README

   1 WHAT IT IS
   2 ----------
   3
   4 This is GStreamer, a framework for streaming media.
   5
   6 This package is in the 0.9.x series.  This means that this is a
   7 development series leading up to a stable 0.10.x series.
   8 You have been warned.
   9
  10 GStreamer 0.9 development series - Hung by a Thread
  11 ---------------------------------------------------
  12
  13 Starring
  14
  15   GSTREAMER
  16
  17 The core around which all other modules revolve.  Base functionality and
  18 libraries, some essential elements, documentation, and testing.
  19
  20   BASE
  21
  22 A well-groomed and well-maintained collection of GStreamer plug-ins and
  23 elements, spanning the range of possible types of elements one would want
  24 to write for GStreamer.
  25
  26 And introducing, for the first time ever, on the development screen ...
  27
  28   THE GOOD
  29
  30  --- "Such ingratitude.  After all the times I've saved your life."
  31
  32 A collection of plug-ins you'd want to have right next to you on the
  33 battlefield.  Shooting sharp and making no mistakes, these plug-ins have it
  34 all: good looks, good code, and good licensing.  Documented and dressed up
  35 in tests.  If you're looking for a role model to base your own plug-in on,
  36 here it is.
  37
  38 If you find a plot hole or a badly lip-synced line of code in them,
  39 let us know - it is a matter of honour for us to ensure Blondie doesn't look
  40 like he's been walking 100 miles through the desert without water.
  41
  42   THE UGLY
  43
  44   --- "When you have to shoot, shoot.  Don't talk."
  45
  46 There are times when the world needs a color between black and white.
  47 Quality code to match the good's, but two-timing, backstabbing and ready to
  48 sell your freedom down the river.  These plug-ins might have a patent noose
  49 around their neck, or a lock-up license, or any other problem that makes you
  50 think twice about shipping them.
  51
  52 We don't call them ugly because we like them less.  Does a mother love her
  53 son less because he's not as pretty as the other ones ? No  - she commends
  54 him on his great personality.  These plug-ins are the life of the party.
  55 And we'll still step in and set them straight if you report any unacceptable
  56 behaviour - because there are two kinds of people in the world, my friend:
  57 those with a rope around their neck and the people who do the cutting.
  58
  59   THE BAD
  60
  61   --- "That an accusation?"
  62
  63 No perfectly groomed moustache or any amount of fine clothing is going to
  64 cover up the truth - these plug-ins are Bad with a capital B.
  65 They look fine on the outside, and might even appear to get the job done, but
  66 at the end of the day they're a black sheep. Without a golden-haired angel
  67 to watch over them, they'll probably land in an unmarked grave at the final
  68 showdown.
  69
  70 Don't bug us about their quality - exercise your Free Software rights,
  71 patch up the offender and send us the patch on the fastest steed you can
  72 steal from the Confederates. Because you see, in this world, there's two
  73 kinds of people, my friend: those with loaded guns and those who dig.
  74 You dig.
  75
  76 The Lowdown
  77 -----------
  78
  79   --- "I've never seen so many plug-ins wasted so badly."
  80
  81 GStreamer Plug-ins has grown so big that it's hard to separate the wheat from
  82 the chaff.  Also, distributors have brought up issues about the legal status
  83 of some of the plug-ins we ship.  To remedy this, we've divided the previous
  84 set of available plug-ins into four modules:
  85
  86 - gst-plugins-base: a small and fixed set of plug-ins, covering a wide range
  87   of possible types of elements; these are continuously kept up-to-date
  88   with any core changes during the development series.
  89
  90   - We believe distributors can safely ship these plug-ins.
  91   - People writing elements should base their code on these elements.
  92   - These elements come with examples, documentation, and regression tests.
  93
  94 - gst-plugins-good: a set of plug-ins that we consider to have good quality
  95   code, correct functionality, our preferred license (LGPL for the plug-in
  96   code, LGPL or LGPL-compatible for the supporting library).
  97
  98   - We believe distributors can safely ship these plug-ins.
  99   - People writing elements should base their code on these elements.
 100
 101 - gst-plugins-ugly: a set of plug-ins that have good quality and correct
 102   functionality, but distributing them might pose problems.  The license
 103   on either the plug-ins or the supporting libraries might not be how we'd
 104   like. The code might be widely known to present patent problems.
 105
 106   - Distributors should check if they want/can ship these plug-ins.
 107   - People writing elements should base their code on these elements.
 108
 109 - gst-plugins-bad: a set of plug-ins that aren't up to par compared to the
 110   rest.  They might be close to being good quality, but they're missing
 111   something - be it a good code review, some documentation, a set of tests,
 112   a real live maintainer, or some actual wide use.
 113   If the blanks are filled in they might be upgraded to become part of
 114   either gst-plugins-good or gst-plugins-ugly, depending on the other factors.
 115
 116   - If the plug-ins break, you can't complain - instead, you can fix the
 117     problem and send us a patch, or bribe someone into fixing them for you.
 118   - New contributors can start here for things to work on.
 119
 120 INSTALLING FROM PACKAGES
 121 ------------------------
 122
 123 You should always prefer installing from packages first.  GStreamer is
 124 well-maintained for a number of distributions, including Fedora, Debian,
 125 Ubuntu, Mandrake, Gentoo, ...
 126
 127 Only in cases where you:
 128 - want to hack on GStreamer
 129 - want to verify that a bug has been fixed
 130 - do not have a sane distribution
 131 should you choose to build from source tarballs or CVS.
 132
 133 Find more information about the various packages at
 134 http://gstreamer.freedesktop.org/download/
 135
 136 COMPILING FROM SOURCE TARBALLS
 137 ------------------------------
 138
 139 - again, make sure that you really need to install from source !
 140   If GStreamer is one of your first projects ever that you build from source,
 141   consider taking on an easier project.
 142
 143 - check output of ./configure --help to see if any options apply to you
 144 - run
 145   ./configure
 146   make
 147
 148   to build GStreamer.
 149 - if you want to install it (not required), run
 150   make install
 151 - You should create a registry for things to work.
 152   If you ran make install in the previous step, run
 153   gst-register
 154   as root.
 155
 156   If you didn't install, run
 157   tools/gst-register
 158   as a normal user.
 159
 160 - try out a simple test:
 161   gst-launch fakesrc num_buffers=5 ! fakesink
 162   (If you didn't install GStreamer, again prefix gst-launch with tools/)
 163
 164   If it outputs a bunch of messages from fakesrc and fakesink, everything is
 165   ok.
 166
 167 - After this, you're ready to install gst-plugins, which will provide the
 168   functionality you're probably looking for by now, so go on and read
 169   that README.
 170
 171 COMPILING FROM CVS
 172 ------------------
 173
 174 When building from CVS sources, you will need to run autogen.sh to generate
 175 the build system files.
 176
 177 You will need a set of additional tools typical for building from CVS,
 178 including:
 179 - autoconf
 180 - automake
 181 - libtool
 182
 183 autogen.sh will check for recent enough versions and complain if you don't have
 184 them.  You can also specify specific versions of automake and autoconf with
 185 --with-automake and --with-autoconf
 186
 187 Check autogen.sh options by running autogen.sh --help
 188
 189 autogen.sh can pass on arguments to configure - you just need to separate them
 190 from autogen.sh with -- between the two.
 191 prefix has been added to autogen.sh but will be passed on to configure because
 192 some build scripts like that.
 193
 194 When you have done this once, you can use autoregen.sh to re-autogen with
 195 the last passed options as a handy shortcut.  Use it.
 196
 197 After the autogen.sh stage, you can follow the directions listed in
 198 "COMPILING FROM SOURCE"
 199
 200 You can also run your whole cvs stack uninstalled.  The script in
 201 the gstreamer module /docs/faq/gst-uninstalled) is helpful in setting
 202 up your environment for this.
 203
 204 PLUG-IN DEPENDENCIES AND LICENSES
 205 ---------------------------------
 206
 207 GStreamer is developed under the terms of the LGPL (see LICENSE file for
 208 details). Some of our plug-ins however rely on libraries which are available
 209 under other licenses. This means that if you are using an application which
 210 has a non-GPL compatible license (for instance a closed-source application)
 211 with GStreamer, you have to make sure not to use GPL-linked plug-ins.
 212 When using GPL-linked plug-ins, GStreamer is for all practical reasons
 213 under the GPL itself.
 214
 215 HISTORY
 216 -------
 217
 218 The fundamental design comes from the video pipeline at Oregon Graduate
 219 Institute, as well as some ideas from DirectMedia.  It's based on plug-ins that
 220 will provide the various codec and other functionality.  The interface
 221 hopefully is generic enough for various companies (ahem, Apple) to release
 222 binary codecs for Linux, until such time as they get a clue and release the
 223 source.