octave-nkf: doc/interpreter/audio.txi annotate

annotate doc/interpreter/audio.txi @ 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	651f12640c90
children	0e1f5a750d00

rev	line source
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	1 @c Copyright (C) 1996-2013 Kurt Hornik
7018 fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	2 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	3 @c This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	4 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	5 @c Octave is free software; you can redistribute it and/or modify it
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	6 @c under the terms of the GNU General Public License as published by the
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	7 @c Free Software Foundation; either version 3 of the License, or (at
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	8 @c your option) any later version.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	9 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	10 @c Octave is distributed in the hope that it will be useful, but WITHOUT
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	13 @c for more details.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	14 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	15 @c You should have received a copy of the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	16 @c along with Octave; see the file COPYING. If not, see
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	17 @c <http://www.gnu.org/licenses/>.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 6778 diff changeset	18
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 4167 diff changeset	19 @c Written by Kurt Hornik <Kurt.Hornik@wu-wien.ac.at> on 1996/05/14
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	20
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3452 diff changeset	21 @node Audio Processing
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	22 @chapter Audio Processing
19527 e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	23
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	24 @menu
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	25 * Audio File Utilities::
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	26 * Audio Device Information::
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	27 * Audio Player::
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	28 * Audio Recorder::
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	29 * Audio Data Processing::
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	30 @end menu
19527 e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	31
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	32 @node Audio File Utilities
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	33 @section Audio File Utilities
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	34
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	35 The following functions allow you to read, write and retrieve
19605 72304a4e010a Use Octave coding conventions for documentation of audio functions. Rik <rik@octave.org> parents: 19561 diff changeset	36 information about audio files. Various formats are supported including
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	37 wav, flac and ogg vorbis.
19529 da6173d4e384 doc: included docstrings for audioinfo, audioread and audiowrite in audio.txi Vytautas Jančauskas <unaudio@gmail.com> parents: 19528 diff changeset	38
19527 e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	39 @DOCSTRING(audioinfo)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	40
19527 e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	41 @DOCSTRING(audioread)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	42
19527 e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	43 @DOCSTRING(audiowrite)
e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	44
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	45 @node Audio Device Information
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	46 @section Audio Device Information
19527 e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	47
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	48 @DOCSTRING(audiodevinfo)
19527 e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	49
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	50 @node Audio Player
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	51 @section Audio Player
19527 e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	52
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	53 The following methods are used to create and use audioplayer
19605 72304a4e010a Use Octave coding conventions for documentation of audio functions. Rik <rik@octave.org> parents: 19561 diff changeset	54 objects. These objects can be used to play back audio data stored in
72304a4e010a Use Octave coding conventions for documentation of audio functions. Rik <rik@octave.org> parents: 19561 diff changeset	55 Octave matrices and arrays. The audioplayer object supports playback
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	56 from various devices available to the system, blocking and non-blocking
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	57 playback, convenient pausing and resuming and much more.
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	58
19527 e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	59 @DOCSTRING(@audioplayer/audioplayer)
e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	60
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	61 @menu
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	62 * Playback::
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	63 * Player Properties::
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	64 @end menu
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	65
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	66 @node Playback
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	67 @subsection Playback
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	68
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	69 The following methods are used to control player playback.
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	70
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	71 @DOCSTRING(@audioplayer/play)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	72
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	73 @DOCSTRING(@audioplayer/playblocking)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	74
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	75 @DOCSTRING(@audioplayer/pause)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	76
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	77 @DOCSTRING(@audioplayer/resume)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	78
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	79 @DOCSTRING(@audioplayer/stop)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	80
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	81 @DOCSTRING(@audioplayer/isplaying)
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	82
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	83 @node Player Properties
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	84 @subsection Properties
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	85
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	86 The remaining couple of methods are used to get and set various
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	87 properties of the audioplayer object.
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	88
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	89 @DOCSTRING(@audioplayer/get)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	90
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	91 @DOCSTRING(@audioplayer/set)
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	92
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	93 @node Audio Recorder
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	94 @section Audio Recorder
19527 e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	95
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	96 The following methods are used to create and use audiorecorder
19605 72304a4e010a Use Octave coding conventions for documentation of audio functions. Rik <rik@octave.org> parents: 19561 diff changeset	97 objects. These objects can be used to record audio data from various
72304a4e010a Use Octave coding conventions for documentation of audio functions. Rik <rik@octave.org> parents: 19561 diff changeset	98 devices available to the system. You can use convenient methods to
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	99 retrieve that data or audioplayer objects created from that
19605 72304a4e010a Use Octave coding conventions for documentation of audio functions. Rik <rik@octave.org> parents: 19561 diff changeset	100 data. Methods for blocking and non-blocking recording, pausing and
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	101 resuming recording and much more is available.
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	102
19527 e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	103 @DOCSTRING(@audiorecorder/audiorecorder)
e36c9a2b2919 doc: add docstrings for audio file utilities, audiodevinfo, audioplayer and audiorecorder Vytautas Jančauskas <unaudio@gmail.com> parents: 19524 diff changeset	104
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	105 @menu
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	106 * Recording::
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	107 * Data Retrieval::
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	108 * Recorder Properties::
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	109 @end menu
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	110
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	111 @node Recording
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	112 @subsection Recording
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	113
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	114 The following methods control the recording process.
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	115
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	116 @DOCSTRING(@audiorecorder/record)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	117
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	118 @DOCSTRING(@audiorecorder/recordblocking)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	119
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	120 @DOCSTRING(@audiorecorder/pause)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	121
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	122 @DOCSTRING(@audiorecorder/resume)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	123
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	124 @DOCSTRING(@audiorecorder/stop)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	125
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	126 @DOCSTRING(@audiorecorder/isrecording)
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	127
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	128 @node Data Retrieval
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	129 @subsection Data Retrieval
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	130
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	131 The following methods allow you to retrieve recorded audio data in
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	132 various ways.
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	133
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	134 @DOCSTRING(@audiorecorder/getaudiodata)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	135
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	136 @DOCSTRING(@audiorecorder/getplayer)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	137
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	138 @DOCSTRING(@audiorecorder/play)
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	139
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	140 @node Recorder Properties
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	141 @subsection Properties
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	142
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	143 The remaining two methods allow you to read or alter the properties of
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	144 audiorecorder objects.
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	145
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	146 @DOCSTRING(@audiorecorder/get)
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	147
19528 3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	148 @DOCSTRING(@audiorecorder/set)
3954d835436b doc: included all docstrings for the @audioplayer class in audio.txi as well as added additional explanations for the functionality Vytautas Jančauskas <unaudio@gmail.com> parents: 19527 diff changeset	149
19561 651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	150 @node Audio Data Processing
651f12640c90 * audio.txi: Update sectioning and refill text. John W. Eaton <jwe@octave.org> parents: 19542 diff changeset	151 @section Audio Data Processing
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	152
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	153 Octave provides a few functions for dealing with audio data. An audio
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	154 `sample' is a single output value from an A/D converter, i.e., a small
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	155 integer number (usually 8 or 16 bits), and audio data is just a series
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	156 of such samples. It can be characterized by three parameters: the
9072 bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 7018 diff changeset	157 sampling rate (measured in samples per second or Hz, e.g., 8000 or
bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi Rik <rdrider0-list@yahoo.com> parents: 7018 diff changeset	158 44100), the number of bits per sample (e.g., 8 or 16), and the number of
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	159 channels (1 for mono, 2 for stereo, etc.).
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	160
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	161 There are many different formats for representing such data. Currently,
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	162 only the two most popular, @emph{linear encoding} and @emph{mu-law
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	163 encoding}, are supported by Octave. There is an excellent FAQ on audio
19074 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17744 diff changeset	164 formats by @nospell{Guido van Rossum} @email{guido@@cwi.nl} which can be
0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17744 diff changeset	165 found at any FAQ ftp site, in particular in the directory
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	166 @file{/pub/usenet/news.answers/audio-fmts} of the archive site
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	167 @code{rtfm.mit.edu}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	168
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	169 Octave simply treats audio data as vectors of samples (non-mono data are
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	170 not supported yet). It is assumed that audio files using linear
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	171 encoding have one of the extensions @file{lin} or @file{raw}, and that
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	172 files holding data in mu-law encoding end in @file{au}, @file{mu}, or
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	173 @file{snd}.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	174
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	175 @DOCSTRING(lin2mu)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	176
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	177 @DOCSTRING(mu2lin)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	178
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	179 @DOCSTRING(loadaudio)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	180
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	181 @DOCSTRING(saveaudio)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	182
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	183 The following functions for audio I/O require special A/D hardware and
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	184 operating system support. It is assumed that audio data in linear
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	185 encoding can be played and recorded by reading from and writing to
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	186 @file{/dev/dsp}, and that similarly @file{/dev/audio} is used for mu-law
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	187 encoding. These file names are system-dependent. Improvements so that
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	188 these functions will work without modification on a wide variety of
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	189 hardware are welcome.
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	190
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	191 @DOCSTRING(playaudio)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	192
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	193 @DOCSTRING(record)
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	194
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	195 @DOCSTRING(setaudio)
7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3294 diff changeset	196
6549 5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 5428 diff changeset	197 @DOCSTRING(wavread)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 5428 diff changeset	198
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe] jwe parents: 5428 diff changeset	199 @DOCSTRING(wavwrite)

Mercurial > octave-nkf

annotate doc/interpreter/audio.txi @ 19605:72304a4e010a