DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
377 Commits
7 Branches
52MB
Tree: c3bc5b1d02
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'c3bc5b1d02'
${ noResults }
DPF/index.html

169 lines
10KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.8"/>

  7. <title>DISTRHO Plugin Framework: DISTRHO Plugin Framework</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/search.js"></script>

  13. <script type="text/javascript">

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  17. </head>

  18. <body>

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  20. <div id="titlearea">

  21. <table cellspacing="0" cellpadding="0">

  22.  <tbody>

  23.  <tr style="height: 56px;">

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">DISTRHO Plugin Framework

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

  32. <!-- end header part -->

  33. <!-- Generated by Doxygen 1.8.8 -->

  34. <script type="text/javascript">

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  36. </script>

  37.   <div id="navrow1" class="tabs">

  38.     <ul class="tablist">

  39.       <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>

  40.       <li><a href="modules.html"><span>Modules</span></a></li>

  41.       <li><a href="annotated.html"><span>Classes</span></a></li>

  42.       <li><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

  47.                onmouseover="return searchBox.OnSearchSelectShow()"

  48.                onmouseout="return searchBox.OnSearchSelectHide()"

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61. </div><!-- top -->

  62. <!-- window showing the filter options -->

  63. <div id="MSearchSelectWindow"

  64.      onmouseover="return searchBox.OnSearchSelectShow()"

  65.      onmouseout="return searchBox.OnSearchSelectHide()"

  66.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  67. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  68. 

  69. <!-- iframe showing the search results (closed by default) -->

  70. <div id="MSearchResultsWindow">

  71. <iframe src="javascript:void(0)" frameborder="0" 

  72.         name="MSearchResults" id="MSearchResults">

  73. </iframe>

  74. </div>

  75. 

  76. <div class="header">

  77.   <div class="headertitle">

  78. <div class="title">DISTRHO Plugin Framework </div>  </div>

  79. </div><!--header-->

  80. <div class="contents">

  81. <div class="textblock"><p>DISTRHO Plugin Framework (or <b>DPF</b> for short) is a plugin framework designed to make development of new plugins an easy and enjoyable task.<br />

  82. It allows developers to create plugins with custom UIs using a simple C++ API.</p>

  83. <h1><a class="anchor" id="Macros"></a>

  84. Macros</h1>

  85. <p>You start by creating a "DistrhoPluginInfo.h" file describing the plugin via macros, see <a class="el" href="group__PluginMacros.html">Plugin Macros</a>.<br />

  86. This file is included in the main DPF code to figure out which features for each plugin format to export.</p>

  87. <p>For example, a plugin (with UI) that use states will require LV2 hosts to support Atom and Worker extensions for message passing from the UI to the plugin.<br />

  88. If your plugin does not make use of states, the Worker extension is not set as a required feature.</p>

  89. <h1><a class="anchor" id="Plugin"></a>

  90. Plugin</h1>

  91. <p>The next step is to create your plugin code by subclassing DPF's <a class="el" href="classPlugin.html">Plugin</a> class.<br />

  92. You need to pass the number of parameters in the constructor and also the number of programs and states, if any.</p>

  93. <p>Here's an example of an audio plugin that simply mutes the host output: </p><div class="fragment"><div class="line"><span class="keyword">class </span>MutePlugin : <span class="keyword">public</span> <a class="code" href="classPlugin.html">Plugin</a></div>

  94. <div class="line">{</div>

  95. <div class="line"><span class="keyword">public</span>:</div>

  96. <div class="line">   MutePlugin()</div>

  97. <div class="line">       : <a class="code" href="classPlugin.html">Plugin</a>(0, 0, 0) <span class="comment">// 0 parameters, 0 programs and 0 states</span></div>

  98. <div class="line">   {</div>

  99. <div class="line">   }</div>

  100. <div class="line"></div>

  101. <div class="line"><span class="keyword">protected</span>:</div>

  102. <div class="line">   <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a00f7945c16149db6845fbcc2af729f4f">getLabel</a>()<span class="keyword"> const override</span></div>

  103. <div class="line"><span class="keyword">   </span>{</div>

  104. <div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;Mute&quot;</span>;</div>

  105. <div class="line">   }</div>

  106. <div class="line"></div>

  107. <div class="line">   <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a955832840de786a7a22798f0ef451c5d">getMaker</a>()<span class="keyword"> const override</span></div>

  108. <div class="line"><span class="keyword">   </span>{</div>

  109. <div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;DPF&quot;</span>;</div>

  110. <div class="line">   }</div>

  111. <div class="line"></div>

  112. <div class="line">   <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPlugin.html#a686a3c92a376a185d6fd97efd59125d1">getLicense</a>()<span class="keyword"> const override</span></div>

  113. <div class="line"><span class="keyword">   </span>{</div>

  114. <div class="line">       <span class="keywordflow">return</span> <span class="stringliteral">&quot;MIT&quot;</span>;</div>

  115. <div class="line">   }</div>

  116. <div class="line"></div>

  117. <div class="line">   uint32_t <a class="code" href="classPlugin.html#abae540dd93caf4834270358a8aad334a">getVersion</a>()<span class="keyword"> const override</span></div>

  118. <div class="line"><span class="keyword">   </span>{</div>

  119. <div class="line">       <span class="keywordflow">return</span> 0x1000;</div>

  120. <div class="line">   }</div>

  121. <div class="line"></div>

  122. <div class="line">   int64_t <a class="code" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">getUniqueId</a>()<span class="keyword"> const override</span></div>

  123. <div class="line"><span class="keyword">   </span>{</div>

  124. <div class="line">       <span class="keywordflow">return</span> cconst(<span class="charliteral">&#39;M&#39;</span>, <span class="charliteral">&#39;u&#39;</span>, <span class="charliteral">&#39;t&#39;</span>, <span class="charliteral">&#39;e&#39;</span>);</div>

  125. <div class="line">   }</div>

  126. <div class="line"></div>

  127. <div class="line">   <span class="keywordtype">void</span> <a class="code" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>**, <span class="keywordtype">float</span>** outputs, uint32_t frames)<span class="keyword"> override</span></div>

  128. <div class="line"><span class="keyword">   </span>{</div>

  129. <div class="line">       <span class="comment">// get the left and right audio outputs</span></div>

  130. <div class="line">       <span class="keywordtype">float</span>* <span class="keyword">const</span> outL = outputs[0];</div>

  131. <div class="line">       <span class="keywordtype">float</span>* <span class="keyword">const</span> outR = outputs[1];</div>

  132. <div class="line"></div>

  133. <div class="line">       <span class="comment">// mute audio</span></div>

  134. <div class="line">       std::memset(outL, 0, <span class="keyword">sizeof</span>(<span class="keywordtype">float</span>)*frames);</div>

  135. <div class="line">       std::memset(outR, 0, <span class="keyword">sizeof</span>(<span class="keywordtype">float</span>)*frames);</div>

  136. <div class="line">   }</div>

  137. <div class="line">};</div>

  138. </div><!-- fragment --><p>See the <a class="el" href="index.html#Plugin">Plugin</a> class for more information and to understand what each function does.</p>

  139. <h1><a class="anchor" id="Parameters"></a>

  140. Parameters</h1>

  141. <p>describe input and output, automable and rt safe, boolean etc, cv</p>

  142. <h1><a class="anchor" id="Programs"></a>

  143. Programs</h1>

  144. <p>describe them</p>

  145. <h1><a class="anchor" id="States"></a>

  146. States</h1>

  147. <p>describe them</p>

  148. <h1><a class="anchor" id="MIDI"></a>

  149. MIDI</h1>

  150. <p>describe them</p>

  151. <h1><a class="anchor" id="Latency"></a>

  152. Latency</h1>

  153. <p>describe it</p>

  154. <h1><a class="anchor" id="Time-Position"></a>

  155. Time-Position</h1>

  156. <p>describe it</p>

  157. <h1><a class="anchor" id="UI"></a>

  158. UI</h1>

  159. <p>describe them </p>

  160. </div></div><!-- contents -->

  161. <!-- start footer part -->

  162. <hr class="footer"/><address class="footer"><small>

  163. Generated on Sun Apr 26 2015 14:55:15 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  164. <img class="footer" src="doxygen.png" alt="doxygen"/>

  165. </a> 1.8.8

  166. </small></address>

  167. </body>

  168. </html>