mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-15 12:34:15 +00:00
Code Issues 1 Projects Releases Wiki Activity

more docs and two more inlined

Browse source 
Original commit message from CVS:
* docs/gst/tmpl/.cvsignore:
* docs/gst/tmpl/gstformat.sgml:
* docs/gst/tmpl/gstversion.sgml:
* gst/gstbus.h:
* gst/gstformat.c:
* gst/gstformat.h:
* gst/gstversion.h.in:
more docs and two more inlined
This commit is contained in:
Stefan Kost 2005-08-30 17:23:19 +00:00
parent da88afccc5
commit a44593349c
8 changed files with 83 additions and 160 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
ChangeLog
View file

@ -1,3 +1,14 @@
2005-08-30 Stefan Kost <ensonic@users.sf.net>
* docs/gst/tmpl/.cvsignore:
* docs/gst/tmpl/gstformat.sgml:
* docs/gst/tmpl/gstversion.sgml:
* gst/gstbus.h:
* gst/gstformat.c:
* gst/gstformat.h:
* gst/gstversion.h.in:
more docs and two more inlined
2005-08-30 Wim Taymans <wim@fluendo.com>
* gst/elements/gstfilesink.c: (gst_file_sink_class_init):

3
docs/gst/tmpl/.gitignore vendored
View file

@ -19,10 +19,13 @@ gstfakesrc.sgml
gstfakesink.sgml
gstfilesrc.sgml
gstfilesink.sgml
gstformat.sgml
gstmessage.sgml
gstminiobject.sgml
gstprobe.sgml
gstpushsrc.sgml
gstquery.sgml
gsttask.sgml
gstversion.sgml
gstxmlregistry.sgml

102
docs/gst/tmpl/gstformat.sgml
View file

@ -1,102 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstFormat
<!-- ##### SECTION Short_Description ##### -->
Dynamically register new formats
<!-- ##### SECTION Long_Description ##### -->
<para>
GstFormats functions are used to register a new format to the gstreamer core.
formats can be used to perform seeking or conversions/query operations.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstPad, #GstElement
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM GstFormat ##### -->
<para>
Standard predefined formats
</para>
@GST_FORMAT_UNDEFINED: undefined format
@GST_FORMAT_DEFAULT: the default format of the pad/element
@GST_FORMAT_BYTES: bytes
@GST_FORMAT_TIME: time in nanoseconds
@GST_FORMAT_BUFFERS: buffers
@GST_FORMAT_PERCENT: percentage of stream
<!-- ##### MACRO GST_FORMAT_PERCENT_MAX ##### -->
<para>
The PERCENT format is between 0 and this value
</para>
<!-- ##### MACRO GST_FORMAT_PERCENT_SCALE ##### -->
<para>
The value used to scale down the reported PERCENT format value to
its real value.
</para>
<!-- ##### STRUCT GstFormatDefinition ##### -->
<para>
A format definition
</para>
@value: The unique id of this format
@nick: A short nick of the format
@description: A longer description of the format
<!-- ##### FUNCTION gst_format_register ##### -->
<para>
</para>
@nick:
@description:
@Returns:
<!-- ##### FUNCTION gst_format_get_by_nick ##### -->
<para>
</para>
@nick:
@Returns:
<!-- ##### FUNCTION gst_formats_contains ##### -->
<para>
</para>
@formats:
@format:
@Returns:
<!-- ##### FUNCTION gst_format_get_details ##### -->
<para>
</para>
@format:
@Returns:
<!-- ##### FUNCTION gst_format_iterate_definitions ##### -->
<para>
</para>
@Returns:

51
docs/gst/tmpl/gstversion.sgml
View file

