README

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