X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=README.md;h=9d5d79bd9912c01767f21e8ed543e9b22cbe8685;hb=db450689db1c8216a059c7733e1d2d37f4b3443b;hp=b89939eedee460ef6a611fbee95edf7ba4141186;hpb=f21a06f5d2a6e7321b73c38d82a0188a77d6e1ec;p=platform%2Fupstream%2Fgstreamer.git diff --git a/README.md b/README.md index b89939e..9d5d79b 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,31 @@ -# gst-build +# GStreamer -GStreamer [meson](http://mesonbuild.com/) based repositories aggregrator. +This is GStreamer, a framework for streaming media. -Check out this module and run meson on it, and it will git clone the other -GStreamer modules as [meson subprojects](https://github.com/mesonbuild/meson/wiki/Subprojects) -and build everything in one go. Once that is done you can switch into an -uninstalled environment which allows you to easily develop and test the latest -version of GStreamer without the need to install anything or touch an existing -GStreamer system installation. +## 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 + + 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.oftc.net + +This repository contains all official modules supported by the GStreamer +community which can be found in the `subprojects/` directory. ## Getting started @@ -20,7 +38,7 @@ You can find [instructions for Windows below](#windows-prerequisites-setup). ### Install meson and ninja -Meson 0.48 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: @@ -35,72 +53,204 @@ 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: ``` -meson build/ -ninja -C build/ +meson builddir +ninja -C builddir ``` This will automatically create the `build` directory and build everything inside it. -NOTE: On Windows, you *must* run this from inside the Visual Studio command -prompt of the appropriate architecture and version. +NOTE: On Windows, you *must* run this from [inside the Visual Studio command +prompt](#running-meson-on-windows) of the appropriate architecture and version. -# Development environment +### External dependencies + +All mandatory dependencies of GStreamer are included as [meson subprojects](https://mesonbuild.com/Subprojects.html): +libintl, zlib, libffi, glib. Some optional dependencies are also included as +subprojects, such as ffmpeg, x264, json-glib, graphene, openh264, orc, etc. + +Mandatory dependencies will be automatically built if meson cannot find them on +your system using pkg-config. The same is true for optional dependencies that +are included as subprojects. You can find a full list by looking at the +`subprojects` directory. + +Plugins that need optional dependencies that aren't included can only be built +if they are provided by the system. Instructions on how to build some common +ones such as Qt5/QML are listed below. If you do not know how to provide an +optional dependency needed by a plugin, you should use [Cerbero](https://gitlab.freedesktop.org/gstreamer/cerbero/#description) +which handles this for you automatically. + +Plugins will be automatically enabled if possible, but you can ensure that +a particular plugin (especially if it has external dependencies) is built by +enabling the gstreamer repository that ships it and the plugin inside it. For +example, to enable the Qt5 plugin in the gst-plugins-good repository, you need +to run meson as follows: + +``` +meson -Dgood=enabled -Dgst-plugins-good:qt5=enabled builddir +``` -## Building the Qt5 QML plugin +This will cause Meson to error out if the plugin could not be enabled. You can +also flip the default and disable all plugins except those explicitly enabled +like so: + +``` +meson -Dauto_features=disabled -Dgstreamer:tools=enabled -Dbad=enabled -Dgst-plugins-bad:openh264=enabled +``` + +This will disable all optional features and then enable the `openh264` plugin +and the tools that ship with the core gstreamer repository: `gst-inspect-1.0`, +`gst-launch-1.0`, etc. As usual, you can change these values on a builddir that +has already been setup with `meson configure -Doption=value`. + +### Building the Qt5 QML plugin If `qmake` is not in `PATH` and pkgconfig files are not available, you can point the `QMAKE` env var to the Qt5 installation of your choosing before running `meson` as shown above. The plugin will be automatically enabled if possible, but you can ensure that -it is built by passing `-Dgst-plugins-good:qt5=enabled` to `meson`. This will -cause Meson to error out if the plugin could not be enabled. This also works -for all plugins in all GStreamer repositories. +it is built by passing `-Dgood=enabled -Dgst-plugins-good:qt5=enabled` to `meson`. -## Uninstalled environment +### Building the Intel MSDK plugin -gst-build also contains a special `uninstalled` target that lets you enter an -uninstalled development environment where you will be able to work on GStreamer -easily. You can get into that environment running: +On Linux, you need to have development files for `libmfx` installed. On +Windows, if you have the [Intel Media SDK](https://software.intel.com/en-us/media-sdk), +it will set the `INTELMEDIASDKROOT` environment variable, which will be used by +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 +shared library `gstreamer-full-1.0` will be produced and includes all enabled +GStreamer plugins and libraries. A list of libraries that needs to be exposed in +`gstreamer-full-1.0` ABI can be set using `gst-full-libraries` option. glib-2.0, +gobject-2.0 and gstreamer-1.0 are always included. ``` -ninja -C build/ uninstalled +meson --default-library=static -Dgst-full-libraries=app,video builddir ``` -If your operating system handles symlinks, built modules source code will be -available at the root of `gst-build/` for example GStreamer core will be in -`gstreamer/`. Otherwise they will be present in `subprojects/`. You can simply -hack in there and to rebuild you just need to rerun `ninja -C build/`. +GStreamer *1.18* requires applications using gstreamer-full-1.0 to initialize +static plugins by calling `gst_init_static_plugins()` after `gst_init()`. That +function is defined in `gst/gstinitstaticplugins.h` header file. + +Since *1.20.0* `gst_init_static_plugins()` is called automatically by +`gst_init()` and applications must not call it manually any more. The header +file has been removed from public API. + +One can use the `gst-full-version-script` option to pass a +[version script](https://www.gnu.org/software/gnulib/manual/html_node/LD-Version-Scripts.html) +to the linker. This can be used to control the exact symbols that are exported by +the gstreamer-full library, allowing the linker to garbage collect unused code +and so reduce the total library size. A default script `gstreamer-full-default.map` +declares only glib/gstreamer symbols as public. + +One can use the `gst-full-plugins` option to pass a list of plugins to be registered +in the gstreamer-full library. The default value is '*' which means that all the plugins selected +during the build process will be registered statically. An empty value will prevent any plugins to +be registered. + +One can select a specific set of features with `gst-full-elements`, `gst-full-typefind-functions`, `gst-full-device-providers` or `gst-full-dynamic-types` to select specific feature from a plugin. +When a feature has been listed in one of those options, the other features from its plugin will no longer be automatically included, even if the plugin is listed in `gst-full-plugins`. + +The user must insure that all selected plugins and features (element, typefind, etc.) have been +enabled during the build configuration. + +To register features, the syntax is the following: +plugins are separated by ';' and features from a plugin starts after ':' and are ',' separated. -NOTE: In the uninstalled environment, a fully usable prefix is also configured -in `gst-build/prefix` where you can install any extra dependency/project. +As an example: + * `-Dgst-full-plugins=coreelements;playback;typefindfunctions;alsa;pbtypes`: enable only `coreelements`, `playback`, `typefindfunctions`, `alsa`, `pbtypes` plugins. + * `-Dgst-full-elements=coreelements:filesrc,fakesink,identity;alsa:alsasrc`: enable only `filesrc`, `identity` and `fakesink` elements from `coreelements` and `alsasrc` element from `alsa` plugin. + * `-Dgst-full-typefind-functions=typefindfunctions:wav,flv`: enable only typefind func `wav` and `flv` from `typefindfunctions` + * `-Dgst-full-device-providers=alsa:alsadeviceprovider`: enable `alsadeviceprovider` from `alsa`. + * `-Dgst-full-dynamic-types=pbtypes:video_multiview_flagset`: enable `video_multiview_flagset` from `pbtypes -## Update git subprojects +All features from the `playback` plugin will be enabled and the other plugins will be restricted to the specific features requested. -We added a special `update` target to update subprojects (it uses `git pull ---rebase` meaning you should always make sure the branches you work on are -following the right upstream branch, you can set it with `git branch ---set-upstream-to origin/master` if you are working on `gst-build` master -branch). +All the selected features will be registered into a dedicated `NULL` plugin name. -Update all GStreamer modules and rebuild: +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 incompatible changes could still be +made in the future. + +# Development environment + +## Development environment target + +GStreamer also contains a special `devenv` target that lets you enter an +development environment where you will be able to work on GStreamer +easily. You can get into that environment running: ``` -ninja -C build/ update +ninja -C builddir devenv ``` -Update all GStreamer modules without rebuilding: +If your operating system handles symlinks, built modules source code will be +available at the root for example GStreamer core will be in +`gstreamer/`. Otherwise they will be present in `subprojects/`. You can simply +hack in there and to rebuild you just need to rerun `ninja -C builddir`. + +NOTE: In the development environment, a fully usable prefix is also configured +in `gstreamer/prefix` where you can install any extra dependency/project. + +An external script can be run in development environment with: ``` -ninja -C build/ git-update +./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 @@ -128,55 +278,42 @@ meson test -C build To list all available tests: ``` -meson test -C build --list +meson test -C builddir --list ``` To run all the tests of a specific component: ``` -meson test -C build --suite gst-plugins-base +meson test -C builddir --suite gst-plugins-base ``` Or to run a specific test file: ``` -meson test -C build/ --suite gstreamer gst_gstbuffer +meson test -C builddir --suite gstreamer gst_gstbuffer ``` Run a specific test from a specific test file: ``` -GST_CHECKS=test_subbuffer meson test -C build/ --suite gstreamer gst_gstbuffer +GST_CHECKS=test_subbuffer meson test -C builddir --suite gstreamer gst_gstbuffer ``` ## Optional Installation -`gst-build` has been created primarily for [uninstalled usage](#uninstalled-environment), -but you can also install everything that is built into a predetermined prefix like so: +You can also install everything that is built into a predetermined prefix like +so: ``` -meson --prefix=/path/to/install/prefix build/ -ninja -C build/ -meson install -C build/ +meson --prefix=/path/to/install/prefix builddir +ninja -C builddir +meson install -C builddir ``` Note that the installed files have `RPATH` stripped, so you will need to set `LD_LIBRARY_PATH`, `DYLD_LIBRARY_PATH`, or `PATH` as appropriate for your platform for things to work. -## Checkout another branch using worktrees - -If you need to have several versions of GStreamer coexisting (eg. `master` and `1.14`), -you can use the `checkout-branch-worktree` script provided by `gst-build`. It allows you -to create a new `gst-build` environment with new checkout of all the GStreamer modules as -[git worktrees](https://git-scm.com/docs/git-worktree). - -For example to get a fresh checkout of `gst-1.14` from a `gst-build` in master already -built in a `build` directory you can simply run: - -``` -./checkout-branch-worktree ../gst-1.14 1.14 -C build/ -``` ## Add information about GStreamer development environment in your prompt line @@ -184,7 +321,10 @@ built in a `build` directory you can simply run: We automatically handle `bash` and set `$PS1` accordingly. -If the automatic `$PS1` override is not desired (maybe you have a fancy custom prompt), set the `$GST_BUILD_DISABLE_PS1_OVERRIDE` environment variable to `TRUE` and use `$GST_ENV` when setting the custom prompt, for example with a snippet like the following: +If the automatic `$PS1` override is not desired (maybe you have a fancy custom +prompt), set the `$GST_BUILD_DISABLE_PS1_OVERRIDE` environment variable to +`TRUE` and use `$GST_ENV` when setting the custom prompt, for example with a +snippet like the following: ```bash ... @@ -193,25 +333,6 @@ then PS1+="[ ${GST_ENV} ]" fi ... - -``` - -### Zsh prompt - -In your `.zshrc`, you should add something like: - -``` -export PROMPT="$GST_ENV-$PROMPT" -``` - -### Fish prompt - -In your `~/.config/fish/functions/fish_prompt.fish`, you should add something like this at the end of the fish_prompt function body: - -``` -if set -q GST_ENV - echo -n -s (set_color -b blue white) "(" (basename "$GST_ENV") ")" (set_color normal) " " -end ``` ### Using powerline @@ -268,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: @@ -279,3 +400,77 @@ pip3 install meson 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. + +### Running Meson on Windows + +At present, to build with Visual Studio, you need to run Meson from inside the +VS 2019 command prompt. Press `Start`, and search for `VS 2019`, and click on +`x64 Native Tools Command Prompt for VS 2019`, or a prompt named similar to +that: + +![x64 Native Tools Command Prompt for VS 2019](/data/images/vs-2019-dev-prompt.png) + +**ARM64 native only**: Since Visual Studio might not install dedicated command +prompt for native ARM64 build, you might need to run `vcvarsx86_arm64.bat` on CMD. +Please refer to [this document](https://docs.microsoft.com/en-us/cpp/build/building-on-the-command-line?view=vs-2019#developer_command_file_locations) + +### Setup a mingw/wine based development environment on linux + +#### Install wine and mingw + +##### On fedora x64 + +``` sh +sudo dnf install mingw64-gcc mingw64-gcc-c++ mingw64-pkg-config mingw64-winpthreads wine +``` + +FIXME: Figure out what needs to be installed on other distros + +#### Get meson from git + +This simplifies the process and allows us to use the cross files +defined in meson itself. + +``` sh +git clone https://github.com/mesonbuild/meson.git +``` + +#### Build and install + +``` +BUILDDIR=$PWD/winebuild/ +export WINEPREFIX=$BUILDDIR/wine-prefix/ && mkdir -p $WINEPREFIX +# 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 this is not in the development environment. + +#### The development environment + +You can get into the development environment the usual way: + +``` +ninja -C $BUILDDIR/ devenv +``` + +Alternatively, if you'd rather not start a shell in your workflow, you +can mutate the current environment into a suitable state like so: + +``` +gst-env.py --only-environment +``` + +This will print output suitable for an sh-compatible `eval` function, +just like `ssh-agent -s`. + +After setting up [binfmt] to use wine for windows binaries, +you can run GStreamer tools under wine by running: + +``` +gst-launch-1.0.exe videotestsrc ! glimagesink +``` + +[binfmt]: http://man7.org/linux/man-pages/man5/binfmt.d.5.html