mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-29 21:21:12 +00:00
284 lines
10 KiB
C
284 lines
10 KiB
C
/* GStreamer
|
|
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
|
|
* 2000 Wim Taymans <wtay@chello.be>
|
|
*
|
|
* gstelement.h: Header for GstElement
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
|
|
#ifndef __GST_ELEMENT_H__
|
|
#define __GST_ELEMENT_H__
|
|
|
|
#include <parser.h> // NOTE: this is xml-config's fault
|
|
|
|
// Include compatability defines: if libxml hasn't already defined these,
|
|
// we have an old version 1.x
|
|
#ifndef xmlChildrenNode
|
|
#define xmlChildrenNode childs
|
|
#define xmlRootNode root
|
|
#endif
|
|
|
|
#include <gst/gstobject.h>
|
|
#include <gst/gstpad.h>
|
|
#include <gst/cothreads.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
|
|
typedef enum {
|
|
GST_STATE_NONE_PENDING = 0,
|
|
GST_STATE_NULL = (1 << 0),
|
|
GST_STATE_READY = (1 << 1),
|
|
GST_STATE_PAUSED = (1 << 2),
|
|
GST_STATE_PLAYING = (1 << 3),
|
|
} GstElementState;
|
|
|
|
typedef enum {
|
|
GST_STATE_FAILURE = 0,
|
|
GST_STATE_SUCCESS = 1,
|
|
GST_STATE_ASYNC = 2,
|
|
} GstElementStateReturn;
|
|
|
|
|
|
// NOTE: this probably should be done with an #ifdef to decide whether to safe-cast
|
|
// or to just do the non-checking cast.
|
|
#define GST_STATE(obj) (GST_ELEMENT(obj)->current_state)
|
|
#define GST_STATE_PENDING(obj) (GST_ELEMENT(obj)->pending_state)
|
|
|
|
// Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g>
|
|
#define GST_STATE_TRANSITION(obj) ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
|
|
#define GST_STATE_NULL_TO_READY ((GST_STATE_NULL<<8) | GST_STATE_READY)
|
|
#define GST_STATE_READY_TO_PAUSED ((GST_STATE_READY<<8) | GST_STATE_PAUSED)
|
|
#define GST_STATE_PAUSED_TO_PLAYING ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
|
|
#define GST_STATE_PLAYING_TO_PAUSED ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
|
|
#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)
|
|
|
|
#define GST_TYPE_ELEMENT \
|
|
(gst_element_get_type())
|
|
#define GST_ELEMENT(obj) \
|
|
(GTK_CHECK_CAST((obj),GST_TYPE_ELEMENT,GstElement))
|
|
#define GST_ELEMENT_CLASS(klass) \
|
|
(GTK_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT,GstElementClass))
|
|
#define GST_IS_ELEMENT(obj) \
|
|
(GTK_CHECK_TYPE((obj),GST_TYPE_ELEMENT))
|
|
#define GST_IS_ELEMENT_CLASS(klass) \
|
|
(GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT))
|
|
|
|
typedef enum {
|
|
/* element is complex (for some def.) and generally require a cothread */
|
|
GST_ELEMENT_COMPLEX = GST_OBJECT_FLAG_LAST,
|
|
/* input and output pads aren't directly coupled to each other
|
|
examples: queues, multi-output async readers, etc. */
|
|
GST_ELEMENT_DECOUPLED,
|
|
/* this element should be placed in a thread if at all possible */
|
|
GST_ELEMENT_THREAD_SUGGESTED,
|
|
/* this element is incable of seeking (FIXME: does this apply to filters?) */
|
|
GST_ELEMENT_NO_SEEK,
|
|
|
|
/***** !!!!! need to have a flag that says that an element must
|
|
*not* be an entry into a scheduling chain !!!!! *****/
|
|
/* this element for some reason doesn't obey COTHREAD_STOPPING, or
|
|
has some other reason why it can't be the entry */
|
|
GST_ELEMENT_NO_ENTRY,
|
|
|
|
/* there is a new loopfunction ready for placement */
|
|
GST_ELEMENT_NEW_LOOPFUNC,
|
|
/* the cothread holding this element needs to be stopped */
|
|
GST_ELEMENT_COTHREAD_STOPPING,
|
|
/* the element has to be scheduled as a cothread for any sanity */
|
|
GST_ELEMENT_USE_COTHREAD,
|
|
|
|
/* if this element is in EOS */
|
|
GST_ELEMENT_EOS,
|
|
|
|
/* use some padding for future expansion */
|
|
GST_ELEMENT_FLAG_LAST = GST_OBJECT_FLAG_LAST + 12,
|
|
} GstElementFlags;
|
|
|
|
#define GST_ELEMENT_IS_THREAD_SUGGESTED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
|
|
#define GST_ELEMENT_IS_COTHREAD_STOPPING(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_COTHREAD_STOPPING))
|
|
#define GST_ELEMENT_IS_EOS(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
|
|
|
|
#define GST_ELEMENT_NAME(obj) (GST_OBJECT_NAME(obj))
|
|
#define GST_ELEMENT_PARENT(obj) (GST_OBJECT_PARENT(obj))
|
|
#define GST_ELEMENT_MANAGER(obj) (((GstElement*)(obj))->manager)
|
|
#define GST_ELEMENT_SCHED(obj) (((GstElement*)(obj))->sched)
|
|
#define GST_ELEMENT_PADS(obj) ((obj)->pads)
|
|
|
|
//typedef struct _GstElement GstElement;
|
|
//typedef struct _GstElementClass GstElementClass;
|
|
typedef struct _GstElementDetails GstElementDetails;
|
|
typedef struct _GstElementFactory GstElementFactory;
|
|
|
|
typedef void (*GstElementLoopFunction) (GstElement *element);
|
|
|
|
struct _GstElement {
|
|
GstObject object;
|
|
|
|
guint8 current_state;
|
|
guint8 pending_state;
|
|
|
|
GstElementLoopFunction loopfunc;
|
|
cothread_state *threadstate;
|
|
|
|
guint16 numpads;
|
|
guint16 numsrcpads;
|
|
guint16 numsinkpads;
|
|
GList *pads;
|
|
|
|
GstElement *manager;
|
|
GstSchedule *sched;
|
|
};
|
|
|
|
struct _GstElementClass {
|
|
GstObjectClass parent_class;
|
|
|
|
/* the elementfactory that created us */
|
|
GstElementFactory *elementfactory;
|
|
|
|
/* signal callbacks */
|
|
void (*state_change) (GstElement *element,GstElementState state);
|
|
void (*new_pad) (GstElement *element,GstPad *pad);
|
|
void (*pad_removed) (GstElement *element,GstPad *pad);
|
|
void (*new_ghost_pad) (GstElement *element,GstPad *pad);
|
|
void (*ghost_pad_removed) (GstElement *element,GstPad *pad);
|
|
void (*error) (GstElement *element,gchar *error);
|
|
void (*eos) (GstElement *element);
|
|
|
|
/* local pointers for get/set */
|
|
void (*set_arg) (GtkObject *object,
|
|
GtkArg *arg,
|
|
guint arg_id);
|
|
void (*get_arg) (GtkObject *object,
|
|
GtkArg *arg,
|
|
guint arg_id);
|
|
|
|
/* change the element state */
|
|
GstElementStateReturn (*change_state) (GstElement *element);
|
|
/* request a new pad */
|
|
GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *templ);
|
|
};
|
|
|
|
struct _GstElementDetails {
|
|
gchar *longname; /* long, english name */
|
|
gchar *klass; /* type of element, as hierarchy */
|
|
gchar *description; /* insights of one form or another */
|
|
gchar *version; /* version of the element */
|
|
gchar *author; /* who wrote this thing? */
|
|
gchar *copyright; /* copyright details (year, etc.) */
|
|
};
|
|
|
|
struct _GstElementFactory {
|
|
gchar *name; /* name of element */
|
|
GtkType type; /* unique GtkType of element */
|
|
|
|
GstElementDetails *details; /* pointer to details struct */
|
|
|
|
GList *padtemplates;
|
|
guint16 numpadtemplates;
|
|
};
|
|
|
|
GtkType gst_element_get_type (void);
|
|
GstElement* gst_element_new (void);
|
|
#define gst_element_destroy(element) gst_object_destroy (GST_OBJECT (element))
|
|
|
|
void gst_element_set_loop_function (GstElement *element,
|
|
GstElementLoopFunction loop);
|
|
|
|
void gst_element_set_name (GstElement *element, const gchar *name);
|
|
const gchar* gst_element_get_name (GstElement *element);
|
|
|
|
void gst_element_set_parent (GstElement *element, GstObject *parent);
|
|
GstObject* gst_element_get_parent (GstElement *element);
|
|
|
|
void gst_element_set_sched (GstElement *element, GstSchedule *sched);
|
|
GstSchedule* gst_element_get_sched (GstElement *element);
|
|
|
|
void gst_element_add_pad (GstElement *element, GstPad *pad);
|
|
void gst_element_remove_pad (GstElement *element, GstPad *pad);
|
|
GstPad* gst_element_get_pad (GstElement *element, const gchar *name);
|
|
GList* gst_element_get_pad_list (GstElement *element);
|
|
GList* gst_element_get_padtemplate_list (GstElement *element);
|
|
GstPadTemplate* gst_element_get_padtemplate_by_name (GstElement *element, const guchar *name);
|
|
void gst_element_add_ghost_pad (GstElement *element, GstPad *pad, gchar *name);
|
|
void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad);
|
|
|
|
GstPad* gst_element_request_compatible_pad (GstElement *element, GstPadTemplate *templ);
|
|
GstPad* gst_element_request_pad_by_name (GstElement *element, const gchar *name);
|
|
|
|
void gst_element_connect (GstElement *src, const gchar *srcpadname,
|
|
GstElement *dest, const gchar *destpadname);
|
|
void gst_element_disconnect (GstElement *src, const gchar *srcpadname,
|
|
GstElement *dest, const gchar *destpadname);
|
|
|
|
void gst_element_signal_eos (GstElement *element);
|
|
|
|
|
|
/* called by the app to set the state of the element */
|
|
gint gst_element_set_state (GstElement *element, GstElementState state);
|
|
|
|
void gst_element_error (GstElement *element, const gchar *error);
|
|
|
|
GstElementFactory* gst_element_get_factory (GstElement *element);
|
|
|
|
/* XML write and read */
|
|
GstElement* gst_element_restore_thyself (xmlNodePtr self, GstObject *parent);
|
|
|
|
|
|
/*
|
|
*
|
|
* factories stuff
|
|
*
|
|
**/
|
|
GstElementFactory* gst_elementfactory_new (const gchar *name,GtkType type,
|
|
GstElementDetails *details);
|
|
void gst_elementfactory_destroy (GstElementFactory *elementfactory);
|
|
|
|
GstElementFactory* gst_elementfactory_find (const gchar *name);
|
|
GList* gst_elementfactory_get_list (void);
|
|
|
|
void gst_elementfactory_add_padtemplate (GstElementFactory *elementfactory,
|
|
GstPadTemplate *templ);
|
|
|
|
gboolean gst_elementfactory_can_src_caps (GstElementFactory *factory,
|
|
GstCaps *caps);
|
|
gboolean gst_elementfactory_can_sink_caps (GstElementFactory *factory,
|
|
GstCaps *caps);
|
|
|
|
GstElement* gst_elementfactory_create (GstElementFactory *factory,
|
|
const gchar *name);
|
|
/* FIXME this name is wrong, probably so is the one above it */
|
|
GstElement* gst_elementfactory_make (const gchar *factoryname, const gchar *name);
|
|
|
|
|
|
xmlNodePtr gst_elementfactory_save_thyself (GstElementFactory *factory, xmlNodePtr parent);
|
|
GstElementFactory* gst_elementfactory_load_thyself (xmlNodePtr parent);
|
|
|
|
|
|
const gchar * gst_element_statename (int state);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
|
|
#endif /* __GST_ELEMENT_H__ */
|
|
|