gstelement.h 8.61 KB
Newer Older
1 2 3 4 5
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wtay@chello.be>
 *
 * gstelement.h: Header for GstElement
Erik Walthinsen's avatar
Erik Walthinsen committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *
 * 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 <gnome-xml/parser.h>
28

Erik Walthinsen's avatar
Erik Walthinsen committed
29 30 31 32 33 34 35 36 37 38
#include <gst/gstobject.h>
#include <gst/gstpad.h>
#include <gst/cothreads.h>


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


39 40
typedef enum {
  GST_STATE_NONE_PENDING	= -1,
41 42 43 44
  GST_STATE_NULL		= 0,
  GST_STATE_READY		= 1,
  GST_STATE_PLAYING		= 2,
  GST_STATE_PAUSED		= 3,
45 46 47
} GstElementState;

typedef enum {
48 49 50
  GST_STATE_FAILURE		= 0,
  GST_STATE_SUCCESS		= 1,
  GST_STATE_ASYNC		= 2,
51 52 53 54 55 56 57 58 59 60 61 62 63
} GstElementStateReturn;

static inline char *_gst_print_statename(int state) {
  switch (state) {
    case -1: return "none pending";break;
    case 0: return "null";break;
    case 1: return "ready";break;
    case 2: return "playing";break;
    case 3: return "paused";break;
    default: return "";
  }
  return "";
}
Erik Walthinsen's avatar
Erik Walthinsen committed
64

65 66 67
#define GST_STATE(obj)			(GST_ELEMENT(obj)->current_state)
#define GST_STATE_PENDING(obj)		(GST_ELEMENT(obj)->pending_state)

68 69 70 71 72 73 74 75
#define GST_STATE_TRANSITION(obj)	((GST_STATE(obj)<<4) | GST_STATE_PENDING(obj))
#define GST_STATE_NULL_TO_READY 	((GST_STATE_NULL<<4) | GST_STATE_READY)
#define GST_STATE_READY_TO_PLAYING 	((GST_STATE_READY<<4) | GST_STATE_PLAYING)
#define GST_STATE_PLAYING_TO_PAUSED	((GST_STATE_PLAYING<<4) | GST_STATE_PAUSED)
#define GST_STATE_PAUSED_TO_PLAYING	((GST_STATE_PAUSED<<4) | GST_STATE_PLAYING)
#define GST_STATE_PLAYING_TO_READY 	((GST_STATE_PLAYING<<4) | GST_STATE_READY)
#define GST_STATE_READY_TO_NULL		((GST_STATE_READY<<4) | GST_STATE_NULL)

Erik Walthinsen's avatar
Erik Walthinsen committed
76 77 78 79 80 81 82 83
#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))
Wim Taymans's avatar
Wim Taymans committed
84
#define GST_IS_ELEMENT_CLASS(klass) \
85
  (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT))
Erik Walthinsen's avatar
Erik Walthinsen committed
86

87
typedef enum {
Wim Taymans's avatar
Wim Taymans committed
88
  /* element is complex (for some def.) and generally require a cothread */
89
  GST_ELEMENT_COMPLEX		= GST_OBJECT_FLAG_LAST,
Wim Taymans's avatar
Wim Taymans committed
90 91
  /* input and output pads aren't directly coupled to each other
     examples: queues, multi-output async readers, etc. */
92
  GST_ELEMENT_DECOUPLED,
Wim Taymans's avatar
Wim Taymans committed
93
  /* this element should be placed in a thread if at all possible */
94
  GST_ELEMENT_THREAD_SUGGESTED,
Wim Taymans's avatar
Wim Taymans committed
95
  /* this element is incable of seeking (FIXME: does this apply to filters?) */
96
  GST_ELEMENT_NO_SEEK,
97

Wim Taymans's avatar
Wim Taymans committed
98
  /* there is a new loopfunction ready for placement */
99
  GST_ELEMENT_NEW_LOOPFUNC,
Wim Taymans's avatar
Wim Taymans committed
100
  /* the cothread holding this element needs to be stopped */
101
  GST_ELEMENT_COTHREAD_STOPPING,
Wim Taymans's avatar
Wim Taymans committed
102
  /* the element has to be scheduled as a cothread for any sanity */
103
  GST_ELEMENT_USE_COTHREAD,
104 105 106

  /* use some padding for future expansion */
  GST_ELEMENT_FLAG_LAST		= GST_OBJECT_FLAG_LAST + 8,
107 108
} GstElementFlags;

109 110
#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))
111 112


Erik Walthinsen's avatar
Erik Walthinsen committed
113 114 115 116 117 118 119 120 121 122 123 124
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;

  gchar *name;

125 126
  guint8 current_state;
  guint8 pending_state;
Erik Walthinsen's avatar
Erik Walthinsen committed
127 128 129 130 131

  GstElementLoopFunction loopfunc;
  cothread_state *threadstate;

  guint16 numpads;
132 133
  guint16 numsrcpads;
  guint16 numsinkpads;
Erik Walthinsen's avatar
Erik Walthinsen committed
134 135 136 137 138 139 140 141 142 143 144 145
  GList *pads;

  GstElement *manager;
};

struct _GstElementClass {
  GstObjectClass parent_class;

  /* the elementfactory that created us */
  GstElementFactory *elementfactory;

