Sort out some remaining bits of fwg which weren't valid sgml.

Original commit message from CVS:
Sort out some remaining bits of fwg which weren't valid sgml.
This commit is contained in:
Richard Boulton 2001-07-18 22:38:22 +00:00
parent 8f72f095d8
commit 23c9ad917a
6 changed files with 76 additions and 37 deletions

View file

@ -5,7 +5,11 @@ sgml_files = gst-plugin-writers-guide.sgml \
titlepage.sgml \
intro.sgml \
testapp.sgml \
loopbased.sgml
loopbased.sgml \
buffers.sgml \
srcnsink.sgml \
statemanage.sgml \
checklist.sgml
fig_files =
eps_files =

23
docs/fwg/buffers.sgml Normal file
View file

@ -0,0 +1,23 @@
<chapter id="cha-buffers-anatomy">
<title>
Anatomy of a Buffer
</title>
<para>
</para>
</chapter>
<chapter id="cha-buffers-refcounts">
<title>
Refcounts and mutability
</title>
<para>
</para>
</chapter>
<chapter id="cha-buffers-metadata">
<title>
Metadata
</title>
<para>
</para>
</chapter>

14
docs/fwg/checklist.sgml Normal file
View file

@ -0,0 +1,14 @@
<chapter id="cha-checklist-filter">
<title>
Things to check when writing a filter
</title>
<para>
</para>
</chapter>
<chapter id="cha-checklist-srcsink">
<title>
Things to check when writing a source or sink
</title>
<para>
</para>
</chapter>

View file

@ -7,13 +7,13 @@
<!ENTITY LOOPBASED SYSTEM "loopbased.sgml">
<!ENTITY BUFFERS SYSTEM ".sgml">
<!ENTITY BUFFERS SYSTEM "buffers.sgml">
<!ENTITY SRCNSINK SYSTEM ".sgml">
<!ENTITY SRCNSINK SYSTEM "srcnsink.sgml">
<!ENTITY STATEMANAGE SYSTEM ".sgml">
<!ENTITY STATEMANAGE SYSTEM "statemanage.sgml">
<!ENTITY CHECKLIST SYSTEM ".sgml">
<!ENTITY CHECKLIST SYSTEM "checklist.sgml">
<!ENTITY GStreamer "<application>GStreamer</application>">
]>
@ -781,12 +781,6 @@
</partintro>
&BUFFERS;
Anatomy of a Buffer
Refcounts and mutability
Metadata
How Properties work efficiently
Metadata mutability
(FIXME: this is an unsolved problem)
</part>
<!-- ############ part ############# -->
@ -798,12 +792,6 @@
</partintro>
&SRCNSINK;
Writing a source
Pull vs loop based
Region pulling
(NOTE: somewhere explain how filters use this)
Writing a sink
Gee, that was easy
</part>
<!-- ############ part ############# -->
@ -815,8 +803,6 @@
</partintro>
&STATEMANAGE;
What are states?
Mangaging filter state
</part>
<!-- ############ part ############# -->
@ -828,24 +814,6 @@
</partintro>
&CHECKLIST;
Things to check when writing a filter
Things to check when writing a source or sink
</part>
</book>
=====
Omega: a chain-based element has chain functions on each sink pad, the
connected source pad may directly call (i.e. on the stack) the chain
function
Omega: each chain function is responsible for doing something useful,
generally processing the buffer and pushing out the other end
Omega: a loop-based element has a single function attatched to the element
(not tha pads) that spins in a loop calling gst_pad_pull(sinkpad),
do stuff, gst_pad_push(srcpad)

16
docs/fwg/srcnsink.sgml Normal file
View file

@ -0,0 +1,16 @@
<chapter id="cha-srcnsink-writesrc">
<title>
Writing a source
</title>
<para>
Pull vs loop based
Region pulling
</para>
</chapter>
<chapter id="cha-srcnsink-writesink">
<title>
Writing a sink
</title>
<para>
</para>
</chapter>

14
docs/fwg/statemanage.sgml Normal file
View file

@ -0,0 +1,14 @@
<chapter id="cha-statemanage-states">
<title>
What are states?
</title>
<para>
</para>
</chapter>
<chapter id="cha-statemanage-filters">
<title>
Mangaging filter state
</title>
<para>
</para>
</chapter>