mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-25 09:40:37 +00:00
Code Issues 1 Projects Releases Wiki Activity

start pulling in base classes and elements for docs

Browse source 
Original commit message from CVS:
start pulling in base classes and elements for docs
This commit is contained in:
Thomas Vander Stichele 2005-06-24 18:16:14 +00:00
parent acb843cb22
commit 87d6d3143b
20 changed files with 538 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
ChangeLog
View file

@ -1,3 +1,24 @@
2005-06-24 Thomas Vander Stichele <thomas at apestaart dot org>
* docs/gst/Makefile.am:
* docs/gst/gstreamer-docs.sgml:
* docs/gst/gstreamer-sections.txt:
* docs/gst/gstreamer.types:
* docs/gst/tmpl/gstbasesink.sgml:
* docs/gst/tmpl/gstbasesrc.sgml:
* docs/gst/tmpl/gstbin.sgml:
* docs/gst/tmpl/gstcompat.sgml:
* docs/gst/tmpl/gstfakesink.sgml:
* docs/gst/tmpl/gstfakesrc.sgml:
* docs/gst/tmpl/gstfilesink.sgml:
* docs/gst/tmpl/gstfilesrc.sgml:
* docs/gst/tmpl/gstindex.sgml:
* docs/manual/appendix-quotes.xml:
* gst/base/gstbasesrc.h:
* gst/elements/gstfakesrc.h:
* gst/gstmessage.h:
start pulling in base classes and elements in our docs
2005-06-24 Stefan Kost <ensonic@users.sf.net>
* docs/gst/Makefile.am:

7
docs/gst/Makefile.am
View file

@ -57,6 +57,9 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
#SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \
# $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la
SCANOBJ_DEPS = \
$(top_builddir)/gst/elements/libgstelements.la \
$(top_builddir)/gst/base/libgstbase-@GST_MAJORMINOR@.la
# Header files to ignore when scanning. Use base file name, no paths
IGNORE_HFILES= \
@ -75,12 +78,8 @@ IGNORE_HFILES= \
gstmarshal.h \
gstaggregator.h \
gstbufferstore.h \
gstfakesink.h \
gstfakesrc.h \
gstfdsink.h \
gstfdsrc.h \
gstfilesink.h \
gstfilesrc.h \
gstidentity.h \
gstmd5sink.h \
gstmultifilesrc.h \

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

