Tizen 2.0 Release
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-monoscope.html
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>monoscope</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
9 <link rel="prev" href="gst-plugins-good-plugins-mj2mux.html" title="mj2mux">
10 <link rel="next" href="gst-plugins-good-plugins-mpegaudioparse.html" title="mpegaudioparse">
11 <meta name="generator" content="GTK-Doc V1.18 (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="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="gst-plugins-good-plugins-mj2mux.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GStreamer Good Plugins 0.10 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-good-plugins-mpegaudioparse.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-good-plugins-monoscope.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-monoscope.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="gst-plugins-good-plugins-monoscope"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
33 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-monoscope.top_of_page"></a>monoscope</span></h2>
34 <p>monoscope — Displays a highly stabilised waveform of audio input</p>
35 </td>
36 <td valign="top" align="right"></td>
37 </tr></table></div>
38 <div class="refsynopsisdiv">
39 <a name="gst-plugins-good-plugins-monoscope.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-monoscope.html#GstMonoscope" title="struct GstMonoscope">GstMonoscope</a>;
41 </pre>
42 </div>
43 <div class="refsect1">
44 <a name="gst-plugins-good-plugins-monoscope.description"></a><h2>Description</h2>
45 <p>
46 Monoscope is an audio visualisation element. It creates a coloured
47 curve of the audio signal like on an oscilloscope.
48 </p>
49 <p>
50 </p>
51 <div class="refsect2">
52 <a name="idp12018016"></a><h3>Example launch line</h3>
53 <div class="informalexample">
54   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
55     <tbody>
56       <tr>
57         <td class="listing_lines" align="right"><pre>1</pre></td>
58         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v audiotestsrc <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> monoscope <span class="gtkdoc opt">!</span> ffmpegcolorspace <span class="gtkdoc opt">!</span> ximagesink</pre></td>
59       </tr>
60     </tbody>
61   </table>
62 </div>
63
64 </div>
65 <p>
66 </p>
67 <div class="refsynopsisdiv">
68 <h2>Synopsis</h2>
69 <div class="refsect2">
70 <a name="idp9475504"></a><h3>Element Information</h3>
71 <div class="variablelist"><table border="0">
72 <col align="left" valign="top">
73 <tbody>
74 <tr>
75 <td><p><span class="term">plugin</span></p></td>
76 <td>
77             <a class="link" href="gst-plugins-good-plugins-plugin-monoscope.html#plugin-monoscope">monoscope</a>
78           </td>
79 </tr>
80 <tr>
81 <td><p><span class="term">author</span></p></td>
82 <td>Richard Boulton &lt;richard@tartarus.org&gt;</td>
83 </tr>
84 <tr>
85 <td><p><span class="term">class</span></p></td>
86 <td>Visualization</td>
87 </tr>
88 </tbody>
89 </table></div>
90 </div>
91 <hr>
92 <div class="refsect2">
93 <a name="idp13911056"></a><h3>Element Pads</h3>
94 <div class="variablelist"><table border="0">
95 <col align="left" valign="top">
96 <tbody>
97 <tr>
98 <td><p><span class="term">name</span></p></td>
99 <td>sink</td>
100 </tr>
101 <tr>
102 <td><p><span class="term">direction</span></p></td>
103 <td>sink</td>
104 </tr>
105 <tr>
106 <td><p><span class="term">presence</span></p></td>
107 <td>always</td>
108 </tr>
109 <tr>
110 <td><p><span class="term">details</span></p></td>
111 <td>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)2, endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true</td>
112 </tr>
113 </tbody>
114 </table></div>
115 <div class="variablelist"><table border="0">
116 <col align="left" valign="top">
117 <tbody>
118 <tr>
119 <td><p><span class="term">name</span></p></td>
120 <td>src</td>
121 </tr>
122 <tr>
123 <td><p><span class="term">direction</span></p></td>
124 <td>source</td>
125 </tr>
126 <tr>
127 <td><p><span class="term">presence</span></p></td>
128 <td>always</td>
129 </tr>
130 <tr>
131 <td><p><span class="term">details</span></p></td>
132 <td>video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)256, height=(int)128, framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
133 </tr>
134 </tbody>
135 </table></div>
136 </div>
137 </div>
138 <p>
139 </p>
140 </div>
141 <div class="refsect1">
142 <a name="gst-plugins-good-plugins-monoscope.details"></a><h2>Details</h2>
143 <div class="refsect2">
144 <a name="GstMonoscope"></a><h3>struct GstMonoscope</h3>
145 <pre class="programlisting">struct GstMonoscope {
146   GstElement element;
147
148   /* pads */
149   GstPad      *sinkpad;
150   GstPad      *srcpad;
151
152   GstAdapter  *adapter;
153
154   guint64      next_ts;             /* expected timestamp of the next frame */
155   guint64      frame_duration;      /* video frame duration    */
156   gint         rate;                /* sample rate             */
157   guint        bps;                 /* bytes per sample        */
158   guint        spf;                 /* samples per video frame */
159
160   GstSegment   segment;
161
162   /* QoS stuff *//* with LOCK */
163   gdouble      proportion;
164   GstClockTime earliest_time;
165
166   /* video state */
167   gint         fps_num;
168   gint         fps_denom;
169   gint         width;
170   gint         height;
171   guint        outsize;
172
173   /* visualisation state */
174   struct monoscope_state *visstate;
175 };
176 </pre>
177 <p>
178 </p>
179 </div>
180 </div>
181 <div class="refsect1">
182 <a name="gst-plugins-good-plugins-monoscope.see-also"></a><h2>See Also</h2>
183 goom
184 </div>
185 </div>
186 <div class="footer">
187 <hr>
188           Generated by GTK-Doc V1.18</div>
189 </body>
190 </html>