gstelement.h 6.85 KB
Newer Older
Erik Walthinsen's avatar
Erik Walthinsen committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
/* Gnome-Streamer
 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
 *
 * 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>
#include <gst/gstlog.h>
#include <gst/gstobject.h>
#include <gst/gstpad.h>
#include <gst/gstbuffer.h>
#include <gst/cothreads.h>


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


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

typedef enum {
47 48 49
  GST_STATE_FAILURE		= 0,
  GST_STATE_SUCCESS		= 1,
  GST_STATE_ASYNC		= 2,
50 51 52 53 54 55 56 57 58 59 60 61 62
} 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
63

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

Erik Walthinsen's avatar
Erik Walthinsen committed
67 68 69 70 71 72 73 74
#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
75
#define GST_IS_ELEMENT_CLASS(klass) \
76
  (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT))
Erik Walthinsen's avatar
Erik Walthinsen committed
77

78
typedef enum {
Wim Taymans's avatar
Wim Taymans committed
79 80
  GST_ELEMENT_MULTI_IN		= (1 << 4),
  GST_ELEMENT_THREAD_SUGGESTED	= (1 << 5),
81
  GST_ELEMENT_NO_SEEK		= (1 << 6),
82 83

  GST_ELEMENT_NEW_LOOPFUNC	= (1 << 16),
84 85 86
} GstElementFlags;

#define GST_ELEMENT_IS_MULTI_IN(obj)	(GST_FLAGS(obj) & GST_ELEMENT_MULTI_IN)
Wim Taymans's avatar
Wim Taymans committed
87
#define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)	(GST_FLAGS(obj) & GST_ELEMENT_THREAD_SUGGESTED)
88 89


Erik Walthinsen's avatar
Erik Walthinsen committed
90 91 92 93 94 95 96 97 98 99 100 101
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;

102 103
  guint8 current_state;
  guint8 pending_state;
Erik Walthinsen's avatar
Erik Walthinsen committed
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120

  GstElementLoopFunction loopfunc;
  cothread_state *threadstate;

  guint16 numpads;
  GList *pads;

  GstElement *manager;
};

struct _GstElementClass {
  GstObjectClass parent_class;

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

  /* signal callbacks */
121 122
  void (*state_change) 	(GstElement *element,GstElementState state);
  void (*new_pad) 	(GstElement *element,GstPad *pad);
Erik Walthinsen's avatar
Erik Walthinsen committed
123
  void (*new_ghost_pad) (GstElement *element,GstPad *pad);
124
  void (*error) 	(GstElement *element,gchar *error);
Erik Walthinsen's avatar
Erik Walthinsen committed
125 126

  /* events */
127 128
//  gboolean (*start) (GstElement *element,GstElementState state);
//  gboolean (*stop) (GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
129 130

  /* change the element state */
131
  GstElementStateReturn (*change_state) (GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
132 133

  /* create or read XML representation of self */
134 135
  xmlNodePtr 		(*save_thyself) (GstElement *element, xmlNodePtr parent);
  void 			(*restore_thyself) (GstElement *element, xmlNodePtr self, GHashTable *elements);
Erik Walthinsen's avatar
Erik Walthinsen committed
136 137 138 139 140 141 142 143 144 145 146 147
};

struct _GstElementDetails {
  gchar *longname;              /* long, english name */
  gchar *class;                 /* type of element, kinda */
  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 {
148 149
  gchar *name;			/* name of element */
  GtkType type;			/* unique GtkType of element */
Erik Walthinsen's avatar
Erik Walthinsen committed
150

151
  GstElementDetails *details;	/* pointer to details struct */
152 153 154

  GList *src_types;
  GList *sink_types;
Erik Walthinsen's avatar
Erik Walthinsen committed
155 156
};

157 158 159
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
160

161 162
void 			gst_element_set_loop_function	(GstElement *element,
                                   			 GstElementLoopFunction loop);
Erik Walthinsen's avatar
Erik Walthinsen committed
163

164
void 			gst_element_set_name		(GstElement *element, gchar *name);
Wim Taymans's avatar
Wim Taymans committed
165
const gchar*		gst_element_get_name		(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
166

167 168
void 			gst_element_set_manager		(GstElement *element, GstElement *manager);
GstElement*		gst_element_get_manager		(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
169

170 171 172 173
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);
void 			gst_element_add_ghost_pad	(GstElement *element, GstPad *pad);
Erik Walthinsen's avatar
Erik Walthinsen committed
174

175 176
void 			gst_element_connect		(GstElement *src, gchar *srcpadname,
                         				 GstElement *dest, gchar *destpadname);
Erik Walthinsen's avatar
Erik Walthinsen committed
177 178

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

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

183 184
GstElementFactory*	gst_element_get_factory		(GstElement *element);
int 			gst_element_loopfunc_wrapper	(int argc,char **argv);
Erik Walthinsen's avatar
Erik Walthinsen committed
185 186

/* XML write and read */
187 188
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
189 190


191 192 193
GstElementFactory*	gst_elementfactory_new		(gchar *name,GtkType type,
                                          		 GstElementDetails *details);
void 			gst_elementfactory_register	(GstElementFactory *elementfactory);
194

195 196
void 			gst_elementfactory_add_src	(GstElementFactory *elementfactory, guint16 id);
void 			gst_elementfactory_add_sink	(GstElementFactory *elementfactory, guint16 id);
Erik Walthinsen's avatar
Erik Walthinsen committed
197

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

201 202 203 204
GstElement*		gst_elementfactory_create	(GstElementFactory *factory,
                                      			 gchar *name);
// FIXME this name is wrong, probably so is the one above it
GstElement*		gst_elementfactory_make		(gchar *factoryname, gchar *name);
205

206 207
xmlNodePtr 		gst_elementfactory_save_thyself	(GstElementFactory *factory, xmlNodePtr parent); 
GstElementFactory*	gst_elementfactory_load_thyself	(xmlNodePtr parent);
Erik Walthinsen's avatar
Erik Walthinsen committed
208 209 210 211 212 213 214 215

#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GST_ELEMENT_H__ */