<!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.3"/>
<title>Audacious: plugin.h Source File</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="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 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>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_fdd964b4528d5f83ff8d7299f798486d.html">audacious</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">plugin.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="plugin_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * plugin.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2005-2012 William Pitcock, Yoshiki Yazawa, Eugene Zagidullin, and</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * John Lindgren</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * modification, are permitted provided that the following conditions are met:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * 1. Redistributions of source code must retain the above copyright notice,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * this list of conditions, and the following disclaimer.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * this list of conditions, and the following disclaimer in the documentation</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * provided with the distribution.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * This software is provided "as is" and without any warranty, express or</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * implied. In no event shall the authors be liable for any damages arising from</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * the use of this software.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef AUDACIOUS_PLUGIN_H</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span><span class="preprocessor">#define AUDACIOUS_PLUGIN_H</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="api_8h.html">audacious/api.h</a>></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="types_8h.html">audacious/types.h</a>></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="audio_8h.html">libaudcore/audio.h</a>></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="index_8h.html">libaudcore/index.h</a>></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="tuple_8h.html" title="Basic Tuple handling API.">libaudcore/tuple.h</a>></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <<a class="code" href="vfs_8h.html" title="Main API header for accessing Audacious VFS functionality.">libaudcore/vfs.h</a>></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/* "Magic" bytes identifying an Audacious plugin header. */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="plugin_8h.html#ab637a009050bed8cafc61e904562ebbc"> 32</a></span> <span class="preprocessor">#define _AUD_PLUGIN_MAGIC 0x8EAC8DE2</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/* API version. Plugins are marked with this number at compile time.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * _AUD_PLUGIN_VERSION is the current version; _AUD_PLUGIN_VERSION_MIN is</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * the oldest one we are backward compatible with. Plugins marked older than</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * _AUD_PLUGIN_VERSION_MIN or newer than _AUD_PLUGIN_VERSION are not loaded.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * Before releases that add new pointers to the end of the API tables, increment</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * _AUD_PLUGIN_VERSION but leave _AUD_PLUGIN_VERSION_MIN the same.</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * Before releases that break backward compatibility (e.g. remove pointers from</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * the API tables), increment _AUD_PLUGIN_VERSION *and* set</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * _AUD_PLUGIN_VERSION_MIN to the same value. */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="plugin_8h.html#a5609a39b570f4db42bbd7305d4ddbff3"> 47</a></span> <span class="preprocessor">#define _AUD_PLUGIN_VERSION_MIN 40 </span><span class="comment">/* 3.3-devel to 3.3-beta1 */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="code" href="plugin_8h.html#abadf91bcd4ffae8c8dc03bd491567e96"> 48</a></span> <span class="preprocessor"></span><span class="preprocessor">#define _AUD_PLUGIN_VERSION 41 </span><span class="comment">/* post 3.3-beta1 */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">/* A NOTE ON THREADS</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * How thread-safe a plugin must be depends on the type of plugin. Note that</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * some parts of the Audacious API are *not* thread-safe and therefore cannot be</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * used in some parts of some plugins; for example, input plugins cannot use</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * GUI-related calls or access the playlist except in about() and configure().</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * Thread-safe plugins: transport, playlist, input, effect, and output. These</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * must be mostly thread-safe. init() and cleanup() may be called from</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * secondary threads; however, no other functions provided by the plugin will be</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * called at the same time. about() and configure() will be called only from</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * the main thread. All other functions provided by the plugin may be called</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * from any thread and from multiple threads simultaneously.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * Exceptions:</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * - Because many existing input plugins are not coded to handle simultaneous</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * calls to play(), play() will only be called from one thread at a time. New</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * plugins should not rely on this exception, though.</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * - Some combinations of calls, especially for output and effect plugins, make</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * no sense; for example, flush() in an output plugin will only be called</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * after open_audio() and before close_audio().</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * Single-thread plugins: visualization, general, and interface. Functions</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * provided by these plugins will only be called from the main thread. */</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">/* CROSS-PLUGIN MESSAGES</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * Since 3.2, Audacious implements a basic messaging system between plugins.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * Messages are sent using aud_plugin_send_message() and received through the</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * take_message() method specified in the header of the receiving plugin.</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * Plugins that do not need to receive messages can set take_message() to NULL.</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * Each message includes a code indicating the type of message, a pointer to</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * some data, and a value indicating the size of that data. What the message</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * data contains is entirely up to the two plugins involved. For this reason, it</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * is crucial that both plugins agree on the meaning of the message codes used.</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * Once the message is sent, an integer error code is returned. If the receiving</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * plugin does not provide the take_message() method, ENOSYS is returned. If</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * take_message() does not recognize the message code, it should ignore the</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * message and return EINVAL. An error code of zero represents success. Other</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * error codes may be used with more specific meanings.</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * For the time being, aud_plugin_send_message() should only be called from the</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * program's main thread. */</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="code" href="plugin_8h.html#a9cc7fd10deaf768870101afdffa05dec"> 96</a></span> <span class="preprocessor">#define PLUGIN_COMMON_FIELDS \</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor"> int magic; </span><span class="comment">/* checked against _AUD_PLUGIN_MAGIC */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor"> int version; </span><span class="comment">/* checked against _AUD_PLUGIN_VERSION */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor"> int type; </span><span class="comment">/* PLUGIN_TYPE_XXX */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor"> int size; </span><span class="comment">/* size in bytes of the struct */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor"> const char * name; \</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor"> const char * domain; </span><span class="comment">/* for gettext */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor"> const char * about_text; \</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor"> const PluginPreferences * prefs; \</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor"> bool_t (* init) (void); \</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor"> void (* cleanup) (void); \</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor"> int (* take_message) (const char * code, const void * data, int size); \</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor"> void (* about) (void); </span><span class="comment">/* use about_text instead if possible */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor"> void (* configure) (void); </span><span class="comment">/* use prefs instead if possible */</span><span class="preprocessor"> \</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor"> void * reserved1; \</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor"> void * reserved2; \</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor"> void * reserved3; \</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor"> void * reserved4;</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00115"></a><span class="lineno"><a class="code" href="struct__Plugin.html"> 115</a></span> <span class="keyword">struct </span><a class="code" href="struct__Plugin.html">_Plugin</a></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> {</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <a class="code" href="plugin_8h.html#a9cc7fd10deaf768870101afdffa05dec">PLUGIN_COMMON_FIELDS</a></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> };</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00120"></a><span class="lineno"><a class="code" href="struct__TransportPlugin.html"> 120</a></span> <span class="keyword">struct </span><a class="code" href="struct__TransportPlugin.html">_TransportPlugin</a></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> {</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <a class="code" href="plugin_8h.html#a9cc7fd10deaf768870101afdffa05dec">PLUGIN_COMMON_FIELDS</a></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="comment">/* supported URI schemes (without "://")</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * (array terminated with null pointer) */</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="code" href="struct__TransportPlugin.html#a468e08debbf3417844c9e812a8aa6f70"> 126</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * <span class="keyword">const</span> * <a class="code" href="struct__TransportPlugin.html#a468e08debbf3417844c9e812a8aa6f70">schemes</a>;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="comment">/* file operation implementations</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * (struct of function pointers, may contain null pointers) */</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"><a class="code" href="struct__TransportPlugin.html#a5a59e5b15da18594626f793ad3284ec5"> 130</a></span>  <span class="keyword">const</span> <a class="code" href="structVFSConstructor.html">VFSConstructor</a> * <a class="code" href="struct__TransportPlugin.html#a5a59e5b15da18594626f793ad3284ec5">vtable</a>;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> };</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a name="l00133"></a><span class="lineno"><a class="code" href="struct__PlaylistPlugin.html"> 133</a></span> <span class="keyword">struct </span><a class="code" href="struct__PlaylistPlugin.html">_PlaylistPlugin</a></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> {</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <a class="code" href="plugin_8h.html#a9cc7fd10deaf768870101afdffa05dec">PLUGIN_COMMON_FIELDS</a></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="comment">/* supported file extensions (without periods)</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * (array terminated with null pointer) */</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"><a class="code" href="struct__PlaylistPlugin.html#a2275bb7b31a7f5652da81a45104e59a6"> 139</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * <span class="keyword">const</span> * <a class="code" href="struct__PlaylistPlugin.html#a2275bb7b31a7f5652da81a45104e59a6">extensions</a>;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="comment">/* path: URI of playlist file (in)</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * file: VFS handle of playlist file (in, read-only file, not seekable)</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * title: title of playlist (out, string-pooled)</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * filenames: container to fill with URIs read from playlist file</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * (in-out, list of (char *), string-pooled)</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * tuples: container to fill with metadata read from playlist</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * (in-out, list of (Tuple *), may contain null pointers) */</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"><a class="code" href="struct__PlaylistPlugin.html#aa59661ba3520193bb43ee2c462172cec"> 148</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> (* <a class="code" href="struct__PlaylistPlugin.html#aa59661ba3520193bb43ee2c462172cec">load</a>) (<span class="keyword">const</span> <span class="keywordtype">char</span> * path, <a class="code" href="structVFSFile.html">VFSFile</a> * file, <span class="keywordtype">char</span> * * title,</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  Index * <a class="code" href="main_8c.html#a4a0ffc3e2bb1095cee8ee5e31a24c6fe">filenames</a>, Index * <a class="code" href="playlist-api_8h.html#a1fcaf4b3cb00c398b1d7c1447a3c229e">tuples</a>);</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="comment">/* path: URI of playlist file (in)</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * file: VFS handle of playlist file (in, write-only file, not seekable)</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * title: title of playlist (in)</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * filenames: container filled with URIs to be written to playlist</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * (in, list of (char *))</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * tuples: container filled with metadata to be written to playlist</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * (in, list of (Tuple *), may contain null pointers) */</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"><a class="code" href="struct__PlaylistPlugin.html#a8d9b699b7fc5cce9de35b279d77488ce"> 158</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> (* <a class="code" href="struct__PlaylistPlugin.html#a8d9b699b7fc5cce9de35b279d77488ce">save</a>) (<span class="keyword">const</span> <span class="keywordtype">char</span> * path, <a class="code" href="structVFSFile.html">VFSFile</a> * file, <span class="keyword">const</span> <span class="keywordtype">char</span> * title,</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  Index * <a class="code" href="main_8c.html#a4a0ffc3e2bb1095cee8ee5e31a24c6fe">filenames</a>, Index * <a class="code" href="playlist-api_8h.html#a1fcaf4b3cb00c398b1d7c1447a3c229e">tuples</a>);</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> };</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div>
<div class="line"><a name="l00162"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html"> 162</a></span> <span class="keyword">struct </span><a class="code" href="struct__OutputPlugin.html">_OutputPlugin</a></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> {</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <a class="code" href="plugin_8h.html#a9cc7fd10deaf768870101afdffa05dec">PLUGIN_COMMON_FIELDS</a></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="comment">/* During probing, plugins with higher priority (10 to 0) are tried first. */</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#a7119919b18b1c81ab3761f3af2833ce0"> 167</a></span>  <span class="keywordtype">int</span> <a class="code" href="struct__OutputPlugin.html#a7119919b18b1c81ab3761f3af2833ce0">probe_priority</a>;</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="comment">/* Returns current volume for left and right channels (0 to 100). */</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#a7c8c6cc66d4651d15b92e34941a9bd51"> 170</a></span>  void (* <a class="code" href="struct__OutputPlugin.html#a7c8c6cc66d4651d15b92e34941a9bd51">get_volume</a>) (<span class="keywordtype">int</span> * l, <span class="keywordtype">int</span> * r);</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="comment">/* Changes volume for left and right channels (0 to 100). */</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#a226872a92a9e1a0295d69bc7b40f376c"> 173</a></span>  void (* <a class="code" href="struct__OutputPlugin.html#a226872a92a9e1a0295d69bc7b40f376c">set_volume</a>) (<span class="keywordtype">int</span> l, <span class="keywordtype">int</span> r);</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="comment">/* Begins playback of a PCM stream. <format> is one of the FMT_*</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * enumeration values defined in libaudcore/audio.h. Returns nonzero on</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * success. */</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#a6e0aad748f3dab79f79c8b310664b9e1"> 178</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> (* <a class="code" href="struct__OutputPlugin.html#a6e0aad748f3dab79f79c8b310664b9e1">open_audio</a>) (<span class="keywordtype">int</span> <a class="code" href="audio_8c.html#a317afff57d87a89158c2b038d37b2b08">format</a>, <span class="keywordtype">int</span> <a class="code" href="equalizer_8c.html#a7a829e6fd74e94e0edf10550470d844c">rate</a>, <span class="keywordtype">int</span> chans);</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="comment">/* Ends playback. Any buffered audio data is discarded. */</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#a54671c73adbbd0a392a5b2dccb883494"> 181</a></span>  void (* <a class="code" href="struct__OutputPlugin.html#a54671c73adbbd0a392a5b2dccb883494">close_audio</a>) (void);</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="comment">/* Returns how many bytes of data may be passed to a following write_audio()</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * call. NULL if the plugin supports only blocking writes (not recommended). */</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#aaea56eef134e818aff30b7c9e06ed84d"> 185</a></span>  <a class="code" href="misc-api_8h.html#aca5b4addd5e6ab053131aaf079201165">int</a> (* <a class="code" href="struct__OutputPlugin.html#aaea56eef134e818aff30b7c9e06ed84d">buffer_free</a>) (void);</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="comment">/* Waits until buffer_free() will return a size greater than zero.</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * output_time(), pause(), and flush() may be called meanwhile; if flush()</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * is called, period_wait() should return immediately. NULL if the plugin</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * supports only blocking writes (not recommended). */</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#a05db3f8034ea89d379095f39f22b76c4"> 191</a></span>  void (* <a class="code" href="struct__OutputPlugin.html#a05db3f8034ea89d379095f39f22b76c4">period_wait</a>) (void);</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="comment">/* Buffers <size> bytes of data, in the format given to open_audio(). */</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#ab9462cd90f2937309feef6555b07e189"> 194</a></span>  void (* <a class="code" href="struct__OutputPlugin.html#ab9462cd90f2937309feef6555b07e189">write_audio</a>) (<span class="keywordtype">void</span> * data, <span class="keywordtype">int</span> size);</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <span class="comment">/* Waits until all buffered data has been heard by the user. */</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#a0e33c378edc49b61f81c4919b8232a73"> 197</a></span>  void (* <a class="code" href="struct__OutputPlugin.html#a0e33c378edc49b61f81c4919b8232a73">drain</a>) (void);</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="comment">/* Returns time count (in milliseconds) of how much data has been heard by</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> * the user. */</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#aeab738bfe7959681470ef619acb90dfa"> 201</a></span>  <a class="code" href="misc-api_8h.html#aca5b4addd5e6ab053131aaf079201165">int</a> (* <a class="code" href="struct__OutputPlugin.html#aeab738bfe7959681470ef619acb90dfa">output_time</a>) (void);</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="comment">/* Pauses the stream if <p> is nonzero; otherwise unpauses it.</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * write_audio() will not be called while the stream is paused. */</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#a1c583375c19df9f90508a46c0aa5015a"> 205</a></span>  void (* <a class="code" href="struct__OutputPlugin.html#a1c583375c19df9f90508a46c0aa5015a">pause</a>) (<a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> p);</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="comment">/* Discards any buffered audio data and sets the time counter (in</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * milliseconds) of data written. */</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#a4da56a3abc91ad97b0f9923fcffca2a8"> 209</a></span>  void (* <a class="code" href="struct__OutputPlugin.html#a4da56a3abc91ad97b0f9923fcffca2a8">flush</a>) (<span class="keywordtype">int</span> time);</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> </div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="comment">/* Whether close_audio() and open_audio() must always be called between</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * songs, even if the audio format is the same. Note that this defeats</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * gapless playback. */</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"><a class="code" href="struct__OutputPlugin.html#aef1bfd0fad3f68955e1c7eac810e7347"> 214</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> <a class="code" href="struct__OutputPlugin.html#aef1bfd0fad3f68955e1c7eac810e7347">force_reopen</a>;</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> };</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div>
<div class="line"><a name="l00217"></a><span class="lineno"><a class="code" href="struct__EffectPlugin.html"> 217</a></span> <span class="keyword">struct </span><a class="code" href="struct__EffectPlugin.html">_EffectPlugin</a></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> {</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <a class="code" href="plugin_8h.html#a9cc7fd10deaf768870101afdffa05dec">PLUGIN_COMMON_FIELDS</a></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> </div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="comment">/* All processing is done in floating point. If the effect plugin wants to</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> * change the channel count or sample rate, it can change the parameters</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * passed to start(). They cannot be changed in the middle of a song. */</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"><a class="code" href="struct__EffectPlugin.html#a90eb811b3ef3a1167d24ee15ee7f772a"> 224</a></span>  void (* <a class="code" href="struct__EffectPlugin.html#a90eb811b3ef3a1167d24ee15ee7f772a">start</a>) (<span class="keywordtype">int</span> * <a class="code" href="equalizer_8c.html#a178795099d0608972755dfef8d8367e3">channels</a>, <span class="keywordtype">int</span> * <a class="code" href="equalizer_8c.html#a7a829e6fd74e94e0edf10550470d844c">rate</a>);</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="comment">/* process() has two options: modify the samples in place and leave the data</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> * pointer unchanged or copy them into a buffer of its own. If it sets the</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> * pointer to dynamically allocated memory, it is the plugin's job to free</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> * that memory. process() may return different lengths of audio than it is</span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> * passed, even a zero length. */</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"><a class="code" href="struct__EffectPlugin.html#a645ff81271ef60c10ad88a061799ef67"> 231</a></span>  void (* <a class="code" href="struct__EffectPlugin.html#a645ff81271ef60c10ad88a061799ef67">process</a>) (<span class="keywordtype">float</span> * * data, <span class="keywordtype">int</span> * samples);</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> </div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="comment">/* Optional. A seek is taking place; any buffers should be discarded. */</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"><a class="code" href="struct__EffectPlugin.html#aad304a042bded72d35014ad23bbbceb4"> 234</a></span>  void (* <a class="code" href="struct__EffectPlugin.html#aad304a042bded72d35014ad23bbbceb4">flush</a>) (void);</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> </div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="comment">/* Exactly like process() except that any buffers should be drained (i.e.</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * the data processed and returned). finish() will be called a second time</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * at the end of the last song in the playlist. */</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"><a class="code" href="struct__EffectPlugin.html#a1640805e43c10bb70ff8f671f8805676"> 239</a></span>  void (* <a class="code" href="struct__EffectPlugin.html#a1640805e43c10bb70ff8f671f8805676">finish</a>) (<span class="keywordtype">float</span> * * data, <span class="keywordtype">int</span> * samples);</div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="comment">/* Required only for plugins that change the time domain (e.g. a time</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * stretch) or use read-ahead buffering. translate_delay() must do two</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * things: first, translate <delay> (which is in milliseconds) from the</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> * output time domain back to the input time domain; second, increase</span></div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * <delay> by the size of the read-ahead buffer. It should return the</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> * adjusted delay. */</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"><a class="code" href="struct__EffectPlugin.html#a6438865fc77501a109280aa1b6e1f051"> 247</a></span>  <a class="code" href="misc-api_8h.html#aca5b4addd5e6ab053131aaf079201165">int</a> (* <a class="code" href="struct__EffectPlugin.html#a6438865fc77501a109280aa1b6e1f051">adjust_delay</a>) (<span class="keywordtype">int</span> delay);</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="comment">/* Effects with lowest order (0 to 9) are applied first. */</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"><a class="code" href="struct__EffectPlugin.html#a6e2a9b5084f049fbf410ae4db2b04a7d"> 250</a></span>  <span class="keywordtype">int</span> <a class="code" href="struct__EffectPlugin.html#a6e2a9b5084f049fbf410ae4db2b04a7d">order</a>;</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> </div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  <span class="comment">/* If the effect does not change the number of channels or the sampling</span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> * rate, it can be enabled and disabled more smoothly. */</span></div>
<div class="line"><a name="l00254"></a><span class="lineno"><a class="code" href="struct__EffectPlugin.html#ab76220b474ef56194a603155ea4dee8c"> 254</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> <a class="code" href="struct__EffectPlugin.html#ab76220b474ef56194a603155ea4dee8c">preserves_format</a>;</div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> };</div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> </div>
<div class="line"><a name="l00257"></a><span class="lineno"><a class="code" href="structOutputAPI.html"> 257</a></span> <span class="keyword">struct </span><a class="code" href="structOutputAPI.html">OutputAPI</a></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> {</div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  <span class="comment">/* Prepares the output system for playback in the specified format. Returns</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> * TRUE on success. If the call fails, no other output functions may be</span></div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> * called. */</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"><a class="code" href="structOutputAPI.html#a8a9e6190b232d3275af1e39c4117a39a"> 262</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> (* <a class="code" href="structOutputAPI.html#a8a9e6190b232d3275af1e39c4117a39a">open_audio</a>) (<span class="keywordtype">int</span> <a class="code" href="audio_8c.html#a317afff57d87a89158c2b038d37b2b08">format</a>, <span class="keywordtype">int</span> <a class="code" href="equalizer_8c.html#a7a829e6fd74e94e0edf10550470d844c">rate</a>, <span class="keywordtype">int</span> <a class="code" href="equalizer_8c.html#a178795099d0608972755dfef8d8367e3">channels</a>);</div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> </div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="comment">/* Informs the output system of replay gain values for the current song so</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * that volume levels can be adjusted accordingly, if the user so desires.</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> * This may be called at any time during playback should the values change. */</span></div>
<div class="line"><a name="l00267"></a><span class="lineno"><a class="code" href="structOutputAPI.html#a8e02b92f6fe02e8571f83d5524fb9ae6"> 267</a></span>  void (* <a class="code" href="structOutputAPI.html#a8e02b92f6fe02e8571f83d5524fb9ae6">set_replaygain_info</a>) (<span class="keyword">const</span> <a class="code" href="structReplayGainInfo.html">ReplayGainInfo</a> * info);</div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> </div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  <span class="comment">/* Passes audio data to the output system for playback. The data must be in</span></div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> * the format passed to open_audio, and the length (in bytes) must be an</span></div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> * integral number of frames. This function blocks until all the data has</span></div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> * been written (though it may not yet be heard by the user). */</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"><a class="code" href="structOutputAPI.html#a297d930bf884dacdc8613286cd295d80"> 273</a></span>  void (* <a class="code" href="structOutputAPI.html#a297d930bf884dacdc8613286cd295d80">write_audio</a>) (<span class="keywordtype">void</span> * data, <span class="keywordtype">int</span> length);</div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> </div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  <span class="comment">/* Interrupts a call to write_audio() so that it returns immediately.</span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> * Buffered audio data is discarded. Until set_written_time() or</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> * open_audio() is called, further calls to write_audio() will have no</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * effect and will return immediately. */</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"><a class="code" href="structOutputAPI.html#a3b4abadb0b21cc10e02e01cad1b47e1a"> 279</a></span>  void (* <a class="code" href="structOutputAPI.html#a3b4abadb0b21cc10e02e01cad1b47e1a">abort_write</a>) (void);</div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> </div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  <span class="comment">/* Pauses or unpauses playback. If playback is paused during a call to</span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> * write_audio(), the call will block until playback is unpaused again or</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> * abort_write() is called. */</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"><a class="code" href="structOutputAPI.html#ae84c60236e59bbdc94d68ed3ac426123"> 284</a></span>  void (* <a class="code" href="structOutputAPI.html#ae84c60236e59bbdc94d68ed3ac426123">pause</a>) (<a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> <a class="code" href="structOutputAPI.html#ae84c60236e59bbdc94d68ed3ac426123">pause</a>);</div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> </div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  <span class="comment">/* Returns the time counter. Note that this represents the amount of audio</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> * data passed to the output system, not the amount actually heard by the</span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> * user. */</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"><a class="code" href="structOutputAPI.html#a32a1f176a9cf29c2f783385c7410e9dc"> 289</a></span>  <a class="code" href="misc-api_8h.html#aca5b4addd5e6ab053131aaf079201165">int</a> (* <a class="code" href="structOutputAPI.html#a32a1f176a9cf29c2f783385c7410e9dc">written_time</a>) (void);</div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> </div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  <span class="comment">/* Sets the time counter to a new value. Does not perform a flush; the name</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> * is kept only for compatibility. */</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"><a class="code" href="structOutputAPI.html#a71424dc2f9c39fffa008ef4bb3d5c41e"> 293</a></span>  void (* <a class="code" href="structOutputAPI.html#a71424dc2f9c39fffa008ef4bb3d5c41e">flush</a>) (<span class="keywordtype">int</span> time);</div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> };</div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> </div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="struct__InputPlayback.html">_InputPlayback</a> InputPlayback;</div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> </div>
<div class="line"><a name="l00298"></a><span class="lineno"><a class="code" href="struct__InputPlayback.html"> 298</a></span> <span class="keyword">struct </span><a class="code" href="struct__InputPlayback.html">_InputPlayback</a></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> {</div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  <span class="comment">/* Pointer to the output API functions. */</span></div>
<div class="line"><a name="l00301"></a><span class="lineno"><a class="code" href="struct__InputPlayback.html#af3ac587480d31b1642b3411b2a06d77e"> 301</a></span>  <span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="structOutputAPI.html">OutputAPI</a> * <a class="code" href="struct__InputPlayback.html#af3ac587480d31b1642b3411b2a06d77e">output</a>;</div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> </div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <span class="comment">/* Allows the plugin to associate data with a playback instance. */</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"><a class="code" href="struct__InputPlayback.html#a6b75ebc4d5b5b129bcd203c8b3ed0368"> 304</a></span>  void (* <a class="code" href="struct__InputPlayback.html#a6b75ebc4d5b5b129bcd203c8b3ed0368">set_data</a>) (InputPlayback * p, <span class="keywordtype">void</span> * data);</div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> </div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  <span class="comment">/* Returns the pointer passed to set_data. */</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"><a class="code" href="struct__InputPlayback.html#abde015ebf9807c8cda6ef56b129aefeb"> 307</a></span>  <span class="keywordtype">void</span> * (* get_data) (InputPlayback * p);</div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> </div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  <span class="comment">/* Signifies that the plugin has started playback is ready to accept mseek,</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> * pause, and stop calls. */</span></div>
<div class="line"><a name="l00311"></a><span class="lineno"><a class="code" href="struct__InputPlayback.html#a42c2b262344798160f4412119a000dc1"> 311</a></span>  void (* <a class="code" href="struct__InputPlayback.html#a42c2b262344798160f4412119a000dc1">set_pb_ready</a>) (InputPlayback * p);</div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> </div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  <span class="comment">/* Updates attributes of the stream. "bitrate" is in bits per second.</span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> * "samplerate" is in hertz. */</span></div>
<div class="line"><a name="l00315"></a><span class="lineno"><a class="code" href="struct__InputPlayback.html#aa4d017b892993c5620b520185964ef35"> 315</a></span>  void (* <a class="code" href="struct__InputPlayback.html#aa4d017b892993c5620b520185964ef35">set_params</a>) (InputPlayback * p, <span class="keywordtype">int</span> bitrate, <span class="keywordtype">int</span> samplerate,</div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  <span class="keywordtype">int</span> <a class="code" href="equalizer_8c.html#a178795099d0608972755dfef8d8367e3">channels</a>);</div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> </div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  <span class="comment">/* Updates metadata for the stream. Caller gives up ownership of one</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * reference to the tuple. */</span></div>
<div class="line"><a name="l00320"></a><span class="lineno"><a class="code" href="struct__InputPlayback.html#a408bd2032437149cb0346976d9af6bf6"> 320</a></span>  void (* <a class="code" href="struct__InputPlayback.html#a408bd2032437149cb0346976d9af6bf6">set_tuple</a>) (InputPlayback * playback, Tuple * tuple);</div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> </div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  <span class="comment">/* If replay gain settings are stored in the tuple associated with the</span></div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> * current song, this function can be called (after opening audio) to apply</span></div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> * those settings. If the settings are changed in a call to set_tuple, this</span></div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"> * function must be called again to apply the updated settings. */</span></div>
<div class="line"><a name="l00326"></a><span class="lineno"><a class="code" href="struct__InputPlayback.html#aab9ccd4d385faf56783ab32114e79ddb"> 326</a></span>  void (* <a class="code" href="struct__InputPlayback.html#aab9ccd4d385faf56783ab32114e79ddb">set_gain_from_playlist</a>) (InputPlayback * playback);</div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> };</div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> </div>
<div class="line"><a name="l00329"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html"> 329</a></span> <span class="keyword">struct </span><a class="code" href="struct__InputPlugin.html">_InputPlugin</a></div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> {</div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span>  <a class="code" href="plugin_8h.html#a9cc7fd10deaf768870101afdffa05dec">PLUGIN_COMMON_FIELDS</a></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> </div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  <span class="comment">/* Nonzero if the files handled by the plugin may contain more than one</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> * song. When reading the tuple for such a file, the plugin should set the</span></div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> * FIELD_SUBSONG_NUM field to the number of songs in the file. For all</span></div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"> * other files, the field should be left unset.</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> * Example:</span></div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> * 1. User adds a file named "somefile.xxx" to the playlist. Having</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> * determined that this plugin can handle the file, Audacious opens the file</span></div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> * and calls probe_for_tuple(). probe_for_tuple() sees that there are 3</span></div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> * songs in the file and sets FIELD_SUBSONG_NUM to 3.</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * 2. For each song in the file, Audacious opens the file and calls</span></div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * probe_for_tuple() -- this time, however, a question mark and song number</span></div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> * are appended to the file name passed: "somefile.sid?2" refers to the</span></div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> * second song in the file "somefile.sid".</span></div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> * 3. When one of the songs is played, Audacious opens the file and calls</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> * play() with a file name modified in this way.</span></div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00350"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#a576f24d28f41c5c15ca2b05375a409ef"> 350</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> <a class="code" href="struct__InputPlugin.html#a576f24d28f41c5c15ca2b05375a409ef">have_subtune</a>;</div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span> </div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span>  <span class="comment">/* Pointer to an array (terminated with NULL) of file extensions associated</span></div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> * with file types the plugin can handle. */</span></div>
<div class="line"><a name="l00354"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#a3fec4bcf075c75349567ad144511b25c"> 354</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * <span class="keyword">const</span> * <a class="code" href="struct__InputPlugin.html#a3fec4bcf075c75349567ad144511b25c">extensions</a>;</div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  <span class="comment">/* Pointer to an array (terminated with NULL) of MIME types the plugin can</span></div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> * handle. */</span></div>
<div class="line"><a name="l00357"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#a80c4d4c14d4640a81af79866cc817767"> 357</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * <span class="keyword">const</span> * <a class="code" href="struct__InputPlugin.html#a80c4d4c14d4640a81af79866cc817767">mimes</a>;</div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  <span class="comment">/* Pointer to an array (terminated with NULL) of custom URI schemes the</span></div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> * plugin can handle. */</span></div>
<div class="line"><a name="l00360"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#a4bb15b28c8a625c92fdfeb42e430c30a"> 360</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * <span class="keyword">const</span> * <a class="code" href="struct__InputPlugin.html#a4bb15b28c8a625c92fdfeb42e430c30a">schemes</a>;</div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span> </div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  <span class="comment">/* How quickly the plugin should be tried in searching for a plugin to</span></div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> * handle a file which could not be identified from its extension. Plugins</span></div>
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> * with priority 0 are tried first, 10 last. */</span></div>
<div class="line"><a name="l00365"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#acaa3b5f600c851a240bc2effc7d5a75b"> 365</a></span>  <span class="keywordtype">int</span> <a class="code" href="struct__InputPlugin.html#acaa3b5f600c851a240bc2effc7d5a75b">priority</a>;</div>
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span> </div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  <span class="comment">/* Must return nonzero if the plugin can handle this file. If the file</span></div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> * could not be opened, "file" will be NULL. (This is normal in the case of</span></div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment"> * special URI schemes like cdda:// that do not represent actual files.) */</span></div>
<div class="line"><a name="l00370"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#a8f5c00e2e8d5c85030ecacd98d847215"> 370</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> (* <a class="code" href="struct__InputPlugin.html#a8f5c00e2e8d5c85030ecacd98d847215">is_our_file_from_vfs</a>) (<span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="misc-api_8h.html#a8e824805f6e62c9bd91eec8b26f73e3f">filename</a>, <a class="code" href="structVFSFile.html">VFSFile</a> * file);</div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span> </div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  <span class="comment">/* Must return a tuple containing metadata for this file, or NULL if no</span></div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"> * metadata could be read. If the file could not be opened, "file" will be</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> * NULL. Audacious takes over one reference to the tuple returned. */</span></div>
<div class="line"><a name="l00375"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#a79d3b753cebb178c1936c0078a102d7a"> 375</a></span>  Tuple * (* probe_for_tuple) (<span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="misc-api_8h.html#a8e824805f6e62c9bd91eec8b26f73e3f">filename</a>, <a class="code" href="structVFSFile.html">VFSFile</a> * file);</div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span> </div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span>  <span class="comment">/* Optional. Must write metadata from a tuple to this file. Must return</span></div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> * nonzero on success or zero on failure. "file" will never be NULL. */</span></div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span>  <span class="comment">/* Bug: This function does not support special URI schemes like cdda://,</span></div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> * since no file name is passed. */</span></div>
<div class="line"><a name="l00381"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#a02a646a85625306e3609b233c5930dac"> 381</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> (* <a class="code" href="struct__InputPlugin.html#a02a646a85625306e3609b233c5930dac">update_song_tuple</a>) (<span class="keyword">const</span> Tuple * tuple, <a class="code" href="structVFSFile.html">VFSFile</a> * file);</div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span> </div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>  <span class="comment">/* Optional, and not recommended. Must show a window with information about</span></div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"> * this file. If this function is provided, update_song_tuple should not be. */</span></div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  <span class="comment">/* Bug: Implementing this function duplicates user interface code and code</span></div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment"> * to open the file in each and every plugin. */</span></div>
<div class="line"><a name="l00387"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#aa5ba6d154f0a7c5fe81f9a96748a5aa8"> 387</a></span>  void (* <a class="code" href="struct__InputPlugin.html#aa5ba6d154f0a7c5fe81f9a96748a5aa8">file_info_box</a>) (<span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="misc-api_8h.html#a8e824805f6e62c9bd91eec8b26f73e3f">filename</a>);</div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> </div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  <span class="comment">/* Optional. Must try to read an "album art" image embedded in this file.</span></div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"> * Must return nonzero on success or zero on failure. If the file could not</span></div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment"> * be opened, "file" will be NULL. On success, must fill "data" with a</span></div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment"> * pointer to a block of data allocated with g_malloc and "size" with the</span></div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment"> * size in bytes of that block. The data may be in any format supported by</span></div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment"> * GTK. Audacious will free the data when it is no longer needed. */</span></div>
<div class="line"><a name="l00395"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#abb661d0073bc05cb3f3cffbad51ffe0f"> 395</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> (* <a class="code" href="struct__InputPlugin.html#abb661d0073bc05cb3f3cffbad51ffe0f">get_song_image</a>) (<span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="misc-api_8h.html#a8e824805f6e62c9bd91eec8b26f73e3f">filename</a>, <a class="code" href="structVFSFile.html">VFSFile</a> * file,</div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>  <span class="keywordtype">void</span> * * data, int64_t * size);</div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span> </div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>  <span class="comment">/* Must try to play this file. "playback" is a structure containing output-</span></div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"> * related functions which the plugin may make use of. It also contains a</span></div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment"> * "data" pointer which the plugin may use to refer private data associated</span></div>
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment"> * with the playback state. This pointer can then be used from pause,</span></div>
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment"> * mseek, and stop. If the file could not be opened, "file" will be NULL.</span></div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment"> * "start_time" is the position in milliseconds at which to start from, or</span></div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment"> * -1 to start from the beginning of the file. "stop_time" is the position</span></div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment"> * in milliseconds at which to end playback, or -1 to play to the end of the</span></div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment"> * file. "paused" specifies whether playback should immediately be paused.</span></div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment"> * Must return nonzero if some of the file was successfully played or zero</span></div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="comment"> * on failure. */</span></div>
<div class="line"><a name="l00409"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#a5d7e9ff7038e6c55fc794efd2bc2ce71"> 409</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> (* <a class="code" href="struct__InputPlugin.html#a5d7e9ff7038e6c55fc794efd2bc2ce71">play</a>) (InputPlayback * playback, <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="misc-api_8h.html#a8e824805f6e62c9bd91eec8b26f73e3f">filename</a>,</div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>  <a class="code" href="structVFSFile.html">VFSFile</a> * file, <span class="keywordtype">int</span> start_time, <span class="keywordtype">int</span> stop_time, <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> <a class="code" href="struct__InputPlugin.html#a1acae269931552d71476dd1a553a8f51">pause</a>);</div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span> </div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>  <span class="comment">/* Must pause or unpause a file currently being played. This function will</span></div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment"> * be called from a different thread than play, but it will not be called</span></div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"> * before the plugin calls set_pb_ready or after stop is called. */</span></div>
<div class="line"><a name="l00415"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#a1acae269931552d71476dd1a553a8f51"> 415</a></span>  void (* <a class="code" href="struct__InputPlugin.html#a1acae269931552d71476dd1a553a8f51">pause</a>) (InputPlayback * playback, <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> <a class="code" href="playback_8c.html#a8ec97d56c71206bf46498285421b7b25">paused</a>);</div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> </div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span>  <span class="comment">/* Optional. Must seek to the given position in milliseconds within a file</span></div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment"> * currently being played. This function will be called from a different</span></div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment"> * thread than play, but it will not be called before the plugin calls</span></div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment"> * set_pb_ready or after stop is called. */</span></div>
<div class="line"><a name="l00421"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#a9b6d9b311b8556b82d8221b75b95ec91"> 421</a></span>  void (* <a class="code" href="struct__InputPlugin.html#a9b6d9b311b8556b82d8221b75b95ec91">mseek</a>) (InputPlayback * playback, <span class="keywordtype">int</span> time);</div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span> </div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>  <span class="comment">/* Must signal a currently playing song to stop and cause play to return.</span></div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment"> * This function will be called from a different thread than play. It will</span></div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment"> * only be called once. It should not join the thread from which play is</span></div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="comment"> * called. */</span></div>
<div class="line"><a name="l00427"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#aaef3747d7c89ab7b8058da34d98629e3"> 427</a></span>  void (* <a class="code" href="struct__InputPlugin.html#aaef3747d7c89ab7b8058da34d98629e3">stop</a>) (InputPlayback * playback);</div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span> </div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span>  <span class="comment">/* Advanced, for plugins that do not use Audacious's output system. Use at</span></div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment"> * your own risk. */</span></div>
<div class="line"><a name="l00431"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#aad559b3abdc48ce97143dad5a7df314b"> 431</a></span>  <a class="code" href="misc-api_8h.html#aca5b4addd5e6ab053131aaf079201165">int</a> (* <a class="code" href="struct__InputPlugin.html#aad559b3abdc48ce97143dad5a7df314b">get_time</a>) (InputPlayback * playback);</div>
<div class="line"><a name="l00432"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#a1ec55a142c74e1b2a493da519ec27329"> 432</a></span>  <a class="code" href="misc-api_8h.html#aca5b4addd5e6ab053131aaf079201165">int</a> (* <a class="code" href="struct__InputPlugin.html#a1ec55a142c74e1b2a493da519ec27329">get_volume</a>) (<span class="keywordtype">int</span> * l, <span class="keywordtype">int</span> * r);</div>
<div class="line"><a name="l00433"></a><span class="lineno"><a class="code" href="struct__InputPlugin.html#a86fa512fa364e0dc50e8381d99f8ad53"> 433</a></span>  <a class="code" href="misc-api_8h.html#aca5b4addd5e6ab053131aaf079201165">int</a> (* <a class="code" href="struct__InputPlugin.html#a86fa512fa364e0dc50e8381d99f8ad53">set_volume</a>) (<span class="keywordtype">int</span> l, <span class="keywordtype">int</span> r);</div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> };</div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span> </div>
<div class="line"><a name="l00436"></a><span class="lineno"><a class="code" href="struct__GeneralPlugin.html"> 436</a></span> <span class="keyword">struct </span><a class="code" href="struct__GeneralPlugin.html">_GeneralPlugin</a></div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span> {</div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span>  <a class="code" href="plugin_8h.html#a9cc7fd10deaf768870101afdffa05dec">PLUGIN_COMMON_FIELDS</a></div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> </div>
<div class="line"><a name="l00440"></a><span class="lineno"><a class="code" href="struct__GeneralPlugin.html#acb4e297f7a0f9886cab779853d45eeaa"> 440</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> <a class="code" href="struct__GeneralPlugin.html#acb4e297f7a0f9886cab779853d45eeaa">enabled_by_default</a>;</div>
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> </div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  <span class="comment">/* GtkWidget * (* get_widget) (void); */</span></div>
<div class="line"><a name="l00443"></a><span class="lineno"><a class="code" href="struct__GeneralPlugin.html#a5eaa8db5aa4b09260b25ff9558c06a61"> 443</a></span>  <span class="keywordtype">void</span> * (* get_widget) (void);</div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span> };</div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span> </div>
<div class="line"><a name="l00446"></a><span class="lineno"><a class="code" href="struct__VisPlugin.html"> 446</a></span> <span class="keyword">struct </span><a class="code" href="struct__VisPlugin.html">_VisPlugin</a></div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span> {</div>
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  <a class="code" href="plugin_8h.html#a9cc7fd10deaf768870101afdffa05dec">PLUGIN_COMMON_FIELDS</a></div>
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span> </div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <span class="comment">/* reset internal state and clear display */</span></div>
<div class="line"><a name="l00451"></a><span class="lineno"><a class="code" href="struct__VisPlugin.html#a13569fcc16454d0631d19b36a0772506"> 451</a></span>  void (* <a class="code" href="struct__VisPlugin.html#a13569fcc16454d0631d19b36a0772506">clear</a>) (void);</div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span> </div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span>  <span class="comment">/* 512 frames of a single-channel PCM signal */</span></div>
<div class="line"><a name="l00454"></a><span class="lineno"><a class="code" href="struct__VisPlugin.html#a988fc17f133d1abdf2a7427864a561bb"> 454</a></span>  void (* <a class="code" href="struct__VisPlugin.html#a988fc17f133d1abdf2a7427864a561bb">render_mono_pcm</a>) (<span class="keyword">const</span> <span class="keywordtype">float</span> * pcm);</div>
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span> </div>
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  <span class="comment">/* 512 frames of an interleaved multi-channel PCM signal */</span></div>
<div class="line"><a name="l00457"></a><span class="lineno"><a class="code" href="struct__VisPlugin.html#ac1b23926a402e79de22b9bd851e2fc3d"> 457</a></span>  void (* <a class="code" href="struct__VisPlugin.html#ac1b23926a402e79de22b9bd851e2fc3d">render_multi_pcm</a>) (<span class="keyword">const</span> <span class="keywordtype">float</span> * pcm, <span class="keywordtype">int</span> <a class="code" href="equalizer_8c.html#a178795099d0608972755dfef8d8367e3">channels</a>);</div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> </div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  <span class="comment">/* intensity of frequencies 1/512, 2/512, ..., 256/512 of sample rate */</span></div>
<div class="line"><a name="l00460"></a><span class="lineno"><a class="code" href="struct__VisPlugin.html#a126bcddd8bc097f449d88e90ac56752a"> 460</a></span>  void (* <a class="code" href="struct__VisPlugin.html#a126bcddd8bc097f449d88e90ac56752a">render_freq</a>) (<span class="keyword">const</span> <span class="keywordtype">float</span> * freq);</div>
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span> </div>
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span>  <span class="comment">/* GtkWidget * (* get_widget) (void); */</span></div>
<div class="line"><a name="l00463"></a><span class="lineno"><a class="code" href="struct__VisPlugin.html#aba33da42317efa1568d63b6ac2f9e792"> 463</a></span>  <span class="keywordtype">void</span> * (* get_widget) (void);</div>
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span> };</div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span> </div>
<div class="line"><a name="l00466"></a><span class="lineno"><a class="code" href="struct__IfacePlugin.html"> 466</a></span> <span class="keyword">struct </span><a class="code" href="struct__IfacePlugin.html">_IfacePlugin</a></div>
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span> {</div>
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>  <a class="code" href="plugin_8h.html#a9cc7fd10deaf768870101afdffa05dec">PLUGIN_COMMON_FIELDS</a></div>
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span> </div>
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span>  <span class="comment">/* is_shown() may return nonzero even if the interface is not actually</span></div>
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="comment"> * visible; for example, if it is obscured by other windows or minimized.</span></div>
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment"> * is_focused() only returns nonzero if the interface is actually visible;</span></div>
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="comment"> * in X11, this should be determined by whether the interface has the</span></div>
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment"> * toplevel focus. show() should show and raise the interface, so that both</span></div>
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="comment"> * is_shown() and is_focused() will return nonzero. */</span></div>
<div class="line"><a name="l00476"></a><span class="lineno"><a class="code" href="struct__IfacePlugin.html#afb9501f349493477d1067558099d6d22"> 476</a></span>  void (* <a class="code" href="struct__IfacePlugin.html#afb9501f349493477d1067558099d6d22">show</a>) (<a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> <a class="code" href="struct__IfacePlugin.html#afb9501f349493477d1067558099d6d22">show</a>);</div>
<div class="line"><a name="l00477"></a><span class="lineno"><a class="code" href="struct__IfacePlugin.html#a68ec36058864726c9ade1d4ff8c11cef"> 477</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> (* <a class="code" href="struct__IfacePlugin.html#a68ec36058864726c9ade1d4ff8c11cef">is_shown</a>) (void);</div>
<div class="line"><a name="l00478"></a><span class="lineno"><a class="code" href="struct__IfacePlugin.html#a3e4f00a8226fbbe45cc807f457c7c1ab"> 478</a></span>  <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> (* <a class="code" href="struct__IfacePlugin.html#a3e4f00a8226fbbe45cc807f457c7c1ab">is_focused</a>) (void);</div>
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span> </div>
<div class="line"><a name="l00480"></a><span class="lineno"><a class="code" href="struct__IfacePlugin.html#ac14fd192766d112b9fba83114cc7f26a"> 480</a></span>  void (* <a class="code" href="struct__IfacePlugin.html#ac14fd192766d112b9fba83114cc7f26a">show_error</a>) (<span class="keyword">const</span> <span class="keywordtype">char</span> * markup);</div>
<div class="line"><a name="l00481"></a><span class="lineno"><a class="code" href="struct__IfacePlugin.html#a49000cd8c811c1da46b8ace8c13b522b"> 481</a></span>  void (* <a class="code" href="struct__IfacePlugin.html#a49000cd8c811c1da46b8ace8c13b522b">show_filebrowser</a>) (<a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a> play_button);</div>
<div class="line"><a name="l00482"></a><span class="lineno"><a class="code" href="struct__IfacePlugin.html#a10c4349f6bc4f9e412723480d3a82098"> 482</a></span>  void (* <a class="code" href="struct__IfacePlugin.html#a10c4349f6bc4f9e412723480d3a82098">show_jump_to_track</a>) (void);</div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span> </div>
<div class="line"><a name="l00484"></a><span class="lineno"><a class="code" href="struct__IfacePlugin.html#a77cee005155b3c90d6e64d85d2c8d66b"> 484</a></span>  void (* <a class="code" href="struct__IfacePlugin.html#a77cee005155b3c90d6e64d85d2c8d66b">run_gtk_plugin</a>) (<span class="keywordtype">void</span> <span class="comment">/* GtkWidget */</span> * widget, <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="plugin-init_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>);</div>
<div class="line"><a name="l00485"></a><span class="lineno"><a class="code" href="struct__IfacePlugin.html#ad3b267a16794318d66093ff449e93068"> 485</a></span>  void (* <a class="code" href="struct__IfacePlugin.html#ad3b267a16794318d66093ff449e93068">stop_gtk_plugin</a>) (<span class="keywordtype">void</span> <span class="comment">/* GtkWidget */</span> * widget);</div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span> </div>
<div class="line"><a name="l00487"></a><span class="lineno"><a class="code" href="struct__IfacePlugin.html#a3ee199c7b83ad8e28525d28886d7098a"> 487</a></span>  void (* <a class="code" href="struct__IfacePlugin.html#a3ee199c7b83ad8e28525d28886d7098a">install_toolbar</a>) (<span class="keywordtype">void</span> <span class="comment">/* GtkWidget */</span> * button);</div>
<div class="line"><a name="l00488"></a><span class="lineno"><a class="code" href="struct__IfacePlugin.html#a717af073e81512aec8cff4e1d90137c1"> 488</a></span>  void (* <a class="code" href="struct__IfacePlugin.html#a717af073e81512aec8cff4e1d90137c1">uninstall_toolbar</a>) (<span class="keywordtype">void</span> <span class="comment">/* GtkWidget */</span> * button);</div>
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span> };</div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span> </div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="preprocessor">#undef PLUGIN_COMMON_FIELDS</span></div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00493"></a><span class="lineno"><a class="code" href="plugin_8h.html#ac17efebe0455b2f5ddfc06b3eba946b2"> 493</a></span> <span class="preprocessor">#define AUD_PLUGIN(stype, itype, ...) \</span></div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="preprocessor">AudAPITable * _aud_api_table = NULL; \</span></div>
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="preprocessor">stype _aud_plugin_self = { \</span></div>
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="preprocessor"> .magic = _AUD_PLUGIN_MAGIC, \</span></div>
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="preprocessor"> .version = _AUD_PLUGIN_VERSION, \</span></div>
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="preprocessor"> .type = itype, \</span></div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="preprocessor"> .size = sizeof (stype), \</span></div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="preprocessor"> __VA_ARGS__}; \</span></div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="preprocessor">stype * get_plugin_info (AudAPITable * table) { \</span></div>
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="preprocessor"> _aud_api_table = table; \</span></div>
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="preprocessor"> return & _aud_plugin_self; \</span></div>
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="preprocessor">}</span></div>
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00506"></a><span class="lineno"><a class="code" href="plugin_8h.html#aa8b1e9bfd73c663b992431810815bfad"> 506</a></span> <span class="preprocessor">#define AUD_TRANSPORT_PLUGIN(...) AUD_PLUGIN (TransportPlugin, PLUGIN_TYPE_TRANSPORT, __VA_ARGS__)</span></div>
<div class="line"><a name="l00507"></a><span class="lineno"><a class="code" href="plugin_8h.html#a04d098b345ac8d0265ccbdc474dfd4b7"> 507</a></span> <span class="preprocessor"></span><span class="preprocessor">#define AUD_PLAYLIST_PLUGIN(...) AUD_PLUGIN (PlaylistPlugin, PLUGIN_TYPE_PLAYLIST, __VA_ARGS__)</span></div>
<div class="line"><a name="l00508"></a><span class="lineno"><a class="code" href="plugin_8h.html#a4043f151ac6c339e90b5cd1a4f5680cc"> 508</a></span> <span class="preprocessor"></span><span class="preprocessor">#define AUD_INPUT_PLUGIN(...) AUD_PLUGIN (InputPlugin, PLUGIN_TYPE_INPUT, __VA_ARGS__)</span></div>
<div class="line"><a name="l00509"></a><span class="lineno"><a class="code" href="plugin_8h.html#a748b29f79fb04f1973b75054a44d2ea2"> 509</a></span> <span class="preprocessor"></span><span class="preprocessor">#define AUD_EFFECT_PLUGIN(...) AUD_PLUGIN (EffectPlugin, PLUGIN_TYPE_EFFECT, __VA_ARGS__)</span></div>
<div class="line"><a name="l00510"></a><span class="lineno"><a class="code" href="plugin_8h.html#a7173aa8bbe74aa7d8a6fbf0e5b4e8467"> 510</a></span> <span class="preprocessor"></span><span class="preprocessor">#define AUD_OUTPUT_PLUGIN(...) AUD_PLUGIN (OutputPlugin, PLUGIN_TYPE_OUTPUT, __VA_ARGS__)</span></div>
<div class="line"><a name="l00511"></a><span class="lineno"><a class="code" href="plugin_8h.html#a401a56f16b1ff1e90ebabc1ccda825f3"> 511</a></span> <span class="preprocessor"></span><span class="preprocessor">#define AUD_VIS_PLUGIN(...) AUD_PLUGIN (VisPlugin, PLUGIN_TYPE_VIS, __VA_ARGS__)</span></div>
<div class="line"><a name="l00512"></a><span class="lineno"><a class="code" href="plugin_8h.html#acabae3701b1ca5411310098f7a1f4cb7"> 512</a></span> <span class="preprocessor"></span><span class="preprocessor">#define AUD_GENERAL_PLUGIN(...) AUD_PLUGIN (GeneralPlugin, PLUGIN_TYPE_GENERAL, __VA_ARGS__)</span></div>
<div class="line"><a name="l00513"></a><span class="lineno"><a class="code" href="plugin_8h.html#aa3bfe8e6f12049d25afc98e8fe9e3a6a"> 513</a></span> <span class="preprocessor"></span><span class="preprocessor">#define AUD_IFACE_PLUGIN(...) AUD_PLUGIN (IfacePlugin, PLUGIN_TYPE_IFACE, __VA_ARGS__)</span></div>
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00515"></a><span class="lineno"><a class="code" href="plugin_8h.html#acc1d6793b4343c98de4938b4e7d46deb"> 515</a></span> <span class="preprocessor">#define PLUGIN_HAS_FUNC(p, func) \</span></div>
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="preprocessor"> ((p)->size > (char *) & (p)->func - (char *) (p) && (p)->func)</span></div>
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="preprocessor">#endif </span><span class="comment">/* AUDACIOUS_PLUGIN_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>
