From e990c2c7d59c4f323dc2b4d18a1a8ef1a7fe7483 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Tue, 7 Nov 2000 21:18:52 +0000 Subject: [PATCH] Updated docs Original commit message from CVS: Updated docs --- docs/gst/Makefile.am | 6 +- docs/gst/gstreamer-decl.txt | 419 +++++++++++++++++++++------------------- docs/gst/gstreamer-docs.sgml | 3 + docs/gst/gstreamer-sections.txt | 4 + 4 files changed, 229 insertions(+), 203 deletions(-) diff --git a/docs/gst/Makefile.am b/docs/gst/Makefile.am index 3cb58f3..8b09acd 100644 --- a/docs/gst/Makefile.am +++ b/docs/gst/Makefile.am @@ -10,7 +10,7 @@ DOC_MAIN_SGML_FILE=gstreamer-docs.sgml DOC_SOURCE_DIR=$(top_srcdir)/gst CFLAGS = $(GLIB_CFLAGS) $(GTK_CFLAGS) -I$(top_srcdir) -LDFLAGS = $(GLIB_LIBS) $(GTK_LIBS) $(top_srcdir)/gst/libgst.la $(top_srcdir)/gst/elements/libgstelements.la +LDFLAGS = $(GLIB_LIBS) $(GTK_LIBS) $(top_srcdir)/gst/.libs/libgst.so $(top_srcdir)/gst/elements/.libs/libgstelements.so EXTRA_DIST=gstreamer.types.in @@ -89,8 +89,8 @@ gstreamer-decl.txt: $(MAKE) scan scanobj: $(srcdir)/$(DOC_MODULE).types - -CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) gtkdoc-scanobj --module=$(DOC_MODULE) - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) + -CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" gtkdoc-scanobj --module=$(DOC_MODULE) + gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) scan: diff --git a/docs/gst/gstreamer-decl.txt b/docs/gst/gstreamer-decl.txt index f39ed4f..b573634 100644 --- a/docs/gst/gstreamer-decl.txt +++ b/docs/gst/gstreamer-decl.txt @@ -43,7 +43,7 @@ struct cothread_state { int *sp; int *top_sp; int *pc; - sigjmp_buf jmp; + jmp_buf jmp; }; @@ -52,22 +52,23 @@ struct cothread_context { cothread_state *threads[COTHREAD_MAXTHREADS]; int nthreads; int current; + GHashTable *data; }; cothread_init -cothread_context * +cothread_context * cothread_create -cothread_state * +cothread_state * cothread_context *ctx cothread_setfunc void -cothread_state *thread,cothread_func func,int argc,char **argv +cothread_state *thread, cothread_func func,int argc, char **argv cothread_switch @@ -75,8 +76,18 @@ cothread_state *thread,cothread_func func,int argc,char **argv cothread_state *thread +cothread_set_data +void +cothread_state *thread, gchar *key, gpointer data + + +cothread_get_data +gpointer +cothread_state *thread, gchar *key + + cothread_main -cothread_state * +cothread_state * cothread_context *ctx @@ -87,12 +98,12 @@ int *argc,char **argv[] gst_main void - +void gst_main_quit void - +void DEBUG @@ -162,31 +173,36 @@ void gst_bin_new -GstElement * +GstElement * gchar *name gst_bin_destroy -#define gst_bin_destroy(bin) gst_object_destroy(GST_OBJECT(bin)) +#define gst_bin_destroy(bin) gst_object_destroy(GST_OBJECT(bin)) gst_bin_add void -GstBin *bin,GstElement *element +GstBin *bin, GstElement *element gst_bin_remove void -GstBin *bin,GstElement *element +GstBin *bin, GstElement *element gst_bin_get_by_name -GstElement * -GstBin *bin,gchar *name +GstElement * +GstBin *bin, gchar *name gst_bin_get_list -GList * +GList * +GstBin *bin + + +gst_bin_create_plan +void GstBin *bin @@ -200,11 +216,6 @@ GstBin *bin,GstElementState state,GtkType type GstBin *bin -gst_bin_create_plan -void -GstBin *bin - - gst_bin_use_cothreads void GstBin *bin, gboolean enabled @@ -326,22 +337,22 @@ struct GstBuffer { gst_buffer_new -GstBuffer * - +GstBuffer * +void gst_buffer_new_from_pool -GstBuffer * +GstBuffer * GstBufferPool *pool gst_buffer_create_sub -GstBuffer * -GstBuffer *parent,guint32 offset,guint32 size +GstBuffer * +GstBuffer *parent, guint32 offset, guint32 size gst_buffer_append -GstBuffer * +GstBuffer * GstBuffer *buffer, GstBuffer *append @@ -352,7 +363,7 @@ GstBuffer *buffer gst_buffer_ref_by_count void -GstBuffer *buffer,int count +GstBuffer *buffer, int count gst_buffer_unref @@ -367,23 +378,23 @@ GstBuffer *buffer gst_buffer_add_meta void -GstBuffer *buffer,GstMeta *meta +GstBuffer *buffer, GstMeta *meta + + +gst_buffer_remove_meta +void +GstBuffer *buffer, GstMeta *meta gst_buffer_get_first_meta -GstMeta * +GstMeta * GstBuffer *buffer gst_buffer_get_metas -GSList * +GSList * GstBuffer *buffer - -gst_buffer_remove_meta -void -GstBuffer *buffer,GstMeta *meta - GstClockTime typedef guint64 GstClockTime; @@ -415,12 +426,12 @@ struct GstClock { gst_clock_new -GstClock * +GstClock * gchar *name gst_clock_get_system -GstClock * +GstClock * void @@ -492,7 +503,7 @@ void gst_connection_new -GstElement * +GstElement * gchar *name @@ -504,18 +515,18 @@ GstConnection *connection GstElementState typedef enum { GST_STATE_NONE_PENDING = -1, - GST_STATE_NULL = 0, - GST_STATE_READY = 1, - GST_STATE_PLAYING = 2, - GST_STATE_PAUSED = 3, + GST_STATE_NULL = 0, + GST_STATE_READY = 1, + GST_STATE_PLAYING = 2, + GST_STATE_PAUSED = 3, } GstElementState; GstElementStateReturn typedef enum { - GST_STATE_FAILURE = 0, - GST_STATE_SUCCESS = 1, - GST_STATE_ASYNC = 2, + GST_STATE_FAILURE = 0, + GST_STATE_SUCCESS = 1, + GST_STATE_ASYNC = 2, } GstElementStateReturn; @@ -548,7 +559,7 @@ typedef enum { GST_IS_ELEMENT_CLASS -#define GST_IS_ELEMENT_CLASS(obj) \ +#define GST_IS_ELEMENT_CLASS(klass) \ (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT)) @@ -556,6 +567,7 @@ typedef enum { typedef enum { GST_ELEMENT_MULTI_IN = (1 << 4), GST_ELEMENT_THREAD_SUGGESTED = (1 << 5), + GST_ELEMENT_NO_SEEK = (1 << 6), } GstElementFlags; @@ -632,9 +644,13 @@ void gst_element_new -GstElement * +GstElement * void + +gst_element_destroy +#define gst_element_destroy(element) gst_object_destroy (GST_OBJECT (element)) + gst_element_set_loop_function void @@ -643,80 +659,81 @@ GstElement *element,GstElementLoopFunction loop gst_element_set_name void -GstElement *element,gchar *name +GstElement *element, gchar *name gst_element_get_name -gchar * +const gchar * GstElement *element gst_element_set_manager void -GstElement *element,GstElement *manager +GstElement *element, GstElement *manager gst_element_get_manager -GstElement * +GstElement * GstElement *element gst_element_add_pad void -GstElement *element,GstPad *pad - - -gst_element_add_ghost_pad -void -GstElement *element,GstPad *pad +GstElement *element, GstPad *pad gst_element_get_pad -GstPad * -GstElement *element,gchar *name +GstPad * +GstElement *element, gchar *name gst_element_get_pad_list -GList * +GList * GstElement *element +gst_element_add_ghost_pad +void +GstElement *element, GstPad *pad + + gst_element_connect void -GstElement *src,gchar *srcpadname,GstElement *dest,gchar *destpadname +GstElement *src, gchar *srcpadname,GstElement *dest, gchar *destpadname gst_element_set_state gint -GstElement *element,GstElementState state +GstElement *element, GstElementState state gst_element_error void -GstElement *element,gchar *error +GstElement *element, gchar *error gst_element_get_factory -GstElementFactory * +GstElementFactory * GstElement *element - -gst_element_destroy -#define gst_element_destroy(element) gst_object_destroy(GST_OBJECT(element)) - + +gst_element_loopfunc_wrapper +int +int argc,char **argv + gst_element_save_thyself xmlNodePtr -GstElement *element,xmlNodePtr parent +GstElement *element, xmlNodePtr parent gst_element_load_thyself -GstElement * +GstElement * xmlNodePtr parent, GHashTable *elements gst_elementfactory_new -GstElementFactory * +GstElementFactory * gchar *name,GtkType type,GstElementDetails *details @@ -736,23 +753,23 @@ GstElementFactory *elementfactory, guint16 id gst_elementfactory_find -GstElementFactory * +GstElementFactory * gchar *name gst_elementfactory_get_list -GList * - +GList * +void gst_elementfactory_create -GstElement * +GstElement * GstElementFactory *factory,gchar *name gst_elementfactory_make -GstElement * -gchar *factoryname,gchar *name +GstElement * +gchar *factoryname, gchar *name gst_elementfactory_save_thyself @@ -761,14 +778,9 @@ GstElementFactory *factory, xmlNodePtr parent gst_elementfactory_load_thyself -GstElementFactory * +GstElementFactory * xmlNodePtr parent - -gst_element_loopfunc_wrapper -int -int argc,char **argv - GST_TYPE_FILTER #define GST_TYPE_FILTER \ @@ -813,7 +825,7 @@ void gst_filter_new -GstElement * +GstElement * gchar *name @@ -883,12 +895,12 @@ struct GstMeta { gst_meta_new_size -GstMeta * +GstMeta * gint size gst_meta_new -#define gst_meta_new(type) (type *)gst_meta_new_size(sizeof(type)) +#define gst_meta_new(type) (type *)gst_meta_new_size(sizeof(type)) gst_meta_ref @@ -995,7 +1007,7 @@ GstObject *object,GstObject *parent gst_object_get_parent -GstObject * +GstObject * GstObject *object @@ -1005,47 +1017,47 @@ GstObject *object gst_object_ref -#define gst_object_ref(object) gtk_object_ref(GTK_OBJECT(object)); +#define gst_object_ref(object) gtk_object_ref(GTK_OBJECT(object)); gst_object_unref -#define gst_object_unref(object) gtk_object_unref(GTK_OBJECT(object)); +#define gst_object_unref(object) gtk_object_unref(GTK_OBJECT(object)); gst_object_sink -#define gst_object_sink(object) gtk_object_sink(GTK_OBJECT(object)); +#define gst_object_sink(object) gtk_object_sink(GTK_OBJECT(object)); gst_object_destroy -#define gst_object_destroy(object) gtk_object_destroy(GTK_OBJECT(object)) +#define gst_object_destroy(object) gtk_object_destroy(GTK_OBJECT(object)) GST_TYPE_PAD -#define GST_TYPE_PAD (gst_pad_get_type()) +#define GST_TYPE_PAD (gst_pad_get_type ()) GST_PAD -#define GST_PAD(obj) (GTK_CHECK_CAST((obj),GST_TYPE_PAD,GstPad)) +#define GST_PAD(obj) (GTK_CHECK_CAST ((obj), GST_TYPE_PAD,GstPad)) GST_PAD_CLASS -#define GST_PAD_CLASS(klass) (GTK_CHECK_CLASS_CAST((klass),GST_TYPE_PAD,GstPadClass)) +#define GST_PAD_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD,GstPadClass)) GST_IS_PAD -#define GST_IS_PAD(obj) (GTK_CHECK_TYPE((obj),GST_TYPE_PAD)) +#define GST_IS_PAD(obj) (GTK_CHECK_TYPE ((obj), GST_TYPE_PAD)) GST_IS_PAD_CLASS -#define GST_IS_PAD_CLASS(obj) (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_PAD)) +#define GST_IS_PAD_CLASS(obj) (GTK_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD)) GST_PAD_CONNECTED -#define GST_PAD_CONNECTED(pad) (pad && (pad)->peer != NULL) +#define GST_PAD_CONNECTED(pad) (pad && (pad)->peer != NULL) GST_PAD_CAN_PULL -#define GST_PAD_CAN_PULL(pad) (pad && (pad)->pullfunc != NULL) +#define GST_PAD_CAN_PULL(pad) (pad && (pad)->pullfunc != NULL) GstPad @@ -1064,6 +1076,11 @@ GstPad *pad,GstBuffer *buf GstPad *pad +GstPadPullRegionFunction +void +GstPad *pad, gulong offset, gulong size + + GstPadPushFunction void GstPad *pad @@ -1097,6 +1114,7 @@ struct GstPad { GstPadChainFunction chainfunc; GstPadPullFunction pullfunc; + GstPadPullRegionFunction pullregionfunc; GstPadPushFunction pushfunc; GstPadQoSFunction qosfunc; @@ -1111,14 +1129,13 @@ void gst_pad_new -GstPad * -gchar *name,GstPadDirection direction +GstPad * +gchar *name, GstPadDirection direction - + gst_pad_destroy -void -GstPad *pad - +#define gst_pad_destroy(pad) gst_object_destroy (GST_OBJECT (pad)) + gst_pad_get_direction GstPadDirection @@ -1127,7 +1144,7 @@ GstPad *pad gst_pad_set_chain_function void -GstPad *pad,GstPadChainFunction chain +GstPad *pad, GstPadChainFunction chain gst_pad_set_pull_function @@ -1147,73 +1164,74 @@ GstPad *pad gst_pad_set_type_id void -GstPad *pad,guint16 id +GstPad *pad, guint16 id gst_pad_set_name void -GstPad *pad,gchar *name +GstPad *pad, const gchar *name gst_pad_get_name -gchar * +const gchar * GstPad *pad - -gst_pad_destroy -#define gst_pad_destroy(pad) gst_object_destroy(GST_OBJECT(pad)) - gst_pad_set_parent void -GstPad *pad,GstObject *parent +GstPad *pad, GstObject *parent + + +gst_pad_get_parent +GstObject * +GstPad *pad gst_pad_add_ghost_parent void -GstPad *pad,GstObject *parent +GstPad *pad, GstObject *parent gst_pad_remove_ghost_parent void -GstPad *pad,GstObject *parent - - -gst_pad_get_parent -GstObject * -GstPad *pad +GstPad *pad, GstObject *parent gst_pad_get_ghost_parents -GList * +GList * GstPad *pad gst_pad_get_peer -GstPad * +GstPad * GstPad *pad gst_pad_connect void -GstPad *srcpad,GstPad *sinkpad +GstPad *srcpad, GstPad *sinkpad gst_pad_disconnect void -GstPad *srcpad,GstPad *sinkpad +GstPad *srcpad, GstPad *sinkpad gst_pad_push void -GstPad *pad,GstBuffer *buffer +GstPad *pad, GstBuffer *buffer gst_pad_pull -GstBuffer * +GstBuffer * GstPad *pad +gst_pad_pull_region +GstBuffer * +GstPad *pad, gulong offset, gulong size + + gst_pad_handle_qos void GstPad *pad, glong qos_message @@ -1221,7 +1239,7 @@ GstPad *pad, glong qos_message gst_pad_save_thyself xmlNodePtr -GstPad *pad,xmlNodePtr parent +GstPad *pad, xmlNodePtr parent gst_pad_load_and_connect @@ -1279,19 +1297,14 @@ void gst_pipeline_new -GstElement * +GstElement * guchar *name gst_pipeline_destroy -#define gst_pipeline_destroy(pipeline) gst_object_destroy(GST_OBJECT(pipeline)) +#define gst_pipeline_destroy(pipeline) gst_object_destroy(GST_OBJECT(pipeline)) -gst_pipeline_autoplug -gboolean -GstPipeline *pipeline - - gst_pipeline_add_src void GstPipeline *pipeline, GstElement *src @@ -1302,6 +1315,11 @@ GstPipeline *pipeline, GstElement *src GstPipeline *pipeline, GstElement *sink +gst_pipeline_autoplug +gboolean +GstPipeline *pipeline + + gst_pipeline_iterate void GstPipeline *pipeline @@ -1332,18 +1350,13 @@ GModule *module gst_plugin_new -GstPlugin * +GstPlugin * gchar *name -gst_plugin_set_longname -void -GstPlugin *plugin,gchar *longname - - gst_plugin_load_all void - +void gst_plugin_load @@ -1361,33 +1374,38 @@ gchar *name gchar *name +gst_plugin_set_longname +void +GstPlugin *plugin, gchar *longname + + gst_plugin_add_factory void -GstPlugin *plugin,GstElementFactory *factory +GstPlugin *plugin, GstElementFactory *factory gst_plugin_add_type void -GstPlugin *plugin,GstTypeFactory *factory +GstPlugin *plugin, GstTypeFactory *factory gst_plugin_find -GstPlugin * +GstPlugin * const gchar *name gst_plugin_get_list -GList * - +GList * +void gst_plugin_find_elementfactory -GstElementFactory * +GstElementFactory * gchar *name gst_plugin_load_elementfactory -GstElementFactory * +GstElementFactory * gchar *name @@ -1449,7 +1467,7 @@ void gst_sink_new -GstObject * +GstObject * gchar *name @@ -1480,7 +1498,7 @@ gchar *name GstSrcFlags typedef enum { - GST_SRC_ASYNC = 1 << 0, + GST_SRC_ASYNC = (1 << 0), } GstSrcFlags; @@ -1522,19 +1540,19 @@ struct GstSrc { void -gst_src_signal_eos +gst_src_push void GstSrc *src -gst_src_push +gst_src_push_region void -GstSrc *src +GstSrc *src, gulong offset, gulong size -gst_src_push_region +gst_src_signal_eos void -GstSrc *src,gulong offset,gulong size +GstSrc *src GST_TYPE_TEE @@ -1585,19 +1603,19 @@ void gst_tee_new -GstElement * +GstElement * gchar *name -gst_tee_chain -void -GstPad *pad,GstBuffer *buf - - gst_tee_new_pad -gchar * +gchar * GstTee *tee + +gst_tee_chain +void +GstPad *pad, GstBuffer *buf + gst_thread_details extern GstElementDetails gst_thread_details; @@ -1658,14 +1676,9 @@ void gst_thread_new -GstElement * +GstElement * guchar *name - -gst_trace_read_tsc -void -guint64 *dst - GstTrace @@ -1696,8 +1709,8 @@ struct GstTraceEntry { gst_trace_new -GstTrace * -guchar *filename,gint size +GstTrace * +guchar *filename, gint size gst_trace_destroy @@ -1711,21 +1724,26 @@ GstTrace *trace gst_trace_get_size -#define gst_trace_get_size(trace) ((trace)->bufsize) +#define gst_trace_get_size(trace) ((trace)->bufsize) gst_trace_get_offset -#define gst_trace_get_offset(trace) ((trace)->bufoffset) +#define gst_trace_get_offset(trace) ((trace)->bufoffset) gst_trace_get_remaining -#define gst_trace_get_remaining(trace) ((trace)->bufsize - (trace)->bufoffset) +#define gst_trace_get_remaining(trace) ((trace)->bufsize - (trace)->bufoffset) gst_trace_set_default void GstTrace *trace + +gst_trace_read_tsc +void +guint64 *dst + TRACE_ENABLE #define TRACE_ENABLE @@ -1795,43 +1813,43 @@ gchar *ext gst_type_add_src -void -guint16 id,GstElementFactory *src +void +guint16 id, GstElementFactory *src gst_type_add_sink void -guint16 id,GstElementFactory *sink +guint16 id, GstElementFactory *sink gst_type_get_srcs -GList * +GList * guint16 id gst_type_get_sinks -GList * +GList * guint16 id gst_type_find_by_id -GstType * +GstType * guint16 id gst_type_get_sink_to_src -GList * +GList * guint16 sinkid, guint16 srcid gst_type_get_list -GList * - +GList * +void gst_type_dump void - +void gst_type_save_thyself @@ -1850,43 +1868,43 @@ GstTypeFactory *factory, xmlNodePtr parent gst_typefactory_load_thyself -GstTypeFactory * +GstTypeFactory * xmlNodePtr parent gst_util_get_int_arg gint -GtkObject *object,guchar *argname +GtkObject *object, guchar *argname gst_util_get_long_arg glong -GtkObject *object,guchar *argname +GtkObject *object, guchar *argname gst_util_get_float_arg gfloat -GtkObject *object,guchar *argname +GtkObject *object, guchar *argname gst_util_get_double_arg gdouble -GtkObject *object,guchar *argname +GtkObject *object, guchar *argname gst_util_get_string_arg -guchar * -GtkObject *object,guchar *argname +guchar * +GtkObject *object, guchar *argname gst_util_get_pointer_arg gpointer -GtkObject *object,guchar *argname +GtkObject *object, guchar *argname gst_util_get_widget_arg -GtkWidget * -GtkObject *object,guchar *argname +GtkWidget * +GtkObject *object, guchar *argname gst_util_dump_mem @@ -1944,12 +1962,12 @@ GstElement *element gst_xml_new -GstXML * +GstXML * const guchar *fname, const guchar *root gst_xml_get_element -GstElement * +GstElement * GstXML *xml, const guchar *name @@ -1984,12 +2002,12 @@ struct GstBufferPool { gst_buffer_pool_new -GstBufferPool * - +GstBufferPool * +void gst_buffer_pool_new_buffer -GstBuffer * +GstBuffer * GstBufferPool *pool @@ -2000,12 +2018,12 @@ GstBufferPool *pool, GstBuffer *buffer gst_buffer_pool_set_create_function void -GstBufferPool *pool, GstBufferPoolCreateFunction create, gpointer user_data +GstBufferPool *pool,GstBufferPoolCreateFunction create,gpointer user_data gst_buffer_pool_set_destroy_function void -GstBufferPool *pool, GstBufferPoolDestroyFunction destroy, gpointer user_data +GstBufferPool *pool,GstBufferPoolDestroyFunction destroy,gpointer user_data gst_buffer_pool_destroy @@ -2022,7 +2040,7 @@ typedef enum { gst_cpu_get_flags GstCPUFlags - +void GET_SP @@ -2129,6 +2147,7 @@ struct GstAsyncDiskSrc { /* details for fallback synchronous read */ gulong curoffset; /* current offset in file */ gulong bytes_per_read; /* bytes per read */ + gboolean new_seek; gulong seq; /* buffer sequence number */ }; diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 4c1bece..7f547b7 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -23,6 +23,7 @@ + @@ -82,6 +83,8 @@ with some more specialized elements. &GstCpu; &GstTrace; &GstXml; + + &cothreads; diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 525ec02..372597a 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -15,6 +15,8 @@ cothread_create cothread_setfunc cothread_switch cothread_main +cothread_set_data +cothread_get_data GET_SP JUMP @@ -272,6 +274,7 @@ GST_PAD_CAN_PULL GstPad GstPadChainFunction GstPadPullFunction +GstPadPullRegionFunction GstPadPushFunction GstPadQoSFunction GstPadDirection @@ -294,6 +297,7 @@ gst_pad_connect gst_pad_disconnect gst_pad_push gst_pad_pull +gst_pad_pull_region gst_pad_set_qos_function gst_pad_handle_qos gst_pad_save_thyself -- 2.7.4