From 5b00b55793d38002e1302dea4137a0953eca25df Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Wed, 28 Jan 2004 15:51:14 +0000 Subject: [PATCH] fix up id's Original commit message from CVS: fix up id's --- ChangeLog | 28 +++++++++++++++++++++ docs/pwg/advanced-clock.xml | 2 +- docs/pwg/advanced-dparams.xml | 20 +++++++-------- docs/pwg/advanced-events.xml | 2 +- docs/pwg/advanced-interfaces.xml | 24 +++++++++--------- docs/pwg/advanced-midi.xml | 2 +- docs/pwg/advanced-request.xml | 8 +++--- docs/pwg/advanced-scheduling.xml | 18 ++++++------- docs/pwg/advanced-tagging.xml | 6 ++--- docs/pwg/advanced-types.xml | 10 ++++---- docs/pwg/appendix-checklist.xml | 6 ++--- docs/pwg/building-boiler.xml | 18 ++++++------- docs/pwg/building-chainfn.xml | 2 +- docs/pwg/building-filterfactory.xml | 2 +- docs/pwg/building-pads.xml | 10 ++++---- docs/pwg/building-props.xml | 2 +- docs/pwg/building-signals.xml | 2 +- docs/pwg/building-state.xml | 4 +-- docs/pwg/building-testapp.xml | 2 +- docs/pwg/intro-basics.xml | 12 ++++----- docs/pwg/intro-preface.xml | 50 ++++++++++++++++++------------------- docs/pwg/other-autoplugger.xml | 2 +- docs/pwg/other-sink.xml | 2 +- docs/pwg/other-source.xml | 2 +- docs/pwg/titlepage.xml | 2 +- 25 files changed, 133 insertions(+), 105 deletions(-) diff --git a/ChangeLog b/ChangeLog index 66f03e4..f0984c8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,33 @@ 2004-01-28 Thomas Vander Stichele + * docs/pwg/advanced-clock.xml: + * docs/pwg/advanced-dparams.xml: + * docs/pwg/advanced-events.xml: + * docs/pwg/advanced-interfaces.xml: + * docs/pwg/advanced-midi.xml: + * docs/pwg/advanced-request.xml: + * docs/pwg/advanced-scheduling.xml: + * docs/pwg/advanced-tagging.xml: + * docs/pwg/advanced-types.xml: + * docs/pwg/appendix-checklist.xml: + * docs/pwg/building-boiler.xml: + * docs/pwg/building-chainfn.xml: + * docs/pwg/building-filterfactory.xml: + * docs/pwg/building-pads.xml: + * docs/pwg/building-props.xml: + * docs/pwg/building-signals.xml: + * docs/pwg/building-state.xml: + * docs/pwg/building-testapp.xml: + * docs/pwg/intro-basics.xml: + * docs/pwg/intro-preface.xml: + * docs/pwg/other-autoplugger.xml: + * docs/pwg/other-sink.xml: + * docs/pwg/other-source.xml: + * docs/pwg/titlepage.xml: + fix up id's + +2004-01-28 Thomas Vander Stichele + * docs/95NonPath: * docs/HACKING: * docs/README: diff --git a/docs/pwg/advanced-clock.xml b/docs/pwg/advanced-clock.xml index 1d4698c..bc9dfaf 100644 --- a/docs/pwg/advanced-clock.xml +++ b/docs/pwg/advanced-clock.xml @@ -1,4 +1,4 @@ - + Clocking WRITEME diff --git a/docs/pwg/advanced-dparams.xml b/docs/pwg/advanced-dparams.xml index cda23ef..973c1eb 100644 --- a/docs/pwg/advanced-dparams.xml +++ b/docs/pwg/advanced-dparams.xml @@ -1,7 +1,7 @@ - + Supporting Dynamic Parameters Sometimes object properties are not powerful enough to control the @@ -14,7 +14,7 @@ as an abbreviation for "Dynamic Parameters". - + Comparing Dynamic Parameters with GObject Properties Your first exposure to dparams may be to convert an existing element from @@ -57,7 +57,7 @@ - + Getting Started @@ -123,7 +123,7 @@ - + Defining Parameter Specificiations You can define the dparams you need anywhere within your element but will @@ -197,7 +197,7 @@ - + Direct Method This method is the simplest and has the lowest overhead for parameters @@ -236,7 +236,7 @@ element knowing that it will always contain the correct value to use. - + Callback Method This should be used if the you have other values to calculate whenever a @@ -305,7 +305,7 @@ gst_example_update_volume(GValue *value, gpointer data) will always contain the correct value. - + Array Method This method is quite different from the other two. It could be thought of @@ -340,7 +340,7 @@ gst_example_update_volume(GValue *value, gpointer data) - + The Data Processing Loop This is the most critical aspect of the dparams subsystem as it relates to @@ -439,7 +439,7 @@ example_chain (GstPad *pad, GstBuffer *buf) GST_DPMAN_PREPROCESS depending on the mode that the dparam manager is running in (see below). - + DParam Manager Modes A brief explanation of dparam manager modes might be useful here even @@ -490,7 +490,7 @@ example_chain (GstPad *pad, GstBuffer *buf) parameter updates - + DParam Manager Modes All of the explanation so far has presumed that the buffer contains audio diff --git a/docs/pwg/advanced-events.xml b/docs/pwg/advanced-events.xml index cd0dfbb..884c532 100644 --- a/docs/pwg/advanced-events.xml +++ b/docs/pwg/advanced-events.xml @@ -1,4 +1,4 @@ - + Events: Seeking, Navigation and More WRITEME diff --git a/docs/pwg/advanced-interfaces.xml b/docs/pwg/advanced-interfaces.xml index 5801545..a18e768 100644 --- a/docs/pwg/advanced-interfaces.xml +++ b/docs/pwg/advanced-interfaces.xml @@ -1,7 +1,7 @@ - + Interfaces - Previously, in the chapter , we have + Previously, in the chapter , we have introduced the concept of GObject properties of controlling an element's behaviour. This is a very powerful, but has two big disadvantage: firstly, it is too generic, and secondly, it isn't dynamic. @@ -47,7 +47,7 @@ commandline (gst-launch). - + How to Implement Interfaces Implementing interfaces is intiated in the _get_type () @@ -64,7 +64,7 @@ wanting to support. The example below explains how to add support for a simple interface with no further dependencies. For a small explanation on GstImplementsInterface, see the next section - about the mixer interface: . + about the mixer interface: . static void gst_my_filter_some_interface_init (GstSomeInterface *iface); @@ -112,7 +112,7 @@ gst_my_filter_some_interface_init (GstSomeInterface *iface) - + Mixer Interface The goal of the mixer interface is to provide a simple yet powerful API @@ -269,26 +269,26 @@ gst_my_filter_mixer_interface_init (GstMixerClass *iface) - + Tuner Interface WRITEME - + Color Balance Interface WRITEME - + Property Probe Interface Property probing is a generic solution to the problem that properties' value lists in an enumeration are static. We've shown enumerations in - . Property probing tries to accomplish + . Property probing tries to accomplish a goal similar to enumeration lists: to have a limited, explicit list of allowed values for a property. There are two differences between enumeration lists and probing. Firstly, enumerations only allow strings @@ -447,21 +447,21 @@ gst_my_filter_probe_interface_init (GstPropertyProbeInterface *iface) - + Profile Interface WRITEME - + X Overlay Interface WRITEME - + Navigation Interface WRITEME diff --git a/docs/pwg/advanced-midi.xml b/docs/pwg/advanced-midi.xml index 513fdac..e5dc430 100644 --- a/docs/pwg/advanced-midi.xml +++ b/docs/pwg/advanced-midi.xml @@ -1,4 +1,4 @@ - + MIDI WRITEME diff --git a/docs/pwg/advanced-request.xml b/docs/pwg/advanced-request.xml index 9497a2f..f8af024 100644 --- a/docs/pwg/advanced-request.xml +++ b/docs/pwg/advanced-request.xml @@ -1,4 +1,4 @@ - + Request and Sometimes pads Until now, we've only dealt with pads that are always available. However, @@ -11,7 +11,7 @@ they should be disposed. - + Sometimes pads A sometimes pad is a pad that is created under certain @@ -196,7 +196,7 @@ gst_my_filter_loopfunc (GstElement *element) - + Request pads Request pads are similar to sometimes pads, except that @@ -261,7 +261,7 @@ gst_my_filter_request_new_pad (GstElement *element, The _loop () function is the same as the one given - previously in . + previously in . diff --git a/docs/pwg/advanced-scheduling.xml b/docs/pwg/advanced-scheduling.xml index 9d808a9..e962c83 100644 --- a/docs/pwg/advanced-scheduling.xml +++ b/docs/pwg/advanced-scheduling.xml @@ -1,4 +1,4 @@ - + How scheduling works Scheduling is, in short, a method for making sure that every element gets @@ -22,7 +22,7 @@ element (a DECOUPLED element) in between them. - + The Basic Scheduler The basic scheduler assumes that each element is its @@ -55,7 +55,7 @@ - + The Optimal Scheduler The optimal scheduler takes advantage of the fact that @@ -86,7 +86,7 @@ - + How a loopfunc works A _loop () function is a function that is called by @@ -139,7 +139,7 @@ gst_my_filter_loopfunc (GstElement *element) introduction to the concept. - + Multi-Input Elements Elements with multiple sink pads need to take manual control over their @@ -256,7 +256,7 @@ gst_my_filter_loopfunc (GstElement *element) - + The Bytestream Object A second type of elements that wants to be loop-based, are the so-called @@ -271,7 +271,7 @@ gst_my_filter_loopfunc (GstElement *element) Bytestream-using elements are ususally stream parsers or demuxers. For now, we will take a parser as an example. Demuxers require some more magic that will be dealt with later in this guide: - . The goal of this parser will be + . The goal of this parser will be to parse a text-file and to push each line of text as a separate buffer over its source pad. @@ -357,14 +357,14 @@ gst_my_filter_change_state (GstElement *element) - + Adding a second output Identity is now a tee - + Modifying the test application WRITEME diff --git a/docs/pwg/advanced-tagging.xml b/docs/pwg/advanced-tagging.xml index e096f5c..e894275 100644 --- a/docs/pwg/advanced-tagging.xml +++ b/docs/pwg/advanced-tagging.xml @@ -1,4 +1,4 @@ - + Tagging (Metadata and Streaminfo) Tags are pieces of information stored in a stream that are not the content @@ -37,14 +37,14 @@ element supporting both can be used in a tag editor for quick tag changing. - + Reading Tags from Streams WRITEME - + Writing Tags to Streams WRITEME diff --git a/docs/pwg/advanced-types.xml b/docs/pwg/advanced-types.xml index 075dc1f..a4c14bc 100644 --- a/docs/pwg/advanced-types.xml +++ b/docs/pwg/advanced-types.xml @@ -1,6 +1,6 @@ - + Types and Properties There is a very large set of possible types that may be used to pass data @@ -56,11 +56,11 @@ - + Building a Simple Format for Testing If you need a new format that has not yet been defined in our , you will want to have some general + linkend="section-types-definitions"/>, you will want to have some general guidelines on mimetype naming, properties and such. A mimetype would ideally be one defined by IANA; else, it should be in the form type/x-name, where type is the sort of data this mimetype handles (audio, @@ -83,7 +83,7 @@ - + Typefind Functions and Autoplugging WRITEME @@ -92,7 +92,7 @@ - + List of Defined Types Below is a list of all the defined types in &GStreamer;. They are split diff --git a/docs/pwg/appendix-checklist.xml b/docs/pwg/appendix-checklist.xml index 872d447..d6aa55d 100644 --- a/docs/pwg/appendix-checklist.xml +++ b/docs/pwg/appendix-checklist.xml @@ -1,4 +1,4 @@ - + Things to check when writing an element @@ -8,14 +8,14 @@ This function should also be called from _init. - + Things to check when writing a filter - + Things to check when writing a source or sink diff --git a/docs/pwg/building-boiler.xml b/docs/pwg/building-boiler.xml index 5392df4..1453098 100644 --- a/docs/pwg/building-boiler.xml +++ b/docs/pwg/building-boiler.xml @@ -1,6 +1,6 @@ - + Constructing the Boilerplate In this chapter you will learn how to construct the bare minimum code for a @@ -14,7 +14,7 @@ - + Getting the GStreamer Plugin Templates There are currently two ways to develop a new plugin for &GStreamer;: You @@ -62,7 +62,7 @@ U gst-template/gst-app/src/Makefile.am - + Using the Project Stamp The first thing to do when making a new element is to specify some basic @@ -115,7 +115,7 @@ U gst-template/gst-app/src/Makefile.am - + Examining the Basic Code First we will examine the code you would be likely to place in a header @@ -167,7 +167,7 @@ U gst-template/gst-app/src/Makefile.am - + GstElementDetails The GstElementDetails structure gives a heirarchical type for the element, @@ -222,7 +222,7 @@ gst_my_filter_base_init (GstMyFilterClass *klass) - + GstStaticPadTemplate A GstStaticPadTemplate is a description of a pad that the element will @@ -317,13 +317,13 @@ GST_STATIC_PAD_TEMPLATE ( Multiple sets of types are supported too, and should be separated by a semicolon (;). Later, in the chapter on pads, we will see how to use types to know the exact format of a stream: - . + . - + Constructor Functions Each element has three functions which are used for construction of an @@ -339,7 +339,7 @@ GST_STATIC_PAD_TEMPLATE ( - + The plugin_init function Once we have written code defining all the parts of the plugin, we need to diff --git a/docs/pwg/building-chainfn.xml b/docs/pwg/building-chainfn.xml index 441b1cd..cb1d5f1 100644 --- a/docs/pwg/building-chainfn.xml +++ b/docs/pwg/building-chainfn.xml @@ -1,7 +1,7 @@ - + The chain function The chain function is the function in which all data processing takes diff --git a/docs/pwg/building-filterfactory.xml b/docs/pwg/building-filterfactory.xml index 4d2e4e8..a5a8997 100644 --- a/docs/pwg/building-filterfactory.xml +++ b/docs/pwg/building-filterfactory.xml @@ -1,4 +1,4 @@ - + Creating a Filter with a Filter Factory A plan for the future is to create a FilterFactory, to make the process of making a new filter a simple process of specifying a few details, and diff --git a/docs/pwg/building-pads.xml b/docs/pwg/building-pads.xml index 1148f9a..d7fd79a 100644 --- a/docs/pwg/building-pads.xml +++ b/docs/pwg/building-pads.xml @@ -1,7 +1,7 @@ - + Specifying the pads As explained before, pads are the port through which data goes in and out @@ -56,13 +56,13 @@ gst_my_filter_init (GstMyFilter *filter) } - + The link function The _link () is called during caps negotiation. This is the process where the linked pads decide on the streamtype that will transfer between them. A full list of type-definitions can be found in - . A _link () + . A _link () receives a pointer to a GstCaps struct that defines the proposed streamtype, and can respond with either yes (GST_PAD_LINK_OK), @@ -130,7 +130,7 @@ gst_my_filter_link (GstPad *pad, - + The getcaps function The _getcaps () funtion is used to request the list @@ -177,7 +177,7 @@ gst_my_filter_getcaps (GstPad *pad) - + Explicit caps Obviously, many elements will not need this complex mechanism, because they diff --git a/docs/pwg/building-props.xml b/docs/pwg/building-props.xml index 33c64dd..51f3def 100644 --- a/docs/pwg/building-props.xml +++ b/docs/pwg/building-props.xml @@ -1,6 +1,6 @@ - + Adding Arguments The primary and most important way of controlling how an element behaves, diff --git a/docs/pwg/building-signals.xml b/docs/pwg/building-signals.xml index 81b6c23..76fea96 100644 --- a/docs/pwg/building-signals.xml +++ b/docs/pwg/building-signals.xml @@ -1,7 +1,7 @@ - + Signals Signals can be used to notify applications of events specific to this diff --git a/docs/pwg/building-state.xml b/docs/pwg/building-state.xml index f8d6253..df6d564 100644 --- a/docs/pwg/building-state.xml +++ b/docs/pwg/building-state.xml @@ -1,4 +1,4 @@ - + What are states? @@ -54,7 +54,7 @@ reverse transition (GST_STATE_PLAYING_TO_PAUSED). - + Mangaging filter state diff --git a/docs/pwg/building-testapp.xml b/docs/pwg/building-testapp.xml index 8f7a4ba..af3baee 100644 --- a/docs/pwg/building-testapp.xml +++ b/docs/pwg/building-testapp.xml @@ -1,6 +1,6 @@ - + Building a Test Application Often, you will want to test your newly written plugin in an as small diff --git a/docs/pwg/intro-basics.xml b/docs/pwg/intro-basics.xml index d6ec4a6..2c4a096 100644 --- a/docs/pwg/intro-basics.xml +++ b/docs/pwg/intro-basics.xml @@ -1,6 +1,6 @@ - + Basic Concepts This chapter of the guide introduces the basic concepts of &GStreamer;. @@ -12,7 +12,7 @@ - + Elements and Plugins Elements are at the core of &GStreamer;. In the context of plugin @@ -64,7 +64,7 @@ - + Pads Pads are used to negotiate links and data flow @@ -103,7 +103,7 @@ - + Data, Buffers and Events All streams of data in &GStreamer; are chopped up into chunks that are @@ -230,7 +230,7 @@ - + Mimetypes and Properties &GStreamer; uses a type system to ensure that the data passed between @@ -251,7 +251,7 @@ &GStreamer;. The table contains the name ("mime type") and a description of the type, the properties associated with the type, and the meaning of each property. A full list of supported types is - included in . + included in . diff --git a/docs/pwg/intro-preface.xml b/docs/pwg/intro-preface.xml index f246335..a151ad4 100644 --- a/docs/pwg/intro-preface.xml +++ b/docs/pwg/intro-preface.xml @@ -1,12 +1,12 @@ - + Preface - + Who Should Read This Guide? This guide explains how to write new modules for &GStreamer;. The guide is @@ -52,7 +52,7 @@ - + Preliminary Reading This guide assumes that you are somewhat familiar with the basic workings @@ -75,7 +75,7 @@ - + Structure of This Guide To help you navigate through this guide, it is divided into several large @@ -93,12 +93,12 @@ This part covers all the basic steps you generally need to perform to build a plugin. The discussion begins by giving examples of generating - the basic structures with . Then + the basic structures with . Then you will learn how to write the code to get a basic filter plugin working: These steps include chapters on , , - , and (WRITEME: building state). + linkend="chapter-building-types"/>, , + , and (WRITEME: building state). After you have finished the first steps, you will be able to create a @@ -106,10 +106,10 @@ functionality you need. To provide some standard functionality, you will learn how to add more features to a new plugin. These features are described in the chapters on - + (WRITEME) - and . Finally, you will see in - (WRITEME) + and . Finally, you will see in + (WRITEME) how to write a short test application to try out your new plugin. @@ -124,11 +124,11 @@ functional audio or video filter plugin with some nice features. However, &GStreamer; offers more for plugin writers. This part of the guide includes chapters on more advanced topics, such as , . Since these features are more advanced, + linkend="chapter-advanced-request"/>, . Since these features are more advanced, the chapters can basically be read in any order, as you find that your plugins require these features. @@ -144,10 +144,10 @@ the concepts apply equally to other plugin types, including sources, sinks, and autopluggers. This part of the guide presents the issues that arise when working on these more specialized plugin types. The - part includes chapters on , , and - . + part includes chapters on , , and + . @@ -159,9 +159,9 @@ The appendices contain some information that stubbornly refuses to fit cleanly in other sections of the guide. This information includes (WRITEME) and + --> (WRITEME) and FIXME: organize better. + linkend="chapter-appendix-python"/>.--> FIXME: organize better. @@ -169,9 +169,9 @@ The remainder of this introductory part of the guide presents a short overview of the basic concepts involved in &GStreamer; plugin development. - Topics covered include , , and - . If you are already familiar with + Topics covered include , , and + . If you are already familiar with this information, you can use this short overview to refresh your memory, or you can skip to . diff --git a/docs/pwg/other-autoplugger.xml b/docs/pwg/other-autoplugger.xml index 627d15f..ac4e4fd 100644 --- a/docs/pwg/other-autoplugger.xml +++ b/docs/pwg/other-autoplugger.xml @@ -1,7 +1,7 @@ - + Writing an Autoplugger FIXME: write. diff --git a/docs/pwg/other-sink.xml b/docs/pwg/other-sink.xml index af2a310..9354589 100644 --- a/docs/pwg/other-sink.xml +++ b/docs/pwg/other-sink.xml @@ -1,7 +1,7 @@ - + Writing a Sink FIXME: write. diff --git a/docs/pwg/other-source.xml b/docs/pwg/other-source.xml index bb991d2..38af9cd 100644 --- a/docs/pwg/other-source.xml +++ b/docs/pwg/other-source.xml @@ -1,7 +1,7 @@ - + Writing a Source FIXME: write. diff --git a/docs/pwg/titlepage.xml b/docs/pwg/titlepage.xml index 6aa6a32..c2f334c 100644 --- a/docs/pwg/titlepage.xml +++ b/docs/pwg/titlepage.xml @@ -54,7 +54,7 @@ - + This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the -- 2.7.4