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 <parser.h> // NOTE: this is xml-config's fault
  28
  29 // Include compatability defines: if libxml hasn't already defined these,
  30 // we have an old version 1.x
  31 #ifndef xmlChildrenNode
  32 #define xmlChildrenNode childs
  33 #define xmlRootNode root
  34 #endif
  35
  36 #include <gst/gstobject.h>
  37 #include <gst/gstpad.h>
  38 #include <gst/cothreads.h>
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif /* __cplusplus */
  43
  44
  45 typedef enum {
  46   GST_STATE_VOID_PENDING        = 0,
  47   GST_STATE_NULL                = (1 << 0),
  48   GST_STATE_READY               = (1 << 1),
  49   GST_STATE_PAUSED              = (1 << 2),
  50   GST_STATE_PLAYING             = (1 << 3),
  51 } GstElementState;
  52
  53 typedef enum {
  54   GST_STATE_FAILURE             = 0,
  55   GST_STATE_SUCCESS             = 1,
  56   GST_STATE_ASYNC               = 2,
  57 } GstElementStateReturn;
  58
  59
  60 // NOTE: this probably should be done with an #ifdef to decide whether to safe-cast
  61 // or to just do the non-checking cast.
  62 #define GST_STATE(obj)                  (GST_ELEMENT(obj)->current_state)
  63 #define GST_STATE_PENDING(obj)          (GST_ELEMENT(obj)->pending_state)
  64
  65 // Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g>
  66 #define GST_STATE_TRANSITION(obj)       ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
  67 #define GST_STATE_NULL_TO_READY         ((GST_STATE_NULL<<8) | GST_STATE_READY)
  68 #define GST_STATE_READY_TO_PAUSED       ((GST_STATE_READY<<8) | GST_STATE_PAUSED)
  69 #define GST_STATE_PAUSED_TO_PLAYING     ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
  70 #define GST_STATE_PLAYING_TO_PAUSED     ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
  71 #define GST_STATE_PAUSED_TO_READY       ((GST_STATE_PAUSED<<8) | GST_STATE_READY)
  72 #define GST_STATE_READY_TO_NULL         ((GST_STATE_READY<<8) | GST_STATE_NULL)
  73
  74 #define GST_TYPE_ELEMENT \
  75   (gst_element_get_type())
  76 #define GST_ELEMENT(obj) \
  77   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT,GstElement))
  78 #define GST_ELEMENT_CLASS(klass) \
  79   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT,GstElementClass))
  80 #define GST_IS_ELEMENT(obj) \
  81   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT))
  82 #define GST_IS_ELEMENT_CLASS(klass) \
  83   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT))
  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   /* use some padding for future expansion */
 113   GST_ELEMENT_FLAG_LAST         = GST_OBJECT_FLAG_LAST + 12,
 114 } GstElementFlags;
 115
 116 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)    (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
 117 #define GST_ELEMENT_IS_COTHREAD_STOPPING(obj)   (GST_FLAG_IS_SET(obj,GST_ELEMENT_COTHREAD_STOPPING))
 118 #define GST_ELEMENT_IS_EOS(obj)                 (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
 119
 120 #define GST_ELEMENT_NAME(obj)                   (GST_OBJECT_NAME(obj))
 121 #define GST_ELEMENT_PARENT(obj)                 (GST_OBJECT_PARENT(obj))
 122 #define GST_ELEMENT_MANAGER(obj)                (((GstElement*)(obj))->manager)
 123 #define GST_ELEMENT_SCHED(obj)                  (((GstElement*)(obj))->sched)
 124 #define GST_ELEMENT_PADS(obj)                   ((obj)->pads)
 125
 126 //typedef struct _GstElement GstElement;
 127 //typedef struct _GstElementClass GstElementClass;
 128 typedef struct _GstElementDetails GstElementDetails;
 129 typedef struct _GstElementFactory GstElementFactory;
 130
 131 typedef void (*GstElementLoopFunction) (GstElement *element);
 132
 133 struct _GstElement {
 134   GstObject object;
 135
 136   guint8 current_state;
 137   guint8 pending_state;
 138
 139   GstElementLoopFunction loopfunc;
 140   cothread_state *threadstate;
 141
 142   guint16 numpads;
 143   guint16 numsrcpads;
 144   guint16 numsinkpads;
 145   GList *pads;
 146
 147   GstElement *manager;
 148   GstSchedule *sched;
 149 };
 150
 151 struct _GstElementClass {
 152   GstObjectClass parent_class;
 153
 154   /* the elementfactory that created us */
 155   GstElementFactory *elementfactory;
 156
 157   /* signal callbacks */
 158   void (*state_change)          (GstElement *element,GstElementState state);
 159   void (*new_pad)               (GstElement *element,GstPad *pad);
 160   void (*pad_removed)           (GstElement *element,GstPad *pad);
 161   void (*new_ghost_pad)         (GstElement *element,GstPad *pad);
 162   void (*ghost_pad_removed)     (GstElement *element,GstPad *pad);
 163   void (*error)                 (GstElement *element,gchar *error);
 164   void (*eos)                   (GstElement *element);
 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, const GValue *value, GParamSpec *pspec);
 169
 170   /* change the element state */
 171   GstElementStateReturn (*change_state)         (GstElement *element);
 172   /* request a new pad */
 173   GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ);
 174 };
 175
 176 struct _GstElementDetails {
 177   gchar *longname;              /* long, english name */
 178   gchar *klass;                 /* type of element, as hierarchy */
 179   gchar *description;           /* insights of one form or another */
 180   gchar *version;               /* version of the element */
 181   gchar *author;                /* who wrote this thing? */
 182   gchar *copyright;             /* copyright details (year, etc.) */
 183 };
 184
 185 struct _GstElementFactory {
 186   gchar *name;                  /* name of element */
 187   GType type;                   /* unique GType of element */
 188
 189   GstElementDetails *details;   /* pointer to details struct */
 190
 191   GList *padtemplates;
 192   guint16 numpadtemplates;
 193 };
 194
 195 GType                   gst_element_get_type            (void);
 196 GstElement*             gst_element_new                 (void);
 197 #define                 gst_element_destroy(element)    gst_object_destroy (GST_OBJECT (element))
 198
 199 void                    gst_element_set_loop_function   (GstElement *element,
 200                                                          GstElementLoopFunction loop);
 201
 202 void                    gst_element_set_name            (GstElement *element, const gchar *name);
 203 const gchar*            gst_element_get_name            (GstElement *element);
 204
 205 void                    gst_element_set_parent          (GstElement *element, GstObject *parent);
 206 GstObject*              gst_element_get_parent          (GstElement *element);
 207
 208 void                    gst_element_set_sched           (GstElement *element, GstSchedule *sched);
 209 GstSchedule*            gst_element_get_sched           (GstElement *element);
 210
 211 void                    gst_element_add_pad             (GstElement *element, GstPad *pad);
 212 void                    gst_element_remove_pad          (GstElement *element, GstPad *pad);
 213 GstPad*                 gst_element_get_pad             (GstElement *element, const gchar *name);
 214 GList*                  gst_element_get_pad_list        (GstElement *element);
 215 GList*                  gst_element_get_padtemplate_list        (GstElement *element);
 216 GstPadTemplate*         gst_element_get_padtemplate_by_name     (GstElement *element, const guchar *name);
 217 void                    gst_element_add_ghost_pad       (GstElement *element, GstPad *pad, gchar *name);
 218 void                    gst_element_remove_ghost_pad    (GstElement *element, GstPad *pad);
 219
 220 GstPad*                 gst_element_request_compatible_pad (GstElement *element, GstPadTemplate *templ);
 221 GstPad*                 gst_element_request_pad_by_name (GstElement *element, const gchar *name);
 222
 223 void                    gst_element_connect             (GstElement *src, const gchar *srcpadname,
 224                                                          GstElement *dest, const gchar *destpadname);
 225 void                    gst_element_disconnect          (GstElement *src, const gchar *srcpadname,
 226                                                          GstElement *dest, const gchar *destpadname);
 227
 228 void                    gst_element_signal_eos          (GstElement *element);
 229
 230
 231 /* called by the app to set the state of the element */
 232 gint                    gst_element_set_state           (GstElement *element, GstElementState state);
 233
 234 void                    gst_element_error               (GstElement *element, const gchar *error);
 235
 236 GstElementFactory*      gst_element_get_factory         (GstElement *element);
 237
 238 /* XML write and read */
 239 GstElement*             gst_element_restore_thyself     (xmlNodePtr self, GstObject *parent);
 240
 241
 242 /*
 243  *
 244  * factories stuff
 245  *
 246  **/
 247 GstElementFactory*      gst_elementfactory_new                  (const gchar *name,GType type,
 248                                                                  GstElementDetails *details);
 249 void                    gst_elementfactory_destroy              (GstElementFactory *elementfactory);
 250
 251 GstElementFactory*      gst_elementfactory_find                 (const gchar *name);
 252 GList*                  gst_elementfactory_get_list             (void);
 253
 254 void                    gst_elementfactory_add_padtemplate      (GstElementFactory *elementfactory,
 255                                                                  GstPadTemplate *templ);
 256
 257 gboolean                gst_elementfactory_can_src_caps         (GstElementFactory *factory,
 258                                                                  GstCaps *caps);
 259 gboolean                gst_elementfactory_can_sink_caps        (GstElementFactory *factory,
 260                                                                  GstCaps *caps);
 261
 262 GstElement*             gst_elementfactory_create               (GstElementFactory *factory,
 263                                                                  const gchar *name);
 264 /* FIXME this name is wrong, probably so is the one above it */
 265 GstElement*             gst_elementfactory_make                 (const gchar *factoryname, const gchar *name);
 266
 267
 268 xmlNodePtr              gst_elementfactory_save_thyself         (GstElementFactory *factory, xmlNodePtr parent);
 269 GstElementFactory*      gst_elementfactory_load_thyself         (xmlNodePtr parent);
 270
 271
 272 const gchar *           gst_element_statename                   (int state);
 273
 274 #ifdef __cplusplus
 275 }
 276 #endif /* __cplusplus */
 277
 278
 279 #endif /* __GST_ELEMENT_H__ */
 280