gst/gstelement.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstelement.h: Header for GstElement
   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
  24 #ifndef __GST_ELEMENT_H__
  25 #define __GST_ELEMENT_H__
  26
  27 #include <gst/gstconfig.h>
  28 #include <gst/gsttypes.h>
  29 #include <gst/gstobject.h>
  30 #include <gst/gstpad.h>
  31 #include <gst/gstclock.h>
  32 #include <gst/gstplugin.h>
  33 #include <gst/gstpluginfeature.h>
  34 #include <gst/gstindex.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct _GstElementDetails GstElementDetails;
  39
  40 /* FIXME: need translatable stuff in here (how handle in registry)? */
  41 struct _GstElementDetails {
  42   gchar *longname;              /* long, english name */
  43   gchar *klass;                 /* type of element, as hierarchy */
  44   gchar *description;           /* insights of one form or another */
  45   gchar *author;                /* who wrote this thing? */
  46
  47   GST_STRUCT_PADDING
  48 };
  49 #define GST_ELEMENT_DETAILS(longname,klass,description,author)          \
  50   { longname, klass, description, author, GST_STRUCT_PADDING_INIT }
  51 #define GST_IS_ELEMENT_DETAILS(details) (                                       \
  52   (details) && ((details)->longname != NULL) && ((details)->klass != NULL)      \
  53   && ((details)->description != NULL) && ((details)->author != NULL))
  54
  55 #define GST_NUM_STATES 4
  56
  57 /* NOTE: this probably should be done with an #ifdef to decide
  58  * whether to safe-cast or to just do the non-checking cast.
  59  */
  60 #define GST_STATE(obj)                  (GST_ELEMENT(obj)->current_state)
  61 #define GST_STATE_PENDING(obj)          (GST_ELEMENT(obj)->pending_state)
  62
  63 /* Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g> */
  64 #define GST_STATE_TRANSITION(obj)       ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
  65 #define GST_STATE_NULL_TO_READY         ((GST_STATE_NULL<<8) | GST_STATE_READY)
  66 #define GST_STATE_READY_TO_PAUSED       ((GST_STATE_READY<<8) | GST_STATE_PAUSED)
  67 #define GST_STATE_PAUSED_TO_PLAYING     ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
  68 #define GST_STATE_PLAYING_TO_PAUSED     ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
  69 #define GST_STATE_PAUSED_TO_READY       ((GST_STATE_PAUSED<<8) | GST_STATE_READY)
  70 #define GST_STATE_READY_TO_NULL         ((GST_STATE_READY<<8) | GST_STATE_NULL)
  71
  72 extern GType _gst_element_type;
  73
  74 #define GST_TYPE_ELEMENT                (_gst_element_type)
  75
  76 #define GST_ELEMENT_CAST(obj)           ((GstElement*)(obj))
  77 #define GST_ELEMENT_CLASS_CAST(klass)   ((GstElementClass*)(klass))
  78 #define GST_IS_ELEMENT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
  79 #define GST_IS_ELEMENT_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
  80 #define GST_ELEMENT_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ELEMENT, GstElementClass))
  81
  82 #ifdef GST_TYPE_PARANOID
  83 # define GST_ELEMENT(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
  84 # define GST_ELEMENT_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
  85 #else
  86 # define GST_ELEMENT                    GST_ELEMENT_CAST
  87 # define GST_ELEMENT_CLASS              GST_ELEMENT_CLASS_CAST
  88 #endif
  89
  90 /* convenience functions */
  91 #ifdef G_HAVE_ISO_VARARGS
  92 #define GST_ELEMENT_QUERY_TYPE_FUNCTION(functionname, ...) \
  93         GST_QUERY_TYPE_FUNCTION (GstElement*, functionname, __VA_ARGS__);
  94 #define GST_ELEMENT_FORMATS_FUNCTION(functionname, ...)    \
  95         GST_FORMATS_FUNCTION (GstElement*, functionname, __VA_ARGS__);
  96 #define GST_ELEMENT_EVENT_MASK_FUNCTION(functionname, ...) \
  97         GST_EVENT_MASK_FUNCTION (GstElement*, functionname, __VA_ARGS__);
  98 #elif defined(G_HAVE_GNUC_VARARGS)
  99 #define GST_ELEMENT_QUERY_TYPE_FUNCTION(functionname, a...) \
 100         GST_QUERY_TYPE_FUNCTION (GstElement*, functionname, a);
 101 #define GST_ELEMENT_FORMATS_FUNCTION(functionname, a...)    \
 102         GST_FORMATS_FUNCTION (GstElement*, functionname, a);
 103 #define GST_ELEMENT_EVENT_MASK_FUNCTION(functionname, a...) \
 104         GST_EVENT_MASK_FUNCTION (GstElement*, functionname, a);
 105 #endif
 106
 107 typedef enum {
 108   /* element is complex (for some def.) and generally require a cothread */
 109   GST_ELEMENT_COMPLEX           = GST_OBJECT_FLAG_LAST,
 110   /* input and output pads aren't directly coupled to each other
 111      examples: queues, multi-output async readers, etc. */
 112   GST_ELEMENT_DECOUPLED,
 113   /* this element should be placed in a thread if at all possible */
 114   GST_ELEMENT_THREAD_SUGGESTED,
 115   /* this element, for some reason, has a loop function that performs
 116    * an infinite loop without calls to gst_element_yield () */
 117   GST_ELEMENT_INFINITE_LOOP,
 118   /* there is a new loopfunction ready for placement */
 119   GST_ELEMENT_NEW_LOOPFUNC,
 120   /* if this element can handle events */
 121   GST_ELEMENT_EVENT_AWARE,
 122   /* use threadsafe property get/set implementation */
 123   GST_ELEMENT_USE_THREADSAFE_PROPERTIES,
 124
 125   /* private flags that can be used by the scheduler */
 126   GST_ELEMENT_SCHEDULER_PRIVATE1,
 127   GST_ELEMENT_SCHEDULER_PRIVATE2,
 128
 129   /* ignore state changes from parent */
 130   GST_ELEMENT_LOCKED_STATE,
 131
 132   /* element is in error */
 133   GST_ELEMENT_ERROR,
 134
 135   /* use some padding for future expansion */
 136   GST_ELEMENT_FLAG_LAST         = GST_OBJECT_FLAG_LAST + 16
 137 } GstElementFlags;
 138
 139 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)    (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
 140 #define GST_ELEMENT_IS_EOS(obj)                 (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
 141 #define GST_ELEMENT_IS_EVENT_AWARE(obj)         (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
 142 #define GST_ELEMENT_IS_DECOUPLED(obj)           (GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
 143
 144 #define GST_ELEMENT_NAME(obj)                   (GST_OBJECT_NAME(obj))
 145 #define GST_ELEMENT_PARENT(obj)                 (GST_OBJECT_PARENT(obj))
 146 #define GST_ELEMENT_MANAGER(obj)                (((GstElement*)(obj))->manager)
 147 #define GST_ELEMENT_SCHED(obj)                  (((GstElement*)(obj))->sched)
 148 #define GST_ELEMENT_CLOCK(obj)                  (((GstElement*)(obj))->clock)
 149 #define GST_ELEMENT_PADS(obj)                   ((obj)->pads)
 150
 151 typedef struct _GstElementFactory GstElementFactory;
 152 typedef struct _GstElementFactoryClass GstElementFactoryClass;
 153
 154 typedef void            (*GstElementLoopFunction)       (GstElement *element);
 155 typedef void            (*GstElementPreRunFunction)     (GstElement *element);
 156 typedef void            (*GstElementPostRunFunction)    (GstElement *element);
 157
 158 struct _GstElement {
 159   GstObject             object;
 160
 161   /* element state  and scheduling */
 162   guint8                current_state;
 163   guint8                pending_state;
 164   GstElementLoopFunction loopfunc;
 165
 166   GstScheduler          *sched;
 167   gpointer              sched_private;
 168
 169   /* allocated clock */
 170   GstClock              *clock;
 171   GstClockTime           base_time;
 172
 173   /* element pads */
 174   guint16               numpads;
 175   guint16               numsrcpads;
 176   guint16               numsinkpads;
 177   GList                 *pads;
 178
 179   GMutex                *state_mutex;
 180   GCond                 *state_cond;
 181
 182   GstElementPreRunFunction  pre_run_func;
 183   GstElementPostRunFunction post_run_func;
 184   GAsyncQueue           *prop_value_queue;
 185   GMutex                *property_mutex;
 186
 187   GST_OBJECT_PADDING
 188 };
 189
 190 struct _GstElementClass {
 191   GstObjectClass        parent_class;
 192
 193   /* the element details */
 194   GstElementDetails     details;
 195
 196   /* factory that the element was created from */
 197   GstElementFactory     *elementfactory;
 198
 199   /* templates for our pads */
 200   GList                 *padtemplates;
 201   gint                  numpadtemplates;
 202
 203   /* signal callbacks */
 204   void (*state_change)  (GstElement *element, GstElementState old, GstElementState state);
 205   void (*new_pad)       (GstElement *element, GstPad *pad);
 206   void (*pad_removed)   (GstElement *element, GstPad *pad);
 207   void (*error)         (GstElement *element, GstElement *source, gchar *error);
 208   void (*eos)           (GstElement *element);
 209
 210   /* local pointers for get/set */
 211   void (*set_property)  (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
 212   void (*get_property)  (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
 213
 214   /* vtable*/
 215   gboolean              (*release_locks)        (GstElement *element);
 216
 217   /* query/convert/events functions */
 218   const GstEventMask*   (*get_event_masks)      (GstElement *element);
 219   gboolean              (*send_event)           (GstElement *element, GstEvent *event);
 220   const GstFormat*      (*get_formats)          (GstElement *element);
 221   gboolean              (*convert)              (GstElement *element,
 222                                                  GstFormat  src_format,  gint64  src_value,
 223                                                  GstFormat *dest_format, gint64 *dest_value);
 224   const GstQueryType*   (*get_query_types)      (GstElement *element);
 225   gboolean              (*query)                (GstElement *element, GstQueryType type,
 226                                                  GstFormat *format, gint64 *value);
 227
 228   /* change the element state */
 229   GstElementStateReturn (*change_state)         (GstElement *element);
 230
 231   /* request/release pads */
 232   GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ, const gchar* name);
 233   void                  (*release_pad)          (GstElement *element, GstPad *pad);
 234
 235   /* set/get clocks */
 236   GstClock*             (*get_clock)            (GstElement *element);
 237   void                  (*set_clock)            (GstElement *element, GstClock *clock);
 238
 239   /* index */
 240   GstIndex*             (*get_index)            (GstElement *element);
 241   void                  (*set_index)            (GstElement *element, GstIndex *index);
 242
 243   GST_CLASS_PADDING
 244 };
 245
 246 void                    gst_element_class_add_pad_template      (GstElementClass *klass, GstPadTemplate *templ);
 247 void                    gst_element_class_install_std_props     (GstElementClass *klass,
 248                                                                  const gchar      *first_name, ...);
 249 void                    gst_element_class_set_details           (GstElementClass *klass,
 250                                                                  GstElementDetails *details);
 251
 252 #define                 gst_element_default_deep_notify         gst_object_default_deep_notify
 253
 254 void                    gst_element_default_error               (GObject *object, GstObject *orig, gchar *error);
 255
 256 GType                   gst_element_get_type            (void);
 257
 258 void                    gst_element_set_loop_function   (GstElement *element,
 259                                                          GstElementLoopFunction loop);
 260
 261 #define                 gst_element_get_name(elem)      gst_object_get_name(GST_OBJECT(elem))
 262 #define                 gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT(elem),name)
 263 #define                 gst_element_get_parent(elem)    gst_object_get_parent(GST_OBJECT(elem))
 264 #define                 gst_element_set_parent(elem,parent)     gst_object_set_parent(GST_OBJECT(elem),parent)
 265
 266 /* threadsafe versions of their g_object_* counterparts */
 267 void                    gst_element_set                 (GstElement *element, const gchar *first_property_name, ...);
 268 void                    gst_element_get                 (GstElement *element, const gchar *first_property_name, ...);
 269 void                    gst_element_set_valist          (GstElement *element, const gchar *first_property_name,
 270                                                          va_list var_args);
 271 void                    gst_element_get_valist          (GstElement *element, const gchar *first_property_name,
 272                                                          va_list var_args);
 273 void                    gst_element_set_property        (GstElement *element, const gchar *property_name,
 274                                                          const GValue   *value);
 275 void                    gst_element_get_property        (GstElement *element, const gchar *property_name,
 276                                                          GValue *value);
 277
 278 void                    gst_element_enable_threadsafe_properties        (GstElement *element);
 279 void                    gst_element_disable_threadsafe_properties       (GstElement *element);
 280 void                    gst_element_set_pending_properties              (GstElement *element);
 281
 282 /* clocking */
 283 gboolean                gst_element_requires_clock      (GstElement *element);
 284 gboolean                gst_element_provides_clock      (GstElement *element);
 285 GstClock*               gst_element_get_clock           (GstElement *element);
 286 void                    gst_element_set_clock           (GstElement *element, GstClock *clock);
 287 GstClockReturn          gst_element_clock_wait          (GstElement *element,
 288                                                          GstClockID id, GstClockTimeDiff *jitter);
 289
 290 /* indexs */
 291 gboolean                gst_element_is_indexable        (GstElement *element);
 292 void                    gst_element_set_index           (GstElement *element, GstIndex *index);
 293 GstIndex*               gst_element_get_index           (GstElement *element);
 294
 295
 296 gboolean                gst_element_release_locks       (GstElement *element);
 297
 298 void                    gst_element_yield               (GstElement *element);
 299 gboolean                gst_element_interrupt           (GstElement *element);
 300 void                    gst_element_set_scheduler       (GstElement *element, GstScheduler *sched);
 301 GstScheduler*           gst_element_get_scheduler       (GstElement *element);
 302
 303 void                    gst_element_add_pad             (GstElement *element, GstPad *pad);
 304 void                    gst_element_remove_pad          (GstElement *element, GstPad *pad);
 305 GstPad *                gst_element_add_ghost_pad       (GstElement *element, GstPad *pad, const gchar *name);
 306 void                    gst_element_remove_ghost_pad    (GstElement *element, GstPad *pad);
 307
 308 GstPad*                 gst_element_get_pad             (GstElement *element, const gchar *name);
 309 GstPad*                 gst_element_get_static_pad      (GstElement *element, const gchar *name);
 310 GstPad*                 gst_element_get_request_pad     (GstElement *element, const gchar *name);
 311 void                    gst_element_release_request_pad (GstElement *element, GstPad *pad);
 312
 313 const GList*            gst_element_get_pad_list        (GstElement *element);
 314 GstPad*                 gst_element_get_compatible_pad  (GstElement *element, GstPad *pad);
 315 GstPad*                 gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad,
 316                                                          GstCaps *filtercaps);
 317
 318 GstPadTemplate*         gst_element_class_get_pad_template      (GstElementClass *element_class, const gchar *name);
 319 GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
 320 GstPadTemplate*         gst_element_get_pad_template            (GstElement *element, const gchar *name);
 321 GList*                  gst_element_get_pad_template_list       (GstElement *element);
 322 GstPadTemplate*         gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
 323
 324 gboolean                gst_element_link                (GstElement *src, GstElement *dest);
 325 gboolean                gst_element_link_many           (GstElement *element_1,
 326                                                          GstElement *element_2, ...);
 327 gboolean                gst_element_link_filtered       (GstElement *src, GstElement *dest,
 328                                                          GstCaps *filtercaps);
 329 void                    gst_element_unlink              (GstElement *src, GstElement *dest);
 330 void                    gst_element_unlink_many         (GstElement *element_1,
 331                                                          GstElement *element_2, ...);
 332
 333 gboolean                gst_element_link_pads           (GstElement *src, const gchar *srcpadname,
 334                                                          GstElement *dest, const gchar *destpadname);
 335 gboolean                gst_element_link_pads_filtered  (GstElement *src, const gchar *srcpadname,
 336                                                          GstElement *dest, const gchar *destpadname,
 337                                                          GstCaps *filtercaps);
 338 void                    gst_element_unlink_pads         (GstElement *src, const gchar *srcpadname,
 339                                                          GstElement *dest, const gchar *destpadname);
 340
 341 const GstEventMask*     gst_element_get_event_masks     (GstElement *element);
 342 gboolean                gst_element_send_event          (GstElement *element, GstEvent *event);
 343 gboolean                gst_element_seek                (GstElement *element, GstSeekType seek_type,
 344                                                          guint64 offset);
 345 const GstQueryType*     gst_element_get_query_types     (GstElement *element);
 346 gboolean                gst_element_query               (GstElement *element, GstQueryType type,
 347                                                          GstFormat *format, gint64 *value);
 348 const GstFormat*        gst_element_get_formats         (GstElement *element);
 349 gboolean                gst_element_convert             (GstElement *element,
 350                                                          GstFormat  src_format,  gint64  src_value,
 351                                                          GstFormat *dest_format, gint64 *dest_value);
 352
 353 void                    gst_element_set_eos             (GstElement *element);
 354
 355 void                    gst_element_error               (GstElement *element, const gchar *error, ...);
 356
 357 gboolean                gst_element_is_locked_state     (GstElement *element);
 358 void                    gst_element_set_locked_state    (GstElement *element, gboolean locked_state);
 359 gboolean                gst_element_sync_state_with_parent (GstElement *element);
 360
 361 GstElementState         gst_element_get_state           (GstElement *element);
 362 GstElementStateReturn   gst_element_set_state           (GstElement *element, GstElementState state);
 363
 364 void                    gst_element_wait_state_change   (GstElement *element);
 365
 366 const gchar*            gst_element_state_get_name      (GstElementState state);
 367
 368 GstElementFactory*      gst_element_get_factory         (GstElement *element);
 369
 370 GstBin*                 gst_element_get_managing_bin    (GstElement *element);
 371
 372
 373 /*
 374  *
 375  * factories stuff
 376  *
 377  **/
 378
 379 #define GST_TYPE_ELEMENT_FACTORY                (gst_element_factory_get_type())
 380 #define GST_ELEMENT_FACTORY(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
 381                                                  GstElementFactory))
 382 #define GST_ELEMENT_FACTORY_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
 383                                                  GstElementFactoryClass))
 384 #define GST_IS_ELEMENT_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
 385 #define GST_IS_ELEMENT_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
 386
 387 struct _GstElementFactory {
 388   GstPluginFeature      parent;
 389
 390   GType                 type;                   /* unique GType of element or 0 if not loaded */
 391
 392   GstElementDetails     details;
 393
 394   GList *               padtemplates;
 395   guint                 numpadtemplates;
 396
 397   GST_OBJECT_PADDING
 398 };
 399
 400 struct _GstElementFactoryClass {
 401   GstPluginFeatureClass parent_class;
 402
 403   GST_CLASS_PADDING
 404 };
 405
 406 GType                   gst_element_factory_get_type            (void);
 407
 408 gboolean                gst_element_register                    (GstPlugin *plugin,
 409                                                                  const gchar *elementname,
 410                                                                  guint rank,
 411                                                                  GType type);
 412
 413 GstElementFactory *     gst_element_factory_find                (const gchar *name);
 414 GType                   gst_element_factory_get_element_type    (GstElementFactory *factory);
 415 G_CONST_RETURN gchar *  gst_element_factory_get_longname        (GstElementFactory *factory);
 416 G_CONST_RETURN gchar *  gst_element_factory_get_klass           (GstElementFactory *factory);
 417 G_CONST_RETURN gchar *  gst_element_factory_get_description     (GstElementFactory *factory);
 418 G_CONST_RETURN gchar *  gst_element_factory_get_version         (GstElementFactory *factory);
 419 G_CONST_RETURN gchar *  gst_element_factory_get_author          (GstElementFactory *factory);
 420 guint                   gst_element_factory_get_num_padtemplates (GstElementFactory *factory);
 421 G_CONST_RETURN GList *  gst_element_factory_get_padtemplates    (GstElementFactory *factory);
 422
 423 GstElement*             gst_element_factory_create              (GstElementFactory *factory,
 424                                                                  const gchar *name);
 425 GstElement*             gst_element_factory_make                (const gchar *factoryname, const gchar *name);
 426
 427 gboolean                gst_element_factory_can_src_caps        (GstElementFactory *factory,
 428                                                                  GstCaps *caps);
 429 gboolean                gst_element_factory_can_sink_caps       (GstElementFactory *factory,
 430                                                                  GstCaps *caps);
 431
 432 void                    __gst_element_factory_add_pad_template  (GstElementFactory *elementfactory,
 433                                                                  GstPadTemplate *templ);
 434
 435
 436 G_END_DECLS
 437
 438
 439 #endif /* __GST_ELEMENT_H__ */
 440