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