Mercurial > hg > vamp-docs

view code-docs/plugins_8cpp.html @ 7:66d125fb8b42 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag vamp-plugin-sdk-v2.7 for changeset 27319718b1f8
author Chris Cannam
date Fri, 24 Feb 2017 16:45:00 +0000
parents 27319718b1f8
children
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>VampPluginSDK: plugins.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">VampPluginSDK
   &#160;<span id="projectnumber">2.7</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('plugins_8cpp.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">plugins.cpp File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="vamp_8h_source.html">vamp/vamp.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="PluginAdapter_8h_source.html">vamp-sdk/PluginAdapter.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ZeroCrossing_8h_source.html">ZeroCrossing.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="SpectralCentroid_8h_source.html">SpectralCentroid.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="PercussionOnsetDetector_8h_source.html">PercussionOnsetDetector.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="FixedTempoEstimator_8h_source.html">FixedTempoEstimator.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="AmplitudeFollower_8h_source.html">AmplitudeFollower.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="PowerSpectrum_8h_source.html">PowerSpectrum.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for plugins.cpp:</div>
<div class="dyncontent">
<div class="center"><img src="plugins_8cpp__incl.png" border="0" usemap="#plugins_8cpp" alt=""/></div>
<map name="plugins_8cpp" id="plugins_8cpp">
<area shape="rect" id="node2" href="vamp_8h.html" title="vamp/vamp.h" alt="" coords="5,152,104,177"/>
<area shape="rect" id="node3" href="PluginAdapter_8h.html" title="vamp&#45;sdk/PluginAdapter.h" alt="" coords="74,79,241,104"/>
<area shape="rect" id="node12" href="ZeroCrossing_8h.html" title="ZeroCrossing.h" alt="" coords="265,79,370,104"/>
<area shape="rect" id="node13" href="SpectralCentroid_8h.html" title="SpectralCentroid.h" alt="" coords="394,79,518,104"/>
<area shape="rect" id="node14" href="PercussionOnsetDetector_8h.html" title="PercussionOnsetDetector.h" alt="" coords="543,79,713,104"/>
<area shape="rect" id="node15" href="FixedTempoEstimator_8h.html" title="FixedTempoEstimator.h" alt="" coords="737,79,887,104"/>
<area shape="rect" id="node16" href="AmplitudeFollower_8h.html" title="AmplitudeFollower.h" alt="" coords="911,79,1044,104"/>
<area shape="rect" id="node17" href="PowerSpectrum_8h.html" title="PowerSpectrum.h" alt="" coords="1069,79,1187,104"/>
<area shape="rect" id="node5" href="vamp-sdk_2Plugin_8h.html" title="Plugin.h" alt="" coords="423,152,489,177"/>
<area shape="rect" id="node9" href="plugguard_8h.html" title="plugguard.h" alt="" coords="236,299,324,324"/>
<area shape="rect" id="node8" href="vamp-sdk_2PluginBase_8h.html" title="PluginBase.h" alt="" coords="492,225,585,251"/>
<area shape="rect" id="node10" href="vamp-sdk_2RealTime_8h.html" title="RealTime.h" alt="" coords="333,225,417,251"/>
</map>
</div>
</div>
<p><a href="plugins_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:abb0fd6db76ddd39698bc370e0fd0ea78"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#abb0fd6db76ddd39698bc370e0fd0ea78">vampGetPluginDescriptor</a> (unsigned int version, unsigned int index)</td></tr>
<tr class="memdesc:abb0fd6db76ddd39698bc370e0fd0ea78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the descriptor for a given plugin index in this library.  <a href="#abb0fd6db76ddd39698bc370e0fd0ea78">More...</a><br /></td></tr>
<tr class="separator:abb0fd6db76ddd39698bc370e0fd0ea78"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a01871ad1ab2bb64e2c53fe5cce19b780"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt; <a class="el" href="classZeroCrossing.html">ZeroCrossing</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a01871ad1ab2bb64e2c53fe5cce19b780">zeroCrossingAdapter</a></td></tr>
<tr class="separator:a01871ad1ab2bb64e2c53fe5cce19b780"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac96bdfb6356a153341b29b43c4961cd5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt; <a class="el" href="classSpectralCentroid.html">SpectralCentroid</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#ac96bdfb6356a153341b29b43c4961cd5">spectralCentroidAdapter</a></td></tr>
<tr class="separator:ac96bdfb6356a153341b29b43c4961cd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acee3823cb6a43281a2ecf923b69613dd"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt; <a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#acee3823cb6a43281a2ecf923b69613dd">percussionOnsetAdapter</a></td></tr>
<tr class="separator:acee3823cb6a43281a2ecf923b69613dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a937de36d22633261716032570064a4be"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt; <a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a937de36d22633261716032570064a4be">fixedTempoAdapter</a></td></tr>
<tr class="separator:a937de36d22633261716032570064a4be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e60bb6a99451da5deb18b969e6b16cd"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt; <a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a4e60bb6a99451da5deb18b969e6b16cd">amplitudeAdapter</a></td></tr>
<tr class="separator:a4e60bb6a99451da5deb18b969e6b16cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77810f485caaae4a8b2303496046d3d7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt; <a class="el" href="classPowerSpectrum.html">PowerSpectrum</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="plugins_8cpp.html#a77810f485caaae4a8b2303496046d3d7">powerSpectrum</a></td></tr>
<tr class="separator:a77810f485caaae4a8b2303496046d3d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="abb0fd6db76ddd39698bc370e0fd0ea78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb0fd6db76ddd39698bc370e0fd0ea78">&#9670;&nbsp;</a></span>vampGetPluginDescriptor()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="vamp_8h.html#aa1d6e0792099b9516a89b5fb7ed2ad2b">VampPluginDescriptor</a>* vampGetPluginDescriptor </td>
          <td>(</td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>hostApiVersion</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the descriptor for a given plugin index in this library. </p>
<p>Return NULL if the index is outside the range of valid indices for this plugin library.</p>
<p>The hostApiVersion argument tells the library code the highest <a class="el" href="namespaceVamp.html">Vamp</a> API version supported by the host. The function should return a plugin descriptor compatible with the highest API version supported by the library that is no higher than that supported by the host. Provided the descriptor has the correct vampApiVersion field for its actual compatibility level, the host should be able to do the right thing with it: use it if possible, discard it otherwise.</p>
<p>This is the only symbol that a <a class="el" href="namespaceVamp.html">Vamp</a> plugin actually needs to export from its shared object; all others can be hidden. See the accompanying documentation for notes on how to achieve this with certain compilers. </p>

<p class="definition">Definition at line <a class="el" href="plugins_8cpp_source.html#l00054">54</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

<p class="reference">References <a class="el" href="classVamp_1_1PluginAdapterBase.html#ad24595002512f9f00e8e45216d6f5dfb">Vamp::PluginAdapterBase::getDescriptor()</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a01871ad1ab2bb64e2c53fe5cce19b780"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01871ad1ab2bb64e2c53fe5cce19b780">&#9670;&nbsp;</a></span>zeroCrossingAdapter</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classZeroCrossing.html">ZeroCrossing</a>&gt; zeroCrossingAdapter</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="plugins_8cpp_source.html#l00047">47</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

</div>
</div>
<a id="ac96bdfb6356a153341b29b43c4961cd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac96bdfb6356a153341b29b43c4961cd5">&#9670;&nbsp;</a></span>spectralCentroidAdapter</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classSpectralCentroid.html">SpectralCentroid</a>&gt; spectralCentroidAdapter</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="plugins_8cpp_source.html#l00048">48</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

</div>
</div>
<a id="acee3823cb6a43281a2ecf923b69613dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acee3823cb6a43281a2ecf923b69613dd">&#9670;&nbsp;</a></span>percussionOnsetAdapter</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classPercussionOnsetDetector.html">PercussionOnsetDetector</a>&gt; percussionOnsetAdapter</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="plugins_8cpp_source.html#l00049">49</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

</div>
</div>
<a id="a937de36d22633261716032570064a4be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a937de36d22633261716032570064a4be">&#9670;&nbsp;</a></span>fixedTempoAdapter</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classFixedTempoEstimator.html">FixedTempoEstimator</a>&gt; fixedTempoAdapter</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="plugins_8cpp_source.html#l00050">50</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

</div>
</div>
<a id="a4e60bb6a99451da5deb18b969e6b16cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e60bb6a99451da5deb18b969e6b16cd">&#9670;&nbsp;</a></span>amplitudeAdapter</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classAmplitudeFollower.html">AmplitudeFollower</a>&gt; amplitudeAdapter</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="plugins_8cpp_source.html#l00051">51</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

</div>
</div>
<a id="a77810f485caaae4a8b2303496046d3d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77810f485caaae4a8b2303496046d3d7">&#9670;&nbsp;</a></span>powerSpectrum</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classVamp_1_1PluginAdapter.html">Vamp::PluginAdapter</a>&lt;<a class="el" href="classPowerSpectrum.html">PowerSpectrum</a>&gt; powerSpectrum</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="plugins_8cpp_source.html#l00052">52</a> of file <a class="el" href="plugins_8cpp_source.html">plugins.cpp</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d28a4824dc47e487b107a5db32ef43c4.html">examples</a></li><li class="navelem"><a class="el" href="plugins_8cpp.html">plugins.cpp</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>