1 /* gstgoom.c: implementation of goom drawing element
2 * Copyright (C) <2001> Richard Boulton <richard@tartarus.org>
3 * (C) <2006> Wim Taymans <wim at fluendo dot com>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * SECTION:element-goom2k1
23 * @see_also: goom, synaesthesia
25 * Goom2k1 is an audio visualisation element. It creates warping structures
26 * based on the incomming audio signal. Goom2k1 is the older version of the
27 * visualisation. Also available is goom2k4, with a different look.
30 * <title>Example launch line</title>
32 * gst-launch -v audiotestsrc ! goom2k1 ! ffmpegcolorspace ! xvimagesink
44 #include <gst/video/video.h>
45 #include "goom_core.h"
47 GST_DEBUG_CATEGORY_STATIC (goom_debug);
48 #define GST_CAT_DEFAULT goom_debug
50 #define DEFAULT_WIDTH 320
51 #define DEFAULT_HEIGHT 240
52 #define DEFAULT_FPS_N 25
53 #define DEFAULT_FPS_D 1
55 /* signals and args */
68 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
71 GST_STATIC_CAPS (GST_VIDEO_CAPS_xRGB_HOST_ENDIAN)
74 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink", /* the name of the pads */
75 GST_PAD_SINK, /* type of the pad */
76 GST_PAD_ALWAYS, /* ALWAYS/SOMETIMES */
77 GST_STATIC_CAPS ("audio/x-raw-int, "
78 "endianness = (int) BYTE_ORDER, "
79 "signed = (boolean) TRUE, "
82 "rate = (int) [ 8000, 96000 ], " "channels = (int) { 1, 2 }")
86 static void gst_goom_class_init (GstGoomClass * klass);
87 static void gst_goom_base_init (GstGoomClass * klass);
88 static void gst_goom_init (GstGoom * goom);
89 static void gst_goom_finalize (GObject * object);
91 static GstStateChangeReturn gst_goom_change_state (GstElement * element,
92 GstStateChange transition);
94 static GstFlowReturn gst_goom_chain (GstPad * pad, GstBuffer * buffer);
95 static gboolean gst_goom_src_event (GstPad * pad, GstEvent * event);
96 static gboolean gst_goom_sink_event (GstPad * pad, GstEvent * event);
98 static gboolean gst_goom_src_query (GstPad * pad, GstQuery * query);
100 static gboolean gst_goom_sink_setcaps (GstPad * pad, GstCaps * caps);
101 static gboolean gst_goom_src_setcaps (GstPad * pad, GstCaps * caps);
103 static GstElementClass *parent_class = NULL;
106 gst_goom_get_type (void)
108 static GType type = 0;
111 static const GTypeInfo info = {
112 sizeof (GstGoomClass),
113 (GBaseInitFunc) gst_goom_base_init,
115 (GClassInitFunc) gst_goom_class_init,
120 (GInstanceInitFunc) gst_goom_init,
123 type = g_type_register_static (GST_TYPE_ELEMENT, "GstGoom2k1", &info, 0);
129 gst_goom_base_init (GstGoomClass * klass)
131 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
133 gst_element_class_set_details_simple (element_class,
134 "GOOM: what a GOOM! 2k1 edition", "Visualization",
135 "Takes frames of data and outputs video frames using the GOOM 2k1 filter",
136 "Wim Taymans <wim@fluendo.com>");
137 gst_element_class_add_static_pad_template (element_class,
139 gst_element_class_add_static_pad_template (element_class, &src_template);
143 gst_goom_class_init (GstGoomClass * klass)
145 GObjectClass *gobject_class;
146 GstElementClass *gstelement_class;
148 gobject_class = (GObjectClass *) klass;
149 gstelement_class = (GstElementClass *) klass;
151 parent_class = g_type_class_peek_parent (klass);
153 gobject_class->finalize = gst_goom_finalize;
155 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_goom_change_state);
157 GST_DEBUG_CATEGORY_INIT (goom_debug, "goom", 0, "goom visualisation element");
161 gst_goom_init (GstGoom * goom)
163 /* create the sink and src pads */
164 goom->sinkpad = gst_pad_new_from_static_template (&sink_template, "sink");
165 gst_pad_set_chain_function (goom->sinkpad,
166 GST_DEBUG_FUNCPTR (gst_goom_chain));
167 gst_pad_set_event_function (goom->sinkpad,
168 GST_DEBUG_FUNCPTR (gst_goom_sink_event));
169 gst_pad_set_setcaps_function (goom->sinkpad,
170 GST_DEBUG_FUNCPTR (gst_goom_sink_setcaps));
171 gst_element_add_pad (GST_ELEMENT (goom), goom->sinkpad);
173 goom->srcpad = gst_pad_new_from_static_template (&src_template, "src");
174 gst_pad_set_setcaps_function (goom->srcpad,
175 GST_DEBUG_FUNCPTR (gst_goom_src_setcaps));
176 gst_pad_set_event_function (goom->srcpad,
177 GST_DEBUG_FUNCPTR (gst_goom_src_event));
178 gst_pad_set_query_function (goom->srcpad,
179 GST_DEBUG_FUNCPTR (gst_goom_src_query));
180 gst_element_add_pad (GST_ELEMENT (goom), goom->srcpad);
182 goom->adapter = gst_adapter_new ();
184 goom->width = DEFAULT_WIDTH;
185 goom->height = DEFAULT_HEIGHT;
186 goom->fps_n = DEFAULT_FPS_N; /* desired frame rate */
187 goom->fps_d = DEFAULT_FPS_D; /* desired frame rate */
192 goom_init (&(goom->goomdata), goom->width, goom->height);
196 gst_goom_finalize (GObject * object)
198 GstGoom *goom = GST_GOOM (object);
200 goom_close (&(goom->goomdata));
202 g_object_unref (goom->adapter);
204 G_OBJECT_CLASS (parent_class)->finalize (object);
208 gst_goom_reset (GstGoom * goom)
210 gst_adapter_clear (goom->adapter);
211 gst_segment_init (&goom->segment, GST_FORMAT_UNDEFINED);
213 GST_OBJECT_LOCK (goom);
214 goom->proportion = 1.0;
215 goom->earliest_time = -1;
216 GST_OBJECT_UNLOCK (goom);
220 gst_goom_sink_setcaps (GstPad * pad, GstCaps * caps)
223 GstStructure *structure;
226 goom = GST_GOOM (GST_PAD_PARENT (pad));
228 structure = gst_caps_get_structure (caps, 0);
230 res = gst_structure_get_int (structure, "channels", &goom->channels);
231 res &= gst_structure_get_int (structure, "rate", &goom->rate);
233 goom->bps = goom->channels * sizeof (gint16);
239 gst_goom_src_setcaps (GstPad * pad, GstCaps * caps)
242 GstStructure *structure;
244 goom = GST_GOOM (GST_PAD_PARENT (pad));
246 structure = gst_caps_get_structure (caps, 0);
248 if (!gst_structure_get_int (structure, "width", &goom->width) ||
249 !gst_structure_get_int (structure, "height", &goom->height) ||
250 !gst_structure_get_fraction (structure, "framerate", &goom->fps_n,
254 goom_set_resolution (&(goom->goomdata), goom->width, goom->height);
256 /* size of the output buffer in bytes, depth is always 4 bytes */
257 goom->outsize = goom->width * goom->height * 4;
259 gst_util_uint64_scale_int (GST_SECOND, goom->fps_d, goom->fps_n);
260 goom->spf = gst_util_uint64_scale_int (goom->rate, goom->fps_d, goom->fps_n);
261 goom->bpf = goom->spf * goom->bps;
263 GST_DEBUG_OBJECT (goom, "dimension %dx%d, framerate %d/%d, spf %d",
264 goom->width, goom->height, goom->fps_n, goom->fps_d, goom->spf);
270 gst_goom_src_negotiate (GstGoom * goom)
272 GstCaps *othercaps, *target;
273 GstStructure *structure;
274 const GstCaps *templ;
276 templ = gst_pad_get_pad_template_caps (goom->srcpad);
278 GST_DEBUG_OBJECT (goom, "performing negotiation");
280 /* see what the peer can do */
281 othercaps = gst_pad_peer_get_caps (goom->srcpad);
283 target = gst_caps_intersect (othercaps, templ);
284 gst_caps_unref (othercaps);
286 if (gst_caps_is_empty (target))
289 gst_caps_truncate (target);
291 target = gst_caps_ref ((GstCaps *) templ);
294 structure = gst_caps_get_structure (target, 0);
295 gst_structure_fixate_field_nearest_int (structure, "width", DEFAULT_WIDTH);
296 gst_structure_fixate_field_nearest_int (structure, "height", DEFAULT_HEIGHT);
297 gst_structure_fixate_field_nearest_fraction (structure, "framerate",
298 DEFAULT_FPS_N, DEFAULT_FPS_D);
300 gst_pad_set_caps (goom->srcpad, target);
301 gst_caps_unref (target);
307 gst_caps_unref (target);
313 gst_goom_src_event (GstPad * pad, GstEvent * event)
318 goom = GST_GOOM (gst_pad_get_parent (pad));
320 switch (GST_EVENT_TYPE (event)) {
324 GstClockTimeDiff diff;
325 GstClockTime timestamp;
327 gst_event_parse_qos (event, &proportion, &diff, ×tamp);
329 /* save stuff for the _chain() function */
330 GST_OBJECT_LOCK (goom);
331 goom->proportion = proportion;
333 /* we're late, this is a good estimate for next displayable
334 * frame (see part-qos.txt) */
335 goom->earliest_time = timestamp + 2 * diff + goom->duration;
337 goom->earliest_time = timestamp + diff;
338 GST_OBJECT_UNLOCK (goom);
340 res = gst_pad_push_event (goom->sinkpad, event);
344 res = gst_pad_push_event (goom->sinkpad, event);
347 gst_object_unref (goom);
353 gst_goom_sink_event (GstPad * pad, GstEvent * event)
358 goom = GST_GOOM (gst_pad_get_parent (pad));
360 switch (GST_EVENT_TYPE (event)) {
361 case GST_EVENT_FLUSH_START:
362 res = gst_pad_push_event (goom->srcpad, event);
364 case GST_EVENT_FLUSH_STOP:
365 gst_goom_reset (goom);
366 res = gst_pad_push_event (goom->srcpad, event);
368 case GST_EVENT_NEWSEGMENT:
372 gint64 start, stop, time;
375 /* the newsegment values are used to clip the input samples
376 * and to convert the incomming timestamps to running time so
378 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
379 &start, &stop, &time);
381 /* now configure the values */
382 gst_segment_set_newsegment_full (&goom->segment, update,
383 rate, arate, format, start, stop, time);
385 res = gst_pad_push_event (goom->srcpad, event);
389 res = gst_pad_push_event (goom->srcpad, event);
392 gst_object_unref (goom);
398 gst_goom_src_query (GstPad * pad, GstQuery * query)
403 goom = GST_GOOM (gst_pad_get_parent (pad));
405 switch (GST_QUERY_TYPE (query)) {
406 case GST_QUERY_LATENCY:
408 /* We need to send the query upstream and add the returned latency to our
410 GstClockTime min_latency, max_latency;
412 GstClockTime our_latency;
415 if ((res = gst_pad_peer_query (goom->sinkpad, query))) {
416 gst_query_parse_latency (query, &us_live, &min_latency, &max_latency);
418 GST_DEBUG_OBJECT (goom, "Peer latency: min %"
419 GST_TIME_FORMAT " max %" GST_TIME_FORMAT,
420 GST_TIME_ARGS (min_latency), GST_TIME_ARGS (max_latency));
422 /* the max samples we must buffer buffer */
423 max_samples = MAX (GOOM_SAMPLES, goom->spf);
425 gst_util_uint64_scale_int (max_samples, GST_SECOND, goom->rate);
427 GST_DEBUG_OBJECT (goom, "Our latency: %" GST_TIME_FORMAT,
428 GST_TIME_ARGS (our_latency));
430 /* we add some latency but only if we need to buffer more than what
431 * upstream gives us */
432 min_latency += our_latency;
433 if (max_latency != -1)
434 max_latency += our_latency;
436 GST_DEBUG_OBJECT (goom, "Calculated total latency : min %"
437 GST_TIME_FORMAT " max %" GST_TIME_FORMAT,
438 GST_TIME_ARGS (min_latency), GST_TIME_ARGS (max_latency));
440 gst_query_set_latency (query, TRUE, min_latency, max_latency);
445 res = gst_pad_peer_query (goom->sinkpad, query);
449 gst_object_unref (goom);
455 get_buffer (GstGoom * goom, GstBuffer ** outbuf)
459 if (GST_PAD_CAPS (goom->srcpad) == NULL) {
460 if (!gst_goom_src_negotiate (goom))
461 return GST_FLOW_NOT_NEGOTIATED;
464 GST_DEBUG_OBJECT (goom, "allocating output buffer with caps %"
465 GST_PTR_FORMAT, GST_PAD_CAPS (goom->srcpad));
468 gst_pad_alloc_buffer_and_set_caps (goom->srcpad,
469 GST_BUFFER_OFFSET_NONE, goom->outsize,
470 GST_PAD_CAPS (goom->srcpad), outbuf);
471 if (ret != GST_FLOW_OK)
478 gst_goom_chain (GstPad * pad, GstBuffer * buffer)
482 GstBuffer *outbuf = NULL;
484 goom = GST_GOOM (gst_pad_get_parent (pad));
486 /* If we don't have an output format yet, preallocate a buffer to try and
488 if (GST_PAD_CAPS (goom->srcpad) == NULL) {
489 ret = get_buffer (goom, &outbuf);
490 if (ret != GST_FLOW_OK) {
491 gst_buffer_unref (buffer);
496 /* don't try to combine samples from discont buffer */
497 if (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT)) {
498 gst_adapter_clear (goom->adapter);
501 GST_DEBUG_OBJECT (goom,
502 "Input buffer has %d samples, time=%" G_GUINT64_FORMAT,
503 GST_BUFFER_SIZE (buffer) / goom->bps, GST_BUFFER_TIMESTAMP (buffer));
505 /* Collect samples until we have enough for an output frame */
506 gst_adapter_push (goom->adapter, buffer);
515 guint avail, to_flush;
516 guint64 dist, timestamp;
518 avail = gst_adapter_available (goom->adapter);
519 GST_DEBUG_OBJECT (goom, "avail now %u", avail);
521 /* we need GOOM_SAMPLES to get a meaningful result from goom. */
522 if (avail < (GOOM_SAMPLES * goom->bps))
525 /* we also need enough samples to produce one frame at least */
526 if (avail < goom->bpf)
529 GST_DEBUG_OBJECT (goom, "processing buffer");
531 /* get timestamp of the current adapter byte */
532 timestamp = gst_adapter_prev_timestamp (goom->adapter, &dist);
533 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
534 /* convert bytes to time */
536 timestamp += gst_util_uint64_scale_int (dist, GST_SECOND, goom->rate);
539 if (timestamp != -1) {
542 qostime = gst_segment_to_running_time (&goom->segment, GST_FORMAT_TIME,
544 qostime += goom->duration;
546 GST_OBJECT_LOCK (goom);
547 /* check for QoS, don't compute buffers that are known to be late */
548 need_skip = goom->earliest_time != -1 && qostime <= goom->earliest_time;
549 GST_OBJECT_UNLOCK (goom);
552 GST_WARNING_OBJECT (goom,
553 "QoS: skip ts: %" GST_TIME_FORMAT ", earliest: %" GST_TIME_FORMAT,
554 GST_TIME_ARGS (qostime), GST_TIME_ARGS (goom->earliest_time));
559 /* get next GOOM_SAMPLES, we have at least this amount of samples */
561 (const guint16 *) gst_adapter_peek (goom->adapter,
562 GOOM_SAMPLES * goom->bps);
564 if (goom->channels == 2) {
565 for (i = 0; i < GOOM_SAMPLES; i++) {
566 goom->datain[0][i] = *data++;
567 goom->datain[1][i] = *data++;
570 for (i = 0; i < GOOM_SAMPLES; i++) {
571 goom->datain[0][i] = *data;
572 goom->datain[1][i] = *data++;
576 /* alloc a buffer if we don't have one yet, this happens
577 * when we pushed a buffer in this while loop before */
578 if (outbuf == NULL) {
579 ret = get_buffer (goom, &outbuf);
580 if (ret != GST_FLOW_OK) {
585 GST_BUFFER_TIMESTAMP (outbuf) = timestamp;
586 GST_BUFFER_DURATION (outbuf) = goom->duration;
587 GST_BUFFER_SIZE (outbuf) = goom->outsize;
589 out_frame = (guchar *) goom_update (&(goom->goomdata), goom->datain);
590 memcpy (GST_BUFFER_DATA (outbuf), out_frame, goom->outsize);
592 GST_DEBUG ("Pushing frame with time=%" GST_TIME_FORMAT ", duration=%"
593 GST_TIME_FORMAT, GST_TIME_ARGS (timestamp),
594 GST_TIME_ARGS (goom->duration));
596 ret = gst_pad_push (goom->srcpad, outbuf);
600 /* Now flush the samples we needed for this frame, which might be more than
601 * the samples we used (GOOM_SAMPLES). */
602 to_flush = goom->bpf;
604 GST_DEBUG_OBJECT (goom, "finished frame, flushing %u bytes from input",
606 gst_adapter_flush (goom->adapter, to_flush);
608 if (ret != GST_FLOW_OK)
613 gst_buffer_unref (outbuf);
616 gst_object_unref (goom);
621 static GstStateChangeReturn
622 gst_goom_change_state (GstElement * element, GstStateChange transition)
624 GstGoom *goom = GST_GOOM (element);
625 GstStateChangeReturn ret;
627 switch (transition) {
628 case GST_STATE_CHANGE_NULL_TO_READY:
630 case GST_STATE_CHANGE_READY_TO_PAUSED:
631 gst_goom_reset (goom);
637 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
639 switch (transition) {
640 case GST_STATE_CHANGE_PAUSED_TO_READY:
642 case GST_STATE_CHANGE_READY_TO_NULL:
652 plugin_init (GstPlugin * plugin)
654 return gst_element_register (plugin, "goom2k1", GST_RANK_NONE, GST_TYPE_GOOM);
657 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
660 "GOOM 2k1 visualization filter",
661 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)