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 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
34 GST_DEBUG_CATEGORY_STATIC (gst_aggregator_debug);
35 #define GST_CAT_DEFAULT gst_aggregator_debug
37 GstElementDetails gst_aggregator_details =
38 GST_ELEMENT_DETAILS ("Aggregator pipe fitting",
40 "N-to-1 pipe fitting",
41 "Wim Taymans <wim.taymans@chello.be>");
43 /* Aggregator signals and args */
60 GstStaticPadTemplate aggregator_src_template =
61 GST_STATIC_PAD_TEMPLATE ("sink%d",
66 #define GST_TYPE_AGGREGATOR_SCHED (gst_aggregator_sched_get_type())
68 gst_aggregator_sched_get_type (void)
70 static GType aggregator_sched_type = 0;
71 static GEnumValue aggregator_sched[] = {
72 {AGGREGATOR_LOOP, "Loop Based", "loop"},
73 {AGGREGATOR_LOOP_SELECT, "Loop Based Select", "loop-select"},
74 {AGGREGATOR_CHAIN, "Chain Based", "chain"},
78 if (!aggregator_sched_type) {
79 aggregator_sched_type =
80 g_enum_register_static ("GstAggregatorSched", aggregator_sched);
82 return aggregator_sched_type;
85 #define AGGREGATOR_IS_LOOP_BASED(ag) ((ag)->sched != AGGREGATOR_CHAIN)
87 static GstPad *gst_aggregator_request_new_pad (GstElement * element,
88 GstPadTemplate * temp, const gchar * unused);
89 static void gst_aggregator_update_functions (GstAggregator * aggregator);
91 static void gst_aggregator_finalize (GObject * object);
92 static void gst_aggregator_set_property (GObject * object, guint prop_id,
93 const GValue * value, GParamSpec * pspec);
94 static void gst_aggregator_get_property (GObject * object, guint prop_id,
95 GValue * value, GParamSpec * pspec);
97 static void gst_aggregator_chain (GstPad * pad, GstData * _data);
98 static void gst_aggregator_loop (GstElement * element);
100 #define _do_init(bla) \
101 GST_DEBUG_CATEGORY_INIT (gst_aggregator_debug, "aggregator", 0, "aggregator element");
103 GST_BOILERPLATE_FULL (GstAggregator, gst_aggregator, GstElement,
104 GST_TYPE_ELEMENT, _do_init);
107 gst_aggregator_base_init (gpointer g_class)
109 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
111 gst_element_class_add_pad_template (gstelement_class,
112 gst_static_pad_template_get (&aggregator_src_template));
113 gst_element_class_add_pad_template (gstelement_class,
114 gst_static_pad_template_get (&srctemplate));
115 gst_element_class_set_details (gstelement_class, &gst_aggregator_details);
119 gst_aggregator_finalize (GObject * object)
121 GstAggregator *aggregator;
123 aggregator = GST_AGGREGATOR (object);
125 g_list_free (aggregator->sinkpads);
126 g_free (aggregator->last_message);
128 G_OBJECT_CLASS (parent_class)->finalize (object);
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 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_aggregator_set_property);
141 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_aggregator_get_property);
143 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_NUM_PADS,
144 g_param_spec_int ("num_pads", "Num pads", "The number of source pads",
145 0, G_MAXINT, 0, G_PARAM_READABLE));
146 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SILENT,
147 g_param_spec_boolean ("silent", "Silent", "Don't produce messages",
148 FALSE, G_PARAM_READWRITE));
149 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SCHED,
150 g_param_spec_enum ("sched", "Scheduling",
151 "The type of scheduling this element should use",
152 GST_TYPE_AGGREGATOR_SCHED, AGGREGATOR_CHAIN, G_PARAM_READWRITE));
153 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_LAST_MESSAGE,
154 g_param_spec_string ("last_message", "Last message",
155 "The current state of the element", NULL, G_PARAM_READABLE));
157 gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_aggregator_finalize);
159 gstelement_class->request_new_pad =
160 GST_DEBUG_FUNCPTR (gst_aggregator_request_new_pad);
164 gst_aggregator_init (GstAggregator * aggregator, GstAggregatorClass * g_class)
167 gst_pad_new_from_template (gst_static_pad_template_get (&srctemplate),
169 gst_pad_set_getcaps_function (aggregator->srcpad, gst_pad_proxy_getcaps);
170 gst_element_add_pad (GST_ELEMENT (aggregator), aggregator->srcpad);
172 aggregator->numsinkpads = 0;
173 aggregator->sinkpads = NULL;
174 aggregator->silent = FALSE;
175 aggregator->sched = AGGREGATOR_LOOP;
176 aggregator->last_message = NULL;
178 gst_aggregator_update_functions (aggregator);
182 gst_aggregator_request_new_pad (GstElement * element, GstPadTemplate * templ,
183 const gchar * unused)
187 GstAggregator *aggregator;
189 g_return_val_if_fail (GST_IS_AGGREGATOR (element), NULL);
191 if (templ->direction != GST_PAD_SINK) {
192 g_warning ("gstaggregator: request new pad that is not a sink pad\n");
196 aggregator = GST_AGGREGATOR (element);
198 name = g_strdup_printf ("sink%d", aggregator->numsinkpads);
200 sinkpad = gst_pad_new_from_template (templ, name);
203 if (!AGGREGATOR_IS_LOOP_BASED (aggregator)) {
204 gst_pad_set_chain_function (sinkpad, gst_aggregator_chain);
206 gst_pad_set_getcaps_function (sinkpad, gst_pad_proxy_getcaps);
207 gst_element_add_pad (GST_ELEMENT (aggregator), sinkpad);
209 aggregator->sinkpads = g_list_prepend (aggregator->sinkpads, sinkpad);
210 aggregator->numsinkpads++;
216 gst_aggregator_update_functions (GstAggregator * aggregator)
220 if (AGGREGATOR_IS_LOOP_BASED (aggregator)) {
221 gst_element_set_loop_function (GST_ELEMENT (aggregator),
222 GST_DEBUG_FUNCPTR (gst_aggregator_loop));
224 gst_element_set_loop_function (GST_ELEMENT (aggregator), NULL);
227 pads = aggregator->sinkpads;
229 GstPad *pad = GST_PAD (pads->data);
231 if (AGGREGATOR_IS_LOOP_BASED (aggregator)) {
232 gst_pad_set_get_function (pad, NULL);
234 gst_element_set_loop_function (GST_ELEMENT (aggregator), NULL);
236 pads = g_list_next (pads);
241 gst_aggregator_set_property (GObject * object, guint prop_id,
242 const GValue * value, GParamSpec * pspec)
244 GstAggregator *aggregator;
246 g_return_if_fail (GST_IS_AGGREGATOR (object));
248 aggregator = GST_AGGREGATOR (object);
252 aggregator->silent = g_value_get_boolean (value);
255 aggregator->sched = g_value_get_enum (value);
256 gst_aggregator_update_functions (aggregator);
264 gst_aggregator_get_property (GObject * object, guint prop_id, GValue * value,
267 GstAggregator *aggregator;
269 g_return_if_fail (GST_IS_AGGREGATOR (object));
271 aggregator = GST_AGGREGATOR (object);
275 g_value_set_int (value, aggregator->numsinkpads);
278 g_value_set_boolean (value, aggregator->silent);
281 g_value_set_enum (value, aggregator->sched);
283 case ARG_LAST_MESSAGE:
284 g_value_set_string (value, aggregator->last_message);
292 gst_aggregator_push (GstAggregator * aggregator, GstPad * pad, GstBuffer * buf,
295 if (!aggregator->silent) {
296 g_free (aggregator->last_message);
298 aggregator->last_message =
299 g_strdup_printf ("%10.10s ******* (%s:%s)a (%d bytes, %"
300 G_GUINT64_FORMAT ")", debug, GST_DEBUG_PAD_NAME (pad),
301 GST_BUFFER_SIZE (buf), GST_BUFFER_TIMESTAMP (buf));
303 g_object_notify (G_OBJECT (aggregator), "last_message");
306 gst_pad_push (aggregator->srcpad, GST_DATA (buf));
310 gst_aggregator_loop (GstElement * element)
312 GstAggregator *aggregator;
316 aggregator = GST_AGGREGATOR (element);
318 if (aggregator->sched == AGGREGATOR_LOOP) {
319 GList *pads = aggregator->sinkpads;
321 /* we'll loop over all pads and try to pull from all
324 GstPad *pad = GST_PAD (pads->data);
326 pads = g_list_next (pads);
328 /* we need to check is the pad is usable. IS_USABLE will check
329 * if the pad is linked, if it is enabled (the element is
330 * playing and the app didn't gst_pad_set_enabled (pad, FALSE))
331 * and that the peer pad is also enabled.
333 if (GST_PAD_IS_USABLE (pad)) {
334 buf = GST_BUFFER (gst_pad_pull (pad));
337 /* then push it forward */
338 gst_aggregator_push (aggregator, pad, buf, debug);
342 if (aggregator->sched == AGGREGATOR_LOOP_SELECT) {
345 debug = "loop_select";
347 buf = GST_BUFFER (gst_pad_collectv (&pad, aggregator->sinkpads));
349 gst_aggregator_push (aggregator, pad, buf, debug);
351 g_assert_not_reached ();
357 * gst_aggregator_chain:
358 * @pad: the pad to follow
359 * @buf: the buffer to pass
361 * Chain a buffer on a pad.
364 gst_aggregator_chain (GstPad * pad, GstData * _data)
366 GstBuffer *buf = GST_BUFFER (_data);
367 GstAggregator *aggregator;
369 g_return_if_fail (pad != NULL);
370 g_return_if_fail (GST_IS_PAD (pad));
371 g_return_if_fail (buf != NULL);
373 aggregator = GST_AGGREGATOR (gst_pad_get_parent (pad));
374 /* gst_trace_add_entry (NULL, 0, buf, "aggregator buffer");*/
376 gst_aggregator_push (aggregator, pad, buf, "chain");