comparison code-docs/hostguard_8h_source.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
comparison
equal deleted inserted replaced
0:895ae8fffdb7 1:3c430ef1ed66
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 <title>VampPluginSDK: hostguard.h Source File</title>
6
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="resize.js"></script>
12 <script type="text/javascript" src="navtree.js"></script>
13 <script type="text/javascript">
14 $(document).ready(initResizable);
15 </script>
16
17
18 </head>
19 <body>
20 <div id="top"><!-- do not remove this div! -->
21
22
23 <div id="titlearea">
24 <table cellspacing="0" cellpadding="0">
25 <tbody>
26 <tr style="height: 56px;">
27
28
29 <td style="padding-left: 0.5em;">
30 <div id="projectname">VampPluginSDK
31 &#160;<span id="projectnumber">2.1</span>
32 </div>
33
34 </td>
35
36
37
38 </tr>
39 </tbody>
40 </table>
41 </div>
42
43 <!-- Generated by Doxygen 1.7.5.1 -->
44 <div id="navrow1" class="tabs">
45 <ul class="tablist">
46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li><a href="annotated.html"><span>Classes</span></a></li>
49 <li class="current"><a href="files.html"><span>Files</span></a></li>
50 <li><a href="dirs.html"><span>Directories</span></a></li>
51 </ul>
52 </div>
53 <div id="navrow2" class="tabs2">
54 <ul class="tablist">
55 <li><a href="files.html"><span>File&#160;List</span></a></li>
56 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
57 </ul>
58 </div>
59 </div>
60 <div id="side-nav" class="ui-resizable side-nav-resizable">
61 <div id="nav-tree">
62 <div id="nav-tree-contents">
63 </div>
64 </div>
65 <div id="splitbar" style="-moz-user-select:none;"
66 class="ui-resizable-handle">
67 </div>
68 </div>
69 <script type="text/javascript">
70 initNavTree('hostguard_8h.html','');
71 </script>
72 <div id="doc-content">
73 <div class="header">
74 <div class="headertitle">
75 <div class="title">hostguard.h</div> </div>
76 </div>
77 <div class="contents">
78 <a href="hostguard_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */</span>
79 <a name="l00002"></a>00002
80 <a name="l00003"></a>00003 <span class="comment">/*</span>
81 <a name="l00004"></a>00004 <span class="comment"> Vamp</span>
82 <a name="l00005"></a>00005 <span class="comment"></span>
83 <a name="l00006"></a>00006 <span class="comment"> An API for audio analysis and feature extraction plugins.</span>
84 <a name="l00007"></a>00007 <span class="comment"></span>
85 <a name="l00008"></a>00008 <span class="comment"> Centre for Digital Music, Queen Mary, University of London.</span>
86 <a name="l00009"></a>00009 <span class="comment"> Copyright 2006 Chris Cannam.</span>
87 <a name="l00010"></a>00010 <span class="comment"> </span>
88 <a name="l00011"></a>00011 <span class="comment"> Permission is hereby granted, free of charge, to any person</span>
89 <a name="l00012"></a>00012 <span class="comment"> obtaining a copy of this software and associated documentation</span>
90 <a name="l00013"></a>00013 <span class="comment"> files (the &quot;Software&quot;), to deal in the Software without</span>
91 <a name="l00014"></a>00014 <span class="comment"> restriction, including without limitation the rights to use, copy,</span>
92 <a name="l00015"></a>00015 <span class="comment"> modify, merge, publish, distribute, sublicense, and/or sell copies</span>
93 <a name="l00016"></a>00016 <span class="comment"> of the Software, and to permit persons to whom the Software is</span>
94 <a name="l00017"></a>00017 <span class="comment"> furnished to do so, subject to the following conditions:</span>
95 <a name="l00018"></a>00018 <span class="comment"></span>
96 <a name="l00019"></a>00019 <span class="comment"> The above copyright notice and this permission notice shall be</span>
97 <a name="l00020"></a>00020 <span class="comment"> included in all copies or substantial portions of the Software.</span>
98 <a name="l00021"></a>00021 <span class="comment"></span>
99 <a name="l00022"></a>00022 <span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,</span>
100 <a name="l00023"></a>00023 <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
101 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span>
102 <a name="l00025"></a>00025 <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR</span>
103 <a name="l00026"></a>00026 <span class="comment"> ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF</span>
104 <a name="l00027"></a>00027 <span class="comment"> CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION</span>
105 <a name="l00028"></a>00028 <span class="comment"> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
106 <a name="l00029"></a>00029 <span class="comment"></span>
107 <a name="l00030"></a>00030 <span class="comment"> Except as contained in this notice, the names of the Centre for</span>
108 <a name="l00031"></a>00031 <span class="comment"> Digital Music; Queen Mary, University of London; and Chris Cannam</span>
109 <a name="l00032"></a>00032 <span class="comment"> shall not be used in advertising or otherwise to promote the sale,</span>
110 <a name="l00033"></a>00033 <span class="comment"> use or other dealings in this Software without prior written</span>
111 <a name="l00034"></a>00034 <span class="comment"> authorization.</span>
112 <a name="l00035"></a>00035 <span class="comment">*/</span>
113 <a name="l00036"></a>00036
114 <a name="l00037"></a>00037 <span class="preprocessor">#ifndef _VAMP_HOSTSDK_HOSTGUARD_H_</span>
115 <a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_HOSTSDK_HOSTGUARD_H_</span>
116 <a name="l00039"></a>00039 <span class="preprocessor"></span>
117 <a name="l00040"></a>00040 <span class="preprocessor">#ifdef _VAMP_IN_PLUGINSDK</span>
118 <a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#error You have included headers from both vamp-sdk and vamp-hostsdk in the same source file. Please include only vamp-sdk headers in plugin code, and only vamp-hostsdk headers in host code.</span>
119 <a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#else</span>
120 <a name="l00043"></a>00043 <span class="preprocessor"></span>
121 <a name="l00044"></a><a class="code" href="hostguard_8h.html#a1b285975a7781cd1d1cdc19b0256380f">00044</a> <span class="preprocessor">#define _VAMP_IN_HOSTSDK</span>
122 <a name="l00045"></a>00045 <span class="preprocessor"></span>
123 <a name="l00046"></a>00046 <span class="preprocessor">#ifdef _VAMP_NO_HOST_NAMESPACE</span>
124 <a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_HOSTSPACE_BEGIN(h)</span>
125 <a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_HOSTSPACE_END(h)</span>
126 <a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGSPACE_BEGIN(h)</span>
127 <a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGSPACE_END(h)</span>
128 <a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor">#else</span>
129 <a name="l00052"></a><a class="code" href="hostguard_8h.html#aef42eae5f1b0b897d8dac58cd54afbcd">00052</a> <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_HOSTSPACE_BEGIN(h) \</span>
130 <a name="l00053"></a>00053 <span class="preprocessor"> namespace _VampHost {</span>
131 <a name="l00054"></a>00054 <span class="preprocessor"></span>
132 <a name="l00055"></a><a class="code" href="hostguard_8h.html#a0e6efdc2909bdb0cfab70e087d91b171">00055</a> <span class="preprocessor">#define _VAMP_SDK_HOSTSPACE_END(h) \</span>
133 <a name="l00056"></a>00056 <span class="preprocessor"> } \</span>
134 <a name="l00057"></a>00057 <span class="preprocessor"> using namespace _VampHost;</span>
135 <a name="l00058"></a><a class="code" href="hostguard_8h.html#a1a2724ea453971288d3218e4eab3072c">00058</a> <span class="preprocessor"></span><span class="preprocessor">#define _VAMP_SDK_PLUGSPACE_BEGIN(h) \</span>
136 <a name="l00059"></a>00059 <span class="preprocessor"> namespace _VampHost {</span>
137 <a name="l00060"></a>00060 <span class="preprocessor"></span>
138 <a name="l00061"></a><a class="code" href="hostguard_8h.html#ac879bb1077ecc6132ea3581ef9033753">00061</a> <span class="preprocessor">#define _VAMP_SDK_PLUGSPACE_END(h) \</span>
139 <a name="l00062"></a>00062 <span class="preprocessor"> } \</span>
140 <a name="l00063"></a>00063 <span class="preprocessor"> using namespace _VampHost;</span>
141 <a name="l00064"></a>00064 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
142 <a name="l00065"></a>00065 <span class="preprocessor"></span>
143 <a name="l00066"></a>00066 <span class="preprocessor">#endif</span>
144 <a name="l00067"></a>00067 <span class="preprocessor"></span>
145 <a name="l00068"></a>00068 <span class="preprocessor">#endif</span>
146 <a name="l00069"></a>00069 <span class="preprocessor"></span>
147 </pre></div></div>
148 </div>
149 <div id="nav-path" class="navpath">
150 <ul>
151 <li class="navelem"><a class="el" href="hostguard_8h.html">hostguard.h</a> </li>
152
153 <li class="footer">Generated on Tue Oct 4 2011 14:38:48 for VampPluginSDK by
154 <a href="http://www.doxygen.org/index.html">
155 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
156 </ul>
157 </div>
158
159
160 </body>
161 </html>