From 498cda94b5d493bd46a15f573f1d69621c3c1f48 Mon Sep 17 00:00:00 2001 From: Luc Pionchon Date: Wed, 25 Jun 2008 14:44:52 +0000 Subject: [PATCH] docs/manual/manual.xml: - Reorganised the previous "introduction" bundle into Foreword, Original commit message from CVS: patch by: Luc Pionchon * docs/manual/manual.xml: - Reorganised the previous "introduction" bundle into Foreword, Introduction, and About GStreamer. The two first are docbook elements. The later is the first part of the book. - added intro-gstreamer.xml (content partially from intro-preface.xml) - moved appendix-win32.xml into appendix-integration.xml * docs/manual/intro-preface.xml: gstreamer section moved... * docs/manual/intro-gstreamer.xml: ...here. new file. * docs/manual/appendix-win32.xml: removed file. Content moved... * docs/manual/appendix-integration.xml: ...here. * docs/manual/highlevel-components.xml: section about GstEditor moved... * docs/manual/appendix-checklist.xml: ...here. --- ChangeLog | 21 +++++ docs/manual/appendix-checklist.xml | 9 ++ docs/manual/appendix-integration.xml | 123 +++++++++++++++++++++++++++ docs/manual/appendix-win32.xml | 99 --------------------- docs/manual/highlevel-components.xml | 8 -- docs/manual/intro-gstreamer.xml | 50 +++++++++++ docs/manual/intro-preface.xml | 56 ------------ docs/manual/manual.xml | 30 +++++-- 8 files changed, 226 insertions(+), 170 deletions(-) delete mode 100644 docs/manual/appendix-win32.xml create mode 100644 docs/manual/intro-gstreamer.xml diff --git a/ChangeLog b/ChangeLog index aeafde559f..63d22a4b63 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,24 @@ +2008-06-25 Stefan Kost + + patch by: Luc Pionchon + + * docs/manual/manual.xml: + - Reorganised the previous "introduction" bundle into Foreword, + Introduction, and About GStreamer. The two first are + docbook elements. The later is the first part of the book. + - added intro-gstreamer.xml (content partially from + intro-preface.xml) + - moved appendix-win32.xml into appendix-integration.xml + + * docs/manual/intro-preface.xml: gstreamer section moved... + * docs/manual/intro-gstreamer.xml: ...here. new file. + + * docs/manual/appendix-win32.xml: removed file. Content moved... + * docs/manual/appendix-integration.xml: ...here. + + * docs/manual/highlevel-components.xml: section about GstEditor moved... + * docs/manual/appendix-checklist.xml: ...here. + 2008-06-25 Stefan Kost patch by: Luc Pionchon diff --git a/docs/manual/appendix-checklist.xml b/docs/manual/appendix-checklist.xml index 6d5db76345..469f7bb4e5 100644 --- a/docs/manual/appendix-checklist.xml +++ b/docs/manual/appendix-checklist.xml @@ -186,5 +186,14 @@ for more information. + + + GstEditor + + GstEditor is a set of widgets to display a graphical representation of a + pipeline. + + + diff --git a/docs/manual/appendix-integration.xml b/docs/manual/appendix-integration.xml index 3e764e516e..a33bbcd436 100644 --- a/docs/manual/appendix-integration.xml +++ b/docs/manual/appendix-integration.xml @@ -8,6 +8,10 @@ operating system or desktop environment of choice. + + + + Linux and UNIX-like operating systems @@ -42,6 +46,10 @@ + + + + GNOME desktop @@ -169,6 +177,12 @@ main (gint argc, gchar **argv) + + + + + + KDE desktop @@ -197,6 +211,10 @@ main (gint argc, gchar **argv) + + + + OS X @@ -205,10 +223,115 @@ main (gint argc, gchar **argv) + + + + Windows + + + +Note: this section is out of date. GStreamer-0.10 has much better +support for win32 than previous versions though and should usually compile +and work out-of-the-box both using MSYS/MinGW or Microsoft compilers. The +GStreamer web site and the +mailing list +archives are a good place to check the latest win32-related news. + + + + &GStreamer; builds using Microsoft Visual C .NET 2003 and using Cygwin. + + + Building <application>GStreamer</application> under Win32 + +There are different makefiles that can be used to build GStreamer with the usual Microsoft +compiling tools. + +The Makefile is meant to be used with the GNU make program and the free +version of the Microsoft compiler (http://msdn.microsoft.com/visualc/vctoolkit2003/). You also +have to modify your system environment variables to use it from the command-line. You will also +need a working Platform SDK for Windows that is available for free from Microsoft. + +The projects/makefiles will generate automatically some source files needed to compile +GStreamer. That requires that you have installed on your system some GNU tools and that they are +available in your system PATH. + +The GStreamer project depends on other libraries, namely : + +GLib +libxml2 +libintl +libiconv + + +Work is being done to provide pre-compiled GStreamer-0.10 libraries as +a packages for win32. Check the +GStreamer web site and check our +mailing list + for the latest developments in this respect. + + +Notes + +GNU tools needed that you can find on http://gnuwin32.sourceforge.net/ + +GNU flex (tested with 2.5.4) +GNU bison (tested with 1.35) + + +and http://www.mingw.org/ + +GNU make (tested with 3.80) + + +the generated files from the -auto makefiles will be available soon separately on the net +for convenience (people who don't want to install GNU tools). + + + + +Installation on the system + +FIXME: This section needs be updated for GStreamer-0.10. + + + + + + diff --git a/docs/manual/appendix-win32.xml b/docs/manual/appendix-win32.xml deleted file mode 100644 index e938fe7896..0000000000 --- a/docs/manual/appendix-win32.xml +++ /dev/null @@ -1,99 +0,0 @@ - -Windows support - -Note: this section is out of date. GStreamer-0.10 has much better -support for win32 than previous versions though and should usually compile -and work out-of-the-box both using MSYS/MinGW or Microsoft compilers. The -GStreamer web site and the -mailing list -archives are a good place to check the latest win32-related news. - - - - - Building <application>GStreamer</application> under Win32 - -There are different makefiles that can be used to build GStreamer with the usual Microsoft -compiling tools. - -The Makefile is meant to be used with the GNU make program and the free -version of the Microsoft compiler (http://msdn.microsoft.com/visualc/vctoolkit2003/). You also -have to modify your system environment variables to use it from the command-line. You will also -need a working Platform SDK for Windows that is available for free from Microsoft. - -The projects/makefiles will generate automatically some source files needed to compile -GStreamer. That requires that you have installed on your system some GNU tools and that they are -available in your system PATH. - -The GStreamer project depends on other libraries, namely : - -GLib -libxml2 -libintl -libiconv - - -Work is being done to provide pre-compiled GStreamer-0.10 libraries as -a packages for win32. Check the -GStreamer web site and check our -mailing list - for the latest developments in this respect. - - -Notes - -GNU tools needed that you can find on http://gnuwin32.sourceforge.net/ - -GNU flex (tested with 2.5.4) -GNU bison (tested with 1.35) - - -and http://www.mingw.org/ - -GNU make (tested with 3.80) - - -the generated files from the -auto makefiles will be available soon separately on the net -for convenience (people who don't want to install GNU tools). - - - - -Installation on the system - -FIXME: This section needs be updated for GStreamer-0.10. - - - - - - diff --git a/docs/manual/highlevel-components.xml b/docs/manual/highlevel-components.xml index 4f8a871804..9a0d211110 100644 --- a/docs/manual/highlevel-components.xml +++ b/docs/manual/highlevel-components.xml @@ -367,12 +367,4 @@ main (gint argc, - - GstEditor - - GstEditor is a set of widgets to display a graphical representation of a - pipeline. - - - diff --git a/docs/manual/intro-gstreamer.xml b/docs/manual/intro-gstreamer.xml new file mode 100644 index 0000000000..e744029f86 --- /dev/null +++ b/docs/manual/intro-gstreamer.xml @@ -0,0 +1,50 @@ + + What is &GStreamer;? + + + + + + &GStreamer; is a framework for creating streaming media applications. + The fundamental design comes from the video pipeline at Oregon Graduate + Institute, as well as some ideas from DirectShow. + + + + &GStreamer;'s development framework makes it possible to write any + type of streaming multimedia application. The &GStreamer; framework + is designed to make it easy to write applications that handle audio + or video or both. It isn't restricted to audio and video, and can + process any kind of data flow. + The pipeline design is made to have little overhead above what the + applied filters induce. This makes &GStreamer; a good framework for + designing even high-end audio applications which put high demands on + latency. + + + + One of the the most obvious uses of &GStreamer; is using it to build + a media player. &GStreamer; already includes components for building a + media player that can support a very wide variety of formats, including + MP3, Ogg/Vorbis, MPEG-1/2, AVI, Quicktime, mod, and more. &GStreamer;, + however, is much more than just another media player. Its main advantages + are that the pluggable components can be mixed and matched into arbitrary + pipelines so that it's possible to write a full-fledged video or audio + editing application. + + + + The framework is based on plugins that will provide the various codec + and other functionality. The plugins can be linked and arranged in + a pipeline. This pipeline defines the flow of the data. Pipelines can + also be edited with a GUI editor and saved as XML so that pipeline + libraries can be made with a minimum of effort. + + + + The &GStreamer; core function is to provide a framework for plugins, + data flow and media type handling/negotiation. It also provides an + API to write applications using the various plugins. + + + diff --git a/docs/manual/intro-preface.xml b/docs/manual/intro-preface.xml index c8e7992fc0..b481bfe872 100644 --- a/docs/manual/intro-preface.xml +++ b/docs/manual/intro-preface.xml @@ -1,58 +1,3 @@ - - Preface - - This chapter gives you an overview of the technologies described in this - book. - - - - - - What is &GStreamer;? - - &GStreamer; is a framework for creating streaming media applications. - The fundamental design comes from the video pipeline at Oregon Graduate - Institute, as well as some ideas from DirectShow. - - - - &GStreamer;'s development framework makes it possible to write any - type of streaming multimedia application. The &GStreamer; framework - is designed to make it easy to write applications that handle audio - or video or both. It isn't restricted to audio and video, and can - process any kind of data flow. - The pipeline design is made to have little overhead above what the - applied filters induce. This makes &GStreamer; a good framework for - designing even high-end audio applications which put high demands on - latency. - - - - One of the the most obvious uses of &GStreamer; is using it to build - a media player. &GStreamer; already includes components for building a - media player that can support a very wide variety of formats, including - MP3, Ogg/Vorbis, MPEG-1/2, AVI, Quicktime, mod, and more. &GStreamer;, - however, is much more than just another media player. Its main advantages - are that the pluggable components can be mixed and matched into arbitrary - pipelines so that it's possible to write a full-fledged video or audio - editing application. - - - - The framework is based on plugins that will provide the various codec - and other functionality. The plugins can be linked and arranged in - a pipeline. This pipeline defines the flow of the data. Pipelines can - also be edited with a GUI editor and saved as XML so that pipeline - libraries can be made with a minimum of effort. - - - - The &GStreamer; core function is to provide a framework for plugins, - data flow and media type handling/negotiation. It also provides an - API to write applications using the various plugins. - - - @@ -137,4 +82,3 @@ programming. - diff --git a/docs/manual/manual.xml b/docs/manual/manual.xml index 116cea0717..0f336fa38b 100644 --- a/docs/manual/manual.xml +++ b/docs/manual/manual.xml @@ -22,6 +22,8 @@ + + @@ -53,7 +55,6 @@ - GStreamer"> @@ -63,11 +64,9 @@ &TITLEPAGE; - + - - Introduction - +Foreword &GStreamer; is an extremely powerful and versatile framework for creating streaming media applications. Many of the virtues of the @@ -85,9 +84,27 @@ more advanced topics related to media playback, but also at other forms of media processing (capture, editing, etc.). + + + +Introduction + + &INTRO; + + + + + + + About GStreamer + + + This part gives you an overview of the technologies described in + this book. + - &INTRO; + &GSTREAMER; &MOTIVATION; &CONCEPTS; @@ -242,7 +259,6 @@ &PORTING; &INTEGRATION; &LICENSING; - &WIN32; "ES;