README 8.91 KB
Newer Older
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
1
GStreamer 1.18.x stable series
2

3
4
WHAT IT IS
----------
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
5

6
This is GStreamer, a framework for streaming media.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
7

8
9
WHERE TO START
--------------
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
10

11
12
We have a website at

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
20
21
22
23
24
25
26
27
You can subscribe to our mailing lists:

  https://lists.freedesktop.org/mailman/listinfo/gstreamer-announce

  https://lists.freedesktop.org/mailman/listinfo/gstreamer-devel

We track bugs, feature requests and merge requests (patches) in GitLab at

  https://gitlab.freedesktop.org/gstreamer/
28
29
30

You can join us on IRC - #gstreamer on irc.freenode.org

31
32
GStreamer 1.0 series
--------------------
33
34
35
36
37
38
39

Starring

  GSTREAMER

The core around which all other modules revolve.  Base functionality and
libraries, some essential elements, documentation, and testing.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
40

41
  BASE
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
42

43
44
45
A well-groomed and well-maintained collection of GStreamer plug-ins and
elements, spanning the range of possible types of elements one would want
to write for GStreamer.  
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
46

47
And introducing, for the first time ever, on the development screen ...
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
48

49
50
51
  THE GOOD

 --- "Such ingratitude.  After all the times I've saved your life."
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
52

53
54
55
56
57
A collection of plug-ins you'd want to have right next to you on the
battlefield.  Shooting sharp and making no mistakes, these plug-ins have it
all: good looks, good code, and good licensing.  Documented and dressed up
in tests.  If you're looking for a role model to base your own plug-in on,
here it is.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
58

59
60
61
If you find a plot hole or a badly lip-synced line of code in them,
let us know - it is a matter of honour for us to ensure Blondie doesn't look
like he's been walking 100 miles through the desert without water.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
62

63
  THE UGLY
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
64

65
  --- "When you have to shoot, shoot.  Don't talk."
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
66

67
68
69
70
71
There are times when the world needs a color between black and white.
Quality code to match the good's, but two-timing, backstabbing and ready to
sell your freedom down the river.  These plug-ins might have a patent noose
around their neck, or a lock-up license, or any other problem that makes you
think twice about shipping them.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
72

73
74
75
76
77
78
We don't call them ugly because we like them less.  Does a mother love her
son less because he's not as pretty as the other ones ? No  - she commends
him on his great personality.  These plug-ins are the life of the party.
And we'll still step in and set them straight if you report any unacceptable
behaviour - because there are two kinds of people in the world, my friend:
those with a rope around their neck and the people who do the cutting.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
79

80
  THE BAD
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
81

82
  --- "That an accusation?"
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
83

84
85
86
87
88
89
No perfectly groomed moustache or any amount of fine clothing is going to
cover up the truth - these plug-ins are Bad with a capital B. 
They look fine on the outside, and might even appear to get the job done, but
at the end of the day they're a black sheep. Without a golden-haired angel
to watch over them, they'll probably land in an unmarked grave at the final
showdown.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
90

91
92
93
94
95
Don't bug us about their quality - exercise your Free Software rights,
patch up the offender and send us the patch on the fastest steed you can
steal from the Confederates. Because you see, in this world, there's two
kinds of people, my friend: those with loaded guns and those who dig.
You dig.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
96

97
98
The Lowdown
-----------
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
99

100
  --- "I've never seen so many plug-ins wasted so badly."
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
101

102
103
104
105
GStreamer Plug-ins has grown so big that it's hard to separate the wheat from
the chaff.  Also, distributors have brought up issues about the legal status
of some of the plug-ins we ship.  To remedy this, we've divided the previous
set of available plug-ins into four modules:
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
106

107
108
109
- gst-plugins-base: a small and fixed set of plug-ins, covering a wide range
  of possible types of elements; these are continuously kept up-to-date
  with any core changes during the development series.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
110

111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
  - We believe distributors can safely ship these plug-ins.
  - People writing elements should base their code on these elements.
  - These elements come with examples, documentation, and regression tests.