@ -55,12 +55,15 @@
<!ENTITY GstVersion SYSTEM "xml/gstversion.xml">
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
<!--
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
<!ENTITY GstBaseSrc SYSTEM "xml/gstbasesrc.xml">
<!ENTITY GstBaseSink SYSTEM "xml/gstbasesink.xml">
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
<!ENTITY GstFakeSink SYSTEM "xml/gstfakesink.xml">
<!ENTITY GstFileSrc SYSTEM "xml/gstfilesrc.xml">
<!ENTITY GstDiskSink SYSTEM "xml/gstdisksink.xml">
<!ENTITY GstFileSink SYSTEM "xml/gstfilesink.xml">
<!--
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
<!ENTITY GstFdSrc SYSTEM "xml/gstfdsrc.xml">
<!ENTITY GstFdSink SYSTEM "xml/gstfdsink.xml">
<!ENTITY GstIdentity SYSTEM "xml/gstidentity.xml">
@ -154,32 +157,31 @@
<chapter id="gstreamer-compat">
<title>GStreamer Core Compatibility</title>
<para>
Theses elements are defined for compatibillity with older code.
The must not be use in new code!
These elements are defined for compatibility with older code.
They must not be used in new code!
</para>
&GstCompat;
</chapter>
<!--
FIXME: why is this commented out (reason #1: no public API)
<chapter id="element-types">
<title>GStreamer Standard Elements</title>
<title>GStreamer Core Elements</title>
<para>
libgstelements.la provide some basic elements like a disk source
libgstelements.so provide some basic elements like a file source
and sink. The use of these elements is strictly though the g_object_get() and
g_object_set() functions and the GStreamer Core Library functions.
</para>
&GstAggregator;
&GstFakeSrc;
&GstFakeSink;
&GstFileSrc;
&GstDiskSink;
&GstFileSink;
<!--
&GstAggregator;
&GstFdSrc;
&GstFdSink;
@ -191,8 +193,19 @@
&GstMD5Sink;
&GstTee;
</chapter>
-->
</chapter>
<chapter id="gstreamer-base">
<title>GStreamer Base Classes</title>
<para>
These base classes are provided to be extended by elements.
</para>
&GstBaseSrc;
&GstBaseSink;
</chapter>
<chapter id="gstreamer-hierarchy">

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

@ -1852,3 +1852,102 @@ gst_xml_get_type
<TITLE>GstEnumTypes</TITLE>
</SECTION>
<SECTION>
<FILE>gstfakesrc</FILE>
<TITLE>GstFakeSrc</TITLE>
GstFakeSrc
<SUBSECTION Standard>
GstFakeSrcClass
GST_FAKESRC
GST_IS_FAKESRC
GST_TYPE_FAKESRC
GST_FAKESRC_CLASS
GST_IS_FAKESRC_CLASS
GST_FAKESRC_GET_CLASS
<SUBSECTION Private>
gst_fakesrc_get_type
</SECTION>
<SECTION>
<FILE>gstfakesink</FILE>
<TITLE>GstFakeSink</TITLE>
GstFakeSink
<SUBSECTION Standard>
GstFakeSinkClass
GST_FAKESINK
GST_IS_FAKESINK
GST_TYPE_FAKESINK
GST_FAKESINK_CLASS
GST_IS_FAKESINK_CLASS
GST_FAKESINK_GET_CLASS
<SUBSECTION Private>
gst_fakesink_get_type
</SECTION>
<SECTION>
<FILE>gstbasesrc</FILE>
<TITLE>GstBaseSrc</TITLE>
GstBaseSrc
<SUBSECTION Standard>
GstBaseSrcClass
GST_BASESRC
GST_IS_BASESRC
GST_TYPE_BASESRC
GST_BASESRC_CLASS
GST_IS_BASESRC_CLASS
GST_BASESRC_GET_CLASS
<SUBSECTION Private>
gst_basesrc_get_type
</SECTION>
<SECTION>
<FILE>gstfilesrc</FILE>
<TITLE>GstFileSrc</TITLE>
GstFileSrc
<SUBSECTION Standard>
GstFileSrcClass
GST_FILESRC
GST_IS_FILESRC
GST_TYPE_FILESRC
GST_FILESRC_CLASS
GST_IS_FILESRC_CLASS
GST_FILESRC_GET_CLASS
<SUBSECTION Private>
gst_filesrc_get_type
</SECTION>
<SECTION>
<FILE>gstfilesink</FILE>
<TITLE>GstFileSink</TITLE>
GstFileSink
<SUBSECTION Standard>
GstFileSinkClass
GST_FILESINK
GST_IS_FILESINK
GST_TYPE_FILESINK
GST_FILESINK_CLASS
GST_IS_FILESINK_CLASS
GST_FILESINK_GET_CLASS
<SUBSECTION Private>
gst_filesink_get_type
</SECTION>
<SECTION>
<FILE>gstbasesink</FILE>
<TITLE>GstBaseSink</TITLE>
GstBaseSink
<SUBSECTION Standard>
GstBaseSinkClass
GST_BASESINK
GST_IS_BASESINK
GST_TYPE_BASESINK
GST_BASESINK_CLASS
GST_IS_BASESINK_CLASS
GST_BASESINK_GET_CLASS
<SUBSECTION Private>
gst_basesink_get_type
</SECTION>

27
docs/gst/gstreamer.types
View file

@ -1,3 +1,11 @@
% add a _get_type for every GObject whose properties and signals you want
% documented
% add the relevant includes to be able to call those _get_type functions
% adding a get_type here will:
% - change output file name from gstreamer-(whatever).html to (whatever).html
% - document properties and signals
#include <gst/gst.h>
#include <gst/gstqueue.h>
@ -21,3 +29,22 @@ gst_tag_setter_get_type
gst_type_find_factory_get_type
gst_xml_get_type
% base classes
#include <gst/base/gstbasesrc.h>
#include <gst/base/gstbasesink.h>
gst_basesrc_get_type
gst_basesink_get_type
% elements
#include <gst/elements/gstfakesrc.h>
#include <gst/elements/gstfakesink.h>
#include <gst/elements/gstfilesrc.h>
#include <gst/elements/gstfilesink.h>
gst_fakesrc_get_type
gst_fakesink_get_type
gst_filesrc_get_type
gst_filesink_get_type

37
docs/gst/tmpl/gstbasesink.sgml Normal file
View file

@ -0,0 +1,37 @@
<!-- ##### SECTION Title ##### -->
GstBaseSink
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstBaseSink ##### -->
<para>
</para>
<!-- ##### ARG GstBaseSink:has-chain ##### -->
<para>
</para>
<!-- ##### ARG GstBaseSink:has-loop ##### -->
<para>
</para>
<!-- ##### ARG GstBaseSink:preroll-queue-len ##### -->
<para>
</para>

37
docs/gst/tmpl/gstbasesrc.sgml Normal file
View file

@ -0,0 +1,37 @@
<!-- ##### SECTION Title ##### -->
GstBaseSrc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstBaseSrc ##### -->
<para>
</para>
<!-- ##### ARG GstBaseSrc:blocksize ##### -->
<para>
</para>
<!-- ##### ARG GstBaseSrc:has-getrange ##### -->
<para>
</para>
<!-- ##### ARG GstBaseSrc:has-loop ##### -->
<para>
</para>

8
docs/gst/tmpl/gstbin.sgml
View file

@ -66,19 +66,19 @@ clock providers in the bin.
<!-- ##### SIGNAL GstBin::element-added ##### -->
<para>
Will be emmited if a new element was removed/added to this bin.
Will be emitted if a new element was removed/added to this bin.
</para>
@gstbin: the object which received the signal.
@arg1: the element that was added to the bin
@arg1: the element that was added to the bin.
<!-- ##### SIGNAL GstBin::element-removed ##### -->
<para>
Will be emmited if an element was removed from this bin.
Will be emitted if an element was removed from this bin.
</para>
@gstbin: the object which received the signal.
@arg1: the element that was removed from the bin
@arg1: the element that was removed from the bin.
<!-- ##### ENUM GstBinFlags ##### -->
<para>

5
docs/gst/tmpl/gstcompat.sgml
View file

@ -6,8 +6,9 @@ Deprecated API entries.
<!-- ##### SECTION Long_Description ##### -->
<para>
Please do not use in new code. This symbols are hidden by the GST_DISABLE_DEPRECATED define.
One would have to add this to the CFLAGS when compiling old code.
Please do not use these in new code.
These symbols are only available by defining GST_DISABLE_DEPRECATED.
This can be done in CFLAGS for compiling old code.
</para>
<!-- ##### SECTION See_Also ##### -->

61
docs/gst/tmpl/gstfakesink.sgml Normal file
View file

@ -0,0 +1,61 @@
<!-- ##### SECTION Title ##### -->
GstFakeSink
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstFakeSink ##### -->
<para>
</para>
<!-- ##### SIGNAL GstFakeSink::handoff ##### -->
<para>
</para>
@gstfakesink: the object which received the signal.
@arg1:
@arg2:
<!-- ##### ARG GstFakeSink:dump ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSink:last-message ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSink:signal-handoffs ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSink:silent ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSink:state-error ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSink:sync ##### -->
<para>
</para>

120
docs/gst/tmpl/gstfakesrc.sgml Normal file
View file

@ -0,0 +1,120 @@
<!-- ##### SECTION Title ##### -->
GstFakeSrc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstFakeSrc ##### -->
<para>
</para>
<!-- ##### SIGNAL GstFakeSrc::handoff ##### -->
<para>
</para>
@gstfakesrc: the object which received the signal.
@arg1:
<!-- ##### ARG GstFakeSrc:data ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:datarate ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:dump ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:eos ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:filltype ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:has-getrange ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:has-loop ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:last-message ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:num-buffers ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:output ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:parentsize ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:pattern ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:signal-handoffs ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:silent ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:sizemax ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:sizemin ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:sizetype ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:sync ##### -->
<para>
</para>

27
docs/gst/tmpl/gstfilesink.sgml Normal file
View file

@ -0,0 +1,27 @@
<!-- ##### SECTION Title ##### -->
GstFileSink
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstFileSink ##### -->
<para>
</para>
<!-- ##### ARG GstFileSink:location ##### -->
<para>
</para>

42
docs/gst/tmpl/gstfilesrc.sgml Normal file
View file

@ -0,0 +1,42 @@
<!-- ##### SECTION Title ##### -->
GstFileSrc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstFileSrc ##### -->
<para>
</para>
<!-- ##### ARG GstFileSrc:fd ##### -->
<para>
</para>
<!-- ##### ARG GstFileSrc:location ##### -->
<para>
</para>
<!-- ##### ARG GstFileSrc:mmapsize ##### -->
<para>
</para>
<!-- ##### ARG GstFileSrc:touch ##### -->
<para>
</para>

2
docs/gst/tmpl/gstindex.sgml
View file

@ -23,7 +23,7 @@ in a pipeline.
<!-- ##### SIGNAL GstIndex::entry-added ##### -->
<para>
Is emited when a new entry is added to the index.
Is emitted when a new entry is added to the index.
</para>
@gstindex: the object which received the signal.

23
docs/manual/appendix-quotes.xml
View file

@ -32,10 +32,31 @@
<para>--- You are now known as thomasvs</para>
<para><emphasis>&lt;Illbe&gt;</emphasis> back</para>
<para>--- Illbe is now known as bilboed</para>
</listitem>
</varlistentry>
<varlistentry>
<term>20 Apr 2005</term>
<listitem>
<para>
<emphasis>thomas</emphasis>:
jrb, somehow his screenshotsrc grabs whatever X is showing and makes it
available as a stream of frames
</para>
<para>
<emphasis>jrb</emphasis>:
thomas: so, is the point that the screenshooter takes a video?
but won't the dialog be in the video? oh, nevermind. I'll just send mail...
</para>
<para>
<emphasis>thomas</emphasis>:
jrb, well, it would shoot first and ask questions later
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>14 Oct 2004</term>
<listitem>

1
gst/base/gstbasesrc.h
View file

@ -98,6 +98,7 @@ struct _GstBaseSrc {
struct _GstBaseSrcClass {
GstElementClass parent_class;
/*< public >*/
/* get caps from subclass */
GstCaps* (*get_caps) (GstBaseSrc *src);
/* notify the subclass of new caps */

2
gst/elements/gstfakesrc.h
View file

@ -76,6 +76,7 @@ typedef struct _GstFakeSrcClass GstFakeSrcClass;
struct _GstFakeSrc {
GstBaseSrc element;
/*< private >*/
gboolean has_loop;
gboolean has_getrange;
gboolean eos;
@ -114,6 +115,7 @@ struct _GstFakeSrc {
struct _GstFakeSrcClass {
GstBaseSrcClass parent_class;
/*< public >*/
/* signals */
void (*handoff) (GstElement *element, GstBuffer *buf, GstPad *pad);
};

2
gst/gstmessage.h
View file

@ -43,7 +43,7 @@ G_BEGIN_DECLS
* @GST_MESSAGE_STEP_DONE: a framestep finished.
* @GST_MESSAGE_NEW_CLOCK: a new clock was selected in the pipeline
* @GST_MESSAGE_STRUCTURE_CHANGE: the structure of the pipeline changed.
* @GST_MESSAGE_STREAM_STATUS: status about a stream, emited when it starts,
* @GST_MESSAGE_STREAM_STATUS: status about a stream, emitted when it starts,
* stops, errors, etc..
* @GST_MESSAGE_APPLICATION: message posted by the application, possibly
* via an application-specific element.

1
libs/gst/base/gstbasesrc.h
View file

@ -98,6 +98,7 @@ struct _GstBaseSrc {
struct _GstBaseSrcClass {
GstElementClass parent_class;
/*< public >*/
/* get caps from subclass */
GstCaps* (*get_caps) (GstBaseSrc *src);
/* notify the subclass of new caps */

2
plugins/elements/gstfakesrc.h
View file

@ -76,6 +76,7 @@ typedef struct _GstFakeSrcClass GstFakeSrcClass;
struct _GstFakeSrc {
GstBaseSrc element;
/*< private >*/
gboolean has_loop;
gboolean has_getrange;
gboolean eos;
@ -114,6 +115,7 @@ struct _GstFakeSrc {
struct _GstFakeSrcClass {
GstBaseSrcClass parent_class;
/*< public >*/
/* signals */
void (*handoff) (GstElement *element, GstBuffer *buf, GstPad *pad);
};