gst/gstpadtemplate.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstpadtemplate.c: Templates for pad creation
   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., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 /**
  24  * SECTION:gstpadtemplate
  25  * @short_description: Describe the media type of a pad.
  26  * @see_also: #GstPad, #GstElementFactory
  27  *
  28  * Padtemplates describe the possible media types a pad or an elementfactory can
  29  * handle. This allows for both inspection of handled types before loading the
  30  * element plugin as well as identifying pads on elements that are not yet
  31  * created (request or sometimes pads).
  32  *
  33  * Pad and PadTemplates have #GstCaps attached to it to describe the media type
  34  * they are capable of dealing with. gst_pad_template_get_caps() or
  35  * GST_PAD_TEMPLATE_CAPS() are used to get the caps of a padtemplate. It's not
  36  * possible to modify the caps of a padtemplate after creation.
  37  *
  38  * PadTemplates have a #GstPadPresence property which identifies the lifetime
  39  * of the pad and that can be retrieved with GST_PAD_TEMPLATE_PRESENCE(). Also
  40  * the direction of the pad can be retrieved from the #GstPadTemplate with
  41  * GST_PAD_TEMPLATE_DIRECTION().
  42  *
  43  * The GST_PAD_TEMPLATE_NAME_TEMPLATE () is important for GST_PAD_REQUEST pads
  44  * because it has to be used as the name in the gst_element_get_request_pad()
  45  * call to instantiate a pad from this template.
  46  *
  47  * Padtemplates can be created with gst_pad_template_new() or with
  48  * gst_static_pad_template_get (), which creates a #GstPadTemplate from a
  49  * #GstStaticPadTemplate that can be filled with the
  50  * convenient GST_STATIC_PAD_TEMPLATE() macro.
  51  *
  52  * A padtemplate can be used to create a pad (see gst_pad_new_from_template()
  53  * or gst_pad_new_from_static_template ()) or to add to an element class
  54  * (see gst_element_class_add_pad_template ()).
  55  *
  56  * The following code example shows the code to create a pad from a padtemplate.
  57  * |[
  58  *   GstStaticPadTemplate my_template =
  59  *   GST_STATIC_PAD_TEMPLATE (
  60  *     "sink",          // the name of the pad
  61  *     GST_PAD_SINK,    // the direction of the pad
  62  *     GST_PAD_ALWAYS,  // when this pad will be present
  63  *     GST_STATIC_CAPS (        // the capabilities of the padtemplate
  64  *       "audio/x-raw, "
  65  *         "channels = (int) [ 1, 6 ]"
  66  *     )
  67  *   );
  68  *   void
  69  *   my_method (void)
  70  *   {
  71  *     GstPad *pad;
  72  *     pad = gst_pad_new_from_static_template (&amp;my_template, "sink");
  73  *     ...
  74  *   }
  75  * ]|
  76  *
  77  * The following example shows you how to add the padtemplate to an
  78  * element class, this is usually done in the class_init of the class:
  79  * |[
  80  *   static void
  81  *   my_element_class_init (GstMyElementClass *klass)
  82  *   {
  83  *     GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
  84  *
  85  *     gst_element_class_add_pad_template (gstelement_class,
  86  *         gst_static_pad_template_get (&amp;my_template));
  87  *   }
  88  * ]|
  89  */
  90
  91 #include "gst_private.h"
  92
  93 #include "gstpad.h"
  94 #include "gstpadtemplate.h"
  95 #include "gstenumtypes.h"
  96 #include "gstutils.h"
  97 #include "gstinfo.h"
  98 #include "gsterror.h"
  99 #include "gstvalue.h"
 100
 101 #define GST_CAT_DEFAULT GST_CAT_PADS
 102
 103 enum
 104 {
 105   PROP_NAME_TEMPLATE = 1,
 106   PROP_DIRECTION,
 107   PROP_PRESENCE,
 108   PROP_CAPS
 109 };
 110
 111 enum
 112 {
 113   TEMPL_PAD_CREATED,
 114   /* FILL ME */
 115   LAST_SIGNAL
 116 };
 117
 118 static guint gst_pad_template_signals[LAST_SIGNAL] = { 0 };
 119
 120 static void gst_pad_template_dispose (GObject * object);
 121 static void gst_pad_template_set_property (GObject * object, guint prop_id,
 122     const GValue * value, GParamSpec * pspec);
 123 static void gst_pad_template_get_property (GObject * object, guint prop_id,
 124     GValue * value, GParamSpec * pspec);
 125
 126 #define gst_pad_template_parent_class parent_class
 127 G_DEFINE_TYPE (GstPadTemplate, gst_pad_template, GST_TYPE_OBJECT);
 128
 129 static void
 130 gst_pad_template_class_init (GstPadTemplateClass * klass)
 131 {
 132   GObjectClass *gobject_class;
 133   GstObjectClass *gstobject_class;
 134
 135   gobject_class = (GObjectClass *) klass;
 136   gstobject_class = (GstObjectClass *) klass;
 137
 138   /**
 139    * GstPadTemplate::pad-created:
 140    * @pad_template: the object which received the signal.
 141    * @pad: the pad that was created.
 142    *
 143    * This signal is fired when an element creates a pad from this template.
 144    */
 145   gst_pad_template_signals[TEMPL_PAD_CREATED] =
 146       g_signal_new ("pad-created", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 147       G_STRUCT_OFFSET (GstPadTemplateClass, pad_created),
 148       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
 149
 150   gobject_class->dispose = gst_pad_template_dispose;
 151
 152   gobject_class->get_property = gst_pad_template_get_property;
 153   gobject_class->set_property = gst_pad_template_set_property;
 154
 155   /**
 156    * GstPadTemplate:name-template:
 157    *
 158    * The name template of the pad template.
 159    */
 160   g_object_class_install_property (gobject_class, PROP_NAME_TEMPLATE,
 161       g_param_spec_string ("name-template", "Name template",
 162           "The name template of the pad template", NULL,
 163           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 164
 165   /**
 166    * GstPadTemplate:direction:
 167    *
 168    * The direction of the pad described by the pad template.
 169    */
 170   g_object_class_install_property (gobject_class, PROP_DIRECTION,
 171       g_param_spec_enum ("direction", "Direction",
 172           "The direction of the pad described by the pad template",
 173           GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
 174           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 175
 176   /**
 177    * GstPadTemplate:presence:
 178    *
 179    * When the pad described by the pad template will become available.
 180    */
 181   g_object_class_install_property (gobject_class, PROP_PRESENCE,
 182       g_param_spec_enum ("presence", "Presence",
 183           "When the pad described by the pad template will become available",
 184           GST_TYPE_PAD_PRESENCE, GST_PAD_ALWAYS,
 185           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 186
 187   /**
 188    * GstPadTemplate:caps:
 189    *
 190    * The capabilities of the pad described by the pad template.
 191    */
 192   g_object_class_install_property (gobject_class, PROP_CAPS,
 193       g_param_spec_boxed ("caps", "Caps",
 194           "The capabilities of the pad described by the pad template",
 195           GST_TYPE_CAPS,
 196           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 197
 198   gstobject_class->path_string_separator = "*";
 199 }
 200
 201 static void
 202 gst_pad_template_init (GstPadTemplate * templ)
 203 {
 204 }
 205
 206 static void
 207 gst_pad_template_dispose (GObject * object)
 208 {
 209   GstPadTemplate *templ = GST_PAD_TEMPLATE (object);
 210
 211   g_free (GST_PAD_TEMPLATE_NAME_TEMPLATE (templ));
 212   if (GST_PAD_TEMPLATE_CAPS (templ)) {
 213     gst_caps_unref (GST_PAD_TEMPLATE_CAPS (templ));
 214   }
 215
 216   G_OBJECT_CLASS (parent_class)->dispose (object);
 217 }
 218
 219 /* ALWAYS padtemplates cannot have conversion specifications (like src_%d),
 220  * since it doesn't make sense.
 221  * SOMETIMES padtemplates can do whatever they want, they are provided by the
 222  * element.
 223  * REQUEST padtemplates can be reverse-parsed (the user asks for 'sink1', the
 224  * 'sink%d' template is automatically selected), so we need to restrict their
 225  * naming.
 226  */
 227 static gboolean
 228 name_is_valid (const gchar * name, GstPadPresence presence)
 229 {
 230   const gchar *str;
 231
 232   if (presence == GST_PAD_ALWAYS) {
 233     if (strchr (name, '%')) {
 234       g_warning ("invalid name template %s: conversion specifications are not"
 235           " allowed for GST_PAD_ALWAYS padtemplates", name);
 236       return FALSE;
 237     }
 238   } else if (presence == GST_PAD_REQUEST) {
 239     if ((str = strchr (name, '%')) && strchr (str + 1, '%')) {
 240       g_warning ("invalid name template %s: only one conversion specification"
 241           " allowed in GST_PAD_REQUEST padtemplate", name);
 242       return FALSE;
 243     }
 244     if (str && (*(str + 1) != 's' && *(str + 1) != 'd' && *(str + 1) != 'u')) {
 245       g_warning ("invalid name template %s: conversion specification must be of"
 246           " type '%%d', '%%u' or '%%s' for GST_PAD_REQUEST padtemplate", name);
 247       return FALSE;
 248     }
 249     if (str && (*(str + 2) != '\0')) {
 250       g_warning ("invalid name template %s: conversion specification must"
 251           " appear at the end of the GST_PAD_REQUEST padtemplate name", name);
 252       return FALSE;
 253     }
 254   }
 255
 256   return TRUE;
 257 }
 258
 259 G_DEFINE_POINTER_TYPE (GstStaticPadTemplate, gst_static_pad_template);
 260
 261 /**
 262  * gst_static_pad_template_get:
 263  * @pad_template: the static pad template
 264  *
 265  * Converts a #GstStaticPadTemplate into a #GstPadTemplate.
 266  *
 267  * Returns: (transfer full): a new #GstPadTemplate.
 268  */
 269 /* FIXME0.11: rename to gst_pad_template_new_from_static_pad_template() */
 270 GstPadTemplate *
 271 gst_static_pad_template_get (GstStaticPadTemplate * pad_template)
 272 {
 273   GstPadTemplate *new;
 274   GstCaps *caps;
 275
 276   if (!name_is_valid (pad_template->name_template, pad_template->presence))
 277     return NULL;
 278
 279   caps = gst_static_caps_get (&pad_template->static_caps);
 280
 281   new = g_object_new (gst_pad_template_get_type (),
 282       "name", pad_template->name_template,
 283       "name-template", pad_template->name_template,
 284       "direction", pad_template->direction,
 285       "presence", pad_template->presence, "caps", caps, NULL);
 286
 287   gst_caps_unref (caps);
 288
 289   return new;
 290 }
 291
 292 /**
 293  * gst_pad_template_new:
 294  * @name_template: the name template.
 295  * @direction: the #GstPadDirection of the template.
 296  * @presence: the #GstPadPresence of the pad.
 297  * @caps: (transfer none): a #GstCaps set for the template.
 298  *
 299  * Creates a new pad template with a name according to the given template
 300  * and with the given arguments.
 301  *
 302  * Returns: (transfer floating): a new #GstPadTemplate.
 303  */
 304 GstPadTemplate *
 305 gst_pad_template_new (const gchar * name_template,
 306     GstPadDirection direction, GstPadPresence presence, GstCaps * caps)
 307 {
 308   GstPadTemplate *new;
 309
 310   g_return_val_if_fail (name_template != NULL, NULL);
 311   g_return_val_if_fail (caps != NULL, NULL);
 312   g_return_val_if_fail (direction == GST_PAD_SRC
 313       || direction == GST_PAD_SINK, NULL);
 314   g_return_val_if_fail (presence == GST_PAD_ALWAYS
 315       || presence == GST_PAD_SOMETIMES || presence == GST_PAD_REQUEST, NULL);
 316
 317   if (!name_is_valid (name_template, presence)) {
 318     return NULL;
 319   }
 320
 321   new = g_object_new (gst_pad_template_get_type (),
 322       "name", name_template, "name-template", name_template,
 323       "direction", direction, "presence", presence, "caps", caps, NULL);
 324
 325   return new;
 326 }
 327
 328 /**
 329  * gst_static_pad_template_get_caps:
 330  * @templ: a #GstStaticPadTemplate to get capabilities of.
 331  *
 332  * Gets the capabilities of the static pad template.
 333  *
 334  * Returns: (transfer full): the #GstCaps of the static pad template.
 335  * Unref after usage. Since the core holds an additional
 336  * ref to the returned caps, use gst_caps_make_writable()
 337  * on the returned caps to modify it.
 338  */
 339 GstCaps *
 340 gst_static_pad_template_get_caps (GstStaticPadTemplate * templ)
 341 {
 342   g_return_val_if_fail (templ, NULL);
 343
 344   return gst_static_caps_get (&templ->static_caps);
 345 }
 346
 347 /**
 348  * gst_pad_template_get_caps:
 349  * @templ: a #GstPadTemplate to get capabilities of.
 350  *
 351  * Gets the capabilities of the pad template.
 352  *
 353  * Returns: (transfer full): the #GstCaps of the pad template.
 354  * Unref after usage.
 355  */
 356 GstCaps *
 357 gst_pad_template_get_caps (GstPadTemplate * templ)
 358 {
 359   GstCaps *caps;
 360   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
 361
 362   caps = GST_PAD_TEMPLATE_CAPS (templ);
 363
 364   return (caps ? gst_caps_ref (caps) : NULL);
 365 }
 366
 367 /**
 368  * gst_pad_template_pad_created:
 369  * @templ: a #GstPadTemplate that has been created
 370  * @pad:   the #GstPad that created it
 371  *
 372  * Emit the pad-created signal for this template when created by this pad.
 373  */
 374 void
 375 gst_pad_template_pad_created (GstPadTemplate * templ, GstPad * pad)
 376 {
 377   g_signal_emit (templ, gst_pad_template_signals[TEMPL_PAD_CREATED], 0, pad);
 378 }
 379
 380 static void
 381 gst_pad_template_set_property (GObject * object, guint prop_id,
 382     const GValue * value, GParamSpec * pspec)
 383 {
 384   /* these properties are all construct-only */
 385   switch (prop_id) {
 386     case PROP_NAME_TEMPLATE:
 387       GST_PAD_TEMPLATE_NAME_TEMPLATE (object) = g_value_dup_string (value);
 388       break;
 389     case PROP_DIRECTION:
 390       GST_PAD_TEMPLATE_DIRECTION (object) =
 391           (GstPadDirection) g_value_get_enum (value);
 392       break;
 393     case PROP_PRESENCE:
 394       GST_PAD_TEMPLATE_PRESENCE (object) =
 395           (GstPadPresence) g_value_get_enum (value);
 396       break;
 397     case PROP_CAPS:
 398       GST_PAD_TEMPLATE_CAPS (object) = g_value_dup_boxed (value);
 399       break;
 400     default:
 401       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 402       break;
 403   }
 404 }
 405
 406 static void
 407 gst_pad_template_get_property (GObject * object, guint prop_id, GValue * value,
 408     GParamSpec * pspec)
 409 {
 410   /* these properties are all construct-only */
 411   switch (prop_id) {
 412     case PROP_NAME_TEMPLATE:
 413       g_value_set_string (value, GST_PAD_TEMPLATE_NAME_TEMPLATE (object));
 414       break;
 415     case PROP_DIRECTION:
 416       g_value_set_enum (value, GST_PAD_TEMPLATE_DIRECTION (object));
 417       break;
 418     case PROP_PRESENCE:
 419       g_value_set_enum (value, GST_PAD_TEMPLATE_PRESENCE (object));
 420       break;
 421     case PROP_CAPS:
 422       g_value_set_boxed (value, GST_PAD_TEMPLATE_CAPS (object));
 423       break;
 424     default:
 425       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 426       break;
 427   }
 428 }