1bd0d623fc81d3121724d27092437fd1f41f52be
[glsdk/gst-plugins-ugly0-10.git] / README
1 WHAT IT IS
2 ----------
3 This is gst-plugins, a set of plug-ins for GStreamer.
5 COMPILING FROM SOURCE
6 ---------------------
7 - make sure you compiled and at least did a test-run of GStreamer (core)
8 - check output of ./configure --help to see if any options apply to you
9 - configure the source tree:
10   - if you installed GStreamer, then do:
11       ./configure
12     If configure complains about missing GStreamer, you should try the 
13     following command:
14     $export PKG_CONFIG_PATH=prefix/lib/pkgconfig
15     where prefix should be replaced by the prefix you used to configure
16     GStreamer. (Be mindful NOT to ADD a trailing / to that option !).
17     After that, rerun ./configure. If this doesn't fix it, you have other
18     issues ;)
20   - if you didn't install GStreamer, you can still compile the plug-ins.
21     Add the path to gstreamer-uninstalled.pc (which lives in the gstreamer
22     source tree) to PKG_CONFIG_PATH
23     or run configure --with-pkg-config-path=(path to gstreamer uninstalled)
24   
25   - the output of configure will give you a list of plug-ins with external
26     dependencies (ie, depending on other libs, see below).  By no means
27     should you try to get them all built on your first run.  This is hard
28     enough as it is ;)  Resist the urge to get the most features for now.
29     It doesn't list all of the non-depending plug-ins, which get built
30     regardless (unless you explicitly asked it not to).
32 - build the tree:
33   make
34   If any plug-in causes a problem at this stage, you should re-configure
35   with --disable-(dependency)
36   and doublecheck if configure reports this plug-in as being disabled.
37   Then re-run make.
39 - install:
40   - if you installed GStreamer, and want to install the plug-ins as well, run
41       make install
42     and, as root, run
43       gst-register
44   - if you installed GStreamer, but don't want to install the plug-ins, run
45       gst-register --gst-plugin-path=.
46   - if you didn't install GStreamer, then do
47       path/to/gstreamer/tools/gst-register --gst-plugin-path=.
48       (Replace path/to/gstreamer obviously)
50 - test:
51   - run 
52      gst-launch sinesrc ! fakesink
53    and prefix gst-launch with the path to gstreamer/tools if you didn't install
54    GStreamer.
55    If this doesn't give any errors, you can abort it.  
57   - try replacing fakesink with your choice of 
58     osssink/esdsink/artsdsink/alsasink/jacksink (depending on what output
59     method you have available) and see if you hear a C tone.
61 - After this, you should look into installing an application, like
62   gst-player, gst-editor or monkey-media with rhythmbox.
64 COMPILING FROM CVS
65 ------------------
66 When building from CVS sources, you will need to run autogen.sh to generate
67 the build system files.
69 GStreamer is cutting-edge stuff.  To be a CVS developer, you need
70 what used to be considered cutting-edge tools.
72 ATM, most of us have at least these versions :
74 * autoconf      2.52    (NOT 2.52d)
75 * automake      1.5     
76 * gettext       0.11.5
77 * libtool       1.4     (NOT Gentoo's genetic failure 1.4.2)
78 * pkg-config    0.8.0
80 autogen.sh will check for these versions and complain if you don't have 
81 them.  You can also specify specific versions of automake and autoconf with
82 --with-automake and --with-autoconf
84 Check autogen.sh options by running autogen.sh --help
86 autogen.sh can pass on arguments to configure - you just need to separate them
87 from autogen.sh with -- between the two.
88 prefix has been added to autogen.sh but will be passed on to configure because
89 some build scripts like that.
90 You will probably have to pass at least --with-pkg-config-path to autogen.sh
91 to point to the CVS version of GStreamer.
93 When you have done this once, you can use autoregen.sh to re-autogen with
94 the last passed options as a handy shortcut.  Use it.
96 After the autogen.sh stage, you can follow the directions listed in
97 "COMPILING FROM SOURCE"
99 PLUG-IN DEPENDENCIES AND LICENSES
100 ---------------------------------
101 GStreamer is developed under the terms of the LGPL (see LICENSE file for 
102 details). Some of our plug-ins however rely on libraries which are available 
103 under other licenses. This means that if you are using an application which 
104 has a non-GPL compatible license (for instance a closed-source application) 
105 with GStreamer, you have to make sure not to use GPL-linked plug-ins.
106 When using GPL-linked plug-ins, GStreamer is for all practical reasons 
107 under the GPL itself. 
109 There is a LICESENSE_readme file containing licensing information on the plugins