From 23c9ad917a0227dd6d7b5d546741b983310a6b15 Mon Sep 17 00:00:00 2001 From: Richard Boulton Date: Wed, 18 Jul 2001 22:38:22 +0000 Subject: [PATCH] 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. --- docs/fwg/Makefile.am | 6 +++- docs/fwg/buffers.sgml | 23 +++++++++++++++ docs/fwg/checklist.sgml | 14 +++++++++ docs/fwg/gst-plugin-writers-guide.sgml | 40 +++----------------------- docs/fwg/srcnsink.sgml | 16 +++++++++++ docs/fwg/statemanage.sgml | 14 +++++++++ 6 files changed, 76 insertions(+), 37 deletions(-) create mode 100644 docs/fwg/buffers.sgml create mode 100644 docs/fwg/checklist.sgml create mode 100644 docs/fwg/srcnsink.sgml create mode 100644 docs/fwg/statemanage.sgml diff --git a/docs/fwg/Makefile.am b/docs/fwg/Makefile.am index 6bd6a674af..165d8ff467 100644 --- a/docs/fwg/Makefile.am +++ b/docs/fwg/Makefile.am @@ -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 = diff --git a/docs/fwg/buffers.sgml b/docs/fwg/buffers.sgml new file mode 100644 index 0000000000..66e691713b --- /dev/null +++ b/docs/fwg/buffers.sgml @@ -0,0 +1,23 @@ + + + Anatomy of a Buffer + + + + + + + + Refcounts and mutability + + + + + + + + Metadata + + + + diff --git a/docs/fwg/checklist.sgml b/docs/fwg/checklist.sgml new file mode 100644 index 0000000000..d67fcb7864 --- /dev/null +++ b/docs/fwg/checklist.sgml @@ -0,0 +1,14 @@ + + + Things to check when writing a filter + + + + + + + Things to check when writing a source or sink + + + + diff --git a/docs/fwg/gst-plugin-writers-guide.sgml b/docs/fwg/gst-plugin-writers-guide.sgml index a5e3d80ffc..7a89d16cdd 100644 --- a/docs/fwg/gst-plugin-writers-guide.sgml +++ b/docs/fwg/gst-plugin-writers-guide.sgml @@ -7,13 +7,13 @@ - + - + - + - + GStreamer"> ]> @@ -781,12 +781,6 @@ &BUFFERS; - Anatomy of a Buffer - Refcounts and mutability - Metadata - How Properties work efficiently - Metadata mutability - (FIXME: this is an unsolved problem) @@ -798,12 +792,6 @@ &SRCNSINK; - Writing a source - Pull vs loop based - Region pulling - (NOTE: somewhere explain how filters use this) - Writing a sink - Gee, that was easy @@ -815,8 +803,6 @@ &STATEMANAGE; - What are states? - Mangaging filter state @@ -828,24 +814,6 @@ &CHECKLIST; - Things to check when writing a filter - Things to check when writing a source or sink - - - - - -===== - -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) - diff --git a/docs/fwg/srcnsink.sgml b/docs/fwg/srcnsink.sgml new file mode 100644 index 0000000000..33d5223db4 --- /dev/null +++ b/docs/fwg/srcnsink.sgml @@ -0,0 +1,16 @@ + + + Writing a source + + + Pull vs loop based + Region pulling + + + + + Writing a sink + + + + diff --git a/docs/fwg/statemanage.sgml b/docs/fwg/statemanage.sgml new file mode 100644 index 0000000000..4d8a1e1474 --- /dev/null +++ b/docs/fwg/statemanage.sgml @@ -0,0 +1,14 @@ + + + What are states? + + + + + + + Mangaging filter state + + + +