<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: csplugincommon/sndsys/sndstream.h Source File (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>csplugincommon/sndsys/sndstream.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2006 by Andrew Mann</span> <a name="l00003"></a>00003 <span class="comment"></span> <a name="l00004"></a>00004 <span class="comment"> This library is free software; you can redistribute it and/or</span> <a name="l00005"></a>00005 <span class="comment"> modify it under the terms of the GNU General Public</span> <a name="l00006"></a>00006 <span class="comment"> License as published by the Free Software Foundation; either</span> <a name="l00007"></a>00007 <span class="comment"> version 2 of the License, or (at your option) any later version.</span> <a name="l00008"></a>00008 <span class="comment"></span> <a name="l00009"></a>00009 <span class="comment"> This library is distributed in the hope that it will be useful,</span> <a name="l00010"></a>00010 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00011"></a>00011 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00012"></a>00012 <span class="comment"> General Public License for more details.</span> <a name="l00013"></a>00013 <span class="comment"></span> <a name="l00014"></a>00014 <span class="comment"> You should have received a copy of the GNU General Public</span> <a name="l00015"></a>00015 <span class="comment"> License along with this library; if not, write to the Free</span> <a name="l00016"></a>00016 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span> <a name="l00017"></a>00017 <span class="comment">*/</span> <a name="l00018"></a>00018 <a name="l00019"></a>00019 <a name="l00020"></a>00020 <a name="l00021"></a>00021 <span class="preprocessor">#ifndef SNDSTREAM_H</span> <a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define SNDSTREAM_H</span> <a name="l00023"></a>00023 <span class="preprocessor"></span> <a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="databuff_8h.html" title="Data Buffer interface.">iutil/databuff.h</a>"</span> <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="ss__structs_8h.html" title="Sound system: types.">isndsys/ss_structs.h</a>"</span> <a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="ss__stream_8h.html" title="Sound system: stream.">isndsys/ss_stream.h</a>"</span> <a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="convert_8h.html" title="Some helper functions for sound elements.">csplugincommon/sndsys/convert.h</a>"</span> <a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="cyclicbuf_8h.html" title="An implementation of a cyclic buffer oriented for sound functionality.">csplugincommon/sndsys/cyclicbuf.h</a>"</span> <a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="queue_8h.html" title="A threadsafe, pointer-passing queue implementation for the sound system.">csplugincommon/sndsys/queue.h</a>"</span> <a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="refarr_8h.html" title="Smart Pointer array.">csutil/refarr.h</a>"</span> <a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span> <a name="l00032"></a>00032 <a name="l00033"></a>00033 <a name="l00034"></a>00034 <span class="keyword">namespace </span>CS <a name="l00035"></a>00035 { <a name="l00036"></a>00036 <span class="keyword">namespace </span>SndSys <a name="l00037"></a>00037 { <a name="l00038"></a>00038 <a name="l00039"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html">00039</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html">SndSysBasicStream</a> : <a name="l00040"></a>00040 <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a><SndSysBasicStream, iSndSysStream> <a name="l00041"></a>00041 { <a name="l00042"></a>00042 <span class="keyword">public</span>: <a name="l00043"></a>00043 <a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html">SndSysBasicStream</a>(<a class="code" href="structcsSndSysSoundFormat.html" title="The sound format.">csSndSysSoundFormat</a> *pRenderFormat, <span class="keywordtype">int</span> Mode3D); <a name="l00044"></a>00044 <span class="keyword">virtual</span> ~<a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html">SndSysBasicStream</a>(); <a name="l00045"></a>00045 <a name="l00047"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#86804c52aca343c2525bf73a5dd69fdc">00047</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> InvalidPosition = (size_t)~0; <a name="l00048"></a>00048 <a name="l00050"></a>00050 <span class="comment">// Structure/enum definitions</span> <a name="l00052"></a>00052 <span class="comment"></span> <a name="l00054"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#76e4566d647662f1098b92bf661c3250">00054</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a name="l00055"></a>00055 { <a name="l00056"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#76e4566d647662f1098b92bf661c3250156587d8de1a66a89ea89e8f31756bf7">00056</a> STREAM_NOTIFY_PAUSED=0, <a name="l00057"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#76e4566d647662f1098b92bf661c32505b79de02618fbefe6efc635b9e1fa019">00057</a> STREAM_NOTIFY_UNPAUSED, <a name="l00058"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#76e4566d647662f1098b92bf661c32505bc2e58878e791aa285eb3ab8b519833">00058</a> STREAM_NOTIFY_LOOP, <a name="l00059"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#76e4566d647662f1098b92bf661c32501beae401b3ada4a5786723631ad1b5dd">00059</a> STREAM_NOTIFY_FRAME <a name="l00060"></a>00060 } StreamNotificationType; <a name="l00061"></a>00061 <a name="l00063"></a><a class="code" href="structCS_1_1SndSys_1_1SndSysBasicStream_1_1StreamNotificationEvent.html">00063</a> <span class="keyword">struct </span><a class="code" href="structCS_1_1SndSys_1_1SndSysBasicStream_1_1StreamNotificationEvent.html" title="Structure containing the data for each notification event.">StreamNotificationEvent</a> <a name="l00064"></a>00064 { <a name="l00066"></a><a class="code" href="structCS_1_1SndSys_1_1SndSysBasicStream_1_1StreamNotificationEvent.html#1734ec15f87ae5485d786734c3667d5c">00066</a> <a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#76e4566d647662f1098b92bf661c3250" title="Types of notification events.">StreamNotificationType</a> m_Type; <a name="l00068"></a>00068 <span class="comment">// This is currently only valid for </span> <a name="l00069"></a>00069 <span class="comment">// STREAM_NOTIFY_FRAME event types</span> <a name="l00070"></a><a class="code" href="structCS_1_1SndSys_1_1SndSysBasicStream_1_1StreamNotificationEvent.html#9ae0b7f1631e5006d5dc7298d45e5d6c">00070</a> <span class="keywordtype">size_t</span> m_Frame; <a name="l00071"></a>00071 }; <a name="l00072"></a>00072 <a name="l00073"></a>00073 <a name="l00075"></a>00075 <span class="comment">// Interface implementation</span> <a name="l00077"></a>00077 <span class="comment"></span> <a name="l00078"></a>00078 <span class="comment">//------------------------</span> <a name="l00079"></a>00079 <span class="comment">// iSndSysStream</span> <a name="l00080"></a>00080 <span class="comment">//------------------------</span> <a name="l00081"></a>00081 <span class="keyword">public</span>: <a name="l00082"></a>00082 <a name="l00084"></a>00084 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetDescription() = 0; <a name="l00085"></a>00085 <a name="l00090"></a>00090 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="structcsSndSysSoundFormat.html" title="The sound format.">csSndSysSoundFormat</a> *GetRenderedFormat(); <a name="l00091"></a>00091 <a name="l00093"></a>00093 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Get3dMode(); <a name="l00094"></a>00094 <a name="l00101"></a>00101 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetFrameCount() = 0; <a name="l00102"></a>00102 <a name="l00103"></a>00103 <a name="l00114"></a>00114 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetPosition(); <a name="l00115"></a>00115 <a name="l00121"></a>00121 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ResetPosition(); <a name="l00122"></a>00122 <a name="l00128"></a>00128 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SetPosition (<span class="keywordtype">size_t</span> newposition); <a name="l00129"></a>00129 <a name="l00142"></a>00142 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Pause(); <a name="l00143"></a>00143 <a name="l00148"></a>00148 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Unpause(); <a name="l00149"></a>00149 <a name="l00156"></a>00156 <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetPauseState(); <a name="l00157"></a>00157 <a name="l00163"></a>00163 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SetLoopState(<span class="keywordtype">int</span> loopstate); <a name="l00164"></a>00164 <a name="l00169"></a>00169 <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetLoopState(); <a name="l00170"></a>00170 <a name="l00175"></a>00175 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetPlayRatePercent(<span class="keywordtype">int</span> percent); <a name="l00176"></a>00176 <a name="l00181"></a>00181 <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetPlayRatePercent(); <a name="l00182"></a>00182 <a name="l00187"></a>00187 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetAutoUnregister(<span class="keywordtype">bool</span> autounreg); <a name="l00188"></a>00188 <a name="l00193"></a>00193 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> GetAutoUnregister(); <a name="l00194"></a>00194 <a name="l00199"></a>00199 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> GetAutoUnregisterRequested(); <a name="l00200"></a>00200 <a name="l00215"></a>00215 <span class="keyword">virtual</span> <span class="keywordtype">void</span> AdvancePosition(<span class="keywordtype">size_t</span> frame_delta) = 0; <a name="l00216"></a>00216 <a name="l00253"></a>00253 <span class="keyword">virtual</span> <span class="keywordtype">void</span> GetDataPointers (<span class="keywordtype">size_t</span> *position_marker, <span class="keywordtype">size_t</span> max_requested_length, <a name="l00254"></a>00254 <span class="keywordtype">void</span> **buffer1, <span class="keywordtype">size_t</span> *buffer1_bytes, <span class="keywordtype">void</span> **buffer2, <span class="keywordtype">size_t</span> *buffer2_bytes); <a name="l00255"></a>00255 <a name="l00262"></a>00262 <span class="keyword">virtual</span> <span class="keywordtype">void</span> InitializeSourcePositionMarker (<span class="keywordtype">size_t</span>* position_marker); <a name="l00263"></a>00263 <a name="l00269"></a>00269 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ProcessNotifications(); <a name="l00270"></a>00270 <a name="l00271"></a>00271 <a name="l00273"></a>00273 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> RegisterCallback(<a class="code" href="structiSndSysStreamCallback.html" title="Sound System stream interface for callback notification.">iSndSysStreamCallback</a> *pCallback); <a name="l00274"></a>00274 <a name="l00276"></a>00276 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> UnregisterCallback(<a class="code" href="structiSndSysStreamCallback.html" title="Sound System stream interface for callback notification.">iSndSysStreamCallback</a> *pCallback); <a name="l00277"></a>00277 <a name="l00279"></a>00279 <span class="comment">// it's crossed.</span> <a name="l00280"></a>00280 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> RegisterFrameNotification(<span class="keywordtype">size_t</span> frame_number); <a name="l00281"></a>00281 <a name="l00283"></a>00283 <span class="comment">// Internal functions</span> <a name="l00285"></a>00285 <span class="comment"></span> <span class="keyword">protected</span>: <a name="l00287"></a>00287 <span class="comment">//</span> <a name="l00288"></a>00288 <span class="keywordtype">size_t</span> CopyBufferBytes (<span class="keywordtype">size_t</span> max_dest_bytes); <a name="l00289"></a>00289 <a name="l00291"></a>00291 <span class="keywordtype">void</span> QueueNotificationEvent(<a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#76e4566d647662f1098b92bf661c3250" title="Types of notification events.">StreamNotificationType</a> NotifyType, <span class="keywordtype">size_t</span> FrameNum); <a name="l00292"></a>00292 <a name="l00293"></a>00293 <a name="l00295"></a>00295 <span class="comment">// Member variables</span> <a name="l00297"></a>00297 <span class="comment"></span> <span class="keyword">protected</span>: <a name="l00299"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#868b9d1503762f5c980c27eae8c84a2b">00299</a> <a class="code" href="structcsSndSysSoundFormat.html" title="The sound format.">csSndSysSoundFormat</a> m_RenderFormat; <a name="l00300"></a>00300 <a name="l00302"></a>00302 <span class="comment">//</span> <a name="l00303"></a>00303 <span class="comment">// The cyclic buffer is used to hold recently decoded sound. It </span> <a name="l00304"></a>00304 <span class="comment">// provides functionality which allows us to add new data at any point</span> <a name="l00305"></a>00305 <span class="comment">// without a lot of excess copying.</span> <a name="l00306"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#70ae4d719679a9227efab043f3a7dbdd">00306</a> <a class="code" href="classCS_1_1SndSys_1_1SoundCyclicBuffer.html" title="An implementation of a cyclic buffer oriented for sound functionality.">SoundCyclicBuffer</a> *m_pCyclicBuffer; <a name="l00307"></a>00307 <a name="l00309"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#912291d919b7f964bfb2d0fb577ce7c4">00309</a> <span class="keywordtype">bool</span> m_bPaused; <a name="l00310"></a>00310 <a name="l00312"></a>00312 <span class="comment">// of the data?</span> <a name="l00313"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#ae2ef6631db2825724b925ff8990c014">00313</a> <span class="keywordtype">bool</span> m_bLooping; <a name="l00314"></a>00314 <a name="l00316"></a>00316 <span class="comment">//</span> <a name="l00317"></a>00317 <span class="comment">// This is set to true once we have completed reading the underlying data</span> <a name="l00318"></a>00318 <span class="comment">// only if we are not looping. If we are looping, then we'll just start</span> <a name="l00319"></a>00319 <span class="comment">// back at the beginning of the data and we will never be finished reading.</span> <a name="l00320"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#5dd5b15236fd53db8a9c300d86dcc120">00320</a> <span class="keywordtype">bool</span> m_bPlaybackReadComplete; <a name="l00321"></a>00321 <a name="l00323"></a>00323 <span class="comment">// furthest ahead in reading.</span> <a name="l00324"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#3752df1544fdab1f1b8c9023fffeb739">00324</a> <span class="keywordtype">size_t</span> m_MostAdvancedReadPointer; <a name="l00325"></a>00325 <a name="l00330"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#8e863b1d76cbbb06ba3147435e0f9ed2">00330</a> <span class="keywordtype">size_t</span> m_NewPosition; <a name="l00331"></a>00331 <a name="l00336"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#477813212199c383b413a9fe53c3d143">00336</a> <a class="code" href="classCS_1_1SndSys_1_1PCMSampleConverter.html" title="A PCMSampleConverter object converts PCM data from one format to another.">PCMSampleConverter</a> *m_pPCMConverter; <a name="l00337"></a>00337 <a name="l00339"></a>00339 <span class="comment">// for addition to the cyclic buffer.</span> <a name="l00340"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#9d34331eda44cc2fefda80890d3259f8">00340</a> <span class="keywordtype">char</span> *m_pPreparedDataBuffer; <a name="l00341"></a>00341 <a name="l00343"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#760b875861a689c90191bb6b382e5720">00343</a> <span class="keywordtype">int</span> m_PreparedDataBufferSize; <a name="l00344"></a>00344 <a name="l00346"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#d0c86385b34b28e240b14eb2daa5143c">00346</a> <span class="keywordtype">size_t</span> m_PreparedDataBufferUsage; <a name="l00347"></a>00347 <a name="l00349"></a>00349 <span class="comment">// data buffer</span> <a name="l00350"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#0daaabd14525f2eb9186e7e37bf4f4b5">00350</a> <span class="keywordtype">size_t</span> m_PreparedDataBufferStart; <a name="l00351"></a>00351 <a name="l00353"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#2f5ac02b43a5bee792c5acf0ea6ccc7d">00353</a> <span class="keywordtype">int</span> m_RenderFrameSize; <a name="l00354"></a>00354 <a name="l00356"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#f7b1ea8cd9f7ff5ee1f352b116884a7c">00356</a> <span class="keywordtype">int</span> m_PlaybackPercent; <a name="l00357"></a>00357 <a name="l00362"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#a13beeaabe1915f87748ed22484d1f65">00362</a> <span class="keywordtype">int</span> m_OutputFrequency; <a name="l00363"></a>00363 <a name="l00368"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#b7b9559f44749840ed67c1ef10770f8c">00368</a> <span class="keywordtype">int</span> m_NewOutputFrequency; <a name="l00369"></a>00369 <a name="l00374"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#8dabf6445e95167889a7850d16a26277">00374</a> <span class="keywordtype">int</span> m_3DMode; <a name="l00375"></a>00375 <a name="l00380"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#f24b34168907645d9b1fac719a9806a1">00380</a> <span class="keywordtype">bool</span> m_bAutoUnregisterRequested; <a name="l00381"></a>00381 <a name="l00383"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#ab161cc9be7635077b6d69b8a1dd95f9">00383</a> <span class="keywordtype">bool</span> m_bAutoUnregisterReady; <a name="l00384"></a>00384 <a name="l00386"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#e51e337e55d531dfe7d5e3f282e70f08">00386</a> <a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csRefArray<iSndSysStreamCallback></a> m_CallbackList; <a name="l00387"></a>00387 <a name="l00389"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicStream.html#ca46c0f8a44c2d6318dc9183fbe047f0">00389</a> <a class="code" href="classCS_1_1SndSys_1_1Queue.html">Queue<StreamNotificationEvent></a> m_NotificationQueue; <a name="l00390"></a>00390 }; <a name="l00391"></a>00391 <a name="l00392"></a>00392 <a name="l00393"></a>00393 } <a name="l00394"></a>00394 <span class="comment">// END namespace CS::SndSys</span> <a name="l00395"></a>00395 } <a name="l00396"></a>00396 <span class="comment">// END namespace CS</span> <a name="l00397"></a>00397 <a name="l00398"></a>00398 <a name="l00399"></a>00399 <a name="l00400"></a>00400 <a name="l00401"></a>00401 <span class="preprocessor">#endif // #ifndef SNDSTREAM_H</span> <a name="l00402"></a>00402 <span class="preprocessor"></span> </pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>