X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=README;h=08b2e1b7457d7f80e80cc08768e391cc2d9c661d;hb=ce43de86902c4e9c8ed4e9682602664cb9bce2ee;hp=5d518ea15af12298fdab1d576fd8687ce246588a;hpb=072a88408d93a1849d08516e783e60afb596ba1a;p=platform%2Fupstream%2Fgstreamer.git diff --git a/README b/README index 5d518ea..08b2e1b 100644 --- a/README +++ b/README @@ -1,13 +1,30 @@ +GStreamer 1.16.x stable series + WHAT IT IS ---------- + This is GStreamer, a framework for streaming media. -This package is in the 0.9.x series. This means that this is a -development series leading up to a stable 0.10.x series. -You have been warned. +WHERE TO START +-------------- + +We have a website at +http://gstreamer.freedesktop.org/ + +You should start by going through our FAQ at +http://gstreamer.freedesktop.org/data/doc/gstreamer/head/faq/html/ + +There is more documentation; go to +http://gstreamer.freedesktop.org/documentation + +You can subscribe to our mailing lists; see the website for details. -GStreamer 0.9 development series - Hung by a Thread ---------------------------------------------------- +We track bugs in GNOME's bugzilla; see the website for details. + +You can join us on IRC - #gstreamer on irc.freenode.org + +GStreamer 1.0 series +-------------------- Starring @@ -116,8 +133,22 @@ set of available plug-ins into four modules: 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 +- FreeBSD is reported to work; other BSDs should work too +- Solaris is reported to work; a specific sunaudiosink plugin has been written +- MacOSX works, binary 1.x packages can be built using the cerbero build tool +- Windows works; binary 1.x packages can be built using the cerbero build tool + - MSys/MinGW builds + - Microsoft Visual Studio builds are not yet available or supported +- Android works, binary 1.x packages can be built using the cerbero build tool +- iOS works + INSTALLING FROM PACKAGES ------------------------ + You should always prefer installing from packages first. GStreamer is well-maintained for a number of distributions, including Fedora, Debian, Ubuntu, Mandrake, Gentoo, ... @@ -126,13 +157,14 @@ Only in cases where you: - want to hack on GStreamer - want to verify that a bug has been fixed - do not have a sane distribution -should you choose to build from source tarballs or CVS. +should you choose to build from source tarballs or git. Find more information about the various packages at http://gstreamer.freedesktop.org/download/ COMPILING FROM SOURCE TARBALLS ------------------------------ + - again, make sure that you really need to install from source ! If GStreamer is one of your first projects ever that you build from source, consider taking on an easier project. @@ -143,34 +175,31 @@ COMPILING FROM SOURCE TARBALLS make to build GStreamer. -- if you want to install it (not required), run +- if you want to install it (not required, but what you usually want to do), run make install -- You should create a registry for things to work. - If you ran make install in the previous step, run - gst-register - as root. - - If you didn't install, run - tools/gst-register - as a normal user. - try out a simple test: - gst-launch fakesrc num_buffers=5 ! fakesink - (If you didn't install GStreamer, again prefix gst-launch with tools/) + gst-launch -v fakesrc num_buffers=5 ! fakesink + (If you didn't install GStreamer, prefix gst-launch with tools/) 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. -COMPILING FROM CVS +COMPILING FROM GIT ------------------ -When building from CVS sources, you will need to run autogen.sh to generate + +When building from git sources, you will need to run autogen.sh to generate the build system files. -You will need a set of additional tools typical for building from CVS, +You will need a set of additional tools typical for building from git, including: - autoconf - automake @@ -182,10 +211,7 @@ them. You can also specify specific versions of automake and autoconf with Check autogen.sh options by running autogen.sh --help -autogen.sh can pass on arguments to configure - you just need to separate them -from autogen.sh with -- between the two. -prefix has been added to autogen.sh but will be passed on to configure because -some build scripts like that. +autogen.sh can pass on arguments to configure When you have done this once, you can use autoregen.sh to re-autogen with the last passed options as a handy shortcut. Use it. @@ -193,22 +219,34 @@ the last passed options as a handy shortcut. Use it. After the autogen.sh stage, you can follow the directions listed in "COMPILING FROM SOURCE" -You can also run your whole cvs stack uninstalled. The script in -the gstreamer module /docs/faq/gst-uninstalled) is helpful in setting -up your environment for this. +You can also run your whole git stack uninstalled in your home directory, +so that you can quickly test changes without affecting your system setup or +interfering with GStreamer installed from packages. Many GStreamer developers +use an uninstalled setup for their work. + +There is a 'create-uninstalled-setup.sh' script in + + http://cgit.freedesktop.org/gstreamer/gstreamer/tree/scripts/ + +to easily create an uninstalled setup from scratch. + PLUG-IN DEPENDENCIES AND LICENSES --------------------------------- -GStreamer is developed under the terms of the LGPL (see LICENSE file for + +GStreamer is developed under the terms of the LGPL (see COPYING file for details). Some of our plug-ins however rely on libraries which are available -under other licenses. This means that if you are using an application which -has a non-GPL compatible license (for instance a closed-source application) -with GStreamer, you have to make sure not to use GPL-linked plug-ins. +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 ------- + 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