README

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