octave-nkf: scripts/audio/wavread.m annotate

annotate scripts/audio/wavread.m @ 17193:af2051e363ea

Fix return arguments for wavread (...,"size"), bug #39639. * scripts/audio/wavread.m: Return two arguments in two output variables. * scripts/audio/wavwrite.m: Add %!tests for "size", and [N], [N1, N2] inputs to wavread.

author	Rik <rik@octave.org>
date	Wed, 07 Aug 2013 07:35:01 -0700
parents	b10a23fe80bb
children	d63878346099

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13003 diff changeset	1 ## Copyright (C) 2005-2012 Michael Zeising
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	2 ##
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	3 ## This file is part of Octave.
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	4 ##
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6549 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6549 diff changeset	8 ## your option) any later version.
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	9 ##
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	10 ## 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	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	13 ## General Public License for more details.
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	14 ##
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	15 ## 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	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6549 diff changeset	17 ## <http://www.gnu.org/licenses/>.
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	18
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	20 ## @deftypefn {Function File} {@var{y} =} wavread (@var{filename})
16489 36dba9be680b doc: Make documentation compatible with Texinfo 5.0 (bug #38392) Amod Mulay <amodmulay1@gmail.com> parents: 15530 diff changeset	21 ## @deftypefnx {Function File} {[@var{y}, @var{Fs}, @var{bps}] =} wavread (@var{filename})
36dba9be680b doc: Make documentation compatible with Texinfo 5.0 (bug #38392) Amod Mulay <amodmulay1@gmail.com> parents: 15530 diff changeset	22 ## @deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n})
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	23 ## @deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, [@var{n1} @var{n2}])
16489 36dba9be680b doc: Make documentation compatible with Texinfo 5.0 (bug #38392) Amod Mulay <amodmulay1@gmail.com> parents: 15530 diff changeset	24 ## @deftypefnx {Function File} {[@var{samples}, @var{channels}] =} wavread (@var{filename}, "size")
36dba9be680b doc: Make documentation compatible with Texinfo 5.0 (bug #38392) Amod Mulay <amodmulay1@gmail.com> parents: 15530 diff changeset	25 ##
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	26 ## Load the RIFF/WAVE sound file @var{filename}, and return the samples
80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	27 ## in vector @var{y}. If the file contains multichannel data, then
80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	28 ## @var{y} is a matrix with the channels represented as columns.
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	29 ##
16489 36dba9be680b doc: Make documentation compatible with Texinfo 5.0 (bug #38392) Amod Mulay <amodmulay1@gmail.com> parents: 15530 diff changeset	30 ## @code{[@var{y}, @var{Fs}, @var{bps}] = wavread (@var{filename})}
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	31 ##
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	32 ## Additionally return the sample rate (@var{fs}) in Hz and the number of bits
12701 de3e90a420e3 Overhaul wavwrite, wavread and fix normalization problem (Bug #33420). Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	33 ## per sample (@var{bps}).
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	34 ##
16489 36dba9be680b doc: Make documentation compatible with Texinfo 5.0 (bug #38392) Amod Mulay <amodmulay1@gmail.com> parents: 15530 diff changeset	35 ## @code{[@dots{}] = wavread (@var{filename}, @var{n})}
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	36 ##
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	37 ## Read only the first @var{n} samples from each channel.
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	38 ##
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	39 ## @code{wavread (@var{filename}, [@var{n1} @var{n2}])}
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	40 ##
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	41 ## Read only samples @var{n1} through @var{n2} from each channel.
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	42 ##
16489 36dba9be680b doc: Make documentation compatible with Texinfo 5.0 (bug #38392) Amod Mulay <amodmulay1@gmail.com> parents: 15530 diff changeset	43 ## @code{[@var{samples}, @var{channels}] = wavread (@var{filename}, "size")}
16491 b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	44 ##
b10a23fe80bb doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. Rik <rik@octave.org> parents: 16489 diff changeset	45 ## Return the number of samples (@var{n}) and number of channels (@var{ch})
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	46 ## instead of the audio data.
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5572 diff changeset	47 ## @seealso{wavwrite}
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	48 ## @end deftypefn
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	49
7117 373c39904877 [project @ 2007-11-07 18:48:00 by jwe] jwe parents: 7017 diff changeset	50 ## Author: Michael Zeising <michael@michaels-website.de>
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	51 ## Created: 06 December 2005
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	52
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	53 function [y, samples_per_sec, bits_per_sample] = wavread (filename, param)
80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	54
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	55 FORMAT_PCM = 0x0001; # PCM (8/16/32 bit)
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	56 FORMAT_IEEE_FLOAT = 0x0003; # IEEE float (32/64 bit)
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	57 BYTEORDER = "ieee-le";
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	58
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	59 if (nargin < 1 \|\| nargin > 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5937 diff changeset	60 print_usage ();
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	61 endif
80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	62
80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	63 if (! ischar (filename))
10738 a4b8364e04c7 wavread.m: Correctly handle non-word aligned chunks (bug #30309). Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	64 error ("wavread: FILENAME must be a character string");
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	65 endif
80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	66
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	67 fid = -1;
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	68
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	69 unwind_protect
8796 9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	70
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	71 [fid, msg] = fopen (filename, "rb");
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	72
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	73 if (fid < 0)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	74 error ("wavread: %s", msg);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	75 endif
8796 9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	76
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	77 ## Get file size.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	78 fseek (fid, 0, "eof");
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	79 file_size = ftell (fid);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	80 fseek (fid, 0, "bof");
8796 9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	81
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	82 ## Find RIFF chunk.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	83 riff_size = find_chunk (fid, "RIFF", file_size);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	84 riff_pos = ftell (fid);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	85 if (riff_size == -1)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	86 error ("wavread: file contains no RIFF chunk");
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	87 endif
15530 203c78063bff Fix wavread to support truncated files (bug #37532) Mike Miller <mtmiller@ieee.org> parents: 14868 diff changeset	88 riff_size = min (riff_size, file_size - riff_pos);
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	89
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	90 riff_type = char (fread (fid, 4))';
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	91 if (! strcmp (riff_type, "WAVE"))
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	92 error ("wavread: file contains no WAVE signature");
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	93 endif
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	94 riff_pos = riff_pos + 4;
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	95 riff_size = riff_size - 4;
8796 9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	96
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	97 ## Find format chunk inside the RIFF chunk.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	98 fseek (fid, riff_pos, "bof");
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	99 fmt_size = find_chunk (fid, "fmt ", riff_size);
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	100 fmt_pos = ftell (fid);
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	101 if (fmt_size == -1)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	102 error ("wavread: file contains no format chunk");
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	103 endif
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	104
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	105 ## Find data chunk inside the RIFF chunk.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	106 ## We don't assume that it comes after the format chunk.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	107 fseek (fid, riff_pos, "bof");
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	108 data_size = find_chunk (fid, "data", riff_size);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	109 data_pos = ftell (fid);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	110 if (data_size == -1)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	111 error ("wavread: file contains no data chunk");
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	112 endif
15530 203c78063bff Fix wavread to support truncated files (bug #37532) Mike Miller <mtmiller@ieee.org> parents: 14868 diff changeset	113 data_size = min (data_size, file_size - data_pos);
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	114
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	115 ### Read format chunk.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	116 fseek (fid, fmt_pos, "bof");
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	117
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	118 ## Sample format code.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	119 format_tag = fread (fid, 1, "uint16", 0, BYTEORDER);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	120 if (format_tag != FORMAT_PCM && format_tag != FORMAT_IEEE_FLOAT)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	121 error ("wavread: sample format %#x is not supported", format_tag);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	122 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	123
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	124 ## Number of interleaved channels.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	125 channels = fread (fid, 1, "uint16", 0, BYTEORDER);
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	126
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	127 ## Sample rate.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	128 samples_per_sec = fread (fid, 1, "uint32", 0, BYTEORDER);
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	129
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	130 ## Bits per sample.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	131 fseek (fid, 6, "cof");
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	132 bits_per_sample = fread (fid, 1, "uint16", 0, BYTEORDER);
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	133
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	134 ### Read data chunk.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	135 fseek (fid, data_pos, "bof");
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	136
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	137 ## Determine sample data type.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	138 if (format_tag == FORMAT_PCM)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	139 switch (bits_per_sample)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	140 case 8
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	141 format = "uint8";
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	142 case 16
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	143 format = "int16";
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	144 case 24
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	145 format = "uint8";
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	146 case 32
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	147 format = "int32";
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	148 otherwise
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	149 error ("wavread: %d bits sample resolution is not supported with PCM",
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	150 bits_per_sample);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	151 endswitch
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	152 else
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	153 switch (bits_per_sample)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	154 case 32
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	155 format = "float32";
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	156 case 64
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	157 format = "float64";
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	158 otherwise
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	159 error ("wavread: %d bits sample resolution is not supported with IEEE float",
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	160 bits_per_sample);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	161 endswitch
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	162 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	163
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	164 ## Parse arguments.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	165 if (nargin == 1)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	166 length = idivide (8 * data_size, bits_per_sample);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	167 else
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	168 nparams = numel (param);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	169 if (nparams == 1)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	170 ## Number of samples is given.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	171 length = param * channels;
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	172 elseif (nparams == 2)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	173 ## Sample range is given.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	174 if (fseek (fid, (param(1)-1) * channels * (bits_per_sample/8), "cof") < 0)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	175 warning ("wavread: seeking failed");
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	176 endif
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	177 length = (param(2)-param(1)+1) * channels;
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	178 elseif (nparams == 4 && char (param) == "size")
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	179 ## Size of the file is requested.
17193 af2051e363ea Fix return arguments for wavread (...,"size"), bug #39639. Rik <rik@octave.org> parents: 16491 diff changeset	180 y = idivide (8 * data_size, channels * bits_per_sample);
af2051e363ea Fix return arguments for wavread (...,"size"), bug #39639. Rik <rik@octave.org> parents: 16491 diff changeset	181 samples_per_sec = channels;
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	182 return;
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	183 else
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	184 error ("wavread: invalid PARAM argument");
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	185 endif
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	186 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	187
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	188 ## Read samples and close file.
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	189 if (bits_per_sample == 24)
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	190 length *= 3;
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	191 endif
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	192
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	193 [yi, n] = fread (fid, length, format, 0, BYTEORDER);
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	194
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	195 unwind_protect_cleanup
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	196
74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	197 if (fid >= 0)
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	198 fclose (fid);
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	199 endif
5839 0bc78d9ddcd4 [project @ 2006-06-01 21:21:11 by jwe] jwe parents: 5642 diff changeset	200
13003 74c5fa5cef47 use unwind_protect to ensure wavread closes file. John W. Eaton <jwe@octave.org> parents: 13001 diff changeset	201 end_unwind_protect
5839 0bc78d9ddcd4 [project @ 2006-06-01 21:21:11 by jwe] jwe parents: 5642 diff changeset	202
8506 bc982528de11 comment style fixes John W. Eaton <jwe@octave.org> parents: 7461 diff changeset	203 ## Check data.
6304 78a3254741b2 [project @ 2007-02-14 21:22:59 by jwe] jwe parents: 6046 diff changeset	204 if (mod (numel (yi), channels) != 0)
78a3254741b2 [project @ 2007-02-14 21:22:59 by jwe] jwe parents: 6046 diff changeset	205 error ("wavread: data in %s doesn't match the number of channels",
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9598 diff changeset	206 filename);
6304 78a3254741b2 [project @ 2007-02-14 21:22:59 by jwe] jwe parents: 6046 diff changeset	207 endif
78a3254741b2 [project @ 2007-02-14 21:22:59 by jwe] jwe parents: 6046 diff changeset	208
5839 0bc78d9ddcd4 [project @ 2006-06-01 21:21:11 by jwe] jwe parents: 5642 diff changeset	209 if (bits_per_sample == 24)
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	210 yi = reshape (yi, 3, rows (yi) / 3)';
5839 0bc78d9ddcd4 [project @ 2006-06-01 21:21:11 by jwe] jwe parents: 5642 diff changeset	211 yi(yi(:,3) >= 128, 3) -= 256;
0bc78d9ddcd4 [project @ 2006-06-01 21:21:11 by jwe] jwe parents: 5642 diff changeset	212 yi = yi * [1; 256; 65536];
7151 aeeb646f6538 [project @ 2007-11-09 19:34:17 by jwe] jwe parents: 7117 diff changeset	213 endif
aeeb646f6538 [project @ 2007-11-09 19:34:17 by jwe] jwe parents: 7117 diff changeset	214
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	215 if (format_tag == FORMAT_PCM)
8506 bc982528de11 comment style fixes John W. Eaton <jwe@octave.org> parents: 7461 diff changeset	216 ## Normalize samples.
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	217 switch (bits_per_sample)
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	218 case 8
12701 de3e90a420e3 Overhaul wavwrite, wavread and fix normalization problem (Bug #33420). Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	219 yi = (yi - 128)/128;
5572 c45cf76df06f [project @ 2005-12-12 20:54:06 by jwe] jwe parents: 5567 diff changeset	220 case 16
12701 de3e90a420e3 Overhaul wavwrite, wavread and fix normalization problem (Bug #33420). Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	221 yi /= 32768;
5839 0bc78d9ddcd4 [project @ 2006-06-01 21:21:11 by jwe] jwe parents: 5642 diff changeset	222 case 24
12701 de3e90a420e3 Overhaul wavwrite, wavread and fix normalization problem (Bug #33420). Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	223 yi /= 8388608;
5572 c45cf76df06f [project @ 2005-12-12 20:54:06 by jwe] jwe parents: 5567 diff changeset	224 case 32
12701 de3e90a420e3 Overhaul wavwrite, wavread and fix normalization problem (Bug #33420). Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	225 yi /= 2147483648;
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	226 endswitch
2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	227 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	228
8506 bc982528de11 comment style fixes John W. Eaton <jwe@octave.org> parents: 7461 diff changeset	229 ## Deinterleave.
5567 80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	230 nr = numel (yi) / channels;
80e629357483 [project @ 2005-12-07 06:31:28 by jwe] jwe parents: 5566 diff changeset	231 y = reshape (yi, channels, nr)';
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	232
5565 2eeed655e801 [project @ 2005-12-06 20:38:20 by jwe] jwe parents: diff changeset	233 endfunction
8796 9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	234
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	235 ## Given a chunk_id, scan through chunks from the current file position
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	236 ## though at most size bytes. Return the size of the found chunk, with
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	237 ## file position pointing to the start of the chunk data. Return -1 for
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	238 ## size if chunk is not found.
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	239
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	240 function chunk_size = find_chunk (fid, chunk_id, size)
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	241 id = "";
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	242 offset = 8;
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	243 chunk_size = 0;
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	244
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	245 while (! strcmp (id, chunk_id) && (offset < size))
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	246 fseek (fid, chunk_size, "cof");
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	247 id = char (fread (fid, 4))';
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	248 chunk_size = fread (fid, 1, "uint32", 0, "ieee-le");
10738 a4b8364e04c7 wavread.m: Correctly handle non-word aligned chunks (bug #30309). Rik <octave@nomad.inbox5.com> parents: 10635 diff changeset	249 ## Chunk sizes must be word-aligned (2 byte)
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	250 chunk_size += rem (chunk_size, 2);
8796 9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	251 offset = offset + 8 + chunk_size;
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	252 endwhile
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	253 if (! strcmp (id, chunk_id))
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	254 chunk_size = -1;
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	255 endif
9662dfb26652 wavread.m: improve search for data chunks Frederick Umminger <Frederick_Umminger@playstation.sony.com> parents: 8506 diff changeset	256 endfunction
12701 de3e90a420e3 Overhaul wavwrite, wavread and fix normalization problem (Bug #33420). Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	257
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	258
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	259 ## Mark file as tested. Tests for wavread/wavwrite pair are in wavwrite.m.
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	260 %!assert (1)
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	261

Mercurial > hg > octave-nkf

annotate scripts/audio/wavread.m @ 17193:af2051e363ea