octave: scripts/deprecated/wavread.m annotate

annotate scripts/deprecated/wavread.m @ 25054:6652d3823428 stable

maint: Update copyright dates in all source files.

author	John W. Eaton <jwe@octave.org>
date	Fri, 30 Mar 2018 09:19:05 -0400
parents	194eb4bd202b
children	7b1b504c2f12

rev	line source
25054 6652d3823428 maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	1 ## Copyright (C) 2016-2018 Mike Miller
6652d3823428 maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	2 ## Copyright (C) 2005-2018 Michael Zeising
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	3 ##
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	4 ## This file is part of Octave.
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	5 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	6 ## Octave is free software: you can redistribute it and/or modify it
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	7 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	8 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	9 ## (at your option) any later version.
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	10 ##
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	14 ## GNU General Public License for more details.
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	15 ##
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	16 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6549 diff changeset	17 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	18 ## <https://www.gnu.org/licenses/>.
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	19
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	20 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20484 diff changeset	21 ## @deftypefn {} {@var{y} =} wavread (@var{filename})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20484 diff changeset	22 ## @deftypefnx {} {[@var{y}, @var{fs}, @var{nbits}] =} wavread (@var{filename})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20484 diff changeset	23 ## @deftypefnx {} {[@dots{}] =} wavread (@var{filename}, @var{n})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20484 diff changeset	24 ## @deftypefnx {} {[@dots{}] =} wavread (@var{filename}, [@var{n1} @var{n2}])
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20484 diff changeset	25 ## @deftypefnx {} {[@dots{}] =} wavread (@dots{}, @var{datatype})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20484 diff changeset	26 ## @deftypefnx {} {@var{sz} =} wavread (@var{filename}, "size")
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20484 diff changeset	27 ## @deftypefnx {} {[@var{n_samp}, @var{n_chan}] =} wavread (@var{filename}, "size")
20484 c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	28 ##
c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	29 ## @code{wavread} is deprecated and will be removed in Octave version 4.6.
c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	30 ## Use @code{audioread} for the equivalent functionality.
c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	31 ##
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	32 ## Read the audio signal @var{y} from the RIFF/WAVE sound file @var{filename}.
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	33 ##
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	34 ## If the file contains multichannel data, then @var{y} is a matrix with the
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	35 ## channels represented as columns.
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	36 ##
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	37 ## If @var{n} is specified, only the first @var{n} samples of the file are
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	38 ## returned. If [@var{n1} @var{n2}] is specified, only the range of samples
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	39 ## from @var{n1} to @var{n2} is returned. A value of @code{Inf} can be used
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	40 ## to represent the total number of samples in the file.
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	41 ##
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	42 ## If the option @qcode{"size"} is given, then the size of the audio signal
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	43 ## is returned instead of the data. The size is returned in a row vector of
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	44 ## the form [@var{samples} @var{channels}]. If there are two output arguments,
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	45 ## the number of samples is assigned to the first and the number of channels
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	46 ## is assigned to the second.
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	47 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	48 ## The optional return value @var{fs} is the sample rate of the audio file in
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	49 ## Hz. The optional return value @var{nbits} is the number of bits per sample
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	50 ## as encoded in the file.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	51 ##
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	52 ## @seealso{audioread, audiowrite, wavwrite}
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	53 ## @end deftypefn
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	54
20484 c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	55 ## Deprecated in 4.2
c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	56
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	57 function [y, fs, nbits] = wavread (filename, varargin)
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	58
20484 c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	59 persistent warned = false;
c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	60 if (! warned)
c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	61 warned = true;
c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	62 warning ("Octave:deprecated-function",
c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	63 "wavread is obsolete and will be removed from a future version of Octave, please use audioread instead");
c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	64 endif
c8ec0b72b7a6 Deprecate wavread and wavwrite. Rik <rik@octave.org> parents: 20158 diff changeset	65
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	66 if (nargin < 1 \|\| nargin > 3)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5937 diff changeset	67 print_usage ();
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	68 endif
80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	69
80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	70 if (! ischar (filename))
10738 a4b8364e04c7 wavread.m: Correctly handle non-word aligned chunks (bug #30309). Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	71 error ("wavread: FILENAME must be a character string");
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	72 endif
80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	73
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	74 datatype = "double";
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	75 samples = [1, Inf];
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	76 do_file_size = false;
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	77
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	78 if (nargin == 3)
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	79 samples = varargin{1};
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	80 datatype = varargin{2};
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	81 elseif (nargin == 2)
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	82 if (strcmp (varargin{1}, "size"))
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	83 do_file_size = true;
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	84 elseif (ischar (varargin{1}))
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	85 datatype = varargin{1};
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	86 else
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	87 samples = varargin{1};
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	88 endif
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	89 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	90
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	91 if (isscalar (samples))
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	92 samples = [1, samples];
6304 78a3254741b2 [project @ 2007-02-14 21:22:59 by jwe] jwe parents: 6046 diff changeset	93 endif
78a3254741b2 [project @ 2007-02-14 21:22:59 by jwe] jwe parents: 6046 diff changeset	94
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	95 if (! (isrow (samples) && numel (samples) == 2 && all (samples > 0)
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	96 && all (fix (samples) == samples)))
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	97 error ("wavread: SAMPLES must be a 1- or 2-element integer row vector");
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	98 endif
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	99
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	100 if (! (ischar (datatype) && any (strcmp (datatype, {"double", "native"}))))
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	101 error ('wavread: DATATYPE must be either "double" or "native"');
7151 aeeb646f6538 [project @ 2007-11-09 19:34:17 by jwe] jwe parents: 7117 diff changeset	102 endif
aeeb646f6538 [project @ 2007-11-09 19:34:17 by jwe] jwe parents: 7117 diff changeset	103
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	104 info = audioinfo (filename);
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	105
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	106 if (do_file_size)
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	107 if (nargout > 1)
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	108 [y, fs] = deal (info.TotalSamples, info.NumChannels);
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	109 else
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	110 y = [info.TotalSamples, info.NumChannels];
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	111 endif
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	112 else
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	113 [y, fs] = audioread (filename, samples, datatype);
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	114 nbits = info.BitsPerSample;
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	115 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	116
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	117 endfunction
8796 9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	118
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	119
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	120 ## Functional tests for wavread/wavwrite pair are in wavwrite.m.
8796 9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	121
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19814 diff changeset	122 ## Test input validation
19814 71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	123 %!error wavread ()
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	124 %!error wavread (1)
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	125 %!error wavread ("foo.wav", 2, 3, 4)
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	126 %!error wavread ("foo.wav", "foo")
71770cf07c30 wavread, wavwrite: Overhaul functions. Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	127 %!error wavread ("foo.wav", -1)
21581 6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 20852 diff changeset	128 %!error wavread ("foo.wav", [1, Inf], "foo")

Mercurial > octave

annotate scripts/deprecated/wavread.m @ 25054:6652d3823428 stable