/usr/share/gtk-doc/html/gst-buzztard/GstBtToneConversion.html is in gstreamer0.10-buzztard-doc 0.6.0-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GStreamer Buzztard Reference Manual: GstBtToneConversion</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer Buzztard Reference Manual">
<link rel="up" href="ch01.html" title="GStreamer Buzztard classes">
<link rel="prev" href="gst-buzztard-GstBtMusicEnums.html" title="GstBtMusicEnums">
<link rel="next" href="ch02.html" title="GStreamer Buzztard interfaces">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GstBtToneConversion.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GstBtToneConversion.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GstBtToneConversion.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-buzztard-GstBtMusicEnums.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GstBtToneConversion"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GstBtToneConversion.top_of_page"></a>GstBtToneConversion</span></h2>
<p>GstBtToneConversion — helper class for tone unit conversion</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GstBtToneConversion.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GstBtToneConversion.html" title="GstBtToneConversion"><span class="returnvalue">GstBtToneConversion</span></a> *
</td>
<td class="function_name">
<a class="link" href="GstBtToneConversion.html#gstbt-tone-conversion-new" title="gstbt_tone_conversion_new ()">gstbt_tone_conversion_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="GstBtToneConversion.html#gstbt-tone-conversion-translate-from-string" title="gstbt_tone_conversion_translate_from_string ()">gstbt_tone_conversion_translate_from_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="GstBtToneConversion.html#gstbt-tone-conversion-translate-from-number" title="gstbt_tone_conversion_translate_from_number ()">gstbt_tone_conversion_translate_from_number</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="GstBtToneConversion.html#gstbt-tone-conversion-note-string-2-number" title="gstbt_tone_conversion_note_string_2_number ()">gstbt_tone_conversion_note_string_2_number</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="GstBtToneConversion.html#gstbt-tone-conversion-note-number-2-string" title="gstbt_tone_conversion_note_number_2_string ()">gstbt_tone_conversion_note_number_2_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstBtToneConversion.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><a class="link" href="GstBtToneConversion.html#GstBtToneConversionTuning" title="enum GstBtToneConversionTuning"><span class="type">GstBtToneConversionTuning</span></a></td>
<td class="property_name"><a class="link" href="GstBtToneConversion.html#GstBtToneConversion--tuning" title="The “tuning” property">tuning</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstBtToneConversion.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GstBtToneConversion.html#GstBtToneConversion-struct" title="struct GstBtToneConversion">GstBtToneConversion</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GstBtToneConversion.html#GstBtToneConversionTuning" title="enum GstBtToneConversionTuning">GstBtToneConversionTuning</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstBtToneConversion.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GstBtToneConversion
</pre>
</div>
<div class="refsect1">
<a name="GstBtToneConversion.description"></a><h2>Description</h2>
<p>An instance of this class can translate a musical note to a frequency, while
taking a specific tuning into account. It also provides conversion betwen
notes as numbers and strings.</p>
</div>
<div class="refsect1">
<a name="GstBtToneConversion.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gstbt-tone-conversion-new"></a><h3>gstbt_tone_conversion_new ()</h3>
<pre class="programlisting"><a class="link" href="GstBtToneConversion.html" title="GstBtToneConversion"><span class="returnvalue">GstBtToneConversion</span></a> *
gstbt_tone_conversion_new (<em class="parameter"><code><a class="link" href="GstBtToneConversion.html#GstBtToneConversionTuning" title="enum GstBtToneConversionTuning"><span class="type">GstBtToneConversionTuning</span></a> tuning</code></em>);</pre>
<p>Create a new instance of a note to frequency translator, that will use the
given <em class="parameter"><code>tuning</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.4.8.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>tuning</p></td>
<td class="parameter_description"><p>the <a class="link" href="GstBtToneConversion.html#GstBtToneConversionTuning" title="enum GstBtToneConversionTuning"><span class="type">GstBtToneConversionTuning</span></a> to use</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.4.8.2.6"></a><h4>Returns</h4>
<p> a new <a class="link" href="GstBtToneConversion.html" title="GstBtToneConversion"><span class="type">GstBtToneConversion</span></a> translator</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gstbt-tone-conversion-translate-from-string"></a><h3>gstbt_tone_conversion_translate_from_string ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
gstbt_tone_conversion_translate_from_string
(<em class="parameter"><code><a class="link" href="GstBtToneConversion.html" title="GstBtToneConversion"><span class="type">GstBtToneConversion</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *note</code></em>);</pre>
<p>Converts the string representation of a musical note such as 'C-3' or 'd#4'
to a frequency in Hz.</p>
<div class="refsect3">
<a name="id-1.3.4.8.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstBtToneConversion.html" title="GstBtToneConversion"><span class="type">GstBtToneConversion</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>note</p></td>
<td class="parameter_description"><p>a musical note in string representation</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.4.8.3.6"></a><h4>Returns</h4>
<p> the frequency of the note or 0.0 in case of an error</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gstbt-tone-conversion-translate-from-number"></a><h3>gstbt_tone_conversion_translate_from_number ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
gstbt_tone_conversion_translate_from_number
(<em class="parameter"><code><a class="link" href="GstBtToneConversion.html" title="GstBtToneConversion"><span class="type">GstBtToneConversion</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">guint</span> note</code></em>);</pre>
<p>Converts the musical note number to a frequency in Hz.</p>
<div class="refsect3">
<a name="id-1.3.4.8.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstBtToneConversion.html" title="GstBtToneConversion"><span class="type">GstBtToneConversion</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>note</p></td>
<td class="parameter_description"><p>a musical note (<a class="link" href="gst-buzztard-GstBtMusicEnums.html#GstBtNote" title="enum GstBtNote"><span class="type">GstBtNote</span></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.4.8.4.6"></a><h4>Returns</h4>
<p> the frequency of the note or 0.0 in case of an error</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gstbt-tone-conversion-note-string-2-number"></a><h3>gstbt_tone_conversion_note_string_2_number ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
gstbt_tone_conversion_note_string_2_number
(<em class="parameter"><code>const <span class="type">gchar</span> *note</code></em>);</pre>
<p>Converts the string representation of a musical note such as 'C-3' or 'd#4'
to a note number.</p>
<div class="refsect3">
<a name="id-1.3.4.8.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>note</p></td>
<td class="parameter_description"><p>a musical note in string representation</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.4.8.5.6"></a><h4>Returns</h4>
<p> the note number or 0 in case of an error.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gstbt-tone-conversion-note-number-2-string"></a><h3>gstbt_tone_conversion_note_number_2_string ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gstbt_tone_conversion_note_number_2_string
(<em class="parameter"><code><span class="type">guint</span> note</code></em>);</pre>
<p>Converts the numerical number of a note to a string. A value of 1
for <em class="parameter"><code>note</code></em>
represents 'c-0'. The highest supported value is 'b-9' (or 'h-9')
which is 1+(9*16)+11 (1 octave has 12 tones, 4 are left unused for easy
coding).</p>
<div class="refsect3">
<a name="id-1.3.4.8.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>note</p></td>
<td class="parameter_description"><p>a musical note as number</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.4.8.6.6"></a><h4>Returns</h4>
<p> the note as string or an empty string in the case of an error.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GstBtToneConversion.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstBtToneConversion-struct"></a><h3>struct GstBtToneConversion</h3>
<pre class="programlisting">struct GstBtToneConversion;</pre>
<p>Opaque object instance.</p>
</div>
<hr>
<div class="refsect2">
<a name="GstBtToneConversionTuning"></a><h3>enum GstBtToneConversionTuning</h3>
<p>Supported tuning types.
see http://en.wikipedia.org/wiki/Musical_tuning</p>
<div class="refsect3">
<a name="id-1.3.4.9.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody><tr>
<td class="enum_member_name"><p><a name="GSTBT-TONE-CONVERSION-CROMATIC:CAPS"></a>GSTBT_TONE_CONVERSION_CROMATIC</p></td>
<td class="enum_member_description">
<p>12 tones with equal distance (equal temperament)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GstBtToneConversion.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstBtToneConversion--tuning"></a><h3>The <code class="literal">“tuning”</code> property</h3>
<pre class="programlisting"> “tuning” <a class="link" href="GstBtToneConversion.html#GstBtToneConversionTuning" title="enum GstBtToneConversionTuning"><span class="type">GstBtToneConversionTuning</span></a></pre>
<p>selection frequency tuning table.</p>
<p>Flags: Read / Write</p>
<p>Default value: GSTBT_TONE_CONVERSION_CROMATIC</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|