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_static_pad_template ()).
  55  *
  56  * The following code example shows the code to create a pad from a padtemplate.
  57  * |[<!-- language="C" -->
  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  * |[<!-- language="C" -->
  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_static_pad_template (gstelement_class, &amp;my_template);
  86  *   }
  87  * ]|
  88  */
  89
  90 #include "gst_private.h"
  91
  92 #include "gstpad.h"
  93 #include "gstpadtemplate.h"
  94 #include "gstenumtypes.h"
  95 #include "gstutils.h"
  96 #include "gstinfo.h"
  97 #include "gsterror.h"
  98 #include "gstvalue.h"
  99
 100 #define GST_CAT_DEFAULT GST_CAT_PADS
 101
 102 enum
 103 {
 104   PROP_NAME_TEMPLATE = 1,
 105   PROP_DIRECTION,
 106   PROP_PRESENCE,
 107   PROP_CAPS
 108 };
 109
 110 enum
 111 {
 112   TEMPL_PAD_CREATED,
 113   /* FILL ME */
 114   LAST_SIGNAL
 115 };
 116
 117 static guint gst_pad_template_signals[LAST_SIGNAL] = { 0 };
 118
 119 static void gst_pad_template_dispose (GObject * object);
 120 static void gst_pad_template_set_property (GObject * object, guint prop_id,
 121     const GValue * value, GParamSpec * pspec);
 122 static void gst_pad_template_get_property (GObject * object, guint prop_id,
 123     GValue * value, GParamSpec * pspec);
 124
 125 #define gst_pad_template_parent_class parent_class
 126 G_DEFINE_TYPE (GstPadTemplate, gst_pad_template, GST_TYPE_OBJECT);
 127
 128 static void
 129 gst_pad_template_class_init (GstPadTemplateClass * klass)
 130 {
 131   GObjectClass *gobject_class;
 132   GstObjectClass *gstobject_class;
 133
 134   gobject_class = (GObjectClass *) klass;
 135   gstobject_class = (GstObjectClass *) klass;
 136
 137   /**
 138    * GstPadTemplate::pad-created:
 139    * @pad_template: the object which received the signal.
 140    * @pad: the pad that was created.
 141    *
 142    * This signal is fired when an element creates a pad from this template.
 143    */
 144   gst_pad_template_signals[TEMPL_PAD_CREATED] =
 145       g_signal_new ("pad-created", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 146       G_STRUCT_OFFSET (GstPadTemplateClass, pad_created),
 147       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
 148
 149   gobject_class->dispose = gst_pad_template_dispose;
 150
 151   gobject_class->get_property = gst_pad_template_get_property;
 152   gobject_class->set_property = gst_pad_template_set_property;
 153
 154   /**
 155    * GstPadTemplate:name-template:
 156    *
 157    * The name template of the pad template.
 158    */
 159   g_object_class_install_property (gobject_class, PROP_NAME_TEMPLATE,
 160       g_param_spec_string ("name-template", "Name template",
 161           "The name template of the pad template", NULL,
 162           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 163
 164   /**
 165    * GstPadTemplate:direction:
 166    *
 167    * The direction of the pad described by the pad template.
 168    */
 169   g_object_class_install_property (gobject_class, PROP_DIRECTION,
 170       g_param_spec_enum ("direction", "Direction",
 171           "The direction of the pad described by the pad template",
 172           GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
 173           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 174
 175   /**
 176    * GstPadTemplate:presence:
 177    *
 178    * When the pad described by the pad template will become available.
 179    */
 180   g_object_class_install_property (gobject_class, PROP_PRESENCE,
 181       g_param_spec_enum ("presence", "Presence",
 182           "When the pad described by the pad template will become available",
 183           GST_TYPE_PAD_PRESENCE, GST_PAD_ALWAYS,
 184           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 185
 186   /**
 187    * GstPadTemplate:caps:
 188    *
 189    * The capabilities of the pad described by the pad template.
 190    */
 191   g_object_class_install_property (gobject_class, PROP_CAPS,
 192       g_param_spec_boxed ("caps", "Caps",
 193           "The capabilities of the pad described by the pad template",
 194           GST_TYPE_CAPS,
 195           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 196
 197   gstobject_class->path_string_separator = "*";
 198 }
 199
 200 static void
 201 gst_pad_template_init (GstPadTemplate * templ)
 202 {
 203 }
 204
 205 static void
 206 gst_pad_template_dispose (GObject * object)
 207 {
 208   GstPadTemplate *templ = GST_PAD_TEMPLATE (object);
 209
 210   g_free (GST_PAD_TEMPLATE_NAME_TEMPLATE (templ));
 211   if (GST_PAD_TEMPLATE_CAPS (templ)) {
 212     gst_caps_unref (GST_PAD_TEMPLATE_CAPS (templ));
 213   }
 214
 215   G_OBJECT_CLASS (parent_class)->dispose (object);
 216 }
 217
 218 /* ALWAYS padtemplates cannot have conversion specifications (like src_%d),
 219  * since it doesn't make sense.
 220  * SOMETIMES padtemplates can do whatever they want, they are provided by the
 221  * element.
 222  * REQUEST padtemplates can be reverse-parsed (the user asks for 'sink1', the
 223  * 'sink%d' template is automatically selected), so we need to restrict their
 224  * naming.
 225  */
 226 static gboolean
 227 name_is_valid (const gchar * name, GstPadPresence presence)
 228 {
 229   const gchar *str;
 230
 231   if (presence == GST_PAD_ALWAYS) {
 232     if (strchr (name, '%')) {
 233       g_warning ("invalid name template %s: conversion specifications are not"
 234           " allowed for GST_PAD_ALWAYS padtemplates", name);
 235       return FALSE;
 236     }
 237   } else if (presence == GST_PAD_REQUEST) {
 238     if ((str = strchr (name, '%')) && strchr (str + 1, '%')) {
 239       g_warning ("invalid name template %s: only one conversion specification"
 240           " allowed in GST_PAD_REQUEST padtemplate", name);
 241       return FALSE;
 242     }
 243     if (str && (*(str + 1) != 's' && *(str + 1) != 'd' && *(str + 1) != 'u')) {
 244       g_warning ("invalid name template %s: conversion specification must be of"
 245           " type '%%d', '%%u' or '%%s' for GST_PAD_REQUEST padtemplate", name);
 246       return FALSE;
 247     }
 248     if (str && (*(str + 2) != '\0')) {
 249       g_warning ("invalid name template %s: conversion specification must"
 250           " appear at the end of the GST_PAD_REQUEST padtemplate name", name);
 251       return FALSE;
 252     }
 253   }
 254
 255   return TRUE;
 256 }
 257
 258 G_DEFINE_POINTER_TYPE (GstStaticPadTemplate, gst_static_pad_template);
 259
 260 /**
 261  * gst_static_pad_template_get:
 262  * @pad_template: the static pad template
 263  *
 264  * Converts a #GstStaticPadTemplate into a #GstPadTemplate.
 265  *
 266  * Returns: (transfer full): a new #GstPadTemplate.
 267  */
 268 /* FIXME0.11: rename to gst_pad_template_new_from_static_pad_template() */
 269 GstPadTemplate *
 270 gst_static_pad_template_get (GstStaticPadTemplate * pad_template)
 271 {
 272   GstPadTemplate *new;
 273   GstCaps *caps;
 274
 275   if (!name_is_valid (pad_template->name_template, pad_template->presence))
 276     return NULL;
 277
 278   caps = gst_static_caps_get (&pad_template->static_caps);
 279
 280   new = g_object_new (gst_pad_template_get_type (),
 281       "name", pad_template->name_template,
 282       "name-template", pad_template->name_template,
 283       "direction", pad_template->direction,
 284       "presence", pad_template->presence, "caps", caps, NULL);
 285
 286   gst_caps_unref (caps);
 287
 288   return new;
 289 }
 290
 291 /**
 292  * gst_pad_template_new:
 293  * @name_template: the name template.
 294  * @direction: the #GstPadDirection of the template.
 295  * @presence: the #GstPadPresence of the pad.
 296  * @caps: (transfer none): a #GstCaps set for the template.
 297  *
 298  * Creates a new pad template with a name according to the given template
 299  * and with the given arguments.
 300  *
 301  * Returns: (transfer floating): a new #GstPadTemplate.
 302  */
 303 GstPadTemplate *
 304 gst_pad_template_new (const gchar * name_template,
 305     GstPadDirection direction, GstPadPresence presence, GstCaps * caps)
 306 {
 307   GstPadTemplate *new;
 308
 309   g_return_val_if_fail (name_template != NULL, NULL);
 310   g_return_val_if_fail (caps != NULL, NULL);
 311   g_return_val_if_fail (direction == GST_PAD_SRC
 312       || direction == GST_PAD_SINK, NULL);
 313   g_return_val_if_fail (presence == GST_PAD_ALWAYS
 314       || presence == GST_PAD_SOMETIMES || presence == GST_PAD_REQUEST, NULL);
 315
 316   if (!name_is_valid (name_template, presence)) {
 317     return NULL;
 318   }
 319
 320   new = g_object_new (gst_pad_template_get_type (),
 321       "name", name_template, "name-template", name_template,
 322       "direction", direction, "presence", presence, "caps", caps, NULL);
 323
 324   return new;
 325 }
 326
 327 /**
 328  * gst_static_pad_template_get_caps:
 329  * @templ: a #GstStaticPadTemplate to get capabilities of.
 330  *
 331  * Gets the capabilities of the static pad template.
 332  *
 333  * Returns: (transfer full): the #GstCaps of the static pad template.
 334  * Unref after usage. Since the core holds an additional
 335  * ref to the returned caps, use gst_caps_make_writable()
 336  * on the returned caps to modify it.
 337  */
 338 GstCaps *
 339 gst_static_pad_template_get_caps (GstStaticPadTemplate * templ)
 340 {
 341   g_return_val_if_fail (templ, NULL);
 342
 343   return gst_static_caps_get (&templ->static_caps);
 344 }
 345
 346 /**
 347  * gst_pad_template_get_caps:
 348  * @templ: a #GstPadTemplate to get capabilities of.
 349  *
 350  * Gets the capabilities of the pad template.
 351  *
 352  * Returns: (transfer full): the #GstCaps of the pad template.
 353  * Unref after usage.
 354  */
 355 GstCaps *
 356 gst_pad_template_get_caps (GstPadTemplate * templ)
 357 {
 358   GstCaps *caps;
 359   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
 360
 361   caps = GST_PAD_TEMPLATE_CAPS (templ);
 362
 363   return (caps ? gst_caps_ref (caps) : NULL);
 364 }
 365
 366 /**
 367  * gst_pad_template_pad_created:
 368  * @templ: a #GstPadTemplate that has been created
 369  * @pad:   the #GstPad that created it
 370  *
 371  * Emit the pad-created signal for this template when created by this pad.
 372  */
 373 void
 374 gst_pad_template_pad_created (GstPadTemplate * templ, GstPad * pad)
 375 {
 376   g_signal_emit (templ, gst_pad_template_signals[TEMPL_PAD_CREATED], 0, pad);
 377 }
 378
 379 static void
 380 gst_pad_template_set_property (GObject * object, guint prop_id,
 381     const GValue * value, GParamSpec * pspec)
 382 {
 383   /* these properties are all construct-only */
 384   switch (prop_id) {
 385     case PROP_NAME_TEMPLATE:
 386       GST_PAD_TEMPLATE_NAME_TEMPLATE (object) = g_value_dup_string (value);
 387       break;
 388     case PROP_DIRECTION:
 389       GST_PAD_TEMPLATE_DIRECTION (object) =
 390           (GstPadDirection) g_value_get_enum (value);
 391       break;
 392     case PROP_PRESENCE:
 393       GST_PAD_TEMPLATE_PRESENCE (object) =
 394           (GstPadPresence) g_value_get_enum (value);
 395       break;
 396     case PROP_CAPS:
 397       GST_PAD_TEMPLATE_CAPS (object) = g_value_dup_boxed (value);
 398       break;
 399     default:
 400       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 401       break;
 402   }
 403 }
 404
 405 static void
 406 gst_pad_template_get_property (GObject * object, guint prop_id, GValue * value,
 407     GParamSpec * pspec)
 408 {
 409   /* these properties are all construct-only */
 410   switch (prop_id) {
 411     case PROP_NAME_TEMPLATE:
 412       g_value_set_string (value, GST_PAD_TEMPLATE_NAME_TEMPLATE (object));
 413       break;
 414     case PROP_DIRECTION:
 415       g_value_set_enum (value, GST_PAD_TEMPLATE_DIRECTION (object));
 416       break;
 417     case PROP_PRESENCE:
 418       g_value_set_enum (value, GST_PAD_TEMPLATE_PRESENCE (object));
 419       break;
 420     case PROP_CAPS:
 421       g_value_set_boxed (value, GST_PAD_TEMPLATE_CAPS (object));
 422       break;
 423     default:
 424       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 425       break;
 426   }
 427 }