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/gstobject.h>
  30 #include <gst/gstpad.h>
  31 #include <gst/cothreads.h>
  32 #include <gst/gstpluginfeature.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif /* __cplusplus */
  37
  38
  39 typedef enum {
  40   GST_STATE_VOID_PENDING        = 0,
  41   GST_STATE_NULL                = (1 << 0),
  42   GST_STATE_READY               = (1 << 1),
  43   GST_STATE_PAUSED              = (1 << 2),
  44   GST_STATE_PLAYING             = (1 << 3),
  45 } GstElementState;
  46
  47 typedef enum {
  48   GST_STATE_FAILURE             = 0,
  49   GST_STATE_SUCCESS             = 1,
  50   GST_STATE_ASYNC               = 2,
  51 } GstElementStateReturn;
  52
  53
  54 // NOTE: this probably should be done with an #ifdef to decide whether to safe-cast
  55 // or to just do the non-checking cast.
  56 #define GST_STATE(obj)                  (GST_ELEMENT(obj)->current_state)
  57 #define GST_STATE_PENDING(obj)          (GST_ELEMENT(obj)->pending_state)
  58
  59 // Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g>
  60 #define GST_STATE_TRANSITION(obj)       ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
  61 #define GST_STATE_NULL_TO_READY         ((GST_STATE_NULL<<8) | GST_STATE_READY)
  62 #define GST_STATE_READY_TO_PAUSED       ((GST_STATE_READY<<8) | GST_STATE_PAUSED)
  63 #define GST_STATE_PAUSED_TO_PLAYING     ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
  64 #define GST_STATE_PLAYING_TO_PAUSED     ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
  65 #define GST_STATE_PAUSED_TO_READY       ((GST_STATE_PAUSED<<8) | GST_STATE_READY)
  66 #define GST_STATE_READY_TO_NULL         ((GST_STATE_READY<<8) | GST_STATE_NULL)
  67
  68 extern GType _gst_element_type;
  69
  70 #define GST_TYPE_ELEMENT                (_gst_element_type)
  71
  72 #define GST_ELEMENT_FAST(obj)           ((GstElement*)(obj))
  73 #define GST_ELEMENT_CLASS_FAST(klass)   ((GstElementClass*)(klass))
  74 #define GST_IS_ELEMENT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
  75 #define GST_IS_ELEMENT_CLASS(obj)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
  76
  77 #ifdef GST_TYPE_PARANOID
  78 # define GST_ELEMENT(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
  79 # define GST_ELEMENT_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
  80 #else
  81 # define GST_ELEMENT                    GST_ELEMENT_FAST
  82 # define GST_ELEMENT_CLASS              GST_ELEMENT_CLASS_FAST
  83 #endif
  84
  85 typedef enum {
  86   /* element is complex (for some def.) and generally require a cothread */
  87   GST_ELEMENT_COMPLEX           = GST_OBJECT_FLAG_LAST,
  88   /* input and output pads aren't directly coupled to each other
  89      examples: queues, multi-output async readers, etc. */
  90   GST_ELEMENT_DECOUPLED,
  91   /* this element should be placed in a thread if at all possible */
  92   GST_ELEMENT_THREAD_SUGGESTED,
  93   /* this element is incable of seeking (FIXME: does this apply to filters?) */
  94   GST_ELEMENT_NO_SEEK,
  95
  96   /***** !!!!! need to have a flag that says that an element must
  97     *not* be an entry into a scheduling chain !!!!! *****/
  98   /* this element for some reason doesn't obey COTHREAD_STOPPING, or
  99      has some other reason why it can't be the entry */
 100   GST_ELEMENT_NO_ENTRY,
 101
 102   /* there is a new loopfunction ready for placement */
 103   GST_ELEMENT_NEW_LOOPFUNC,
 104   /* the cothread holding this element needs to be stopped */
 105   GST_ELEMENT_COTHREAD_STOPPING,
 106   /* the element has to be scheduled as a cothread for any sanity */
 107   GST_ELEMENT_USE_COTHREAD,
 108
 109   /* if this element is in EOS */
 110   GST_ELEMENT_EOS,
 111
 112   /* if this element can handle events */
 113   GST_ELEMENT_EVENT_AWARE,
 114
 115   /* use some padding for future expansion */
 116   GST_ELEMENT_FLAG_LAST         = GST_OBJECT_FLAG_LAST + 12,
 117 } GstElementFlags;
 118
 119 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)    (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
 120 #define GST_ELEMENT_IS_COTHREAD_STOPPING(obj)   (GST_FLAG_IS_SET(obj,GST_ELEMENT_COTHREAD_STOPPING))
 121 #define GST_ELEMENT_IS_EOS(obj)                 (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
 122 #define GST_ELEMENT_IS_EVENT_AWARE(obj)         (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
 123
 124 #define GST_ELEMENT_NAME(obj)                   (GST_OBJECT_NAME(obj))
 125 #define GST_ELEMENT_PARENT(obj)                 (GST_OBJECT_PARENT(obj))
 126 #define GST_ELEMENT_MANAGER(obj)                (((GstElement*)(obj))->manager)
 127 #define GST_ELEMENT_SCHED(obj)                  (((GstElement*)(obj))->sched)
 128 #define GST_ELEMENT_PADS(obj)                   ((obj)->pads)
 129
 130 //typedef struct _GstElement GstElement;
 131 //typedef struct _GstElementClass GstElementClass;
 132 typedef struct _GstElementFactory GstElementFactory;
 133 typedef struct _GstElementFactoryClass GstElementFactoryClass;
 134
 135 typedef void (*GstElementLoopFunction) (GstElement *element);
 136
 137 struct _GstElement {
 138   GstObject             object;
 139
 140   /* element state  and scheduling */
 141   guint8                current_state;
 142   guint8                pending_state;
 143   GstElement            *manager;
 144   GstSchedule           *sched;
 145   GstElementLoopFunction loopfunc;
 146   cothread_state        *threadstate;
 147
 148   /* element pads */
 149   guint16               numpads;
 150   guint16               numsrcpads;
 151   guint16               numsinkpads;
 152   GList                 *pads;
 153   GstPad                *select_pad;
 154 };
 155
 156 struct _GstElementClass {
 157   GstObjectClass        parent_class;
 158
 159   /* the elementfactory that created us */
 160   GstElementFactory     *elementfactory;
 161   /* templates for our pads */
 162   GList                 *padtemplates;
 163   gint                  numpadtemplates;
 164
 165   /* signal callbacks */
 166   void (*state_change)          (GstElement *element,GstElementState state);
 167   void (*new_pad)               (GstElement *element,GstPad *pad);
 168   void (*pad_removed)           (GstElement *element,GstPad *pad);
 169   void (*new_ghost_pad)         (GstElement *element,GstPad *pad);
 170   void (*ghost_pad_removed)     (GstElement *element,GstPad *pad);
 171   void (*error)                 (GstElement *element,gchar *error);
 172   void (*eos)                   (GstElement *element);
 173
 174   /* local pointers for get/set */
 175   void (*set_property)  (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
 176   void (*get_property)  (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
 177
 178   /* change the element state */
 179   GstElementStateReturn (*change_state)         (GstElement *element);
 180   /* request a new pad */
 181   GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ, const gchar* name);
 182 };
 183
 184 void                    gst_element_class_add_padtemplate       (GstElementClass *klass, GstPadTemplate *templ);
 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 void                    gst_element_set_name            (GstElement *element, const gchar *name);
 193 const gchar*            gst_element_get_name            (GstElement *element);
 194
 195 void                    gst_element_set_parent          (GstElement *element, GstObject *parent);
 196 GstObject*              gst_element_get_parent          (GstElement *element);
 197
 198 void                    gst_element_set_sched           (GstElement *element, GstSchedule *sched);
 199 GstSchedule*            gst_element_get_sched           (GstElement *element);
 200
 201 void                    gst_element_add_pad             (GstElement *element, GstPad *pad);
 202 void                    gst_element_remove_pad          (GstElement *element, GstPad *pad);
 203 GstPad*                 gst_element_get_pad             (GstElement *element, const gchar *name);
 204 GList*                  gst_element_get_pad_list        (GstElement *element);
 205 GList*                  gst_element_get_padtemplate_list        (GstElement *element);
 206 GstPadTemplate*         gst_element_get_padtemplate_by_name     (GstElement *element, const guchar *name);
 207 void                    gst_element_add_ghost_pad       (GstElement *element, GstPad *pad, gchar *name);
 208 void                    gst_element_remove_ghost_pad    (GstElement *element, GstPad *pad);
 209
 210 GstPad*                 gst_element_request_compatible_pad (GstElement *element, GstPadTemplate *templ);
 211 GstPad*                 gst_element_request_pad_by_name (GstElement *element, const gchar *name);
 212
 213 void                    gst_element_connect             (GstElement *src, const gchar *srcpadname,
 214                                                          GstElement *dest, const gchar *destpadname);
 215 void                    gst_element_disconnect          (GstElement *src, const gchar *srcpadname,
 216                                                          GstElement *dest, const gchar *destpadname);
 217
 218 void                    gst_element_signal_eos          (GstElement *element);
 219
 220
 221 GstElementState         gst_element_get_state           (GstElement *element);
 222 /* called by the app to set the state of the element */
 223 gint                    gst_element_set_state           (GstElement *element, GstElementState state);
 224 const gchar *           gst_element_statename           (GstElementState state);
 225
 226 void                    gst_element_error               (GstElement *element, const gchar *error);
 227
 228 GstElementFactory*      gst_element_get_factory         (GstElement *element);
 229
 230 #ifndef GST_DISABLE_LOADSAVE
 231 /* XML write and read */
 232 GstElement*             gst_element_restore_thyself     (xmlNodePtr self, GstObject *parent);
 233 #endif
 234
 235
 236 /*
 237  *
 238  * factories stuff
 239  *
 240  **/
 241 typedef struct _GstElementDetails GstElementDetails;
 242
 243 struct _GstElementDetails {
 244   gchar *longname;              /* long, english name */
 245   gchar *klass;                 /* type of element, as hierarchy */
 246   gchar *description;           /* insights of one form or another */
 247   gchar *version;               /* version of the element */
 248   gchar *author;                /* who wrote this thing? */
 249   gchar *copyright;             /* copyright details (year, etc.) */
 250 };
 251
 252 #define GST_TYPE_ELEMENTFACTORY                 (gst_elementfactory_get_type())
 253 #define GST_ELEMENTFACTORY(obj)                 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENTFACTORY,\
 254                                                  GstElementFactory))
 255 #define GST_ELEMENTFACTORY_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENTFACTORY,\
 256                                                  GstElementFactoryClass))
 257 #define GST_IS_ELEMENTFACTORY(obj)              (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENTFACTORY))
 258 #define GST_IS_ELEMENTFACTORY_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENTFACTORY))
 259
 260 struct _GstElementFactory {
 261   GstPluginFeature feature;
 262
 263   GType type;                   /* unique GType of element */
 264
 265   guint details_dynamic : 1;
 266
 267   GstElementDetails *details;   /* pointer to details struct */
 268
 269   GList *padtemplates;
 270   guint16 numpadtemplates;
 271 };
 272
 273 struct _GstElementFactoryClass {
 274   GstPluginFeatureClass parent_class;
 275 };
 276
 277 GType                   gst_elementfactory_get_type             (void);
 278
 279 GstElementFactory*      gst_elementfactory_new                  (const gchar *name,GType type,
 280                                                                  GstElementDetails *details);
 281
 282 GstElementFactory*      gst_elementfactory_find                 (const gchar *name);
 283 const GList*            gst_elementfactory_get_list             (void);
 284
 285 void                    gst_elementfactory_add_padtemplate      (GstElementFactory *elementfactory,
 286                                                                  GstPadTemplate *templ);
 287
 288 gboolean                gst_elementfactory_can_src_caps         (GstElementFactory *factory,
 289                                                                  GstCaps *caps);
 290 gboolean                gst_elementfactory_can_sink_caps        (GstElementFactory *factory,
 291                                                                  GstCaps *caps);
 292
 293 GstElement*             gst_elementfactory_create               (GstElementFactory *factory,
 294                                                                  const gchar *name);
 295 /* FIXME this name is wrong, probably so is the one above it */
 296 GstElement*             gst_elementfactory_make                 (const gchar *factoryname, const gchar *name);
 297
 298
 299 #ifdef __cplusplus
 300 }
 301 #endif /* __cplusplus */
 302
 303
 304 #endif /* __GST_ELEMENT_H__ */
 305