various style fixes

Original commit message from CVS:
various style fixes
This commit is contained in:
Thomas Vander Stichele 2005-10-15 16:01:57 +00:00
parent 5cb910050a
commit bef56ce78d
44 changed files with 164 additions and 112 deletions

View file

@ -19,11 +19,13 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gst * SECTION:gst
* @short_description: Media library supporting arbitrary formats and filter graphs. * @short_description: Media library supporting arbitrary formats and filter
* graphs.
* @see_also: Check out both <ulink url="http://www.cse.ogi.edu/sysl/">OGI's * @see_also: Check out both <ulink url="http://www.cse.ogi.edu/sysl/">OGI's
* pipeline</ulink> and Microsoft's DirectShow for some background. * pipeline</ulink> and Microsoft's DirectShow for some background.
* *
* GStreamer is a framework for constructing graphs of various filters * GStreamer is a framework for constructing graphs of various filters
* (termed elements here) that will handle streaming media. Any discreet * (termed elements here) that will handle streaming media. Any discreet
@ -57,8 +59,8 @@
* </programlisting> * </programlisting>
* </example> * </example>
* *
* It's allowed to pass two NULL pointers to gst_init() in case you don't want to * It's allowed to pass two NULL pointers to gst_init() in case you don't want
* pass the command line args to GStreamer. * to pass the command line args to GStreamer.
* *
* You can also use a popt table to initialize your own parameters as shown in * You can also use a popt table to initialize your own parameters as shown in
* the next code fragment: * the next code fragment:
@ -85,8 +87,8 @@
* </programlisting> * </programlisting>
* </example> * </example>
* *
* Use gst_version() to query the library version at runtime or use the GST_VERSION_* macros * Use gst_version() to query the library version at runtime or use the
* to find the version at compile time. * GST_VERSION_* macros to find the version at compile time.
* *
* The functions gst_main() and gst_main_quit() enter and exit the main loop. * The functions gst_main() and gst_main_quit() enter and exit the main loop.
* GStreamer doesn't currently require you to use a mainloop but can intergrate * GStreamer doesn't currently require you to use a mainloop but can intergrate

View file

@ -22,6 +22,7 @@
* *
* MT safe. * MT safe.
*/ */
/** /**
* SECTION:gstbin * SECTION:gstbin
* @short_description: Base class for elements that contain other elements * @short_description: Base class for elements that contain other elements

View file

@ -19,6 +19,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstbuffer * SECTION:gstbuffer
* @short_description: Data-passing buffer type, supporting sub-buffers. * @short_description: Data-passing buffer type, supporting sub-buffers.
@ -75,12 +76,13 @@
* a buffer that is safe to modify by using gst_buffer_make_writable(). This * a buffer that is safe to modify by using gst_buffer_make_writable(). This
* function is optimized so that a copy will only be made when it is necessary. * function is optimized so that a copy will only be made when it is necessary.
* *
* Several flags of the buffer can be set and unset with the GST_BUFFER_FLAG_SET() * Several flags of the buffer can be set and unset with the
* and GST_BUFFER_FLAG_UNSET() macros. Use GST_BUFFER_FLAG_IS_SET() to test it * GST_BUFFER_FLAG_SET() and GST_BUFFER_FLAG_UNSET() macros. Use
* a certain #GstBufferFlag is set. * GST_BUFFER_FLAG_IS_SET() to test it a certain #GstBufferFlag is set.
* *
* Buffers can be efficiently merged into a larger buffer with gst_buffer_merge() * Buffers can be efficiently merged into a larger buffer with
* and gst_buffer_span() if the gst_buffer_is_span_fast() function returns TRUE. * gst_buffer_merge() and gst_buffer_span() if the gst_buffer_is_span_fast()
* function returns TRUE.
* *
* An element should either unref the buffer or push it out on a src pad * An element should either unref the buffer or push it out on a src pad
* using gst_pad_push() (see #GstPad). * using gst_pad_push() (see #GstPad).

View file

@ -18,6 +18,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstbus * SECTION:gstbus
* @short_description: Asynchronous message bus subsystem * @short_description: Asynchronous message bus subsystem
@ -45,9 +46,9 @@
* up to the specified timeout value until one of the specified messages types * up to the specified timeout value until one of the specified messages types
* is posted on the bus. The application can then _pop() the messages from the * is posted on the bus. The application can then _pop() the messages from the
* bus to handle them. * bus to handle them.
* Alternatively the application can register an asynchronous bus function using * Alternatively the application can register an asynchronous bus function
* gst_bus_add_watch_full() or gst_bus_add_watch(). This function will receive * using gst_bus_add_watch_full() or gst_bus_add_watch(). This function will
* messages a short while after they have been posted. * receive messages a short while after they have been posted.
* *
* It is also possible to get messages from the bus without any thread * It is also possible to get messages from the bus without any thread
* marshalling with the gst_bus_set_sync_handler() method. This makes it * marshalling with the gst_bus_set_sync_handler() method. This makes it
@ -57,8 +58,8 @@
* *
* Every #GstPipeline has one bus. * Every #GstPipeline has one bus.
* *
* Note that a #GstPipeline will set its bus into flushing state when changing from * Note that a #GstPipeline will set its bus into flushing state when changing
* READY to NULL state. * from READY to NULL state.
*/ */
#include <errno.h> #include <errno.h>

