gstreamer0.10-buzztard-doc 0.5.0-2 / usr / share / gtk-doc / html / gst-buzztard / GstBtToneConversion.html

This file is indexed.

/usr/share/gtk-doc/html/gst-buzztard/GstBtToneConversion.html is in gstreamer0.10-buzztard-doc 0.5.0-2.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstBtToneConversion</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<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.15 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="gst-buzztard-GstBtMusicEnums.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">GStreamer Buzztard Reference Manual</th>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GstBtToneConversion.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GstBtToneConversion.description" class="shortcut">Description</a>
                   | 
                  <a href="#GstBtToneConversion.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GstBtToneConversion.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="GstBtToneConversion">
<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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GstBtToneConversion.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="GstBtToneConversion.html#GstBtToneConversion-struct" title="GstBtToneConversion">GstBtToneConversion</a>;
enum                <a class="link" href="GstBtToneConversion.html#GstBtToneConversionTuning" title="enum GstBtToneConversionTuning">GstBtToneConversionTuning</a>;
<a class="link" href="GstBtToneConversion.html" title="GstBtToneConversion"><span class="returnvalue">GstBtToneConversion</span></a> * <a class="link" href="GstBtToneConversion.html#gstbt-tone-conversion-new" title="gstbt_tone_conversion_new ()">gstbt_tone_conversion_new</a>         (<em class="parameter"><code><a class="link" href="GstBtToneConversion.html#GstBtToneConversionTuning" title="enum GstBtToneConversionTuning"><span class="type">GstBtToneConversionTuning</span></a> tuning</code></em>);
<span class="returnvalue">gdouble</span>             <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>
                                                        (<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>);
<span class="returnvalue">gdouble</span>             <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>
                                                        (<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>);
<span class="returnvalue">guint</span>               <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>
                                                        (<em class="parameter"><code>const <span class="type">gchar</span> *note</code></em>);
const <span class="returnvalue">gchar</span> *       <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>
                                                        (<em class="parameter"><code><span class="type">guint</span> note</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GstBtToneConversion.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GstBtToneConversion
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="GstBtToneConversion.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GstBtToneConversion.html#GstBtToneConversion--tuning" title='The "tuning" property'>tuning</a>"                   <a class="link" href="GstBtToneConversion.html#GstBtToneConversionTuning" title="enum GstBtToneConversionTuning"><span class="type">GstBtToneConversionTuning</span></a>  : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<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" title="Details">
<a name="GstBtToneConversion.details"></a><h2>Details</h2>
<div class="refsect2" title="GstBtToneConversion">
<a name="GstBtToneConversion-struct"></a><h3>GstBtToneConversion</h3>
<pre class="programlisting">typedef struct _GstBtToneConversion GstBtToneConversion;</pre>
<p>
Opaque object instance.
</p>
</div>
<hr>
<div class="refsect2" title="enum GstBtToneConversionTuning">
<a name="GstBtToneConversionTuning"></a><h3>enum GstBtToneConversionTuning</h3>
<pre class="programlisting">typedef enum {
  /* 12 tones with equal distance (equal temperament) */
  GSTBT_TONE_CONVERSION_CROMATIC=0,
  /* @todo: add more */
} GstBtToneConversionTuning;
</pre>
<p>
Supported tuning types.
see http://en.wikipedia.org/wiki/Musical_tuning
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><a name="GSTBT-TONE-CONVERSION-CROMATIC:CAPS"></a><span class="term"><code class="literal">GSTBT_TONE_CONVERSION_CROMATIC</code></span></p></td>
<td>12 tones with equal distance (equal temperament)
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gstbt_tone_conversion_new ()">
<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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tuning</code></em> :</span></p></td>
<td>the <a class="link" href="GstBtToneConversion.html#GstBtToneConversionTuning" title="enum GstBtToneConversionTuning"><span class="type">GstBtToneConversionTuning</span></a> to use
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="GstBtToneConversion.html" title="GstBtToneConversion"><span class="type">GstBtToneConversion</span></a> translator
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gstbt_tone_conversion_translate_from_string ()">
<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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GstBtToneConversion.html" title="GstBtToneConversion"><span class="type">GstBtToneConversion</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>note</code></em> :</span></p></td>
<td>a musical note in string representation
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the frequency of the note or 0.0 in case of an error
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gstbt_tone_conversion_translate_from_number ()">
<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 numerical number of a note to a frequency in Hz. 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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GstBtToneConversion.html" title="GstBtToneConversion"><span class="type">GstBtToneConversion</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>note</code></em> :</span></p></td>
<td>a musical note as number
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the frequency of the note or 0.0 in case of an error
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gstbt_tone_conversion_note_string_2_number ()">
<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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>note</code></em> :</span></p></td>
<td>a musical note in string representation
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the note number or 0 in case of an error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gstbt_tone_conversion_note_number_2_string ()">
<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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>note</code></em> :</span></p></td>
<td>a musical note as number
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the note as string or an empty string in the case of an error.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="GstBtToneConversion.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "tuning" property'>
<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>  : Read / Write</pre>
<p>selection frequency tuning table.</p>
<p>Default value: GSTBT_TONE_CONVERSION_CROMATIC</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.