1 /* gstmonoscope.c: implementation of monoscope drawing element
2 * Copyright (C) <2002> Richard Boulton <richard@tartarus.org>
3 * Copyright (C) <2006> Tim-Philipp Müller <tim centricular net>
4 * Copyright (C) <2006> Wim Taymans <wim at fluendo dot com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
23 * SECTION:element-monoscope
26 * Monoscope is an audio visualisation element. It creates a coloured
27 * curve of the audio signal like on an oscilloscope.
30 * <title>Example launch line</title>
32 * gst-launch-1.0 -v audiotestsrc ! audioconvert ! monoscope ! videoconvert ! ximagesink
41 #include <gst/video/video.h>
42 #include <gst/audio/audio.h>
44 #include "gstmonoscope.h"
45 #include "monoscope.h"
47 GST_DEBUG_CATEGORY_STATIC (monoscope_debug);
48 #define GST_CAT_DEFAULT monoscope_debug
50 #if G_BYTE_ORDER == G_BIG_ENDIAN
51 #define RGB_ORDER "xRGB"
53 #define RGB_ORDER "BGRx"
56 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
59 GST_STATIC_CAPS ("video/x-raw, "
60 "format = (string) " RGB_ORDER ", "
61 "width = " G_STRINGIFY (scope_width) ", "
62 "height = " G_STRINGIFY (scope_height) ", "
63 "framerate = " GST_VIDEO_FPS_RANGE)
66 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
69 GST_STATIC_CAPS ("audio/x-raw, "
70 "format = (string) " GST_AUDIO_NE (S16) ", "
71 "rate = (int) [ 8000, 96000 ], "
72 "channels = (int) 1, " "layout = (string) interleaved")
76 #define gst_monoscope_parent_class parent_class
77 G_DEFINE_TYPE (GstMonoscope, gst_monoscope, GST_TYPE_ELEMENT);
79 static void gst_monoscope_finalize (GObject * object);
80 static GstFlowReturn gst_monoscope_chain (GstPad * pad, GstObject * parent,
82 static gboolean gst_monoscope_src_setcaps (GstMonoscope * mono, GstCaps * caps);
83 static gboolean gst_monoscope_sink_setcaps (GstMonoscope * mono,
85 static void gst_monoscope_reset (GstMonoscope * monoscope);
86 static gboolean gst_monoscope_sink_event (GstPad * pad, GstObject * parent,
88 static gboolean gst_monoscope_src_event (GstPad * pad, GstObject * parent,
90 static GstStateChangeReturn gst_monoscope_change_state (GstElement * element,
91 GstStateChange transition);
94 gst_monoscope_class_init (GstMonoscopeClass * klass)
96 GObjectClass *gobject_class;
97 GstElementClass *gstelement_class;
99 gobject_class = (GObjectClass *) klass;
100 gstelement_class = (GstElementClass *) klass;
102 gobject_class->finalize = gst_monoscope_finalize;
104 gstelement_class->change_state =
105 GST_DEBUG_FUNCPTR (gst_monoscope_change_state);
107 gst_element_class_add_static_pad_template (gstelement_class, &src_template);
108 gst_element_class_add_static_pad_template (gstelement_class, &sink_template);
109 gst_element_class_set_static_metadata (gstelement_class, "Monoscope",
111 "Displays a highly stabilised waveform of audio input",
112 "Richard Boulton <richard@tartarus.org>");
116 gst_monoscope_init (GstMonoscope * monoscope)
119 gst_pad_new_from_static_template (&sink_template, "sink");
120 gst_pad_set_chain_function (monoscope->sinkpad,
121 GST_DEBUG_FUNCPTR (gst_monoscope_chain));
122 gst_pad_set_event_function (monoscope->sinkpad,
123 GST_DEBUG_FUNCPTR (gst_monoscope_sink_event));
124 gst_element_add_pad (GST_ELEMENT (monoscope), monoscope->sinkpad);
126 monoscope->srcpad = gst_pad_new_from_static_template (&src_template, "src");
127 gst_pad_set_event_function (monoscope->srcpad,
128 GST_DEBUG_FUNCPTR (gst_monoscope_src_event));
129 gst_element_add_pad (GST_ELEMENT (monoscope), monoscope->srcpad);
131 monoscope->adapter = gst_adapter_new ();
132 monoscope->next_ts = GST_CLOCK_TIME_NONE;
133 monoscope->bps = sizeof (gint16);
135 /* reset the initial video state */
136 monoscope->width = scope_width;
137 monoscope->height = scope_height;
138 monoscope->fps_num = 25; /* desired frame rate */
139 monoscope->fps_denom = 1;
140 monoscope->visstate = NULL;
142 /* reset the initial audio state */
143 monoscope->rate = GST_AUDIO_DEF_RATE;
147 gst_monoscope_finalize (GObject * object)
149 GstMonoscope *monoscope = GST_MONOSCOPE (object);
151 if (monoscope->visstate)
152 monoscope_close (monoscope->visstate);
154 g_object_unref (monoscope->adapter);
156 G_OBJECT_CLASS (parent_class)->finalize (object);
160 gst_monoscope_reset (GstMonoscope * monoscope)
162 monoscope->next_ts = GST_CLOCK_TIME_NONE;
164 gst_adapter_clear (monoscope->adapter);
165 gst_segment_init (&monoscope->segment, GST_FORMAT_UNDEFINED);
166 monoscope->segment_pending = FALSE;
168 GST_OBJECT_LOCK (monoscope);
169 monoscope->proportion = 1.0;
170 monoscope->earliest_time = -1;
171 GST_OBJECT_UNLOCK (monoscope);
175 gst_monoscope_sink_setcaps (GstMonoscope * monoscope, GstCaps * caps)
177 GstStructure *structure;
179 structure = gst_caps_get_structure (caps, 0);
181 gst_structure_get_int (structure, "rate", &monoscope->rate);
183 GST_DEBUG_OBJECT (monoscope, "sample rate = %d", monoscope->rate);
188 gst_monoscope_src_setcaps (GstMonoscope * monoscope, GstCaps * caps)
190 GstStructure *structure;
193 structure = gst_caps_get_structure (caps, 0);
195 gst_structure_get_int (structure, "width", &monoscope->width);
196 gst_structure_get_int (structure, "height", &monoscope->height);
197 gst_structure_get_fraction (structure, "framerate", &monoscope->fps_num,
198 &monoscope->fps_denom);
200 monoscope->outsize = monoscope->width * monoscope->height * 4;
201 monoscope->frame_duration = gst_util_uint64_scale_int (GST_SECOND,
202 monoscope->fps_denom, monoscope->fps_num);
204 gst_util_uint64_scale_int (monoscope->rate, monoscope->fps_denom,
207 GST_DEBUG_OBJECT (monoscope, "dimension %dx%d, framerate %d/%d, spf %d",
208 monoscope->width, monoscope->height, monoscope->fps_num,
209 monoscope->fps_denom, monoscope->spf);
211 if (monoscope->visstate) {
212 monoscope_close (monoscope->visstate);
213 monoscope->visstate = NULL;
216 monoscope->visstate = monoscope_init (monoscope->width, monoscope->height);
218 res = gst_pad_set_caps (monoscope->srcpad, caps);
220 return res && (monoscope->visstate != NULL);
224 gst_monoscope_src_negotiate (GstMonoscope * monoscope)
226 GstCaps *othercaps, *target;
227 GstStructure *structure;
231 GstStructure *config;
232 guint size, min, max;
234 templ = gst_pad_get_pad_template_caps (monoscope->srcpad);
236 GST_DEBUG_OBJECT (monoscope, "performing negotiation");
238 /* see what the peer can do */
239 othercaps = gst_pad_peer_query_caps (monoscope->srcpad, NULL);
241 target = gst_caps_intersect (othercaps, templ);
242 gst_caps_unref (othercaps);
243 gst_caps_unref (templ);
245 if (gst_caps_is_empty (target))
248 target = gst_caps_truncate (target);
253 target = gst_caps_make_writable (target);
254 structure = gst_caps_get_structure (target, 0);
255 gst_structure_fixate_field_nearest_int (structure, "width", 320);
256 gst_structure_fixate_field_nearest_int (structure, "height", 240);
257 gst_structure_fixate_field_nearest_fraction (structure, "framerate", 25, 1);
258 if (gst_structure_has_field (structure, "pixel-aspect-ratio"))
259 gst_structure_fixate_field_nearest_fraction (structure,
260 "pixel-aspect-ratio", 1, 1);
261 target = gst_caps_fixate (target);
263 gst_monoscope_src_setcaps (monoscope, target);
265 /* try to get a bufferpool now */
266 /* find a pool for the negotiated caps now */
267 query = gst_query_new_allocation (target, TRUE);
269 if (!gst_pad_peer_query (monoscope->srcpad, query)) {
272 if (gst_query_get_n_allocation_pools (query) > 0) {
273 /* we got configuration from our peer, parse them */
274 gst_query_parse_nth_allocation_pool (query, 0, &pool, &size, &min, &max);
277 size = monoscope->outsize;
282 /* we did not get a pool, make one ourselves then */
283 pool = gst_buffer_pool_new ();
286 config = gst_buffer_pool_get_config (pool);
287 gst_buffer_pool_config_set_params (config, target, size, min, max);
288 gst_buffer_pool_set_config (pool, config);
290 if (monoscope->pool) {
291 gst_buffer_pool_set_active (monoscope->pool, TRUE);
292 gst_object_unref (monoscope->pool);
294 monoscope->pool = pool;
297 gst_buffer_pool_set_active (pool, TRUE);
299 gst_query_unref (query);
300 gst_caps_unref (target);
306 gst_caps_unref (target);
311 /* make sure we are negotiated */
313 ensure_negotiated (GstMonoscope * monoscope)
315 gboolean reconfigure;
317 reconfigure = gst_pad_check_reconfigure (monoscope->srcpad);
319 /* we don't know an output format yet, pick one */
320 if (reconfigure || !gst_pad_has_current_caps (monoscope->srcpad)) {
321 if (!gst_monoscope_src_negotiate (monoscope)) {
322 gst_pad_mark_reconfigure (monoscope->srcpad);
323 if (GST_PAD_IS_FLUSHING (monoscope->srcpad))
324 return GST_FLOW_FLUSHING;
326 return GST_FLOW_NOT_NEGOTIATED;
333 gst_monoscope_chain (GstPad * pad, GstObject * parent, GstBuffer * inbuf)
335 GstFlowReturn flow_ret = GST_FLOW_OK;
336 GstMonoscope *monoscope;
338 monoscope = GST_MONOSCOPE (parent);
340 if (monoscope->rate == 0) {
341 gst_buffer_unref (inbuf);
342 flow_ret = GST_FLOW_NOT_NEGOTIATED;
346 /* Make sure have an output format */
347 flow_ret = ensure_negotiated (monoscope);
348 if (flow_ret != GST_FLOW_OK) {
349 gst_buffer_unref (inbuf);
353 if (monoscope->segment_pending) {
354 gst_pad_push_event (monoscope->srcpad,
355 gst_event_new_segment (&monoscope->segment));
356 monoscope->segment_pending = FALSE;
359 /* don't try to combine samples from discont buffer */
360 if (GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_DISCONT)) {
361 gst_adapter_clear (monoscope->adapter);
362 monoscope->next_ts = GST_CLOCK_TIME_NONE;
365 /* Match timestamps from the incoming audio */
366 if (GST_BUFFER_TIMESTAMP (inbuf) != GST_CLOCK_TIME_NONE)
367 monoscope->next_ts = GST_BUFFER_TIMESTAMP (inbuf);
369 GST_LOG_OBJECT (monoscope,
370 "in buffer has %" G_GSIZE_FORMAT " samples, ts=%" GST_TIME_FORMAT,
371 gst_buffer_get_size (inbuf) / monoscope->bps,
372 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (inbuf)));
374 gst_adapter_push (monoscope->adapter, inbuf);
377 /* Collect samples until we have enough for an output frame */
378 while (flow_ret == GST_FLOW_OK) {
380 GstBuffer *outbuf = NULL;
381 guint32 *pixels, avail, bytesperframe;
383 avail = gst_adapter_available (monoscope->adapter);
384 GST_LOG_OBJECT (monoscope, "bytes avail now %u", avail);
386 bytesperframe = monoscope->spf * monoscope->bps;
387 if (avail < bytesperframe)
390 /* FIXME: something is wrong with QoS, we are skipping way too much
391 * stuff even with very low CPU loads */
393 if (monoscope->next_ts != -1) {
397 qostime = gst_segment_to_running_time (&monoscope->segment,
398 GST_FORMAT_TIME, monoscope->next_ts);
400 GST_OBJECT_LOCK (monoscope);
401 /* check for QoS, don't compute buffers that are known to be late */
403 GST_CLOCK_TIME_IS_VALID (monoscope->earliest_time) &&
404 qostime <= monoscope->earliest_time;
405 GST_OBJECT_UNLOCK (monoscope);
408 GST_WARNING_OBJECT (monoscope,
409 "QoS: skip ts: %" GST_TIME_FORMAT ", earliest: %" GST_TIME_FORMAT,
410 GST_TIME_ARGS (qostime), GST_TIME_ARGS (monoscope->earliest_time));
416 samples = (gint16 *) gst_adapter_map (monoscope->adapter, bytesperframe);
418 if (monoscope->spf < convolver_big) {
419 gint16 in_data[convolver_big], i;
420 gdouble scale = (gdouble) monoscope->spf / (gdouble) convolver_big;
422 for (i = 0; i < convolver_big; ++i) {
423 gdouble off = (gdouble) i * scale;
424 in_data[i] = samples[MIN ((guint) off, monoscope->spf)];
426 pixels = monoscope_update (monoscope->visstate, in_data);
428 /* not really correct, but looks much prettier */
429 pixels = monoscope_update (monoscope->visstate, samples);
432 GST_LOG_OBJECT (monoscope, "allocating output buffer");
433 flow_ret = gst_buffer_pool_acquire_buffer (monoscope->pool, &outbuf, NULL);
434 if (flow_ret != GST_FLOW_OK) {
435 gst_adapter_unmap (monoscope->adapter);
439 gst_buffer_fill (outbuf, 0, pixels, monoscope->outsize);
441 GST_BUFFER_TIMESTAMP (outbuf) = monoscope->next_ts;
442 GST_BUFFER_DURATION (outbuf) = monoscope->frame_duration;
444 flow_ret = gst_pad_push (monoscope->srcpad, outbuf);
450 if (GST_CLOCK_TIME_IS_VALID (monoscope->next_ts))
451 monoscope->next_ts += monoscope->frame_duration;
453 gst_adapter_flush (monoscope->adapter, bytesperframe);
462 gst_monoscope_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
464 GstMonoscope *monoscope;
467 monoscope = GST_MONOSCOPE (parent);
469 switch (GST_EVENT_TYPE (event)) {
470 case GST_EVENT_FLUSH_START:
471 res = gst_pad_push_event (monoscope->srcpad, event);
473 case GST_EVENT_FLUSH_STOP:
474 gst_monoscope_reset (monoscope);
475 res = gst_pad_push_event (monoscope->srcpad, event);
477 case GST_EVENT_SEGMENT:
479 /* the newsegment values are used to clip the input samples
480 * and to convert the incoming timestamps to running time so
482 gst_event_copy_segment (event, &monoscope->segment);
484 /* We forward the event from the chain function after caps are
485 * negotiated. Otherwise we would potentially break the event order and
486 * send the segment event before the caps event */
487 monoscope->segment_pending = TRUE;
488 gst_event_unref (event);
496 gst_event_parse_caps (event, &caps);
497 gst_monoscope_sink_setcaps (monoscope, caps);
498 gst_event_unref (event);
503 res = gst_pad_push_event (monoscope->srcpad, event);
511 gst_monoscope_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
513 GstMonoscope *monoscope;
516 monoscope = GST_MONOSCOPE (parent);
518 switch (GST_EVENT_TYPE (event)) {
521 GstClockTimeDiff diff;
522 GstClockTime timestamp;
524 gst_event_parse_qos (event, NULL, &proportion, &diff, ×tamp);
526 /* save stuff for the _chain() function */
527 GST_OBJECT_LOCK (monoscope);
528 monoscope->proportion = proportion;
530 /* we're late, this is a good estimate for next displayable
531 * frame (see part-qos.txt) */
532 monoscope->earliest_time =
533 timestamp + 2 * diff + monoscope->frame_duration;
535 monoscope->earliest_time = timestamp + diff;
536 GST_OBJECT_UNLOCK (monoscope);
538 res = gst_pad_push_event (monoscope->sinkpad, event);
542 res = gst_pad_push_event (monoscope->sinkpad, event);
549 static GstStateChangeReturn
550 gst_monoscope_change_state (GstElement * element, GstStateChange transition)
552 GstMonoscope *monoscope = GST_MONOSCOPE (element);
553 GstStateChangeReturn ret;
555 switch (transition) {
556 case GST_STATE_CHANGE_NULL_TO_READY:
558 case GST_STATE_CHANGE_READY_TO_PAUSED:
559 gst_monoscope_reset (monoscope);
565 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
567 switch (transition) {
568 case GST_STATE_CHANGE_PAUSED_TO_READY:
569 if (monoscope->pool) {
570 gst_buffer_pool_set_active (monoscope->pool, FALSE);
571 gst_object_replace ((GstObject **) & monoscope->pool, NULL);
574 case GST_STATE_CHANGE_READY_TO_NULL:
584 plugin_init (GstPlugin * plugin)
586 GST_DEBUG_CATEGORY_INIT (monoscope_debug, "monoscope", 0,
587 "monoscope element");
589 return gst_element_register (plugin, "monoscope",
590 GST_RANK_NONE, GST_TYPE_MONOSCOPE);
593 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
596 "Monoscope visualization",
597 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);