2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wim.taymans@chello.be>
5 * gstaggregator.c: Aggregator element, N in 1 out
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
27 #include "gstaggregator.h"
29 GST_DEBUG_CATEGORY_STATIC (gst_aggregator_debug);
30 #define GST_CAT_DEFAULT gst_aggregator_debug
32 GstElementDetails gst_aggregator_details = GST_ELEMENT_DETAILS (
33 "Aggregator pipe fitting",
35 "N-to-1 pipe fitting",
36 "Wim Taymans <wim.taymans@chello.be>"
39 /* Aggregator signals and args */
54 GstStaticPadTemplate aggregator_src_template = GST_STATIC_PAD_TEMPLATE (
61 #define GST_TYPE_AGGREGATOR_SCHED (gst_aggregator_sched_get_type())
63 gst_aggregator_sched_get_type (void)
65 static GType aggregator_sched_type = 0;
66 static GEnumValue aggregator_sched[] = {
67 { AGGREGATOR_LOOP, "1", "Loop Based"},
68 { AGGREGATOR_LOOP_SELECT, "3", "Loop Based Select"},
69 { AGGREGATOR_CHAIN, "4", "Chain Based"},
72 if (!aggregator_sched_type) {
73 aggregator_sched_type = g_enum_register_static ("GstAggregatorSched", aggregator_sched);
75 return aggregator_sched_type;
78 #define AGGREGATOR_IS_LOOP_BASED(ag) ((ag)->sched != AGGREGATOR_CHAIN)
80 static void gst_aggregator_base_init (gpointer g_class);
81 static void gst_aggregator_class_init (GstAggregatorClass *klass);
82 static void gst_aggregator_init (GstAggregator *aggregator);
84 static GstPad* gst_aggregator_request_new_pad (GstElement *element, GstPadTemplate *temp, const
86 static void gst_aggregator_update_functions (GstAggregator *aggregator);
88 static void gst_aggregator_set_property (GObject *object, guint prop_id,
89 const GValue *value, GParamSpec *pspec);
90 static void gst_aggregator_get_property (GObject *object, guint prop_id,
91 GValue *value, GParamSpec *pspec);
93 static void gst_aggregator_chain (GstPad *pad, GstData *_data);
94 static void gst_aggregator_loop (GstElement *element);
96 static GstElementClass *parent_class = NULL;
97 /*static guint gst_aggregator_signals[LAST_SIGNAL] = { 0 };*/
100 gst_aggregator_get_type (void)
102 static GType aggregator_type = 0;
104 if (!aggregator_type) {
105 static const GTypeInfo aggregator_info = {
106 sizeof(GstAggregatorClass),
107 gst_aggregator_base_init,
109 (GClassInitFunc)gst_aggregator_class_init,
112 sizeof(GstAggregator),
114 (GInstanceInitFunc)gst_aggregator_init,
116 aggregator_type = g_type_register_static (GST_TYPE_ELEMENT, "GstAggregator", &aggregator_info, 0);
118 GST_DEBUG_CATEGORY_INIT (gst_aggregator_debug, "aggregator", 0, "aggregator element");
120 return aggregator_type;
124 gst_aggregator_base_init (gpointer g_class)
126 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
127 gst_element_class_add_pad_template (gstelement_class,
128 gst_static_pad_template_get (&aggregator_src_template));
129 gst_element_class_set_details (gstelement_class, &gst_aggregator_details);
132 gst_aggregator_class_init (GstAggregatorClass *klass)
134 GObjectClass *gobject_class;
135 GstElementClass *gstelement_class;
137 gobject_class = (GObjectClass*) klass;
138 gstelement_class = (GstElementClass*) klass;
140 parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
142 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_NUM_PADS,
143 g_param_spec_int ("num_pads", "Num pads", "The number of source pads",
144 0, G_MAXINT, 0, G_PARAM_READABLE));
145 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SILENT,
146 g_param_spec_boolean ("silent", "Silent", "Don't produce messages",
147 FALSE, G_PARAM_READWRITE));
148 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SCHED,
149 g_param_spec_enum ("sched", "Scheduling", "The type of scheduling this element should use",
150 GST_TYPE_AGGREGATOR_SCHED, AGGREGATOR_CHAIN, G_PARAM_READWRITE));
151 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_LAST_MESSAGE,
152 g_param_spec_string ("last_message", "Last message", "The current state of the element",
153 NULL, G_PARAM_READABLE));
155 gobject_class->set_property = GST_DEBUG_FUNCPTR(gst_aggregator_set_property);
156 gobject_class->get_property = GST_DEBUG_FUNCPTR(gst_aggregator_get_property);
158 gstelement_class->request_new_pad = GST_DEBUG_FUNCPTR(gst_aggregator_request_new_pad);
162 gst_aggregator_init (GstAggregator *aggregator)
164 aggregator->srcpad = gst_pad_new ("src", GST_PAD_SRC);
165 gst_element_add_pad (GST_ELEMENT (aggregator), aggregator->srcpad);
167 aggregator->numsinkpads = 0;
168 aggregator->sinkpads = NULL;
169 aggregator->silent = FALSE;
170 aggregator->sched = AGGREGATOR_LOOP;
172 gst_aggregator_update_functions (aggregator);
176 gst_aggregator_request_new_pad (GstElement *element, GstPadTemplate *templ, const gchar *unused)
180 GstAggregator *aggregator;
182 g_return_val_if_fail (GST_IS_AGGREGATOR (element), NULL);
184 if (templ->direction != GST_PAD_SINK) {
185 g_warning ("gstaggregator: request new pad that is not a sink pad\n");
189 aggregator = GST_AGGREGATOR (element);
191 name = g_strdup_printf ("sink%d",aggregator->numsinkpads);
193 sinkpad = gst_pad_new_from_template (templ, name);
196 if (!AGGREGATOR_IS_LOOP_BASED (aggregator)) {
197 gst_pad_set_chain_function (sinkpad, gst_aggregator_chain);
199 gst_element_add_pad (GST_ELEMENT (aggregator), sinkpad);
201 aggregator->sinkpads = g_list_prepend (aggregator->sinkpads, sinkpad);
202 aggregator->numsinkpads++;
208 gst_aggregator_update_functions (GstAggregator *aggregator)
212 if (AGGREGATOR_IS_LOOP_BASED (aggregator)) {
213 gst_element_set_loop_function (GST_ELEMENT (aggregator), GST_DEBUG_FUNCPTR (gst_aggregator_loop));
216 gst_element_set_loop_function (GST_ELEMENT (aggregator), NULL);
219 pads = aggregator->sinkpads;
221 GstPad *pad = GST_PAD (pads->data);
223 if (AGGREGATOR_IS_LOOP_BASED (aggregator)) {
224 gst_pad_set_get_function (pad, NULL);
227 gst_element_set_loop_function (GST_ELEMENT (aggregator), NULL);
229 pads = g_list_next (pads);
234 gst_aggregator_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
236 GstAggregator *aggregator;
238 /* it's not null if we got it, but it might not be ours */
239 g_return_if_fail (GST_IS_AGGREGATOR (object));
241 aggregator = GST_AGGREGATOR (object);
245 aggregator->silent = g_value_get_boolean (value);
248 aggregator->sched = g_value_get_enum (value);
249 gst_aggregator_update_functions (aggregator);
257 gst_aggregator_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
259 GstAggregator *aggregator;
261 /* it's not null if we got it, but it might not be ours */
262 g_return_if_fail (GST_IS_AGGREGATOR (object));
264 aggregator = GST_AGGREGATOR (object);
268 g_value_set_int (value, aggregator->numsinkpads);
271 g_value_set_boolean (value, aggregator->silent);
274 g_value_set_enum (value, aggregator->sched);
276 case ARG_LAST_MESSAGE:
277 g_value_set_string (value, aggregator->last_message);
285 gst_aggregator_push (GstAggregator *aggregator, GstPad *pad, GstBuffer *buf, guchar *debug)
287 if (!aggregator->silent) {
288 g_free (aggregator->last_message);
290 aggregator->last_message = g_strdup_printf ("%10.10s ******* (%s:%s)a (%d bytes, %"
291 G_GUINT64_FORMAT ")",
292 debug, GST_DEBUG_PAD_NAME (pad), GST_BUFFER_SIZE (buf), GST_BUFFER_TIMESTAMP (buf));
294 g_object_notify (G_OBJECT (aggregator), "last_message");
297 gst_pad_push (aggregator->srcpad, GST_DATA (buf));
301 gst_aggregator_loop (GstElement *element)
303 GstAggregator *aggregator;
307 aggregator = GST_AGGREGATOR (element);
309 if (aggregator->sched == AGGREGATOR_LOOP) {
310 GList *pads = aggregator->sinkpads;
312 /* we'll loop over all pads and try to pull from all
315 GstPad *pad = GST_PAD (pads->data);
316 pads = g_list_next (pads);
318 /* we need to check is the pad is usable. IS_USABLE will check
319 * if the pad is linked, if it is enabled (the element is
320 * playing and the app didn't gst_pad_set_enabled (pad, FALSE))
321 * and that the peer pad is also enabled.
323 if (GST_PAD_IS_USABLE (pad)) {
324 buf = GST_BUFFER (gst_pad_pull (pad));
327 /* then push it forward */
328 gst_aggregator_push (aggregator, pad, buf, debug);
333 if (aggregator->sched == AGGREGATOR_LOOP_SELECT) {
336 debug = "loop_select";
338 pad = gst_pad_selectv (aggregator->sinkpads);
339 buf = GST_BUFFER (gst_pad_pull (pad));
341 gst_aggregator_push (aggregator, pad, buf, debug);
344 g_assert_not_reached ();
350 * gst_aggregator_chain:
351 * @pad: the pad to follow
352 * @buf: the buffer to pass
354 * Chain a buffer on a pad.
357 gst_aggregator_chain (GstPad *pad, GstData *_data)
359 GstBuffer *buf = GST_BUFFER (_data);
360 GstAggregator *aggregator;
362 g_return_if_fail (pad != NULL);
363 g_return_if_fail (GST_IS_PAD (pad));
364 g_return_if_fail (buf != NULL);
366 aggregator = GST_AGGREGATOR (gst_pad_get_parent (pad));
367 /* gst_trace_add_entry (NULL, 0, buf, "aggregator buffer");*/
369 gst_aggregator_push (aggregator, pad, buf, "chain");