/usr/share/gtk-doc/html/libinstpatch/IpatchBase.html is in libinstpatch-doc 1.0.0-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchBase</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="libinstpatch Reference Manual">
<link rel="up" href="ch01.html" title="Base objects and functions">
<link rel="prev" href="IpatchContainer.html" title="IpatchContainer">
<link rel="next" href="IpatchFile.html" title="IpatchFile">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Base objects and functions">
<link rel="chapter" href="ch02.html" title="Utility objects and functions">
<link rel="chapter" href="ch03.html" title="Sample data objects and functions">
<link rel="chapter" href="ch04.html" title="DLS patches">
<link rel="chapter" href="ch05.html" title="SoundFont patches">
<link rel="chapter" href="ch06.html" title="GigaSampler patches">
<link rel="chapter" href="ch07.html" title="Virtual banks">
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
<link rel="index" href="api-index-full.html" title="API Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="IpatchContainer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinstpatch Reference Manual</th>
<td><a accesskey="n" href="IpatchFile.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchBase.synopsis" class="shortcut">Top</a>
|
<a href="#IpatchBase.description" class="shortcut">Description</a>
|
<a href="#IpatchBase.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#IpatchBase.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchBase">
<a name="IpatchBase"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchBase.top_of_page"></a>IpatchBase</span></h2>
<p>IpatchBase — Base instrument file object type</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchBase.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchBase.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
enum <a
href="../libinstpatch/IpatchBase.html#IpatchBaseFlags"
>IpatchBaseFlags</a>;
#define <a
href="../libinstpatch/IpatchBase.html#IPATCH-BASE-UNUSED-FLAG-SHIFT--CAPS"
>IPATCH_BASE_UNUSED_FLAG_SHIFT</a>
<a
href="../libinstpatch/IpatchBase.html#IpatchBase-struct"
>IpatchBase</a>;
#define <a
href="../libinstpatch/IpatchBase.html#IPATCH-BASE-DEFAULT-NAME--CAPS"
>IPATCH_BASE_DEFAULT_NAME</a>
void <a
href="../libinstpatch/IpatchBase.html#ipatch-base-set-file"
>ipatch_base_set_file</a> (<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a> *base,
<a
href="../libinstpatch/IpatchFile.html"
>IpatchFile</a> *file);
<a
href="../libinstpatch/IpatchFile.html"
>IpatchFile</a> * <a
href="../libinstpatch/IpatchBase.html#ipatch-base-get-file"
>ipatch_base_get_file</a> (<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a> *base);
void <a
href="../libinstpatch/IpatchBase.html#ipatch-base-set-file-name"
>ipatch_base_set_file_name</a> (<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a> *base,
const char *file_name);
char * <a
href="../libinstpatch/IpatchBase.html#ipatch-base-get-file-name"
>ipatch_base_get_file_name</a> (<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a> *base);
void <a
href="../libinstpatch/IpatchBase.html#ipatch-base-find-unused-midi-locale"
>ipatch_base_find_unused_midi_locale</a> (<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a> *base,
int *bank,
int *program,
const <a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *exclude,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> percussion);
<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> * <a
href="../libinstpatch/IpatchBase.html#ipatch-base-find-item-by-midi-locale"
>ipatch_base_find_item_by_midi_locale</a>
(<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a> *base,
int bank,
int program);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchBase.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a>
+----<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a>
+----IpatchBase
+----<a
href="../libinstpatch/IpatchDLS2.html"
>IpatchDLS2</a>
+----<a
href="../libinstpatch/IpatchSF2.html"
>IpatchSF2</a>
+----<a
href="../libinstpatch/IpatchVBank.html"
>IpatchVBank</a>
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchBase.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a
href="../libinstpatch/IpatchBase.html#IpatchBase--changed"
>changed</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a
href="../libinstpatch/IpatchBase.html#IpatchBase--file"
>file</a>" <a
href="../libinstpatch/IpatchFile.html"
>IpatchFile</a>* : Read / Write
"<a
href="../libinstpatch/IpatchBase.html#IpatchBase--file-name"
>file-name</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write
"<a
href="../libinstpatch/IpatchBase.html#IpatchBase--saved"
>saved</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchBase.description"></a><h2>Description</h2>
<p>
Defines an abstract object type which is used as the basis of instrument
files, such as <a
href="../libinstpatch/IpatchSF2.html"
><span class="type">IpatchSF2</span></a>, <span class="type">IpatchDLS</span>, etc.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchBase.details"></a><h2>Details</h2>
<div class="refsect2" title="enum IpatchBaseFlags">
<a name="IpatchBaseFlags"></a><h3>enum IpatchBaseFlags</h3>
<pre class="programlisting">typedef enum
{
/* patch changed flag */
IPATCH_BASE_CHANGED = 1 << IPATCH_ITEM_UNUSED_FLAG_SHIFT,
/* patch been saved ever? */
IPATCH_BASE_SAVED = 1 << (IPATCH_ITEM_UNUSED_FLAG_SHIFT + 1)
} IpatchBaseFlags;
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_BASE_UNUSED_FLAG_SHIFT">
<a name="IPATCH-BASE-UNUSED-FLAG-SHIFT--CAPS"></a><h3>IPATCH_BASE_UNUSED_FLAG_SHIFT</h3>
<pre class="programlisting">#define IPATCH_BASE_UNUSED_FLAG_SHIFT (IPATCH_ITEM_UNUSED_FLAG_SHIFT + 4)
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchBase">
<a name="IpatchBase-struct"></a><h3>IpatchBase</h3>
<pre class="programlisting">typedef struct _IpatchBase IpatchBase;</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_BASE_DEFAULT_NAME">
<a name="IPATCH-BASE-DEFAULT-NAME--CAPS"></a><h3>IPATCH_BASE_DEFAULT_NAME</h3>
<pre class="programlisting">#define IPATCH_BASE_DEFAULT_NAME "Untitled"
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_base_set_file ()">
<a name="ipatch-base-set-file"></a><h3>ipatch_base_set_file ()</h3>
<pre class="programlisting">void ipatch_base_set_file (<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a> *base,
<a
href="../libinstpatch/IpatchFile.html"
>IpatchFile</a> *file);</pre>
<p>
Sets the file object associated with a patch.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>base</code></em> :</span></p></td>
<td> Patch base object to set file object of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td> File object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_base_get_file ()">
<a name="ipatch-base-get-file"></a><h3>ipatch_base_get_file ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchFile.html"
>IpatchFile</a> * ipatch_base_get_file (<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a> *base);</pre>
<p>
Get the file object associated with a patch base object. Caller owns a
reference to the returned file object and it should be unrefed when
done with it.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>base</code></em> :</span></p></td>
<td> Patch base object to get file object from
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> File object or <code class="literal">NULL</code> if not set. Remember to unref it when done
with it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_base_set_file_name ()">
<a name="ipatch-base-set-file-name"></a><h3>ipatch_base_set_file_name ()</h3>
<pre class="programlisting">void ipatch_base_set_file_name (<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a> *base,
const char *file_name);</pre>
<p>
Sets the file name of the file object in a patch base object. File object
should have been set before calling this function (otherwise request is
silently ignored). A convenience function as one could get the file object
and set it directly.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>base</code></em> :</span></p></td>
<td> Patch base object to set file name of
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
<td> Path and name to set filename to
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_base_get_file_name ()">
<a name="ipatch-base-get-file-name"></a><h3>ipatch_base_get_file_name ()</h3>
<pre class="programlisting">char * ipatch_base_get_file_name (<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a> *base);</pre>
<p>
Get the file name of the file object in a base patch item. A convenience
function.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>base</code></em> :</span></p></td>
<td> Base patch item to get file name from.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New allocated file name or <code class="literal">NULL</code> if not set or file object
not set. String should be freed when finished with it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_base_find_unused_midi_locale ()">
<a name="ipatch-base-find-unused-midi-locale"></a><h3>ipatch_base_find_unused_midi_locale ()</h3>
<pre class="programlisting">void ipatch_base_find_unused_midi_locale (<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a> *base,
int *bank,
int *program,
const <a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> *exclude,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> percussion);</pre>
<p>
Finds an unused MIDI locale (bank:program number pair) in a patch
base object. The way in which MIDI bank and program numbers are
used is implementation dependent. Percussion instruments often
affect the bank parameter (for example SoundFont uses bank 128 for
percussion presets). On input the <em class="parameter"><code>bank</code></em> and <em class="parameter"><code>program</code></em> parameters
set the initial locale to start from (set to 0:0 to find the first
free value). If the <em class="parameter"><code>percussion</code></em> parameter is set it may affect
<em class="parameter"><code>bank</code></em>, if its not set, bank will not be modified (e.g., if bank is
a percussion value it will be used). The exclude parameter can be
set to a child item of <em class="parameter"><code>base</code></em> to exclude from the list of "used"
locales (useful when making an item unique that is already parented
to <em class="parameter"><code>base</code></em>). On return <em class="parameter"><code>bank</code></em> and <em class="parameter"><code>program</code></em> will be set to an unused
MIDI locale based on the input criteria.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>base</code></em> :</span></p></td>
<td> Patch base object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bank</code></em> :</span></p></td>
<td> MIDI bank number (input and output parameter)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
<td> MIDI program number (input and output parameter)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>exclude</code></em> :</span></p></td>
<td> Child of <em class="parameter"><code>base</code></em> with MIDI locale to exclude or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>percussion</code></em> :</span></p></td>
<td> Set to <code class="literal">TRUE</code> to find a free percussion MIDI locale
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_base_find_item_by_midi_locale ()">
<a name="ipatch-base-find-item-by-midi-locale"></a><h3>ipatch_base_find_item_by_midi_locale ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a> * ipatch_base_find_item_by_midi_locale
(<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a> *base,
int bank,
int program);</pre>
<p>
Find a child object in a base patch object which matches the given MIDI
locale (<em class="parameter"><code>bank</code></em> and <em class="parameter"><code>program</code></em> numbers).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>base</code></em> :</span></p></td>
<td> Patch base object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bank</code></em> :</span></p></td>
<td> MIDI bank number of item to search for
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
<td> MIDI program number of item to search for
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The item or <code class="literal">NULL</code> if not found. The caller owns a reference to the
returned object, and is responsible for unref'ing when finished.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchBase.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "changed" property'>
<a name="IpatchBase--changed"></a><h3>The <code class="literal">"changed"</code> property</h3>
<pre class="programlisting"> "changed" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>Changed Flag.</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2" title='The "file" property'>
<a name="IpatchBase--file"></a><h3>The <code class="literal">"file"</code> property</h3>
<pre class="programlisting"> "file" <a
href="../libinstpatch/IpatchFile.html"
>IpatchFile</a>* : Read / Write</pre>
<p>File Object.</p>
</div>
<hr>
<div class="refsect2" title='The "file-name" property'>
<a name="IpatchBase--file-name"></a><h3>The <code class="literal">"file-name"</code> property</h3>
<pre class="programlisting"> "file-name" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write</pre>
<p>File Name.</p>
<p>Default value: "untitled"</p>
</div>
<hr>
<div class="refsect2" title='The "saved" property'>
<a name="IpatchBase--saved"></a><h3>The <code class="literal">"saved"</code> property</h3>
<pre class="programlisting"> "saved" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>Been Saved Flag.</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|