<!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/snddata.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/snddata.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 <span class="preprocessor">#ifndef SNDDATA_H</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define SNDDATA_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="databuff_8h.html" title="Data Buffer interface.">iutil/databuff.h</a>"</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="ss__structs_8h.html" title="Sound system: types.">isndsys/ss_structs.h</a>"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="ss__data_8h.html" title="Sound system: data container.">isndsys/ss_data.h</a>"</span>
<a name="l00026"></a>00026 <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="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">namespace </span>CS
<a name="l00029"></a>00029 {
<a name="l00030"></a>00030 <span class="keyword">namespace </span>SndSys
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032
<a name="l00033"></a>00033
<a name="l00034"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicData.html">00034</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classCS_1_1SndSys_1_1SndSysBasicData.html">SndSysBasicData</a> :
<a name="l00035"></a>00035 <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a><SndSysBasicData, iSndSysData>
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="keyword">public</span>:
<a name="l00038"></a>00038 <a class="code" href="classCS_1_1SndSys_1_1SndSysBasicData.html">SndSysBasicData</a>(<a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a> *pParent);
<a name="l00039"></a>00039 <span class="keyword">virtual</span> ~<a class="code" href="classCS_1_1SndSys_1_1SndSysBasicData.html">SndSysBasicData</a>();
<a name="l00040"></a>00040
<a name="l00042"></a>00042 <span class="comment">// Internal functions</span>
<a name="l00044"></a>00044 <span class="comment"></span> <span class="keyword">protected</span>:
<a name="l00045"></a>00045
<a name="l00047"></a>00047 <span class="comment">// This is only called the first time that SoundFormat or SampleCount data is requested.</span>
<a name="l00048"></a>00048 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Initialize() = 0;
<a name="l00049"></a>00049
<a name="l00050"></a>00050
<a name="l00052"></a>00052 <span class="comment">// Interface implementation</span>
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment">//------------------------</span>
<a name="l00056"></a>00056 <span class="comment">// iSndSysData</span>
<a name="l00057"></a>00057 <span class="comment">//------------------------</span>
<a name="l00058"></a>00058 <span class="keyword">public</span>:
<a name="l00060"></a>00060 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="structcsSndSysSoundFormat.html" title="The sound format.">csSndSysSoundFormat</a> *GetFormat();
<a name="l00061"></a>00061
<a name="l00063"></a>00063 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetFrameCount();
<a name="l00064"></a>00064
<a name="l00073"></a>00073 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetDataSize() = 0;
<a name="l00074"></a>00074
<a name="l00079"></a>00079 <span class="keyword">virtual</span> <a class="code" href="structiSndSysStream.html" title="The primary interface for a sound stream used by the audio system.">iSndSysStream</a> *CreateStream (<a class="code" href="structcsSndSysSoundFormat.html" title="The sound format.">csSndSysSoundFormat</a> *pRenderFormat, <span class="keywordtype">int</span> Mode3D) = 0;
<a name="l00080"></a>00080
<a name="l00082"></a>00082 <span class="comment">// A filename isn't a bad idea!</span>
<a name="l00083"></a>00083 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetDescription (<span class="keyword">const</span> <span class="keywordtype">char</span> *pDescription);
<a name="l00084"></a>00084
<a name="l00086"></a>00086 <span class="comment">// This may return 0 if no description is set.</span>
<a name="l00087"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicData.html#a5988c9cd7b6b1edd2ac9abdf11bba79">00087</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetDescription() { <span class="keywordflow">return</span> m_pDescription; }
<a name="l00088"></a>00088
<a name="l00090"></a>00090 <span class="comment">// Member variables</span>
<a name="l00092"></a>00092 <span class="comment"></span> <span class="keyword">protected</span>:
<a name="l00093"></a>00093
<a name="l00095"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicData.html#f895e33412560483c4d32d2ecfb776e9">00095</a> <span class="keywordtype">bool</span> m_bInfoReady;
<a name="l00096"></a>00096
<a name="l00098"></a>00098 <span class="comment">// Currently this is the default format that the ogg vorbis library returns for a given Ogg audio file.</span>
<a name="l00099"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicData.html#bd3297c1100a80b7a720c88b9b76c789">00099</a> <a class="code" href="structcsSndSysSoundFormat.html" title="The sound format.">csSndSysSoundFormat</a> m_SoundFormat;
<a name="l00100"></a>00100
<a name="l00102"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicData.html#94fb2827f6247cb27de6807f6dd79a59">00102</a> <span class="keywordtype">size_t</span> m_FrameCount;
<a name="l00103"></a>00103
<a name="l00105"></a><a class="code" href="classCS_1_1SndSys_1_1SndSysBasicData.html#d2b107809bcac02d165df98c8bad7b9b">00105</a> <span class="keywordtype">char</span> *m_pDescription;
<a name="l00106"></a>00106 };
<a name="l00107"></a>00107
<a name="l00108"></a>00108
<a name="l00109"></a>00109
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111 <span class="comment">// END namespace CS::SndSys</span>
<a name="l00112"></a>00112 }
<a name="l00113"></a>00113 <span class="comment">// END namespace CS</span>
<a name="l00114"></a>00114
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="preprocessor">#endif // #ifndef SNDDATA_H</span>
<a name="l00117"></a>00117 <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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
2316
