classaflibaudio.html

来自「一个共享源码的音频库5(doc 文档)」· HTML 代码 · 共 994 行 · 第 1/3 页

    </td>
    <td>

<p>
Returns the output audio data configuration of an object.
<p>

<p>
Reimplemented in <a class="el" href="classaflibAudioFile.html#a12">aflibAudioFile</a>.    </td>
  </tr>
</table>
<a name="b12" doxytag="aflibAudio::incrementLevel"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void aflibAudio::incrementLevel </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [inline, protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="b11" doxytag="aflibAudio::isChannelsSupported"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> bool aflibAudio::isChannelsSupported </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>channels</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [protected, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Reimplemented in <a class="el" href="classaflibAudioEdit.html#a22">aflibAudioEdit</a>, <a class="el" href="classaflibAudioFile.html#a17">aflibAudioFile</a>, and <a class="el" href="classaflibAudioSampleRateCvt.html#a8">aflibAudioSampleRateCvt</a>.    </td>
  </tr>
</table>
<a name="b8" doxytag="aflibAudio::isDataSizeSupported"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> bool aflibAudio::isDataSizeSupported </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="aflib_8h.html#a30">aflib_data_size</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>size</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [protected, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Reimplemented in <a class="el" href="classaflibAudioBWFilter.html#a6">aflibAudioBWFilter</a>, <a class="el" href="classaflibAudioEdit.html#a19">aflibAudioEdit</a>, <a class="el" href="classaflibAudioFile.html#a14">aflibAudioFile</a>, <a class="el" href="classaflibAudioMixer.html#a11">aflibAudioMixer</a>, and <a class="el" href="classaflibAudioSampleRateCvt.html#a7">aflibAudioSampleRateCvt</a>.    </td>
  </tr>
</table>
<a name="b9" doxytag="aflibAudio::isEndianSupported"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> bool aflibAudio::isEndianSupported </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="aflib_8h.html#a31">aflib_data_endian</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>end</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [protected, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Reimplemented in <a class="el" href="classaflibAudioEdit.html#a20">aflibAudioEdit</a>, <a class="el" href="classaflibAudioFile.html#a15">aflibAudioFile</a>, and <a class="el" href="classaflibAudioMixer.html#a12">aflibAudioMixer</a>.    </td>
  </tr>
</table>
<a name="b10" doxytag="aflibAudio::isSampleRateSupported"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> bool aflibAudio::isSampleRateSupported </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>rate</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [protected, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Reimplemented in <a class="el" href="classaflibAudioEdit.html#a21">aflibAudioEdit</a>, <a class="el" href="classaflibAudioFile.html#a16">aflibAudioFile</a>, and <a class="el" href="classaflibAudioMixer.html#a13">aflibAudioMixer</a>.    </td>
  </tr>
</table>
<a name="b7" doxytag="aflibAudio::preprocessChain"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void aflibAudio::preprocessChain </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">aflibAudio *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>audio</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>aflibAudio *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>child</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a13" doxytag="aflibAudio::process"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="classaflibData.html">aflibData</a> * aflibAudio::process </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="aflib_8h.html#a33">aflibStatus</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>ret_status</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>long long&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>position</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>int &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>num_samples</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>bool&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>free_memory</em> = TRUE</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Main processing function for pulling data thru an audio chain.
<p>
This is the main processing function for pulling data thru an audio chain. It can be called from any aflibAudio derived object. Users should call the process function at the end of a chain. This function will then call each process function in an audio chain until the start of the chain is reached. When the start of the chain is reached then an <a class="el" href="classaflibData.html">aflibData</a> object of the proper size will be allocated and each aflibAudio derived objects compute_segment function will be called to process the data until the end of the chain is reached. This implementation will handle multiple parents automatically. It will request data from the same position and size from each parent of an object. It data of a different size or position is needed from each parent then this will need to be overriden in the derived class. This is not recommended. The first parameter will return a status to the caller. If everything worked OK then AFLIB_SUCCESS will be returned. The second is a position parameter. This indicates at which position in an audio source to read data from. This is a suggestion. It will be ignored if reading from an audio device or from an audio format that does not support random access, like mp3. The third parameter is the number of samples to pull thru the chain. If 0 is passed then the library will pick the size. This is a suggestion. It will return the actual number of samples used when pulling data thru the chain. If the caller passes FALSE to free_memory then the pointer to the <a class="el" href="classaflibData.html">aflibData</a> class containing the data will be returned. It is then the responsibility of the calling app to free this memory using delete. If no parameter is passed then it will not be returned by default. Instead NULL will be returned. 
<p>
Reimplemented in <a class="el" href="classaflibAudioEdit.html#a14">aflibAudioEdit</a>, and <a class="el" href="classaflibAudioSampleRateCvt.html#a6">aflibAudioSampleRateCvt</a>.    </td>
  </tr>
</table>
<a name="a7" doxytag="aflibAudio::setInputConfig"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void aflibAudio::setInputConfig </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classaflibConfig.html">aflibConfig</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>cfg</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets the input audio data configuration of an object.
<p>
This is a virtual function that derived classes can override if needed. It allows the caller to set the configuration of the audio data of an object. By default it saves the output audio configuration to be the same as the input data configuration that is passed in. This should be sufficient for most derived classes. For those classes that will have a change from the output to input config mapping then this function should be overriden and the output config processed and saved. 
<p>
Reimplemented in <a class="el" href="classaflibAudioBWFilter.html#a3">aflibAudioBWFilter</a>, <a class="el" href="classaflibAudioEdit.html#a18">aflibAudioEdit</a>, <a class="el" href="classaflibAudioFile.html#a9">aflibAudioFile</a>, <a class="el" href="classaflibAudioMixer.html#a8">aflibAudioMixer</a>, <a class="el" href="classaflibAudioPitch.html#a2">aflibAudioPitch</a>, <a class="el" href="classaflibAudioSampleRateCvt.html#a3">aflibAudioSampleRateCvt</a>, and <a class="el" href="classaflibAudioSpectrum.html#a5">aflibAudioSpectrum</a>.    </td>
  </tr>
</table>
<a name="a9" doxytag="aflibAudio::setOutputConfig"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void aflibAudio::setOutputConfig </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classaflibConfig.html">aflibConfig</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>cfg</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets the output audio data configuration of an object.
<p>
This is a virtual function that derived classes can override if needed. Most derived classes will not need to override this function but can  simply call it to store the output audio configuration. It is virtual so that it can be overriden by the <a class="el" href="classaflibAudioFile.html">aflibAudioFile</a> class which needs to implement its own. 
<p>
Reimplemented in <a class="el" href="classaflibAudioFile.html#a11">aflibAudioFile</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="aflibAudio_8h-source.html">aflibAudio.h</a><li><a class="el" href="aflibAudio_8cc.html">aflibAudio.cc</a></ul>
<hr><address align="right"><small>Generated on Wed May 8 20:51:08 2002 for Open Source Audio Library Project by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.15 </small></address>
</body>
</html>