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