View source for Setting a GStreamer Alternative Environment

{{#seo:
|title=How To Set Up a GStreamer Alternative Environment.
|title_mode=replace
|description={{{description|Learn how to set up a GStreamer alternative environment by reading this simple guide today. Setting up a GStreamer alternative environment has a variety of advantages.}}}
}}

{{NVIDIA & NXP logo and RR Contact}}
<br>
<td>
{{GStreamer debug}}
</td>

== Overview ==

This guide describes the steps necessary to set up an alternative GStreamer environment on your machine. There are several reasons you might want to do this:
* Building and using the newest version
* Having multiple versions alongside
* Installing in a non-standard location
* Avoiding conflicts with the system's default one

== Install GStreamer below version 1.16 ==

=== Dependencies ===

You'll need the following dependencies:

<syntaxhighlight lang="bash">
sudo apt-get install \
pkg-config bison flex git \
libglib2.0-dev liborc-0.4-dev \
libtool autopoint autoconf \
gettext yasm
</syntaxhighlight>

Additionally, install the packages in [[Setting_a_GStreamer_Alternative_Environment#Optional_Dependencies|Optional Dependencies]] if you wish to enable the construction of plug-ins with external dependencies.

=== Building the Environment ===

For this example, I'm going to build the latest available version. At this point its 1.16, from a Git perspective "master" will always point to the latest.

<syntaxhighlight lang="bash">
#Download and grant execution permissions
wget https://raw.githubusercontent.com/GStreamer/gstreamer/1.16/scripts/create-uninstalled-setup.sh
chmod ug+rx create-uninstalled-setup.sh

#Execute the script. 
#By default, the script downloads the environment to ~/gst
#By default, the script downloads the master branch
./create-uninstalled-setup.sh

#Switch to the new environment
cd ~/gst/
./gst-master

#Build the environment

for module in `echo gstreamer gst-plugins-base gst-plugins-good gst-plugins-bad gst-plugins-ugly gst-libav`; do
    cd $module
    ./autogen.sh --disable-gtk-doc --disable-tests --disable-nls && make -j8
    cd -
done
 
#Leave the environment
exit
cd ~/gst/
</syntaxhighlight>

=== Using the Environment ===

You'll find each version you downloaded as a set of scripts and directories. To switch to the environment run the following:

<syntaxhighlight lang="bash">
cd ~/gst

#Select your version, this example uses master
./gst-master

#Use the new gstreamer!
gst-launch-1.0 --gst-version

#When finished, exit the session to return to normality 
exit
</syntaxhighlight>

In this special environment, all the paths are configured to point to the appropriate plugins.

=== Customizing the environment ===

==== Changing the version ====

Modify the BRANCH variable in the '''create-uninstalled-setup.sh''' to the desired version. For example:
* BRANCH=master
* BRANCH=1.8
* BRANCH=1.4

New versions don't require a new area, since they are stored in different directories within the original area

==== Changing the location of the build ====

Modify the UNINSTALLED_ROOT variable in the '''create-uninstalled-setup.sh'''. After creating the area, you'll also need to modify the MYGST variable in the '''gst-master''' script (or whatever version you've downloaded)

==== Path considerations when using JetPack and Jetson platforms ====

If the environment doesn't recognize your new GStreamer version, it could be for the way that JetPack handles the $PATH and $LD_LIBRARY_PATH libraries. You can solve this issue by modifying the end of the '''~/.bashrc''' file inside your Jetson platform as follows:

<syntaxhighlight lang="bash">
export PATH=$PATH:/usr/local/cuda-9.0/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/snap/bin
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/cuda-9.0/lib64:
</syntaxhighlight>

=== Optional Dependencies ===

The following dependencies are optional, and if installed will enable the construction of the associated plug-ins. For example, if '''libx264-dev''' is installed, '''x264enc''' will be built.

<syntaxhighlight lang="bash">
# For gst-plugins-base
sudo apt install libasound2-dev libcdparanoia-dev libvorbisidec-dev libvisual-0.4-dev libopus-dev libpango1.0-dev libxv-dev

# For gst-plugins-good
sudo apt install libavc1394-dev libaa1-dev libcaca-dev libcairo2-dev libdv4-dev libflac-dev libgdk-pixbuf2.0-dev libjack-dev libjpeg9-dev libpng-dev libpulse-dev libshout3-dev libsoup2.4-dev libspeex-dev libtaglib-cil-dev libwavpack-dev libx11-dev

</syntaxhighlight>

== GStreamer-1.16 through GStreamer-1.19 non-invasive method - gst-build ==

=== Building the environment ===

'''1.''' Create a directory to download and install all GStreamer packages

{{Ambox
|type=notice
|small=left
|issue= '''Note:''' Set the GST_VERSION according to your needs, supported values are between 1.16-1.19
|style=width:unset;
}}

<syntaxhighlight lang="bash">
GST_VERSION=1.16
mkdir -p /home/$USER/gst-$GST_VERSION
cd /home/$USER/gst-$GST_VERSION
</syntaxhighlight>

'''2.''' Install dependencies

<syntaxhighlight lang="bash">
git clone https://github.com/GStreamer/gst-build
cd gst-build
git checkout origin/$GST_VERSION
meson builddir
ninja -C builddir
</syntaxhighlight>

=== Using the environment ===
{{Ambox
|type=notice
|small=left
|issue='''Note:'''Now, this is an awesome way to use a GStreamer version just in your current terminal:
|style=width:unset;
}}

<syntaxhighlight lang="bash">
cd builddir
ninja devenv # use uninstalled in 1.16
</syntaxhighlight>

To check your version use:

<syntaxhighlight lang="bash">
gst-launch-1.0 --gst-version
</syntaxhighlight>

If you want to leave this environment use the: 

<syntaxhighlight lang="bash">
exit
</syntaxhighlight>

Every time you need to use this version you have to repeat these steps, and adjust the GST_VERSION (1.16-1.19):

<syntaxhighlight lang="bash">
GST_VERSION=1.16
cd /home/$USER/gst-$GST_VERSION/gst-build/builddir
ninja devenv
</syntaxhighlight>

{{Ambox
|type=notice
|small=left
|issue='''Note:''' Some dependencies needed for certain plugins will not be automatically installed. It is recommended to check the 'REQUIREMENTS' file in the 'gst-plugins' directories for uninstalled optional libraries. These files also specify for which plugin each library is for. Once the preferred optional libraries are installed, run the following commands (from the gst-build/builddir directory) again:
|style=width:unset;
}}

<syntaxhighlight lang="bash">
meson builddir
ninja -C builddir
</syntaxhighlight>

{{ContactUs}}

[[Category:GStreamer]]