View file

@ -16,6 +16,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstcaps * SECTION:gstcaps
* @short_description: Structure describing sets of media formats * @short_description: Structure describing sets of media formats

View file

@ -18,6 +18,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstchildproxy * SECTION:gstchildproxy
* @short_description: Interface for multi child elements. * @short_description: Interface for multi child elements.
@ -25,8 +26,8 @@
* *
* This interface abstracts handling of property sets for child elements. * This interface abstracts handling of property sets for child elements.
* Imagine elements such as mixers or polyphonic generators. They all have * Imagine elements such as mixers or polyphonic generators. They all have
* multiple #GstPads or some kind of voice objects. The element acts as a parent * multiple #GstPads or some kind of voice objects. The element acts as a
* for those child objects. Each child has the same properties. * parent for those child objects. Each child has the same properties.
* *
* By implementing this interface the child properties can be accessed from the * By implementing this interface the child properties can be accessed from the
* parent element by using gst_child_proxy_get() and gst_child_proxy_set(). * parent element by using gst_child_proxy_get() and gst_child_proxy_set().

View file

@ -20,6 +20,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstclock * SECTION:gstclock
* @short_description: Abstract class for global clocks * @short_description: Abstract class for global clocks
@ -36,6 +37,7 @@
* *
* The time of the clock in itself is not very useful for an application. * The time of the clock in itself is not very useful for an application.
*/ */
#include <time.h> #include <time.h>
#include "gst_private.h" #include "gst_private.h"

View file

@ -24,7 +24,7 @@
* SECTION:gstconfig * SECTION:gstconfig
* @short_description: Build configuration options * @short_description: Build configuration options
* *
* This describes the configuration options for GStreamer. When building * This describes the configuration options for GStreamer. When building
* GStreamer there are a lot of parts (known internally as "subsystems" ) that * GStreamer there are a lot of parts (known internally as "subsystems" ) that
* can be disabled for various reasons. The most common reasons are speed and * can be disabled for various reasons. The most common reasons are speed and
* size, which is important because GStreamer is designed to run on embedded * size, which is important because GStreamer is designed to run on embedded
@ -34,8 +34,8 @@
* compatible way, so you don't need to adapt your code in most cases. It is * compatible way, so you don't need to adapt your code in most cases. It is
* never done in an ABI compatible way though. So if you want to disable a * never done in an ABI compatible way though. So if you want to disable a
* suybsystem, you have to rebuild all programs depending on GStreamer, too. * suybsystem, you have to rebuild all programs depending on GStreamer, too.
* *
* If a subsystem is disabled in GStreamer, a value is defined in * If a subsystem is disabled in GStreamer, a value is defined in
* &lt;gst/gst.h&gt;. You can check this if you do subsystem-specific stuff. * &lt;gst/gst.h&gt;. You can check this if you do subsystem-specific stuff.
* <example> * <example>
* <title>Doing subsystem specific things</title> * <title>Doing subsystem specific things</title>

