1 /* GStreamer output selector
2 * Copyright (C) 2008 Nokia Corporation. (contact <stefan.kost@nokia.com>)
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * SECTION:element-output-selector
22 * @see_also: #GstOutputSelector, #GstInputSelector
24 * Direct input stream to one out of N output pads.
35 #include "gstoutputselector.h"
37 GST_DEBUG_CATEGORY_STATIC (output_selector_debug);
38 #define GST_CAT_DEFAULT output_selector_debug
40 static GstStaticPadTemplate gst_output_selector_sink_factory =
41 GST_STATIC_PAD_TEMPLATE ("sink",
46 static GstStaticPadTemplate gst_output_selector_src_factory =
47 GST_STATIC_PAD_TEMPLATE ("src_%u",
52 enum GstOutputSelectorPadNegotiationMode
54 GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_NONE,
55 GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ALL,
56 GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ACTIVE
58 #define GST_TYPE_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE (gst_output_selector_pad_negotiation_mode_get_type())
60 gst_output_selector_pad_negotiation_mode_get_type (void)
62 static GType pad_negotiation_mode_type = 0;
63 static GEnumValue pad_negotiation_modes[] = {
64 {GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_NONE, "None", "none"},
65 {GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ALL, "All", "all"},
66 {GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ACTIVE, "Active", "active"},
70 if (!pad_negotiation_mode_type) {
71 pad_negotiation_mode_type =
72 g_enum_register_static ("GstOutputSelectorPadNegotiationMode",
73 pad_negotiation_modes);
75 return pad_negotiation_mode_type;
84 PROP_PAD_NEGOTIATION_MODE
87 #define DEFAULT_PAD_NEGOTIATION_MODE GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ALL
90 GST_DEBUG_CATEGORY_INIT (output_selector_debug, \
91 "output-selector", 0, "Output stream selector");
92 #define gst_output_selector_parent_class parent_class
93 G_DEFINE_TYPE_WITH_CODE (GstOutputSelector, gst_output_selector,
94 GST_TYPE_ELEMENT, _do_init);
96 static void gst_output_selector_dispose (GObject * object);
97 static void gst_output_selector_set_property (GObject * object,
98 guint prop_id, const GValue * value, GParamSpec * pspec);
99 static void gst_output_selector_get_property (GObject * object,
100 guint prop_id, GValue * value, GParamSpec * pspec);
101 static GstPad *gst_output_selector_request_new_pad (GstElement * element,
102 GstPadTemplate * templ, const gchar * unused, const GstCaps * caps);
103 static void gst_output_selector_release_pad (GstElement * element,
105 static GstFlowReturn gst_output_selector_chain (GstPad * pad,
106 GstObject * parent, GstBuffer * buf);
107 static GstStateChangeReturn gst_output_selector_change_state (GstElement *
108 element, GstStateChange transition);
109 static gboolean gst_output_selector_event (GstPad * pad, GstObject * parent,
111 static gboolean gst_output_selector_query (GstPad * pad, GstObject * parent,
113 static void gst_output_selector_switch_pad_negotiation_mode (GstOutputSelector *
117 gst_output_selector_class_init (GstOutputSelectorClass * klass)
119 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
120 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
122 gobject_class->dispose = gst_output_selector_dispose;
124 gobject_class->set_property = gst_output_selector_set_property;
125 gobject_class->get_property = gst_output_selector_get_property;
127 g_object_class_install_property (gobject_class, PROP_ACTIVE_PAD,
128 g_param_spec_object ("active-pad", "Active pad",
129 "Currently active src pad", GST_TYPE_PAD,
130 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
131 g_object_class_install_property (gobject_class, PROP_RESEND_LATEST,
132 g_param_spec_boolean ("resend-latest", "Resend latest buffer",
133 "Resend latest buffer after a switch to a new pad", FALSE,
134 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
135 g_object_class_install_property (gobject_class, PROP_PAD_NEGOTIATION_MODE,
136 g_param_spec_enum ("pad-negotiation-mode", "Pad negotiation mode",
137 "The mode to be used for pad negotiation",
138 GST_TYPE_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE,
139 DEFAULT_PAD_NEGOTIATION_MODE,
140 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
142 gst_element_class_set_details_simple (gstelement_class, "Output selector",
143 "Generic", "1-to-N output stream selector",
144 "Stefan Kost <stefan.kost@nokia.com>");
145 gst_element_class_add_pad_template (gstelement_class,
146 gst_static_pad_template_get (&gst_output_selector_sink_factory));
147 gst_element_class_add_pad_template (gstelement_class,
148 gst_static_pad_template_get (&gst_output_selector_src_factory));
150 gstelement_class->request_new_pad =
151 GST_DEBUG_FUNCPTR (gst_output_selector_request_new_pad);
152 gstelement_class->release_pad =
153 GST_DEBUG_FUNCPTR (gst_output_selector_release_pad);
155 gstelement_class->change_state = gst_output_selector_change_state;
159 gst_output_selector_init (GstOutputSelector * sel)
162 gst_pad_new_from_static_template (&gst_output_selector_sink_factory,
164 gst_pad_set_chain_function (sel->sinkpad,
165 GST_DEBUG_FUNCPTR (gst_output_selector_chain));
166 gst_pad_set_event_function (sel->sinkpad,
167 GST_DEBUG_FUNCPTR (gst_output_selector_event));
168 gst_pad_set_query_function (sel->sinkpad,
169 GST_DEBUG_FUNCPTR (gst_output_selector_query));
171 gst_element_add_pad (GST_ELEMENT (sel), sel->sinkpad);
173 /* srcpad management */
174 sel->active_srcpad = NULL;
176 gst_segment_init (&sel->segment, GST_FORMAT_UNDEFINED);
177 sel->pending_srcpad = NULL;
179 sel->resend_latest = FALSE;
180 sel->latest_buffer = NULL;
181 gst_output_selector_switch_pad_negotiation_mode (sel,
182 DEFAULT_PAD_NEGOTIATION_MODE);
186 gst_output_selector_reset (GstOutputSelector * osel)
188 if (osel->pending_srcpad != NULL) {
189 gst_object_unref (osel->pending_srcpad);
190 osel->pending_srcpad = NULL;
192 if (osel->latest_buffer != NULL) {
193 gst_buffer_unref (osel->latest_buffer);
194 osel->latest_buffer = NULL;
196 gst_segment_init (&osel->segment, GST_FORMAT_UNDEFINED);
200 gst_output_selector_dispose (GObject * object)
202 GstOutputSelector *osel = GST_OUTPUT_SELECTOR (object);
204 gst_output_selector_reset (osel);
206 G_OBJECT_CLASS (parent_class)->dispose (object);
210 gst_output_selector_set_property (GObject * object, guint prop_id,
211 const GValue * value, GParamSpec * pspec)
213 GstOutputSelector *sel = GST_OUTPUT_SELECTOR (object);
216 case PROP_ACTIVE_PAD:
220 next_pad = g_value_get_object (value);
222 GST_INFO_OBJECT (sel, "Activating pad %s:%s",
223 GST_DEBUG_PAD_NAME (next_pad));
225 GST_OBJECT_LOCK (object);
226 if (next_pad != sel->active_srcpad) {
227 /* switch to new srcpad in next chain run */
228 if (sel->pending_srcpad != NULL) {
229 GST_INFO ("replacing pending switch");
230 gst_object_unref (sel->pending_srcpad);
233 gst_object_ref (next_pad);
234 sel->pending_srcpad = next_pad;
236 GST_INFO ("pad already active");
237 if (sel->pending_srcpad != NULL) {
238 gst_object_unref (sel->pending_srcpad);
239 sel->pending_srcpad = NULL;
242 GST_OBJECT_UNLOCK (object);
245 case PROP_RESEND_LATEST:{
246 sel->resend_latest = g_value_get_boolean (value);
249 case PROP_PAD_NEGOTIATION_MODE:{
250 gst_output_selector_switch_pad_negotiation_mode (sel,
251 g_value_get_enum (value));
255 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
261 gst_output_selector_get_property (GObject * object, guint prop_id,
262 GValue * value, GParamSpec * pspec)
264 GstOutputSelector *sel = GST_OUTPUT_SELECTOR (object);
267 case PROP_ACTIVE_PAD:
268 GST_OBJECT_LOCK (object);
269 g_value_set_object (value,
270 sel->pending_srcpad ? sel->pending_srcpad : sel->active_srcpad);
271 GST_OBJECT_UNLOCK (object);
273 case PROP_RESEND_LATEST:{
274 GST_OBJECT_LOCK (object);
275 g_value_set_boolean (value, sel->resend_latest);
276 GST_OBJECT_UNLOCK (object);
279 case PROP_PAD_NEGOTIATION_MODE:
280 g_value_set_enum (value, sel->pad_negotiation_mode);
283 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
289 gst_output_selector_get_active (GstOutputSelector * sel)
291 GstPad *active = NULL;
293 GST_OBJECT_LOCK (sel);
294 if (sel->pending_srcpad)
295 active = gst_object_ref (sel->pending_srcpad);
296 else if (sel->active_srcpad)
297 active = gst_object_ref (sel->active_srcpad);
298 GST_OBJECT_UNLOCK (sel);
304 gst_output_selector_switch_pad_negotiation_mode (GstOutputSelector * sel,
307 sel->pad_negotiation_mode = mode;
311 forward_sticky_events (GstPad * pad, GstEvent ** event, gpointer user_data)
313 GstPad *srcpad = GST_PAD_CAST (user_data);
315 gst_pad_push_event (srcpad, gst_event_ref (*event));
321 gst_output_selector_request_new_pad (GstElement * element,
322 GstPadTemplate * templ, const gchar * name, const GstCaps * caps)
326 GstOutputSelector *osel;
328 osel = GST_OUTPUT_SELECTOR (element);
330 GST_DEBUG_OBJECT (osel, "requesting pad");
332 GST_OBJECT_LOCK (osel);
333 padname = g_strdup_printf ("src_%u", osel->nb_srcpads++);
334 srcpad = gst_pad_new_from_template (templ, padname);
335 GST_OBJECT_UNLOCK (osel);
337 gst_pad_set_active (srcpad, TRUE);
339 /* Forward sticky events to the new srcpad */
340 gst_pad_sticky_events_foreach (osel->sinkpad, forward_sticky_events, srcpad);
342 gst_element_add_pad (GST_ELEMENT (osel), srcpad);
344 /* Set the first requested src pad as active by default */
345 if (osel->active_srcpad == NULL) {
346 osel->active_srcpad = srcpad;
354 gst_output_selector_release_pad (GstElement * element, GstPad * pad)
356 GstOutputSelector *osel;
358 osel = GST_OUTPUT_SELECTOR (element);
360 GST_DEBUG_OBJECT (osel, "releasing pad");
362 gst_pad_set_active (pad, FALSE);
364 gst_element_remove_pad (GST_ELEMENT_CAST (osel), pad);
368 gst_output_selector_switch (GstOutputSelector * osel)
370 gboolean res = FALSE;
372 GstSegment *seg = NULL;
373 gint64 start = 0, position = 0;
376 GST_OBJECT_LOCK (GST_OBJECT (osel));
377 GST_INFO_OBJECT (osel, "switching to pad %" GST_PTR_FORMAT,
378 osel->pending_srcpad);
379 if (gst_pad_is_linked (osel->pending_srcpad)) {
380 osel->active_srcpad = osel->pending_srcpad;
383 gst_object_unref (osel->pending_srcpad);
384 osel->pending_srcpad = NULL;
385 GST_OBJECT_UNLOCK (GST_OBJECT (osel));
387 /* Send SEGMENT event and latest buffer if switching succeeded
388 * and we already have a valid segment configured */
390 if (osel->segment.format != GST_FORMAT_UNDEFINED) {
391 /* Send SEGMENT to the pad we are going to switch to */
392 seg = &osel->segment;
393 /* If resending then mark segment start and position accordingly */
394 if (osel->resend_latest && osel->latest_buffer &&
395 GST_BUFFER_TIMESTAMP_IS_VALID (osel->latest_buffer)) {
396 start = position = GST_BUFFER_TIMESTAMP (osel->latest_buffer);
398 start = position = seg->position;
402 seg->position = position;
403 ev = gst_event_new_segment (seg);
405 if (!gst_pad_push_event (osel->active_srcpad, ev)) {
406 GST_WARNING_OBJECT (osel,
407 "newsegment handling failed in %" GST_PTR_FORMAT,
408 osel->active_srcpad);
412 /* Resend latest buffer to newly switched pad */
413 if (osel->resend_latest && osel->latest_buffer) {
414 GST_INFO ("resending latest buffer");
415 gst_pad_push (osel->active_srcpad, gst_buffer_ref (osel->latest_buffer));
418 GST_WARNING_OBJECT (osel, "switch failed, pad not linked");
425 gst_output_selector_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
428 GstOutputSelector *osel;
429 GstClockTime position, duration;
431 osel = GST_OUTPUT_SELECTOR (parent);
434 * The _switch function might push a buffer if 'resend-latest' is true.
436 * Elements/Applications (e.g. camerabin) might use pad probes to
437 * switch output-selector's active pad. If we simply switch and don't
438 * recheck any pending pad switch the following codepath could end
439 * up pushing a buffer on a non-active pad. This is bad.
441 * So we always should check the pending_srcpad before going further down
442 * the chain and pushing the new buffer
444 while (osel->pending_srcpad) {
446 gst_output_selector_switch (osel);
449 if (osel->latest_buffer) {
450 gst_buffer_unref (osel->latest_buffer);
451 osel->latest_buffer = NULL;
454 if (osel->resend_latest) {
455 /* Keep reference to latest buffer to resend it after switch */
456 osel->latest_buffer = gst_buffer_ref (buf);
459 /* Keep track of last stop and use it in NEWSEGMENT start after
460 switching to a new src pad */
461 position = GST_BUFFER_TIMESTAMP (buf);
462 if (GST_CLOCK_TIME_IS_VALID (position)) {
463 duration = GST_BUFFER_DURATION (buf);
464 if (GST_CLOCK_TIME_IS_VALID (duration)) {
465 position += duration;
467 GST_LOG_OBJECT (osel, "setting last stop %" GST_TIME_FORMAT,
468 GST_TIME_ARGS (position));
469 osel->segment.position = position;
472 GST_LOG_OBJECT (osel, "pushing buffer to %" GST_PTR_FORMAT,
473 osel->active_srcpad);
474 res = gst_pad_push (osel->active_srcpad, buf);
479 static GstStateChangeReturn
480 gst_output_selector_change_state (GstElement * element,
481 GstStateChange transition)
483 GstOutputSelector *sel;
484 GstStateChangeReturn result;
486 sel = GST_OUTPUT_SELECTOR (element);
488 switch (transition) {
489 case GST_STATE_CHANGE_READY_TO_PAUSED:
495 result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
497 switch (transition) {
498 case GST_STATE_CHANGE_PAUSED_TO_READY:
499 gst_output_selector_reset (sel);
509 gst_output_selector_event (GstPad * pad, GstObject * parent, GstEvent * event)
512 GstOutputSelector *sel;
513 GstPad *active = NULL;
515 sel = GST_OUTPUT_SELECTOR (parent);
517 switch (GST_EVENT_TYPE (event)) {
520 switch (sel->pad_negotiation_mode) {
521 case GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ALL:
522 /* Send caps to all src pads */
523 res = gst_pad_event_default (pad, parent, event);
525 case GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_NONE:
526 gst_event_unref (event);
529 active = gst_output_selector_get_active (sel);
531 res = gst_pad_push_event (active, event);
532 gst_object_unref (active);
534 gst_event_unref (event);
540 case GST_EVENT_SEGMENT:
542 gst_event_copy_segment (event, &sel->segment);
544 GST_DEBUG_OBJECT (sel, "configured SEGMENT %" GST_SEGMENT_FORMAT,
547 /* Send newsegment to all src pads */
548 res = gst_pad_event_default (pad, parent, event);
552 /* Send eos to all src pads */
553 res = gst_pad_event_default (pad, parent, event);
557 /* Send other events to pending or active src pad */
558 active = gst_output_selector_get_active (sel);
560 res = gst_pad_push_event (active, event);
561 gst_object_unref (active);
563 gst_event_unref (event);
573 gst_output_selector_query (GstPad * pad, GstObject * parent, GstQuery * query)
576 GstOutputSelector *sel;
577 GstPad *active = NULL;
579 sel = GST_OUTPUT_SELECTOR (parent);
581 switch (GST_QUERY_TYPE (query)) {
584 switch (sel->pad_negotiation_mode) {
585 case GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ALL:
586 /* Send caps to all src pads */
587 res = gst_pad_proxy_query_caps (pad, query);
589 case GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_NONE:
593 active = gst_output_selector_get_active (sel);
595 res = gst_pad_peer_query (active, query);
596 gst_object_unref (active);
605 res = gst_pad_query_default (pad, parent, query);