Mercurial > octave
view scripts/audio/soundsc.m @ 30564:796f54d4ddbf stable
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2021.
In all .txi and .texi files except gpl.txi and gpl.texi in the
doc/liboctave and doc/interpreter directories, change the copyright
to "Octave Project Developers", the same as used for other source
files. Update copyright notices for 2022 (not done since 2019). For
gpl.txi and gpl.texi, change the copyright notice to be "Free Software
Foundation, Inc." and leave the date at 2007 only because this file
only contains the text of the GPL, not anything created by the Octave
Project Developers.
Add Paul Thomas to contributors.in.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 28 Dec 2021 18:22:40 -0500 |
parents | 7854d5752dd2 |
children | 82b685157e2b |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2016-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} soundsc (@var{y}) ## @deftypefnx {} {} soundsc (@var{y}, @var{fs}) ## @deftypefnx {} {} soundsc (@var{y}, @var{fs}, @var{nbits}) ## @deftypefnx {} {} soundsc (@dots{}, [@var{ymin}, @var{ymax}]) ## Scale the audio data @var{y} and play it at sample rate @var{fs} to the ## default audio device. ## ## The audio signal @var{y} can be a vector or a two-column array, representing ## mono or stereo audio, respectively. ## ## If @var{fs} is not given, a default sample rate of 8000 samples per second ## is used. ## ## The optional argument @var{nbits} specifies the bit depth to play to the ## audio device and defaults to 8 bits. ## ## By default, @var{y} is automatically normalized to the range [-1, 1]. If ## the range [@var{ymin}, @var{ymax}] is given, then elements of @var{y} ## that fall within the range @var{ymin} @leq{} @var{y} @leq{} @var{ymax} ## are scaled to the range [-1, 1] instead. ## ## For more control over audio playback, use the @code{audioplayer} class. ## @seealso{sound, record} ## @end deftypefn function soundsc (y, fs, nbits, yrange) if (nargin < 1) print_usage (); endif if (nargin < 4) yrange = []; endif if (nargin < 2 || isempty (fs)) fs = 8000; elseif (nargin == 2 && numel (fs) > 1) yrange = fs; fs = 8000; elseif (! (isscalar (fs) && fs > 0)) error ("soundsc: sample rate FS must be a positive number"); endif if (nargin < 3 || isempty (nbits)) nbits = 8; elseif (nargin == 3 && numel (nbits) > 1) yrange = nbits; nbits = 8; elseif (! (isscalar (nbits) && (nbits == 8 || nbits == 16 || nbits == 24))) error ("soundsc: bit depth NBITS must be 8, 16, or 24"); endif if (isreal (yrange) && (numel (yrange) == 2) && (yrange(1) <= yrange(2))) ymin = yrange(1); ymax = yrange(2); elseif (isempty (yrange)) ymin = min (y(:)); ymax = max (y(:)); else error ("soundsc: audio range must be a 2-element [YMIN, YMAX] vector"); endif ymin = double (ymin); ymax = double (ymax); ymedian = (ymax + ymin) / 2; yscale = 2 / (ymax - ymin); y = (double (y) - ymedian) .* yscale; play = audioplayer (y, fs, nbits); playblocking (play); endfunction ## Tests of soundsc must not actually play anything. ## Test input validation %!error <Invalid call> soundsc () %!error <FS must be a positive number> soundsc (1, ones (2,2), 8) %!error <FS must be a positive number> soundsc (1, -1) %!error <NBITS must be 8, 16, or 24> soundsc (1, [], 2) %!error <range must be a 2-element .* vector> soundsc (1, [2 1]) %!error <range must be a 2-element .* vector> soundsc (1, [1 2 3]) %!error <range must be a 2-element .* vector> soundsc (1, 8000, [2 1]) %!error <range must be a 2-element .* vector> soundsc (1, 8000, [1 2 3]) %!error <range must be a 2-element .* vector> soundsc (1, 8000, 8, [2 1]) %!error <range must be a 2-element .* vector> soundsc (1, 8000, 8, [1 2 3])