  /* signal callbacks */
146 147
  void (*state_change) 	(GstElement *element,GstElementState state);
  void (*new_pad) 	(GstElement *element,GstPad *pad);
Erik Walthinsen's avatar
Erik Walthinsen committed
148
  void (*new_ghost_pad) (GstElement *element,GstPad *pad);
149
  void (*error) 	(GstElement *element,gchar *error);
150
  void (*eos)		(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
151 152

  /* change the element state */
153
  GstElementStateReturn (*change_state) (GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
154 155

  /* create or read XML representation of self */
Wim Taymans's avatar
Wim Taymans committed
156 157
  xmlNodePtr	(*save_thyself) 	(GstElement *element, xmlNodePtr parent);
  void 		(*restore_thyself) 	(GstElement *element, xmlNodePtr self, GHashTable *elements);
Erik Walthinsen's avatar
Erik Walthinsen committed
158 159 160 161
};

struct _GstElementDetails {
  gchar *longname;              /* long, english name */
162
  gchar *klass;                 /* type of element, kinda */
Erik Walthinsen's avatar
Erik Walthinsen committed
163 164 165 166 167 168 169
  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 {
170 171
  gchar *name;			/* name of element */
  GtkType type;			/* unique GtkType of element */
Erik Walthinsen's avatar
Erik Walthinsen committed
172

173
  GstElementDetails *details;	/* pointer to details struct */
174

175
  GList *padtemplates;
176
  guint16 numpadtemplates;
Erik Walthinsen's avatar
Erik Walthinsen committed
177 178
};

179 180 181
GtkType 		gst_element_get_type		(void);
GstElement*		gst_element_new			(void);
#define 		gst_element_destroy(element) 	gst_object_destroy (GST_OBJECT (element))
Erik Walthinsen's avatar
Erik Walthinsen committed
182

183 184
void 			gst_element_set_loop_function	(GstElement *element,
                                   			 GstElementLoopFunction loop);
Erik Walthinsen's avatar
Erik Walthinsen committed
185

186
void 			gst_element_set_name		(GstElement *element, gchar *name);
Wim Taymans's avatar
Wim Taymans committed
187
const gchar*		gst_element_get_name		(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
188

189 190
void 			gst_element_set_manager		(GstElement *element, GstElement *manager);
GstElement*		gst_element_get_manager		(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
191

192 193 194
void 			gst_element_add_pad		(GstElement *element, GstPad *pad);
GstPad*			gst_element_get_pad		(GstElement *element, gchar *name);
GList*			gst_element_get_pad_list	(GstElement *element);
Wim Taymans's avatar
Wim Taymans committed
195
GList*			gst_element_get_padtemplate_list	(GstElement *element);
196
void 			gst_element_add_ghost_pad	(GstElement *element, GstPad *pad);
197
void			gst_element_remove_ghost_pad	(GstElement *element, GstPad *pad);
Erik Walthinsen's avatar
Erik Walthinsen committed
198

199 200
void 			gst_element_connect		(GstElement *src, gchar *srcpadname,
                         				 GstElement *dest, gchar *destpadname);
Erik Walthinsen's avatar
Erik Walthinsen committed
201

202 203 204
void			gst_element_signal_eos		(GstElement *element);


Erik Walthinsen's avatar
Erik Walthinsen committed
205
/* called by the app to set the state of the element */
206
gint 			gst_element_set_state		(GstElement *element, GstElementState state);
Erik Walthinsen's avatar
Erik Walthinsen committed
207

208
void 			gst_element_error		(GstElement *element, gchar *error);
Erik Walthinsen's avatar
Erik Walthinsen committed
209

210
GstElementFactory*	gst_element_get_factory		(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
211 212

/* XML write and read */
213 214
xmlNodePtr 		gst_element_save_thyself	(GstElement *element, xmlNodePtr parent);
GstElement*		gst_element_load_thyself	(xmlNodePtr parent, GHashTable *elements);
Erik Walthinsen's avatar
Erik Walthinsen committed
215 216


217 218 219 220 221 222 223 224
/* 
 *
 * factories stuff
 *
 **/
GstElementFactory*	gst_elementfactory_new			(gchar *name,GtkType type,
                                          			 GstElementDetails *details);
void 			gst_elementfactory_destroy		(GstElementFactory *elementfactory);
225

226
void 			gst_elementfactory_add_padtemplate	(GstElementFactory *elementfactory, 
Wim Taymans's avatar
Wim Taymans committed
227
							 	 GstPadTemplate *temp);
228 229 230

GstElementFactory*	gst_elementfactory_find			(gchar *name);
GList*			gst_elementfactory_get_list		(void);
Erik Walthinsen's avatar
Erik Walthinsen committed
231

232 233 234 235
gboolean		gst_elementfactory_can_src_caps 	(GstElementFactory *factory,
								 GstCaps *caps);
gboolean		gst_elementfactory_can_sink_caps 	(GstElementFactory *factory,
							 	 GstCaps *caps);
Wim Taymans's avatar
Wim Taymans committed
236 237 238 239
gboolean		gst_elementfactory_can_src_caps_list 	(GstElementFactory *factory,
								 GList *caps);
gboolean		gst_elementfactory_can_sink_caps_list 	(GstElementFactory *factory,
							 	 GList *caps);
Erik Walthinsen's avatar
Erik Walthinsen committed
240

241 242
GstElement*		gst_elementfactory_create		(GstElementFactory *factory,
                                      				 gchar *name);
Wim Taymans's avatar
Wim Taymans committed
243
/* FIXME this name is wrong, probably so is the one above it */
244
GstElement*		gst_elementfactory_make			(gchar *factoryname, gchar *name);
245

246 247
xmlNodePtr 		gst_elementfactory_save_thyself		(GstElementFactory *factory, xmlNodePtr parent); 
GstElementFactory*	gst_elementfactory_load_thyself		(xmlNodePtr parent);
Erik Walthinsen's avatar
Erik Walthinsen committed
248 249 250 251 252 253 254 255

#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GST_ELEMENT_H__ */