Mercurial > octave-nkf
view libinterp/dldfcn/audiowrite.cc @ 19539:ce02743b6f2a
Fix texinfo docstring syntax for all audio functions
* libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioinfo.cc,
libinterp/dldfcn/audioread.cc, libinterp/dldfcn/audiowrite.cc,
scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m,
scripts/audio/@audioplayer/display.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/pause.m,
scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m,
scripts/audio/@audioplayer/resume.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/stop.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/display.m, scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/pause.m, scripts/audio/@audiorecorder/play.m,
scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/resume.m, scripts/audio/@audiorecorder/set.m,
scripts/audio/@audiorecorder/stop.m: Fix texinfo docstring formatting, wrap
long lines, and use consistent lowercase variable names.
author | Mike Miller <mtmiller@ieee.org> |
---|---|
date | Thu, 03 Oct 2013 09:50:01 -0400 |
parents | 36a26a131209 |
children |
line wrap: on
line source
/* Copyright (C) 2013 Vytautas JanĨauskas This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include "oct.h" #include "ov-struct.h" #ifdef HAVE_SNDFILE #include <sndfile.h> #endif #include <string> #include <map> #ifdef HAVE_SNDFILE static void fill_extension_table (std::map<std::string, int> &table) { table["wav"] = SF_FORMAT_WAV; table["aiff"] = SF_FORMAT_AIFF; table["au"] = SF_FORMAT_AU; table["raw"] = SF_FORMAT_RAW; table["paf"] = SF_FORMAT_PAF; table["svx"] = SF_FORMAT_SVX; table["nist"] = SF_FORMAT_NIST; table["voc"] = SF_FORMAT_VOC; table["ircam"] = SF_FORMAT_IRCAM; table["w64"] = SF_FORMAT_W64; table["mat4"] = SF_FORMAT_MAT4; table["mat5"] = SF_FORMAT_MAT5; table["pvf"] = SF_FORMAT_PVF; table["xi"] = SF_FORMAT_XI; table["htk"] = SF_FORMAT_HTK; table["sds"] = SF_FORMAT_SDS; table["avr"] = SF_FORMAT_AVR; table["wavex"] = SF_FORMAT_WAVEX; table["sd2"] = SF_FORMAT_SD2; table["flac"] = SF_FORMAT_FLAC; table["caf"] = SF_FORMAT_CAF; table["wve"] = SF_FORMAT_WVE; table["ogg"] = SF_FORMAT_OGG; table["mpc2k"] = SF_FORMAT_MPC2K; table["rf64"] = SF_FORMAT_RF64; } #endif DEFUN_DLD (audiowrite, args, , "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs})\n\ \n\ Write audio data from the matrix @var{y} to a file specified by @var{filename},\n\ file format will be determined by the file extension.\n\ \n\ @end deftypefn\n\ @deftypefn {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs}, @var{name}, @var{value})\n\ \n\ Lets you specify additional parameters when writing the file. Those parameters\n\ are given in the table below:\n\ \n\ @table @samp\n\ @item BitsPerSample\n\ Number of bits per sample, valid values are 8, 16, 24 and 32. Default is 16.\n\ @item BitRate\n\ Valid argument name, but ignored. Left for compatibility with MATLAB.\n\ @item Quality\n\ Quality setting for the Ogg Vorbis compressor. Values can range between 0 and 100 with 100 being the highest quality setting. Default is 75.\n\ @item Title\n\ Title for the audio file.\n\ @item Artist\n\ Artist name.\n\ @item Comment\n\ Comment.\n\ @end table\n\ @end deftypefn") { octave_scalar_map retval; #ifdef HAVE_SNDFILE std::map<std::string, int> extension_to_format; fill_extension_table (extension_to_format); std::string filename = args(0).string_value (); std::string extension = filename.substr (filename.find_last_of (".") + 1); std::transform (extension.begin (), extension.end (), extension.begin (), ::tolower); Matrix audio = args(1).matrix_value (); SNDFILE *file; SF_INFO info; float *data = (float *)malloc (audio.rows () * audio.cols () * sizeof (float)); for (int i = 0; i < audio.cols (); i++) { for (int j = 0; j < audio.rows (); j++) { data[j * audio.cols () + i] = audio(j, i); } } if (extension == "ogg") info.format = SF_FORMAT_VORBIS; else info.format = SF_FORMAT_PCM_16; std::string title = ""; std::string artist = ""; std::string comment = ""; float quality = 0.75; for (int i = 3; i < args.length (); i += 2) { if (args(i).string_value () == "BitsPerSample") { int bits = args(i + 1).int_value (); if (bits == 8) info.format |= SF_FORMAT_PCM_S8; else if (bits == 16) info.format |= SF_FORMAT_PCM_16; else if (bits == 24) info.format |= SF_FORMAT_PCM_24; else if (bits == 32) info.format |= SF_FORMAT_PCM_32; else error ("audiowrite: wrong number of bits specified"); } else if (args(i).string_value () == "BitRate") ; else if (args(i).string_value () == "Quality") quality = args(i + 1).int_value () * 0.01; else if (args(i).string_value () == "Title") title = args(i + 1).string_value (); else if (args(i).string_value () == "Artist") artist = args(i + 1).string_value (); else if (args(i).string_value () == "Comment") comment = args(i + 1).string_value (); else error ("audiowrite: wrong argument name"); } info.samplerate = args(2).int_value (); info.channels = audio.cols (); info.format |= extension_to_format[extension]; file = sf_open (filename.c_str (), SFM_WRITE, &info); if (title != "") sf_set_string (file, SF_STR_TITLE, title.c_str ()); if (artist != "") sf_set_string (file, SF_STR_ARTIST, artist.c_str ()); if (comment != "") sf_set_string (file, SF_STR_COMMENT, comment.c_str ()); sf_write_float (file, data, audio.rows () * audio.cols ()); sf_close (file); free (data); #else error ("sndfile not found on your system and thus audiowrite is not functional"); #endif return octave_value (retval); }