gstreamer/plugins/elements/gststreamiddemux.c
Thibault Saunier a87b4551a6 Port gtk-doc comments to their equivalent markdown syntax
Modernizing our documentation and preparing a possible move to hotdoc.
This commits also adds missing @title metadatas to all SECTIONs
2017-01-27 16:36:38 -03:00

413 lines
12 KiB
C

/* GStreamer streamiddemux element
*
* Copyright 2013 LGE Corporation.
* @author: Hoonhee Lee <hoonhee.lee@lge.com>
* @author: Jeongseok Kim <jeongseok.kim@lge.com>
* @author: Wonchul Lee <wonchul86.lee@lge.com>
*
* gststreamiddemux.c: Simple stream-id-demultiplexer element
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* SECTION:element-streamiddemux
* @title: streamiddemux
*
* The basic concept was started from de-funneling element which restores one
* serialized stream via #GstFunnel to its original state. #GstStreamidDemux
* classifies each stream base on stream ids.
*
* The stream id demux always takes one input and checks how many streams
* are contained in a stream by STREAM_START event. Likewise #GstFunnel,
* #GstStreamidDemux does not synchronize the different output streams.
*
* #GstStreamidDemux:active-pad provides information about which output pad
* is activated at the moment.
*
* @see_also: #GstFunnel, #gst_event_new_stream_start
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <string.h>
#include "gststreamiddemux.h"
GST_DEBUG_CATEGORY_STATIC (streamid_demux_debug);
#define GST_CAT_DEFAULT streamid_demux_debug
enum
{
PROP_0,
PROP_ACTIVE_PAD,
PROP_LAST
};
static GstStaticPadTemplate gst_streamid_demux_sink_factory =
GST_STATIC_PAD_TEMPLATE ("sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS_ANY);
static GstStaticPadTemplate gst_streamid_demux_src_factory =
GST_STATIC_PAD_TEMPLATE ("src_%u",
GST_PAD_SRC,
GST_PAD_SOMETIMES,
GST_STATIC_CAPS_ANY);
#define _do_init \
GST_DEBUG_CATEGORY_INIT (streamid_demux_debug, \
"streamiddemux", 0, "Streamid demuxer");
#define gst_streamid_demux_parent_class parent_class
G_DEFINE_TYPE_WITH_CODE (GstStreamidDemux, gst_streamid_demux,
GST_TYPE_ELEMENT, _do_init);
static void gst_streamid_demux_dispose (GObject * object);
static void gst_streamid_demux_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec);
static GstFlowReturn gst_streamid_demux_chain (GstPad * pad,
GstObject * parent, GstBuffer * buf);
static gboolean gst_streamid_demux_event (GstPad * pad, GstObject * parent,
GstEvent * event);
static GstStateChangeReturn gst_streamid_demux_change_state (GstElement *
element, GstStateChange transition);
static GstPad *gst_streamid_demux_get_srcpad_by_stream_id (GstStreamidDemux *
demux, const gchar * stream_id);
static gboolean gst_streamid_demux_srcpad_create (GstStreamidDemux * demux,
GstPad * pad, const gchar * stream_id);
static void gst_streamid_demux_reset (GstStreamidDemux * demux);
static void gst_streamid_demux_release_srcpad (const GValue * item,
GstStreamidDemux * demux);
static void
gst_streamid_demux_class_init (GstStreamidDemuxClass * klass)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
gobject_class->get_property = gst_streamid_demux_get_property;
gobject_class->dispose = gst_streamid_demux_dispose;
g_object_class_install_property (gobject_class, PROP_ACTIVE_PAD,
g_param_spec_object ("active-pad", "Active pad",
"The currently active src pad", GST_TYPE_PAD,
G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
gst_element_class_set_static_metadata (gstelement_class, "Streamid Demux",
"Generic", "1-to-N output stream by stream-id",
"HoonHee Lee <hoonhee.lee@lge.com>");
gst_element_class_add_static_pad_template (gstelement_class,
&gst_streamid_demux_sink_factory);
gst_element_class_add_static_pad_template (gstelement_class,
&gst_streamid_demux_src_factory);
gstelement_class->change_state = gst_streamid_demux_change_state;
}
static void
gst_streamid_demux_init (GstStreamidDemux * demux)
{
demux->sinkpad =
gst_pad_new_from_static_template (&gst_streamid_demux_sink_factory,
"sink");
gst_pad_set_chain_function (demux->sinkpad,
GST_DEBUG_FUNCPTR (gst_streamid_demux_chain));
gst_pad_set_event_function (demux->sinkpad,
GST_DEBUG_FUNCPTR (gst_streamid_demux_event));
gst_element_add_pad (GST_ELEMENT (demux), demux->sinkpad);
/* srcpad management */
demux->active_srcpad = NULL;
demux->nb_srcpads = 0;
/* initialize hash table for srcpad */
demux->stream_id_pairs =
g_hash_table_new_full (g_str_hash, g_str_equal, (GDestroyNotify) g_free,
(GDestroyNotify) gst_object_unref);
}
static void
gst_streamid_demux_dispose (GObject * object)
{
GstStreamidDemux *demux = GST_STREAMID_DEMUX (object);
gst_streamid_demux_reset (demux);
G_OBJECT_CLASS (parent_class)->dispose (object);
}
static void
gst_streamid_demux_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec)
{
GstStreamidDemux *demux = GST_STREAMID_DEMUX (object);
switch (prop_id) {
case PROP_ACTIVE_PAD:
GST_OBJECT_LOCK (demux);
g_value_set_object (value, demux->active_srcpad);
GST_OBJECT_UNLOCK (demux);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static gboolean
forward_sticky_events (GstPad * pad, GstEvent ** event, gpointer user_data)
{
GstPad *srcpad = GST_PAD_CAST (user_data);
gst_pad_push_event (srcpad, gst_event_ref (*event));
return TRUE;
}
static gboolean
gst_streamid_demux_srcpad_create (GstStreamidDemux * demux, GstPad * pad,
const gchar * stream_id)
{
gchar *padname = NULL;
GstPad *srcpad = NULL;
GstPadTemplate *pad_tmpl = NULL;
padname = g_strdup_printf ("src_%u", demux->nb_srcpads++);
pad_tmpl = gst_static_pad_template_get (&gst_streamid_demux_src_factory);
GST_LOG_OBJECT (demux, "generating a srcpad:%s", padname);
srcpad = gst_pad_new_from_template (pad_tmpl, padname);
gst_object_unref (pad_tmpl);
g_free (padname);
g_return_val_if_fail (srcpad != NULL, FALSE);
demux->active_srcpad = srcpad;
g_hash_table_insert (demux->stream_id_pairs, g_strdup (stream_id),
gst_object_ref (srcpad));
return TRUE;
}
static GstFlowReturn
gst_streamid_demux_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
{
GstFlowReturn res = GST_FLOW_OK;
GstStreamidDemux *demux = NULL;
GstPad *srcpad = NULL;
demux = GST_STREAMID_DEMUX (parent);
GST_LOG_OBJECT (demux, "pushing buffer to %" GST_PTR_FORMAT,
demux->active_srcpad);
GST_OBJECT_LOCK (demux);
if (demux->active_srcpad) {
srcpad = gst_object_ref (demux->active_srcpad);
GST_OBJECT_UNLOCK (demux);
res = gst_pad_push (srcpad, buf);
gst_object_unref (srcpad);
} else {
GST_OBJECT_UNLOCK (demux);
goto no_active_srcpad;
}
GST_LOG_OBJECT (demux, "handled buffer %s", gst_flow_get_name (res));
return res;
/* ERROR */
no_active_srcpad:
{
GST_WARNING_OBJECT (demux, "srcpad is not initialized");
return GST_FLOW_NOT_NEGOTIATED;
}
}
static GstPad *
gst_streamid_demux_get_srcpad_by_stream_id (GstStreamidDemux * demux,
const gchar * stream_id)
{
GstPad *srcpad = NULL;
GST_DEBUG_OBJECT (demux, "stream_id = %s", stream_id);
if (demux->stream_id_pairs == NULL || stream_id == NULL) {
goto done;
}
srcpad = g_hash_table_lookup (demux->stream_id_pairs, stream_id);
if (srcpad) {
GST_DEBUG_OBJECT (demux, "srcpad = %s:%s matched",
GST_DEBUG_PAD_NAME (srcpad));
}
done:
return srcpad;
}
static gboolean
gst_streamid_demux_event (GstPad * pad, GstObject * parent, GstEvent * event)
{
gboolean res = TRUE;
GstStreamidDemux *demux;
const gchar *stream_id = NULL;
GstPad *active_srcpad = NULL;
demux = GST_STREAMID_DEMUX (parent);
GST_DEBUG_OBJECT (demux, "event = %s, sticky = %d",
GST_EVENT_TYPE_NAME (event), GST_EVENT_IS_STICKY (event));
if (GST_EVENT_TYPE (event) == GST_EVENT_STREAM_START) {
gst_event_parse_stream_start (event, &stream_id);
if (!stream_id)
goto no_stream_id;
GST_OBJECT_LOCK (demux);
active_srcpad =
gst_streamid_demux_get_srcpad_by_stream_id (demux, stream_id);
if (!active_srcpad) {
/* try to generate a srcpad */
if (gst_streamid_demux_srcpad_create (demux, pad, stream_id)) {
GST_OBJECT_UNLOCK (demux);
gst_pad_set_active (demux->active_srcpad, TRUE);
/* Forward sticky events to the new srcpad */
gst_pad_sticky_events_foreach (demux->sinkpad, forward_sticky_events,
demux->active_srcpad);
gst_element_add_pad (GST_ELEMENT_CAST (demux), demux->active_srcpad);
} else {
GST_OBJECT_UNLOCK (demux);
goto fail_create_srcpad;
}
} else if (demux->active_srcpad != active_srcpad) {
demux->active_srcpad = active_srcpad;
GST_OBJECT_UNLOCK (demux);
g_object_notify (G_OBJECT (demux), "active-pad");
} else
GST_OBJECT_UNLOCK (demux);
}
if (GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_START
|| GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_STOP
|| GST_EVENT_TYPE (event) == GST_EVENT_EOS) {
res = gst_pad_event_default (pad, parent, event);
} else if (demux->active_srcpad) {
GstPad *srcpad = NULL;
GST_OBJECT_LOCK (demux);
srcpad = gst_object_ref (demux->active_srcpad);
GST_OBJECT_UNLOCK (demux);
res = gst_pad_push_event (srcpad, event);
gst_object_unref (srcpad);
} else {
gst_event_unref (event);
}
return res;
/* ERRORS */
no_stream_id:
{
GST_ELEMENT_ERROR (demux, STREAM, DEMUX,
("Error occurred trying to get stream-id to create a srcpad"),
("no stream-id found at %s", GST_EVENT_TYPE_NAME (event)));
gst_event_unref (event);
return FALSE;
}
fail_create_srcpad:
{
GST_ELEMENT_ERROR (demux, STREAM, FAILED,
("Error occurred trying to create a srcpad"),
("Failed to create a srcpad via stream-id:%s", stream_id));
gst_event_unref (event);
return FALSE;
}
}
static void
gst_streamid_demux_release_srcpad (const GValue * item,
GstStreamidDemux * demux)
{
GstPad *pad = g_value_get_object (item);
if (pad != NULL) {
gst_pad_set_active (pad, FALSE);
gst_element_remove_pad (GST_ELEMENT_CAST (demux), pad);
}
}
static void
gst_streamid_demux_reset (GstStreamidDemux * demux)
{
GstIterator *it = NULL;
GstIteratorResult itret = GST_ITERATOR_OK;
GST_OBJECT_LOCK (demux);
if (demux->active_srcpad != NULL)
demux->active_srcpad = NULL;
demux->nb_srcpads = 0;
GST_OBJECT_UNLOCK (demux);
if (demux->stream_id_pairs != NULL) {
g_hash_table_unref (demux->stream_id_pairs);
demux->stream_id_pairs = NULL;
}
it = gst_element_iterate_src_pads (GST_ELEMENT_CAST (demux));
while (itret == GST_ITERATOR_OK || itret == GST_ITERATOR_RESYNC) {
itret =
gst_iterator_foreach (it,
(GstIteratorForeachFunction) gst_streamid_demux_release_srcpad, demux);
if (itret == GST_ITERATOR_RESYNC)
gst_iterator_resync (it);
}
gst_iterator_free (it);
}
static GstStateChangeReturn
gst_streamid_demux_change_state (GstElement * element,
GstStateChange transition)
{
GstStreamidDemux *demux;
GstStateChangeReturn result;
demux = GST_STREAMID_DEMUX (element);
switch (transition) {
case GST_STATE_CHANGE_READY_TO_PAUSED:
break;
default:
break;
}
result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
switch (transition) {
case GST_STATE_CHANGE_PAUSED_TO_READY:
gst_streamid_demux_reset (demux);
break;
default:
break;
}
return result;
}