View file

@ -19,6 +19,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstelement * SECTION:gstelement
* @short_description: Abstract base class for all pipeline elements * @short_description: Abstract base class for all pipeline elements
@ -64,11 +65,12 @@
* gst_element_provides_clock() returns TRUE. With the gst_element_provide_clock() * gst_element_provides_clock() returns TRUE. With the gst_element_provide_clock()
* method one can retrieve the clock provided by such an element. * method one can retrieve the clock provided by such an element.
* Not all elements require a clock to operate correctly. If * Not all elements require a clock to operate correctly. If
* gst_element_requires_clock() returns TRUE, a clock should be set on the element * gst_element_requires_clock() returns TRUE, a clock should be set on the
* with gst_element_set_clock(). * element with gst_element_set_clock().
* *
* Note that clock slection and distribution is normally handled by the toplevel * Note that clock slection and distribution is normally handled by the
* #GstPipeline so the clock functions are only to be used in very specific situations. * toplevel #GstPipeline so the clock functions are only to be used in very
* specific situations.
*/ */
#include "gst_private.h" #include "gst_private.h"

View file

@ -20,24 +20,26 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstelementfactory * SECTION:gstelementfactory
* @short_description: Create GstElements from a factory * @short_description: Create GstElements from a factory
* @see_also: #GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate. * @see_also: #GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
* *
* GstElementFactory is used to create instances of elements. A GstElementfactory * GstElementFactory is used to create instances of elements. A
* can be added to a #GstPlugin as it is also a #GstPluginFeature. * GstElementfactory can be added to a #GstPlugin as it is also a
* #GstPluginFeature.
* *
* Use gst_element_factory_new() to create a new factory which can be added to a * Use gst_element_factory_new() to create a new factory which can be added to
* plugin with gst_plugin_add_feature(). * a plugin with gst_plugin_add_feature().
* *
* gst_element_factory_add_pad_template() is used to add a padtemplate to the factory. * gst_element_factory_add_pad_template() is used to add a padtemplate to the
* This function will enable the application to query for elementfactories that handle * factory. This function will enable the application to query for
* a specific media type. * elementfactories that handle a specific media type.
* *
* Use the gst_element_factory_find() and gst_element_factory_create() functions * Use the gst_element_factory_find() and gst_element_factory_create()
* to create element instances or use gst_element_factory_make() as a convenient * functions to create element instances or use gst_element_factory_make() as a
* shortcut. * convenient shortcut.
* *
* The following code example shows you how to create a GstFileSrc element. * The following code example shows you how to create a GstFileSrc element.
* *

View file

@ -16,6 +16,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gsterror * SECTION:gsterror
* @short_description: Categorized error messages * @short_description: Categorized error messages

View file

@ -19,6 +19,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstevent * SECTION:gstevent
* @short_description: Structure describing events that are passed up and down * @short_description: Structure describing events that are passed up and down

View file

@ -16,6 +16,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstfilter * SECTION:gstfilter
* @short_description: A utility function to filter GLists. * @short_description: A utility function to filter GLists.

View file

@ -20,13 +20,15 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstformat * SECTION:gstformat
* @short_description: Dynamically register new data formats * @short_description: Dynamically register new data formats
* @see_also: #GstPad, #GstElement * @see_also: #GstPad, #GstElement
* *
* GstFormats functions are used to register a new format to the gstreamer core. * GstFormats functions are used to register a new format to the gstreamer
* Formats can be used to perform seeking or conversions/query operations. * core. Formats can be used to perform seeking or conversions/query
* operations.
*/ */
#include <string.h> #include <string.h>

View file

@ -20,6 +20,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstghostpad * SECTION:gstghostpad
* @short_description: Pseudo link pads * @short_description: Pseudo link pads

View file

