gst/: Move elementfactory methods to separate .h file.
[platform/upstream/gstreamer.git] / gst / gstelement.h
index 464b831..289d21c 100644 (file)
 #include <gst/gstobject.h>
 #include <gst/gstpad.h>
 #include <gst/gstclock.h>
+#include <gst/gstelementfactory.h>
 #include <gst/gstplugin.h>
 #include <gst/gstpluginfeature.h>
 #include <gst/gstindex.h>
 #include <gst/gstiterator.h>
+#include <gst/gstmessage.h>
 #include <gst/gsttag.h>
 
 G_BEGIN_DECLS
 
-typedef struct _GstElementDetails GstElementDetails;
-
-/* FIXME: need translatable stuff in here (how handle in registry)? */
-struct _GstElementDetails
-{
-  /*< public > */
-  gchar *longname;              /* long, english name */
-  gchar *klass;                 /* type of element, as hierarchy */
-  gchar *description;           /* insights of one form or another */
-  gchar *author;                /* who wrote this thing? */
-
-  /*< private > */
-  gpointer _gst_reserved[GST_PADDING];
-};
+GST_EXPORT GType _gst_element_type;
 
-#define GST_ELEMENT_DETAILS(longname,klass,description,author)         \
-  { longname, klass, description, author, GST_PADDING_INIT }
-#define GST_IS_ELEMENT_DETAILS(details) (                                      \
-  (details) && ((details)->longname != NULL) && ((details)->klass != NULL)     \
-  && ((details)->description != NULL) && ((details)->author != NULL))
+#define GST_TYPE_ELEMENT               (_gst_element_type)
+#define GST_IS_ELEMENT(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
+#define GST_IS_ELEMENT_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
+#define GST_ELEMENT_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ELEMENT, GstElementClass))
+#define GST_ELEMENT(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
+#define GST_ELEMENT_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
+#define GST_ELEMENT_CAST(obj)          ((GstElement*)(obj))
 
 #define GST_NUM_STATES 4
-
 /* NOTE: this probably should be done with an #ifdef to decide 
  * whether to safe-cast or to just do the non-checking cast.
  */
@@ -76,16 +66,6 @@ struct _GstElementDetails
 #define GST_STATE_PAUSED_TO_READY      ((GST_STATE_PAUSED<<8) | GST_STATE_READY)
 #define GST_STATE_READY_TO_NULL                ((GST_STATE_READY<<8) | GST_STATE_NULL)
 
-GST_EXPORT GType _gst_element_type;
-
-#define GST_TYPE_ELEMENT               (_gst_element_type)
-#define GST_IS_ELEMENT(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
-#define GST_IS_ELEMENT_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
-#define GST_ELEMENT_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ELEMENT, GstElementClass))
-#define GST_ELEMENT(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
-#define GST_ELEMENT_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
-#define GST_ELEMENT_CAST(obj)          ((GstElement*)(obj))
-
 /* convenience functions */
 #ifdef G_HAVE_ISO_VARARGS
 #define GST_ELEMENT_QUERY_TYPE_FUNCTION(functionname, ...) \
@@ -105,17 +85,6 @@ GST_EXPORT GType _gst_element_type;
 
 typedef enum
 {
-  /* input and output pads aren't directly coupled to each other
-     examples: queues, multi-output async readers, etc. */
-  GST_ELEMENT_DECOUPLED,
-  /* this element, for some reason, has a loop function that performs
-   * an infinite loop without calls to gst_element_yield () */
-  GST_ELEMENT_INFINITE_LOOP,
-  /* there is a new loopfunction ready for placement */
-  GST_ELEMENT_NEW_LOOPFUNC,
-  /* if this element can handle events */
-  GST_ELEMENT_EVENT_AWARE,
-
   /* private flags that can be used by the scheduler */
   GST_ELEMENT_SCHEDULER_PRIVATE1,
   GST_ELEMENT_SCHEDULER_PRIVATE2,
@@ -123,21 +92,20 @@ typedef enum
   /* ignore state changes from parent */
   GST_ELEMENT_LOCKED_STATE,
 
-  /* element is in error */
-  GST_ELEMENT_IN_ERROR,
+  /* the element is a sink */
+  GST_ELEMENT_IS_SINK,
 
   /* use some padding for future expansion */
   GST_ELEMENT_FLAG_LAST                = GST_OBJECT_FLAG_LAST + 16
 } GstElementFlags;
 
