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