X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=README.md;h=9d5d79bd9912c01767f21e8ed543e9b22cbe8685;hb=f4d0537b3e3e930b2f421bb8d8de21f474af89de;hp=7b70161f6348ee3674733a427f73ed576c718123;hpb=f33e6655a3ed3ab44c8b3bab3ec3f94014b34b05;p=platform%2Fupstream%2Fgstreamer.git diff --git a/README.md b/README.md index 7b70161..9d5d79b 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ 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 +You can join us on IRC - #gstreamer on irc.oftc.net This repository contains all official modules supported by the GStreamer community which can be found in the `subprojects/` directory. @@ -38,9 +38,7 @@ You can find [instructions for Windows below](#windows-prerequisites-setup). ### Install meson and ninja -Meson 0.52 or newer is required. - -For cross-compilation Meson 0.54 or newer is required. +Meson 0.59 or newer is required. On Linux and macOS you can get meson through your package manager or using: @@ -55,6 +53,20 @@ binary in your PATH. You can find [instructions for Windows below](#windows-prerequisites-setup). + +On macOS, you might need to execute "Install Certificates.command" from the +Python folder in the user Applications folder: + +``` +$ /Applications/Python\ 3.*/Install\ Certificates.command +``` + +Otherwise you will get this error when downloading meson wraps: + +``` +urllib.error.URLError: urlopen error [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed +``` + ### Build GStreamer and its modules You can get all GStreamer built running: @@ -129,6 +141,30 @@ the build files to find `libmfx`. The plugin will be automatically enabled if possible, but you can ensure it by passing `-Dbad=enabled -Dgst-plugins-bad:msdk=enabled` to `meson`. +### Building plugins with (A)GPL-licensed dependencies + +Some plugins have GPL- or AGPL-licensed dependencies and will only be built +if you have explicitly opted in to allow (A)GPL-licensed dependencies by +passing `-Dgpl=enabled` to Meson. + +List of plugins with (A)GPL-licensed dependencies (non-exhaustive) in gst-plugins-bad: + - dts (DTS audio decoder plugin) + - faad (Free AAC audio decoder plugin) + - iqa (Image quality assessment plugin based on dssim-c) + - mpeg2enc (MPEG-2 video encoder plugin) + - mplex (audio/video multiplexer plugin) + - ofa (Open Fingerprint Architecture library plugin) + - resindvd (Resin DVD playback plugin) + - x265 (HEVC/H.265 video encoder plugin) + +List of plugins with (A)GPL-licensed dependencies (non-exhaustive) in gst-plugins-ugly: + - a52dec (Dolby Digital (AC-3) audio decoder plugin) + - cdio (CD audio source plugin based on libcdio) + - dvdread (DVD video source plugin based on libdvdread) + - mpeg2dec (MPEG-2 video decoder plugin based on libmpeg2) + - sidplay (Commodore 64 audio decoder plugin based on libsidplay) + - x264 (H.264 video encoder plugin based on libx264) + ### Static build Since *1.18.0* when doing a static build using `--default-library=static`, a @@ -183,7 +219,7 @@ All the selected features will be registered into a dedicated `NULL` plugin name This will cause the features/plugins that are not registered to not be included in the final gstreamer-full library. -This is an experimental feature, backward uncompatible changes could still be +This is an experimental feature, backward incompatible changes could still be made in the future. # Development environment @@ -212,6 +248,9 @@ An external script can be run in development environment with: ./gst-env.py external_script.sh ``` +For more extensive documentation about the development environment go to [the +documentation](https://gstreamer.freedesktop.org/documentation/installing/building-from-source-using-meson.html). + ## Custom subprojects We also added a meson option, `custom_subprojects`, that allows the user @@ -350,7 +389,7 @@ and place it into `PATH`. ### Meson on Windows **IMPORTANT**: Do not use the Meson MSI installer since it is experimental and known to not -work with `gst-build`. +work with `GStreamer`. You can use `pip3` to install Meson, same as Ninja above: @@ -362,12 +401,6 @@ Note that Meson is written entirely in Python, so you can also run it as-is from the [git repository](https://github.com/mesonbuild/meson/) if you want to use the latest master branch for some reason. -**ARM64 native only**: You might need -[native upstream ARM64 support fix](https://github.com/mesonbuild/meson/pull/7432) -which is expected to be a part of Meson 0.55.1. -If your Meson package version which was installed via `pip3` is lower than 0.55.1, -then you need to use [the latest master branch](https://github.com/mesonbuild/meson/). - ### Running Meson on Windows At present, to build with Visual Studio, you need to run Meson from inside the @@ -407,13 +440,13 @@ git clone https://github.com/mesonbuild/meson.git ``` BUILDDIR=$PWD/winebuild/ export WINEPREFIX=$BUILDDIR/wine-prefix/ && mkdir -p $WINEPREFIX -# Setting the prefix is mandatory as it is used to setup symlinks during uninstalled development +# Setting the prefix is mandatory as it is used to setup symlinks within the development environment meson/meson.py $BUILDDIR --cross-file meson/cross/linux-mingw-w64-64bit.txt -Dgst-plugins-bad:vulkan=disabled -Dorc:gtk_doc=disabled --prefix=$BUILDDIR/wininstall/ -Djson-glib:gtk_doc=disabled meson/meson.py install -C $BUILDDIR/ ``` > __NOTE__: You should use `meson install -C $BUILDDIR` each time you make a change -> instead of the usual `ninja -C build` as the environment is not uninstalled. +> instead of the usual `ninja -C build` as this is not in the development environment. #### The development environment