-#define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)   (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
-#define GST_ELEMENT_IS_EVENT_AWARE(obj)                (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
-#define GST_ELEMENT_IS_DECOUPLED(obj)          (GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
 #define GST_ELEMENT_IS_LOCKED_STATE(obj)        (GST_FLAG_IS_SET(obj,GST_ELEMENT_LOCKED_STATE))
 
 #define GST_ELEMENT_NAME(obj)                  (GST_OBJECT_NAME(obj))
-#define GST_ELEMENT_PARENT(obj)                        (GST_OBJECT_PARENT(obj))
-#define GST_ELEMENT_SCHEDULER(obj)             (GST_ELEMENT_CAST(obj)->sched)
+#define GST_ELEMENT_PARENT(obj)                        (GST_ELEMENT_CAST(GST_OBJECT_PARENT(obj)))
+#define GST_ELEMENT_MANAGER(obj)               (GST_ELEMENT_CAST(obj)->manager)
+#define GST_ELEMENT_BUS(obj)                   (GST_ELEMENT_CAST(obj)->bus)
+#define GST_ELEMENT_SCHEDULER(obj)             (GST_ELEMENT_CAST(obj)->scheduler)
 #define GST_ELEMENT_CLOCK(obj)                 (GST_ELEMENT_CAST(obj)->clock)
 #define GST_ELEMENT_PADS(obj)                  (GST_ELEMENT_CAST(obj)->pads)
 
@@ -153,23 +121,32 @@ typedef enum
  * data processing error. The pipeline will throw an error signal and the
  * application will be requested to stop further media processing.
  */
-#define GST_ELEMENT_ERROR(el, domain, code, message, debug)            \
-G_STMT_START {                                                                 \
-  gchar *__msg = _gst_element_error_printf message;                    \
-  gchar *__dbg = _gst_element_error_printf debug;                      \
-  if (__msg)                                                           \
-    GST_ERROR_OBJECT (el, "%s", __msg);                                \
-  if (__dbg)                                                           \
-    GST_ERROR_OBJECT (el, "%s", __dbg);                                \
-  gst_element_error_full (GST_ELEMENT(el),                             \
-    GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,       \
-    __msg, __dbg, __FILE__, GST_FUNCTION, __LINE__);                   \
+#define GST_ELEMENT_ERROR(el, domain, code, text, debug)               \
+G_STMT_START {                                                         \
+  gchar *__txt = _gst_element_error_printf text;                       \
+  gchar *__dbg = _gst_element_error_printf debug;                      \
+  if (__txt)                                                           \
+    GST_ERROR_OBJECT (el, "%s", __txt);                                        \
+  if (__dbg)                                                           \
+    GST_ERROR_OBJECT (el, "%s", __dbg);                                        \
+  gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_ERROR,                \
+    GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,       \
+    __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);                   \
 } G_STMT_END
 
-typedef struct _GstElementFactory GstElementFactory;
-typedef struct _GstElementFactoryClass GstElementFactoryClass;
-
-typedef void           (*GstElementLoopFunction)       (GstElement *element);
+/* log a (non-fatal) warning message and post it on the bus */
+#define GST_ELEMENT_WARNING(el, domain, code, text, debug)             \
+G_STMT_START {                                                         \
+  gchar *__txt = _gst_element_error_printf text;                       \
+  gchar *__dbg = _gst_element_error_printf debug;                      \
+  if (__txt)                                                           \
+    GST_WARNING_OBJECT (el, "%s", __txt);                              \
+  if (__dbg)                                                           \
+    GST_WARNING_OBJECT (el, "%s", __dbg);                              \
+  gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_WARNING,      \
+    GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,       \
+  __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);                     \
+} G_STMT_END
 
 /* the state change mutexes and conds */
 #define GST_STATE_GET_LOCK(elem)               (GST_ELEMENT_CAST(elem)->state_lock)
@@ -183,7 +160,7 @@ typedef void                (*GstElementLoopFunction)       (GstElement *element);
 #define GST_STATE_SIGNAL(elem)                 g_cond_signal (GST_STATE_GET_COND (elem));
 #define GST_STATE_BROADCAST(elem)              g_cond_broadcast (GST_STATE_GET_COND (elem));
 
-struct _GstElement 
+struct _GstElement
 {
   GstObject            object;
 
@@ -196,11 +173,10 @@ struct _GstElement
   gboolean              state_error; /* flag is set when the element has an error in the last state
                                         change. it is cleared when doing another state change. */
   /*< public >*/ /* with LOCK */
-  /* scheduling */
-  GstElementLoopFunction loopfunc;
-  GstScheduler                *sched;
-  /* private pointer for the scheduler */
-  gpointer             sched_private;
+  /* element manager */
+  GstPipeline                 *manager;
+  GstBus                      *bus;
+  GstScheduler                *scheduler;
 
   /* allocated clock */
   GstClock            *clock;
@@ -241,23 +217,22 @@ struct _GstElementClass
   void (*new_pad)      (GstElement *element, GstPad *pad);
   void (*pad_removed)  (GstElement *element, GstPad *pad);
   void (*no_more_pads) (GstElement *element);
-  void (*error)                (GstElement *element, GstElement *source, GError *error, gchar *debug);
-  void (*eos)          (GstElement *element);
-  void (*found_tag)    (GstElement *element, GstElement *source, const GstTagList *tag_list);
 
   /*< protected >*/
-  /* vtable*/
+  /* vtable */
 
   /* request/release pads */
   GstPad*              (*request_new_pad)      (GstElement *element, GstPadTemplate *templ, const gchar* name);
   void                 (*release_pad)          (GstElement *element, GstPad *pad);
 
   /* state changes */
+  GstElementStateReturn (*get_state)           (GstElement * element, GstElementState * state,
+                                                GstElementState * pending, GTimeVal * timeout);
   GstElementStateReturn (*change_state)                (GstElement *element);
-  GstElementStateReturn        (*set_state)            (GstElement *element, GstElementState state);
 
-  /* scheduling */
-  gboolean             (*release_locks)        (GstElement *element);
+  /* manager */
+  void                         (*set_manager)          (GstElement * element, GstPipeline * pipeline);
+  void                         (*set_bus)              (GstElement * element, GstBus * bus);
   void                 (*set_scheduler)        (GstElement *element, GstScheduler *scheduler);
 
   /* set/get clocks */
@@ -268,16 +243,12 @@ struct _GstElementClass
   GstIndex*            (*get_index)            (GstElement *element);
   void                 (*set_index)            (GstElement *element, GstIndex *index);
 
-  /* query/convert/events functions */
-  const GstEventMask*   (*get_event_masks)             (GstElement *element);
+  /* query functions */
   gboolean             (*send_event)           (GstElement *element, GstEvent *event);
-  const GstFormat*      (*get_formats)         (GstElement *element);
-  gboolean              (*convert)             (GstElement *element,
-                                                GstFormat  src_format,  gint64  src_value,
-                                                GstFormat *dest_format, gint64 *dest_value);
+
   const GstQueryType*  (*get_query_types)      (GstElement *element);
-  gboolean             (*query)                (GstElement *element, GstQueryType type,
-                                                GstFormat *format, gint64 *value);
+  gboolean             (*query)                (GstElement *element, GstQuery *query);
+
   /*< private >*/
   gpointer _gst_reserved[GST_PADDING];
 };
@@ -303,30 +274,19 @@ gboolean          gst_element_requires_clock      (GstElement *element);
 gboolean               gst_element_provides_clock      (GstElement *element);
 GstClock*              gst_element_get_clock           (GstElement *element);
 void                   gst_element_set_clock           (GstElement *element, GstClock *clock);
-GstClockReturn         gst_element_clock_wait          (GstElement *element, 
-                                                        GstClockID id, GstClockTimeDiff *jitter);
-GstClockTime           gst_element_get_time            (GstElement *element);
-gboolean               gst_element_wait                (GstElement *element, GstClockTime timestamp);
-void                   gst_element_set_time            (GstElement *element, GstClockTime time);
-void                   gst_element_set_time_delay      (GstElement *element, GstClockTime time, GstClockTime delay);
-
-void                   gst_element_adjust_time         (GstElement *element, GstClockTimeDiff diff);
 
 /* indexes */
 gboolean               gst_element_is_indexable        (GstElement *element);
 void                   gst_element_set_index           (GstElement *element, GstIndex *index);
 GstIndex*              gst_element_get_index           (GstElement *element);
 
-
-/* scheduling */
-void                   gst_element_set_loop_function   (GstElement *element,
-                                                        GstElementLoopFunction loop);
-gboolean               gst_element_release_locks       (GstElement *element);
-void                   gst_element_yield               (GstElement *element);
-gboolean               gst_element_interrupt           (GstElement *element);
+/* manager and tasks */
+void                   gst_element_set_manager         (GstElement * element, GstPipeline * pipeline);
+GstPipeline *          gst_element_get_manager         (GstElement * element);
+void                   gst_element_set_bus             (GstElement * element, GstBus * bus);
+GstBus *               gst_element_get_bus             (GstElement * element);
 void                   gst_element_set_scheduler       (GstElement *element, GstScheduler *sched);
 GstScheduler*          gst_element_get_scheduler       (GstElement *element);
-GstBin*                        gst_element_get_managing_bin    (GstElement *element);
 
 /* pad management */
 gboolean               gst_element_add_pad             (GstElement *element, GstPad *pad);
@@ -342,121 +302,41 @@ void                     gst_element_release_request_pad (GstElement *element, GstPad *pad);
 GstIterator *          gst_element_iterate_pads        (GstElement * element);
 
 /* event/query/format stuff */
-G_CONST_RETURN GstEventMask*
-                       gst_element_get_event_masks     (GstElement *element);
 gboolean               gst_element_send_event          (GstElement *element, GstEvent *event);
 gboolean               gst_element_seek                (GstElement *element, GstSeekType seek_type,
                                                         guint64 offset);
 G_CONST_RETURN GstQueryType*
                        gst_element_get_query_types     (GstElement *element);
-gboolean               gst_element_query               (GstElement *element, GstQueryType type,
-                                                        GstFormat *format, gint64 *value);
-G_CONST_RETURN GstFormat*
-                       gst_element_get_formats         (GstElement *element);
-gboolean               gst_element_convert             (GstElement *element, 
-                                                        GstFormat  src_format,  gint64  src_value,
-                                                        GstFormat *dest_format, gint64 *dest_value);
+gboolean               gst_element_query               (GstElement *element, GstQuery *query);
+
+/* messages */
+gboolean               gst_element_post_message        (GstElement * element, GstMessage * message);
 
 /* error handling */
 gchar *                        _gst_element_error_printf       (const gchar *format, ...);
-void                   gst_element_error_full          (GstElement *element, GQuark domain, gint code, 
-                                                        gchar *message, gchar *debug, 
-                                                        const gchar *file, const gchar *function, gint line);
-void                   gst_element_default_error       (GObject *object, GstObject *orig, GError *error, gchar *debug);
-#define                gst_element_default_deep_notify gst_object_default_deep_notify
+void                   gst_element_message_full        (GstElement * element, GstMessageType type,
+                                                        GQuark domain, gint code, gchar * text, 
+                                                        gchar * debug, const gchar * file,
+                                                        const gchar * function, gint line);
 
 /* state management */
-void                   gst_element_set_eos             (GstElement *element);
-
 gboolean               gst_element_is_locked_state     (GstElement *element);
 gboolean               gst_element_set_locked_state    (GstElement *element, gboolean locked_state);
 gboolean               gst_element_sync_state_with_parent (GstElement *element);
 
-GstElementState         gst_element_get_state           (GstElement *element);
+GstElementStateReturn  gst_element_get_state           (GstElement * element, 
+                                                        GstElementState * state,
+                                                        GstElementState * pending, 
+                                                        GTimeVal * timeout);
 GstElementStateReturn  gst_element_set_state           (GstElement *element, GstElementState state);
 
-void                   gst_element_wait_state_change   (GstElement *element);
+void                   gst_element_abort_state         (GstElement * element);
+void                   gst_element_commit_state        (GstElement * element);
+void                   gst_element_lost_state          (GstElement * element);
 
 /* factory management */
 GstElementFactory*     gst_element_get_factory         (GstElement *element);
 
-
-/* misc */
-void                   gst_element_found_tags          (GstElement *element, const GstTagList *tag_list);
-void                   gst_element_found_tags_for_pad  (GstElement *element, GstPad *pad, GstClockTime timestamp, 
-                                                        GstTagList *list);
-/*
- *
- * factories stuff
- *
- **/
-
-#define GST_TYPE_ELEMENT_FACTORY               (gst_element_factory_get_type())
-#define GST_ELEMENT_FACTORY(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
-                                                GstElementFactory))
-#define GST_ELEMENT_FACTORY_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
-                                                GstElementFactoryClass))
-#define GST_IS_ELEMENT_FACTORY(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
-#define GST_IS_ELEMENT_FACTORY_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
-
-struct _GstElementFactory {
-  GstPluginFeature     parent;
-
-  GType                        type;                   /* unique GType of element or 0 if not loaded */
-
-  GstElementDetails    details;
-
-  GList *              padtemplates;
-  guint                        numpadtemplates;
-
-  /* URI interface stuff */
-  guint                        uri_type;
-  gchar **             uri_protocols;
-  
-  GList *              interfaces;             /* interfaces this element implements */
-
-  gpointer _gst_reserved[GST_PADDING];
-};
-
-struct _GstElementFactoryClass {
-  GstPluginFeatureClass parent_class;
-
-  gpointer _gst_reserved[GST_PADDING];
-};
-
-GType                  gst_element_factory_get_type            (void);
-
-gboolean               gst_element_register                    (GstPlugin *plugin,
-                                                                const gchar *name,
-                                                                guint rank,
-                                                                GType type);
-
-GstElementFactory *    gst_element_factory_find                (const gchar *name);
-GType                  gst_element_factory_get_element_type    (GstElementFactory *factory);
-G_CONST_RETURN gchar * gst_element_factory_get_longname        (GstElementFactory *factory);
-G_CONST_RETURN gchar * gst_element_factory_get_klass           (GstElementFactory *factory);
-G_CONST_RETURN gchar * gst_element_factory_get_description     (GstElementFactory *factory);
-G_CONST_RETURN gchar * gst_element_factory_get_author          (GstElementFactory *factory);
-guint                  gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
-G_CONST_RETURN GList * gst_element_factory_get_pad_templates   (GstElementFactory *factory);
-guint                  gst_element_factory_get_uri_type        (GstElementFactory *factory);           
-gchar **               gst_element_factory_get_uri_protocols   (GstElementFactory *factory);           
-
-GstElement*            gst_element_factory_create              (GstElementFactory *factory,
-                                                                const gchar *name);
-GstElement*            gst_element_factory_make                (const gchar *factoryname, const gchar *name);
-
-gboolean               gst_element_factory_can_src_caps        (GstElementFactory *factory,
-                                                                const GstCaps *caps);
-gboolean               gst_element_factory_can_sink_caps       (GstElementFactory *factory,
-                                                                const GstCaps *caps);
-
-void                   __gst_element_factory_add_pad_template  (GstElementFactory *elementfactory,
-                                                                GstPadTemplate *templ);
-void                   __gst_element_factory_add_interface     (GstElementFactory *elementfactory,
-                                                                const gchar *interfacename);
-
 G_END_DECLS
 
 #endif /* __GST_ELEMENT_H__ */
-