<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ -->
<HEAD>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8">
<meta name="keywords" content="stage, robot, simulation, player, player/stage">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<style type="text/css">
.floatright { float: right; margin: 0 0 1em 1em; }
body {
font-family: sans-serif;
#font-family: Geneva, Verdana, Helvetica, Arial, sans-serif;
background-color: #FFF;
color:#000;
}
a:link {
color: #A00;
}
a:visited {
color: #800;
}
a { text-decoration: none; }
a:hover { text-decoration: underline; }
.timestamp { text-align:right; background-color: #DDD; font-size:75%;}
h1 {
font-size:160%;
}
h2 {
font-size:110%;
#color: #FFF;
#background-color: #666;
#padding:3px;
}
h3 { text-align:left; }
img {
border: 0;
}
ul.menu {
position:relative;
left:-2.5em;
margin-bottom:0px;
margin-top:0px;
}
ul.menu1 {
position:relative;
left:-2.1em;
margin-bottom:0px;
margin-top:0px;
}
li.menu {
list-style-type: none;
position:relative;
#left:-0.5em;
}
#sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;}
#content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; }
div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em; }
div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;}
div.topbar { position: absolute; top:0px; left:9em; margin:1em; }
</style>
<TITLE>Player Manual</TITLE>
</HEAD>
<body>
<div id="sidebar">
<h2 style="text-align:center;">
<a href="index.html">
<img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a>
</h2>
<div class="box">
<div class=title>Player</div>
<ul class=menu>
<li class=menu><a href="index.html">Frontpage</a>
<li class=menu><a href="modules.html">Contents</a>
</ul>
</div>
<div class="box">
<div class=title>User</div>
<ul class=menu>
<li class=menu><a href="install.html">Installation</a>
<li class=menu><a href="start.html">Quick start</a>
<li class=menu><a href="supported_hardware.html">Supported devices</a>
<li class=menu><a href="group__tutorials.html">Tutorials</a>
<li class=menu><a href="group__utils.html">Utilities</a>
<li class=menu><a href="group__clientlibs.html">Client libraries</a>
<li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a>
<li class=menu><a href="help.html">Help</a>
</ul>
</div>
<div class=box>
<div class="title">Developer</div>
<ul class=menu>
<li class=menu><a href="architecture.html">Architecture</a>
<li class=menu><a href="group__libplayercore.html">libplayercore</a>
<ul class=menu1>
<li class=menu><a href="group__interfaces.html">interfaces</a></li>
</ul>
<li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a>
<ul class=menu1>
<li class=menu><a href="group__drivers.html">drivers</a></li>
</ul>
<li class=menu><a href="group__libplayercommon.html">libplayercommon</a>
<li class=menu><a href="group__libplayerutils.html">libplayerutils</a>
<li class=menu><a href="group__libplayersd.html">libplayersd</a>
<li class=menu><a href="group__libplayertcp.html">libplayertcp</a>
<li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a>
<li class=menu><a href="todo.html">TODO</a>
</ul>
</div>
<div class=box>
<!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> -->
<div class="title">Online</div>
<a href="http://playerstage.sourceforge.net">Homepage</a><br>
<a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br>
<a href="http://sourceforge.net/projects/playerstage">Project</a><br>
<a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br>
<a href="http://sourceforge.net/mail/?group_id=42445">Help</a>
</div>
</div>
<div id="content" >
<!-- Generated by Doxygen 1.7.1 -->
<div class="header">
<div class="headertitle">
<h1>alsa.h</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Player - One Hell of a Robot Server</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright (C) 2003</span>
<a name="l00004"></a>00004 <span class="comment"> * Brian Gerkey</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00010"></a>00010 <span class="comment"> * (at your option) any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00019"></a>00019 <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<a name="l00020"></a>00020 <span class="comment"> *</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#include <alsa/asoundlib.h></span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#include "audio_sample.h"</span>
<a name="l00026"></a>00026
<a name="l00028"></a>00028 <span class="comment">// Describes a prestored sample for playing with PLAYER_AUDIO_CMD_SAMPLE_PLAY</span>
<a name="l00029"></a><a class="code" href="structStoredSample.html">00029</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structStoredSample.html">StoredSample</a>
<a name="l00030"></a>00030 {
<a name="l00031"></a>00031 <a class="code" href="classAudioSample.html">AudioSample</a> *sample;
<a name="l00032"></a>00032 <span class="keywordtype">int</span> index; <span class="comment">// Index of sample</span>
<a name="l00033"></a>00033 <span class="keyword">struct </span><a class="code" href="structStoredSample.html">StoredSample</a> *next; <span class="comment">// Next sample in the linked list</span>
<a name="l00034"></a>00034 } <a class="code" href="structStoredSample.html">StoredSample</a>;
<a name="l00035"></a>00035
<a name="l00037"></a>00037 <span class="comment">// An item on the queue of waves to play</span>
<a name="l00038"></a><a class="code" href="structQueueItem.html">00038</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structQueueItem.html">QueueItem</a>
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040 <a class="code" href="classAudioSample.html">AudioSample</a> *sample; <span class="comment">// Audio sample at this position in the queue</span>
<a name="l00041"></a>00041 <span class="keywordtype">bool</span> temp; <span class="comment">// If true, the AudioSample will be deleted after playback completes</span>
<a name="l00042"></a>00042 <span class="keyword">struct </span><a class="code" href="structQueueItem.html">QueueItem</a> *next; <span class="comment">// Next item in the queue</span>
<a name="l00043"></a>00043 } <a class="code" href="structQueueItem.html">QueueItem</a>;
<a name="l00044"></a>00044
<a name="l00046"></a>00046 <span class="comment">// Capabilities of a mixer element</span>
<a name="l00047"></a>00047 <span class="keyword">typedef</span> uint32_t ElemCap;
<a name="l00048"></a>00048 <span class="keyword">const</span> ElemCap ELEMCAP_CAN_PLAYBACK = 0x0001;
<a name="l00049"></a>00049 <span class="keyword">const</span> ElemCap ELEMCAP_CAN_CAPTURE = 0x0002;
<a name="l00050"></a>00050 <span class="keyword">const</span> ElemCap ELEMCAP_COMMON = 0x0004; <span class="comment">// Has a single volume control for both playback and record</span>
<a name="l00051"></a>00051 <span class="keyword">const</span> ElemCap ELEMCAP_PLAYBACK_VOL = 0x0008;
<a name="l00052"></a>00052 <span class="keyword">const</span> ElemCap ELEMCAP_CAPTURE_VOL = 0x0010;
<a name="l00053"></a>00053 <span class="keyword">const</span> ElemCap ELEMCAP_COMMON_VOL = 0x0020;
<a name="l00054"></a>00054 <span class="keyword">const</span> ElemCap ELEMCAP_PLAYBACK_SWITCH = 0x0040;
<a name="l00055"></a>00055 <span class="keyword">const</span> ElemCap ELEMCAP_CAPTURE_SWITCH = 0x0080;
<a name="l00056"></a>00056 <span class="keyword">const</span> ElemCap ELEMCAP_COMMON_SWITCH = 0x0100;
<a name="l00057"></a>00057 <span class="comment">// const ElemCap ELEMCAP_PB_JOINED_SWITCH = 0x0200;</span>
<a name="l00058"></a>00058 <span class="comment">// const ElemCap ELEMCAP_CAP_JOINED_SWITCH = 0x0400;</span>
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="comment">// Describes an ALSA mixer element</span>
<a name="l00061"></a><a class="code" href="structMixerElement.html">00061</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structMixerElement.html">MixerElement</a>
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063 snd_mixer_elem_t *elem; <span class="comment">// ALSA Mixer element structure</span>
<a name="l00064"></a>00064 <span class="keywordtype">long</span> minPlayVol, curPlayVol, maxPlayVol; <span class="comment">// min, current and max volume levels for playback</span>
<a name="l00065"></a>00065 <span class="keywordtype">long</span> minCapVol, curCapVol, maxCapVol; <span class="comment">// min, current and max volume levels for capture</span>
<a name="l00066"></a>00066 <span class="keywordtype">long</span> minComVol, curComVol, maxComVol; <span class="comment">// min, current and max volume levels for common</span>
<a name="l00067"></a>00067 <span class="keywordtype">int</span> playSwitch, capSwitch, comSwitch; <span class="comment">// Current switch status</span>
<a name="l00068"></a>00068 <span class="keywordtype">char</span> *name; <span class="comment">// Name of the element</span>
<a name="l00069"></a>00069 ElemCap caps; <span class="comment">// Capabilities</span>
<a name="l00070"></a>00070 } <a class="code" href="structMixerElement.html">MixerElement</a>;
<a name="l00071"></a>00071
<a name="l00073"></a>00073 <span class="comment">// State of the playback system</span>
<a name="l00074"></a>00074 <span class="keyword">typedef</span> uint8_t PBState;
<a name="l00075"></a>00075 <span class="keyword">const</span> PBState PB_STATE_STOPPED = 0; <span class="comment">// Not playing anything</span>
<a name="l00076"></a>00076 <span class="keyword">const</span> PBState PB_STATE_PLAYING = 1; <span class="comment">// Playing</span>
<a name="l00077"></a>00077 <span class="keyword">const</span> PBState PB_STATE_DRAIN = 2; <span class="comment">// Draining current wave</span>
<a name="l00078"></a>00078 <span class="keyword">const</span> PBState PB_STATE_RECORDING = 3; <span class="comment">// Recording</span>
<a name="l00079"></a>00079
<a name="l00081"></a>00081 <span class="comment">// The class for the driver</span>
<a name="l00082"></a><a class="code" href="classAlsa.html">00082</a> <span class="keyword">class </span><a class="code" href="classAlsa.html">Alsa</a> : <span class="keyword">public</span> <a class="code" href="classThreadedDriver.html" title="Base class for drivers which oeprate with a thread.">ThreadedDriver</a>
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084 <span class="keyword">public</span>:
<a name="l00085"></a>00085 <a class="code" href="classAlsa.html">Alsa</a> (<a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a>* cf, <span class="keywordtype">int</span> section);
<a name="l00086"></a>00086 ~<a class="code" href="classAlsa.html">Alsa</a> (<span class="keywordtype">void</span>);
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classAlsa.html#a7ed88e541c2471cc7bb1cebda8025e41" title="Message handler.">ProcessMessage</a> (<a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> &resp_queue, <a class="code" href="structplayer__msghdr.html" title="Generic message header.">player_msghdr</a> *hdr, <span class="keywordtype">void</span> *data);
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="keyword">private</span>:
<a name="l00091"></a>00091 <span class="comment">// Driver options</span>
<a name="l00092"></a>00092 <span class="keywordtype">bool</span> useQueue; <span class="comment">// If should use a queue for playback or just stop currently playing</span>
<a name="l00093"></a>00093 uint8_t debugLevel; <span class="comment">// Debug info level</span>
<a name="l00094"></a>00094 <span class="keywordtype">char</span> **mixerFilters; <span class="comment">// Null-terminated array of strings to filter mixer elements by</span>
<a name="l00095"></a>00095 <span class="keywordtype">bool</span> mixerFilterExact; <span class="comment">// If mixer filters need to match element names exactly</span>
<a name="l00096"></a>00096 <span class="keywordtype">char</span> *pbDevice; <span class="comment">// Name of the playback device</span>
<a name="l00097"></a>00097 <span class="keywordtype">char</span> *mixerDevice; <span class="comment">// Name of the mixer device</span>
<a name="l00098"></a>00098 <span class="keywordtype">char</span> *recDevice; <span class="comment">// Name of the record device</span>
<a name="l00099"></a>00099 uint32_t cfgPBPeriodTime; <span class="comment">// Length of a playback period in milliseconds</span>
<a name="l00100"></a>00100 uint32_t cfgPBBufferTime; <span class="comment">// Length of the playback buffer in milliseconds</span>
<a name="l00101"></a>00101 uint32_t silenceTime; <span class="comment">// Length of silence to put between samples in the queue</span>
<a name="l00102"></a>00102 uint32_t cfgRecBufferTime; <span class="comment">// Length of the record buffer in milliseconds</span>
<a name="l00103"></a>00103 uint32_t cfgRecStoreTime; <span class="comment">// Length of time to store recorded data before sending to clients</span>
<a name="l00104"></a>00104 uint32_t cfgRecPeriodTime; <span class="comment">// Length of a record period in milliseconds</span>
<a name="l00105"></a>00105 uint8_t recNumChannels; <span class="comment">// Number of channels for recording</span>
<a name="l00106"></a>00106 uint32_t recSampleRate; <span class="comment">// Sample rate for recording</span>
<a name="l00107"></a>00107 uint8_t recBits; <span class="comment">// Sample bits per frame for recording</span>
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="comment">// ALSA variables</span>
<a name="l00110"></a>00110 <span class="comment">// Playback</span>
<a name="l00111"></a>00111 snd_pcm_t *pbHandle; <span class="comment">// Handle to the PCM device for playback</span>
<a name="l00112"></a>00112 <span class="keywordtype">int</span> numPBFDs; <span class="comment">// Number of playback file descriptors</span>
<a name="l00113"></a>00113 <span class="keyword">struct </span>pollfd *pbFDs; <span class="comment">// Playback file descriptors for polling</span>
<a name="l00114"></a>00114 uint32_t actPBBufferTime; <span class="comment">// Length of the playback buffer in microseconds (actual value)</span>
<a name="l00115"></a>00115 uint32_t actPBPeriodTime; <span class="comment">// Length of a playback period in microseconds (actual value)</span>
<a name="l00116"></a>00116 snd_pcm_uframes_t pbPeriodSize; <span class="comment">// Size of a playback period (used for filling the buffer)</span>
<a name="l00117"></a>00117 uint8_t *periodBuffer; <span class="comment">// A buffer used to copy data from samples to the playback buffer</span>
<a name="l00118"></a>00118 <span class="comment">// Record</span>
<a name="l00119"></a>00119 snd_pcm_t *recHandle; <span class="comment">// Handle to the PCM device for recording</span>
<a name="l00120"></a>00120 <span class="keywordtype">int</span> numRecFDs; <span class="comment">// Number of record file descriptors</span>
<a name="l00121"></a>00121 <span class="keyword">struct </span>pollfd *recFDs; <span class="comment">// Record file descriptors for polling</span>
<a name="l00122"></a>00122 uint32_t actRecBufferTime; <span class="comment">// Length of the record buffer in microseconds (actual value)</span>
<a name="l00123"></a>00123 uint32_t actRecPeriodTime; <span class="comment">// Length of a record period in microseconds (actual value)</span>
<a name="l00124"></a>00124 snd_pcm_uframes_t recPeriodSize; <span class="comment">// Size of a record period (used for filling the buffer)</span>
<a name="l00125"></a>00125 <span class="comment">// Mixer</span>
<a name="l00126"></a>00126 snd_mixer_t *mixerHandle; <span class="comment">// Mixer for controlling volume levels</span>
<a name="l00127"></a>00127 <a class="code" href="structMixerElement.html">MixerElement</a> *mixerElements; <span class="comment">// Elements of the mixer</span>
<a name="l00128"></a>00128 uint32_t numElements; <span class="comment">// Number of elements</span>
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="comment">// Other driver data</span>
<a name="l00131"></a>00131 <span class="keywordtype">int</span> nextSampleIdx; <span class="comment">// Next free index to store a sample at</span>
<a name="l00132"></a>00132 <a class="code" href="structStoredSample.html">StoredSample</a> *samplesHead, *samplesTail; <span class="comment">// Stored samples</span>
<a name="l00133"></a>00133 <a class="code" href="structQueueItem.html">QueueItem</a> *queueHead, *queueTail; <span class="comment">// Queue of audio data waiting to play</span>
<a name="l00134"></a>00134 PBState playState; <span class="comment">// Playback state</span>
<a name="l00135"></a>00135 PBState recState; <span class="comment">// Record state</span>
<a name="l00136"></a>00136 uint32_t recDataLength; <span class="comment">// Length of recorded data buffer (in bytes)</span>
<a name="l00137"></a>00137 uint32_t recDataOffset; <span class="comment">// Current end of recorded data in recData</span>
<a name="l00138"></a>00138 uint8_t *recData; <span class="comment">// Somewhere to store recorded data before it goes to the client</span>
<a name="l00139"></a>00139 <span class="keywordtype">int</span> recDest; <span class="comment">// Destination of recorded data: -ve for to clients via data packets,</span>
<a name="l00140"></a>00140 <span class="comment">// >=0 for to stored sample at that index</span>
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="comment">// Internal functions</span>
<a name="l00143"></a>00143 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAlsa.html#a46a695a8a788d0039c1465389a54d855" title="Main method for driver thread.">Main</a> (<span class="keywordtype">void</span>);
<a name="l00144"></a>00144 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classAlsa.html#a624c62d5369313834f0a1aaf0c20f9f1" title="Sets up the resources needed by the driver thread.">MainSetup</a> (<span class="keywordtype">void</span>);
<a name="l00145"></a>00145 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAlsa.html#a7b553f911e3a72797a493eac04ed6201" title="Cleanup method for driver thread (called when main exits).">MainQuit</a> (<span class="keywordtype">void</span>);
<a name="l00146"></a>00146 <span class="keywordtype">void</span> SendStateMessage (<span class="keywordtype">void</span>);
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="comment">// Stored sample functions</span>
<a name="l00149"></a>00149 <span class="keywordtype">bool</span> AddStoredSample (<a class="code" href="structStoredSample.html">StoredSample</a> *newSample);
<a name="l00150"></a>00150 <span class="keywordtype">bool</span> AddStoredSample (<a class="code" href="structplayer__audio__wav.html" title="Data: Raw audio data.">player_audio_wav_t</a> *waveData);
<a name="l00151"></a>00151 <span class="keywordtype">bool</span> AddStoredSample (<span class="keyword">const</span> <span class="keywordtype">char</span> *filePath);
<a name="l00152"></a>00152 <a class="code" href="structStoredSample.html">StoredSample</a>* GetSampleAtIndex (<span class="keywordtype">int</span> index);
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="comment">// Queue functions</span>
<a name="l00155"></a>00155 <span class="keywordtype">void</span> ClearQueue (<span class="keywordtype">void</span>);
<a name="l00156"></a>00156 <span class="keywordtype">bool</span> AddToQueue (<a class="code" href="structQueueItem.html">QueueItem</a> *newItem);
<a name="l00157"></a>00157 <span class="keywordtype">bool</span> AddToQueue (<a class="code" href="structplayer__audio__wav.html" title="Data: Raw audio data.">player_audio_wav_t</a> *waveData);
<a name="l00158"></a>00158 <span class="keywordtype">bool</span> AddToQueue (<a class="code" href="classAudioSample.html">AudioSample</a> *sample);
<a name="l00159"></a>00159 <span class="keywordtype">bool</span> AddSilence (uint32_t time, <a class="code" href="classAudioSample.html">AudioSample</a> *format);
<a name="l00160"></a>00160 <span class="keywordtype">void</span> AdvanceQueue (<span class="keywordtype">void</span>);
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="comment">// Playback functions</span>
<a name="l00163"></a>00163 <span class="comment">// bool SetGeneralParams (void);</span>
<a name="l00164"></a>00164 <span class="comment">// bool SetWaveHWParams (AudioSample *sample);</span>
<a name="l00165"></a>00165 <span class="keywordtype">bool</span> SetupPlayBack (<span class="keywordtype">void</span>);
<a name="l00166"></a>00166 <span class="keywordtype">bool</span> SetPBParams (<a class="code" href="classAudioSample.html">AudioSample</a> *sample);
<a name="l00167"></a>00167 <span class="keywordtype">void</span> PlaybackCallback (<span class="keywordtype">int</span> numFrames);
<a name="l00168"></a>00168
<a name="l00169"></a>00169 <span class="comment">// Record functions</span>
<a name="l00170"></a>00170 <span class="keywordtype">bool</span> SetupRecord (<span class="keywordtype">void</span>);
<a name="l00171"></a>00171 <span class="keywordtype">bool</span> SetRecParams (<span class="keywordtype">void</span>);
<a name="l00172"></a>00172 <span class="keywordtype">bool</span> SetupRecordBuffer (uint32_t length);
<a name="l00173"></a>00173 <span class="keywordtype">void</span> RecordCallback (<span class="keywordtype">int</span> numFrames);
<a name="l00174"></a>00174 <span class="keywordtype">void</span> HandleRecordedData (<span class="keywordtype">void</span>);
<a name="l00175"></a>00175 <span class="keywordtype">void</span> PublishRecordedData (<span class="keywordtype">void</span>);
<a name="l00176"></a>00176
<a name="l00177"></a>00177 <span class="comment">// Playback/record control functions</span>
<a name="l00178"></a>00178 <span class="keywordtype">void</span> StartPlayback (<span class="keywordtype">void</span>);
<a name="l00179"></a>00179 <span class="keywordtype">void</span> StopPlayback (<span class="keywordtype">void</span>);
<a name="l00180"></a>00180 <span class="keywordtype">void</span> StartRecording (<span class="keywordtype">void</span>);
<a name="l00181"></a>00181 <span class="keywordtype">void</span> StopRecording (<span class="keywordtype">void</span>);
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <span class="comment">// Mixer functions</span>
<a name="l00184"></a>00184 <span class="keywordtype">bool</span> SetupMixer (<span class="keywordtype">void</span>);
<a name="l00185"></a>00185 <span class="keywordtype">bool</span> EnumMixerElements (<span class="keywordtype">void</span>);
<a name="l00186"></a>00186 <span class="keywordtype">bool</span> EnumElementCaps (<a class="code" href="structMixerElement.html">MixerElement</a> *element);
<a name="l00187"></a>00187 <a class="code" href="structMixerElement.html">MixerElement</a>* SplitElements (<a class="code" href="structMixerElement.html">MixerElement</a> *elements, uint32_t &count);
<a name="l00188"></a>00188 <a class="code" href="structMixerElement.html">MixerElement</a>* FilterElements (<a class="code" href="structMixerElement.html">MixerElement</a> *elements, uint32_t &count);
<a name="l00189"></a>00189 <span class="keywordtype">void</span> CleanUpMixerElements (<a class="code" href="structMixerElement.html">MixerElement</a> *elements, uint32_t count);
<a name="l00190"></a>00190 <span class="keywordtype">void</span> MixerDetailsToPlayer (<a class="code" href="structplayer__audio__mixer__channel__list__detail.html" title="Player mixer channels.">player_audio_mixer_channel_list_detail_t</a> *dest);
<a name="l00191"></a>00191 <span class="keywordtype">void</span> MixerLevelsToPlayer (<a class="code" href="structplayer__audio__mixer__channel__list.html" title="Player mixer channels.">player_audio_mixer_channel_list_t</a> *dest);
<a name="l00192"></a>00192 <span class="keywordtype">void</span> SetElementLevel (uint32_t index, <span class="keywordtype">float</span> level);
<a name="l00193"></a>00193 <span class="keywordtype">void</span> SetElementSwitch (uint32_t index, <a class="code" href="structplayer__bool.html" title="A boolean variable, 0 for false anything else for true.">player_bool_t</a> active);
<a name="l00194"></a>00194 <span class="keywordtype">void</span> PublishMixerData (<span class="keywordtype">void</span>);
<a name="l00195"></a>00195 <span class="keywordtype">float</span> LevelToPlayer (<span class="keywordtype">long</span> <a class="code" href="group__player__clientlib__utility.html#gae595027e3eb7a9c12bf49dee42d6ea06" title="Return the minimum of a, b.">min</a>, <span class="keywordtype">long</span> <a class="code" href="group__player__clientlib__utility.html#gaa6c2b569d3d0e6c174a49e8ec1aac796" title="Return the maximum of a, b.">max</a>, <span class="keywordtype">long</span> level);
<a name="l00196"></a>00196 <span class="keywordtype">long</span> LevelFromPlayer (<span class="keywordtype">long</span> min, <span class="keywordtype">long</span> max, <span class="keywordtype">float</span> level);
<a name="l00197"></a>00197 <span class="keywordtype">void</span> PrintMixerElements (<a class="code" href="structMixerElement.html">MixerElement</a> *elements, uint32_t count);
<a name="l00198"></a>00198
<a name="l00199"></a>00199 <span class="comment">// Command and request handling</span>
<a name="l00200"></a>00200 <span class="keywordtype">int</span> HandleWavePlayCmd (<a class="code" href="structplayer__audio__wav.html" title="Data: Raw audio data.">player_audio_wav_t</a> *waveData);
<a name="l00201"></a>00201 <span class="keywordtype">int</span> HandleSamplePlayCmd (<a class="code" href="structplayer__audio__sample__item.html" title="Player audio sample selection.">player_audio_sample_item_t</a> *data);
<a name="l00202"></a>00202 <span class="keywordtype">int</span> HandleRecordCmd (<a class="code" href="structplayer__bool.html" title="A boolean variable, 0 for false anything else for true.">player_bool_t</a> *data);
<a name="l00203"></a>00203 <span class="keywordtype">int</span> HandleMixerChannelCmd (<a class="code" href="structplayer__audio__mixer__channel__list.html" title="Player mixer channels.">player_audio_mixer_channel_list_t</a> *data);
<a name="l00204"></a>00204 <span class="keywordtype">int</span> HandleSampleLoadReq (<a class="code" href="structplayer__audio__sample.html" title="Player audio sample.">player_audio_sample_t</a> *data, <a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> &resp_queue);
<a name="l00205"></a>00205 <span class="keywordtype">int</span> HandleSampleRetrieveReq (<a class="code" href="structplayer__audio__sample.html" title="Player audio sample.">player_audio_sample_t</a> *data, <a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> &resp_queue);
<a name="l00206"></a>00206 <span class="keywordtype">int</span> HandleSampleRecordReq (<a class="code" href="structplayer__audio__sample__rec__req.html" title="Player audio sample record request.">player_audio_sample_rec_req_t</a> *data, <a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> &resp_queue);
<a name="l00207"></a>00207 <span class="keywordtype">int</span> HandleMixerChannelListReq (<a class="code" href="structplayer__audio__mixer__channel__list__detail.html" title="Player mixer channels.">player_audio_mixer_channel_list_detail_t</a> *data, <a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> &resp_queue);
<a name="l00208"></a>00208 <span class="keywordtype">int</span> HandleMixerChannelLevelReq (<a class="code" href="structplayer__audio__mixer__channel__list.html" title="Player mixer channels.">player_audio_mixer_channel_list_t</a> *data, <a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> &resp_queue);
<a name="l00209"></a>00209 };
</pre></div></div>
</div>
<!-- render the modification time of the source file -->
<div class="timestamp">
<hr>
<table style="width:100%;">
<tr>
<td style="text-align:left;">
Last updated 12 September 2005 21:38:45
<!--
<td style="text-align:right;">
<a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px"
src="http://www.w3.org/Icons/valid-html401"
alt="Valid HTML 4.01!"></a>
<a href="http://jigsaw.w3.org/css-validator/">
<img style="vertical-align:middle;border:0;width:88px;height:31px"
src="http://jigsaw.w3.org/css-validator/images/vcss"
alt="Valid CSS!">
</a>
-->
</tr>
</table>
</div>
</tr>
</table>
</BODY>
</HTML>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
727fa15453fcace956b835e2377d4269
>
files
>
18
