1 /* -*- c-basic-offset: 2 -*-
3 * Copyright (C) 1999-2001 Erik Walthinsen <omega@cse.ogi.edu>
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-speed
24 * Plays an audio stream at a different speed (by resampling the audio).
26 * Do not use this element. Either use the 'pitch' element, or do a seek with
27 * a non-1.0 rate parameter, this will have the same effect as using the speed
28 * element (but relies on the decoder/demuxer to handle this correctly, also
29 * requires a fairly up-to-date gst-plugins-base, as of February 2007).
32 * <title>Example launch line</title>
34 * gst-launch filesrc location=test.ogg ! decodebin ! audioconvert ! speed speed=1.5 ! audioconvert ! audioresample ! autoaudiosink
35 * ]| Plays an .ogg file at 1.5x speed.
38 * Last reviewed on 2007-02-26 (0.10.4.1)
48 #include <gst/audio/audio.h>
52 GST_DEBUG_CATEGORY_STATIC (speed_debug);
53 #define GST_CAT_DEFAULT speed_debug
61 /* assumption here: sizeof (gfloat) = 4 */
62 #define GST_SPEED_AUDIO_CAPS \
63 "audio/x-raw-float, " \
64 "rate = (int) [ 1, MAX ], " \
65 "channels = (int) [ 1, MAX ], " \
66 "endianness = (int) BYTE_ORDER, " \
67 "width = (int) 32; " \
70 "rate = (int) [ 1, MAX ], " \
71 "channels = (int) [ 1, MAX ], " \
72 "endianness = (int) BYTE_ORDER, " \
73 "width = (int) 16, " \
74 "depth = (int) 16, " \
75 "signed = (boolean) true"
77 static GstStaticPadTemplate gst_speed_sink_template =
78 GST_STATIC_PAD_TEMPLATE ("sink",
81 GST_STATIC_CAPS (GST_SPEED_AUDIO_CAPS)
84 static GstStaticPadTemplate gst_speed_src_template =
85 GST_STATIC_PAD_TEMPLATE ("src",
88 GST_STATIC_CAPS (GST_SPEED_AUDIO_CAPS)
91 static void speed_base_init (gpointer g_class);
92 static void speed_class_init (GstSpeedClass * klass);
93 static void speed_init (GstSpeed * filter);
95 static void speed_set_property (GObject * object, guint prop_id,
96 const GValue * value, GParamSpec * pspec);
97 static void speed_get_property (GObject * object, guint prop_id, GValue * value,
100 static gboolean speed_parse_caps (GstSpeed * filter, const GstCaps * caps);
102 static GstFlowReturn speed_chain (GstPad * pad, GstBuffer * buf);
104 static GstStateChangeReturn speed_change_state (GstElement * element,
105 GstStateChange transition);
106 static gboolean speed_sink_event (GstPad * pad, GstEvent * event);
107 static gboolean speed_src_event (GstPad * pad, GstEvent * event);
109 static GstElementClass *parent_class; /* NULL */
112 speed_setcaps (GstPad * pad, GstCaps * caps)
118 filter = GST_SPEED (gst_pad_get_parent (pad));
120 otherpad = (pad == filter->srcpad) ? filter->sinkpad : filter->srcpad;
122 if ((ret = speed_parse_caps (filter, caps)))
123 ret = gst_pad_set_caps (otherpad, caps);
125 gst_object_unref (filter);
132 speed_parse_caps (GstSpeed * filter, const GstCaps * caps)
135 GstStructure *structure;
136 gint rate, chans, width;
138 g_return_val_if_fail (filter != NULL, FALSE);
139 g_return_val_if_fail (caps != NULL, FALSE);
141 structure = gst_caps_get_structure (caps, 0);
144 if (gst_structure_has_name (structure, "audio/x-raw-float"))
145 filter->format = GST_SPEED_FORMAT_FLOAT;
146 else if (gst_structure_has_name (structure, "audio/x-raw-int"))
147 filter->format = GST_SPEED_FORMAT_INT;
151 if (!gst_structure_get_int (structure, "rate", &rate)
152 || !gst_structure_get_int (structure, "width", &width)
153 || !gst_structure_get_int (structure, "channels", &chans)) {
158 filter->width = width;
159 filter->channels = chans;
161 if (filter->format == GST_SPEED_FORMAT_FLOAT) {
162 filter->sample_size = filter->channels * filter->width / 8;
164 /* our caps only allow width == depth for now */
165 filter->sample_size = filter->channels * filter->width / 8;
172 gst_speed_get_type (void)
174 static GType speed_type = 0;
177 static const GTypeInfo speed_info = {
178 sizeof (GstSpeedClass),
181 (GClassInitFunc) speed_class_init,
186 (GInstanceInitFunc) speed_init,
190 g_type_register_static (GST_TYPE_ELEMENT, "GstSpeed", &speed_info, 0);
195 static const GstQueryType *
196 speed_get_query_types (GstPad * pad)
198 static const GstQueryType src_query_types[] = {
204 return src_query_types;
208 speed_src_event (GstPad * pad, GstEvent * event)
211 gboolean ret = FALSE;
213 filter = GST_SPEED (gst_pad_get_parent (pad));
215 switch (GST_EVENT_TYPE (event)) {
216 case GST_EVENT_SEEK:{
220 GstSeekType start_type, stop_type;
223 gst_event_parse_seek (event, &rate, &format, &flags, &start_type, &start,
225 gst_event_unref (event);
227 if (format != GST_FORMAT_TIME) {
228 GST_DEBUG_OBJECT (filter, "only support seeks in TIME format");
232 if (start_type != GST_SEEK_TYPE_NONE && start != -1) {
233 start *= filter->speed;
236 if (stop_type != GST_SEEK_TYPE_NONE && stop != -1) {
237 stop *= filter->speed;
240 event = gst_event_new_seek (rate, format, flags, start_type, start,
243 GST_LOG ("sending seek event: %" GST_PTR_FORMAT, event->structure);
245 ret = gst_pad_send_event (GST_PAD_PEER (filter->sinkpad), event);
249 ret = gst_pad_event_default (pad, event);
253 gst_object_unref (filter);
259 gst_speed_convert (GstPad * pad, GstFormat src_format, gint64 src_value,
260 GstFormat * dest_format, gint64 * dest_value)
266 if (src_format == *dest_format) {
267 *dest_value = src_value;
271 filter = GST_SPEED (GST_PAD_PARENT (pad));
273 switch (src_format) {
274 case GST_FORMAT_BYTES:
275 switch (*dest_format) {
276 case GST_FORMAT_DEFAULT:
277 if (filter->sample_size == 0) {
281 *dest_value = src_value / filter->sample_size;
283 case GST_FORMAT_TIME:
285 gint byterate = filter->sample_size * filter->rate;
291 *dest_value = src_value * GST_SECOND / byterate;
298 case GST_FORMAT_DEFAULT:
299 switch (*dest_format) {
300 case GST_FORMAT_BYTES:
301 *dest_value = src_value * filter->sample_size;
303 case GST_FORMAT_TIME:
304 if (filter->rate == 0) {
308 *dest_value = src_value * GST_SECOND / filter->rate;
314 case GST_FORMAT_TIME:
315 switch (*dest_format) {
316 case GST_FORMAT_BYTES:
317 scale = filter->sample_size;
319 case GST_FORMAT_DEFAULT:
320 *dest_value = src_value * scale * filter->rate / GST_SECOND;
335 speed_src_query (GstPad * pad, GstQuery * query)
340 filter = GST_SPEED (gst_pad_get_parent (pad));
342 switch (GST_QUERY_TYPE (query)) {
343 case GST_QUERY_POSITION:
346 GstFormat rformat = GST_FORMAT_TIME;
348 GstFormat conv_format = GST_FORMAT_TIME;
350 /* save requested format */
351 gst_query_parse_position (query, &format, NULL);
353 /* query peer for current position in time */
354 gst_query_set_position (query, GST_FORMAT_TIME, -1);
356 if (!gst_pad_query_peer_position (filter->sinkpad, &rformat, &cur)) {
357 GST_LOG_OBJECT (filter, "query on peer pad failed");
361 if (rformat == GST_FORMAT_BYTES)
362 GST_LOG_OBJECT (filter,
363 "peer pad returned current=%" G_GINT64_FORMAT " bytes", cur);
364 else if (rformat == GST_FORMAT_TIME)
365 GST_LOG_OBJECT (filter, "peer pad returned time=%" G_GINT64_FORMAT,
368 /* convert to time format */
369 if (!gst_speed_convert (pad, rformat, cur, &conv_format, &cur)) {
374 /* adjust for speed factor */
375 cur /= filter->speed;
377 /* convert to time format */
378 if (!gst_speed_convert (pad, conv_format, cur, &format, &cur)) {
382 gst_query_set_position (query, format, cur);
384 GST_LOG_OBJECT (filter,
385 "position query: we return %" G_GUINT64_FORMAT " (format %u)", cur,
390 case GST_QUERY_DURATION:
393 GstFormat rformat = GST_FORMAT_TIME;
395 GstFormat conv_format = GST_FORMAT_TIME;
397 /* save requested format */
398 gst_query_parse_duration (query, &format, NULL);
400 /* query peer for total length in time */
401 gst_query_set_duration (query, GST_FORMAT_TIME, -1);
403 if (!gst_pad_query_peer_duration (filter->sinkpad, &rformat, &end)) {
404 GST_LOG_OBJECT (filter, "query on peer pad failed");
408 if (rformat == GST_FORMAT_BYTES)
409 GST_LOG_OBJECT (filter,
410 "peer pad returned total=%" G_GINT64_FORMAT " bytes", end);
411 else if (rformat == GST_FORMAT_TIME)
412 GST_LOG_OBJECT (filter, "peer pad returned time=%" G_GINT64_FORMAT,
415 /* convert to time format */
416 if (!gst_speed_convert (pad, rformat, end, &conv_format, &end)) {
421 /* adjust for speed factor */
422 end /= filter->speed;
424 /* convert to time format */
425 if (!gst_speed_convert (pad, conv_format, end, &format, &end)) {
430 gst_query_set_duration (query, format, end);
432 GST_LOG_OBJECT (filter,
433 "duration query: we return %" G_GUINT64_FORMAT " (format %u)", end,
443 gst_object_unref (filter);
448 gst_object_unref (filter);
449 GST_DEBUG ("error handling query");
454 speed_base_init (gpointer g_class)
456 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
458 gst_element_class_set_details_simple (element_class, "Speed",
459 "Filter/Effect/Audio",
460 "Set speed/pitch on audio/raw streams (resampler)",
461 "Andy Wingo <apwingo@eos.ncsu.edu>, "
462 "Tim-Philipp Müller <tim@centricular.net>");
464 gst_element_class_add_static_pad_template (element_class,
465 &gst_speed_src_template);
466 gst_element_class_add_static_pad_template (element_class,
467 &gst_speed_sink_template);
471 speed_class_init (GstSpeedClass * klass)
473 GObjectClass *gobject_class = (GObjectClass *) klass;
474 GstElementClass *gstelement_class = (GstElementClass *) klass;
476 gobject_class->set_property = speed_set_property;
477 gobject_class->get_property = speed_get_property;
478 gstelement_class->change_state = speed_change_state;
480 parent_class = g_type_class_peek_parent (klass);
482 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SPEED,
483 g_param_spec_float ("speed", "speed", "speed",
485 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
489 speed_init (GstSpeed * filter)
492 gst_pad_new_from_static_template (&gst_speed_sink_template, "sink");
493 gst_pad_set_setcaps_function (filter->sinkpad, speed_setcaps);
494 gst_pad_set_chain_function (filter->sinkpad, speed_chain);
495 gst_element_add_pad (GST_ELEMENT (filter), filter->sinkpad);
496 gst_pad_set_event_function (filter->sinkpad, speed_sink_event);
499 gst_pad_new_from_static_template (&gst_speed_src_template, "src");
500 gst_pad_set_setcaps_function (filter->srcpad, speed_setcaps);
501 gst_pad_set_query_type_function (filter->srcpad, speed_get_query_types);
502 gst_pad_set_query_function (filter->srcpad, speed_src_query);
503 gst_element_add_pad (GST_ELEMENT (filter), filter->srcpad);
505 gst_pad_set_event_function (filter->srcpad, speed_src_event);
508 filter->timestamp = 0;
509 filter->sample_size = 0;
514 speed_chain_int16 (GstSpeed * filter, GstBuffer * in_buf, GstBuffer * out_buf,
515 guint c, guint in_samples)
517 gint16 *in_data, *out_data;
518 gfloat interp, lower, i_float;
521 in_data = ((gint16 *) GST_BUFFER_DATA (in_buf)) + c;
522 out_data = ((gint16 *) GST_BUFFER_DATA (out_buf)) + c;
525 i_float = 0.5 * (filter->speed - 1.0);
526 i = (guint) ceil (i_float);
529 while (i < in_samples) {
530 interp = i_float - floor (i_float);
532 out_data[j * filter->channels] =
533 lower * (1 - interp) + in_data[i * filter->channels] * interp;
535 lower = in_data[i * filter->channels];
537 i_float += filter->speed;
538 i = (guint) ceil (i_float);
547 speed_chain_float32 (GstSpeed * filter, GstBuffer * in_buf, GstBuffer * out_buf,
548 guint c, guint in_samples)
550 gfloat *in_data, *out_data;
551 gfloat interp, lower, i_float;
554 in_data = ((gfloat *) GST_BUFFER_DATA (in_buf)) + c;
555 out_data = ((gfloat *) GST_BUFFER_DATA (out_buf)) + c;
558 i_float = 0.5 * (filter->speed - 1.0);
559 i = (guint) ceil (i_float);
562 while (i < in_samples) {
563 interp = i_float - floor (i_float);
565 out_data[j * filter->channels] =
566 lower * (1 - interp) + in_data[i * filter->channels] * interp;
568 lower = in_data[i * filter->channels];
570 i_float += filter->speed;
571 i = (guint) ceil (i_float);
581 speed_sink_event (GstPad * pad, GstEvent * event)
584 gboolean ret = FALSE;
586 filter = GST_SPEED (gst_pad_get_parent (pad));
588 switch (GST_EVENT_TYPE (event)) {
589 case GST_EVENT_NEWSEGMENT:{
591 gboolean update = FALSE;
593 gint64 start_value, stop_value, base;
595 gst_event_parse_new_segment (event, &update, &rate, &format, &start_value,
597 gst_event_unref (event);
599 if (format != GST_FORMAT_TIME) {
600 GST_WARNING_OBJECT (filter, "newsegment event not in TIME format!");
604 g_assert (filter->speed > 0);
606 if (start_value >= 0)
607 start_value /= filter->speed;
609 stop_value /= filter->speed;
610 base /= filter->speed;
612 /* this would only really be correct if we clipped incoming data */
613 filter->timestamp = start_value;
615 /* set to NONE so it gets reset later based on the timestamp when we have
617 filter->offset = GST_BUFFER_OFFSET_NONE;
620 gst_pad_event_default (pad, gst_event_new_new_segment (update, rate,
621 format, start_value, stop_value, base));
625 ret = gst_pad_event_default (pad, event);
630 gst_object_unref (filter);
638 speed_chain (GstPad * pad, GstBuffer * in_buf)
642 guint c, in_samples, out_samples, out_size;
645 filter = GST_SPEED (GST_PAD_PARENT (pad));
647 if (G_UNLIKELY (filter->sample_size == 0 || filter->rate == 0)) {
648 flow = GST_FLOW_NOT_NEGOTIATED;
652 if (G_UNLIKELY (filter->offset == GST_BUFFER_OFFSET_NONE)) {
654 gst_util_uint64_scale_int (filter->timestamp, filter->rate, GST_SECOND);
657 /* buffersize has to be aligned by samplesize */
658 out_size = ceil ((gfloat) GST_BUFFER_SIZE (in_buf) / filter->speed);
659 out_size = ((out_size + filter->sample_size - 1) / filter->sample_size) *
663 gst_pad_alloc_buffer_and_set_caps (filter->srcpad, -1, out_size,
664 GST_PAD_CAPS (filter->srcpad), &out_buf);
666 if (flow != GST_FLOW_OK)
669 in_samples = GST_BUFFER_SIZE (in_buf) / filter->sample_size;
673 for (c = 0; c < filter->channels; ++c) {
674 if (filter->format == GST_SPEED_FORMAT_INT) {
675 out_samples = speed_chain_int16 (filter, in_buf, out_buf, c, in_samples);
678 speed_chain_float32 (filter, in_buf, out_buf, c, in_samples);
682 GST_BUFFER_SIZE (out_buf) = out_samples * filter->sample_size;
684 GST_BUFFER_OFFSET (out_buf) = filter->offset;
685 GST_BUFFER_TIMESTAMP (out_buf) = filter->timestamp;
687 filter->offset += GST_BUFFER_SIZE (out_buf) / filter->sample_size;
689 gst_util_uint64_scale_int (filter->offset, GST_SECOND, filter->rate);
691 /* make sure it's at least nominally a perfect stream */
692 GST_BUFFER_DURATION (out_buf) =
693 filter->timestamp - GST_BUFFER_TIMESTAMP (out_buf);
695 flow = gst_pad_push (filter->srcpad, out_buf);
699 if (G_UNLIKELY (flow != GST_FLOW_OK))
700 GST_DEBUG_OBJECT (filter, "flow: %s", gst_flow_get_name (flow));
702 gst_buffer_unref (in_buf);
707 speed_set_property (GObject * object, guint prop_id, const GValue * value,
710 GstSpeed *filter = GST_SPEED (object);
714 filter->speed = g_value_get_float (value);
717 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
724 speed_get_property (GObject * object, guint prop_id, GValue * value,
727 GstSpeed *filter = GST_SPEED (object);
731 g_value_set_float (value, filter->speed);
734 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
740 static GstStateChangeReturn
741 speed_change_state (GstElement * element, GstStateChange transition)
743 GstSpeed *speed = GST_SPEED (element);
745 switch (transition) {
746 case GST_STATE_CHANGE_READY_TO_PAUSED:
747 speed->offset = GST_BUFFER_OFFSET_NONE;
748 speed->timestamp = 0;
754 if (GST_ELEMENT_CLASS (parent_class)->change_state)
755 return GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
757 return GST_STATE_CHANGE_SUCCESS;
761 plugin_init (GstPlugin * plugin)
763 GST_DEBUG_CATEGORY_INIT (speed_debug, "speed", 0, "speed element");
765 return gst_element_register (plugin, "speed", GST_RANK_NONE, GST_TYPE_SPEED);
768 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
771 "Set speed/pitch on audio/raw streams (resampler)",
772 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)