<!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"/>
<title>SLV2: plugininstance.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>plugininstance.h</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* SLV2</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2007-2009 Dave Robillard <http://drobilla.net></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 modify it</span>
<a name="l00005"></a>00005 <span class="comment"> * under the terms of the GNU General Public License as published by the Free</span>
<a name="l00006"></a>00006 <span class="comment"> * Software Foundation; either version 2 of the License, or (at your option)</span>
<a name="l00007"></a>00007 <span class="comment"> * 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, but WITHOUT</span>
<a name="l00010"></a>00010 <span class="comment"> * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span>
<a name="l00011"></a>00011 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License</span>
<a name="l00012"></a>00012 <span class="comment"> * 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 License along</span>
<a name="l00015"></a>00015 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00016"></a>00016 <span class="comment"> * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.</span>
<a name="l00017"></a>00017 <span class="comment"> */</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __SLV2_PLUGININSTANCE_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __SLV2_PLUGININSTANCE_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00024"></a>00024 <span class="preprocessor">#endif</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <stddef.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <stdlib.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "lv2.h"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "slv2/plugin.h"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "slv2/port.h"</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">typedef</span> <span class="keyword">struct </span>_InstanceImpl* SLV2InstanceImpl;
<a name="l00033"></a>00033
<a name="l00036"></a>00036 <span class="comment">/* Instance of a plugin.</span>
<a name="l00037"></a>00037 <span class="comment"> *</span>
<a name="l00038"></a>00038 <span class="comment"> * The LV2 descriptor and handle of this are exposed to allow inlining of</span>
<a name="l00039"></a>00039 <span class="comment"> * performance critical functions like slv2_instance_run (which are exposed</span>
<a name="l00040"></a>00040 <span class="comment"> * in lv2.h anyway). This is for performance only, this struct is not</span>
<a name="l00041"></a>00041 <span class="comment"> * documented and should not be used directly. The remaining implementation</span>
<a name="l00042"></a>00042 <span class="comment"> * details are in the opaque pimpl member.</span>
<a name="l00043"></a>00043 <span class="comment"> */</span>
<a name="l00044"></a>00044 <span class="keyword">typedef</span> <span class="keyword">struct </span>_Instance {
<a name="l00045"></a>00045 <span class="keyword">const</span> LV2_Descriptor* lv2_descriptor;
<a name="l00046"></a>00046 LV2_Handle lv2_handle;
<a name="l00047"></a>00047 SLV2InstanceImpl pimpl;
<a name="l00048"></a>00048 }* SLV2Instance;
<a name="l00049"></a>00049
<a name="l00077"></a>00077 SLV2Instance
<a name="l00078"></a>00078 <a class="code" href="group__slv2__library.html#gaa4a37fe6fdd901e9498ee64b834456dc" title="Instantiate a plugin.">slv2_plugin_instantiate</a>(SLV2Plugin plugin,
<a name="l00079"></a>00079 <span class="keywordtype">double</span> sample_rate,
<a name="l00080"></a>00080 <span class="keyword">const</span> LV2_Feature*<span class="keyword">const</span>* features);
<a name="l00081"></a>00081
<a name="l00082"></a>00082
<a name="l00087"></a>00087 <span class="keywordtype">void</span>
<a name="l00088"></a>00088 <a class="code" href="group__slv2__library.html#gad30406911275d08a9bc34fc16373a849" title="Free a plugin instance.">slv2_instance_free</a>(SLV2Instance instance);
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="preprocessor">#ifndef LIBSLV2_SOURCE</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span>
<a name="l00096"></a>00096 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span>*
<a name="l00097"></a><a class="code" href="group__slv2__library.html#ga6c8419d13f7ff40a7e417bff709bdf85">00097</a> <a class="code" href="group__slv2__library.html#ga6c8419d13f7ff40a7e417bff709bdf85" title="Get the URI of the plugin which instance is an instance of.">slv2_instance_get_uri</a>(SLV2Instance instance)
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099 <span class="keywordflow">return</span> instance->lv2_descriptor->URI;
<a name="l00100"></a>00100 }
<a name="l00101"></a>00101
<a name="l00102"></a>00102
<a name="l00108"></a>00108 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
<a name="l00109"></a><a class="code" href="group__slv2__library.html#ga229db619d64c3a03cf7c3adfe5455bc1">00109</a> <a class="code" href="group__slv2__library.html#ga229db619d64c3a03cf7c3adfe5455bc1" title="Connect a port to a data location.">slv2_instance_connect_port</a>(SLV2Instance instance,
<a name="l00110"></a>00110 uint32_t port_index,
<a name="l00111"></a>00111 <span class="keywordtype">void</span>* data_location)
<a name="l00112"></a>00112 {
<a name="l00113"></a>00113 instance->lv2_descriptor->connect_port
<a name="l00114"></a>00114 (instance->lv2_handle, port_index, data_location);
<a name="l00115"></a>00115 }
<a name="l00116"></a>00116
<a name="l00117"></a>00117
<a name="l00124"></a>00124 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
<a name="l00125"></a><a class="code" href="group__slv2__library.html#gafca18967cc2a47d475ff5f98def1d6c2">00125</a> <a class="code" href="group__slv2__library.html#gafca18967cc2a47d475ff5f98def1d6c2" title="Activate a plugin instance.">slv2_instance_activate</a>(SLV2Instance instance)
<a name="l00126"></a>00126 {
<a name="l00127"></a>00127 <span class="keywordflow">if</span> (instance->lv2_descriptor->activate)
<a name="l00128"></a>00128 instance->lv2_descriptor->activate(instance->lv2_handle);
<a name="l00129"></a>00129 }
<a name="l00130"></a>00130
<a name="l00131"></a>00131
<a name="l00137"></a>00137 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
<a name="l00138"></a><a class="code" href="group__slv2__library.html#gab4b0b8304ad52ea754f8718e19a55555">00138</a> <a class="code" href="group__slv2__library.html#gab4b0b8304ad52ea754f8718e19a55555" title="Run instance for sample_count frames.">slv2_instance_run</a>(SLV2Instance instance,
<a name="l00139"></a>00139 uint32_t sample_count)
<a name="l00140"></a>00140 {
<a name="l00141"></a>00141 <span class="comment">/*if (instance->lv2_descriptor->run)*/</span>
<a name="l00142"></a>00142 instance->lv2_descriptor->run(instance->lv2_handle, sample_count);
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144
<a name="l00145"></a>00145
<a name="l00151"></a>00151 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
<a name="l00152"></a><a class="code" href="group__slv2__library.html#gac0c874b71b4b3ae3b2e9f6bbf8c09ad7">00152</a> <a class="code" href="group__slv2__library.html#gac0c874b71b4b3ae3b2e9f6bbf8c09ad7" title="Deactivate a plugin instance.">slv2_instance_deactivate</a>(SLV2Instance instance)
<a name="l00153"></a>00153 {
<a name="l00154"></a>00154 <span class="keywordflow">if</span> (instance->lv2_descriptor->deactivate)
<a name="l00155"></a>00155 instance->lv2_descriptor->deactivate(instance->lv2_handle);
<a name="l00156"></a>00156 }
<a name="l00157"></a>00157
<a name="l00158"></a>00158
<a name="l00164"></a>00164 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">void</span>*
<a name="l00165"></a><a class="code" href="group__slv2__library.html#gae4de9a82faf53cd45f0755d476a484e0">00165</a> <a class="code" href="group__slv2__library.html#gae4de9a82faf53cd45f0755d476a484e0" title="Get extension data from the plugin instance.">slv2_instance_get_extension_data</a>(SLV2Instance instance,
<a name="l00166"></a>00166 <span class="keyword">const</span> <span class="keywordtype">char</span>* uri)
<a name="l00167"></a>00167 {
<a name="l00168"></a>00168 <span class="keywordflow">if</span> (instance->lv2_descriptor->extension_data)
<a name="l00169"></a>00169 <span class="keywordflow">return</span> instance->lv2_descriptor->extension_data(uri);
<a name="l00170"></a>00170 <span class="keywordflow">else</span>
<a name="l00171"></a>00171 <span class="keywordflow">return</span> NULL;
<a name="l00172"></a>00172 }
<a name="l00173"></a>00173
<a name="l00174"></a>00174
<a name="l00182"></a>00182 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">const</span> LV2_Descriptor*
<a name="l00183"></a><a class="code" href="group__slv2__library.html#ga27d4c77b27244fbd898d834f328948fe">00183</a> <a class="code" href="group__slv2__library.html#ga27d4c77b27244fbd898d834f328948fe" title="Get the LV2_Descriptor of the plugin instance.">slv2_instance_get_descriptor</a>(SLV2Instance instance)
<a name="l00184"></a>00184 {
<a name="l00185"></a>00185 <span class="keywordflow">return</span> instance->lv2_descriptor;
<a name="l00186"></a>00186 }
<a name="l00187"></a>00187
<a name="l00188"></a>00188
<a name="l00196"></a>00196 <span class="keyword">static</span> <span class="keyword">inline</span> LV2_Handle
<a name="l00197"></a><a class="code" href="group__slv2__library.html#gae7fac958253fdfcbfbefb17cc354b69e">00197</a> <a class="code" href="group__slv2__library.html#gae7fac958253fdfcbfbefb17cc354b69e" title="Get the LV2_Handle of the plugin instance.">slv2_instance_get_handle</a>(SLV2Instance instance)
<a name="l00198"></a>00198 {
<a name="l00199"></a>00199 <span class="keywordflow">return</span> instance->lv2_handle;
<a name="l00200"></a>00200 }
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="preprocessor">#endif </span><span class="comment">/* LIBSLV2_SOURCE */</span>
<a name="l00203"></a>00203
<a name="l00206"></a>00206 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00207"></a>00207 <span class="preprocessor"></span>} <span class="comment">/* extern "C" */</span>
<a name="l00208"></a>00208 <span class="preprocessor">#endif</span>
<a name="l00209"></a>00209 <span class="preprocessor"></span>
<a name="l00210"></a>00210
<a name="l00211"></a>00211 <span class="preprocessor">#endif </span><span class="comment">/* __SLV2_PLUGININSTANCE_H__ */</span>
<a name="l00212"></a>00212
</pre></div></div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated for SLV2 by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.7.1</small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
d5107a51881bd9da3e41b22d3401eaf0
>
files
>
39
