1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>modplug: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements"> 9<link rel="prev" href="gst-plugins-bad-plugins-mmssrc.html" title="mmssrc"> 10<link rel="next" href="gst-plugins-bad-plugins-motioncells.html" title="motioncells"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-bad-plugins-modplug.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-modplug.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-modplug.properties" class="shortcut">Properties</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-bad-plugins-mmssrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-bad-plugins-motioncells.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="gst-plugins-bad-plugins-modplug"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-modplug.top_of_page"></a>modplug</span></h2> 32<p>modplug</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="gst-plugins-bad-plugins-modplug.properties"></a><h2>Properties</h2> 38<div class="informaltable"><table class="informaltable" border="0"> 39<colgroup> 40<col width="150px" class="properties_type"> 41<col width="300px" class="properties_name"> 42<col width="200px" class="properties_flags"> 43</colgroup> 44<tbody> 45<tr> 46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug--megabass" title="The “megabass” property">megabass</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug--megabass-amount" title="The “megabass-amount” property">megabass-amount</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55<tr> 56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug--megabass-range" title="The “megabass-range” property">megabass-range</a></td> 58<td class="property_flags">Read / Write</td> 59</tr> 60<tr> 61<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 62<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug--noise-reduction" title="The “noise-reduction” property">noise-reduction</a></td> 63<td class="property_flags">Read / Write</td> 64</tr> 65<tr> 66<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 67<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug--oversamp" title="The “oversamp” property">oversamp</a></td> 68<td class="property_flags">Read / Write</td> 69</tr> 70<tr> 71<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 72<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug--reverb" title="The “reverb” property">reverb</a></td> 73<td class="property_flags">Read / Write</td> 74</tr> 75<tr> 76<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 77<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug--reverb-delay" title="The “reverb-delay” property">reverb-delay</a></td> 78<td class="property_flags">Read / Write</td> 79</tr> 80<tr> 81<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 82<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug--reverb-depth" title="The “reverb-depth” property">reverb-depth</a></td> 83<td class="property_flags">Read / Write</td> 84</tr> 85<tr> 86<td class="property_type"> 87<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 88<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug--songname" title="The “songname” property">songname</a></td> 89<td class="property_flags">Read</td> 90</tr> 91<tr> 92<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 93<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug--surround" title="The “surround” property">surround</a></td> 94<td class="property_flags">Read / Write</td> 95</tr> 96<tr> 97<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 98<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug--surround-delay" title="The “surround-delay” property">surround-delay</a></td> 99<td class="property_flags">Read / Write</td> 100</tr> 101<tr> 102<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 103<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug--surround-depth" title="The “surround-depth” property">surround-depth</a></td> 104<td class="property_flags">Read / Write</td> 105</tr> 106</tbody> 107</table></div> 108</div> 109<a name="GstModPlug"></a><div class="refsect1"> 110<a name="gst-plugins-bad-plugins-modplug.other"></a><h2>Types and Values</h2> 111<div class="informaltable"><table class="informaltable" width="100%" border="0"> 112<colgroup> 113<col width="150px" class="name"> 114<col class="description"> 115</colgroup> 116<tbody><tr> 117<td class="datatype_keyword"> </td> 118<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-modplug.html#GstModPlug-struct" title="GstModPlug">GstModPlug</a></td> 119</tr></tbody> 120</table></div> 121</div> 122<div class="refsect1"> 123<a name="gst-plugins-bad-plugins-modplug.object-hierarchy"></a><h2>Object Hierarchy</h2> 124<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 125 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 126 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 127 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 128 <span class="lineart">╰──</span> GstModPlug 129</pre> 130</div> 131<div class="refsect1"> 132<a name="gst-plugins-bad-plugins-modplug.description"></a><h2>Description</h2> 133<p>Modplug uses the <a class="ulink" href="http://modplug-xmms.sourceforge.net/" target="_top">modplug</a> 134library to decode tracked music in the MOD/S3M/XM/IT and related formats.</p> 135<div class="refsect2"> 136<a name="id-1.2.140.7.3"></a><h3>Example pipeline</h3> 137<div class="informalexample"> 138 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 139 <tbody> 140 <tr> 141 <td class="listing_lines" align="right"><pre>1</pre></td> 142 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> <span class="gtkdoc opt">-</span>v filesrc location<span class="gtkdoc opt">=</span><span class="number">1990</span>s<span class="gtkdoc opt">-</span>nostalgia<span class="gtkdoc opt">.</span>xm <span class="gtkdoc opt">!</span> modplug <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink</pre></td> 143 </tr> 144 </tbody> 145 </table> 146</div> 147 Play a FastTracker xm file. 148</div> 149<div class="refsynopsisdiv"> 150<h2>Synopsis</h2> 151<div class="refsect2"> 152<a name="id-1.2.140.7.4.1"></a><h3>Element Information</h3> 153<div class="variablelist"><table border="0" class="variablelist"> 154<colgroup> 155<col align="left" valign="top"> 156<col> 157</colgroup> 158<tbody> 159<tr> 160<td><p><span class="term">plugin</span></p></td> 161<td> 162 <a class="link" href="gst-plugins-bad-plugins-plugin-modplug.html#plugin-modplug">modplug</a> 163 </td> 164</tr> 165<tr> 166<td><p><span class="term">author</span></p></td> 167<td>Jeremy SIMON <jsimon13@yahoo.fr></td> 168</tr> 169<tr> 170<td><p><span class="term">class</span></p></td> 171<td>Codec/Decoder/Audio</td> 172</tr> 173</tbody> 174</table></div> 175</div> 176<hr> 177<div class="refsect2"> 178<a name="id-1.2.140.7.4.2"></a><h3>Element Pads</h3> 179<div class="variablelist"><table border="0" class="variablelist"> 180<colgroup> 181<col align="left" valign="top"> 182<col> 183</colgroup> 184<tbody> 185<tr> 186<td><p><span class="term">name</span></p></td> 187<td>sink</td> 188</tr> 189<tr> 190<td><p><span class="term">direction</span></p></td> 191<td>sink</td> 192</tr> 193<tr> 194<td><p><span class="term">presence</span></p></td> 195<td>always</td> 196</tr> 197<tr> 198<td><p><span class="term">details</span></p></td> 199<td>audio/x-mod</td> 200</tr> 201<tr> 202<td><p><span class="term"></span></p></td> 203<td> audio/x-xm</td> 204</tr> 205<tr> 206<td><p><span class="term"></span></p></td> 207<td> audio/x-it</td> 208</tr> 209<tr> 210<td><p><span class="term"></span></p></td> 211<td> audio/x-s3m</td> 212</tr> 213<tr> 214<td><p><span class="term"></span></p></td> 215<td> audio/x-stm</td> 216</tr> 217</tbody> 218</table></div> 219<div class="variablelist"><table border="0" class="variablelist"> 220<colgroup> 221<col align="left" valign="top"> 222<col> 223</colgroup> 224<tbody> 225<tr> 226<td><p><span class="term">name</span></p></td> 227<td>src</td> 228</tr> 229<tr> 230<td><p><span class="term">direction</span></p></td> 231<td>source</td> 232</tr> 233<tr> 234<td><p><span class="term">presence</span></p></td> 235<td>always</td> 236</tr> 237<tr> 238<td><p><span class="term">details</span></p></td> 239<td>audio/x-raw, format=(string){ S32LE, S16LE, U8 }, layout=(string)interleaved, rate=(int){ 8000, 11025, 22050, 44100 }, channels=(int)[ 1, 2 ]</td> 240</tr> 241</tbody> 242</table></div> 243</div> 244</div> 245</div> 246<div class="refsect1"> 247<a name="gst-plugins-bad-plugins-modplug.functions_details"></a><h2>Functions</h2> 248<p></p> 249</div> 250<div class="refsect1"> 251<a name="gst-plugins-bad-plugins-modplug.other_details"></a><h2>Types and Values</h2> 252<div class="refsect2"> 253<a name="GstModPlug-struct"></a><h3>GstModPlug</h3> 254<pre class="programlisting">typedef struct _GstModPlug GstModPlug;</pre> 255</div> 256</div> 257<div class="refsect1"> 258<a name="gst-plugins-bad-plugins-modplug.property-details"></a><h2>Property Details</h2> 259<div class="refsect2"> 260<a name="GstModPlug--megabass"></a><h3>The <code class="literal">“megabass”</code> property</h3> 261<pre class="programlisting"> “megabass” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 262<p>Megabass.</p> 263<p>Flags: Read / Write</p> 264<p>Default value: FALSE</p> 265</div> 266<hr> 267<div class="refsect2"> 268<a name="GstModPlug--megabass-amount"></a><h3>The <code class="literal">“megabass-amount”</code> property</h3> 269<pre class="programlisting"> “megabass-amount” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 270<p>Megabass amount.</p> 271<p>Flags: Read / Write</p> 272<p>Allowed values: [0,100]</p> 273<p>Default value: 40</p> 274</div> 275<hr> 276<div class="refsect2"> 277<a name="GstModPlug--megabass-range"></a><h3>The <code class="literal">“megabass-range”</code> property</h3> 278<pre class="programlisting"> “megabass-range” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 279<p>Megabass range.</p> 280<p>Flags: Read / Write</p> 281<p>Allowed values: [0,100]</p> 282<p>Default value: 30</p> 283</div> 284<hr> 285<div class="refsect2"> 286<a name="GstModPlug--noise-reduction"></a><h3>The <code class="literal">“noise-reduction”</code> property</h3> 287<pre class="programlisting"> “noise-reduction” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 288<p>noise reduction.</p> 289<p>Flags: Read / Write</p> 290<p>Default value: TRUE</p> 291</div> 292<hr> 293<div class="refsect2"> 294<a name="GstModPlug--oversamp"></a><h3>The <code class="literal">“oversamp”</code> property</h3> 295<pre class="programlisting"> “oversamp” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 296<p>oversamp.</p> 297<p>Flags: Read / Write</p> 298<p>Default value: TRUE</p> 299</div> 300<hr> 301<div class="refsect2"> 302<a name="GstModPlug--reverb"></a><h3>The <code class="literal">“reverb”</code> property</h3> 303<pre class="programlisting"> “reverb” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 304<p>Reverb.</p> 305<p>Flags: Read / Write</p> 306<p>Default value: FALSE</p> 307</div> 308<hr> 309<div class="refsect2"> 310<a name="GstModPlug--reverb-delay"></a><h3>The <code class="literal">“reverb-delay”</code> property</h3> 311<pre class="programlisting"> “reverb-delay” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 312<p>Reverb delay.</p> 313<p>Flags: Read / Write</p> 314<p>Allowed values: [0,200]</p> 315<p>Default value: 100</p> 316</div> 317<hr> 318<div class="refsect2"> 319<a name="GstModPlug--reverb-depth"></a><h3>The <code class="literal">“reverb-depth”</code> property</h3> 320<pre class="programlisting"> “reverb-depth” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 321<p>Reverb depth.</p> 322<p>Flags: Read / Write</p> 323<p>Allowed values: [0,100]</p> 324<p>Default value: 30</p> 325</div> 326<hr> 327<div class="refsect2"> 328<a name="GstModPlug--songname"></a><h3>The <code class="literal">“songname”</code> property</h3> 329<pre class="programlisting"> “songname” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 330<p>The song name.</p> 331<p>Flags: Read</p> 332<p>Default value: NULL</p> 333</div> 334<hr> 335<div class="refsect2"> 336<a name="GstModPlug--surround"></a><h3>The <code class="literal">“surround”</code> property</h3> 337<pre class="programlisting"> “surround” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 338<p>Surround.</p> 339<p>Flags: Read / Write</p> 340<p>Default value: TRUE</p> 341</div> 342<hr> 343<div class="refsect2"> 344<a name="GstModPlug--surround-delay"></a><h3>The <code class="literal">“surround-delay”</code> property</h3> 345<pre class="programlisting"> “surround-delay” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 346<p>Surround delay.</p> 347<p>Flags: Read / Write</p> 348<p>Allowed values: [0,40]</p> 349<p>Default value: 20</p> 350</div> 351<hr> 352<div class="refsect2"> 353<a name="GstModPlug--surround-depth"></a><h3>The <code class="literal">“surround-depth”</code> property</h3> 354<pre class="programlisting"> “surround-depth” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 355<p>Surround depth.</p> 356<p>Flags: Read / Write</p> 357<p>Allowed values: [0,100]</p> 358<p>Default value: 20</p> 359</div> 360</div> 361</div> 362<div class="footer"> 363<hr>Generated by GTK-Doc V1.28</div> 364</body> 365</html>
