Menu
▾
▴
[gst-cvs] thomasvs gst-plugins-ugly: gst-plugins-ugly/ gst-plugins-ugly/docs/plugins/ gst-plugins-ugly/ext/dvdnav/ gst-plugins-ugly/ext/dvdread/ gst-plugins-ugly/gst/mpegaudioparse/
CVS Root: /cvs/gstreamer
Module: gst-plugins-ugly
Changes by: thomasvs
Date: Wed Aug 31 2005 11:33:20 PDT
Log message:
add plugin documentation
Modified files:
. : ChangeLog Makefile.am configure.ac
ext/dvdnav : dvdnavsrc.c
ext/dvdread : dvdreadsrc.c
gst/mpegaudioparse: gstmpegaudioparse.c
Added files:
docs/plugins : Makefile.am gst-plugins-ugly-plugins-docs.sgml
gst-plugins-ugly-plugins-sections.txt
gst-plugins-ugly-plugins.types
Links:
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-ugly/ChangeLog.diff?r1=1.1824&r2=1.1825
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-ugly/Makefile.am.diff?r1=1.65&r2=1.66
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-ugly/configure.ac.diff?r1=1.585&r2=1.586
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-ugly/docs/plugins/Makefile.am?rev=1.1&content-type=text/vnd.viewcvs-markup
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-ugly/docs/plugins/gst-plugins-ugly-plugins-docs.sgml?rev=1.1&content-type=text/vnd.viewcvs-markup
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-ugly/docs/plugins/gst-plugins-ugly-plugins-sections.txt?rev=1.1&content-type=text/vnd.viewcvs-markup
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-ugly/docs/plugins/gst-plugins-ugly-plugins.types?rev=1.1&content-type=text/vnd.viewcvs-markup
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-ugly/ext/dvdnav/dvdnavsrc.c.diff?r1=1.40&r2=1.41
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-ugly/ext/dvdread/dvdreadsrc.c.diff?r1=1.23&r2=1.24
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-ugly/gst/mpegaudioparse/gstmpegaudioparse.c.diff?r1=1.45&r2=1.46
====Begin Diffs====
--- NEW FILE: Makefile.am ---
GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
## Process this file with automake to produce Makefile.in
# The name of the module, e.g. 'glib'.
#DOC_MODULE=gst-plugins-libs-@GST_MAJORMINOR@
MODULE=gst-plugins-ugly
DOC_MODULE=$(MODULE)-plugins
# for upload.mak
DOC=$(MODULE)-plugins
FORMATS=html
html: html-build.stamp
include $(top_srcdir)/common/upload-doc.mak
# generated basefiles
#basefiles = \
## $(DOC_MODULE).types \
# $(DOC_MODULE)-sections.txt \
# $(DOC_MODULE)-docs.sgml
# ugly hack to make -unused.sgml work
#unused-build.stamp:
# BUILDDIR=`pwd` && \
# cd $(srcdir)/tmpl && \
# ln -sf gstreamer-libs-unused.sgml \
# $$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml
# touch unused-build.stamp
# these rules are added to create parallel docs using GST_MAJORMINOR
#$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
# cp $< $@
#CLEANFILES = $(basefiles)
# The top-level SGML file. Change it if you want.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The directory containing the source code. Relative to $(top_srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
DOC_SOURCE_DIR = $(top_srcdir)
# Extra options to supply to gtkdoc-scan.
SCAN_OPTIONS=
# FIXME :
# there's something wrong with gstreamer-sections.txt not being in the dist
# maybe it doesn't resolve; we're adding it below for now
#EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
# Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=--sgml-mode
# Extra options to supply to gtkdoc-fixref.
# FIXME get the location of the installed gstreamer docs
#FIXXREF_OPTIONS=--extra-dir=../gst/html
# Used for dependencies.
HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.h
CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c
# this is a wingo addition
# thomasvs: another nice wingo addition would be an explanation on why
# this is useful ;)
SCANOBJ_DEPS =
# Header files to ignore when scanning.
IGNORE_HFILES =
IGNORE_CFILES =
# we add all .h files of elements that have signals/args we want
# sadly this also pulls in the private methods - maybe we should
# move those around in the source ?
# also, we should add some stuff here conditionally based on whether
# or not the plugin will actually build
# but I'm not sure about that - it might be this Just Works given that
# the registry won't have the element
# FIXME: not ported yet
# $(top_srcdir)/ext/gnomevfs/gstgnomevfssink.c
EXTRA_HFILES = \
$(top_srcdir)/ext/mad/gstmad.h
# Images to copy into HTML directory.
HTML_IMAGES =
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
content_files =
# Other files to distribute.
extra_files =
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
# contains GtkObjects/GObjects and you want to document signals and properties.
GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir)
GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS)
GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
# If you need to override some of the declarations, place them in this file
# and uncomment this line.
#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
DOC_OVERRIDES =
include $(top_srcdir)/common/gtk-doc-plugins.mak
--- NEW FILE: gst-plugins-ugly-plugins-docs.sgml ---
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>GStreamer Ugly Plugins &GST_MAJORMINOR; Plugins Reference Manual</title>
</bookinfo>
<chapter>
<title>gst-plugins-ugly Elements</title>
</chapter>
<title>gst-plugins-ugly Plugins</title>
<xi:include href="xml/plugin-dvdlpcmdec.xml" />
<xi:include href="xml/plugin-gstcoreelements.xml" />
<xi:include href="xml/plugin-lame.xml" />
<xi:include href="xml/plugin-mad.xml" />
<xi:include href="xml/plugin-mpegaudioparse.xml" />
<xi:include href="xml/plugin-rmdemux.xml" />
</book>
--- NEW FILE: gst-plugins-ugly-plugins-sections.txt ---
<SECTION>
<FILE>element-mad</FILE>
GstMad
<TITLE>mad</TITLE>
<SUBSECTION Standard>
GstMadClass
</SECTION>
--- NEW FILE: gst-plugins-ugly-plugins.types ---
#include <gst/gst.h>
Index: dvdnavsrc.c
===================================================================
RCS file: /cvs/gstreamer/gst-plugins-ugly/ext/dvdnav/dvdnavsrc.c,v
retrieving revision 1.40
retrieving revision 1.41
diff -u -d -r1.40 -r1.41
--- dvdnavsrc.c 5 Jul 2005 10:51:30 -0000 1.40
+++ dvdnavsrc.c 31 Aug 2005 18:33:08 -0000 1.41
@@ -674,7 +674,7 @@
g_return_val_if_fail (src->title > 0, FALSE);
GST_INFO_OBJECT (src, "seeking to %d/%d/%d", title, chapter, angle);
- /**
+ /*
* Make sure our title number is valid.
*/
if (dvdnav_get_number_of_titles (src->dvdnav, &titles) != DVDNAV_STATUS_OK) {
@@ -689,7 +689,7 @@
return FALSE;
}
* Before we can get the number of chapters (programs) we need to call
* dvdnav_title_play so that dvdnav_get_number_of_programs knows which title
* to operate on (also needed to get the number of angles)
@@ -701,7 +701,7 @@
* Make sure the chapter number is valid for this title.
if (dvdnav_get_number_of_titles (src->dvdnav, &programs)
@@ -717,7 +717,7 @@
* Make sure the angle number is valid for this title.
if (dvdnav_get_angle_info (src->dvdnav, &curangle, &angles)
@@ -733,7 +733,7 @@
* We've got enough info, time to open the title set data.
if (src->chapter == 0) {
@@ -800,7 +800,7 @@
g_object_notify (G_OBJECT (src), "streaminfo");
}
-/**
+/*
* Check for a new DVD domain area, and update the structure if
* necessary.
*/
@@ -825,7 +825,7 @@
src->domain = domain;
* Check for a new highlighted area, and send an spu highlight event if
Index: dvdreadsrc.c
RCS file: /cvs/gstreamer/gst-plugins-ugly/ext/dvdread/dvdreadsrc.c,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -d -r1.23 -r1.24
--- dvdreadsrc.c 5 Jul 2005 10:51:30 -0000 1.23
+++ dvdreadsrc.c 31 Aug 2005 18:33:08 -0000 1.24
@@ -544,7 +544,7 @@
return res;
* Returns true if the pack is a NAV pack. This check is clearly insufficient,
* and sometimes we incorrectly think that valid other packs are NAV packs. I
* need to make this stronger.
@@ -579,7 +579,7 @@
g_return_val_if_fail (priv != NULL, -1);
g_return_val_if_fail (location != NULL, -1);
* Open the disc.
priv->dvd = DVDOpen (location);
@@ -589,7 +589,7 @@
* Load the video manager to find out the information about the titles on
* this disc.
@@ -608,9 +608,9 @@
{
GHashTable *languagelist = NULL;
- /**
- * Make sure our title number is valid.
- */
+ * Make sure our title number is valid.
+ */
GST_LOG ("There are %d titles on this DVD", priv->tt_srpt->nr_of_srpts);
if (title < 0 || title >= priv->tt_srpt->nr_of_srpts) {
GST_WARNING ("Invalid title %d (only %d available)",
@@ -625,9 +625,9 @@
GST_LOG ("There are %d chapters in this title",
priv->tt_srpt->title[title].nr_of_ptts);
- * Make sure the angle number is valid for this title.
+ * Make sure the angle number is valid for this title.
GST_LOG ("There are %d angles available in this title",
priv->tt_srpt->title[title].nr_of_angles);
@@ -640,9 +640,9 @@
angle = priv->tt_srpt->title[title].nr_of_angles - 1;
- * Load the VTS information for the title set our title is in.
+ * Load the VTS information for the title set our title is in.
priv->vts_file =
ifoOpen (priv->dvd, priv->tt_srpt->title[title].title_set_nr);
if (!priv->vts_file) {
@@ -655,9 +655,9 @@
priv->ttn = priv->tt_srpt->title[title].vts_ttn;
priv->vts_ptt_srpt = priv->vts_file->vts_ptt_srpt;
- * We've got enough info, time to open the title set data.
+ * We've got enough info, time to open the title set data.
priv->dvd_title =
DVDOpenFile (priv->dvd, priv->tt_srpt->title[title].title_set_nr,
DVD_READ_TITLE_VOBS);
@@ -688,9 +688,9 @@
int i;
- * Make sure the chapter number is valid for this title.
+ * Make sure the chapter number is valid for this title.
if (chapter < 0 || chapter >= priv->tt_srpt->title[priv->title].nr_of_ptts) {
GST_WARNING ("Invalid chapter %d (only %d available)",
chapter, priv->tt_srpt->title[priv->title].nr_of_ptts);
@@ -699,10 +699,10 @@
chapter = priv->tt_srpt->title[priv->title].nr_of_ptts - 1;
- * Determine which program chain we want to watch. This is based on the
- * chapter number.
+ * Determine which program chain we want to watch. This is based on the
+ * chapter number.
priv->pgc_id = priv->vts_ptt_srpt->title[priv->ttn - 1].ptt[chapter].pgcn;
priv->pgn = priv->vts_ptt_srpt->title[priv->ttn - 1].ptt[chapter].pgn;
priv->cur_pgc = priv->vts_file->vts_pgcit->pgci_srp[priv->pgc_id - 1].pgc;
@@ -784,9 +784,9 @@
data = static_data;
- * Playback by cell in this pgc, starting at the cell for our chapter.
+ * Playback by cell in this pgc, starting at the cell for our chapter.
if (new_seek)
priv->cur_cell = priv->start_cell;
@@ -810,7 +810,7 @@
/* calculate next cell */
priv->next_cell = get_next_cell_for (priv, priv->cur_cell);
- /**
+ /*
* We loop until we're out of this cell.
*/
priv->cur_pack =
@@ -824,9 +824,9 @@
unsigned int next_vobu, next_ilvu_start, cur_output_size;
int len;
- /**
- * Read NAV packet.
- */
+ * Read NAV packet.
+ */
nav_retry:
len = DVDReadBlocks (priv->dvd_title, priv->cur_pack, 1, data);
@@ -841,31 +841,31 @@
}
- * Parse the contained dsi packet.
+ * Parse the contained dsi packet.
navRead_DSI (&dsi_pack, &(data[DSI_START_BYTE]));
assert (priv->cur_pack == dsi_pack.dsi_gi.nv_pck_lbn);
- * Determine where we go next. These values are the ones we mostly
- * care about.
+ * Determine where we go next. These values are the ones we mostly
+ * care about.
next_ilvu_start = priv->cur_pack + dsi_pack.sml_agli.data[angle].address;
cur_output_size = dsi_pack.dsi_gi.vobu_ea;
- * If we're not at the end of this cell, we can determine the next
- * VOBU to display using the VOBU_SRI information section of the
- * DSI. Using this value correctly follows the current angle,
- * avoiding the doubled scenes in The Matrix, and makes our life
- * really happy.
- *
- * Otherwise, we set our next address past the end of this cell to
- * force the code above to go to the next cell in the program.
+ * If we're not at the end of this cell, we can determine the next
+ * VOBU to display using the VOBU_SRI information section of the
+ * DSI. Using this value correctly follows the current angle,
+ * avoiding the doubled scenes in The Matrix, and makes our life
+ * really happy.
+ *
+ * Otherwise, we set our next address past the end of this cell to
+ * force the code above to go to the next cell in the program.
if (dsi_pack.vobu_sri.next_vobu != SRI_END_OF_CELL) {
next_vobu = priv->cur_pack + (dsi_pack.vobu_sri.next_vobu & 0x7fffffff);
} else {
@@ -876,9 +876,9 @@
priv->cur_pack++;
if (buf) {
- * Read in and output cursize packs.
+ /*
+ * Read in and output cursize packs.
+ */
len =
DVDReadBlocks (priv->dvd_title, priv->cur_pack, cur_output_size,
data);
Index: gstmpegaudioparse.c
RCS file: /cvs/gstreamer/gst-plugins-ugly/gst/mpegaudioparse/gstmpegaudioparse.c,v
retrieving revision 1.45
retrieving revision 1.46
diff -u -d -r1.45 -r1.46
--- gstmpegaudioparse.c 17 Aug 2005 19:05:51 -0000 1.45
+++ gstmpegaudioparse.c 31 Aug 2005 18:33:08 -0000 1.46
@@ -174,7 +174,7 @@
return length;
* The chance that random data is identified as a valid mp3 header is 63 / 2^18
* (0.024%) per try. This makes the function for calculating false positives
* 1 - (1 - ((63 / 2 ^18) ^ GST_MP3_TYPEFIND_MIN_HEADERS)) ^ buffersize)
Index: ChangeLog
RCS file: /cvs/gstreamer/gst-plugins-ugly/ChangeLog,v
retrieving revision 1.1824
retrieving revision 1.1825
diff -u -d -r1.1824 -r1.1825
--- ChangeLog 31 Aug 2005 11:53:35 -0000 1.1824
+++ ChangeLog 31 Aug 2005 18:33:08 -0000 1.1825
@@ -1,17692 +1,14 @@
-2005-08-31 Michael Smith <ms...@fl...>
-
- * configure.ac:
- * gst/dvdlpcmdec/Makefile.am:
- * gst/dvdlpcmdec/gstdvdlpcmdec.c: (gst_dvdlpcm_reset),
- (gst_dvdlpcmdec_init), (gst_dvdlpcmdec_link), (update_timestamps),
- (gst_dvdlpcmdec_chain):
- * gst/dvdlpcmdec/gstdvdlpcmdec.h:
- Port LPCM decoder to 0.9
-2005-08-30 Jan Schmidt <th...@ma...>
[...17670 lines suppressed...]
- Fix format conversion, we confused bits/bytes.
- * sys/oss/gstosselement.h:
- Improve documentation for 'bps'.
- * sys/v4l/TODO:
- Remove stuff about plugins that need removing - this was done
- ages ago.
- * sys/v4l/gstv4lmjpegsrc.c: (gst_v4lmjpegsrc_init),
- (gst_v4lmjpegsrc_src_convert), (gst_v4lmjpegsrc_src_query):
- * sys/v4l/gstv4lsrc.c: (gst_v4lsrc_init), (gst_v4lsrc_src_convert),
- (gst_v4lsrc_src_query):
- * sys/v4l2/gstv4l2src.c: (gst_v4l2src_init),
- (gst_v4l2src_src_convert), (gst_v4l2src_src_query):
- Add get_query_types(), get_formats() and query() functions.
-2003-12-21 Thomas Vander Stichele <thomas at apestaart dot org>
- * ChangeLog: moved to gstreamer/docs/random/old/ChangeLog.gst-plugins
- * moved CVS to freedesktop.org
+ add plugin documentation
Index: Makefile.am
RCS file: /cvs/gstreamer/gst-plugins-ugly/Makefile.am,v
retrieving revision 1.65
retrieving revision 1.66
diff -u -d -r1.65 -r1.66
--- Makefile.am 31 Aug 2005 17:57:34 -0000 1.65
+++ Makefile.am 31 Aug 2005 18:33:08 -0000 1.66
@@ -1,5 +1,5 @@
SUBDIRS = \
- gst ext m4 common
+ gst ext docs m4 common
EXTRA_DIST = \
gst-plugins-ugly.spec depcomp \
Index: configure.ac
RCS file: /cvs/gstreamer/gst-plugins-ugly/configure.ac,v
retrieving revision 1.585
retrieving revision 1.586
diff -u -d -r1.585 -r1.586
--- configure.ac 31 Aug 2005 17:57:34 -0000 1.585
+++ configure.ac 31 Aug 2005 18:33:08 -0000 1.586
@@ -325,6 +325,12 @@
AC_SUBST(GST_LIBS)
AC_SUBST(GST_CFLAGS)
+dnl ######################
+dnl # Checks for gtk-doc #
+
+GTK_DOC_CHECK([1.3])
dnl ############################
dnl # Set up some more defines #
@@ -374,7 +380,6 @@
AC_CONFIG_FILES(
Makefile
-gst-plugins-ugly.spec
gst/Makefile
gst/dvdlpcmdec/Makefile
gst/mpegaudioparse/Makefile
@@ -385,9 +390,13 @@
ext/mad/Makefile
ext/mpeg2dec/Makefile
ext/sidplay/Makefile
+docs/Makefile
+docs/plugins/Makefile
+docs/version.entities
common/Makefile
common/m4/Makefile
m4/Makefile
+gst-plugins-ugly.spec
)
AC_OUTPUT
|