From df81ae17655d86a2bd461d33fbfbed284981bc17 Mon Sep 17 00:00:00 2001 From: Erik Walthinsen Date: Thu, 4 Jan 2001 22:16:06 +0000 Subject: [PATCH] updated API docs Original commit message from CVS: updated API docs --- docs/gst/tmpl/gstasyncdisksrc.sgml | 20 - docs/gst/tmpl/gstaudiosink.sgml | 29 - docs/gst/tmpl/gstaudiosrc.sgml | 25 - docs/gst/tmpl/gstbin.sgml | 9 - docs/gst/tmpl/gstdisksrc.sgml | 20 - docs/gst/tmpl/gstelement.sgml | 42 +- docs/gst/tmpl/gstfakesink.sgml | 7 - docs/gst/tmpl/gstfakesrc.sgml | 27 - docs/gst/tmpl/gstfdsink.sgml | 5 - docs/gst/tmpl/gstfdsrc.sgml | 15 - docs/gst/tmpl/gsthttpsrc.sgml | 11 - docs/gst/tmpl/gstidentity.sgml | 5 - docs/gst/tmpl/gstinfo.sgml | 82 +- docs/gst/tmpl/gstobject.sgml | 8 - docs/gst/tmpl/gstpad.sgml | 5 - docs/gst/tmpl/gstpipefilter.sgml | 5 - docs/gst/tmpl/gstqueue.sgml | 16 - docs/gst/tmpl/gstreamer-unused.sgml | 3627 +++++++++++++++------------ docs/gst/tmpl/gstsinesrc.sgml | 20 - docs/gst/tmpl/gstthread.sgml | 6 - docs/gst/tmpl/gsttypefind.sgml | 13 - gst/cothreads.c | 17 +- gst/gstinfo.c | 89 + 23 files changed, 2137 insertions(+), 1966 deletions(-) diff --git a/docs/gst/tmpl/gstasyncdisksrc.sgml b/docs/gst/tmpl/gstasyncdisksrc.sgml index ca7479d480..b355753553 100644 --- a/docs/gst/tmpl/gstasyncdisksrc.sgml +++ b/docs/gst/tmpl/gstasyncdisksrc.sgml @@ -32,23 +32,3 @@ the offset. @GST_ASYNCDISKSRC_OPEN: @GST_ASYNCDISKSRC_FLAG_LAST: - - -Specify the location of the file to read. - - - - -Specify how many bytes to read at a time. - - - - -Specify the current offset in the file. - - - - - - - diff --git a/docs/gst/tmpl/gstaudiosink.sgml b/docs/gst/tmpl/gstaudiosink.sgml index 87e51aa4d3..8ec48a9cb6 100644 --- a/docs/gst/tmpl/gstaudiosink.sgml +++ b/docs/gst/tmpl/gstaudiosink.sgml @@ -14,32 +14,3 @@ Output to a sound card via OSS. - - -The buffer is sent to the sound card. - - -@gstaudiosink: the object which received the signal. - -@arg1: the audiosink. - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstaudiosrc.sgml b/docs/gst/tmpl/gstaudiosrc.sgml index 721a58f3e7..68dabaab9b 100644 --- a/docs/gst/tmpl/gstaudiosrc.sgml +++ b/docs/gst/tmpl/gstaudiosrc.sgml @@ -14,28 +14,3 @@ Create buffers from an OSS sound card. - - -The number of bytes per read. - - - - -Get the current number of bytes read. - - - - -The audio format as defined in soundcard.h - - - - -The number of channels (mono, stereo, ...) - - - - -The frequency. - - diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml index 98f827e650..5375c597c4 100644 --- a/docs/gst/tmpl/gstbin.sgml +++ b/docs/gst/tmpl/gstbin.sgml @@ -121,12 +121,3 @@ Flags for a bin @bin: - - -is signaled whenever a new GstElement is added to the GstBin - - - -@gstbin: the object which received the signal. -@arg1: the element that was added - diff --git a/docs/gst/tmpl/gstdisksrc.sgml b/docs/gst/tmpl/gstdisksrc.sgml index 67c4fd6366..d8516af222 100644 --- a/docs/gst/tmpl/gstdisksrc.sgml +++ b/docs/gst/tmpl/gstdisksrc.sgml @@ -33,23 +33,3 @@ with seeking capabilities use a GstAsynDiskSrc instead. @GST_DISKSRC_OPEN: @GST_DISKSRC_FLAG_LAST: - - -Specify the location of the file to read. - - - - -Specify how many bytes to read at a time. - - - - -Get the current offset in the file. - - - - - - - diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index aed2653abd..e5607c86cf 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -180,6 +180,7 @@ GstElementDetails struct for the element. @type: @details: @padtemplates: +@numpadtemplates: @@ -500,44 +501,3 @@ circumstances. @Returns: - - -Is trigered whenever the state of an element changes - - -@gstelement: the object which received the signal. -@arg1: the new state of the object - - - -Is trigered whenever a new pad is added to an element - - -@gstelement: the object which received the signal. -@arg1: the new pad that was added - - - - -Is trigered whenever a new ghost pad is added to an element - - -@gstelement: the object which received the signal. -@arg1: the new ghost pad that was added - - - -Is trigered whenever an error occured - - - -@gstelement: the object which received the signal. -@arg1: the error message - - - - - - -@gstelement: the object which received the signal. - diff --git a/docs/gst/tmpl/gstfakesink.sgml b/docs/gst/tmpl/gstfakesink.sgml index 6efd872735..361a67d1a7 100644 --- a/docs/gst/tmpl/gstfakesink.sgml +++ b/docs/gst/tmpl/gstfakesink.sgml @@ -16,10 +16,3 @@ with the buffer. (fakesink) - - - - - -@gstfakesink: the object which received the signal. - diff --git a/docs/gst/tmpl/gstfakesrc.sgml b/docs/gst/tmpl/gstfakesrc.sgml index f67bf334ea..dfc2d57101 100644 --- a/docs/gst/tmpl/gstfakesrc.sgml +++ b/docs/gst/tmpl/gstfakesrc.sgml @@ -14,30 +14,3 @@ The GstFakeSrc generates empty buffers. (fakesrc) - - - - - -@gstfakesrc: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstfdsink.sgml b/docs/gst/tmpl/gstfdsink.sgml index a9f7327643..ec3e297b20 100644 --- a/docs/gst/tmpl/gstfdsink.sgml +++ b/docs/gst/tmpl/gstfdsink.sgml @@ -14,8 +14,3 @@ Write data to a file descriptor. - - -The filedescriptor to write to. - - diff --git a/docs/gst/tmpl/gstfdsrc.sgml b/docs/gst/tmpl/gstfdsrc.sgml index 882a451986..dd2c183b71 100644 --- a/docs/gst/tmpl/gstfdsrc.sgml +++ b/docs/gst/tmpl/gstfdsrc.sgml @@ -14,18 +14,3 @@ Read buffers from a file descriptor. - - -The filedescriptor to read from. Pass the argument as a char* (???) - - - - -The number of bytes per read. - - - - -Get the current offset in the file. - - diff --git a/docs/gst/tmpl/gsthttpsrc.sgml b/docs/gst/tmpl/gsthttpsrc.sgml index f1c74b859a..2ba4a00e8d 100644 --- a/docs/gst/tmpl/gsthttpsrc.sgml +++ b/docs/gst/tmpl/gsthttpsrc.sgml @@ -14,14 +14,3 @@ Reads data from a URL. - - -Specify the location of the file. The location must be a fully qualified URL. - - - - -Specify how many bytes to read at a time. - - - diff --git a/docs/gst/tmpl/gstidentity.sgml b/docs/gst/tmpl/gstidentity.sgml index 0ec323dfd4..e5a1a65bde 100644 --- a/docs/gst/tmpl/gstidentity.sgml +++ b/docs/gst/tmpl/gstidentity.sgml @@ -14,8 +14,3 @@ Pass data without modification. - - - - - diff --git a/docs/gst/tmpl/gstinfo.sgml b/docs/gst/tmpl/gstinfo.sgml index 15ac814682..6f94c6bb83 100644 --- a/docs/gst/tmpl/gstinfo.sgml +++ b/docs/gst/tmpl/gstinfo.sgml @@ -6,8 +6,24 @@ info/debugging/error handling -GstInfo contains a lot of functions to add debugging information -to your application. +gstinfo.c contains a number of debuggins subsystems. + + +The INFO subsystem is used to provide informative printouts to +application and plugin developers. These messages can be enabled and +disabled via a category system, which is a bitmask enabling you to turn +on and off any subset of categories. + +The DEBUG subsystem is similar, but is intended for core developers +and those writing more complex pipelines or filters. It uses the same +category system, but must be enabled at configure time else it's not +compiled into the library. autogen.sh automatically enables the DEBUG +subsystem. + + +The ERROR subsystem doesn't use categories, but will print out a +more verbose message, and attempt to print out a stack trace of the error +before aborting the application. @@ -72,30 +88,30 @@ to your application. - +When defined, INFO printouts are compiled into the library. - +Print out any information usable at run-time by application developers. -@cat: -@format: -@args...: +@cat: the GST_CAT_... category for the information +@format: printf-style format string +@args...: printf arguments - +Print out information like #GST_INFO, but with an element pointer to clarify things. -@cat: -@element: -@format: -@args...: +@cat: the GST_CAT_... category for the information +@element: pointer to the #GstElement in question +@format: printf-style format string +@args...: printf arguments @@ -132,25 +148,27 @@ to your application. - +Set the debug string for the current function, typically containing the arguments +to the current function, i.e. "('element')" -@format: -@args...: +@format: printf-style format string +@args...: printf arguments - +Called at the beginning of a function, it simply prints out a DEBUG string of "entering" +in addition to the given string. -@format: -@args...: +@format: printf-style format string +@args...: printf arguments - +Combine #GST_DEBUG_ENTER and #GST_DEBUG_SET_STRING. @@ -183,12 +201,12 @@ to your application. - +Print out debugging information. -@cat: -@format: -@args...: +@cat: the GST_CAT_... the debug falls within +@format: printf-style format string +@args...: printf arguments @@ -240,23 +258,23 @@ to your application. - +Print out an error condition and abort the application. -@element: -@format: -@args...: +@element: the #GstElement in question +@format: printf-style format string +@args...: printf arguments - +Print out an error condition and abort the application. -@element: -@object: -@format: -@args...: +@element: the #GstElement in question +@object: pointer to a 'contributing' object +@format: printf-style format string +@args...: printf arguments diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml index 27f67cfa4e..ee6cdd88ad 100644 --- a/docs/gst/tmpl/gstobject.sgml +++ b/docs/gst/tmpl/gstobject.sgml @@ -174,11 +174,3 @@ This macro releases a lock on the object. @Returns: - - - - - -@gstobject: the object which received the signal. -@arg1: the new parent - diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index ea558d5414..03b0829f45 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -537,8 +537,3 @@ Indicates when this pad will become available @Returns: - - -Indicates this pad is active - - diff --git a/docs/gst/tmpl/gstpipefilter.sgml b/docs/gst/tmpl/gstpipefilter.sgml index 55f1469e74..968c3132aa 100644 --- a/docs/gst/tmpl/gstpipefilter.sgml +++ b/docs/gst/tmpl/gstpipefilter.sgml @@ -15,8 +15,3 @@ buffers from its output. - - -Sets the command to be executed. - - diff --git a/docs/gst/tmpl/gstqueue.sgml b/docs/gst/tmpl/gstqueue.sgml index e3ae1dfdaa..0363d626a7 100644 --- a/docs/gst/tmpl/gstqueue.sgml +++ b/docs/gst/tmpl/gstqueue.sgml @@ -21,19 +21,3 @@ The default queue length is set to 10. - - -Get the number of buffers in the queue. - - - - -Specify the maximum number of buffers in the queue before the queue -blocks. - - - - - - - diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 5434c6d738..7792b6e986 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -1,436 +1,3 @@ - - - - - -@obj: - - - - - - - - - - - - - - - - - - -@format: -@args...: - - - - - - -@id: -@sink: - - - - - - -@Returns: - - - - - - -@src: - - - - - - -@obj: - - - - - - -@obj: - - - -An eos signal is triggered whenever the GstSrc has reached the end of -the stream. - - - -@gstsrc: the object which received the signal. -@arg1: the object which received the signal - - - - - - - - - - - - -@name: -@Returns: - - - - - - -@obj: - - - - - - - - - - - - - - - - - - - - - - - - -@obj: - - - - - - -@name: -@Returns: - - - - - - -@obj: - - - - - - - - - - - - -@obj: - - - - - - -@format: -@args...: - - - - - - -@obj: - - - - - - -@obj: - - - - - - - - - - - - - - - - -@klass: - - - - - - -@klass: - - - - - - -@obj: - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - -@obj: - - - - - - -@Returns: - - - - - - - - - -Use this macro to show debugging info. This is only usefull when developing new -plugin elements. -If you #define DEBUG_ENABLED before including gst/gst.h, this macro will produce -g_print messages. - - -@format: the format specification as in g_print -@args...: arguments - - - - - - -@Returns: - - - - - - -@klass: - - - - - - - - - - - - - - - - - - -@obj: - - - -The sink is the end of the filter graph. A typical sink would be an audio -or a video card. - - - - - - - - - -@name: -@Returns: - - - - - - -@Returns: - - - - - - - - - - - - - - - - - - -@name: -@Returns: - - - - - - - - - - - - -@obj: - - - - - - -@connection: - - - -This macro checks to see if the GST_SRC_ASYNC flag is set. - - -@obj: GstSrc to check for flag in. - - - - - - - - - - - - - - - - - - -@klass: - - - - - - -@arg: - - - - - - - - - - - - -@obj: - - - - - - - - - -A connection is a bas class for a generic connection between -elements. A connection is typically a bas class for queues. - - - - - - - - - -@name: -@Returns: - - - - - - -@Returns: - - - - - - - - - - - - - @@ -439,329 +6,70 @@ elements. A connection is typically a bas class for queues. @pad: @buf: - + - +Query the element for the current mime type -@id: -@src: - + @Returns: - + -@pad: -@buf: - + -@cat: -@format: -@args...: - + + + + + + + -@id: @Returns: - - - - - - - - - - - - - - - - - -@klass: - - - - - - - - - - - - -@klass: - - - - - - - - + @obj: - + + + + + +@meta: + + @obj: - + -@obj: - - - - - - - - -GstColorSpace - - - - - - - -@obj: - - - - - - - - - - - - -@obj: - - - - - - - - - - - - -@id: -@Returns: - - - -Filters take data in and spit data out. They are the main Element in a filter graph. -Filters have zero or more inputs and zero or more outputs. Filters are connected -together to form filter graphs. A GstFilter is the base class and is not very usefull -on its own. - - - - -Take data in and spit data out - - - - - - - -@name: -@Returns: - - - - - - -@name: -@Returns: - - - - - - - - - - - - -@name: -@Returns: - - - - - - -@format: -@args...: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@src: - - - - - - -@name: -@Returns: - - - - - - - - - - - - -@obj: - - -GstGetbits - - - - - - - -@klass: - - - - - - -@element: -@format: -@args...: - - - - - - -@obj: - - - - - - -@src: -@offset: -@size: - - - - - - -@src: - - - - - - -@klass: - - - - - - -@obj: - - - - - - -@name: -@Returns: - - - - - - -@name: -@Returns: - - - - - - -@klass: - - - -A GstSrc is the start of a filter graph. It typically is a file or an -audio source. It provides data for the next element in the graph. - - - @@ -771,156 +79,73 @@ audio source. It provides data for the next element in the graph. @pad: @buf: - + - +This macro usets the given flags. -@obj: +@src: +@flag: Flag to set, must be a single bit in guint32. +@obj: GstSrc to unset flag in. - + +Is trigered whenever a new ghost pad is added to an element -@esdsink: -@channels: +@gstelement: the object which received the signal. +@arg1: the new ghost pad that was added - - - - - -@klass: - - - - - - -@klass: - - - - - - - - -GstSrc - - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@Returns: - - - - - - -@Returns: - - + The frequency. - + + +Specify the location of the file. The location must be a fully qualified URL. + + + + +@pad: +@buf: - + +@pad: +@buf: - - - - - -@obj: - - - -This macro unsets the given state on the element. - - -@obj: Element to unset state of. -@flag: State to unset, can be any number of bits in guint32. - - - -This macro returns the entire set of flags for the object. - - -@obj: GstSrc to return flags for. - - - - - - - - + @Returns: - - - - - - - + @klass: - -The start point of a filter graph - - - + -@klass: +@elementfactory: +@id: @@ -935,194 +160,180 @@ The start point of a filter graph - + @obj: - + + +The number of channels. + + + + - + +GstEsdSink + + + + +Use this macro to show debugging info. This is only usefull when developing new +plugin elements. +If you #define DEBUG_ENABLED before including gst/gst.h, this macro will produce +g_print messages. + + +@format: the format specification as in g_print +@args...: arguments + + + + + + + + +@type: @parent: @Returns: - + + +Is trigered whenever the state of an element changes + + +@gstelement: the object which received the signal. +@arg1: the new state of the object + + - - - - - + + + + + + + +@src: + + + + + + +@obj: + + + + + + + + + + + + +@obj: + + + + + + + + + + + + +@esdsink: @format: -@args...: - + + +An eos signal is triggered whenever the GstSrc has reached the end of +the stream. + + + +@gstsrc: the object which received the signal. +@arg1: the object which received the signal + + -@klass: - - - - - -@klass: - - + @obj: - - - - - -@Returns: - - - - - - - - - - - - -@obj: - - -GstConnection - - - - - - - - - + +@Returns: - - -This macro sets the given state on the element. - - -@obj: Element to set state of. -@flag: State to set, can be any number of bits in guint32. - - - - - - - - - - - - -@klass: - - - - - - -@GST_CAPS_ALWAYS: -@GST_CAPS_MAYBE: - - + @obj: - -Generic connection between elements. - - - + +Specify how many bytes to read at a time. - + +@Returns: - - - - - -@esdsink: - - + @obj: - - - - - -@obj: - - - - - - -@obj: - - - - - - - @@ -1130,38 +341,7 @@ Generic connection between elements. @obj: - - - - - -@obj: - - -plugin - - - - - - - - - - - - - -@pad: -@buf: - - - - - - - - + @@ -1169,55 +349,6 @@ plugin @name: @Returns: - - - - - -@obj: - - - - - - -@obj: - - - - - - - - - - - - - - - -This macro usets the given flags. - - -@src: -@flag: Flag to set, must be a single bit in guint32. -@obj: GstSrc to unset flag in. - - - - - - -@audiosink: - - - - - - -@obj: - @@ -1226,13 +357,338 @@ This macro usets the given flags. @pad: @Returns: - + +GstSrc + + + + + + + + + @obj: + + + + + + + + + + + + + + + + + +@obj: + + + + + + + + + + + + +@name: +@Returns: + + + + + + + + + + + + +@klass: + + + + + + + + + + + + +@klass: + + + + + + +@obj: + + + + + + +@arg: + + + + + + +@obj: + + + + + + + + +GstConnection + + + + +Specify how many bytes to read at a time. + + + + + + + + + + + + + + +@obj: + + + +The frequency. + + + + + +Specify how many bytes to read at a time. + + + + + + + + + + + + + + + + + + + + +@name: +@Returns: + + + + + + + + + + + + + + + + + + + + +@Returns: + + + +The volume as a double 0.0 is silent, 1.0 is loudest. + + + + + + + + + + + + + + +@connection: + + + +subclass use this to start their flag enumeration + + + + +GstElement + + + + + + + +@obj: + + + + + + +@id: +@Returns: + + + + + + +@buf: + + + + + + +@audiosink: +@channels: + + +Generic connection between elements. + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + +@element: +@format: +@args...: + + + + + + +@obj: + + + + + + +@obj: + + + +The sink is the end of the filter graph. A typical sink would be an audio +or a video card. + + + + + + + + + +@esdsink: +@channels: + + + + + + + + + + + + +@Returns: + + + + + + +@obj: + + + + + + + @@ -1240,34 +696,75 @@ This macro usets the given flags. @obj: - - -A flag indicating that SSE instructions are supported. - - - - - - - - -@pad: -@id: - - + - + + + + + + + + +Query whether this object has multiple input pads. + + + +@obj: Element to query for multiple input pads. + + + + + + +@name: +@fd: +@Returns: + + + + + + +@format: +@args...: + + + + + + + + + + + + + + + + + + + + @obj: - + + + + + + + @@ -1279,45 +776,107 @@ A flag indicating that SSE instructions are supported. - -The end point of a filter graph - - - - - - - -@Returns: - - - - - - -@klass: - - + - + @obj: - + + + + + +@pad: +@pull: + + + + + + + + @Returns: - + + + + + +@obj: + + + + + + + + + + + + + + + + + + +@src: + + + +The signal to indicate the mime type was detected. + + +@gsttypefind: the object which received the signal. +@arg1: The mime type that was detected + + + + + + + + + + + + + + + +Get the current offset in the file. + + + + + + + + +@format: +@args...: + + + + + + + + @@ -1331,6 +890,217 @@ The end point of a filter graph @Returns: + + +Specify the current offset in the file. + + + + + + + + +@name: +@Returns: + + + + + + +@klass: + + + + + + +@obj: + + + + + + + + + + + + + + + + + + +@klass: + + + + + + + + + + + + +@name: +@Returns: + + + + + + +@klass: + + + + + + +@Returns: + + + + + + +@obj: + + + + + + + + + + + + + + + + + + +@klass: + + + + + + + + + + + + + + + + +@Returns: + + + + + + + + + + + + + + + + + + +@obj: + + + +Is trigered whenever a new pad is added to an element + + +@gstelement: the object which received the signal. +@arg1: the new pad that was added + + + +Filters take data in and spit data out. They are the main Element in a filter graph. +Filters have zero or more inputs and zero or more outputs. Filters are connected +together to form filter graphs. A GstFilter is the base class and is not very usefull +on its own. + + + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@klass: + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + @@ -1339,242 +1109,81 @@ The end point of a filter graph @pad: @caps: - + + + + + +@klass: + + @obj: - - -This macro checks to see if the given state is set. - - -@obj: Element to check for state. -@flag: State to check for, must be a single bit in guint32. - - + -@type: -@parent: + + + + + + + + + + + + +@name: @Returns: - + @obj: - + +@name: @Returns: - + + + + + + + @obj: - + - - - - - -@obj: - - - -This macro sets the given flags. - - -@src: -@flag: Flag to set, can by any number of bits in guint32. -@obj: GstSrc to set flag in. - - - - - - -@Returns: - - - -Query a GstSrc for the ASYNC flag - - -@obj: The GstSrc to query - - - - - - - - - - - -@argc: -@argv: -@Returns: - - - - - - - - - - - - - - - - - - - - -GstSink - - - - - - - -@sinkid: -@srcid: -@Returns: - - - - - - - - - - - - - - - - - - -@Returns: - - - - - - - - - - - - -@connection: - - - - - - - - - - - - - - - - - - -@obj: - - - - - - -@buf: - - - -Query the element for the current mime type - - - - - - - - - - - - - - - - - - -@Returns: - - - - - - -@element: -@state: -@Returns: - - - - - - -@klass: - - - - - - - - + @@ -1587,37 +1196,63 @@ Query the element for the current mime type @klass: - + - + -@GST_PROPS_END_ID_NUM: -@GST_PROPS_LIST_ID_NUM: -@GST_PROPS_INT_ID_NUM: -@GST_PROPS_INT_RANGE_ID_NUM: -@GST_PROPS_FOURCC_ID_NUM: -@GST_PROPS_BOOL_ID_NUM: +@obj: - + + + + + +@src: + + + + + + +@id: +@sink: + + + + + + +@obj: + + - + - +This macro returns the entire set of flags for the object. + + +@obj: GstSrc to return flags for. + + +GstGetbits + + + + +The filedescriptor to write to. -@esdsink: -@frequency: @@ -1625,43 +1260,14 @@ Get the size of the current file. - - -subclass use this to start their flag enumeration - - - - + -@element: -@object: -@format: -@args...: +@klass: - - -Flags for the GstSrc element - - -@GST_SRC_ASYNC: Indicates that this src is asynchronous -@GST_SRC_FLAG_LAST: subclasses can use this to number their flags - - - - - - - - - - - - - - + @@ -1669,52 +1275,16 @@ Flags for the GstSrc element @name: @Returns: - - - - - -@audiosink: -@channels: - - - - - - - - - - - - -@thread: - - - - - - -@obj: - - - - - - - - - - - - -@obj: - - + +The start point of a filter graph + + + +@src: @@ -1723,92 +1293,23 @@ Flags for the GstSrc element @obj: - - - - - -@elementfactory: -@id: - - + +@sinkid: +@srcid: @Returns: - - - - - -@pad: -@Returns: - - - - - - - - - - - - - - - - - - -@pad: -@buf: - - - - - - - - - - - - -@pad: -@buf: - - - - - - -@klass: - - + @obj: - - - - - -@obj: - - - - - - -@klass: - - + @@ -1827,6 +1328,221 @@ Flags for the GstSrc element @src: + + + + + +@obj: + + + + + + +@id: +@Returns: + + + + + + +@esdsink: +@frequency: + + + +The number of bytes per read. + + + + + +The filedescriptor to read from. Pass the argument as a char* (???) + + + + + + + + +@klass: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + +@obj: + + + + + + +@Returns: + + + + + + +@obj: + + + + + + +@klass: + + + + + + +@obj: + + + +The audio format as defined in soundcard.h + + + + + + + + +@obj: + + + + + + +@klass: + + + + + + + + + + + + +@audiosink: + + + + + + +@elementfactory: +@id: + + + + + + +@obj: + + + +This macro unsets the given state on the element. + + +@obj: Element to unset state of. +@flag: State to unset, can be any number of bits in guint32. + + + + + + +@obj: + + + + + + +@klass: + + + + + + +@pad: +@id: + + + + + + + + + +The fequency. + + + + + + + + +@Returns: + + + +The format ad defined in soundcard.h + + + @@ -1835,7 +1551,13 @@ Flags for the GstSrc element @audiosink: @frequency: - + + + + + + + @@ -1848,12 +1570,133 @@ Flags for the GstSrc element @elementfactory: - + + +The number of bytes per read. + + + + + + + + +@obj: + + + + + +@argc: +@argv: +@Returns: + + + + + + +@obj: + + + +The buffer is sent to the sound card. + + +@gstaudiosink: the object which received the signal. +@arg1: the audiosink. + + + +Specify the location of the file to read. + + + + + + + + +@obj: + + + + + + +@gstelement: the object which received the signal. + + + + + + +@Returns: + + + + + + +@element: +@object: +@format: +@args...: + + + +TRUE if the thread should be created. + + + + + + + + + +@obj: + + + + + + +@obj: + + + + + + + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@pad: +@buf: + + -@meta: @@ -1862,147 +1705,79 @@ Flags for the GstSrc element @Returns: - - - - - -@Returns: - - - - - - -@Returns: - - - - - - -@obj: - - - - - - -@Returns: - - - - - - -@obj: - - - - - - - - - - - - -@obj: - - - - - - - - - - - - -@obj: - - - - - - -@obj: - - - - - - - - -GstElement - - - - - - - -@obj: - - - - - - - - - - - - - - - - - - -@pad: -@pull: - - - - - - - - - - - - -@esdsink: -@format: - - - -Query whether this object has multiple input pads. - - - -@obj: Element to query for multiple input pads. - - + @klass: - + + +A connection is a bas class for a generic connection between +elements. A connection is typically a bas class for queues. + + + + + + + + + +@buf: + + + +Query a GstSrc for the ASYNC flag + + +@obj: The GstSrc to query + + + + + + +@obj: + + + +This macro sets the given state on the element. + + +@obj: Element to set state of. +@flag: State to set, can be any number of bits in guint32. + + + + + + +@pad: +@buf: + + - + + + + + +@Returns: + + + + + + +@gstfakesink: the object which received the signal. + + @@ -2015,123 +1790,62 @@ Query whether this object has multiple input pads. @obj: - + + + + + + + + + + + + + @src: +@offset: +@size: - - - - - + -@klass: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - - - - - - - -@name: -@fd: @Returns: - -GstFilter - - - + -@elementfactory: -@id: - + -@buf: +@obj: - + -@pad: -@Returns: - - - - - - -@audiosink: @format: +@args...: - - - - - -@klass: - - + @obj: - - - - - -@Returns: - @@ -2142,27 +1856,147 @@ GstFilter @format: @args...: - + + + + + +@klass: + + + + + + +@name: +@Returns: + + + + + + +@klass: + + + + + + + + + + + + +@id: +@src: + + + + + + + + + + + + +@Returns: + + @obj: - + + + + + + + @obj: - + +Take data in and spit data out + + + + +This macro checks to see if the GST_SRC_ASYNC flag is set. + + +@obj: GstSrc to check for flag in. + + + + + + + + + + + + +@klass: + + + + + + + + + +A flag indicating that SSE instructions are supported. + + + + + + + + +@esdsink: + + @obj: + + + + + +@connection: + + + +is signaled whenever a new GstElement is added to the GstBin + + + +@gstbin: the object which received the signal. +@arg1: the element that was added + + + + + + + @@ -2171,15 +2005,526 @@ GstFilter @name: @Returns: + + + + + + + + + + + +@Returns: + + + + + + +@obj: + + + + + + + + + + + + +@obj: + + + + + + + + +GstFilter + + + + + + + +@obj: + + + + + + +@obj: + + + + + + +@Returns: + + + + + + +@gstfakesrc: the object which received the signal. + + + + + + +@GST_PROPS_END_ID_NUM: +@GST_PROPS_LIST_ID_NUM: +@GST_PROPS_INT_ID_NUM: +@GST_PROPS_INT_RANGE_ID_NUM: +@GST_PROPS_FOURCC_ID_NUM: +@GST_PROPS_BOOL_ID_NUM: + + + + + + +@pad: +@Returns: + + + + + + +@pad: +@Returns: + + + + + + +@thread: + + + + + + +@GST_CAPS_ALWAYS: +@GST_CAPS_MAYBE: + + + +Get the current offset in the file. + + + + + +Sets the command to be executed. + + + + + + + + + + + +Flags for the GstSrc element + + +@GST_SRC_ASYNC: Indicates that this src is asynchronous +@GST_SRC_FLAG_LAST: subclasses can use this to number their flags + + + +Specify the maximum number of buffers in the queue before the queue +blocks. + + + + + +Get the number of buffers in the queue. + + + + + + + + +@obj: + + +GstColorSpace + + + + + + + + + + + + + +@element: +@state: +@Returns: + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + + + +Specify the location of the file to read. + + + + + + + + +@klass: + + + + + + +@Returns: + + + + + + +@Returns: + + + + + + +@klass: + + + + + + + + + + + + +@klass: + + + + + + + + + + + + +@parent: +@Returns: + + + + + + +@name: +@Returns: + + + + + + + + + + + + +@format: +@args...: + + + + + + +@audiosink: +@format: + + + + + + +@obj: + + +The end point of a filter graph + + + + + + + +@cat: +@format: +@args...: + + + + + + +@obj: + + + + + + +@name: +@Returns: + + + +Get the current number of bytes read. + + + + + +The number of channels (mono, stereo, ...) + + + + + + + + + + + + + + + + +plugin + + + + +This macro checks to see if the given state is set. + + +@obj: Element to check for state. +@flag: State to check for, must be a single bit in guint32. + + + + + + +@gstobject: the object which received the signal. +@arg1: the new parent + + + + + + +@obj: + + + + + + + + + + + + + + + + + + +@name: +@Returns: + + + + + + +@obj: + + + + + + + + + + + + + + + + + + +@obj: + + + +Is trigered whenever an error occured + + + +@gstelement: the object which received the signal. +@arg1: the error message + + + + + + + + + +This macro sets the given flags. + + +@src: +@flag: Flag to set, can by any number of bits in guint32. +@obj: GstSrc to set flag in. + + + + + + +@klass: + + + + + + +@obj: + + + + + + +@klass: + + + + + + + + + +Indicates this pad is active + + + + + + + + +@Returns: + + + + + + +@name: +@Returns: + + + +A GstSrc is the start of a filter graph. It typically is a file or an +audio source. It provides data for the next element in the graph. + + + + + + + + + + + +GstSink + + A flag indicating that MMX instructions are supported. - - - - - - diff --git a/docs/gst/tmpl/gstsinesrc.sgml b/docs/gst/tmpl/gstsinesrc.sgml index 7768424330..687c03392d 100644 --- a/docs/gst/tmpl/gstsinesrc.sgml +++ b/docs/gst/tmpl/gstsinesrc.sgml @@ -14,23 +14,3 @@ Create a sine wave of a given frequency and volume. - - -The volume as a double 0.0 is silent, 1.0 is loudest. - - - - -The format ad defined in soundcard.h - - - - -The number of channels. - - - - -The fequency. - - diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml index 1a0aed88c8..659af8e5a5 100644 --- a/docs/gst/tmpl/gstthread.sgml +++ b/docs/gst/tmpl/gstthread.sgml @@ -43,9 +43,3 @@ thread flags @Returns: - - -TRUE if the thread should be created. - - - diff --git a/docs/gst/tmpl/gsttypefind.sgml b/docs/gst/tmpl/gsttypefind.sgml index ace6c21877..4fb5972710 100644 --- a/docs/gst/tmpl/gsttypefind.sgml +++ b/docs/gst/tmpl/gsttypefind.sgml @@ -15,16 +15,3 @@ the detected mime type of the stream. It is used in autoplugging. - - -The signal to indicate the mime type was detected. - - -@gsttypefind: the object which received the signal. -@arg1: The mime type that was detected - - - - - - diff --git a/gst/cothreads.c b/gst/cothreads.c index 1dec8f3f14..e4eca4ba1b 100644 --- a/gst/cothreads.c +++ b/gst/cothreads.c @@ -45,7 +45,7 @@ pthread_key_t _cothread_key = -1; /** * cothread_init: * - * create and initialize a new cotread context + * Create and initialize a new cothread context * * Returns: the new cothread context */ @@ -90,7 +90,7 @@ cothread_init (void) * cothread_create: * @ctx: the cothread context * - * create a new cotread state in the given context + * Create a new cothread state in the given context * * Returns: the new cothread state */ @@ -136,8 +136,8 @@ cothread_create (cothread_context *ctx) * cothread_setfunc: * @thread: the cothread state * @func: the function to call - * @argc: the argument count for the cothread function - * @argv: the arguments for the cothread function + * @argc: argument count for the cothread function + * @argv: arguments for the cothread function * * Set the cothread function */ @@ -153,6 +153,11 @@ cothread_setfunc (cothread_state *thread, thread->pc = (int *)func; } +/** + * cothread_main: + * @ctx: cothread context to find main thread of + * + * Returns: the #cothread_state of the main (0th) thread static cothread_state* cothread_main(cothread_context *ctx) { @@ -226,9 +231,9 @@ cothread_get_data (cothread_state *thread, /** * cothread_switch: - * @thread: the cothread state + * @thread: cothread state to switch to * - * switches to the given cothread state + * Switches to the given cothread state */ void cothread_switch (cothread_state *thread) diff --git a/gst/gstinfo.c b/gst/gstinfo.c index 492879a3e4..89ba3f5ffc 100644 --- a/gst/gstinfo.c +++ b/gst/gstinfo.c @@ -65,6 +65,20 @@ static gchar *_gst_info_category_strings[] = { "XML", }; +/** + * gst_default_info_handler: + * @category: category of the INFO message + * @file: the file the INFO occurs in + * @function: the function the INFO occurs in + * @line: the line number in the file + * @debug_string: the current debug_string in the function, if any + * @element: pointer to the #GstElement in question + * @string: the actual INFO string + * + * Prints out the INFO mesage in a variant of the following form: + * + * INFO:gst_function:542(args): [elementname] something neat happened + */ void gst_default_info_handler (gint category, gchar *file, gchar *function, gint line, gchar *debug_string, @@ -87,6 +101,13 @@ gst_default_info_handler (gint category, gchar *file, gchar *function, g_free(string); } +/** + * gst_info_set_categories: + * @categories: bitmask of INFO categories to enable + * + * Enable the output of INFO categories based on the given bitmask. + * The bit for any given category is (1 << GST_CAT_...). + */ void gst_info_set_categories (guint32 categories) { _gst_info_categories = categories; @@ -94,11 +115,23 @@ gst_info_set_categories (guint32 categories) { GST_INFO (0, "setting INFO categories to 0x%08X\n",categories); } +/** + * gst_info_get_categories: + * + * Returns: the current bitmask of enabled INFO categories + * The bit for any given category is (1 << GST_CAT_...). + */ guint32 gst_info_get_categories () { return _gst_info_categories; } +/** + * gst_info_enable_category: + * @category: the category to enable + * + * Enables the given GST_CAT_... INFO category. + */ void gst_info_enable_category (gint category) { _gst_info_categories |= (1 << category); @@ -106,6 +139,12 @@ gst_info_enable_category (gint category) { GST_INFO (0, "setting INFO categories to 0x%08X\n",_gst_info_categories); } +/** + * gst_info_disable_category: + * @category: the category to disable + * + * Disables the given GST_CAT_... INFO category. + */ void gst_info_disable_category (gint category) { _gst_info_categories &= ~ (1 << category); @@ -119,6 +158,13 @@ gst_info_disable_category (gint category) { guint32 _gst_debug_categories = 0x00000000; +/** + * gst_debug_set_categories: + * @categories: bitmask of DEBUG categories to enable + * + * Enable the output of DEBUG categories based on the given bitmask. + * The bit for any given category is (1 << GST_CAT_...). + */ void gst_debug_set_categories (guint32 categories) { _gst_debug_categories = categories; @@ -126,11 +172,23 @@ gst_debug_set_categories (guint32 categories) { GST_INFO (0, "setting DEBUG categories to 0x%08X\n",categories); } +/** + * gst_debug_get_categories: + * + * Returns: the current bitmask of enabled DEBUG categories + * The bit for any given category is (1 << GST_CAT_...). + */ guint32 gst_debug_get_categories () { return _gst_debug_categories; } +/** + * gst_debug_enable_category: + * @category: the category to enable + * + * Enables the given GST_CAT_... DEBUG category. + */ void gst_debug_enable_category (gint category) { _gst_debug_categories |= (1 << category); @@ -138,6 +196,12 @@ gst_debug_enable_category (gint category) { GST_INFO (0, "setting DEBUG categories to 0x%08X\n",_gst_debug_categories); } +/** + * gst_debug_disable_category: + * @category: the category to disable + * + * Disables the given GST_CAT_... DEBUG category. + */ void gst_debug_disable_category (gint category) { _gst_debug_categories &= ~ (1 << category); @@ -145,6 +209,12 @@ gst_debug_disable_category (gint category) { GST_INFO (0, "setting DEBUG categories to 0x%08X\n",_gst_debug_categories); } +/** + * gst_get_category_name: + * @category: the category to return the name of + * + * Returns: string containing the name of the category + */ const gchar * gst_get_category_name (gint category) { if ((category >= 0) && (category < GST_CAT_MAX_CATEGORY)) @@ -158,6 +228,25 @@ gst_get_category_name (gint category) { /***** ERROR system *****/ GstErrorHandler _gst_error_handler = gst_default_error_handler; +/** + * gst_default_error_handler: + * @file: the file the ERROR occurs in + * @function: the function the INFO occurs in + * @line: the line number in the file + * @debug_string: the current debug_string in the function, if any + * @element: pointer to the #GstElement in question + * @object: pointer to a related object + * @string: the actual ERROR string + * + * Prints out the given ERROR string in a variant of the following format: + * + * ***** GStreamer ERROR ***** in file gstsomething.c at gst_function:399(arg) + * Element: /pipeline/thread/element.src + * Error: peer is null! + * ***** attempting to stack trace.... ***** + * + * At the end, it attempts to print the stack trace via GDB. + */ void gst_default_error_handler (gchar *file, gchar *function, gint line, gchar *debug_string,