Mercurial > octave-nkf
view scripts/audio/@audiorecorder/audiorecorder.m @ 19539:ce02743b6f2a
Fix texinfo docstring syntax for all audio functions
* libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioinfo.cc,
libinterp/dldfcn/audioread.cc, libinterp/dldfcn/audiowrite.cc,
scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m,
scripts/audio/@audioplayer/display.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/pause.m,
scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m,
scripts/audio/@audioplayer/resume.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/stop.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/display.m, scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/pause.m, scripts/audio/@audiorecorder/play.m,
scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/resume.m, scripts/audio/@audiorecorder/set.m,
scripts/audio/@audiorecorder/stop.m: Fix texinfo docstring formatting, wrap
long lines, and use consistent lowercase variable names.
author | Mike Miller <mtmiller@ieee.org> |
---|---|
date | Thu, 03 Oct 2013 09:50:01 -0400 |
parents | 36a26a131209 |
children | fdb8a62ef17a |
line wrap: on
line source
## Copyright (C) 2013 Vytautas JanĨauskas ## ## 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{recorder} =} audiorecorder () ## Create an audiorecorder object recording 8 bit mono audio at 8000 Hz ## sample rate. ## @end deftypefn ## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels}) ## Create an audiorecorder object recording at specified sample rate ## @var{fs}, specified bit depth @var{nbits}, and specified number of ## @var{channels}. ## @end deftypefn ## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{fs}, @var{nbits}, @var{channels}, @var{id}) ## Create an audiorecorder object recording at specified sample rate @var{fs}, ## specified bit depth @var{nbits}, number of @var{channels}, and recording ## on the device specified by @var{id}. You can get device IDs by using the ## audiodevinfo function. ## @end deftypefn ## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{function}, @var{fs}) ## Argument @var{function} is a function handle, inline function, or a string ## value of a function name that will get called to process audio. Audio ## will be recorded at @var{fs} sampling rate. ## @end deftypefn ## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{function}, @var{fs}, @var{nbits}) ## Same as above but also allows you to specify the number of bits per ## sample. ## @end deftypefn ## @deftypefn {Function File} {@var{recorder} =} audiorecorder (@var{function}, @var{fs}, @var{nbits}, @var{id}) ## Same as above but also allows you to specify device @var{id} that will be ## used. ## @end deftypefn function recorder = audiorecorder (varargin) if (nargin > 5) print_usage (); endif if nargin > 0 && ischar (varargin{1}) varargin{1} = str2func (varargin{1}); endif recorder.recorder = __recorder_audiorecorder__ (varargin{:}); recorder = class (recorder, "audiorecorder"); endfunction %!test %! recorder = audiorecorder (44100, 16, 2); %! recordblocking (recorder, 1); %! data = getaudiodata (recorder, "int16"); %! assert (strcmp (class (data), "int16")); %! data = getaudiodata (recorder, "int8"); %! assert (strcmp (class (data), "int8")); %! data = getaudiodata (recorder, "uint8"); %! assert (strcmp (class (data), "uint8")); %! assert (size (data)(1), recorder.TotalSamples); %! assert (size (data)(2), 2); %! assert (size (data)(1) != 0); %!test %! recorder = audiorecorder (44100, 16, 2); %! record (recorder, 1) %! sleep (2); %! record (recorder, 1); %! sleep (2); %! data = getaudiodata (recorder); %! assert (size (data)(1) < 44100 * 2); %!test %! recorder = audiorecorder (44100, 16, 2); %! record (recorder, 1); %! sleep (2); %! player1 = audioplayer (recorder); %! player2 = getplayer (recorder); %! play (player1); %! sleep (2); %! play (player2); %! sleep (2); %! assert (player1.TotalSamples, recorder.TotalSamples); %! assert (player2.TotalSamples, recorder.TotalSamples); %!test %! recorder = audiorecorder; %! set (recorder, {"SampleRate", "Tag", "UserData"}, {8000, "tag", [1, 2; 3, 4]}); %! assert (recorder.SampleRate, 8000); %! assert (recorder.Tag, "tag"); %! assert (recorder.UserData, [1, 2; 3, 4]); %!test %! recorder = audiorecorder; %! settable = set (recorder); %! settable.SampleRate = 8000; %! settable.Tag = "tag"; %! settable.UserData = [1, 2; 3, 4]; %! set (recorder, settable); %! assert (recorder.SampleRate, 8000); %! assert (recorder.Tag, "tag"); %! assert (recorder.UserData, [1, 2; 3, 4]); %!test %! recorder = audiorecorder; %! recorder.SampleRate = 8000; %! recorder.Tag = "tag"; %! recorder.UserData = [1, 2; 3, 4]; %! properties = get (recorder, {"SampleRate", "Tag", "UserData"}); %! assert (properties, {8000, "tag", [1, 2; 3, 4]}); #%!function status = callback_record (sound) #%! fid = fopen ("record.txt", "at"); #%! for index = 1:rows(sound) #%! fprintf (fid, "%.4f, %.4f\n", sound(index, 1), sound(index, 2)); #%! endfor #%! fclose (fid); #%! status = 0; #%!endfunction #%!test #%! recorder = audiorecorder (@callback_record, 44100); #%! unlink ("record.txt") #%! record (recorder); #%! sleep (2); #%! stop (player); #%! s = stat ("record.txt"); #%! assert (s.size > 0); #%!test #%! recorder = audiorecorder (@callback_record, 44100); #%! unlink ("record.txt") #%! record (recorder); #%! sleep (2); #%! stop (recorder); #%! s = stat ("record.txt"); #%! assert (s.size > 0);