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
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif /* __cplusplus */
  44
  45
  46 typedef enum {
  47   GST_STATE_NONE_PENDING        = 0,
  48   GST_STATE_NULL                = (1 << 0),
  49   GST_STATE_READY               = (1 << 1),
  50   GST_STATE_PLAYING             = (1 << 2),
  51   GST_STATE_PAUSED              = (1 << 3),
  52 } GstElementState;
  53
  54 typedef enum {
  55   GST_STATE_FAILURE             = 0,
  56   GST_STATE_SUCCESS             = 1,
  57   GST_STATE_ASYNC               = 2,
  58 } GstElementStateReturn;
  59
  60 static inline char *_gst_print_statename(int state) {
  61   switch (state) {
  62     case GST_STATE_NONE_PENDING: return "none pending";break;
  63     case GST_STATE_NULL: return "null";break;
  64     case GST_STATE_READY: return "ready";break;
  65     case GST_STATE_PLAYING: return "playing";break;
  66     case GST_STATE_PAUSED: return "paused";break;
  67     default: return "";
  68   }
  69   return "";
  70 }
  71
  72 #define GST_STATE(obj)                  (GST_ELEMENT(obj)->current_state)
  73 #define GST_STATE_PENDING(obj)          (GST_ELEMENT(obj)->pending_state)
  74
  75 // Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g>
  76 #define GST_STATE_TRANSITION(obj)       ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
  77 #define GST_STATE_NULL_TO_READY         ((GST_STATE_NULL<<8) | GST_STATE_READY)
  78 #define GST_STATE_READY_TO_PLAYING      ((GST_STATE_READY<<8) | GST_STATE_PLAYING)
  79 #define GST_STATE_PLAYING_TO_PAUSED     ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
  80 #define GST_STATE_PAUSED_TO_PLAYING     ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
  81 #define GST_STATE_PLAYING_TO_READY      ((GST_STATE_PLAYING<<8) | GST_STATE_READY)
  82 #define GST_STATE_READY_TO_NULL         ((GST_STATE_READY<<8) | GST_STATE_NULL)
  83
  84 #define GST_TYPE_ELEMENT \
  85   (gst_element_get_type())
  86 #define GST_ELEMENT(obj) \
  87   (GTK_CHECK_CAST((obj),GST_TYPE_ELEMENT,GstElement))
  88 #define GST_ELEMENT_CLASS(klass) \
  89   (GTK_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT,GstElementClass))
  90 #define GST_IS_ELEMENT(obj) \
  91   (GTK_CHECK_TYPE((obj),GST_TYPE_ELEMENT))
  92 #define GST_IS_ELEMENT_CLASS(klass) \
  93   (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT))
  94
  95 typedef enum {
  96   /* element is complex (for some def.) and generally require a cothread */
  97   GST_ELEMENT_COMPLEX           = GST_OBJECT_FLAG_LAST,
  98   /* input and output pads aren't directly coupled to each other
  99      examples: queues, multi-output async readers, etc. */
 100   GST_ELEMENT_DECOUPLED,
 101   /* this element should be placed in a thread if at all possible */
 102   GST_ELEMENT_THREAD_SUGGESTED,
 103   /* this element is incable of seeking (FIXME: does this apply to filters?) */
 104   GST_ELEMENT_NO_SEEK,
 105
 106   /* there is a new loopfunction ready for placement */
 107   GST_ELEMENT_NEW_LOOPFUNC,
 108   /* the cothread holding this element needs to be stopped */
 109   GST_ELEMENT_COTHREAD_STOPPING,
 110   /* the element has to be scheduled as a cothread for any sanity */
 111   GST_ELEMENT_USE_COTHREAD,
 112
 113   /* if this element is in EOS */
 114   GST_ELEMENT_EOS,
 115
 116   /* use some padding for future expansion */
 117   GST_ELEMENT_FLAG_LAST         = GST_OBJECT_FLAG_LAST + 8,
 118 } GstElementFlags;
 119
 120 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)    (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
 121 #define GST_ELEMENT_IS_COTHREAD_STOPPING(obj)   (GST_FLAG_IS_SET(obj,GST_ELEMENT_COTHREAD_STOPPING))
 122 #define GST_ELEMENT_IS_EOS(obj)                 (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
 123
 124
 125 typedef struct _GstElement GstElement;
 126 typedef struct _GstElementClass GstElementClass;
 127 typedef struct _GstElementDetails GstElementDetails;
 128 typedef struct _GstElementFactory GstElementFactory;
 129
 130 typedef void (*GstElementLoopFunction) (GstElement *element);
 131
 132 struct _GstElement {
 133   GstObject object;
 134
 135   gchar *name;
 136
 137   guint8 current_state;
 138   guint8 pending_state;
 139
 140   GstElementLoopFunction loopfunc;
 141   cothread_state *threadstate;
 142
 143   guint16 numpads;
 144   guint16 numsrcpads;
 145   guint16 numsinkpads;
 146   GList *pads;
 147
 148   GstElement *manager;
 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 (*new_ghost_pad) (GstElement *element,GstPad *pad);
 161   void (*error)         (GstElement *element,gchar *error);
 162   void (*eos)           (GstElement *element);
 163
 164   /* change the element state */
 165   GstElementStateReturn (*change_state)         (GstElement *element);
 166   /* request a new pad */
 167   GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ);
 168
 169   /* create or read XML representation of self */
 170   xmlNodePtr    (*save_thyself)         (GstElement *element, xmlNodePtr parent);
 171   void          (*restore_thyself)      (GstElement *element, xmlNodePtr self, GHashTable *elements);
 172 };
 173
 174 struct _GstElementDetails {
 175   gchar *longname;              /* long, english name */
 176   gchar *klass;                 /* type of element, as hierarchy */
 177   gchar *description;           /* insights of one form or another */
 178   gchar *version;               /* version of the element */
 179   gchar *author;                /* who wrote this thing? */
 180   gchar *copyright;             /* copyright details (year, etc.) */
 181 };
 182
 183 struct _GstElementFactory {
 184   gchar *name;                  /* name of element */
 185   GtkType type;                 /* unique GtkType of element */
 186
 187   GstElementDetails *details;   /* pointer to details struct */
 188
 189   GList *padtemplates;
 190   guint16 numpadtemplates;
 191 };
 192
 193 GtkType                 gst_element_get_type            (void);
 194 GstElement*             gst_element_new                 (void);
 195 #define                 gst_element_destroy(element)    gst_object_destroy (GST_OBJECT (element))
 196
 197 void                    gst_element_set_loop_function   (GstElement *element,
 198                                                          GstElementLoopFunction loop);
 199
 200 void                    gst_element_set_name            (GstElement *element, const gchar *name);
 201 const gchar*            gst_element_get_name            (GstElement *element);
 202
 203 void                    gst_element_set_manager         (GstElement *element, GstElement *manager);
 204 GstElement*             gst_element_get_manager         (GstElement *element);
 205
 206 void                    gst_element_add_pad             (GstElement *element, GstPad *pad);
 207 GstPad*                 gst_element_get_pad             (GstElement *element, const gchar *name);
 208 GList*                  gst_element_get_pad_list        (GstElement *element);
 209 GList*                  gst_element_get_padtemplate_list        (GstElement *element);
 210 GstPadTemplate*         gst_element_get_padtemplate_by_name     (GstElement *element, const guchar *name);
 211 void                    gst_element_add_ghost_pad       (GstElement *element, GstPad *pad, gchar *name);
 212 void                    gst_element_remove_ghost_pad    (GstElement *element, GstPad *pad);
 213
 214 GstPad*                 gst_element_request_compatible_pad (GstElement *element, GstPadTemplate *templ);
 215 GstPad*                 gst_element_request_pad_by_name (GstElement *element, const gchar *name);
 216
 217 void                    gst_element_connect             (GstElement *src, const gchar *srcpadname,
 218                                                          GstElement *dest, const gchar *destpadname);
 219 void                    gst_element_disconnect          (GstElement *src, const gchar *srcpadname,
 220                                                          GstElement *dest, const gchar *destpadname);
 221
 222 void                    gst_element_signal_eos          (GstElement *element);
 223
 224
 225 /* called by the app to set the state of the element */
 226 gint                    gst_element_set_state           (GstElement *element, GstElementState state);
 227
 228 void                    gst_element_error               (GstElement *element, const gchar *error);
 229
 230 GstElementFactory*      gst_element_get_factory         (GstElement *element);
 231
 232 /* XML write and read */
 233 xmlNodePtr              gst_element_save_thyself        (GstElement *element, xmlNodePtr parent);
 234 GstElement*             gst_element_load_thyself        (xmlNodePtr parent, GHashTable *elements);
 235
 236
 237 /*
 238  *
 239  * factories stuff
 240  *
 241  **/
 242 GstElementFactory*      gst_elementfactory_new                  (const gchar *name,GtkType type,
 243                                                                  GstElementDetails *details);
 244 void                    gst_elementfactory_destroy              (GstElementFactory *elementfactory);
 245
 246 GstElementFactory*      gst_elementfactory_find                 (const gchar *name);
 247 GList*                  gst_elementfactory_get_list             (void);
 248
 249 void                    gst_elementfactory_add_padtemplate      (GstElementFactory *elementfactory,
 250                                                                  GstPadTemplate *templ);
 251
 252 gboolean                gst_elementfactory_can_src_caps         (GstElementFactory *factory,
 253                                                                  GstCaps *caps);
 254 gboolean                gst_elementfactory_can_sink_caps        (GstElementFactory *factory,
 255                                                                  GstCaps *caps);
 256 gboolean                gst_elementfactory_can_src_caps_list    (GstElementFactory *factory,
 257                                                                  GList *caps);
 258 gboolean                gst_elementfactory_can_sink_caps_list   (GstElementFactory *factory,
 259                                                                  GList *caps);
 260
 261 GstElement*             gst_elementfactory_create               (GstElementFactory *factory,
 262                                                                  const gchar *name);
 263 /* FIXME this name is wrong, probably so is the one above it */
 264 GstElement*             gst_elementfactory_make                 (const gchar *factoryname, const gchar *name);
 265
 266 xmlNodePtr              gst_elementfactory_save_thyself         (GstElementFactory *factory, xmlNodePtr parent);
 267 GstElementFactory*      gst_elementfactory_load_thyself         (xmlNodePtr parent);
 268
 269 #ifdef __cplusplus
 270 }
 271 #endif /* __cplusplus */
 272
 273
 274 #endif /* __GST_ELEMENT_H__ */
 275