gst-python-example

This repository demostrates how to use gstreamer by Python Binding. There is very few documentation about gstreamer. The most code and launch description written here are learned (or guessed) based on gstreamer C examples, e.g., rtsp C example, and then tested.

Installation

The installation steps are learned from How to install Gstreamer Python Bindings. The process is tested at Windows 11 + WSL2 + Ubuntu 20.04. Some tiny changes are adapted for Ubuntu 20.04.

# Install gstreamer basis
sudo apt install libgstreamer1.0-0 gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-libav gstreamer1.0-doc gstreamer1.0-tools gstreamer1.0-x gstreamer1.0-alsa gstreamer1.0-gl gstreamer1.0-gtk3 gstreamer1.0-qt5 gstreamer1.0-pulseaudio

# Install rtsp server related
sudo apt-get install libglib2.0-dev libgstrtspserver-1.0-dev gstreamer1.0-rtsp

# Install Python basis. You can replace 3.6 with any other version.
sudo apt install python3.6 python3.6-dev python-dev python3-dev python3-pip python-dev python3.6-venv

# Install gstreamer Python binding
sudo apt install autoconf automake libtool python3-gi python3-gst-1.0 libgirepository1.0-dev libcairo2-dev gir1.2-gstreamer-1.0 gir1.2-gst-rtsp-server-1.0

# Setup a virtual environment for development and testing
python3 -m venv venv

# Activate virtual environment
source venv/bin/activate

# Install python packages for gstreamer Python binding.
pip install --upgrade wheel pip setuptools
pip install pycairo PyGObject

# Verify packages installed successfully
python -c "import gi; gi.require_version('Gst', '1.0'); \
gi.require_version('GstApp', '1.0'); \
gi.require_version('GstVideo', '1.0'); \
gi.require_version('GstBase', '1.0'); \
gi.require_version('GstRtspServer', '1.0')"

Usage

`example_filesrc_to_rtsp.py`

$ python example_filesrc_to_rtsp.py
stream ready at rtsp://127.0.0.1:8554/0

# launch a new shell for testing
$ gst-launch-1.0 rtspsrc location=rtsp://localhost:8554/0 latency=0 ! decodebin ! autovideosink

# you can launch more clients
$ gst-launch-1.0 rtspsrc location=rtsp://localhost:8554/0 latency=0 ! decodebin ! autovideosink

# even switch to multiple paths, e.g, /0 and /1
$ gst-launch-1.0 rtspsrc location=rtsp://localhost:8554/1 latency=0 ! decodebin ! autovideosink

The testing video sample-mp4-file-small.mp4 is downloaded from 11 Sample video files | MP4 sample download. Please do NOT use or distribute it for other purposes.

Tip

debugging

If your program doesn't work well, please set GST_DEBUG environment variable for logging some levels of information to stdout.

# basic
$ GST_DEBUG=1 python gst_rtsp_server_2.py

# verbose
$ GST_DEBUG=6 python gst_rtsp_server_2.py

# verbose and python logging only
$ GST_DEBUG=python:6 python gst_rtsp_server_2.py

multifilesrc

multifilesrc doesn't support video file in a loop way. As long as your location is a video file, the playback will be teminated after EOS (even you set loop=true). For the reason, please read a professional answer by Keivan looping-a-video-with-gstreamer-and-gst-launch.

foreverfaint / gst-python-example