gst/elements/gstaggregator.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *
   5  * gstaggregator.c: Aggregator element, N in 1 out
   6  *
   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.
  11  *
  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.
  16  *
  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.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #endif
  26
  27 #include "gstaggregator.h"
  28
  29 GST_DEBUG_CATEGORY_STATIC (gst_aggregator_debug);
  30 #define GST_CAT_DEFAULT gst_aggregator_debug
  31
  32 GstElementDetails gst_aggregator_details = GST_ELEMENT_DETAILS (
  33   "Aggregator pipe fitting",
  34   "Generic",
  35   "N-to-1 pipe fitting",
  36   "Wim Taymans <wim.taymans@chello.be>"
  37 );
  38
  39 /* Aggregator signals and args */
  40 enum {
  41   /* FILL ME */
  42   LAST_SIGNAL
  43 };
  44
  45 enum {
  46   ARG_0,
  47   ARG_NUM_PADS,
  48   ARG_SILENT,
  49   ARG_SCHED,
  50   ARG_LAST_MESSAGE,
  51   /* FILL ME */
  52 };
  53
  54 GstStaticPadTemplate aggregator_src_template = GST_STATIC_PAD_TEMPLATE (
  55   "sink%d",
  56   GST_PAD_SINK,
  57   GST_PAD_REQUEST,
  58   GST_STATIC_CAPS_ANY
  59 );
  60
  61 #define GST_TYPE_AGGREGATOR_SCHED (gst_aggregator_sched_get_type())
  62 static GType
  63 gst_aggregator_sched_get_type (void)
  64 {
  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"},
  70     {0, NULL, NULL},
  71   };
  72   if (!aggregator_sched_type) {
  73     aggregator_sched_type = g_enum_register_static ("GstAggregatorSched", aggregator_sched);
  74   }
  75   return aggregator_sched_type;
  76 }
  77
  78 #define AGGREGATOR_IS_LOOP_BASED(ag)    ((ag)->sched != AGGREGATOR_CHAIN)
  79
  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);
  83
  84 static GstPad*  gst_aggregator_request_new_pad  (GstElement *element, GstPadTemplate *temp, const
  85                                                  gchar *unused);
  86 static void     gst_aggregator_update_functions (GstAggregator *aggregator);
  87
  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);
  92
  93 static void     gst_aggregator_chain            (GstPad *pad, GstData *_data);
  94 static void     gst_aggregator_loop             (GstElement *element);
  95
  96 static GstElementClass *parent_class = NULL;
  97 /*static guint gst_aggregator_signals[LAST_SIGNAL] = { 0 };*/
  98
  99 GType
 100 gst_aggregator_get_type (void)
 101 {
 102   static GType aggregator_type = 0;
 103
 104   if (!aggregator_type) {
 105     static const GTypeInfo aggregator_info = {
 106       sizeof(GstAggregatorClass),
 107       gst_aggregator_base_init,
 108       NULL,
 109       (GClassInitFunc)gst_aggregator_class_init,
 110       NULL,
 111       NULL,
 112       sizeof(GstAggregator),
 113       0,
 114       (GInstanceInitFunc)gst_aggregator_init,
 115     };
 116     aggregator_type = g_type_register_static (GST_TYPE_ELEMENT, "GstAggregator", &aggregator_info, 0);
 117
 118     GST_DEBUG_CATEGORY_INIT (gst_aggregator_debug, "aggregator", 0, "aggregator element");
 119   }
 120   return aggregator_type;
 121 }
 122
 123 static void
 124 gst_aggregator_base_init (gpointer g_class)
 125 {
 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);
 130 }
 131 static void
 132 gst_aggregator_class_init (GstAggregatorClass *klass)
 133 {
 134   GObjectClass *gobject_class;
 135   GstElementClass *gstelement_class;
 136
 137   gobject_class = (GObjectClass*) klass;
 138   gstelement_class = (GstElementClass*) klass;
 139
 140   parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
 141
 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));
 154
 155   gobject_class->set_property = GST_DEBUG_FUNCPTR(gst_aggregator_set_property);
 156   gobject_class->get_property = GST_DEBUG_FUNCPTR(gst_aggregator_get_property);
 157
 158   gstelement_class->request_new_pad = GST_DEBUG_FUNCPTR(gst_aggregator_request_new_pad);
 159 }
 160
 161 static void
 162 gst_aggregator_init (GstAggregator *aggregator)
 163 {
 164   aggregator->srcpad = gst_pad_new ("src", GST_PAD_SRC);
 165   gst_pad_set_getcaps_function (aggregator->srcpad, gst_pad_proxy_getcaps);
 166   gst_element_add_pad (GST_ELEMENT (aggregator), aggregator->srcpad);
 167
 168   aggregator->numsinkpads = 0;
 169   aggregator->sinkpads = NULL;
 170   aggregator->silent = FALSE;
 171   aggregator->sched = AGGREGATOR_LOOP;
 172
 173   gst_aggregator_update_functions (aggregator);
 174 }
 175
 176 static GstPad*
 177 gst_aggregator_request_new_pad (GstElement *element, GstPadTemplate *templ, const gchar *unused)
 178 {
 179   gchar *name;
 180   GstPad *sinkpad;
 181   GstAggregator *aggregator;
 182
 183   g_return_val_if_fail (GST_IS_AGGREGATOR (element), NULL);
 184
 185   if (templ->direction != GST_PAD_SINK) {
 186     g_warning ("gstaggregator: request new pad that is not a sink pad\n");
 187     return NULL;
 188   }
 189
 190   aggregator = GST_AGGREGATOR (element);
 191
 192   name = g_strdup_printf ("sink%d",aggregator->numsinkpads);
 193
 194   sinkpad = gst_pad_new_from_template (templ, name);
 195   g_free (name);
 196
 197   if (!AGGREGATOR_IS_LOOP_BASED (aggregator)) {
 198     gst_pad_set_chain_function (sinkpad, gst_aggregator_chain);
 199   }
 200   gst_pad_set_getcaps_function (sinkpad, gst_pad_proxy_getcaps);
 201   gst_element_add_pad (GST_ELEMENT (aggregator), sinkpad);
 202
 203   aggregator->sinkpads = g_list_prepend (aggregator->sinkpads, sinkpad);
 204   aggregator->numsinkpads++;
 205
 206   return sinkpad;
 207 }
 208
 209 static void
 210 gst_aggregator_update_functions (GstAggregator *aggregator)
 211 {
 212   GList *pads;
 213
 214   if (AGGREGATOR_IS_LOOP_BASED (aggregator)) {
 215     gst_element_set_loop_function (GST_ELEMENT (aggregator), GST_DEBUG_FUNCPTR (gst_aggregator_loop));
 216   }
 217   else {
 218     gst_element_set_loop_function (GST_ELEMENT (aggregator), NULL);
 219   }
 220
 221   pads = aggregator->sinkpads;
 222   while (pads) {
 223     GstPad *pad = GST_PAD (pads->data);
 224
 225     if (AGGREGATOR_IS_LOOP_BASED (aggregator)) {
 226       gst_pad_set_get_function (pad, NULL);
 227     }
 228     else {
 229       gst_element_set_loop_function (GST_ELEMENT (aggregator), NULL);
 230     }
 231     pads = g_list_next (pads);
 232   }
 233 }
 234
 235 static void
 236 gst_aggregator_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
 237 {
 238   GstAggregator *aggregator;
 239
 240   /* it's not null if we got it, but it might not be ours */
 241   g_return_if_fail (GST_IS_AGGREGATOR (object));
 242
 243   aggregator = GST_AGGREGATOR (object);
 244
 245   switch (prop_id) {
 246     case ARG_SILENT:
 247       aggregator->silent = g_value_get_boolean (value);
 248       break;
 249     case ARG_SCHED:
 250       aggregator->sched = g_value_get_enum (value);
 251       gst_aggregator_update_functions (aggregator);
 252       break;
 253     default:
 254       break;
 255   }
 256 }
 257
 258 static void
 259 gst_aggregator_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 260 {
 261   GstAggregator *aggregator;
 262
 263   /* it's not null if we got it, but it might not be ours */
 264   g_return_if_fail (GST_IS_AGGREGATOR (object));
 265
 266   aggregator = GST_AGGREGATOR (object);
 267
 268   switch (prop_id) {
 269     case ARG_NUM_PADS:
 270       g_value_set_int (value, aggregator->numsinkpads);
 271       break;
 272     case ARG_SILENT:
 273       g_value_set_boolean (value, aggregator->silent);
 274       break;
 275     case ARG_SCHED:
 276       g_value_set_enum (value, aggregator->sched);
 277       break;
 278     case ARG_LAST_MESSAGE:
 279       g_value_set_string (value, aggregator->last_message);
 280       break;
 281     default:
 282       break;
 283   }
 284 }
 285
 286 static void
 287 gst_aggregator_push (GstAggregator *aggregator, GstPad *pad, GstBuffer *buf, guchar *debug)
 288 {
 289   if (!aggregator->silent) {
 290     g_free (aggregator->last_message);
 291
 292     aggregator->last_message = g_strdup_printf ("%10.10s ******* (%s:%s)a (%d bytes, %"
 293                                                 G_GUINT64_FORMAT ")",
 294             debug, GST_DEBUG_PAD_NAME (pad), GST_BUFFER_SIZE (buf), GST_BUFFER_TIMESTAMP (buf));
 295
 296     g_object_notify (G_OBJECT (aggregator), "last_message");
 297   }
 298
 299   gst_pad_push (aggregator->srcpad, GST_DATA (buf));
 300 }
 301
 302 static void
 303 gst_aggregator_loop (GstElement *element)
 304 {
 305   GstAggregator *aggregator;
 306   GstBuffer *buf;
 307   guchar *debug;
 308
 309   aggregator = GST_AGGREGATOR (element);
 310
 311   if (aggregator->sched == AGGREGATOR_LOOP) {
 312     GList *pads = aggregator->sinkpads;
 313
 314     /* we'll loop over all pads and try to pull from all
 315      * active ones */
 316     while (pads) {
 317       GstPad *pad = GST_PAD (pads->data);
 318       pads = g_list_next (pads);
 319
 320       /* we need to check is the pad is usable. IS_USABLE will check
 321        * if the pad is linked, if it is enabled (the element is
 322        * playing and the app didn't gst_pad_set_enabled (pad, FALSE))
 323        * and that the peer pad is also enabled.
 324        */
 325       if (GST_PAD_IS_USABLE (pad)) {
 326         buf = GST_BUFFER (gst_pad_pull (pad));
 327         debug = "loop";
 328
 329         /* then push it forward */
 330         gst_aggregator_push (aggregator, pad, buf, debug);
 331       }
 332     }
 333   }
 334   else {
 335     if (aggregator->sched == AGGREGATOR_LOOP_SELECT) {
 336       GstPad *pad;
 337
 338       debug = "loop_select";
 339
 340       pad = gst_pad_selectv (aggregator->sinkpads);
 341       buf = GST_BUFFER (gst_pad_pull (pad));
 342
 343       gst_aggregator_push (aggregator, pad, buf, debug);
 344     }
 345     else {
 346       g_assert_not_reached ();
 347     }
 348   }
 349 }
 350
 351 /**
 352  * gst_aggregator_chain:
 353  * @pad: the pad to follow
 354  * @buf: the buffer to pass
 355  *
 356  * Chain a buffer on a pad.
 357  */
 358 static void
 359 gst_aggregator_chain (GstPad *pad, GstData *_data)
 360 {
 361   GstBuffer *buf = GST_BUFFER (_data);
 362   GstAggregator *aggregator;
 363
 364   g_return_if_fail (pad != NULL);
 365   g_return_if_fail (GST_IS_PAD (pad));
 366   g_return_if_fail (buf != NULL);
 367
 368   aggregator = GST_AGGREGATOR (gst_pad_get_parent (pad));
 369 /*  gst_trace_add_entry (NULL, 0, buf, "aggregator buffer");*/
 370
 371   gst_aggregator_push (aggregator, pad, buf, "chain");
 372 }
 373