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
  29 #include <gst/gsttypes.h>
  30 #include <gst/gstobject.h>
  31 #include <gst/gstpad.h>
  32 #include <gst/gstclock.h>
  33 #include <gst/gstpluginfeature.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            (*GstElementSetClockFunction)   (GstElement *element, GstClock *clock);
 114 typedef GstClock*       (*GstElementGetClockFunction)   (GstElement *element);
 115 typedef void            (*GstElementPreRunFunction)     (GstElement *element);
 116 typedef void            (*GstElementPostRunFunction)    (GstElement *element);
 117
 118 struct _GstElement {
 119   GstObject             object;
 120
 121   /* element state  and scheduling */
 122   guint8                current_state;
 123   guint8                pending_state;
 124   GstElement            *manager;
 125   GstElementLoopFunction loopfunc;
 126
 127   GstScheduler          *sched;
 128   gpointer              sched_private;
 129   GstElementSetClockFunction setclockfunc;
 130   GstElementGetClockFunction getclockfunc;
 131   GstClock              *clock;
 132
 133   /* element pads */
 134   guint16               numpads;
 135   guint16               numsrcpads;
 136   guint16               numsinkpads;
 137   GList                 *pads;
 138   GstPad                *select_pad;
 139
 140   GMutex                *state_mutex;
 141   GCond                 *state_cond;
 142
 143   GstElementPreRunFunction  pre_run_func;
 144   GstElementPostRunFunction post_run_func;
 145   GAsyncQueue           *prop_value_queue;
 146   GMutex                *property_mutex;
 147 };
 148
 149 struct _GstElementClass {
 150   GstObjectClass        parent_class;
 151
 152   /* the elementfactory that created us */
 153   GstElementFactory     *elementfactory;
 154   /* templates for our pads */
 155   GList                 *padtemplates;
 156   gint                  numpadtemplates;
 157
 158   /* signal callbacks */
 159   void (*state_change)  (GstElement *element, GstElementState old, GstElementState state);
 160   void (*new_pad)       (GstElement *element, GstPad *pad);
 161   void (*pad_removed)   (GstElement *element, GstPad *pad);
 162   void (*error)         (GstElement *element, GstElement *source, gchar *error);
 163   void (*eos)           (GstElement *element);
 164   void (*deep_notify)   (GstObject *object, GstObject *orig, GParamSpec *pspec);
 165
 166   /* local pointers for get/set */
 167   void (*set_property)  (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
 168   void (*get_property)  (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
 169
 170   /* vtable*/
 171   gboolean              (*release_locks)        (GstElement *element);
 172   gboolean              (*send_event)           (GstElement *element, GstEvent *event);
 173   gboolean              (*query)                (GstElement *element, GstPadQueryType type,
 174                                                  GstFormat *format, gint64 *value);
 175   /* change the element state */
 176   GstElementStateReturn (*change_state)         (GstElement *element);
 177   /* request a new pad */
 178   GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ, const gchar* name);
 179   void                  (*release_pad)          (GstElement *element, GstPad *pad);
 180 };
 181
 182 void                    gst_element_class_add_pad_template      (GstElementClass *klass, GstPadTemplate *templ);
 183 void                    gst_element_class_install_std_props     (GstElementClass *klass,
 184                                                                  const gchar      *first_name, ...);
 185
 186
 187 GType                   gst_element_get_type            (void);
 188 #define                 gst_element_destroy(element)    gst_object_destroy (GST_OBJECT (element))
 189
 190 void                    gst_element_set_loop_function   (GstElement *element,
 191                                                          GstElementLoopFunction loop);
 192
 193 /* threadsafe versions of their g_object_* counterparts */
 194 void                    gst_element_set                 (GstElement *element, const gchar *first_property_name, ...);
 195 void                    gst_element_get                 (GstElement *element, const gchar *first_property_name, ...);
 196 void                    gst_element_set_valist          (GstElement *element, const gchar *first_property_name,
 197                                                          va_list var_args);
 198 void                    gst_element_get_valist          (GstElement *element, const gchar *first_property_name,
 199                                                          va_list var_args);
 200 void                    gst_element_set_property        (GstElement *element, const gchar *property_name,
 201                                                          const GValue   *value);
 202 void                    gst_element_get_property        (GstElement *element, const gchar *property_name,
 203                                                          GValue *value);
 204
 205 void                    gst_element_enable_threadsafe_properties        (GstElement *element);
 206 void                    gst_element_disable_threadsafe_properties       (GstElement *element);
 207 void                    gst_element_set_pending_properties              (GstElement *element);
 208
 209 void                    gst_element_set_name            (GstElement *element, const gchar *name);
 210 const gchar*            gst_element_get_name            (GstElement *element);
 211
 212 void                    gst_element_set_parent          (GstElement *element, GstObject *parent);
 213 GstObject*              gst_element_get_parent          (GstElement *element);
 214
 215 GstClock*               gst_element_get_clock           (GstElement *element);
 216 void                    gst_element_set_clock           (GstElement *element, GstClock *clock);
 217 GstClockReturn          gst_element_clock_wait          (GstElement *element, GstClock *clock,
 218                                                          GstClockTime time, GstClockTimeDiff *jitter);
 219
 220 gboolean                gst_element_release_locks       (GstElement *element);
 221
 222 void                    gst_element_yield               (GstElement *element);
 223 gboolean                gst_element_interrupt           (GstElement *element);
 224 void                    gst_element_set_scheduler       (GstElement *element, GstScheduler *sched);
 225 GstScheduler*           gst_element_get_scheduler       (GstElement *element);
 226
 227 void                    gst_element_add_pad             (GstElement *element, GstPad *pad);
 228 void                    gst_element_remove_pad          (GstElement *element, GstPad *pad);
 229 GstPad *                gst_element_add_ghost_pad       (GstElement *element, GstPad *pad, gchar *name);
 230 void                    gst_element_remove_ghost_pad    (GstElement *element, GstPad *pad);
 231
 232 GstPad*                 gst_element_get_pad             (GstElement *element, const gchar *name);
 233 GstPad*                 gst_element_get_static_pad      (GstElement *element, const gchar *name);
 234 GstPad*                 gst_element_get_request_pad     (GstElement *element, const gchar *name);
 235 void                    gst_element_release_request_pad (GstElement *element, GstPad *pad);
 236
 237 GList*                  gst_element_get_pad_list        (GstElement *element);
 238 GstPad*                 gst_element_get_compatible_pad  (GstElement *element, GstPad *pad);
 239 GstPad*                 gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad,
 240                                                          GstCaps *filtercaps);
 241 /* unimplemented
 242 GstPad*                 gst_element_get_compatible_request_pad (GstElement *element, GstPadTemplate *templ);
 243 GstPad*                 gst_element_get_compatible_static_pad (GstElement *element, GstPadTemplate *templ);
 244 */
 245
 246 GstPadTemplate*         gst_element_get_pad_template            (GstElement *element, const guchar *name);
 247 GList*                  gst_element_get_pad_template_list       (GstElement *element);
 248 GstPadTemplate*         gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
 249
 250 gboolean                gst_element_connect             (GstElement *src, GstElement *dest);
 251 gboolean                gst_element_connect_many        (GstElement *element_1, GstElement *element_2, ...);
 252 gboolean                gst_element_connect_filtered    (GstElement *src, GstElement *dest,
 253                                                          GstCaps *filtercaps);
 254 void                    gst_element_disconnect          (GstElement *src, GstElement *dest);
 255 void                    gst_element_disconnect_many     (GstElement *element_1, GstElement *element_2, ...);
 256
 257 gboolean                gst_element_connect_pads        (GstElement *src, const gchar *srcpadname,
 258                                                          GstElement *dest, const gchar *destpadname);
 259 gboolean                gst_element_connect_pads_filtered (GstElement *src, const gchar *srcpadname,
 260                                                          GstElement *dest, const gchar *destpadname,
 261                                                          GstCaps *filtercaps);
 262 void                    gst_element_disconnect_pads     (GstElement *src, const gchar *srcpadname,
 263                                                          GstElement *dest, const gchar *destpadname);
 264
 265 gboolean                gst_element_send_event          (GstElement *element, GstEvent *event);
 266 gboolean                gst_element_query               (GstElement *element, GstPadQueryType type,
 267                                                          GstFormat *format, gint64 *value);
 268
 269 void                    gst_element_set_eos             (GstElement *element);
 270
 271 void                    gst_element_error               (GstElement *element, const gchar *error, ...);
 272
 273 GstElementState         gst_element_get_state           (GstElement *element);
 274 gint                    gst_element_set_state           (GstElement *element, GstElementState state);
 275
 276 void                    gst_element_wait_state_change   (GstElement *element);
 277
 278 const gchar*            gst_element_state_get_name      (GstElementState state);
 279
 280 GstElementFactory*      gst_element_get_factory         (GstElement *element);
 281
 282 GstBin*                 gst_element_get_managing_bin    (GstElement *element);
 283
 284
 285 /*
 286  *
 287  * factories stuff
 288  *
 289  **/
 290 typedef struct _GstElementDetails GstElementDetails;
 291
 292 struct _GstElementDetails {
 293   gchar *longname;              /* long, english name */
 294   gchar *klass;                 /* type of element, as hierarchy */
 295   gchar *description;           /* insights of one form or another */
 296   gchar *version;               /* version of the element */
 297   gchar *author;                /* who wrote this thing? */
 298   gchar *copyright;             /* copyright details (year, etc.) */
 299 };
 300
 301 #define GST_TYPE_ELEMENT_FACTORY                (gst_element_factory_get_type())
 302 #define GST_ELEMENT_FACTORY(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
 303                                                  GstElementFactory))
 304 #define GST_ELEMENT_FACTORY_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
 305                                                  GstElementFactoryClass))
 306 #define GST_IS_ELEMENT_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
 307 #define GST_IS_ELEMENT_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
 308
 309 #define GST_ELEMENT_RANK_PRIMARY    256
 310 #define GST_ELEMENT_RANK_SECONDARY  128
 311 #define GST_ELEMENT_RANK_MARGINAL   64
 312 #define GST_ELEMENT_RANK_NONE       0
 313
 314 struct _GstElementFactory {
 315   GstPluginFeature feature;
 316
 317   GType type;                   /* unique GType of element */
 318
 319   guint details_dynamic : 1;
 320
 321   GstElementDetails *details;   /* pointer to details struct */
 322
 323   GList *padtemplates;
 324   guint16 numpadtemplates;
 325
 326   guint16 rank;                 /* used by autoplug to prioritise elements to try */
 327 };
 328
 329 struct _GstElementFactoryClass {
 330   GstPluginFeatureClass parent_class;
 331 };
 332
 333 GType                   gst_element_factory_get_type            (void);
 334
 335 GstElementFactory*      gst_element_factory_new                 (const gchar *name, GType type,
 336                                                                  GstElementDetails *details);
 337 GstElementFactory*      gst_element_factory_find                (const gchar *name);
 338
 339 void                    gst_element_factory_add_pad_template    (GstElementFactory *elementfactory,
 340                                                                  GstPadTemplate *templ);
 341
 342 gboolean                gst_element_factory_can_src_caps        (GstElementFactory *factory,
 343                                                                  GstCaps *caps);
 344 gboolean                gst_element_factory_can_sink_caps       (GstElementFactory *factory,
 345                                                                  GstCaps *caps);
 346
 347 GstElement*             gst_element_factory_create              (GstElementFactory *factory,
 348                                                                  const gchar *name);
 349 GstElement*             gst_element_factory_make                (const gchar *factoryname, const gchar *name);
 350 GstElement*             gst_element_factory_make_or_warn        (const gchar *factoryname, const gchar *name);
 351
 352 void                    gst_element_factory_set_rank            (GstElementFactory *factory, guint16 rank);
 353
 354 G_END_DECLS
 355
 356
 357 #endif /* __GST_ELEMENT_H__ */
 358