View source for How to Run GStreamer in a Docker Container

= How to Run GStreamer in Docker =

This tutorial shows you how to install and use '''GStreamer''' inside a '''Docker container''' on '''Ubuntu 22.04'''. We'll build a minimal Docker image with support for '''x264enc''', then run a simple test pipeline to encode video to an MP4 file.

== Step 1: Create a Dockerfile with GStreamer and x264enc ==

Create a file named <code>Dockerfile</code> with the following contents:

<syntaxhighlight lang="dockerfile">
FROM ubuntu:22.04

ENV DEBIAN_FRONTEND=noninteractive

# Install GStreamer with x264 support and minimal required tools
RUN apt-get update && apt-get install -y \
    libgstreamer1.0-dev \
    libgstreamer-plugins-base1.0-dev \
    libgstreamer-plugins-bad1.0-dev \
    gstreamer1.0-plugins-base \
    gstreamer1.0-plugins-good \
    gstreamer1.0-plugins-bad \
    gstreamer1.0-plugins-ugly \
    gstreamer1.0-libav \
    gstreamer1.0-tools \
    gstreamer1.0-x \
    gstreamer1.0-alsa \
    gstreamer1.0-gl \
    gstreamer1.0-gtk3 \
    gstreamer1.0-qt5 \
    gstreamer1.0-pulseaudio \
    libx264-dev \
    && rm -rf /var/lib/apt/lists/*

CMD [ "tail", "-F", "/dev/null" ]
</syntaxhighlight>

This Dockerfile installs a complete GStreamer stack along with the necessary packages to support <code>x264enc</code>, allowing you to encode H.264 video streams.

== Step 2: Build the Docker image ==

Use the following command to build the Docker image and tag it as <code>gstreamer-test</code>:

<syntaxhighlight lang="bash">
docker build -t gstreamer-test .
</syntaxhighlight>

== Step 3: Start the GStreamer container in the background ==

Run the container in detached mode and give it a name:

<syntaxhighlight lang="bash">
docker run -d --name gstreamer-test gstreamer-test
</syntaxhighlight>

== Step 4: Run a sample GStreamer pipeline inside the container ==

Use the following GStreamer command to generate a test video, encode it with x264, and save it as an MP4 file:

<syntaxhighlight lang="bash">
gst-launch-1.0 videotestsrc num-buffers=300 is-live=true ! video/x-raw,width=640,height=480,framerate=30/1 ! x264enc ! mp4mux ! filesink location=output.mp4
</syntaxhighlight>

This will create a short 10-second video called <code>output.mp4</code> using GStreamer's built-in <code>videotestsrc</code> source.

== Step 5: Exit the container ==

After the pipeline finishes, you can exit the container shell:

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

== Step 6: Copy the video output to the host system ==

Transfer the generated MP4 file from the container to your local system:

<syntaxhighlight lang="bash">
docker cp gstreamer-test:/output.mp4 ./output.mp4
</syntaxhighlight>

== Step 7: Preview the video on your host machine ==

Open <code>output.mp4</code> with any media player that supports MP4 and H.264, such as VLC or your system's default video player.

== Conclusion ==

You've successfully created a Dockerized GStreamer environment with x264 encoding support. This is useful for rapid prototyping of pipelines, isolated testing, or running GStreamer apps on systems without native installations.

For more GStreamer examples, pipeline debugging tips, or Docker use cases in embedded systems, explore our other tutorials.

{{Footer}}