<!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>audio_sample.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="comment">// Sample type</span> <a name="l00024"></a>00024 <span class="keyword">typedef</span> uint8_t SampleType; <a name="l00025"></a>00025 <span class="comment">// No type - no wave data loaded</span> <a name="l00026"></a>00026 <span class="keyword">const</span> SampleType SAMPLE_TYPE_NONE = 0; <a name="l00027"></a>00027 <span class="comment">// File samples must be opened, and the data comes from/goes to the file on demand</span> <a name="l00028"></a>00028 <span class="keyword">const</span> SampleType SAMPLE_TYPE_FILE = 1; <a name="l00029"></a>00029 <span class="comment">// Memory samples are stored as data in memory, eg a sample received via the player server</span> <a name="l00030"></a>00030 <span class="keyword">const</span> SampleType SAMPLE_TYPE_MEM = 2; <a name="l00031"></a>00031 <a name="l00032"></a><a class="code" href="classAudioSample.html">00032</a> <span class="keyword">class </span><a class="code" href="classAudioSample.html">AudioSample</a> <a name="l00033"></a>00033 { <a name="l00034"></a>00034 <span class="keyword">public</span>: <a name="l00035"></a>00035 <a class="code" href="classAudioSample.html">AudioSample</a> (<span class="keywordtype">void</span>); <a name="l00036"></a>00036 <a class="code" href="classAudioSample.html">AudioSample</a> (<span class="keyword">const</span> <a class="code" href="structplayer__audio__wav.html" title="Data: Raw audio data.">player_audio_wav_t</a> *source); <a name="l00037"></a>00037 <a class="code" href="classAudioSample.html">AudioSample</a> (<span class="keyword">const</span> uint8_t *source, uint32_t length, uint16_t channels, uint32_t sr, uint16_t bps); <a name="l00038"></a>00038 ~<a class="code" href="classAudioSample.html">AudioSample</a> (<span class="keywordtype">void</span>); <a name="l00039"></a>00039 <a name="l00040"></a>00040 <span class="comment">// Data management functions</span> <a name="l00041"></a>00041 <span class="keywordtype">void</span> SetDataPosition (uint32_t newPosition); <span class="comment">// Set current position in the data (in frames, not bytes)</span> <a name="l00042"></a>00042 uint32_t GetDataPosition (<span class="keywordtype">void</span>) <span class="keyword">const</span>; <span class="comment">// Get current position in the data (in frames, not bytes)</span> <a name="l00043"></a>00043 uint32_t GetDataLength (<span class="keywordtype">void</span>) <span class="keyword">const</span>; <span class="comment">// Get length of data (in frames, not bytes)</span> <a name="l00044"></a>00044 <span class="keywordtype">int</span> GetData (<span class="keywordtype">int</span> frameCount, uint8_t *buffer); <span class="comment">// Get a block of data from current position</span> <a name="l00045"></a>00045 <span class="keywordtype">void</span> ClearSample (<span class="keywordtype">void</span>); <span class="comment">// Clear the entire sample (including format), making this a SAMPLE_TYPE_NONE</span> <a name="l00046"></a>00046 <span class="keywordtype">bool</span> FillSilence (uint32_t time); <span class="comment">// Fill the sample with silence</span> <a name="l00047"></a>00047 <a name="l00048"></a>00048 <span class="comment">// Data conversion functions</span> <a name="l00049"></a>00049 <span class="keywordtype">bool</span> ToPlayer (<a class="code" href="structplayer__audio__wav.html" title="Data: Raw audio data.">player_audio_wav_t</a> *dest); <span class="comment">// Convert to player wave structure</span> <a name="l00050"></a>00050 <span class="keywordtype">bool</span> FromPlayer (<span class="keyword">const</span> <a class="code" href="structplayer__audio__wav.html" title="Data: Raw audio data.">player_audio_wav_t</a> *source); <span class="comment">// Convert from player wave structure</span> <a name="l00051"></a>00051 <a name="l00052"></a>00052 <span class="comment">// File management functions</span> <a name="l00053"></a>00053 <span class="keywordtype">bool</span> LoadFile (<span class="keyword">const</span> <span class="keywordtype">char</span> *fileName); <span class="comment">// Load wave data from a file</span> <a name="l00054"></a>00054 <span class="keywordtype">void</span> CloseFile (<span class="keywordtype">void</span>); <span class="comment">// Close the opened file</span> <a name="l00055"></a>00055 <span class="keyword">const</span> <span class="keywordtype">char</span>* GetFilePath (<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> filePath; } <a name="l00056"></a>00056 <a name="l00057"></a>00057 <span class="comment">// Wave format functions</span> <a name="l00058"></a>00058 SampleType GetType (<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> type; } <a name="l00059"></a>00059 <span class="keywordtype">void</span> SetType (SampleType val) { type = val; } <a name="l00060"></a>00060 uint16_t GetNumChannels (<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> numChannels; } <a name="l00061"></a>00061 <span class="keywordtype">void</span> SetNumChannels (uint16_t val) { numChannels = val; } <a name="l00062"></a>00062 uint32_t GetSampleRate (<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> sampleRate; } <a name="l00063"></a>00063 <span class="keywordtype">void</span> SetSampleRate (uint32_t val) { sampleRate = val; byteRate = blockAlign * sampleRate; } <a name="l00064"></a>00064 uint32_t GetByteRate (<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> byteRate; } <a name="l00065"></a>00065 uint16_t GetBlockAlign (<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> blockAlign; } <a name="l00066"></a>00066 <span class="keywordtype">void</span> SetBlockAlign (uint16_t val) { blockAlign = val; byteRate = blockAlign * sampleRate; } <a name="l00067"></a>00067 uint16_t GetBitsPerSample (<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> bitsPerSample; } <a name="l00068"></a>00068 <span class="keywordtype">void</span> SetBitsPerSample (uint16_t val) { bitsPerSample = val; } <a name="l00069"></a>00069 uint32_t GetNumFrames (<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> numFrames; } <a name="l00070"></a>00070 <span class="keywordtype">bool</span> SameFormat (<span class="keyword">const</span> <a class="code" href="classAudioSample.html">AudioSample</a> *rhs); <a name="l00071"></a>00071 <span class="keywordtype">void</span> CopyFormat (<span class="keyword">const</span> <a class="code" href="classAudioSample.html">AudioSample</a> *rhs); <a name="l00072"></a>00072 <a name="l00073"></a>00073 <span class="comment">// Other useful functions</span> <a name="l00074"></a>00074 <span class="keywordtype">void</span> PrintWaveInfo (<span class="keywordtype">void</span>); <span class="comment">// Print out the wave information</span> <a name="l00075"></a>00075 <a name="l00076"></a>00076 <span class="keyword">private</span>: <a name="l00077"></a>00077 SampleType type; <span class="comment">// Sample type</span> <a name="l00078"></a>00078 <a name="l00079"></a>00079 <span class="comment">// Information about the wave this sample stores</span> <a name="l00080"></a>00080 uint16_t numChannels; <span class="comment">// Number of channels in the data</span> <a name="l00081"></a>00081 uint32_t sampleRate; <span class="comment">// Number of samples per second</span> <a name="l00082"></a>00082 uint32_t byteRate; <span class="comment">// Number of bytes per second</span> <a name="l00083"></a>00083 uint16_t blockAlign; <span class="comment">// Number of bytes for one sample over all channels (i.e. frame size)</span> <a name="l00084"></a>00084 uint16_t bitsPerSample; <span class="comment">// Number of bits per sample (eg 8, 16, 24, ...)</span> <a name="l00085"></a>00085 uint32_t numFrames; <span class="comment">// Number of frames (divide by sampleRate to get time)</span> <a name="l00086"></a>00086 <a name="l00087"></a>00087 <span class="comment">// Current position in the wave data (in bytes)</span> <a name="l00088"></a>00088 uint32_t position; <a name="l00089"></a>00089 <a name="l00090"></a>00090 <span class="comment">// If this is a file sample, this is the file info</span> <a name="l00091"></a>00091 FILE *waveFile; <span class="comment">// File pointer</span> <a name="l00092"></a>00092 <span class="keywordtype">char</span> *filePath; <span class="comment">// Path to the file on disc</span> <a name="l00093"></a>00093 uint32_t headerSize; <span class="comment">// Size of the wave format header in the file (i.e. start of actual data in the file)</span> <a name="l00094"></a>00094 <a name="l00095"></a>00095 <span class="comment">// If this is a memory sample, the data is stored here</span> <a name="l00096"></a>00096 uint32_t dataLength; <span class="comment">// Length of data in bytes</span> <a name="l00097"></a>00097 uint8_t *data; <span class="comment">// Array on the heap containing the data</span> <a name="l00098"></a>00098 }; </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>