@ -1,51 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstVersion
<!-- ##### SECTION Short_Description ##### -->
GStreamer version macros.
<!-- ##### SECTION Long_Description ##### -->
<para>
Use these macros e.g. when defining own plugins.
The version macros get defined by including "gst/gst.h".
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO GST_VERSION_MAJOR ##### -->
<para>
The major version of GStreamer at compile time
</para>
<!-- ##### MACRO GST_VERSION_MINOR ##### -->
<para>
The minor version of GStreamer at compile time
</para>
<!-- ##### MACRO GST_VERSION_MICRO ##### -->
<para>
The micro version of GStreamer at compile time
</para>
<!-- ##### FUNCTION gst_version ##### -->
<para>
</para>
@major:
@minor:
@micro:

3
gst/gstbus.h
View file

@ -71,7 +71,8 @@ typedef GstBusSyncReply (*GstBusSyncHandler) (GstBus * bus, GstMessage * messag
* @data: user data that has been given, when registering the handler
*
* Handler will be invoked asynchronously, after a new message has been injected
* into the bus.
* into the bus. Return %TRUE if the message has been handled. It will then be
* taken from the bus and _unref()'ed.
*
* Returns: %TRUE if message should be taken from the bus
*/

8
gst/gstformat.c
View file

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

30
gst/gstformat.h
View file

@ -31,6 +31,17 @@
G_BEGIN_DECLS
/**
* GstFormat:
* @GST_FORMAT_UNDEFINED: undefined format
* @GST_FORMAT_DEFAULT: the default format of the pad/element
* @GST_FORMAT_BYTES: bytes
* @GST_FORMAT_TIME: time in nanoseconds
* @GST_FORMAT_BUFFERS: buffers
* @GST_FORMAT_PERCENT: percentage of stream
*
* Standard predefined formats
*/
typedef enum {
GST_FORMAT_UNDEFINED = 0, /* must be first in list */
GST_FORMAT_DEFAULT = 1, /* samples for audio, frames/fields for video */
@ -41,11 +52,30 @@ typedef enum {
} GstFormat;
/* a percentage is always relative to 1000000 */
/**
* GST_FORMAT_PERCENT_MAX:
*
* The PERCENT format is between 0 and this value
*/
#define GST_FORMAT_PERCENT_MAX G_GINT64_CONSTANT (1000000)
/**
* GST_FORMAT_PERCENT_SCALE:
*
* The value used to scale down the reported PERCENT format value to
* its real value.
*/
#define GST_FORMAT_PERCENT_SCALE G_GINT64_CONSTANT (10000)
typedef struct _GstFormatDefinition GstFormatDefinition;
/**
* GstFormatDefinition:
* @value: The unique id of this format
* @nick: A short nick of the format
* @description: A longer description of the format
*
* A format definition
*/
struct _GstFormatDefinition
{
GstFormat value;

35
gst/gstversion.h.in
View file

@ -19,21 +19,44 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:gstversion
* @short_description: GStreamer version macros.
*
* Use the GST_VERSION_* macros e.g. when defining own plugins. The GStreamer
* runtime checks if these plugin and core version match and refuses to use a
* plugin compiled against a different version of GStreamer.
* You can also use the macros to keep the GStreamer version information in your
* application.
*
* Use the gst_version() function if you want to know which version of
* GStreamer you are currently linked against.
*
* The version macros get defined by including "gst/gst.h".
*/
#ifndef __GST_VERSION_H__
#define __GST_VERSION_H__
G_BEGIN_DECLS
/*
* Use these only when you want to know what GStreamer version your stuff was
* compiled against.
* Use the #gst_version function if you want to know which version of
* GStreamer you are currently linked against.
/**
* GST_VERSION_MAJOR:
*
* The major version of GStreamer at compile time:
*/
#define GST_VERSION_MAJOR (@GST_VERSION_MAJOR@)
/**
* GST_VERSION_MINOR:
*
* The minor version of GStreamer at compile time:
*/
#define GST_VERSION_MINOR (@GST_VERSION_MINOR@)
/**
* GST_VERSION_MICRO:
*
* The micro version of GStreamer at compile time:
*/
#define GST_VERSION_MICRO (@GST_VERSION_MICRO@)
void gst_version (guint *major, guint *minor, guint *micro);