mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-31 03:29:50 +00:00
Code Issues 1 Projects Releases Wiki Activity

Documentation updates documented the libraries

Browse source 
Original commit message from CVS:
Documentation updates
documented the libraries
This commit is contained in:
Wim Taymans 2000-10-22 16:27:21 +00:00
parent 2521a319c3
commit 894215eb29
22 changed files with 4053 additions and 262 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/Makefile.am
View file

@ -1,9 +1,9 @@
SUBDIRS = manual SUBDIRS = manual
if HAVE_GTK_DOC if HAVE_GTK_DOC
SUBDIRS += gst SUBDIRS += gst libs
endif endif
DIST_SUBDIRS = gst manual DIST_SUBDIRS = gst manual libs
EXTRA_DIST = random slides EXTRA_DIST = random slides

9
docs/gst/Makefile.am
View file

@ -27,6 +27,7 @@ tmpl_sources = \
tmpl/gstaudiosrc.sgml \ tmpl/gstaudiosrc.sgml \
tmpl/gstbin.sgml \ tmpl/gstbin.sgml \
tmpl/gstbuffer.sgml \ tmpl/gstbuffer.sgml \
tmpl/gstbufferpool.sgml \
tmpl/gstconnection.sgml \ tmpl/gstconnection.sgml \
tmpl/gstdisksrc.sgml \ tmpl/gstdisksrc.sgml \
tmpl/gstelement.sgml \ tmpl/gstelement.sgml \
@ -88,12 +89,12 @@ gstreamer-decl.txt:
$(MAKE) scan $(MAKE) scan
scanobj: $(srcdir)/$(DOC_MODULE).types scanobj: $(srcdir)/$(DOC_MODULE).types
env CC="$(LIBTOOL) --mode=link $(CC)" CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" \ -CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) gtkdoc-scanobj --module=$(DOC_MODULE)
gtkdoc-scanobj --module=$(DOC_MODULE) \ gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
--types=$(srcdir)/$(DOC_MODULE).types
scan: scan:
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="gsttypefind.h" gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers=""
tmpl: scanobj scan tmpl: scanobj scan
gtkdoc-mktmpl --module=$(DOC_MODULE) gtkdoc-mktmpl --module=$(DOC_MODULE)

383
docs/gst/gstreamer-decl.txt
View file

