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/gstcache.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(obj)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
  62
  63 #ifdef GST_TYPE_PARANOID
  64 # define GST_ELEMENT(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
  65 # define GST_ELEMENT_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
  66 #else
  67 # define GST_ELEMENT                    GST_ELEMENT_CAST
  68 # define GST_ELEMENT_CLASS              GST_ELEMENT_CLASS_CAST
  69 #endif
  70
  71 typedef enum {
  72   /* element is complex (for some def.) and generally require a cothread */
  73   GST_ELEMENT_COMPLEX           = GST_OBJECT_FLAG_LAST,
  74   /* input and output pads aren't directly coupled to each other
  75      examples: queues, multi-output async readers, etc. */
  76   GST_ELEMENT_DECOUPLED,
  77   /* this element should be placed in a thread if at all possible */
  78   GST_ELEMENT_THREAD_SUGGESTED,
  79   /* this element, for some reason, has a loop function that performs
  80    * an infinite loop without calls to gst_element_yield () */
  81   GST_ELEMENT_INFINITE_LOOP,
  82   /* there is a new loopfunction ready for placement */
  83   GST_ELEMENT_NEW_LOOPFUNC,
  84   /* if this element can handle events */
  85   GST_ELEMENT_EVENT_AWARE,
  86   /* use threadsafe property get/set implementation */
  87   GST_ELEMENT_USE_THREADSAFE_PROPERTIES,
  88
  89   /* private flags that can be used by the scheduler */
  90   GST_ELEMENT_SCHEDULER_PRIVATE1,
  91   GST_ELEMENT_SCHEDULER_PRIVATE2,
  92
  93   /* use some padding for future expansion */
  94   GST_ELEMENT_FLAG_LAST         = GST_OBJECT_FLAG_LAST + 16
  95 } GstElementFlags;
  96
  97 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)    (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
  98 #define GST_ELEMENT_IS_EOS(obj)                 (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
  99 #define GST_ELEMENT_IS_EVENT_AWARE(obj)         (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
 100 #define GST_ELEMENT_IS_DECOUPLED(obj)           (GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
 101
 102 #define GST_ELEMENT_NAME(obj)                   (GST_OBJECT_NAME(obj))
 103 #define GST_ELEMENT_PARENT(obj)                 (GST_OBJECT_PARENT(obj))
 104 #define GST_ELEMENT_MANAGER(obj)                (((GstElement*)(obj))->manager)
 105 #define GST_ELEMENT_SCHED(obj)                  (((GstElement*)(obj))->sched)
 106 #define GST_ELEMENT_CLOCK(obj)                  (((GstElement*)(obj))->clock)
 107 #define GST_ELEMENT_PADS(obj)                   ((obj)->pads)
 108
 109 typedef struct _GstElementFactory GstElementFactory;
 110 typedef struct _GstElementFactoryClass GstElementFactoryClass;
 111
 112 typedef void            (*GstElementLoopFunction)       (GstElement *element);
 113 typedef void            (*GstElementPreRunFunction)     (GstElement *element);
 114 typedef void            (*GstElementPostRunFunction)    (GstElement *element);
 115
 116 struct _GstElement {
 117   GstObject             object;
 118
 119   /* element state  and scheduling */
 120   guint8                current_state;
 121   guint8                pending_state;
 122   GstElement            *manager;
 123   GstElementLoopFunction loopfunc;
 124
 125   GstScheduler          *sched;
 126   gpointer              sched_private;
 127   GstClock              *clock;
 128   GstClockTime           base_time;
 129
 130   /* element pads */
 131   guint16               numpads;
 132   guint16               numsrcpads;
 133   guint16               numsinkpads;
 134   GList                 *pads;
 135   GstPad                *select_pad;
 136
 137   GMutex                *state_mutex;
 138   GCond                 *state_cond;
 139
 140   GstElementPreRunFunction  pre_run_func;
 141   GstElementPostRunFunction post_run_func;
 142   GAsyncQueue           *prop_value_queue;
 143   GMutex                *property_mutex;
 144 };
 145
 146 struct _GstElementClass {
 147   GstObjectClass        parent_class;
 148
 149   /* the elementfactory that created us */
 150   GstElementFactory     *elementfactory;
 151   /* templates for our pads */
 152   GList                 *padtemplates;
 153   gint                  numpadtemplates;
 154
 155   /* signal callbacks */
 156   void (*state_change)  (GstElement *element, GstElementState old, GstElementState state);
 157   void (*new_pad)       (GstElement *element, GstPad *pad);
 158   void (*pad_removed)   (GstElement *element, GstPad *pad);
 159   void (*error)         (GstElement *element, GstElement *source, gchar *error);
 160   void (*eos)           (GstElement *element);
 161
 162   /* local pointers for get/set */
 163   void (*set_property)  (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
 164   void (*get_property)  (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
 165
 166   /* vtable*/
 167   gboolean              (*release_locks)        (GstElement *element);
 168   gboolean              (*send_event)           (GstElement *element, GstEvent *event);
 169   gboolean              (*query)                (GstElement *element, GstPadQueryType type,
 170                                                  GstFormat *format, gint64 *value);
 171   /* change the element state */
 172   GstElementStateReturn (*change_state)         (GstElement *element);
 173   /* request a new pad */
 174   GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ, const gchar* name);
 175   void                  (*release_pad)          (GstElement *element, GstPad *pad);
 176   /* set/get clocks */
 177   GstClock*             (*get_clock)            (GstElement *element);
 178   void                  (*set_clock)            (GstElement *element, GstClock *clock);
 179   /* cache */
 180   GstCache*             (*get_cache)            (GstElement *element);
 181   void                  (*set_cache)            (GstElement *element, GstCache *cache);
 182 };
 183
 184 void                    gst_element_class_add_pad_template      (GstElementClass *klass, GstPadTemplate *templ);
 185 void                    gst_element_class_install_std_props     (GstElementClass *klass,
 186                                                                  const gchar      *first_name, ...);
 187
 188 #define                 gst_element_default_deep_notify         gst_object_default_deep_notify
 189
 190 void                    gst_element_default_error               (GObject *object, GstObject *orig, gchar *error);
 191
 192 GType                   gst_element_get_type            (void);
 193 #define                 gst_element_destroy(element)    gst_object_destroy (GST_OBJECT (element))
 194
 195 void                    gst_element_set_loop_function   (GstElement *element,
 196                                                          GstElementLoopFunction loop);
 197
 198 #define                 gst_element_get_name(elem)      gst_object_get_name(GST_OBJECT(elem))
 199 #define                 gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT(elem),name)
 200 #define                 gst_element_get_parent(elem)    gst_object_get_parent(GST_OBJECT(elem))
 201 #define                 gst_element_set_parent(elem,parent)     gst_object_set_parent(GST_OBJECT(elem),parent)
 202
 203 /* threadsafe versions of their g_object_* counterparts */
 204 void                    gst_element_set                 (GstElement *element, const gchar *first_property_name, ...);
 205 void                    gst_element_get                 (GstElement *element, const gchar *first_property_name, ...);
 206 void                    gst_element_set_valist          (GstElement *element, const gchar *first_property_name,
 207                                                          va_list var_args);
 208 void                    gst_element_get_valist          (GstElement *element, const gchar *first_property_name,
 209                                                          va_list var_args);
 210 void                    gst_element_set_property        (GstElement *element, const gchar *property_name,
 211                                                          const GValue   *value);
 212 void                    gst_element_get_property        (GstElement *element, const gchar *property_name,
 213                                                          GValue *value);
 214
 215 void                    gst_element_enable_threadsafe_properties        (GstElement *element);
 216 void                    gst_element_disable_threadsafe_properties       (GstElement *element);
 217 void                    gst_element_set_pending_properties              (GstElement *element);
 218
 219 /* clocking */
 220 gboolean                gst_element_requires_clock      (GstElement *element);
 221 gboolean                gst_element_provides_clock      (GstElement *element);
 222 GstClock*               gst_element_get_clock           (GstElement *element);
 223 void                    gst_element_set_clock           (GstElement *element, GstClock *clock);
 224 GstClockReturn          gst_element_clock_wait          (GstElement *element, GstClock *clock,
 225                                                          GstClockTime time, GstClockTimeDiff *jitter);
 226 /* caches */
 227 gboolean                gst_element_is_cachable         (GstElement *element);
 228 void                    gst_element_set_cache           (GstElement *element, GstCache *cache);
 229 GstCache*               gst_element_get_cache           (GstElement *element);
 230
 231
 232 gboolean                gst_element_release_locks       (GstElement *element);
 233
 234 void                    gst_element_yield               (GstElement *element);
 235 gboolean                gst_element_interrupt           (GstElement *element);
 236 void                    gst_element_set_scheduler       (GstElement *element, GstScheduler *sched);
 237 GstScheduler*           gst_element_get_scheduler       (GstElement *element);
 238
 239 void                    gst_element_add_pad             (GstElement *element, GstPad *pad);
 240 void                    gst_element_remove_pad          (GstElement *element, GstPad *pad);
 241 GstPad *                gst_element_add_ghost_pad       (GstElement *element, GstPad *pad, const gchar *name);
 242 void                    gst_element_remove_ghost_pad    (GstElement *element, GstPad *pad);
 243
 244 GstPad*                 gst_element_get_pad             (GstElement *element, const gchar *name);
 245 GstPad*                 gst_element_get_static_pad      (GstElement *element, const gchar *name);
 246 GstPad*                 gst_element_get_request_pad     (GstElement *element, const gchar *name);
 247 void                    gst_element_release_request_pad (GstElement *element, GstPad *pad);
 248
 249 const GList*            gst_element_get_pad_list        (GstElement *element);
 250 GstPad*                 gst_element_get_compatible_pad  (GstElement *element, GstPad *pad);
 251 GstPad*                 gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad,
 252                                                          GstCaps *filtercaps);
 253 /* unimplemented
 254 GstPad*                 gst_element_get_compatible_request_pad (GstElement *element, GstPadTemplate *templ);
 255 GstPad*                 gst_element_get_compatible_static_pad (GstElement *element, GstPadTemplate *templ);
 256 */
 257
 258 GstPadTemplate*         gst_element_get_pad_template            (GstElement *element, const gchar *name);
 259 GList*                  gst_element_get_pad_template_list       (GstElement *element);
 260 GstPadTemplate*         gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
 261
 262 gboolean                gst_element_connect             (GstElement *src, GstElement *dest);
 263 gboolean                gst_element_connect_many        (GstElement *element_1, GstElement *element_2, ...);
 264 gboolean                gst_element_connect_filtered    (GstElement *src, GstElement *dest,
 265                                                          GstCaps *filtercaps);
 266 void                    gst_element_disconnect          (GstElement *src, GstElement *dest);
 267 void                    gst_element_disconnect_many     (GstElement *element_1, GstElement *element_2, ...);
 268
 269 gboolean                gst_element_connect_pads        (GstElement *src, const gchar *srcpadname,
 270                                                          GstElement *dest, const gchar *destpadname);
 271 gboolean                gst_element_connect_pads_filtered (GstElement *src, const gchar *srcpadname,
 272                                                          GstElement *dest, const gchar *destpadname,
 273                                                          GstCaps *filtercaps);
 274 void                    gst_element_disconnect_pads     (GstElement *src, const gchar *srcpadname,
 275                                                          GstElement *dest, const gchar *destpadname);
 276
 277 gboolean                gst_element_send_event          (GstElement *element, GstEvent *event);
 278 gboolean                gst_element_query               (GstElement *element, GstPadQueryType type,
 279                                                          GstFormat *format, gint64 *value);
 280
 281 void                    gst_element_set_eos             (GstElement *element);
 282
 283 void                    gst_element_error               (GstElement *element, const gchar *error, ...);
 284
 285 GstElementState         gst_element_get_state           (GstElement *element);
 286 GstElementStateReturn   gst_element_set_state           (GstElement *element, GstElementState state);
 287
 288 void                    gst_element_wait_state_change   (GstElement *element);
 289
 290 const gchar*            gst_element_state_get_name      (GstElementState state);
 291
 292 GstElementFactory*      gst_element_get_factory         (GstElement *element);
 293
 294 GstBin*                 gst_element_get_managing_bin    (GstElement *element);
 295
 296
 297 /*
 298  *
 299  * factories stuff
 300  *
 301  **/
 302 typedef struct _GstElementDetails GstElementDetails;
 303
 304 struct _GstElementDetails {
 305   gchar *longname;              /* long, english name */
 306   gchar *klass;                 /* type of element, as hierarchy */
 307   gchar *license;               /* license element is under */
 308   gchar *description;           /* insights of one form or another */
 309   gchar *version;               /* version of the element */
 310   gchar *author;                /* who wrote this thing? */
 311   gchar *copyright;             /* copyright details (year, etc.) */
 312 };
 313
 314 #define GST_TYPE_ELEMENT_FACTORY                (gst_element_factory_get_type())
 315 #define GST_ELEMENT_FACTORY(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
 316                                                  GstElementFactory))
 317 #define GST_ELEMENT_FACTORY_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
 318                                                  GstElementFactoryClass))
 319 #define GST_IS_ELEMENT_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
 320 #define GST_IS_ELEMENT_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
 321
 322 #define GST_ELEMENT_RANK_PRIMARY    256
 323 #define GST_ELEMENT_RANK_SECONDARY  128
 324 #define GST_ELEMENT_RANK_MARGINAL   64
 325 #define GST_ELEMENT_RANK_NONE       0
 326
 327 struct _GstElementFactory {
 328   GstPluginFeature feature;
 329
 330   GType type;                   /* unique GType of element */
 331
 332   guint details_dynamic : 1;
 333
 334   GstElementDetails *details;   /* pointer to details struct */
 335
 336   GList *padtemplates;
 337   guint16 numpadtemplates;
 338
 339   guint16 rank;                 /* used by autoplug to prioritise elements to try */
 340 };
 341
 342 struct _GstElementFactoryClass {
 343   GstPluginFeatureClass parent_class;
 344 };
 345
 346 GType                   gst_element_factory_get_type            (void);
 347
 348 GstElementFactory*      gst_element_factory_new                 (const gchar *name, GType type,
 349                                                                  GstElementDetails *details);
 350 GstElementFactory*      gst_element_factory_find                (const gchar *name);
 351
 352 void                    gst_element_factory_add_pad_template    (GstElementFactory *elementfactory,
 353                                                                  GstPadTemplate *templ);
 354
 355 gboolean                gst_element_factory_can_src_caps        (GstElementFactory *factory,
 356                                                                  GstCaps *caps);
 357 gboolean                gst_element_factory_can_sink_caps       (GstElementFactory *factory,
 358                                                                  GstCaps *caps);
 359
 360 GstElement*             gst_element_factory_create              (GstElementFactory *factory,
 361                                                                  const gchar *name);
 362 GstElement*             gst_element_factory_make                (const gchar *factoryname, const gchar *name);
 363 GstElement*             gst_element_factory_make_or_warn        (const gchar *factoryname, const gchar *name);
 364
 365 void                    gst_element_factory_set_rank            (GstElementFactory *factory, guint16 rank);
 366
 367 G_END_DECLS
 368
 369
 370 #endif /* __GST_ELEMENT_H__ */
 371