@ -19,6 +19,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstindex * SECTION:gstindex
* @short_description: Generate indexes on objects * @short_description: Generate indexes on objects

View file

@ -19,6 +19,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstindexfactory * SECTION:gstindexfactory
* @short_description: Create GstIndexes from a factory * @short_description: Create GstIndexes from a factory

View file

@ -20,6 +20,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstinfo * SECTION:gstinfo
* @short_description: Debugging and logging facillities * @short_description: Debugging and logging facillities
@ -27,21 +28,19 @@
* and environment variables that affect the debugging output. * and environment variables that affect the debugging output.
* *
* GStreamer's debugging subsystem is an easy way to get information about what * GStreamer's debugging subsystem is an easy way to get information about what
* the application is doing. * the application is doing. It is not meant for programming errors. Use GLib
* It is not meant for programming errors. Use GLib methods (g_warning and * methods (g_warning and friends) for that.
* friends) for that.
* *
* The debugging subsystem works only after GStreamer has been initialized * The debugging subsystem works only after GStreamer has been initialized
* - for example by calling gst_init(). * - for example by calling gst_init().
* *
* The debugging subsystem is used to log informational messages while the * The debugging subsystem is used to log informational messages while the
* application runs. * application runs. Each messages has some properties attached to it. Among
* Each messages has some properties attached to it. Among these properties * these properties are the debugging category, the severity (called "level"
* are the debugging category, the severity (called "level" here) and an * here) and an optional #GObject it belongs to. Each of these messages is sent
* optional * to all registered debugging handlers, which then handle the messages.
* #GObject it belongs to. Each of these messages is sent to all registered * GStreamer attaches a default handler on startup, which outputs requested
* debugging handlers, which then handle the messages. GStreamer attaches a * messages to stderr.
* default handler on startup, which outputs requested messages to stderr.
* *
* Messages are output by using shortcut macros like #GST_DEBUG, * Messages are output by using shortcut macros like #GST_DEBUG,
* #GST_CAT_ERROR_OBJECT or similar. These all expand to calling gst_debug_log() * #GST_CAT_ERROR_OBJECT or similar. These all expand to calling gst_debug_log()

View file

@ -20,6 +20,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstimplementsinterface * SECTION:gstimplementsinterface
* @short_description: Core interface implemented by #GstElement instances that * @short_description: Core interface implemented by #GstElement instances that

View file

@ -18,6 +18,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstiterator * SECTION:gstiterator
* @short_description: Object to retrieve multiple elements in a threadsafe * @short_description: Object to retrieve multiple elements in a threadsafe

View file

@ -20,6 +20,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstmemchunk * SECTION:gstmemchunk
* @short_description: Atomic chunk allocator * @short_description: Atomic chunk allocator
@ -32,6 +33,7 @@
* The GstMemChunk is used to allocate critical resources for #GstBuffer and * The GstMemChunk is used to allocate critical resources for #GstBuffer and
* #GstEvent. * #GstEvent.
*/ */
#include "gst_private.h" #include "gst_private.h"
#include <string.h> /* memset */ #include <string.h> /* memset */

View file

@ -18,9 +18,11 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstmessage * SECTION:gstmessage
* @short_description: Lightweight objects to signal the application of pipeline events * @short_description: Lightweight objects to signal the application of
* pipeline events
* @see_also: #GstBus,#GstMiniObject * @see_also: #GstBus,#GstMiniObject
* *
* Messages are implemented as a subclass of #GstMiniObject with a generic * Messages are implemented as a subclass of #GstMiniObject with a generic

View file