@ -41,8 +41,9 @@ struct cothread_state {
int flags; int flags;
int *sp; int *sp;
int *top_sp;
int *pc; int *pc;
jmp_buf jmp; sigjmp_buf jmp;
}; };
</STRUCT> </STRUCT>
<STRUCT> <STRUCT>
@ -154,25 +155,6 @@ struct GstBin {
gboolean use_cothreads; gboolean use_cothreads;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstBinClass</NAME>
struct GstBinClass {
GstElementClass parent_class;
void (*object_added) (GstObject *object,GstObject *child);
/* change the state of elements of the given type */
gboolean (*change_state_type) (GstBin *bin,
GstElementState state,
GtkType type);
/* create a plan for the execution of the bin */
void (*create_plan) (GstBin *bin);
/* run a full iteration of operation */
void (*iterate) (GstBin *bin);
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_bin_get_type</NAME> <NAME>gst_bin_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -489,7 +471,7 @@ GstClock *clock, GstClockTime time
<MACRO> <MACRO>
<NAME>GST_IS_CONNECTION_CLASS</NAME> <NAME>GST_IS_CONNECTION_CLASS</NAME>
#define GST_IS_CONNECTION_CLASS(obj) \ #define GST_IS_CONNECTION_CLASS(obj) \
(GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_CONNECTION))) (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_CONNECTION))
</MACRO> </MACRO>
<STRUCT> <STRUCT>
<NAME>GstConnection</NAME> <NAME>GstConnection</NAME>
@ -503,15 +485,6 @@ struct GstConnection {
GstElement element; GstElement element;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstConnectionClass</NAME>
struct GstConnectionClass {
GstElementClass parent_class;
/* push function */
void (*push) (GstConnection *connection);
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_connection_get_type</NAME> <NAME>gst_connection_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -581,13 +554,18 @@ typedef enum {
<ENUM> <ENUM>
<NAME>GstElementFlags</NAME> <NAME>GstElementFlags</NAME>
typedef enum { typedef enum {
GST_ELEMENT_MULTI_IN = (1 << 0), GST_ELEMENT_MULTI_IN = (1 << 4),
GST_ELEMENT_THREAD_SUGGESTED = (1 << 5),
} GstElementFlags; } GstElementFlags;
</ENUM> </ENUM>
<MACRO> <MACRO>
<NAME>GST_ELEMENT_IS_MULTI_IN</NAME> <NAME>GST_ELEMENT_IS_MULTI_IN</NAME>
#define GST_ELEMENT_IS_MULTI_IN(obj) (GST_FLAGS(obj) & GST_ELEMENT_MULTI_IN) #define GST_ELEMENT_IS_MULTI_IN(obj) (GST_FLAGS(obj) & GST_ELEMENT_MULTI_IN)
</MACRO> </MACRO>
<MACRO>
<NAME>GST_ELEMENT_IS_THREAD_SUGGESTED</NAME>
#define GST_ELEMENT_IS_THREAD_SUGGESTED(obj) (GST_FLAGS(obj) & GST_ELEMENT_THREAD_SUGGESTED)
</MACRO>
<STRUCT> <STRUCT>
<NAME>GstElement</NAME> <NAME>GstElement</NAME>
</STRUCT> </STRUCT>
@ -625,32 +603,6 @@ struct GstElement {
}; };
</STRUCT> </STRUCT>
<STRUCT> <STRUCT>
<NAME>GstElementClass</NAME>
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 (*new_ghost_pad) (GstElement *element,GstPad *pad);
void (*error) (GstElement *element,gchar *error);
/* events */
// gboolean (*start) (GstElement *element,GstElementState state);
// gboolean (*stop) (GstElement *element);
/* change the element state */
GstElementStateReturn (*change_state) (GstElement *element);
/* create or read XML representation of self */
xmlNodePtr (*save_thyself)(GstElement *element,xmlNodePtr parent);
void (*restore_thyself)(GstElement *element,xmlNodePtr *self);
};
</STRUCT>
<STRUCT>
<NAME>GstElementDetails</NAME> <NAME>GstElementDetails</NAME>
struct GstElementDetails { struct GstElementDetails {
gchar *longname; /* long, english name */ gchar *longname; /* long, english name */
@ -758,6 +710,11 @@ GstElement *element
GstElement *element,xmlNodePtr parent GstElement *element,xmlNodePtr parent
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_element_load_thyself</NAME>
<RETURNS>GstElement *</RETURNS>
xmlNodePtr parent, GHashTable *elements
</FUNCTION>
<FUNCTION>
<NAME>gst_elementfactory_new</NAME> <NAME>gst_elementfactory_new</NAME>
<RETURNS>GstElementFactory *</RETURNS> <RETURNS>GstElementFactory *</RETURNS>
gchar *name,GtkType type,GstElementDetails *details gchar *name,GtkType type,GstElementDetails *details
@ -849,12 +806,6 @@ struct GstFilter {
GstElement element; GstElement element;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstFilterClass</NAME>
struct GstFilterClass {
GstElementClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_filter_get_type</NAME> <NAME>gst_filter_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -883,8 +834,8 @@ gchar *name
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>GST_META_FLAGS</NAME> <NAME>GST_META_FLAGS</NAME>
#define GST_META_FLAGS(buf) \ #define GST_META_FLAGS(meta) \
(GST_META(buf)->flags) (GST_META(meta)->flags)
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>GST_META_FLAG_IS_SET</NAME> <NAME>GST_META_FLAG_IS_SET</NAME>
@ -999,17 +950,6 @@ struct GstObject {
GstObject *parent; GstObject *parent;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstObjectClass</NAME>
struct GstObjectClass {
GtkObjectClass parent_class;
/* signals */
void (*parent_set) (GstObject *object,GstObject *parent);
/* functions go here */
};
</STRUCT>
<MACRO> <MACRO>
<NAME>GST_FLAGS</NAME> <NAME>GST_FLAGS</NAME>
#define GST_FLAGS(obj) GTK_OBJECT_FLAGS(obj) #define GST_FLAGS(obj) GTK_OBJECT_FLAGS(obj)
@ -1101,11 +1041,11 @@ GstObject *object
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>GST_PAD_CONNECTED</NAME> <NAME>GST_PAD_CONNECTED</NAME>
#define GST_PAD_CONNECTED(pad) ((pad)->peer != NULL) #define GST_PAD_CONNECTED(pad) (pad && (pad)->peer != NULL)
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>GST_PAD_CAN_PULL</NAME> <NAME>GST_PAD_CAN_PULL</NAME>
#define GST_PAD_CAN_PULL(pad) ((pad)->pullfunc != NULL) #define GST_PAD_CAN_PULL(pad) (pad && (pad)->pullfunc != NULL)
</MACRO> </MACRO>
<STRUCT> <STRUCT>
<NAME>GstPad</NAME> <NAME>GstPad</NAME>
@ -1164,12 +1104,6 @@ struct GstPad {
GList *ghostparents; GList *ghostparents;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstPadClass</NAME>
struct GstPadClass {
GstObjectClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_get_type</NAME> <NAME>gst_pad_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -1289,6 +1223,11 @@ GstPad *pad, glong qos_message
<RETURNS>xmlNodePtr </RETURNS> <RETURNS>xmlNodePtr </RETURNS>
GstPad *pad,xmlNodePtr parent GstPad *pad,xmlNodePtr parent
</FUNCTION> </FUNCTION>
<FUNCTION>
<NAME>gst_pad_load_and_connect</NAME>
<RETURNS>void </RETURNS>
xmlNodePtr parent, GstObject *element, GHashTable *elements
</FUNCTION>
<VARIABLE> <VARIABLE>
<NAME>gst_pipeline_details</NAME> <NAME>gst_pipeline_details</NAME>
extern GstElementDetails gst_pipeline_details; extern GstElementDetails gst_pipeline_details;
@ -1333,12 +1272,6 @@ struct GstPipeline {
GList *sinks; // and multiple sinks GList *sinks; // and multiple sinks
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstPipelineClass</NAME>
struct GstPipelineClass {
GstBinClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_pipeline_get_type</NAME> <NAME>gst_pipeline_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -1509,12 +1442,6 @@ struct GstSink {
GstElement element; GstElement element;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstSinkClass</NAME>
struct GstSinkClass {
GstElementClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_sink_get_type</NAME> <NAME>gst_sink_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -1579,19 +1506,6 @@ struct GstSrc {
gint32 flags; gint32 flags;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstSrcClass</NAME>
struct GstSrcClass {
GstElementClass parent_class;
/* subclass functions */
void (*push) (GstSrc *src);
void (*push_region) (GstSrc *src,gulong offset,gulong size);
/* signals */
void (*eos) (GstSrc *src);
};
</STRUCT>
<MACRO> <MACRO>
<NAME>GST_SRC_SET_FLAGS</NAME> <NAME>GST_SRC_SET_FLAGS</NAME>
#define GST_SRC_SET_FLAGS(src,flag) \ #define GST_SRC_SET_FLAGS(src,flag) \
@ -1645,7 +1559,7 @@ GstSrc *src,gulong offset,gulong size
<MACRO> <MACRO>
<NAME>GST_IS_TEE_CLASS</NAME> <NAME>GST_IS_TEE_CLASS</NAME>
#define GST_IS_TEE_CLASS(obj) \ #define GST_IS_TEE_CLASS(obj) \
(GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_TEE))) (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_TEE))
</MACRO> </MACRO>
<STRUCT> <STRUCT>
<NAME>GstTee</NAME> <NAME>GstTee</NAME>
@ -1664,12 +1578,6 @@ struct GstTee {
GSList *srcpads; GSList *srcpads;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstTeeClass</NAME>
struct GstTeeClass {
GstFilterClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_tee_get_type</NAME> <NAME>gst_tee_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -1725,7 +1633,7 @@ typedef enum {
<MACRO> <MACRO>
<NAME>GST_IS_THREAD_CLASS</NAME> <NAME>GST_IS_THREAD_CLASS</NAME>
#define GST_IS_THREAD_CLASS(obj) \ #define GST_IS_THREAD_CLASS(obj) \
(GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_THREAD))) (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_THREAD))
</MACRO> </MACRO>
<STRUCT> <STRUCT>
<NAME>GstThread</NAME> <NAME>GstThread</NAME>
@ -1743,12 +1651,6 @@ struct GstThread {
GCond *cond; /* used to control the thread */ GCond *cond; /* used to control the thread */
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstThreadClass</NAME>
struct GstThreadClass {
GstBinClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_thread_get_type</NAME> <NAME>gst_thread_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -1760,16 +1662,6 @@ void
guchar *name guchar *name
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_thread_main_loop</NAME>
<RETURNS>void *</RETURNS>
void *arg
</FUNCTION>
<FUNCTION>
<NAME>gst_thread_iterate</NAME>
<RETURNS>void </RETURNS>
GstThread *thread
</FUNCTION>
<FUNCTION>
<NAME>gst_trace_read_tsc</NAME> <NAME>gst_trace_read_tsc</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
guint64 *dst guint64 *dst
@ -2001,11 +1893,65 @@ GtkObject *object,guchar *argname
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
guchar *mem, guint size guchar *mem, guint size
</FUNCTION> </FUNCTION>
<MACRO>
<NAME>GST_TYPE_XML</NAME>
#define GST_TYPE_XML \
(gst_object_get_type())
</MACRO>
<MACRO>
<NAME>GST_XML</NAME>
#define GST_XML(obj) \
(GTK_CHECK_CAST((obj),GST_TYPE_XML,GstXML))
</MACRO>
<MACRO>
<NAME>GST_XML_CLASS</NAME>
#define GST_XML_CLASS(klass) \
(GTK_CHECK_CLASS_CAST((klass),GST_TYPE_XML,GstXMLClass))
</MACRO>
<MACRO>
<NAME>GST_IS_XML</NAME>
#define GST_IS_XML(obj) \
(GTK_CHECK_TYPE((obj),GST_TYPE_XML))
</MACRO>
<MACRO>
<NAME>GST_IS_XML_CLASS</NAME>
#define GST_IS_XML_CLASS(obj) \
(GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_XML))
</MACRO>
<STRUCT>
<NAME>GstXML</NAME>
</STRUCT>
<STRUCT>
<NAME>GstXMLClass</NAME>
</STRUCT>
<STRUCT>
<NAME>GstXML</NAME>
struct GstXML {
GtkObject object;
GHashTable *elements;
};
</STRUCT>
<FUNCTION>
<NAME>gst_xml_get_type</NAME>
<RETURNS>GtkType </RETURNS>
void
</FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_xml_write</NAME> <NAME>gst_xml_write</NAME>
<RETURNS>xmlDocPtr </RETURNS> <RETURNS>xmlDocPtr </RETURNS>
GstElement *element GstElement *element
</FUNCTION> </FUNCTION>
<FUNCTION>
<NAME>gst_xml_new</NAME>
<RETURNS>GstXML *</RETURNS>
const guchar *fname, const guchar *root
</FUNCTION>
<FUNCTION>
<NAME>gst_xml_get_element</NAME>
<RETURNS>GstElement *</RETURNS>
GstXML *xml, const guchar *name
</FUNCTION>
<MACRO> <MACRO>
<NAME>GST_BUFFER_POOL</NAME> <NAME>GST_BUFFER_POOL</NAME>
#define GST_BUFFER_POOL(buf) \ #define GST_BUFFER_POOL(buf) \
@ -2066,17 +2012,16 @@ GstBufferPool *pool, GstBufferPoolDestroyFunction destroy, gpointer user_data
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstBufferPool *pool GstBufferPool *pool
</FUNCTION> </FUNCTION>
<MACRO> <ENUM>
<NAME>GST_CPU_FLAG_MMX</NAME> <NAME>GstCPUFlags</NAME>
#define GST_CPU_FLAG_MMX (1 << 0) typedef enum {
</MACRO> GST_CPU_FLAG_MMX = (1<<0),
<MACRO> GST_CPU_FLAG_SSE = (1<<1),
<NAME>GST_CPU_FLAG_SSE</NAME> } GstCPUFlags;
#define GST_CPU_FLAG_SSE (1 << 1) </ENUM>
</MACRO>
<FUNCTION> <FUNCTION>
<NAME>gst_cpu_get_flags</NAME> <NAME>gst_cpu_get_flags</NAME>
<RETURNS>guint32 </RETURNS> <RETURNS>GstCPUFlags </RETURNS>
</FUNCTION> </FUNCTION>
<MACRO> <MACRO>
@ -2095,6 +2040,10 @@ GstBufferPool *pool
__asm__("jmp " SYMBOL_NAME_STR(cothread_stub)) __asm__("jmp " SYMBOL_NAME_STR(cothread_stub))
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>SETUP_STACK</NAME>
#define SETUP_STACK(sp) do ; while(0)
</MACRO>
<MACRO>
<NAME>GET_SP</NAME> <NAME>GET_SP</NAME>
#define GET_SP(target) \ #define GET_SP(target) \
__asm__("stw 1,%0" : "=m"(target) : : "r1"); __asm__("stw 1,%0" : "=m"(target) : : "r1");
@ -2110,6 +2059,21 @@ GstBufferPool *pool
__asm__("b " SYMBOL_NAME_STR(cothread_stub)) __asm__("b " SYMBOL_NAME_STR(cothread_stub))
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>SETUP_STACK</NAME>
#define SETUP_STACK(sp) \
sp = ((unsigned long *)(sp)) - 4; \
((struct minimal_ppc_stackframe *)sp)->back_chain = 0;
</MACRO>
<MACRO>
<NAME>GST_TYPE_FILENAME</NAME>
#define GST_TYPE_FILENAME (gst_extra_get_filename_type())
</MACRO>
<FUNCTION>
<NAME>gst_extra_get_filename_type</NAME>
<RETURNS>GtkType </RETURNS>
void
</FUNCTION>
<MACRO>
<NAME>GST_TYPE_ASYNCDISKSRC</NAME> <NAME>GST_TYPE_ASYNCDISKSRC</NAME>
#define GST_TYPE_ASYNCDISKSRC \ #define GST_TYPE_ASYNCDISKSRC \
(gst_asyncdisksrc_get_type()) (gst_asyncdisksrc_get_type())
@ -2169,12 +2133,6 @@ struct GstAsyncDiskSrc {
gulong seq; /* buffer sequence number */ gulong seq; /* buffer sequence number */
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstAsyncDiskSrcClass</NAME>
struct GstAsyncDiskSrcClass {
GstSrcClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_asyncdisksrc_get_type</NAME> <NAME>gst_asyncdisksrc_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -2235,15 +2193,6 @@ struct GstAudioSink {
gboolean mute; gboolean mute;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstAudioSinkClass</NAME>
struct GstAudioSinkClass {
GstSinkClass parent_class;
/* signals */
void (*handoff) (GstElement *element,GstPad *pad);
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_audiosink_get_type</NAME> <NAME>gst_audiosink_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -2316,12 +2265,6 @@ struct GstAudioSrc {
MetaAudioRaw *meta; MetaAudioRaw *meta;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstAudioSrcClass</NAME>
struct GstAudioSrcClass {
GstSrcClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_audiosrc_get_type</NAME> <NAME>gst_audiosrc_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -2387,12 +2330,6 @@ struct GstDiskSrc {
gulong size; gulong size;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstDiskSrcClass</NAME>
struct GstDiskSrcClass {
GstSrcClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_disksrc_get_type</NAME> <NAME>gst_disksrc_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -2444,15 +2381,6 @@ struct GstEsdSink {
gint frequency; gint frequency;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstEsdSinkClass</NAME>
struct GstEsdSinkClass {
GstFilterClass parent_class;
/* signals */
void (*handoff) (GstElement *element,GstPad *pad);
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_esdsink_get_type</NAME> <NAME>gst_esdsink_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -2497,12 +2425,6 @@ struct GstFakeSink {
GstPad *sinkpad; GstPad *sinkpad;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstFakeSinkClass</NAME>
struct GstFakeSinkClass {
GstSinkClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_fakesink_get_type</NAME> <NAME>gst_fakesink_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -2547,12 +2469,6 @@ struct GstFakeSrc {
GstPad *srcpad; GstPad *srcpad;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstFakeSrcClass</NAME>
struct GstFakeSrcClass {
GstSrcClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_fakesrc_get_type</NAME> <NAME>gst_fakesrc_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -2599,12 +2515,6 @@ struct GstFdSink {
int fd; int fd;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstFdSinkClass</NAME>
struct GstFdSinkClass {
GstSinkClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_fdsink_get_type</NAME> <NAME>gst_fdsink_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -2657,12 +2567,6 @@ struct GstFdSrc {
gulong seq; /* buffer sequence number */ gulong seq; /* buffer sequence number */
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstFdSrcClass</NAME>
struct GstFdSrcClass {
GstSrcClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_fdsrc_get_type</NAME> <NAME>gst_fdsrc_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -2720,12 +2624,6 @@ struct GstHttpSrc {
gulong bytes_per_read; /* bytes per read */ gulong bytes_per_read; /* bytes per read */
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstHttpSrcClass</NAME>
struct GstHttpSrcClass {
GstSrcClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_httpsrc_get_type</NAME> <NAME>gst_httpsrc_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -2773,12 +2671,6 @@ struct GstIdentity {
gint control; gint control;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstIdentityClass</NAME>
struct GstIdentityClass {
GstFilterClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_identity_get_type</NAME> <NAME>gst_identity_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -2824,8 +2716,7 @@ struct GstQueue {
GstPad *srcpad; GstPad *srcpad;
/* the queue of buffers we're keeping our grubby hands on */ /* the queue of buffers we're keeping our grubby hands on */
GList *queue; GSList *queue;
GList *tail; /* have to keep track of this myself */
gint level_buffers; /* number of buffers queued here */ gint level_buffers; /* number of buffers queued here */
gint max_buffers; /* maximum number of buffers queued here */ gint max_buffers; /* maximum number of buffers queued here */
@ -2839,12 +2730,6 @@ struct GstQueue {
GCond *fullcond; GCond *fullcond;
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstQueueClass</NAME>
struct GstQueueClass {
GstConnectionClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_queue_get_type</NAME> <NAME>gst_queue_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
@ -2904,14 +2789,54 @@ struct GstSineSrc {
gboolean sentmeta; gboolean sentmeta;
}; };
</STRUCT> </STRUCT>
<FUNCTION>
<NAME>gst_sinesrc_get_type</NAME>
<RETURNS>GtkType </RETURNS>
void
</FUNCTION>
<MACRO>
<NAME>GST_TYPE_TYPEFIND</NAME>
#define GST_TYPE_TYPEFIND \
(gst_typefind_get_type())
</MACRO>
<MACRO>
<NAME>GST_TYPEFIND</NAME>
#define GST_TYPEFIND(obj) \
(GTK_CHECK_CAST((obj),GST_TYPE_TYPEFIND,GstTypeFind))
</MACRO>
<MACRO>
<NAME>GST_TYPEFIND_CLASS</NAME>
#define GST_TYPEFIND_CLASS(klass) \
(GTK_CHECK_CLASS_CAST((klass),GST_TYPE_TYPEFIND,GstTypeFindClass))
</MACRO>
<MACRO>
<NAME>GST_IS_TYPEFIND</NAME>
#define GST_IS_TYPEFIND(obj) \
(GTK_CHECK_TYPE((obj),GST_TYPE_TYPEFIND))
</MACRO>
<MACRO>
<NAME>GST_IS_TYPEFIND_CLASS</NAME>
#define GST_IS_TYPEFIND_CLASS(obj) \
(GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_TYPEFIND))
</MACRO>
<STRUCT> <STRUCT>
<NAME>GstSineSrcClass</NAME> <NAME>GstTypeFind</NAME>
struct GstSineSrcClass { </STRUCT>
GstSrcClass parent_class; <STRUCT>
<NAME>GstTypeFindClass</NAME>
</STRUCT>
<STRUCT>
<NAME>GstTypeFind</NAME>
struct GstTypeFind {
GstSink sink;
GstPad *sinkpad;
gint16 type;
}; };
</STRUCT> </STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_sinesrc_get_type</NAME> <NAME>gst_typefind_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>
void void
</FUNCTION> </FUNCTION>
@ -2974,12 +2899,6 @@ struct GstPipefilter {
gulong seq; /* buffer sequence number */ gulong seq; /* buffer sequence number */
}; };
</STRUCT> </STRUCT>
<STRUCT>
<NAME>GstPipefilterClass</NAME>
struct GstPipefilterClass {
GstFilterClass parent_class;
};
</STRUCT>
<FUNCTION> <FUNCTION>
<NAME>gst_pipefilter_get_type</NAME> <NAME>gst_pipefilter_get_type</NAME>
<RETURNS>GtkType </RETURNS> <RETURNS>GtkType </RETURNS>

24
docs/gst/gstreamer-docs.sgml
View file

@ -4,6 +4,7 @@
<!entity Gst SYSTEM "sgml/gst.sgml"> <!entity Gst SYSTEM "sgml/gst.sgml">
<!entity GstBin SYSTEM "sgml/gstbin.sgml"> <!entity GstBin SYSTEM "sgml/gstbin.sgml">
<!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml"> <!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
<!entity GstBufferPool SYSTEM "sgml/gstbufferpool.sgml">
<!entity GstConnection SYSTEM "sgml/gstconnection.sgml"> <!entity GstConnection SYSTEM "sgml/gstconnection.sgml">
<!entity GstCpu SYSTEM "sgml/gstcpu.sgml"> <!entity GstCpu SYSTEM "sgml/gstcpu.sgml">
<!entity GstElement SYSTEM "sgml/gstelement.sgml"> <!entity GstElement SYSTEM "sgml/gstelement.sgml">
@ -25,21 +26,19 @@
<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml"> <!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
<!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml"> <!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
<!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml"> <!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
<!entity GstAsyncDiskSrc SYSTEM "sgml/gstasyncdisksrc.sgml"> <!entity GstAsyncDiskSrc SYSTEM "sgml/gstasyncdisksrc.sgml">
<!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml"> <!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml">
<!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml"> <!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
<!entity GstAudioSrc SYSTEM "sgml/gstaudiosrc.sgml"> <!entity GstAudioSrc SYSTEM "sgml/gstaudiosrc.sgml">
<!entity GstSineSrc SYSTEM "sgml/gstsinesrc.sgml"> <!entity GstSineSrc SYSTEM "sgml/gstsinesrc.sgml">
<!entity GstAudioSink SYSTEM "sgml/gstaudiosink.sgml"> <!entity GstAudioSink SYSTEM "sgml/gstaudiosink.sgml">
<!entity GstEsdSink SYSTEM "sgml/gstesdsink.sgml"> <!entity GstEsdSink SYSTEM "sgml/gstesdsink.sgml">
<!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml"> <!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
<!entity GstIdentity SYSTEM "sgml/gstidentity.sgml"> <!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
<!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml"> <!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml"> <!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
<!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
<!entity audioraw SYSTEM "sgml/audioraw.sgml"> <!entity audioraw SYSTEM "sgml/audioraw.sgml">
<!entity spectrum SYSTEM "sgml/spectrum.sgml"> <!entity spectrum SYSTEM "sgml/spectrum.sgml">
@ -51,7 +50,7 @@
<book> <book>
<bookinfo> <bookinfo>
<title>GStreamer Library Reference Manual</title> <title>GStreamer Library Reference Manual (Core)</title>
</bookinfo> </bookinfo>
<chapter id="gstreamer"> <chapter id="gstreamer">
<title>GStreamer Core Library</title> <title>GStreamer Core Library</title>
@ -70,6 +69,7 @@ with some more specialized elements.</para>
&GstSink; &GstSink;
&GstSrc; &GstSrc;
&GstBuffer; &GstBuffer;
&GstBufferPool;
&GstPad; &GstPad;
&GstConnection; &GstConnection;
&GstPlugin; &GstPlugin;
@ -123,16 +123,20 @@ with some more specialized elements.</para>
&GstDiskSrc; &GstDiskSrc;
&GstAsyncDiskSrc; &GstAsyncDiskSrc;
&GstHttpSrc; &GstHttpSrc;
&GstFdSrc;
&GstAudioSrc; &GstAudioSrc;
&GstAudioSink;
&GstSineSrc; &GstSineSrc;
&GstAudioSink; &GstFdSrc;
&GstFdSink; &GstFdSink;
&GstPipefilter; &GstPipefilter;
&GstIdentity; &GstIdentity;
&GstQueue; &GstQueue;
&GstTypeFind;
</chapter> </chapter>
<chapter id="metatdata-types"> <chapter id="metatdata-types">
@ -145,14 +149,6 @@ with some more specialized elements.</para>
&videoraw; &videoraw;
</chapter> </chapter>
<chapter id="plugins">
<title>GStreamer Multimedia Plugins</title>
<para>GStreamer has some advanced multimedia plugins. </para>
</chapter>
<chapter id="gst-index"> <chapter id="gst-index">
<title>Index</title> <title>Index</title>

47
docs/gst/gstreamer-sections.txt
View file

@ -29,6 +29,15 @@ gst_main
gst_main_quit gst_main_quit
DEBUG DEBUG
<SUBSECTION Standard> <SUBSECTION Standard>
SETUP_STACK
</SECTION>
<SECTION>
<FILE>gstextratypes</FILE>
<TITLE>GstExtraTypes</TITLE>
GST_TYPE_FILENAME
gst_extra_get_filename_type
<SUBSECTION Standard>
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -92,7 +101,6 @@ GST_BUFFER
<SECTION> <SECTION>
<FILE>gstbufferpool</FILE> <FILE>gstbufferpool</FILE>
GST_BUFFER_POOL
GstBufferPool GstBufferPool
GstBufferPoolCreateFunction GstBufferPoolCreateFunction
GstBufferPoolDestroyFunction GstBufferPoolDestroyFunction
@ -102,6 +110,8 @@ gst_buffer_pool_destroy_buffer
gst_buffer_pool_set_create_function gst_buffer_pool_set_create_function
gst_buffer_pool_set_destroy_function gst_buffer_pool_set_destroy_function
gst_buffer_pool_destroy gst_buffer_pool_destroy
<SUBSECTION Standard>
GST_BUFFER_POOL
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -129,6 +139,7 @@ GST_STATE
GST_STATE_PENDING GST_STATE_PENDING
GstElementFlags GstElementFlags
GST_ELEMENT_IS_MULTI_IN GST_ELEMENT_IS_MULTI_IN
GST_ELEMENT_IS_THREAD_SUGGESTED
GstElement GstElement
GstElementDetails GstElementDetails
GstElementFactory GstElementFactory
@ -149,6 +160,7 @@ gst_element_error
gst_element_get_factory gst_element_get_factory
gst_element_destroy gst_element_destroy
gst_element_save_thyself gst_element_save_thyself
gst_element_load_thyself
gst_elementfactory_new gst_elementfactory_new
gst_elementfactory_register gst_elementfactory_register
gst_elementfactory_add_sink gst_elementfactory_add_sink
@ -285,6 +297,7 @@ gst_pad_pull
gst_pad_set_qos_function gst_pad_set_qos_function
gst_pad_handle_qos gst_pad_handle_qos
gst_pad_save_thyself gst_pad_save_thyself
gst_pad_load_and_connect
<SUBSECTION Standard> <SUBSECTION Standard>
GstPadClass GstPadClass
GST_TYPE_PAD GST_TYPE_PAD
@ -400,8 +413,6 @@ GST_IS_TEE_CLASS
GstThreadState GstThreadState
GstThread GstThread
gst_thread_new gst_thread_new
gst_thread_main_loop
gst_thread_iterate
<SUBSECTION Standard> <SUBSECTION Standard>
GstThreadClass GstThreadClass
gst_thread_get_type gst_thread_get_type
@ -472,14 +483,24 @@ gst_util_dump_mem
<SECTION> <SECTION>
<FILE>gstxml</FILE> <FILE>gstxml</FILE>
<TITLE>GstXml</TITLE> <TITLE>GstXml</TITLE>
GstXML
gst_xml_new
gst_xml_write gst_xml_write
gst_xml_get_element
<SUBSECTION Standard>
gst_xml_get_type
GST_XML
GST_IS_XML
GST_IS_XML_CLASS
GST_TYPE_XML
GST_XML_CLASS
GstXMLClass
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstcpu</FILE> <FILE>gstcpu</FILE>
<TITLE>GstCpu</TITLE> <TITLE>GstCpu</TITLE>
GST_CPU_FLAG_MMX GstCPUFlags
GST_CPU_FLAG_SSE
gst_cpu_get_flags gst_cpu_get_flags
</SECTION> </SECTION>
@ -688,11 +709,27 @@ gst_pipefilter_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gsttypefind</FILE>
<TITLE>GstTypeFind</TITLE>
<SUBSECTION Standard>
GstTypeFind
GstTypeFindClass
gst_typefind_get_type
GST_TYPE_TYPEFIND
GST_TYPEFIND
GST_TYPEFIND_CLASS
GST_IS_TYPEFIND
GST_IS_TYPEFIND_CLASS
</SECTION>
<SECTION>
<INCLUDE>gst/meta/audioraw.h</INCLUDE>
<FILE>audioraw</FILE> <FILE>audioraw</FILE>
MetaAudioRaw MetaAudioRaw
</SECTION> </SECTION>
<SECTION> <SECTION>
<INCLUDE>gst/meta/spectrum.h</INCLUDE>
<FILE>spectrum</FILE> <FILE>spectrum</FILE>
MetaAudioSpectrum MetaAudioSpectrum
</SECTION> </SECTION>

4
docs/gst/gstreamer.hierarchy
View file

@ -1,7 +1,4 @@
GtkObject GtkObject
GtkWidget
GtkRange
GtkContainer
GstObject GstObject
GstElement GstElement
GstBin GstBin
@ -15,6 +12,7 @@ GtkObject
GstFakeSink GstFakeSink
GstAudioSink GstAudioSink
GstFdSink GstFdSink
GstTypeFind
GstSrc GstSrc
GstFakeSrc GstFakeSrc
GstDiskSrc GstDiskSrc

4
docs/gst/gstreamer.types.in
View file

@ -1,5 +1,8 @@
#include <gtk/gtk.h> #include <gtk/gtk.h>
#include <gst/gst.h> #include <gst/gst.h>
#include <libs/colorspace/gstcolorspace.h>
gst_object_get_type gst_object_get_type
gst_element_get_type gst_element_get_type
gst_bin_get_type gst_bin_get_type
@ -29,4 +32,5 @@ gst_pipefilter_get_type
gst_identity_get_type gst_identity_get_type
gst_queue_get_type gst_queue_get_type
gst_typefind_get_type

7
docs/libs/.gitignore vendored Normal file
View file

@ -0,0 +1,7 @@
Makefile
Makefile.in
html
sgml
gstreamer-libs-unused.txt
gstreamer-libs-decl.txt
gstreamer-libs-decl-list.txt

85
docs/libs/Makefile.am Normal file
View file

@ -0,0 +1,85 @@
## Process this file with automake to produce Makefile.in
# The name of the module.
DOC_MODULE=gstreamer-libs
# The top-level SGML file.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The directory containing the source code (if it contains documentation).
DOC_SOURCE_DIR=$(top_srcdir)/libs
HTML_DIR=$(datadir)/gstreamer/html
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
tmpl_sources = \
tmpl/videoraw.sgml
gstreamer_docdir = $(HTML_DIR)
gstreamer_doc_DATA = \
$(DOC_MODULE).html \
$(DOC_MODULE)-decl.txt \
$(DOC_MODULE)-sections.txt
if HAVE_GTK_DOC
gstreamer.html: html/book1.html
-cd $(srcdir) && cp html/book1.html gstreamer.html
else
gstreamer.html:
endif
html/book1.html: sgml/gstreamer-doc.bottom
$(MAKE) html
sgml/gstreamer-doc.bottom: $(tmpl_sources)
$(MAKE) sgml
gstreamer-decl.txt:
$(MAKE) scan
scan:
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers=""
tmpl: scan
gtkdoc-mktmpl --module=$(DOC_MODULE)
sgml: tmpl
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
html:
if ! test -d html ; then mkdir html ; fi
-cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
clean-local:
rm -f *~ *.bak *.signals *-unused.txt *.args
maintainer-clean-local: clean
rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
install-data-local:
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
(installfiles=`echo $(srcdir)/html/*.html`; \
if test "$$installfiles" = '$(srcdir)/html/*.html'; \
then echo '-- Nothing to install' ; \
else \
for i in $$installfiles; do \
echo '-- Installing '$$i ; \
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
done; \
echo '-- Installing $(srcdir)/html/index.sgml' ; \
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
echo '-- Fixing Crossreferences' ; \
gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \
fi)
dist-hook:
mkdir $(distdir)/html
mkdir $(distdir)/sgml
mkdir $(distdir)/tmpl
-cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
-cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
.PHONY : html sgml templates scan

36
docs/libs/gstreamer-libs-docs.sgml Normal file
View file

@ -0,0 +1,36 @@
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!entity GstColorSpace SYSTEM "sgml/gstcolorspace.sgml">
<!entity GstGetbits SYSTEM "sgml/gstgetbits.sgml">
<!entity GstIDCT SYSTEM "sgml/gstidct.sgml">
<!entity GstPutbits SYSTEM "sgml/gstputbits.sgml">
<!entity GstVideoScale SYSTEM "sgml/gstvideoscale.sgml">
<!entity GstRiff SYSTEM "sgml/gstriff.sgml">
]>
<book>
<bookinfo>
<title>GStreamer Library Reference Manual (Libraries)</title>
</bookinfo>
<chapter id="gstreamer-libs">
<title>GStreamer Libraries</title>
<para>
To ease the creation of plugins, a library system was created. The most common
functions for a plugin can be found in a library.
</para>
<para>
GStreamer provides some standard libraries you can use to create plugins.
</para>
&GstColorSpace;
&GstGetbits;
&GstIDCT;
&GstPutbits;
&GstVideoScale;
&GstRiff;
</chapter>
</book>

445
docs/libs/gstreamer-libs-sections.txt Normal file
View file

@ -0,0 +1,445 @@
<SECTION>
<FILE>gstcolorspace</FILE>
<INCLUDE>libs/colorspace/gstcolorspace.h</INCLUDE>
GstColorSpaceType
GstColorSpaceConverter
GstColorSpaceConvertFunction
GST_COLORSPACE_RGB_FIRST
GST_COLORSPACE_YUV_FIRST
GST_COLORSPACE_YUV_LAST
GST_COLORSPACE_RGB_LAST
GST_COLORSPACE_IS_YUV_TYPE
GST_COLORSPACE_IS_RGB_TYPE
gst_colorspace_converter_new
gst_colorspace_convert
gst_colorspace_destroy
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>gstriff</FILE>
<INCLUDE>libs/riff/gstriff.h</INCLUDE>
GstRiffReturn
GstRiffParserState
GST_RIFF_OK
GST_RIFF_ENOTRIFF
GST_RIFF_EINVAL
GST_RIFF_ENOMEM
GST_RIFF_STATE_INITIAL
GST_RIFF_STATE_HASAVIH
GST_RIFF_STATE_HASSTRH
GST_RIFF_STATE_HASSTRF
GST_RIFF_STATE_MOVI
MAKE_FOUR_CC
GST_RIFF_RIFF_WAVE
GST_RIFF_RIFF_AVI
GST_RIFF_TAG_RIFF
GST_RIFF_TAG_RIFX
GST_RIFF_TAG_LIST
GST_RIFF_TAG_avih
GST_RIFF_TAG_strd
GST_RIFF_TAG_strh
GST_RIFF_TAG_strf
GST_RIFF_TAG_vedt
GST_RIFF_TAG_JUNK
GST_RIFF_TAG_idx1
GST_RIFF_TAG_fmt
GST_RIFF_TAG_data
GST_RIFF_LIST_movi
GST_RIFF_LIST_hdrl
GST_RIFF_LIST_strl
GST_RIFF_FCC_vids
GST_RIFF_FCC_auds
GST_RIFF_FCC_pads
GST_RIFF_FCC_txts
GST_RIFF_FCC_vidc
GST_RIFF_FCCH_RLE
GST_RIFF_FCCH_msvc
GST_RIFF_FCCH_MSVC
GST_RIFF_FF00
GST_RIFF_00
GST_RIFF_01
GST_RIFF_02
GST_RIFF_03
GST_RIFF_04
GST_RIFF_05
GST_RIFF_06
GST_RIFF_07
GST_RIFF_00pc
GST_RIFF_01pc
GST_RIFF_00dc
GST_RIFF_00dx
GST_RIFF_00db
GST_RIFF_00xx
GST_RIFF_00id
GST_RIFF_00rt
GST_RIFF_0021
GST_RIFF_00iv
GST_RIFF_0031
GST_RIFF_0032
GST_RIFF_00vc
GST_RIFF_00xm
GST_RIFF_01wb
GST_RIFF_01dc
GST_RIFF_cram
GST_RIFF_CRAM
GST_RIFF_wham
GST_RIFF_WHAM
GST_RIFF_rgb
GST_RIFF_RGB
GST_RIFF_rle8
GST_RIFF_RLE8
GST_RIFF_rle4
GST_RIFF_RLE4
GST_RIFF_none
GST_RIFF_NONE
GST_RIFF_pack
GST_RIFF_PACK
GST_RIFF_tran
GST_RIFF_TRAN
GST_RIFF_ccc
GST_RIFF_CCC
GST_RIFF_cyuv
GST_RIFF_CYUV
GST_RIFF_jpeg
GST_RIFF_JPEG
GST_RIFF_MJPG
GST_RIFF_mJPG
GST_RIFF_IJPG
GST_RIFF_rt21
GST_RIFF_RT21
GST_RIFF_iv31
GST_RIFF_IV31
GST_RIFF_iv32
GST_RIFF_IV32
GST_RIFF_iv41
GST_RIFF_IV41
GST_RIFF_iv50
GST_RIFF_IV50
GST_RIFF_cvid
GST_RIFF_CVID
GST_RIFF_ULTI
GST_RIFF_ulti
GST_RIFF_YUV9
GST_RIFF_YVU9
GST_RIFF_XMPG
GST_RIFF_xmpg
GST_RIFF_VDOW
GST_RIFF_MVI1
GST_RIFF_v422
GST_RIFF_V422
GST_RIFF_mvi1
GST_RIFF_MPIX
GST_RIFF_AURA
GST_RIFF_DMB1
GST_RIFF_dmb1
GST_RIFF_BW10
GST_RIFF_bw10
GST_RIFF_yuy2
GST_RIFF_YUY2
GST_RIFF_YUV8
GST_RIFF_WINX
GST_RIFF_WPY2
GST_RIFF_m263
GST_RIFF_M263
GST_RIFF_Q1_0
GST_RIFF_SFMC
GST_RIFF_y41p
GST_RIFF_Y41P
GST_RIFF_yv12
GST_RIFF_YV12
GST_RIFF_vixl
GST_RIFF_VIXL
GST_RIFF_iyuv
GST_RIFF_IYUV
GST_RIFF_i420
GST_RIFF_I420
GST_RIFF_vyuy
GST_RIFF_VYUY
GST_RIFF_DIV3
GST_RIFF_rpza
GST_RIFF_azpr
GST_RIFF_ISFT
GST_RIFF_IDIT
GST_RIFF_00AM
GST_RIFF_DISP
GST_RIFF_ISBJ
GST_RIFF_rec
gst_riff_avih
gst_riff_strh
gst_riff_strf_vids
gst_riff_strf_auds
gst_riff_riff
gst_riff_list
gst_riff_chunk
GstRiff
GstRiffChunk
GstRiffCallback
gst_riff_parser_new
gst_riff_parser_next_buffer
gst_riff_encoder_new
gst_riff_encoder_avih
gst_riff_encoder_strh
gst_riff_encoder_strf
gst_riff_encoder_chunk
gst_riff_encoder_get_buffer
gst_riff_encoder_get_and_reset_buffer
gst_riff_fourcc_to_id
gst_riff_id_to_fourcc
</SECTION>
<SECTION>
<FILE>gstgetbits_inl</FILE>
debug2
debug
checklength2
checklength
swab32
gst_getbits_init
gst_getbits_newbuf
gst_getbits_bitoffset
gst_getbits_bufferpos
gst_getbits_bytesleft
gst_getbits_bitsleft
gst_getbits1
gst_getbits2
gst_getbitsX
gst_getbits3
gst_getbits4
gst_getbits5
gst_getbits6
gst_getbits7
gst_getbits8
gst_getbits9
gst_getbits10
gst_getbits11
gst_getbits12
gst_getbits13
gst_getbits14
gst_getbits15
gst_getbits16
gst_getbits17
gst_getbits18
gst_getbits19
gst_getbits20
gst_getbits21
gst_getbits22
gst_getbits32
gst_getbitsn
gst_showbits32
gst_showbitsX
gst_showbits1
gst_showbits2
gst_showbits3
gst_showbits4
gst_showbits5
gst_showbits6
gst_showbits7
gst_showbits8
gst_showbits9
gst_showbits10
gst_showbits11
gst_showbits12
gst_showbits13
gst_showbits14
gst_showbits15
gst_showbits16
gst_showbits17
gst_showbits18
gst_showbits19
gst_showbits20
gst_showbits21
gst_showbits22
gst_showbits23
gst_showbits24
gst_showbits25
gst_showbits26
gst_showbits27
gst_showbits28
gst_showbits29
gst_showbits30
gst_showbits31
gst_showbitsn
gst_flushbits32
gst_flushbitsn
gst_backbits24
gst_backbitsn
</SECTION>
<SECTION>
<FILE>gstgetbits</FILE>
<INCLUDE>libs/getbits/gstgetbits.h</INCLUDE>
gst_getbits_t
GstGetbitsCallback
gst_getbits_init
gst_getbits_newbuf
gst_getbits_bitoffset
gst_getbits_align_byte
gst_getbits_bufferpos
gst_getbits_bytesleft
gst_getbits_bitsleft
gst_getbyte
gst_getbits_fastn
gst_getbitsn
gst_getbits1
gst_getbits2
gst_getbits3
gst_getbits4
gst_getbits5
gst_getbits6
gst_getbits7
gst_getbits8
gst_getbits9
gst_getbits10
gst_getbits11
gst_getbits12
gst_getbits13
gst_getbits14
gst_getbits15
gst_getbits16
gst_getbits17
gst_getbits18
gst_getbits19
gst_getbits20
gst_getbits21
gst_getbits22
gst_getbits23
gst_showbitsn
gst_showbits1
gst_showbits2
gst_showbits3
gst_showbits4
gst_showbits5
gst_showbits6
gst_showbits7
gst_showbits8
gst_showbits9
gst_showbits10
gst_showbits11
gst_showbits12
gst_showbits13
gst_showbits14
gst_showbits15
gst_showbits16
gst_showbits17
gst_showbits18
gst_showbits19
gst_showbits20
gst_showbits21
gst_showbits22
gst_showbits23
gst_showbits24
gst_showbits32
gst_flushbitsn
gst_flushbits32
gst_backbitsn
gst_backbits24
<SUBSECTION Standard>
gst_get1bit
gst_show1bit
gst_getbitsX
gst_getbits_fastX
gst_showbitsX
gst_flushbitsX
gst_backbitsX
swab32
DEBUG
</SECTION>
<SECTION>
<FILE>gstvideoscale</FILE>
<INCLUDE>libs/videoscale/gstvideoscale.h</INCLUDE>
GstVideoScaleMethod
GstVideoScale
GstVideoScaleScaler
gst_videoscale_new
gst_videoscale_scale
gst_videoscale_destroy
</SECTION>
<SECTION>
<FILE>gstputbits</FILE>
<INCLUDE>libs/putbits/gstputbits.h</INCLUDE>
gst_putbits_t
gst_putbits_init
gst_putbits_new_empty_buffer
gst_putbits_new_buffer
gst_putbits_align
gst_putbits_bitcount
gst_putbits1
gst_putbits2
gst_putbits3
gst_putbits4
gst_putbits5
gst_putbits6
gst_putbits7
gst_putbits8
gst_putbits9
gst_putbits10
gst_putbits11
gst_putbits12
gst_putbits13
gst_putbits14
gst_putbits15
gst_putbits16
gst_putbits17
gst_putbits18
gst_putbits19
gst_putbits20
gst_putbits21
gst_putbits22
gst_putbits32
gst_putbitsn
<SUBSECTION Standard>
gst_putbits
</SECTION>
<SECTION>
<FILE>externals</FILE>
ext_unknown
</SECTION>
<SECTION>
<FILE>wineacm</FILE>
MSACM_hHeap
MSACM_pFirstACMDriverID
MSACM_pLastACMDriverID
MSACM_RegisterDriver
MSACM_RegisterAllDrivers
MSACM_UnregisterDriver
MSACM_UnregisterAllDrivers
MSACM_GetDriverID
MSACM_GetDriver
MSACM_GetObj
</SECTION>
<SECTION>
<FILE>dct</FILE>
DCTSIZE
DCTSIZE2
EIGHT_BIT_SAMPLES
DCTELEM
DCTBLOCK[DCTSIZE2]
INT32
gst_idct_int_idct
gst_idct_init_fast_int_idct
gst_idct_fast_int_idct
gst_idct_mmx_idct
gst_idct_mmx32_idct
gst_idct_init_float_idct
gst_idct_float_idct
</SECTION>
<SECTION>
<FILE>gstidct</FILE>
<INCLUDE>libs/idct/gstidct.h</INCLUDE>
GstIDCTMethod
GstIDCT
GstIDCTFunction
GST_IDCT_TRANSPOSE
gst_idct_new
gst_idct_convert
gst_idct_convert_sparse
gst_idct_destroy
</SECTION>

1
docs/libs/tmpl/.gitignore vendored Normal file
View file

@ -0,0 +1 @@
*.bak

108
docs/libs/tmpl/dct.sgml Normal file
View file

@ -0,0 +1,108 @@
<!-- ##### SECTION Title ##### -->
dct
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO DCTSIZE ##### -->
<para>
</para>
<!-- ##### MACRO DCTSIZE2 ##### -->
<para>
</para>
<!-- ##### MACRO EIGHT_BIT_SAMPLES ##### -->
<para>
</para>
<!-- ##### TYPEDEF DCTELEM ##### -->
<para>
</para>
<!-- ##### TYPEDEF DCTBLOCK[DCTSIZE2] ##### -->
<para>
</para>
<!-- ##### TYPEDEF INT32 ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_idct_int_idct ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_idct_init_fast_int_idct ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_idct_fast_int_idct ##### -->
<para>
</para>
@block:
<!-- ##### FUNCTION gst_idct_mmx_idct ##### -->
<para>
</para>
@block:
<!-- ##### FUNCTION gst_idct_mmx32_idct ##### -->
<para>
</para>
@block:
<!-- ##### FUNCTION gst_idct_init_float_idct ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_idct_float_idct ##### -->
<para>
</para>
@block:

24
docs/libs/tmpl/externals.sgml Normal file
View file

@ -0,0 +1,24 @@
<!-- ##### SECTION Title ##### -->
externals
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION ext_unknown ##### -->
<para>
</para>
@Returns:

156
docs/libs/tmpl/gstcolorspace.sgml Normal file
View file

@ -0,0 +1,156 @@
<!-- ##### SECTION Title ##### -->
GstColorSpace
<!-- ##### SECTION Short_Description ##### -->
Convert between different colorspaces
<!-- ##### SECTION Long_Description ##### -->
<para>
The GstColorSpaceConverter can be used to convert between different
colorspaces. The most common colorspaces conversions are implemented in
fast MMX assembler.
</para>
<para>
a typical usage pattern is:
<programlisting>
...
GstColorSpaceConverter *converter;
// we setup a converter for a 100x100 bitmap
converter = gst_colorspace_converter_new(100, 100, GST_COLORSPACE_YUV420P,
GST_COLORSPACE_RGB565, gdk_visual_get_system());
...
// perform the conversion
gst_colorspace_convert(converter, src, dest);
...
</programlisting>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstColorSpaceType ##### -->
<para>
A list of all available colorspaces.
</para>
@GST_COLORSPACE_RGB555: big endian (0RRRRRGG GGGBBBBB)
@GST_COLORSPACE_BGR555: little endian (GGGBBBBB 0RRRRRGG)
@GST_COLORSPACE_RGB565: big endian (RRRRRGGG GGGBBBBB)
@GST_COLORSPACE_BGR565: little endian (GGGBBBBB RRRRRGGG)
@GST_COLORSPACE_RGB24: big endian (RRRRRRRR GGGGGGGG BBBBBBBB)
@GST_COLORSPACE_BGR24: little endian (BBBBBBBB GGGGGGGG RRRRRRRR)
@GST_COLORSPACE_RGB32: big endian (00000000 RRRRRRRR GGGGGGGG BBBBBBBB)
@GST_COLORSPACE_BGR32: little endian (BBBBBBBB GGGGGGGG RRRRRRRR 00000000)
@GST_COLORSPACE_YUV420:
@GST_COLORSPACE_YUV420P:
@GST_COLORSPACE_YUV422:
@GST_COLORSPACE_YUV422P:
<!-- ##### STRUCT GstColorSpaceConverter ##### -->
<para>
The structure that holds the information about the conversion.
</para>
@width:
@height:
@srcspace:
@destspace:
@visual:
@insize:
@outsize:
@color_tables:
@convert:
<!-- ##### USER_FUNCTION GstColorSpaceConvertFunction ##### -->
<para>
</para>
@space:
@src:
@dest:
<!-- ##### MACRO GST_COLORSPACE_RGB_FIRST ##### -->
<para>
The first RGB GstColorSpaceType
</para>
<!-- ##### MACRO GST_COLORSPACE_YUV_FIRST ##### -->
<para>
The first YUV GstColorSpaceType
</para>
<!-- ##### MACRO GST_COLORSPACE_YUV_LAST ##### -->
<para>
The first YUV GstColorSpaceType
</para>
<!-- ##### MACRO GST_COLORSPACE_RGB_LAST ##### -->
<para>
The last RGB GstColorSpaceType
</para>
<!-- ##### MACRO GST_COLORSPACE_IS_YUV_TYPE ##### -->
<para>
Check if a given colorspace type is YUV
</para>
@type: the type to check
<!-- ##### MACRO GST_COLORSPACE_IS_RGB_TYPE ##### -->
<para>
Check if a given colorspace type is RGB
</para>
@type: the type to check
<!-- ##### FUNCTION gst_colorspace_converter_new ##### -->
<para>
Create a new colorspace converter
</para>
@width: the width of the source and destination bitmap
@height: the height of the source and destination bitmap
@srcspace: the source colorspace type
@destspace: the destination colorspace type
@destvisual: the destination visual
@Returns: a new colorspace converter
<!-- ##### MACRO gst_colorspace_convert ##### -->
<para>
Perform the conversion
</para>
@converter: the converter as created with gst_colorspace_converter_new()
@src: the source bitmap
@dest: the destination bitmap
<!-- ##### FUNCTION gst_colorspace_destroy ##### -->
<para>
Destroys the colorspace converter
</para>
@space: the colorspace converter to destroy

562
docs/libs/tmpl/gstgetbits.sgml Normal file
View file

@ -0,0 +1,562 @@
<!-- ##### SECTION Title ##### -->
GstGetbits
<!-- ##### SECTION Short_Description ##### -->
Work with bits in an input stream
<!-- ##### SECTION Long_Description ##### -->
<para>
the getbits functions can be used to manipulate a bitstream like
an MPEG stream.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT gst_getbits_t ##### -->
<para>
</para>
@ptr:
@longptr:
@endptr:
@length:
@bits:
@dword:
@temp:
@callback:
@data:
@get1bit:
@getbits:
@getbits_fast:
@getbyte:
@show1bit:
@showbits:
@flushbits:
@backbits:
<!-- ##### USER_FUNCTION GstGetbitsCallback ##### -->
<para>
The callback function definition.
</para>
@gb: a pointer to the getbits structure
@data: user data
<!-- ##### FUNCTION gst_getbits_init ##### -->
<para>
</para>
@gb:
@callback:
@data:
<!-- ##### FUNCTION gst_getbits_newbuf ##### -->
<para>
</para>
@gb:
@buffer:
@len:
<!-- ##### MACRO gst_getbits_bitoffset ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits_align_byte ##### -->
<para>
Align the parser to the next byte in the input.
</para>
@gb: the bit parser
<!-- ##### MACRO gst_getbits_bufferpos ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits_bytesleft ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits_bitsleft ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbyte ##### -->
<para>
</para>
@gb: the bit parser
<!-- ##### MACRO gst_getbits_fastn ##### -->
<para>
</para>
@gb: the bit parser
@n:
<!-- ##### MACRO gst_getbitsn ##### -->
<para>
</para>
@gb:
@num:
<!-- ##### MACRO gst_getbits1 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits2 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits3 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits4 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits5 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits6 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits7 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits8 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits9 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits10 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits11 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits12 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits13 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits14 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits15 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits16 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits17 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits18 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits19 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits20 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits21 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits22 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits23 ##### -->
<para>
</para>
@gb: the bit parser
<!-- ##### MACRO gst_showbitsn ##### -->
<para>
</para>
@gb:
@num:
<!-- ##### MACRO gst_showbits1 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits2 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits3 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits4 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits5 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits6 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits7 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits8 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits9 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits10 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits11 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits12 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits13 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits14 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits15 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits16 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits17 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits18 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits19 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits20 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits21 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits22 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits23 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits24 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits32 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_flushbitsn ##### -->
<para>
</para>
@gb:
@num:
<!-- ##### MACRO gst_flushbits32 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_backbitsn ##### -->
<para>
</para>
@gb:
@num:
<!-- ##### MACRO gst_backbits24 ##### -->
<para>
</para>
@gb:

626
docs/libs/tmpl/gstgetbits_inl.sgml Normal file
View file

@ -0,0 +1,626 @@
<!-- ##### SECTION Title ##### -->
gstgetbits_inl
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO debug2 ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO debug ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO checklength2 ##### -->
<para>
</para>
@src:
@dst:
<!-- ##### MACRO checklength ##### -->
<para>
</para>
@src:
@dst:
<!-- ##### MACRO swab32 ##### -->
<para>
</para>
@x:
<!-- ##### FUNCTION gst_getbits_init ##### -->
<para>
</para>
@gb:
@callback:
@data:
<!-- ##### FUNCTION gst_getbits_newbuf ##### -->
<para>
</para>
@gb:
@buffer:
@len:
<!-- ##### MACRO gst_getbits_bitoffset ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits_bufferpos ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits_bytesleft ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits_bitsleft ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits1 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits2 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbitsX ##### -->
<para>
</para>
@gb:
@num:
@mask:
@shift:
<!-- ##### MACRO gst_getbits3 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits4 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits5 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits6 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits7 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits8 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits9 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits10 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits11 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits12 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits13 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits14 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits15 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits16 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits17 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits18 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits19 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits20 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits21 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits22 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits32 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbitsn ##### -->
<para>
</para>
@gb:
@num:
<!-- ##### MACRO gst_showbits32 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbitsX ##### -->
<para>
</para>
@gb:
@num:
@mask:
@shift:
<!-- ##### MACRO gst_showbits1 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits2 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits3 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits4 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits5 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits6 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits7 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits8 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits9 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits10 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits11 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits12 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits13 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits14 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits15 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits16 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits17 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits18 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits19 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits20 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits21 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits22 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits23 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits24 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits25 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits26 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits27 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits28 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits29 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits30 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits31 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbitsn ##### -->
<para>
</para>
@gb:
@num:
<!-- ##### MACRO gst_flushbits32 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_flushbitsn ##### -->
<para>
</para>
@gb:
@num:
<!-- ##### MACRO gst_backbits24 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_backbitsn ##### -->
<para>
</para>
@gb:
@num:

89
docs/libs/tmpl/gstidct.sgml Normal file
View file

@ -0,0 +1,89 @@
<!-- ##### SECTION Title ##### -->
GstIDCT
<!-- ##### SECTION Short_Description ##### -->
Inverse cosine transform
<!-- ##### SECTION Long_Description ##### -->
<para>
The inverse cosine transform is used in MPEG video. This module
contains various implementations of this algorithm.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstIDCTMethod ##### -->
<para>
The different IDCT methods available
</para>
@GST_IDCT_DEFAULT: The fastest IEEE compliant implementation for this machine
@GST_IDCT_INT: integer IDCT
@GST_IDCT_FAST_INT: fastest integer
@GST_IDCT_FLOAT: accurate float version
@GST_IDCT_MMX: fast MMX (not IEEE compliant)
@GST_IDCT_MMX32: accurate MMX
<!-- ##### STRUCT GstIDCT ##### -->
<para>
</para>
@convert:
@convert_sparse:
@need_transpose:
<!-- ##### USER_FUNCTION GstIDCTFunction ##### -->
<para>
The definition of the actual implementation of the IDCT transform
</para>
@block: the block to transform
<!-- ##### MACRO GST_IDCT_TRANSPOSE ##### -->
<para>
Query if this the transformer needs transposed input
</para>
@idct: the transformer
<!-- ##### FUNCTION gst_idct_new ##### -->
<para>
Create a new IDCT transformer
</para>
@method: the desired method
@Returns: the new transformer
<!-- ##### MACRO gst_idct_convert ##### -->
<para>
Perform the conversion
</para>
@idct: the transformer
@blocks: a pointer to the blocks
<!-- ##### MACRO gst_idct_convert_sparse ##### -->
<para>
Perform a sparse conversion
</para>
@idct: the transformer
@blocks: the blocks
<!-- ##### FUNCTION gst_idct_destroy ##### -->
<para>
Destroy the transformer
</para>
@idct: the transformer to destroy

292
docs/libs/tmpl/gstputbits.sgml Normal file
View file

@ -0,0 +1,292 @@
<!-- ##### SECTION Title ##### -->
GstPutbits
<!-- ##### SECTION Short_Description ##### -->
Write bits into a memory buffer
<!-- ##### SECTION Long_Description ##### -->
<para>
The putbits library can be used to write out a bit stream.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT gst_putbits_t ##### -->
<para>
</para>
@outbfr:
@outbase:
@temp:
@outcnt:
@bytecnt:
@len:
@newlen:
<!-- ##### FUNCTION gst_putbits_init ##### -->
<para>
Initialize the bit writer
</para>
@pb: the putbits structure
<!-- ##### FUNCTION gst_putbits_new_empty_buffer ##### -->
<para>
Prepare the putbits structure for writing len bytes. A new buffer
with the given length will be allocated which you must free.
</para>
@pb: the putbits structure
@len: the bytes that are going to be written
<!-- ##### FUNCTION gst_putbits_new_buffer ##### -->
<para>
Prepare the putbits structure for writing len bytes. The bits
will be written in the supplied buffer.
</para>
@pb: the putbits structure
@buffer: the buffer to write the bits in
@len: the length of the buffer
<!-- ##### FUNCTION gst_putbits_align ##### -->
<para>
Align the bits to the next byte. The buffer will be filled with zeroes.
</para>
@pb: the putbits structure
<!-- ##### FUNCTION gst_putbits_bitcount ##### -->
<para>
Get the number of bits written to the buffer
</para>
@pb: the putbits structure
@Returns: the number of bits written
<!-- ##### MACRO gst_putbits1 ##### -->
<para>
Put one bit in the buffer
</para>
@gb: the putbits structure
@val: the value of the bit to put in the buffer
<!-- ##### MACRO gst_putbits2 ##### -->
<para>
Put 2 bits into the buffer
</para>
@gb: the putbits structure
@val: the value of the bits to put in the buffer
<!-- ##### MACRO gst_putbits3 ##### -->
<para>
</para>
@gb: the putbits structure
@val:
<!-- ##### MACRO gst_putbits4 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits5 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits6 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits7 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits8 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits9 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits10 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits11 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits12 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits13 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits14 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits15 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits16 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits17 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits18 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits19 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits20 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits21 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits22 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits32 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbitsn ##### -->
<para>
Put a variable number of bits into the buffer
</para>
@gb: the putbits structure
@val: the value of the bits to put into the buffer
@n: the number of bits to put into the buffer

1225
docs/libs/tmpl/gstriff.sgml Normal file
View file

File diff suppressed because it is too large Load diff

85
docs/libs/tmpl/gstvideoscale.sgml Normal file
View file

@ -0,0 +1,85 @@
<!-- ##### SECTION Title ##### -->
GstVideoScale
<!-- ##### SECTION Short_Description ##### -->
Scale a video buffer
<!-- ##### SECTION Long_Description ##### -->
<para>
This library implements a scaling algorithm for video buffers.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstVideoScaleMethod ##### -->
<para>
the different scaling methods available.
</para>
@GST_VIDEOSCALE_POINT_SAMPLE: perform a point sample filter
@GST_VIDEOSCALE_NEAREST: use a nearest neighbor algorithm
@GST_VIDEOSCALE_BILINEAR: use a bilinear filter
@GST_VIDEOSCALE_BICUBIC: use a bicubic filter
<!-- ##### STRUCT GstVideoScale ##### -->
<para>
</para>
@source_width:
@source_height:
@dest_width:
@dest_height:
@format:
@method:
@copy_row:
@temp:
@scale:
@scaler:
@filter:
<!-- ##### USER_FUNCTION GstVideoScaleScaler ##### -->
<para>
the actual scaler implementation
</para>
@scale:
@src:
@dest:
<!-- ##### FUNCTION gst_videoscale_new ##### -->
<para>
Create a new video scaler
</para>
@sw: the width of the source bitmap
@sh: the height of the source bitmap
@dw: the width of the destination bitmap
@dh: the height of the destination bitmap
@format: the format of the source and destination bitmaps
@method: the filter method
@Returns: a new scaler
<!-- ##### MACRO gst_videoscale_scale ##### -->
<para>
Perform the scale
</para>
@scaler: the scaler
@src: the source buffer
@dest: the destination buffer
<!-- ##### FUNCTION gst_videoscale_destroy ##### -->
<para>
Destroy the scaler
</para>
@scale: the scaler to destroy

95
docs/libs/tmpl/wineacm.sgml Normal file
View file

@ -0,0 +1,95 @@
<!-- ##### SECTION Title ##### -->
wineacm
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### VARIABLE MSACM_hHeap ##### -->
<para>
</para>
<!-- ##### VARIABLE MSACM_pFirstACMDriverID ##### -->
<para>
</para>
<!-- ##### VARIABLE MSACM_pLastACMDriverID ##### -->
<para>
</para>
<!-- ##### FUNCTION MSACM_RegisterDriver ##### -->
<para>
</para>
@pszDriverAlias:
@pszFileName:
@hinstModule:
@Returns:
<!-- ##### FUNCTION MSACM_RegisterAllDrivers ##### -->
<para>
</para>
<!-- ##### FUNCTION MSACM_UnregisterDriver ##### -->
<para>
</para>
@p:
@Returns:
<!-- ##### FUNCTION MSACM_UnregisterAllDrivers ##### -->
<para>
</para>
<!-- ##### FUNCTION MSACM_GetDriverID ##### -->
<para>
</para>
@hDriverID:
@Returns:
<!-- ##### FUNCTION MSACM_GetDriver ##### -->
<para>
</para>
@hDriver:
@Returns:
<!-- ##### FUNCTION MSACM_GetObj ##### -->
<para>
</para>
@hObj:
@Returns: