GStreamer: Difference between revisions
imported>Malteneuss Initial working gstreamer flake |
mNo edit summary |
||
| (17 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
[https://gstreamer.freedesktop.org/ GStreamer] is a popular multimedia framework to handle a variety of video and audio formats on different platforms in a uniform way through a powerful and convenient API in order to build multimedia apps, video/audio editors and streaming services. It consists of a huge amount low-level plugins like "videotestsrc", "videoconvert" and "autovideosink" as well as a few higher level test-and-combine framework tools like "gst-inspect", "gst-launch" etc. | |||
{ | |||
== Installing via nixpkgs == | |||
In Nix as in other Linux distributions those tools and plugins are split into separate packages, which you can bring together with a custom Nix shell environment: | |||
{{File|3={ | |||
description = "A GStreamer development flake"; | description = "A GStreamer development flake"; | ||
| Line 14: | Line 18: | ||
# Common plugins like "filesrc" to combine within e.g. gst-launch | # Common plugins like "filesrc" to combine within e.g. gst-launch | ||
gst_all_1.gst-plugins-base | gst_all_1.gst-plugins-base | ||
# Specialized plugins separated by quality | |||
gst_all_1.gst-plugins-good | gst_all_1.gst-plugins-good | ||
gst_all_1.gst-plugins-bad | gst_all_1.gst-plugins-bad | ||
| Line 21: | Line 26: | ||
# Support the Video Audio (Hardware) Acceleration API | # Support the Video Audio (Hardware) Acceleration API | ||
gst_all_1.gst-vaapi | gst_all_1.gst-vaapi | ||
#... | |||
]; | ]; | ||
}; | }; | ||
}; | }; | ||
} | }|name=/etc/nixos/flake.nix|lang=nix}} | ||
To activate this environment in your terminal run | |||
<syntaxhighlight lang="nix"> | |||
$ nix develop | |||
</syntaxhighlight> | </syntaxhighlight> | ||
You can find all available Nix package names through the [https://search.nixos.org/packages?query=gst_all_1. Nix search page]. | |||
== Test the installation == | |||
You can test that the <code>gst_all_1.gstreamer</code> tools are available by running a dummy pipeline | You can test that the <code>gst_all_1.gstreamer</code> tools are available by running a dummy pipeline | ||
<syntaxhighlight lang="nix"> | <syntaxhighlight lang="nix"> | ||
gst-launch-1.0 videotestsrc ! videoconvert ! autovideosink | $ gst-launch-1.0 videotestsrc ! videoconvert ! autovideosink | ||
</syntaxhighlight> | </syntaxhighlight> | ||
which should open a colored video window. | which should open a colored video window. | ||
You can test that the plugins like from <code>gst_all_1.gst-plugins-base</code> are | You can test that the plugins like from <code>gst_all_1.gst-plugins-base</code> are available to the higher level tools by inspecting such a base plugin like <code>filesrc</code> with | ||
<syntaxhighlight lang="nix"> | |||
$ gst-inspect-1.0 filesrc | |||
Factory Details: | |||
... | |||
Long-name File Source | |||
Description Read from arbitrary point in a file | |||
... | |||
Plugin Details: | |||
Name coreelements | |||
Description GStreamer core elements | |||
Filename /nix/store/p39g1.../libgstcoreelements.so | |||
... | |||
</syntaxhighlight> | |||
or by using it in a pipeline. Here, we could play a video from the local machine with | |||
<syntaxhighlight lang="nix"> | |||
$ gst-launch-1.0 filesrc location=my_video.mp4 ! videoconvert ! autovideosink | |||
</syntaxhighlight> | |||
If the plugins are not correctly made available to the higher level tools, you'll get an error | |||
<syntaxhighlight lang="nix"> | <syntaxhighlight lang="nix"> | ||
gst- | $ gst-inspect-1.0 filesrc | ||
No such element or plugin 'filesrc' | |||
</syntaxhighlight> | |||
== Troubleshooting == | |||
==== erroneous pipeline: no element "filesrc" ==== | |||
In some cases while creating a shell using "mkShell" or "writeShellApplication" just setting the "runtimeInputs" is not enough. It's necessary to manually set the "GST_PLUGIN_SYSTEM_PATH_1_0" environment variable.<ref>https://discourse.nixos.org/t/how-to-use-gst-plugins/6345</ref> | |||
Adding the following export to your script, sets "gstreamer" and "gst-plugins-base" and "gst-plugins-good" paths. Similarly you can add any other "gst-plugins" package as well. | |||
<syntaxhighlight lang="shell"> | |||
export GST_PLUGIN_SYSTEM_PATH_1_0="${gst_all_1.gstreamer.out}/lib/gstreamer-1.0:${gst_all_1.gst-plugins-base}/lib/gstreamer-1.0:${gst_all_1.gst-plugins-good}/lib/gstreamer-1.0" | |||
</syntaxhighlight>Note: "gstreamer.out" is the derivative that contains "/lib" directory for that package. | |||
<references /> | |||
==== nautilus: "Your GStreamer installation is missing a plug-in." ==== | |||
[[File:Screenshot From 2025-03-28 09-58-50.png|thumb|nautilus: "Your GStreamer installation is missing a plug-in."]] | |||
To fix the issue I found the following solutions: | |||
* Using <code>nix-shell</code>:<syntaxhighlight lang="bash"> | |||
nix-shell -p gst_all_1.gstreamer gst_all_1.gst-plugins-base gst_all_1.gst-plugins-good gst_all_1.gst-plugins-bad gst_all_1.gst-plugins-ugly gst_all_1.gst-libav gst_all_1.gst-vaapi --run "nautilus" | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*Using the environment variable "<code>GST_PLUGIN_PATH</code>":[[File:Screenshot From 2025-03-28 12-51-31.png|thumb|"Audio and Video Properties" of "Properties" window of nautilus after fix]]{{File|3={ config, pkgs, ... }: | |||
{ | |||
environment.systemPackages = with pkgs; [ | |||
gst_all_1.gstreamer | |||
gst_all_1.gst-plugins-base | |||
gst_all_1.gst-plugins-good | |||
gst_all_1.gst-plugins-bad | |||
gst_all_1.gst-plugins-ugly | |||
gst_all_1.gst-libav | |||
gst_all_1.gst-vaapi | |||
]; | |||
environment.variables = { | |||
GST_PLUGIN_PATH = "/run/current-system/sw/lib/gstreamer-1.0/"; | |||
}; | |||
}|name=/etc/nixos/configuration.nix|lang=nix}} {{Evaluate|boot}} | |||
[[Category:Video]] | |||
[[Category:Audio]] | |||