view scripts/audio/@audiorecorder/getaudiodata.m @ 19605:72304a4e010a

Use Octave coding conventions for documentation of audio functions. * audio.txi, audioread.cc, @audioplayer/audioplayer.m, @audioplayer/get.m, @audioplayer/play.m, @audioplayer/playblocking.m, @audioplayer/set.m, @audiorecorder/audiorecorder.m, @audiorecorder/get.m, @audiorecorder/getaudiodata.m, @audiorecorder/play.m, @audiorecorder/record.m, @audiorecorder/set.m: Use Octave documentation standards. * audiodevinfo.cc: Limit lines to 80 chars. Indent according to GNU style.
author Rik <rik@octave.org>
date Tue, 13 Jan 2015 08:54:25 -0800
parents 5802ea7037d4
children 4197fc428c7d
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{data} =} getaudiodata (@var{recorder})
## @deftypefnx {Function File} {@var{data} =} getaudiodata (@var{recorder}, @var{datatype})
## Return recorder audio data as a matrix with values between -1.0 and 1.0
## and with as many columns as there are channels in the recorder.
## Given the optional argument @var{datatype}, convert the recorded data
## to the specified type, which may be one of @qcode{"double"},
## @qcode{"single"}, @qcode{"int16"}, @qcode{"int8"} or @qcode{"uint8"}.
## @end deftypefn

function data = getaudiodata (varargin)

  if (nargin < 1 || nargin > 2)
    print_usage ();
  endif

  recorder = varargin{1};

  if (nargin == 1)
    data = __recorder_getaudiodata__ (struct (recorder).recorder);
  else
    data = __recorder_getaudiodata__ (struct (recorder).recorder);
    type = varargin{2};
    switch (type)
      case "int16"
        data = int16 (data * (2.0 ^ 15));
      case "int8"
        data = int8 (data * (2.0 ^ 7));
      case "uint8"
        data = uint8 ((data + 1.0) * 0.5 * (2.0 ^ 8 - 1));
    endswitch
  endif

  if (get (recorder, "NumberOfChannels") == 2)
    data = data';
  else
    data = data(1,:)';
  endif

endfunction