- gst-plugins-good: a set of plug-ins that we consider to have good quality
  code, correct functionality, our preferred license (LGPL for the plug-in
  code, LGPL or LGPL-compatible for the supporting library).

  - We believe distributors can safely ship these plug-ins.
  - People writing elements should base their code on these elements.
 
- gst-plugins-ugly: a set of plug-ins that have good quality and correct
  functionality, but distributing them might pose problems.  The license
  on either the plug-ins or the supporting libraries might not be how we'd
  like. The code might be widely known to present patent problems.

  - Distributors should check if they want/can ship these plug-ins.
  - People writing elements should base their code on these elements.

- gst-plugins-bad: a set of plug-ins that aren't up to par compared to the
  rest.  They might be close to being good quality, but they're missing
  something - be it a good code review, some documentation, a set of tests,
  a real live maintainer, or some actual wide use.
  If the blanks are filled in they might be upgraded to become part of
  either gst-plugins-good or gst-plugins-ugly, depending on the other factors.

  - If the plug-ins break, you can't complain - instead, you can fix the
    problem and send us a patch, or bribe someone into fixing them for you.
  - New contributors can start here for things to work on.

PLATFORMS
---------

- Linux is of course fully supported
145
146
- FreeBSD is reported to work; other BSDs should work too; same for Solaris
- MacOS works, binary 1.x packages can be built using the cerbero build tool
147
148
- Windows works; binary 1.x packages can be built using the cerbero build tool
  - MSys/MinGW builds
149
  - Microsoft Visual Studio builds are also available and supported
150
151
- Android works, binary 1.x packages can be built using the cerbero build tool
- iOS works
152
153
154
155
156
157

INSTALLING FROM PACKAGES
------------------------

You should always prefer installing from packages first.  GStreamer is
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
163
164
165

 - want to hack on GStreamer
 - want to verify that a bug has been fixed
 - do not have a sane distribution

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
173
174

COMPILING FROM SOURCE TARBALLS
------------------------------

175
- again, make sure that you really need to install from source!
176
177
178
  If GStreamer is one of your first projects ever that you build from source,
  consider taking on an easier project.

179
180
181
182
183
184
185
186
- you need a recent version of Meson installed, see

    http://mesonbuild.com/Getting-meson.html

  and

    https://gitlab.freedesktop.org/gstreamer/gst-build/blob/master/README.md

187
- run
188
189
190

    meson build
    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
200
  gst-launch-1.0 -v fakesrc num_buffers=5 ! fakesink
  (If you didn't install GStreamer, run `./build/tools/gst-launch-1.0`)
201
202
203
204
205
206
207
208
209
210
211
212

  If it outputs a bunch of messages from fakesrc and fakesink, everything is
  ok.

  If it did not work, keep in mind that you might need to adjust the
  PATH and/or LD_LIBRARY_PATH environment variables to make the system
  find GStreamer in the prefix where you installed (by default that is /usr/local).

- After this, you're ready to install gst-plugins, which will provide the
  functionality you're probably looking for by now, so go on and read
  that README.

213
COMPILING FROM GIT
214
215
------------------

216
217
You can build an uninstalled GStreamer from git for development or testing
purposes without affecting your system installation.
218

219
Get started with:
220

221
222
223
224
    git clone https://gitlab.freedesktop.org/gstreamer/gst-build
    meson build
    ninja -C build
    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
232
233

PLUG-IN DEPENDENCIES AND LICENSES
---------------------------------

234
GStreamer is developed under the terms of the LGPL (see COPYING file for
235
236
237
238
239
240
241
242
243
244
245
details). Some of our plug-ins however rely on libraries which are available
under other licenses. This means that if you are distributing an application
which has a non-GPL compatible license (for instance a closed-source
application) with GStreamer, you have to make sure not to distribute GPL-linked
plug-ins.

When using GPL-linked plug-ins, GStreamer is for all practical reasons
under the GPL itself.

HISTORY
-------
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
246

247
248
249
250
251
252
The fundamental design comes from the video pipeline at Oregon Graduate
Institute, as well as some ideas from DirectMedia.  It's based on plug-ins that
will provide the various codec and other functionality.  The interface
hopefully is generic enough for various companies (ahem, Apple) to release
binary codecs for Linux, until such time as they get a clue and release the
source.