<!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>Audacious: plugins.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.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Audacious <span id="projectnumber">$Id:Doxyfile42802007-03-2104:39:00Znenolod$</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>plugins.h</h1> </div>
</div>
<div class="contents">
<a href="plugins_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * plugins.h</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2010 John Lindgren</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of Audacious.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Audacious is free software: you can redistribute it and/or modify it under</span>
<a name="l00008"></a>00008 <span class="comment"> * the terms of the GNU General Public License as published by the Free Software</span>
<a name="l00009"></a>00009 <span class="comment"> * Foundation, version 2 or version 3 of the License.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * Audacious is distributed in the hope that it will be useful, but WITHOUT ANY</span>
<a name="l00012"></a>00012 <span class="comment"> * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR</span>
<a name="l00013"></a>00013 <span class="comment"> * A PARTICULAR PURPOSE. See the GNU General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU General Public License along with</span>
<a name="l00016"></a>00016 <span class="comment"> * Audacious. If not, see <http://www.gnu.org/licenses/>.</span>
<a name="l00017"></a>00017 <span class="comment"> *</span>
<a name="l00018"></a>00018 <span class="comment"> * The Audacious team does not consider modular code linking to Audacious or</span>
<a name="l00019"></a>00019 <span class="comment"> * using our public API to be a derived work.</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef AUDACIOUS_PLUGINS_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define AUDACIOUS_PLUGINS_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <glib.h></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <audacious/api.h></span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">enum</span> {
<a name="l00029"></a><a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4dab99d18fad9d8c4fa42f16ec442d31055">00029</a> <a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4dab99d18fad9d8c4fa42f16ec442d31055">PLUGIN_TYPE_BASIC</a>,
<a name="l00030"></a><a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4da90ccc132a4f44b46e7b671831fc62359">00030</a> <a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4da90ccc132a4f44b46e7b671831fc62359">PLUGIN_TYPE_INPUT</a>,
<a name="l00031"></a><a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4da7749536cd9ea272f74294480091674c7">00031</a> <a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4da7749536cd9ea272f74294480091674c7">PLUGIN_TYPE_OUTPUT</a>,
<a name="l00032"></a><a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4dae9f4cb7a4f78b0bf25be57d1b05cb613">00032</a> <a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4dae9f4cb7a4f78b0bf25be57d1b05cb613">PLUGIN_TYPE_EFFECT</a>,
<a name="l00033"></a><a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4da542b11c7fdb0b7ff2dd4f315923efccf">00033</a> <a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4da542b11c7fdb0b7ff2dd4f315923efccf">PLUGIN_TYPE_VIS</a>,
<a name="l00034"></a><a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4dac11f2b0af43ad87a1eb968032654e4fc">00034</a> <a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4dac11f2b0af43ad87a1eb968032654e4fc">PLUGIN_TYPE_IFACE</a>,
<a name="l00035"></a><a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4da1755e93b8489ab99d93ae2984de17343">00035</a> <a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4da1755e93b8489ab99d93ae2984de17343">PLUGIN_TYPE_GENERAL</a>,
<a name="l00036"></a><a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4da19772b5cbccf50bc78640ca70094c2d6">00036</a> <a class="code" href="plugins_8h.html#a16af7b253440dadd46a80a4b9fddba4da19772b5cbccf50bc78640ca70094c2d6">PLUGIN_TYPES</a>};
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structPluginHandle.html">PluginHandle</a> <a class="code" href="structPluginHandle.html">PluginHandle</a>;
<a name="l00039"></a><a class="code" href="plugins_8h.html#aca40a3a62c5957dc9ac52e5cbd131016">00039</a> <span class="keyword">typedef</span> <a class="code" href="configdb-api_8h.html#a3ac4dad7ee7fd2890139bff9a134ee9a">gboolean</a> (* <a class="code" href="plugins_8h.html#aca40a3a62c5957dc9ac52e5cbd131016">PluginForEachFunc</a>) (<a class="code" href="structPluginHandle.html">PluginHandle</a> * plugin, <span class="keywordtype">void</span> * <a class="code" href="misc-api_8h.html#a2a40119722f785a93d720b769541a543">data</a>);
<a name="l00040"></a>00040
<a name="l00041"></a><a class="code" href="plugins_8h.html#abc0fc45d45b7fb41924d4b32e6928609">00041</a> <span class="preprocessor">#define AUD_API_NAME PluginsAPI</span>
<a name="l00042"></a><a class="code" href="plugins_8h.html#a84385a6137955fddd65af51f493d08e4">00042</a> <span class="preprocessor"></span><span class="preprocessor">#define AUD_API_SYMBOL plugins_api</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span>
<a name="l00044"></a>00044 <span class="preprocessor">#ifdef _AUDACIOUS_CORE</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span>
<a name="l00046"></a>00046 <span class="preprocessor">#include "<a class="code" href="api-local-begin_8h.html">api-local-begin.h</a>"</span>
<a name="l00047"></a>00047 <span class="preprocessor">#include "<a class="code" href="plugins-api_8h.html">plugins-api.h</a>"</span>
<a name="l00048"></a>00048 <span class="preprocessor">#include "<a class="code" href="api-local-end_8h.html">api-local-end.h</a>"</span>
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keyword">enum</span> {
<a name="l00051"></a>00051 INPUT_KEY_SCHEME,
<a name="l00052"></a>00052 INPUT_KEY_EXTENSION,
<a name="l00053"></a>00053 INPUT_KEY_MIME,
<a name="l00054"></a>00054 INPUT_KEYS};
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keywordtype">void</span> <a class="code" href="plugin-registry_8c.html#a60887db76f52e7c84b30db0148704dbd">plugin_registry_load</a> (<span class="keywordtype">void</span>);
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="plugin-registry_8c.html#adc6170e00c511ac50841d844ba1f79ab">plugin_registry_prune</a> (<span class="keywordtype">void</span>);
<a name="l00058"></a>00058 <span class="keywordtype">void</span> <a class="code" href="plugin-registry_8c.html#a37933cbcb27ac97a8857f42fe95677d4">plugin_registry_save</a> (<span class="keywordtype">void</span>);
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keywordtype">void</span> <a class="code" href="plugin-registry_8c.html#a2a526916cd2b7caaee705be75619e97f">module_register</a> (<span class="keyword">const</span> gchar * <a class="code" href="plugins-api_8h.html#aed23534511ec9dec0630ca4854c4552b">path</a>);
<a name="l00061"></a>00061 <span class="keywordtype">void</span> <a class="code" href="plugin-registry_8c.html#a8f08de7cf4ee8683f534dfce0f249524">plugin_register</a> (<span class="keyword">const</span> gchar * <a class="code" href="plugins-api_8h.html#aed23534511ec9dec0630ca4854c4552b">path</a>, <a class="code" href="misc-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> <a class="code" href="plugins-api_8h.html#aadb7c01f728e0e29453ee3c1279b3746">type</a>, <a class="code" href="misc-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> <a class="code" href="structPluginHandle.html#ae0e5337b94f5ede79d928c36c475d6ef">number</a>, <span class="keywordtype">void</span> * <a class="code" href="structPluginHandle.html#a10bb90556ae4c04231c260582307910e">header</a>);
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keywordtype">void</span> <a class="code" href="plugin-registry_8c.html#a76c9501f0af75773187e70aa7f476298">input_plugin_for_key</a> (<a class="code" href="misc-api_8h.html#acf599c059f43e0cca83145eb6b0c93cd">gint</a> <a class="code" href="configdb-api_8h.html#a38fda4676b99f6c8df6a7fd772335d7d">key</a>, <span class="keyword">const</span> gchar * value, <a class="code" href="plugins_8h.html#aca40a3a62c5957dc9ac52e5cbd131016">PluginForEachFunc</a>
<a name="l00064"></a>00064 <a class="code" href="plugins-api_8h.html#accb587ebf49707e5bc9a7cb9686c2ab3">func</a>, <span class="keywordtype">void</span> * <a class="code" href="misc-api_8h.html#a2a40119722f785a93d720b769541a543">data</a>);
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="preprocessor">#else</span>
<a name="l00067"></a>00067 <span class="preprocessor"></span>
<a name="l00068"></a>00068 <span class="preprocessor">#include <audacious/api-define-begin.h></span>
<a name="l00069"></a>00069 <span class="preprocessor">#include <audacious/plugins-api.h></span>
<a name="l00070"></a>00070 <span class="preprocessor">#include <audacious/api-define-end.h></span>
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="preprocessor">#include <audacious/api-alias-begin.h></span>
<a name="l00073"></a>00073 <span class="preprocessor">#include <audacious/plugins-api.h></span>
<a name="l00074"></a>00074 <span class="preprocessor">#include <audacious/api-alias-end.h></span>
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="preprocessor">#endif</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span>
<a name="l00078"></a>00078 <span class="preprocessor">#undef AUD_API_NAME</span>
<a name="l00079"></a>00079 <span class="preprocessor"></span><span class="preprocessor">#undef AUD_API_SYMBOL</span>
<a name="l00080"></a>00080 <span class="preprocessor"></span>
<a name="l00081"></a>00081 <span class="preprocessor">#endif</span>
<a name="l00082"></a>00082 <span class="preprocessor"></span>
<a name="l00083"></a>00083 <span class="preprocessor">#ifdef AUD_API_DECLARE</span>
<a name="l00084"></a>00084 <span class="preprocessor"></span>
<a name="l00085"></a>00085 <span class="preprocessor">#define AUD_API_NAME PluginsAPI</span>
<a name="l00086"></a>00086 <span class="preprocessor"></span><span class="preprocessor">#define AUD_API_SYMBOL plugins_api</span>
<a name="l00087"></a>00087 <span class="preprocessor"></span>
<a name="l00088"></a>00088 <span class="preprocessor">#include "<a class="code" href="api-define-begin_8h.html">api-define-begin.h</a>"</span>
<a name="l00089"></a>00089 <span class="preprocessor">#include "<a class="code" href="plugins-api_8h.html">plugins-api.h</a>"</span>
<a name="l00090"></a>00090 <span class="preprocessor">#include "<a class="code" href="api-define-end_8h.html">api-define-end.h</a>"</span>
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="preprocessor">#include "<a class="code" href="api-declare-begin_8h.html">api-declare-begin.h</a>"</span>
<a name="l00093"></a>00093 <span class="preprocessor">#include "<a class="code" href="plugins-api_8h.html">plugins-api.h</a>"</span>
<a name="l00094"></a>00094 <span class="preprocessor">#include "<a class="code" href="api-declare-end_8h.html">api-declare-end.h</a>"</span>
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="preprocessor">#undef AUD_API_NAME</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span><span class="preprocessor">#undef AUD_API_SYMBOL</span>
<a name="l00098"></a>00098 <span class="preprocessor"></span>
<a name="l00099"></a>00099 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Apr 17 2011 for Audacious by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
