openh264enc: fix broken sps/pps header generation

[platform/upstream/gstreamer.git] / README

diff --git a/README b/README
index caec7d3..c95e53e 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,35 @@
+GStreamer 1.19.x development series
+

 WHAT IT IS
 ----------
 WHAT IT IS
 ----------

-This is GStreamer Bad Plug-ins.

 
 

-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.
+This is GStreamer, a framework for streaming media.
+
+WHERE TO START
+--------------
+
+We have a website at
+
+  https://gstreamer.freedesktop.org
+
+Our documentation, including tutorials, API reference and FAQ can be found at
+
+  https://gstreamer.freedesktop.org/documentation/
+
+You can subscribe to our mailing lists:
+
+  https://lists.freedesktop.org/mailman/listinfo/gstreamer-announce

 
 

-GStreamer 0.9 development series - Hung by a Thread
----------------------------------------------------
+  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/
+
+You can join us on IRC - #gstreamer on irc.freenode.org
+
+GStreamer 1.0 series
+--------------------

 
 Starring
 
 
 Starring
 


@@ -116,99 +138,112 @@ 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.
 
     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; same for Solaris
+- MacOS 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 also available and supported
+- Android works, binary 1.x packages can be built using the cerbero build tool
+- iOS works
+

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

+

 You should always prefer installing from packages first.  GStreamer is
 well-maintained for a number of distributions, including Fedora, Debian,
 You should always prefer installing from packages first.  GStreamer is
 well-maintained for a number of distributions, including Fedora, Debian,

-Ubuntu, Mandrake, Gentoo, ...
+Ubuntu, Mandrake, Arch Linux, Gentoo, ...

 
 Only in cases where you:
 
 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.
+
+ - 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 git.

 
 Find more information about the various packages at
 
 Find more information about the various packages at

-http://gstreamer.freedesktop.org/download/
+
+  https://gstreamer.freedesktop.org/download/

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

-- again, make sure that you really need to install from source !
+
+- 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.
 
   If GStreamer is one of your first projects ever that you build from source,
   consider taking on an easier project.
 

-- check output of ./configure --help to see if any options apply to you
+- 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
+

 - run
 - run

-  ./configure
-  make
+
+    meson build
+    ninja -C build

 
   to build GStreamer.
 
   to build GStreamer.

-- if you want to install it (not required), 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.
+- if you want to install it (not required, but what you usually want to do), run
+
+    ninja -C build install

 
 - try out a simple test:
 
 - 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-1.0 -v fakesrc num_buffers=5 ! fakesink
+  (If you didn't install GStreamer, run `./build/tools/gst-launch-1.0`)

 
   If it outputs a bunch of messages from fakesrc and fakesink, everything is
   ok.
 
 
   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.
 
 - 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 
-the build system files.
-
-You will need a set of additional tools typical for building from CVS,
-including:
-- autoconf
-- automake
-- libtool

 
 

-autogen.sh will check for recent enough versions and complain if you don't have
-them.  You can also specify specific versions of automake and autoconf with
---with-automake and --with-autoconf
+You can build an uninstalled GStreamer from git for development or testing
+purposes without affecting your system installation.

 
 

-Check autogen.sh options by running autogen.sh --help
+Get started with:

 
 

-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.
+    git clone https://gitlab.freedesktop.org/gstreamer/gst-build
+    meson build
+    ninja -C build
+    ninja -C build uninstalled

 
 

-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.
+For more information, see the `gst-build` module and its documentation:

 
 

-After the autogen.sh stage, you can follow the directions listed in
-"COMPILING FROM SOURCE"
+  https://gitlab.freedesktop.org/gstreamer/gst-build/blob/master/README.md

 
 

-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.

 
 PLUG-IN DEPENDENCIES AND LICENSES
 ---------------------------------
 
 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
 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
 -------
 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
 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