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 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
53 #if G_BYTE_ORDER == G_BIG_ENDIAN
54 GST_STATIC_CAPS ("video/x-raw, "
55 "format = (string) xRGB, "
56 "width = 256, " "height = 128, " "framerate = " GST_VIDEO_FPS_RANGE)
58 GST_STATIC_CAPS ("video/x-raw, "
59 "format = (string) BGRx, "
60 "width = 256, " "height = 128, " "framerate = " GST_VIDEO_FPS_RANGE)
64 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
67 GST_STATIC_CAPS ("audio/x-raw, "
68 "format = (string) " GST_AUDIO_NE (S16) ", "
69 "rate = (int) [ 8000, 96000 ], "
70 "channels = (int) 1, " "layout = (string) interleaved")
74 #define gst_monoscope_parent_class parent_class
75 G_DEFINE_TYPE (GstMonoscope, gst_monoscope, GST_TYPE_ELEMENT);
77 static void gst_monoscope_finalize (GObject * object);
78 static GstFlowReturn gst_monoscope_chain (GstPad * pad, GstObject * parent,
80 static gboolean gst_monoscope_src_setcaps (GstMonoscope * mono, GstCaps * caps);
81 static gboolean gst_monoscope_sink_setcaps (GstMonoscope * mono,
83 static void gst_monoscope_reset (GstMonoscope * monoscope);
84 static gboolean gst_monoscope_sink_event (GstPad * pad, GstObject * parent,
86 static gboolean gst_monoscope_src_event (GstPad * pad, GstObject * parent,
88 static GstStateChangeReturn gst_monoscope_change_state (GstElement * element,
89 GstStateChange transition);
92 gst_monoscope_class_init (GstMonoscopeClass * klass)
94 GObjectClass *gobject_class;
95 GstElementClass *gstelement_class;
97 gobject_class = (GObjectClass *) klass;
98 gstelement_class = (GstElementClass *) klass;
100 gobject_class->finalize = gst_monoscope_finalize;
102 gstelement_class->change_state =
103 GST_DEBUG_FUNCPTR (gst_monoscope_change_state);
105 gst_element_class_add_pad_template (gstelement_class,
106 gst_static_pad_template_get (&src_template));
107 gst_element_class_add_pad_template (gstelement_class,
108 gst_static_pad_template_get (&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 = 256;
137 monoscope->height = 128;
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);
167 GST_OBJECT_LOCK (monoscope);
168 monoscope->proportion = 1.0;
169 monoscope->earliest_time = -1;
170 GST_OBJECT_UNLOCK (monoscope);
174 gst_monoscope_sink_setcaps (GstMonoscope * monoscope, GstCaps * caps)
176 GstStructure *structure;
178 structure = gst_caps_get_structure (caps, 0);
180 gst_structure_get_int (structure, "rate", &monoscope->rate);
182 GST_DEBUG_OBJECT (monoscope, "sample rate = %d", monoscope->rate);
187 gst_monoscope_src_setcaps (GstMonoscope * monoscope, GstCaps * caps)
189 GstStructure *structure;
192 structure = gst_caps_get_structure (caps, 0);
194 gst_structure_get_int (structure, "width", &monoscope->width);
195 gst_structure_get_int (structure, "height", &monoscope->height);
196 gst_structure_get_fraction (structure, "framerate", &monoscope->fps_num,
197 &monoscope->fps_denom);
199 monoscope->outsize = monoscope->width * monoscope->height * 4;
200 monoscope->frame_duration = gst_util_uint64_scale_int (GST_SECOND,
201 monoscope->fps_denom, monoscope->fps_num);
203 gst_util_uint64_scale_int (monoscope->rate, monoscope->fps_denom,
206 GST_DEBUG_OBJECT (monoscope, "dimension %dx%d, framerate %d/%d, spf %d",
207 monoscope->width, monoscope->height, monoscope->fps_num,
208 monoscope->fps_denom, monoscope->spf);
210 if (monoscope->visstate) {
211 monoscope_close (monoscope->visstate);
212 monoscope->visstate = NULL;
215 monoscope->visstate = monoscope_init (monoscope->width, monoscope->height);
217 res = gst_pad_set_caps (monoscope->srcpad, caps);
219 return res && (monoscope->visstate != NULL);
223 gst_monoscope_src_negotiate (GstMonoscope * monoscope)
225 GstCaps *othercaps, *target;
226 GstStructure *structure;
230 GstStructure *config;
231 guint size, min, max;
233 templ = gst_pad_get_pad_template_caps (monoscope->srcpad);
235 GST_DEBUG_OBJECT (monoscope, "performing negotiation");
237 /* see what the peer can do */
238 othercaps = gst_pad_peer_query_caps (monoscope->srcpad, NULL);
240 target = gst_caps_intersect (othercaps, templ);
241 gst_caps_unref (othercaps);
242 gst_caps_unref (templ);
244 if (gst_caps_is_empty (target))
247 target = gst_caps_truncate (target);
252 target = gst_caps_make_writable (target);
253 structure = gst_caps_get_structure (target, 0);
254 gst_structure_fixate_field_nearest_int (structure, "width", 320);
255 gst_structure_fixate_field_nearest_int (structure, "height", 240);
256 gst_structure_fixate_field_nearest_fraction (structure, "framerate", 25, 1);
258 gst_monoscope_src_setcaps (monoscope, target);
260 /* try to get a bufferpool now */
261 /* find a pool for the negotiated caps now */
262 query = gst_query_new_allocation (target, TRUE);
264 if (!gst_pad_peer_query (monoscope->srcpad, query)) {
267 if (gst_query_get_n_allocation_pools (query) > 0) {
268 /* we got configuration from our peer, parse them */
269 gst_query_parse_nth_allocation_pool (query, 0, &pool, &size, &min, &max);
272 size = monoscope->outsize;
277 /* we did not get a pool, make one ourselves then */
278 pool = gst_buffer_pool_new ();
281 config = gst_buffer_pool_get_config (pool);
282 gst_buffer_pool_config_set_params (config, target, size, min, max);
283 gst_buffer_pool_set_config (pool, config);
285 if (monoscope->pool) {
286 gst_buffer_pool_set_active (monoscope->pool, TRUE);
287 gst_object_unref (monoscope->pool);
289 monoscope->pool = pool;
292 gst_buffer_pool_set_active (pool, TRUE);
294 gst_caps_unref (target);
300 gst_caps_unref (target);
305 /* make sure we are negotiated */
307 ensure_negotiated (GstMonoscope * monoscope)
309 gboolean reconfigure;
311 reconfigure = gst_pad_check_reconfigure (monoscope->srcpad);
313 /* we don't know an output format yet, pick one */
314 if (reconfigure || !gst_pad_has_current_caps (monoscope->srcpad)) {
315 if (!gst_monoscope_src_negotiate (monoscope))
316 return GST_FLOW_NOT_NEGOTIATED;
322 gst_monoscope_chain (GstPad * pad, GstObject * parent, GstBuffer * inbuf)
324 GstFlowReturn flow_ret = GST_FLOW_OK;
325 GstMonoscope *monoscope;
327 monoscope = GST_MONOSCOPE (parent);
329 if (monoscope->rate == 0) {
330 gst_buffer_unref (inbuf);
331 flow_ret = GST_FLOW_NOT_NEGOTIATED;
335 /* Make sure have an output format */
336 flow_ret = ensure_negotiated (monoscope);
337 if (flow_ret != GST_FLOW_OK) {
338 gst_buffer_unref (inbuf);
342 /* don't try to combine samples from discont buffer */
343 if (GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_DISCONT)) {
344 gst_adapter_clear (monoscope->adapter);
345 monoscope->next_ts = GST_CLOCK_TIME_NONE;
348 /* Match timestamps from the incoming audio */
349 if (GST_BUFFER_TIMESTAMP (inbuf) != GST_CLOCK_TIME_NONE)
350 monoscope->next_ts = GST_BUFFER_TIMESTAMP (inbuf);
352 GST_LOG_OBJECT (monoscope,
353 "in buffer has %" G_GSIZE_FORMAT " samples, ts=%" GST_TIME_FORMAT,
354 gst_buffer_get_size (inbuf) / monoscope->bps,
355 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (inbuf)));
357 gst_adapter_push (monoscope->adapter, inbuf);
360 /* Collect samples until we have enough for an output frame */
361 while (flow_ret == GST_FLOW_OK) {
363 GstBuffer *outbuf = NULL;
364 guint32 *pixels, avail, bytesperframe;
366 avail = gst_adapter_available (monoscope->adapter);
367 GST_LOG_OBJECT (monoscope, "bytes avail now %u", avail);
369 bytesperframe = monoscope->spf * monoscope->bps;
370 if (avail < bytesperframe)
373 /* FIXME: something is wrong with QoS, we are skipping way too much
374 * stuff even with very low CPU loads */
376 if (monoscope->next_ts != -1) {
380 qostime = gst_segment_to_running_time (&monoscope->segment,
381 GST_FORMAT_TIME, monoscope->next_ts);
383 GST_OBJECT_LOCK (monoscope);
384 /* check for QoS, don't compute buffers that are known to be late */
386 GST_CLOCK_TIME_IS_VALID (monoscope->earliest_time) &&
387 qostime <= monoscope->earliest_time;
388 GST_OBJECT_UNLOCK (monoscope);
391 GST_WARNING_OBJECT (monoscope,
392 "QoS: skip ts: %" GST_TIME_FORMAT ", earliest: %" GST_TIME_FORMAT,
393 GST_TIME_ARGS (qostime), GST_TIME_ARGS (monoscope->earliest_time));
399 samples = (gint16 *) gst_adapter_map (monoscope->adapter, bytesperframe);
401 if (monoscope->spf < 512) {
402 gint16 in_data[512], i;
404 for (i = 0; i < 512; ++i) {
407 off = ((gdouble) i * (gdouble) monoscope->spf) / 512.0;
408 in_data[i] = samples[MIN ((guint) off, monoscope->spf)];
410 pixels = monoscope_update (monoscope->visstate, in_data);
412 /* not really correct, but looks much prettier */
413 pixels = monoscope_update (monoscope->visstate, samples);
416 GST_LOG_OBJECT (monoscope, "allocating output buffer");
417 flow_ret = gst_buffer_pool_acquire_buffer (monoscope->pool, &outbuf, NULL);
418 if (flow_ret != GST_FLOW_OK) {
419 gst_adapter_unmap (monoscope->adapter);
423 gst_buffer_fill (outbuf, 0, pixels, monoscope->outsize);
425 GST_BUFFER_TIMESTAMP (outbuf) = monoscope->next_ts;
426 GST_BUFFER_DURATION (outbuf) = monoscope->frame_duration;
428 flow_ret = gst_pad_push (monoscope->srcpad, outbuf);
434 if (GST_CLOCK_TIME_IS_VALID (monoscope->next_ts))
435 monoscope->next_ts += monoscope->frame_duration;
437 gst_adapter_flush (monoscope->adapter, bytesperframe);
446 gst_monoscope_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
448 GstMonoscope *monoscope;
451 monoscope = GST_MONOSCOPE (parent);
453 switch (GST_EVENT_TYPE (event)) {
454 case GST_EVENT_FLUSH_START:
455 res = gst_pad_push_event (monoscope->srcpad, event);
457 case GST_EVENT_FLUSH_STOP:
458 gst_monoscope_reset (monoscope);
459 res = gst_pad_push_event (monoscope->srcpad, event);
461 case GST_EVENT_SEGMENT:
463 /* the newsegment values are used to clip the input samples
464 * and to convert the incomming timestamps to running time so
466 gst_event_copy_segment (event, &monoscope->segment);
468 res = gst_pad_push_event (monoscope->srcpad, event);
475 gst_event_parse_caps (event, &caps);
476 gst_monoscope_sink_setcaps (monoscope, caps);
477 gst_event_unref (event);
482 res = gst_pad_push_event (monoscope->srcpad, event);
490 gst_monoscope_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
492 GstMonoscope *monoscope;
495 monoscope = GST_MONOSCOPE (parent);
497 switch (GST_EVENT_TYPE (event)) {
500 GstClockTimeDiff diff;
501 GstClockTime timestamp;
503 gst_event_parse_qos (event, NULL, &proportion, &diff, ×tamp);
505 /* save stuff for the _chain() function */
506 GST_OBJECT_LOCK (monoscope);
507 monoscope->proportion = proportion;
509 /* we're late, this is a good estimate for next displayable
510 * frame (see part-qos.txt) */
511 monoscope->earliest_time =
512 timestamp + 2 * diff + monoscope->frame_duration;
514 monoscope->earliest_time = timestamp + diff;
515 GST_OBJECT_UNLOCK (monoscope);
517 res = gst_pad_push_event (monoscope->sinkpad, event);
521 res = gst_pad_push_event (monoscope->sinkpad, event);
528 static GstStateChangeReturn
529 gst_monoscope_change_state (GstElement * element, GstStateChange transition)
531 GstMonoscope *monoscope = GST_MONOSCOPE (element);
532 GstStateChangeReturn ret;
534 switch (transition) {
535 case GST_STATE_CHANGE_NULL_TO_READY:
537 case GST_STATE_CHANGE_READY_TO_PAUSED:
538 gst_monoscope_reset (monoscope);
544 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
546 switch (transition) {
547 case GST_STATE_CHANGE_PAUSED_TO_READY:
548 if (monoscope->pool) {
549 gst_buffer_pool_set_active (monoscope->pool, FALSE);
550 gst_object_replace ((GstObject **) & monoscope->pool, NULL);
553 case GST_STATE_CHANGE_READY_TO_NULL:
563 plugin_init (GstPlugin * plugin)
565 GST_DEBUG_CATEGORY_INIT (monoscope_debug, "monoscope", 0,
566 "monoscope element");
568 return gst_element_register (plugin, "monoscope",
569 GST_RANK_NONE, GST_TYPE_MONOSCOPE);
572 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
575 "Monoscope visualization",
576 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN);