gst/: Move elementfactory methods to separate .h file.
[platform/upstream/gstreamer.git] / gst / gstelement.h
index 2d71f2f..289d21c 100644 (file)
@@ -29,6 +29,7 @@
 #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>
 
 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.
  */
@@ -77,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, ...) \
@@ -113,6 +92,9 @@ typedef enum
   /* ignore state changes from parent */
   GST_ELEMENT_LOCKED_STATE,
 
+  /* 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;
@@ -178,9 +160,6 @@ G_STMT_START {                                                              \
 #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));
 
-typedef struct _GstElementFactory GstElementFactory;
-typedef struct _GstElementFactoryClass GstElementFactoryClass;
-
 struct _GstElement
 {
   GstObject            object;
@@ -195,11 +174,9 @@ struct _GstElement
                                         change. it is cleared when doing another state change. */
   /*< public >*/ /* with LOCK */
   /* element manager */
-  GstPipeline  *manager;
-  GstBus       *bus;
+  GstPipeline                 *manager;
+  GstBus                      *bus;
   GstScheduler                *scheduler;
-  /* private pointer for the scheduler */
-  gpointer             sched_private;
 
   /* allocated clock */
   GstClock            *clock;
@@ -249,13 +226,13 @@ struct _GstElementClass
   void                 (*release_pad)          (GstElement *element, GstPad *pad);
 
   /* state changes */
-  GstElementStateReturn (*get_state)   (GstElement * element, GstElementState * state,
-                                        GstElementState * pending, GTimeVal * timeout);
+  GstElementStateReturn (*get_state)           (GstElement * element, GstElementState * state,
+                                                GstElementState * pending, GTimeVal * timeout);
   GstElementStateReturn (*change_state)                (GstElement *element);
 
   /* manager */
-  void (*set_manager)      (GstElement * element, GstPipeline * pipeline);
-  void (*set_bus)          (GstElement * element, GstBus * bus);
+  void                         (*set_manager)          (GstElement * element, GstPipeline * pipeline);
+  void                         (*set_bus)              (GstElement * element, GstBus * bus);
   void                 (*set_scheduler)        (GstElement *element, GstScheduler *scheduler);
 
   /* set/get clocks */
@@ -266,16 +243,11 @@ 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];
@@ -309,10 +281,10 @@ void                      gst_element_set_index           (GstElement *element, GstIndex *index);
 GstIndex*              gst_element_get_index           (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_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);
 
@@ -330,114 +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);
+gboolean               gst_element_post_message        (GstElement * element, GstMessage * message);
 
 /* error handling */
 gchar *                        _gst_element_error_printf       (const gchar *format, ...);
-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);
+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 */
 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);
 
-GstElementStateReturn  gst_element_get_state                   (GstElement * element, 
-                                                                GstElementState * state,
-                                                                GstElementState * pending, 
-                                                                GTimeVal * timeout);
+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_abort_state                 (GstElement * element);
-void                   gst_element_commit_state                (GstElement * element);
-void                   gst_element_lost_state                  (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);
 
-/*
- *
- * 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);
-
-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__ */