Mercurial > octave-antonio
view scripts/audio/wavread.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} {@var{y} =} wavread (@var{filename}) ## @deftypefnx {Function File} {[@var{y}, @var{fs}, @var{nbits}] =} wavread (@var{filename}) ## @deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n}) ## @deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, [@var{n1} @var{n2}]) ## @deftypefnx {Function File} {[@dots{}] =} wavread (@dots{}, @var{datatype}) ## @deftypefnx {Function File} {@var{sz} =} wavread (@var{filename}, "size") ## @deftypefnx {Function File} {[@var{n_samp}, @var{n_chan}] =} wavread (@var{filename}, "size") ## Read the audio signal @var{y} from the RIFF/WAVE sound file @var{filename}. ## ## If the file contains multichannel data, then @var{y} is a matrix with the ## channels represented as columns. ## ## If @var{n} is specified, only the first @var{n} samples of the file are ## returned. If [@var{n1} @var{n2}] is specified, only the range of samples ## from @var{n1} to @var{n2} is returned. A value of @code{Inf} can be used ## to represent the total number of samples in the file. ## ## If the option @qcode{"size"} is given, then the size of the audio signal ## is returned instead of the data. The size is returned in a row vector of ## the form [@var{samples} @var{channels}]. If there are two output arguments, ## the number of samples is assigned to the first and the number of channels ## is assigned to the second. ## ## The optional return value @var{fs} is the sample rate of the audio file in ## Hz. The optional return value @var{nbits} is the number of bits per sample ## as encoded in the file. ## ## @seealso{audioread, audiowrite, wavwrite} ## @end deftypefn function [y, fs, nbits] = wavread (filename, varargin) if (nargin < 1 || nargin > 3) print_usage (); endif if (! ischar (filename)) error ("wavread: FILENAME must be a character string"); endif datatype = "double"; samples = [1, Inf]; do_file_size = false; if (nargin == 3) samples = varargin{1}; datatype = varargin{2}; elseif (nargin == 2) if (strcmp (varargin{1}, "size")) do_file_size = true; elseif (ischar (varargin{1})) datatype = varargin{1}; else samples = varargin{1}; endif endif if (isscalar (samples)) samples = [1, samples]; endif if (! (isrow (samples) && numel (samples) == 2 && all (samples > 0) && all (fix (samples) == samples))) error ("wavread: SAMPLES must be a 1- or 2-element integer row vector"); endif if (! (ischar (datatype) && any (strcmp (datatype, {"double", "native"})))) error ('wavread: DATATYPE must be either "double" or "native"'); endif info = audioinfo (filename); if (do_file_size) if (nargout > 1) [y, fs] = deal (info.TotalSamples, info.NumChannels); else y = [info.TotalSamples, info.NumChannels]; endif else [y, fs] = audioread (filename, samples, datatype); nbits = info.BitsPerSample; endif endfunction ## Functional tests for wavread/wavwrite pair are in wavwrite.m. ## Test input validation %!error wavread () %!error wavread (1) %!error wavread ("foo.wav", 2, 3, 4) %!error wavread ("foo.wav", "foo") %!error wavread ("foo.wav", -1) %!error wavread ("foo.wav", [1, Inf], "foo");