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, GstBuffer * buf);
106 static GstStateChangeReturn gst_output_selector_change_state (GstElement *
107 element, GstStateChange transition);
108 static gboolean gst_output_selector_event (GstPad * pad, GstEvent * event);
109 static gboolean gst_output_selector_query (GstPad * pad, GstQuery * query);
110 static void gst_output_selector_switch_pad_negotiation_mode (GstOutputSelector *
114 gst_output_selector_class_init (GstOutputSelectorClass * klass)
116 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
117 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
119 gobject_class->dispose = gst_output_selector_dispose;
121 gobject_class->set_property = gst_output_selector_set_property;
122 gobject_class->get_property = gst_output_selector_get_property;
124 g_object_class_install_property (gobject_class, PROP_ACTIVE_PAD,
125 g_param_spec_object ("active-pad", "Active pad",
126 "Currently active src pad", GST_TYPE_PAD,
127 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
128 g_object_class_install_property (gobject_class, PROP_RESEND_LATEST,
129 g_param_spec_boolean ("resend-latest", "Resend latest buffer",
130 "Resend latest buffer after a switch to a new pad", FALSE,
131 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
132 g_object_class_install_property (gobject_class, PROP_PAD_NEGOTIATION_MODE,
133 g_param_spec_enum ("pad-negotiation-mode", "Pad negotiation mode",
134 "The mode to be used for pad negotiation",
135 GST_TYPE_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE,
136 DEFAULT_PAD_NEGOTIATION_MODE,
137 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
139 gst_element_class_set_details_simple (gstelement_class, "Output selector",
140 "Generic", "1-to-N output stream selector",
141 "Stefan Kost <stefan.kost@nokia.com>");
142 gst_element_class_add_pad_template (gstelement_class,
143 gst_static_pad_template_get (&gst_output_selector_sink_factory));
144 gst_element_class_add_pad_template (gstelement_class,
145 gst_static_pad_template_get (&gst_output_selector_src_factory));
147 gstelement_class->request_new_pad =
148 GST_DEBUG_FUNCPTR (gst_output_selector_request_new_pad);
149 gstelement_class->release_pad =
150 GST_DEBUG_FUNCPTR (gst_output_selector_release_pad);
152 gstelement_class->change_state = gst_output_selector_change_state;
156 gst_output_selector_init (GstOutputSelector * sel)
159 gst_pad_new_from_static_template (&gst_output_selector_sink_factory,
161 gst_pad_set_chain_function (sel->sinkpad,
162 GST_DEBUG_FUNCPTR (gst_output_selector_chain));
163 gst_pad_set_event_function (sel->sinkpad,
164 GST_DEBUG_FUNCPTR (gst_output_selector_event));
165 gst_pad_set_query_function (sel->sinkpad,
166 GST_DEBUG_FUNCPTR (gst_output_selector_query));
168 gst_element_add_pad (GST_ELEMENT (sel), sel->sinkpad);
170 /* srcpad management */
171 sel->active_srcpad = NULL;
173 gst_segment_init (&sel->segment, GST_FORMAT_TIME);
174 sel->pending_srcpad = NULL;
176 sel->resend_latest = FALSE;
177 sel->latest_buffer = NULL;
178 gst_output_selector_switch_pad_negotiation_mode (sel,
179 DEFAULT_PAD_NEGOTIATION_MODE);
183 gst_output_selector_reset (GstOutputSelector * osel)
185 if (osel->pending_srcpad != NULL) {
186 gst_object_unref (osel->pending_srcpad);
187 osel->pending_srcpad = NULL;
189 if (osel->latest_buffer != NULL) {
190 gst_buffer_unref (osel->latest_buffer);
191 osel->latest_buffer = NULL;
193 gst_segment_init (&osel->segment, GST_FORMAT_UNDEFINED);
197 gst_output_selector_dispose (GObject * object)
199 GstOutputSelector *osel = GST_OUTPUT_SELECTOR (object);
201 gst_output_selector_reset (osel);
203 G_OBJECT_CLASS (parent_class)->dispose (object);
207 gst_output_selector_set_property (GObject * object, guint prop_id,
208 const GValue * value, GParamSpec * pspec)
210 GstOutputSelector *sel = GST_OUTPUT_SELECTOR (object);
213 case PROP_ACTIVE_PAD:
217 next_pad = g_value_get_object (value);
219 GST_INFO_OBJECT (sel, "Activating pad %s:%s",
220 GST_DEBUG_PAD_NAME (next_pad));
222 GST_OBJECT_LOCK (object);
223 if (next_pad != sel->active_srcpad) {
224 /* switch to new srcpad in next chain run */
225 if (sel->pending_srcpad != NULL) {
226 GST_INFO ("replacing pending switch");
227 gst_object_unref (sel->pending_srcpad);
230 gst_object_ref (next_pad);
231 sel->pending_srcpad = next_pad;
233 GST_INFO ("pad already active");
234 if (sel->pending_srcpad != NULL) {
235 gst_object_unref (sel->pending_srcpad);
236 sel->pending_srcpad = NULL;
239 GST_OBJECT_UNLOCK (object);
242 case PROP_RESEND_LATEST:{
243 sel->resend_latest = g_value_get_boolean (value);
246 case PROP_PAD_NEGOTIATION_MODE:{
247 gst_output_selector_switch_pad_negotiation_mode (sel,
248 g_value_get_enum (value));
252 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
258 gst_output_selector_get_property (GObject * object, guint prop_id,
259 GValue * value, GParamSpec * pspec)
261 GstOutputSelector *sel = GST_OUTPUT_SELECTOR (object);
264 case PROP_ACTIVE_PAD:
265 GST_OBJECT_LOCK (object);
266 g_value_set_object (value,
267 sel->pending_srcpad ? sel->pending_srcpad : sel->active_srcpad);
268 GST_OBJECT_UNLOCK (object);
270 case PROP_RESEND_LATEST:{
271 GST_OBJECT_LOCK (object);
272 g_value_set_boolean (value, sel->resend_latest);
273 GST_OBJECT_UNLOCK (object);
276 case PROP_PAD_NEGOTIATION_MODE:
277 g_value_set_enum (value, sel->pad_negotiation_mode);
280 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
286 gst_output_selector_get_active (GstOutputSelector * sel)
288 GstPad *active = NULL;
290 GST_OBJECT_LOCK (sel);
291 if (sel->pending_srcpad)
292 active = gst_object_ref (sel->pending_srcpad);
293 else if (sel->active_srcpad)
294 active = gst_object_ref (sel->active_srcpad);
295 GST_OBJECT_UNLOCK (sel);
301 gst_output_selector_switch_pad_negotiation_mode (GstOutputSelector * sel,
304 sel->pad_negotiation_mode = mode;
308 forward_sticky_events (GstPad * pad, GstEvent * event, gpointer user_data)
310 GstPad *srcpad = GST_PAD_CAST (user_data);
312 gst_pad_push_event (srcpad, gst_event_ref (event));
318 gst_output_selector_request_new_pad (GstElement * element,
319 GstPadTemplate * templ, const gchar * name, const GstCaps * caps)
323 GstOutputSelector *osel;
325 osel = GST_OUTPUT_SELECTOR (element);
327 GST_DEBUG_OBJECT (osel, "requesting pad");
329 GST_OBJECT_LOCK (osel);
330 padname = g_strdup_printf ("src_%u", osel->nb_srcpads++);
331 srcpad = gst_pad_new_from_template (templ, padname);
332 GST_OBJECT_UNLOCK (osel);
334 gst_pad_set_active (srcpad, TRUE);
336 /* Forward sticky events to the new srcpad */
337 gst_pad_sticky_events_foreach (osel->sinkpad, forward_sticky_events, srcpad);
339 gst_element_add_pad (GST_ELEMENT (osel), srcpad);
341 /* Set the first requested src pad as active by default */
342 if (osel->active_srcpad == NULL) {
343 osel->active_srcpad = srcpad;
351 gst_output_selector_release_pad (GstElement * element, GstPad * pad)
353 GstOutputSelector *osel;
355 osel = GST_OUTPUT_SELECTOR (element);
357 GST_DEBUG_OBJECT (osel, "releasing pad");
359 gst_pad_set_active (pad, FALSE);
361 gst_element_remove_pad (GST_ELEMENT_CAST (osel), pad);
365 gst_output_selector_switch (GstOutputSelector * osel)
367 gboolean res = FALSE;
369 GstSegment *seg = NULL;
370 gint64 start = 0, position = 0;
373 GST_OBJECT_LOCK (GST_OBJECT (osel));
374 GST_INFO ("switching to pad %" GST_PTR_FORMAT, osel->pending_srcpad);
375 if (gst_pad_is_linked (osel->pending_srcpad)) {
376 osel->active_srcpad = osel->pending_srcpad;
379 gst_object_unref (osel->pending_srcpad);
380 osel->pending_srcpad = NULL;
381 GST_OBJECT_UNLOCK (GST_OBJECT (osel));
383 /* Send SEGMENT event and latest buffer if switching succeeded */
385 /* Send SEGMENT to the pad we are going to switch to */
386 seg = &osel->segment;
387 /* If resending then mark segment start and position accordingly */
388 if (osel->resend_latest && osel->latest_buffer &&
389 GST_BUFFER_TIMESTAMP_IS_VALID (osel->latest_buffer)) {
390 start = position = GST_BUFFER_TIMESTAMP (osel->latest_buffer);
392 start = position = seg->position;
396 seg->position = position;
397 ev = gst_event_new_segment (seg);
399 if (!gst_pad_push_event (osel->active_srcpad, ev)) {
400 GST_WARNING_OBJECT (osel,
401 "newsegment handling failed in %" GST_PTR_FORMAT,
402 osel->active_srcpad);
405 /* Resend latest buffer to newly switched pad */
406 if (osel->resend_latest && osel->latest_buffer) {
407 GST_INFO ("resending latest buffer");
408 gst_pad_push (osel->active_srcpad, gst_buffer_ref (osel->latest_buffer));
411 GST_WARNING_OBJECT (osel, "switch failed, pad not linked");
418 gst_output_selector_chain (GstPad * pad, GstBuffer * buf)
421 GstOutputSelector *osel;
422 GstClockTime position, duration;
424 osel = GST_OUTPUT_SELECTOR (gst_pad_get_parent (pad));
427 * The _switch function might push a buffer if 'resend-latest' is true.
429 * Elements/Applications (e.g. camerabin) might use pad probes to
430 * switch output-selector's active pad. If we simply switch and don't
431 * recheck any pending pad switch the following codepath could end
432 * up pushing a buffer on a non-active pad. This is bad.
434 * So we always should check the pending_srcpad before going further down
435 * the chain and pushing the new buffer
437 while (osel->pending_srcpad) {
439 gst_output_selector_switch (osel);
442 if (osel->latest_buffer) {
443 gst_buffer_unref (osel->latest_buffer);
444 osel->latest_buffer = NULL;
447 if (osel->resend_latest) {
448 /* Keep reference to latest buffer to resend it after switch */
449 osel->latest_buffer = gst_buffer_ref (buf);
452 /* Keep track of last stop and use it in NEWSEGMENT start after
453 switching to a new src pad */
454 position = GST_BUFFER_TIMESTAMP (buf);
455 if (GST_CLOCK_TIME_IS_VALID (position)) {
456 duration = GST_BUFFER_DURATION (buf);
457 if (GST_CLOCK_TIME_IS_VALID (duration)) {
458 position += duration;
460 GST_LOG_OBJECT (osel, "setting last stop %" GST_TIME_FORMAT,
461 GST_TIME_ARGS (position));
462 osel->segment.position = position;
465 GST_LOG_OBJECT (osel, "pushing buffer to %" GST_PTR_FORMAT,
466 osel->active_srcpad);
467 res = gst_pad_push (osel->active_srcpad, buf);
468 gst_object_unref (osel);
473 static GstStateChangeReturn
474 gst_output_selector_change_state (GstElement * element,
475 GstStateChange transition)
477 GstOutputSelector *sel;
478 GstStateChangeReturn result;
480 sel = GST_OUTPUT_SELECTOR (element);
482 switch (transition) {
483 case GST_STATE_CHANGE_READY_TO_PAUSED:
489 result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
491 switch (transition) {
492 case GST_STATE_CHANGE_PAUSED_TO_READY:
493 gst_output_selector_reset (sel);
503 gst_output_selector_event (GstPad * pad, GstEvent * event)
506 GstOutputSelector *sel;
507 GstPad *active = NULL;
509 sel = GST_OUTPUT_SELECTOR (gst_pad_get_parent (pad));
510 if (G_UNLIKELY (sel == NULL)) {
511 gst_event_unref (event);
515 switch (GST_EVENT_TYPE (event)) {
518 switch (sel->pad_negotiation_mode) {
519 case GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ALL:
520 /* Send caps to all src pads */
521 res = gst_pad_event_default (pad, event);
523 case GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_NONE:
524 gst_event_unref (event);
527 active = gst_output_selector_get_active (sel);
529 res = gst_pad_push_event (active, event);
530 gst_object_unref (active);
532 gst_event_unref (event);
538 case GST_EVENT_SEGMENT:
540 gst_event_copy_segment (event, &sel->segment);
542 GST_DEBUG_OBJECT (sel, "configured SEGMENT %" GST_SEGMENT_FORMAT,
545 /* Send newsegment to all src pads */
546 res = gst_pad_event_default (pad, event);
550 /* Send eos to all src pads */
551 res = gst_pad_event_default (pad, event);
555 /* Send other events to pending or active src pad */
556 active = gst_output_selector_get_active (sel);
558 res = gst_pad_push_event (active, event);
559 gst_object_unref (active);
561 gst_event_unref (event);
567 gst_object_unref (sel);
573 gst_output_selector_query (GstPad * pad, GstQuery * query)
576 GstOutputSelector *sel;
577 GstPad *active = NULL;
579 sel = GST_OUTPUT_SELECTOR (gst_pad_get_parent (pad));
580 if (G_UNLIKELY (sel == NULL)) {
584 switch (GST_QUERY_TYPE (query)) {
587 switch (sel->pad_negotiation_mode) {
588 case GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ALL:
589 /* Send caps to all src pads */
590 res = gst_pad_proxy_query_caps (pad, query);
592 case GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_NONE:
596 active = gst_output_selector_get_active (sel);
598 res = gst_pad_peer_query (active, query);
599 gst_object_unref (active);
611 gst_object_unref (sel);