@ -20,6 +20,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstobject * SECTION:gstobject
* @short_description: Base class for the GStreamer object hierarchy * @short_description: Base class for the GStreamer object hierarchy
@ -33,30 +34,31 @@
* found under the same name in the base class of GstObject which is GObject * found under the same name in the base class of GstObject which is GObject
* (e.g. g_object_ref() becomes gst_object_ref()). * (e.g. g_object_ref() becomes gst_object_ref()).
* *
* The most interesting difference between GstObject and GObject is the "floating" * The most interesting difference between GstObject and GObject is the
* reference count. A GObject is created with a reference count of 1, owned by the * "floating" reference count. A GObject is created with a reference count of
* creator of the GObject. (The owner of a reference is the code section that has * 1, owned by the creator of the GObject. (The owner of a reference is the
* the right to call gst_object_unref() in order to remove that reference.) * code section that has the right to call gst_object_unref() in order to
* A GstObject is created with a reference count of 1 also, but it isn't owned by * remove that reference.) A GstObject is created with a reference count of 1
* anyone; calling gst_object_unref() on the newly-created GtkObject is incorrect. * also, but it isn't owned by anyone; calling gst_object_unref() on the
* Instead, the initial reference count of a GstObject is "floating". The floating * newly-created GtkObject is incorrect. Instead, the initial reference count
* reference can be removed by anyone at any time, by calling gst_object_sink(). * of a GstObject is "floating". The floating reference can be removed by
* gst_object_sink() does nothing if an object is already sunk (has no floating * anyone at any time, by calling gst_object_sink(). gst_object_sink() does
* reference). * nothing if an object is already sunk (has no floating reference).
* *
* When you add a GstElement to its parent container, the parent container will do * When you add a GstElement to its parent container, the parent container will
* this: * do this:
* <informalexample> * <informalexample>
* <programlisting> * <programlisting>
* gst_object_ref (GST_OBJECT (child_element)); * gst_object_ref (GST_OBJECT (child_element));
* gst_object_sink (GST_OBJECT (child_element)); * gst_object_sink (GST_OBJECT (child_element));
* </programlisting> * </programlisting>
* </informalexample> * </informalexample>
* This means that the container now owns a reference to the child element (since * This means that the container now owns a reference to the child element
* it called gst_object_ref()), and the child element has no floating reference. * (since it called gst_object_ref()), and the child element has no floating
* reference.
* *
* The purpose of the floating reference is to keep the child element alive until * The purpose of the floating reference is to keep the child element alive
* you add it to a parent container: * until you add it to a parent container:
* <informalexample> * <informalexample>
* <programlisting> * <programlisting>
* element = gst_element_factory_make (factoryname, name); * element = gst_element_factory_make (factoryname, name);
@ -66,9 +68,9 @@
* </programlisting> * </programlisting>
* </informalexample> * </informalexample>
* *
* Another effect of this is, that calling gst_object_unref() on a bin object, will * Another effect of this is, that calling gst_object_unref() on a bin object,
* also destoy all the GstElement objects in it. The same is true for calling * will also destoy all the GstElement objects in it. The same is true for
* gst_bin_remove(). * calling gst_bin_remove().
* *
* In contrast to GObject instances GstObject add a name property. The functions * In contrast to GObject instances GstObject add a name property. The functions
* gst_object_set_name() and gst_object_get_name() are used to set/get the name * gst_object_set_name() and gst_object_get_name() are used to set/get the name
@ -91,18 +93,17 @@
#define REFCOUNT_HACK #define REFCOUNT_HACK
#endif #endif
/* Refcount hack: since glib is not threadsafe, the glib refcounter can be /* Refcount hack: since glib < 2.8 is not threadsafe, the glib refcounter can be
* screwed up and the object can be freed unexpectedly. We use an evil hack * screwed up and the object can be freed unexpectedly. We use an evil hack
* to work around this problem. We set the glib refcount to a high value so * to work around this problem. We set the glib refcount to a high value so
* that glib will never unref the object under realistic circumstances. Then * that glib will never unref the object under realistic circumstances. Then
* we use our own atomic refcounting to do proper MT safe refcounting. * we use our own atomic refcounting to do proper MT safe refcounting.
* *
* The hack has several side-effect. At first you should use * The hack has several side-effect. At first you should use
* gst_object_ref/unref() whenever you can. Next when using g_value_set/get_object(); * gst_object_ref/unref() whenever you can. Next when using
* you need to manually fix the refcount. * g_value_set/get_object(); you need to manually fix the refcount.
* *
* A proper fix is of course to make the glib refcounting threadsafe which is * A proper fix is of course to upgrade to glib 2.8
* planned. Update: atomic refcounting is now in glib >= 2.7.3
*/ */
#ifdef REFCOUNT_HACK #ifdef REFCOUNT_HACK
#define PATCH_REFCOUNT(obj) ((GObject*)(obj))->ref_count = 100000; #define PATCH_REFCOUNT(obj) ((GObject*)(obj))->ref_count = 100000;

View file

@ -21,7 +21,8 @@
*/ */
/** /**
* SECTION:gstpad * SECTION:gstpad
* @short_description: Object contained by elements that allows links to other elements * @short_description: Object contained by elements that allows links to
* other elements
* @see_also: #GstPadTemplate, #GstElement, #GstEvent * @see_also: #GstPadTemplate, #GstElement, #GstEvent
* *
* A #GstElement is linked to other elements via "pads", which are extremely * A #GstElement is linked to other elements via "pads", which are extremely
@ -34,10 +35,9 @@
* Pads are typically created from a #GstPadTemplate with * Pads are typically created from a #GstPadTemplate with
* gst_pad_new_from_template(). * gst_pad_new_from_template().
* *
* Pads have #GstCaps attached to it to describe the media type they are capable * Pads have #GstCaps attached to it to describe the media type they are
* of dealing with. * capable of dealing with. gst_pad_get_caps() and gst_pad_try_set_caps() are
* gst_pad_get_caps() and gst_pad_try_set_caps() are used to manipulate the caps * used to manipulate the caps of the pads.
* of the pads.
* Pads created from a pad template cannot set capabilities that are * Pads created from a pad template cannot set capabilities that are
* incompatible with the pad template capabilities. * incompatible with the pad template capabilities.
* *

View file

@ -19,6 +19,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstpadtemplate * SECTION:gstpadtemplate
* @short_description: Describe the media type of a pad. * @short_description: Describe the media type of a pad.
@ -27,14 +28,14 @@
* Padtemplates describe the possible media types a pad or an elementfactory can * Padtemplates describe the possible media types a pad or an elementfactory can
* handle. * handle.
* *
* Pad and PadTemplates have #GstCaps attached to it to describe the media type they * Pad and PadTemplates have #GstCaps attached to it to describe the media type
* are capable of dealing with. gst_pad_template_get_caps() is used to get the * they are capable of dealing with. gst_pad_template_get_caps() is used to get
* caps of a padtemplate. It's not possible to modify the caps of a padtemplate after * the caps of a padtemplate. It's not possible to modify the caps of a
* creation. * padtemplate after creation.
* *
* Padtemplates can be created with gst_pad_template_new() or with the convenient * Padtemplates can be created with gst_pad_template_new() or with the
* GST_PAD_TEMPLATE_FACTORY() macro. A padtemplate can be used to create a pad or * convenient GST_PAD_TEMPLATE_FACTORY() macro. A padtemplate can be used to
* to add to an elementfactory. * create a pad or to add to an elementfactory.
* *
* The following code example shows the code to create a pad from a padtemplate. * The following code example shows the code to create a pad from a padtemplate.
* <example> * <example>
@ -44,7 +45,7 @@
* GST_STATIC_PAD_TEMPLATE ( * GST_STATIC_PAD_TEMPLATE (
* "sink", // the name of the pad * "sink", // the name of the pad
* GST_PAD_SINK, // the direction of the pad * GST_PAD_SINK, // the direction of the pad
* GST_PAD_ALWAYS, // when this pad will be present * GST_PAD_ALWAYS, // when this pad will be present
* GST_STATIC_CAPS ( // the capabilities of the padtemplate * GST_STATIC_CAPS ( // the capabilities of the padtemplate
* "audio/x-raw-int, " * "audio/x-raw-int, "
* "channels = (int) [ 1, 6 ]" * "channels = (int) [ 1, 6 ]"
@ -62,7 +63,8 @@
* </programlisting> * </programlisting>
* </example> * </example>
* *
* The following example shows you how to add the padtemplate to an elementfactory: * The following example shows you how to add the padtemplate to an
* elementfactory:
* <informalexample> * <informalexample>
* <programlisting> * <programlisting>
* gboolean * gboolean

View file

@ -20,6 +20,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstparse * SECTION:gstparse
* @short_description: Get a pipeline from a text pipeline description * @short_description: Get a pipeline from a text pipeline description

View file

@ -19,21 +19,24 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstpipeline * SECTION:gstpipeline
* @short_description: Top-level bin with clocking and bus management functionality. * @short_description: Top-level bin with clocking and bus management
functionality.
* @see_also: #GstBin * @see_also: #GstBin
* *
* In almost all cases, you'll want to use a GstPipeline when creating a filter * In almost all cases, you'll want to use a GstPipeline when creating a filter
* graph. The GstPipeline will manage the selection and distribution of a global * graph. The GstPipeline will manage the selection and distribution of a
* global
* clock as well as provide a GstBus to the application. * clock as well as provide a GstBus to the application.
* *
* The pipeline will also use the selected clock to calculate the stream time of * The pipeline will also use the selected clock to calculate the stream time
* the pipeline. * of the pipeline.
* *
* When sending a seek event to a GstPipeline, it will make sure that the * When sending a seek event to a GstPipeline, it will make sure that the
* pipeline is properly PAUSED and resumed as well as update the new stream time * pipeline is properly PAUSED and resumed as well as update the new stream
* after the seek. * time after the seek.
* *
* gst_pipeline_new() is used to create a pipeline. when you are done with * gst_pipeline_new() is used to create a pipeline. when you are done with
* the pipeline, use gst_object_unref() to free its resources including all * the pipeline, use gst_object_unref() to free its resources including all

View file

@ -19,29 +19,32 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstplugin * SECTION:gstplugin
* @short_description: Container for features loaded from a shared object module * @short_description: Container for features loaded from a shared object module
* @see_also: #GstPluginFeature, #GstElementFactory * @see_also: #GstPluginFeature, #GstElementFactory
* *
* GStreamer is extensible, so #GstElement instances can be loaded at runtime. * GStreamer is extensible, so #GstElement instances can be loaded at runtime.
* A plugin system can provide one or more of the basic <application>GStreamer</application> * A plugin system can provide one or more of the basic
* #GstPluginFeature subclasses. * <application>GStreamer</application> #GstPluginFeature subclasses.
* *
* A plugin should export a symbol <symbol>plugin_desc</symbol> that is a struct of type #GstPluginDesc. * A plugin should export a symbol <symbol>plugin_desc</symbol> that is a struct of type #GstPluginDesc.
* the plugin loader will check the version of the core library the plugin was linked against * the plugin loader will check the version of the core library the plugin was
* and will create a new #GstPlugin. It will then call the #GstPluginInitFunc function * linked against and will create a new #GstPlugin. It will then call the
* that was provided in the plugin_desc. * #GstPluginInitFunc function that was provided in the plugin_desc.
* *
* Once you have a handle to a #GstPlugin (e.g. from the #GstRegistryPool), you can * Once you have a handle to a #GstPlugin (e.g. from the #GstRegistryPool), you
* add any object that subclasses #GstPluginFeature. * can add any object that subclasses #GstPluginFeature.
* *
* Use gst_plugin_find_feature() and gst_plugin_get_feature_list() to find features in a plugin. * Use gst_plugin_find_feature() and gst_plugin_get_feature_list() to find
* features in a plugin.
* *
* Usually plugins are always automaticlly loaded so you don't need to call gst_plugin_load() explicitly * Usually plugins are always automaticlly loaded so you don't need to call
* to bring it into memory. There are options to statically link plugins to an app or even * gst_plugin_load() explicitly to bring it into memory. There are options to
* use GStreamer without a plugin repository in which case gst_plugin_load() can be needed * statically link plugins to an app or even use GStreamer without a plugin
* to bring the plugin into memory. * repository in which case gst_plugin_load() can be needed to bring the plugin
* into memory.
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

View file

@ -19,6 +19,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstpluginfeature * SECTION:gstpluginfeature
* @short_description: Base class for contents of a GstPlugin * @short_description: Base class for contents of a GstPlugin

View file

@ -20,6 +20,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstquery * SECTION:gstquery
* @short_description: Dynamically register new query types and parse results * @short_description: Dynamically register new query types and parse results

View file

@ -21,6 +21,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstqueue * SECTION:gstqueue
* @short_description: Simple asynchronous data queue. * @short_description: Simple asynchronous data queue.
@ -36,7 +37,6 @@
* The queue blocks by default. * The queue blocks by default.
*/ */
#include "gst_private.h" #include "gst_private.h"
#include "gstqueue.h" #include "gstqueue.h"

View file

@ -20,6 +20,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstregistry * SECTION:gstregistry
* @short_description: Abstract base class for management of #GstPlugin objects * @short_description: Abstract base class for management of #GstPlugin objects

View file

@ -18,6 +18,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gststructure * SECTION:gststructure
* @short_description: Generic structure containing fields of names and values * @short_description: Generic structure containing fields of names and values

View file

@ -19,6 +19,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstsystemclock * SECTION:gstsystemclock
* @short_description: Default clock that uses the current system time * @short_description: Default clock that uses the current system time

View file

@ -18,6 +18,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gsttaglist * SECTION:gsttaglist
* @short_description: List of tags and values used to describe media metadata * @short_description: List of tags and values used to describe media metadata

View file

@ -18,9 +18,11 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gsttagsetter * SECTION:gsttagsetter
* @short_description: Element interface that allows setting and retrieval of media metadata * @short_description: Element interface that allows setting and retrieval
* of media metadata
* *
*/ */

View file

@ -19,13 +19,13 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gsttrace * SECTION:gsttrace
* @short_description: Tracing functionality * @short_description: Tracing functionality
* *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include "config.h" #include "config.h"
#endif #endif

View file

@ -18,6 +18,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gsttypefind * SECTION:gsttypefind
* @short_description: Stream type detection * @short_description: Stream type detection

View file

@ -18,6 +18,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gsttypefindfactory * SECTION:gsttypefindfactory
* @short_description: Information about registered typefind functions * @short_description: Information about registered typefind functions
@ -73,8 +74,9 @@
* </programlisting> * </programlisting>
* </example> * </example>
* *
* The above example shows how to write a very simple typefinder that identifies * The above example shows how to write a very simple typefinder that
* the given data. You can get quite a bit more complicated than that though. * identifies the given data. You can get quite a bit more complicated than
* that though.
*/ */
#include "gst_private.h" #include "gst_private.h"

View file

@ -19,13 +19,14 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gsturihandler * SECTION:gsturihandler
* @short_description: Plugin feature that handles URI types * @short_description: Plugin feature that handles URI types
* @see_also: #GstPluginFeature, #GstUri * @see_also: #GstPluginFeature, #GstUri
* *
* The URIHandler is a pluginfeature that can be used to locate elements and the * The URIHandler is a pluginfeature that can be used to locate elements and
* element property that can handle a given URI. * the element property that can handle a given URI.
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

View file

@ -19,6 +19,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gsturitype * SECTION:gsturitype
* @short_description: Describes URI types * @short_description: Describes URI types

View file

@ -19,6 +19,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstutils * SECTION:gstutils
* @short_description: Various utility functions * @short_description: Various utility functions

View file

@ -19,6 +19,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstxml * SECTION:gstxml
* @short_description: XML save/restore operations of pipelines * @short_description: XML save/restore operations of pipelines

View file

@ -21,6 +21,7 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * Boston, MA 02111-1307, USA.
*/ */
/** /**
* SECTION:gstqueue * SECTION:gstqueue
* @short_description: Simple asynchronous data queue. * @short_description: Simple asynchronous data queue.
@ -36,7 +37,6 @@
* The queue blocks by default. * The queue blocks by default.
*/ */
#include "gst_private.h" #include "gst_private.h"
#include "gstqueue.h" #include "gstqueue.h"