Mercurial > octave-antonio
view scripts/audio/wavwrite.m @ 20158:7503499a252b stable
doc: Update docstrings to have one sentence summary as first line.
Update scripts in audio, elfun, general, geometry, and image directories.
* scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m,
scripts/audio/@audiorecorder/subsasgn.m,
scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m,
scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m,
scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m,
scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m,
scripts/general/accumarray.m, scripts/general/accumdim.m,
scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m,
scripts/general/blkdiag.m, scripts/general/cart2pol.m,
scripts/general/cart2sph.m, scripts/general/cell2mat.m,
scripts/general/celldisp.m, scripts/general/chop.m,
scripts/general/circshift.m, scripts/general/common_size.m,
scripts/general/cplxpair.m, scripts/general/cumtrapz.m,
scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m,
scripts/general/display.m, scripts/general/divergence.m,
scripts/general/fieldnames.m, scripts/general/flip.m,
scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m,
scripts/general/gradient.m, scripts/general/interp3.m,
scripts/general/interpft.m, scripts/general/interpn.m,
scripts/general/loadobj.m, scripts/general/logspace.m,
scripts/general/methods.m, scripts/general/nargchk.m,
scripts/general/narginchk.m, scripts/general/nargoutchk.m,
scripts/general/nextpow2.m, scripts/general/nthargout.m,
scripts/general/num2str.m, scripts/general/pol2cart.m,
scripts/general/polyarea.m, scripts/general/postpad.m,
scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m,
scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m,
scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m,
scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m,
scripts/general/shiftdim.m, scripts/general/sortrows.m,
scripts/general/sph2cart.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/trapz.m,
scripts/general/triplequad.m, scripts/geometry/delaunayn.m,
scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m,
scripts/geometry/rectint.m, scripts/geometry/tsearchn.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/help/__unimplemented__.m, scripts/help/doc.m,
scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m,
scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m,
scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m,
scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m,
scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m,
scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m,
scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m,
scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m,
scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m,
scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m,
scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m,
scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m,
scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m,
scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m,
scripts/image/white.m, scripts/image/winter.m:
Update docstrings to have one sentence summary as first line.
Re-structure to have line lengths <= 80 chars.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 09:36:20 -0700 |
parents | 9fc020886ae9 |
children |
line wrap: on
line source
## Copyright (C) 2015 Mike Miller ## Copyright (C) 2005-2015 Michael Zeising ## ## 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/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} wavwrite (@var{y}, @var{filename}) ## @deftypefnx {Function File} {} wavwrite (@var{y}, @var{fs}, @var{filename}) ## @deftypefnx {Function File} {} wavwrite (@var{y}, @var{fs}, @var{nbits}, @var{filename}) ## Write the audio signal @var{y} to the RIFF/WAVE sound file @var{filename}. ## ## If @var{y} is a matrix, the columns represent multiple audio channels. ## ## The optional argument @var{fs} specifies the sample rate of the audio signal ## in Hz. ## ## The optional argument @var{nbits} specifies the number of bits per sample ## to write to @var{filename}. ## ## The default sample rate is 8000 Hz and the default bit depth is 16 bits ## per sample. ## ## @seealso{audiowrite, audioread, wavread} ## @end deftypefn function wavwrite (y, varargin) if (nargin < 2 || nargin > 4) print_usage (); endif ## Defaults. fs = 8000; nbits = 16; filename = varargin{end}; if (nargin > 2) fs = varargin{1}; if (nargin > 3) nbits = varargin{2}; endif endif ## calculate filesize [n, channels] = size (y); ## allow y to be a row vector if (n == 1) y = y(:); n = channels; channels = 1; endif ## test arguments if (channels < 1) error ("wavwrite: Y must have at least one column"); endif if (channels > 0x7FFF) error ("wavwrite: Y must have no more than 32767 columns"); endif if (! (isscalar (fs) && (fs > 0))) error ("wavwrite: sample rate FS must be a positive number"); endif if (! isscalar (nbits) || isempty (find (nbits == [8, 16, 24, 32]))) error ("wavwrite: bit depth NBITS must be 8, 16, 24, or 32"); endif audiowrite (filename, y, fs, "BitsPerSample", nbits); endfunction %!shared fname %! fname = [tempname() ".wav"]; %!testif HAVE_SNDFILE %! A = [-1:0.1:1; -1:0.1:1]'; %! unwind_protect %! wavwrite (A, fname); %! [B, samples_per_sec, bits_per_sample] = wavread (fname); %! assert (B, A, 2^-14); %! assert (samples_per_sec, 8000); %! assert (bits_per_sample, 16); %! unwind_protect_cleanup %! unlink (fname); %! end_unwind_protect %!testif HAVE_SNDFILE %! A = [-1:0.1:1; -1:0.1:1]'; %! unwind_protect %! wavwrite (A, 4000, fname); %! [B, samples_per_sec, bits_per_sample] = wavread (fname); %! assert (B, A, 2^-14); %! assert (samples_per_sec, 4000); %! assert (bits_per_sample, 16); %! unwind_protect_cleanup %! unlink (fname); %! end_unwind_protect %!testif HAVE_SNDFILE %! A = [-1:0.1:1; -1:0.1:1]'; %! unwind_protect %! wavwrite (A, 4000, 8, fname); %! [B, samples_per_sec, bits_per_sample] = wavread (fname); %! assert (B, A, 2^-6); %! assert (samples_per_sec, 4000); %! assert (bits_per_sample, 8); %! unwind_protect_cleanup %! unlink (fname); %! end_unwind_protect %!testif HAVE_SNDFILE %! A = [-2:2]'; %! unwind_protect %! wavwrite (A, fname); %! B = wavread (fname); %! B *= 32768; %! assert (B, [-32767 -32767 0 32767 32767]'); %! unwind_protect_cleanup %! unlink (fname); %! end_unwind_protect %!testif HAVE_SNDFILE %! A = [-1:0.1:1]; %! unwind_protect %! wavwrite (A, fname); %! [B, samples_per_sec, bits_per_sample] = wavread (fname); %! assert (B, A', 2^-14); %! assert (samples_per_sec, 8000); %! assert (bits_per_sample, 16); %! unwind_protect_cleanup %! unlink (fname); %! end_unwind_protect %!testif HAVE_SNDFILE %! A = [-1:0.1:1; -1:0.1:1]'; %! unwind_protect %! wavwrite (A, fname); %! B = wavread (fname, 15); %! assert (B, A(1:15,:), 2^-14); %! wavwrite (A, fname); %! B = wavread (fname, [10, 20]); %! assert (B, A(10:20,:), 2^-14); %! unwind_protect_cleanup %! unlink (fname); %! end_unwind_protect %!testif HAVE_SNDFILE %! A = [-1:0.1:1; -1:0.1:1]'; %! unwind_protect %! wavwrite (A, fname); %! [nsamp, nchan] = wavread (fname, "size"); %! assert (nsamp, 21); %! assert (nchan, 2); %! unwind_protect_cleanup %! unlink (fname); %! end_unwind_protect ## Test input validation %!error wavwrite () %!error wavwrite (1) %!error wavwrite (1,2,3,4,5) %!error wavwrite ([], "foo.wav");