source: multimedia/libdriv/gst10-plugins-bad.xml

trunk
Last change on this file was 17c4d8d, checked in by Bruce Dubbs <bdubbs@…>, 5 days ago

Update the gstreamer stack to 1.24.2.

  • Property mode set to 100644
File size: 12.4 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY gst10-plugins-bad-download-http
8 "&gstreamer-dl;/gst-plugins-bad/gst-plugins-bad-&gst10-plugins-bad-version;.tar.xz">
9 <!ENTITY gst10-plugins-bad-download-ftp " ">
10 <!ENTITY gst10-plugins-bad-md5sum "06d6a2472a4dfa441f3220890736c474">
11 <!ENTITY gst10-plugins-bad-size "6.7 MB">
12 <!ENTITY gst10-plugins-bad-buildsize "187 MB (with tests)">
13 <!ENTITY gst10-plugins-bad-time "1.0 SBU (Using parallelism=4; with tests)">
14]>
15
16<sect1 id="gst10-plugins-bad" xreflabel="gst-plugins-bad-&gst10-plugins-bad-version;">
17 <?dbhtml filename="gst10-plugins-bad.html"?>
18
19
20 <title>gst-plugins-bad-&gst10-plugins-bad-version;</title>
21
22 <indexterm zone="gst10-plugins-bad">
23 <primary sortas="a-gst-plugins-bad">gst-plugins-bad</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to GStreamer Bad Plug-ins</title>
28
29 <para>
30 The <application>GStreamer Bad Plug-ins</application> package contains a
31 set of plug-ins that aren't up to par compared to the rest. They
32 might be close to being good quality, but they're missing something - be
33 it a good code review, some documentation, a set of tests, a real live
34 maintainer, or some actual wide use.
35 </para>
36
37 &lfs121_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&gst10-plugins-bad-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&gst10-plugins-bad-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &gst10-plugins-bad-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &gst10-plugins-bad-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &gst10-plugins-bad-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &gst10-plugins-bad-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">GStreamer Bad Plug-ins Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required">
77 <xref linkend="gst10-plugins-base"/>
78 </para>
79
80 <!-- Common formats, output and input codecs and requirements
81 for GNOME apps. What's a multimedia framework useful if it
82 can't be used to play anything (common)? -->
83 <bridgehead renderas="sect4">Recommended</bridgehead>
84 <para role="recommended">
85 <xref linkend="libdvdread"/>,
86 <xref linkend="libdvdnav"/>, and
87 <xref linkend="soundtouch"/>
88 </para>
89
90 <bridgehead renderas="sect4">Optional</bridgehead>
91 <para role="optional">
92 <xref linkend="bluez"/>,
93 <xref linkend="curl"/>,
94 <xref linkend="faac"/>,
95 <xref linkend="faad2"/>,
96 <xref linkend="fdk-aac"/>,
97 <xref linkend="gtk3"/> (for examples),
98 <xref linkend="gst10-plugins-good"/> (for one test),
99 <xref linkend="json-glib"/>,
100 <xref linkend="lcms2"/>,
101 <xref linkend="libaom"/>,
102 <xref linkend="libass"/>,
103 <xref linkend="libexif"/> (for one test),
104 <xref linkend="librsvg"/>,
105 <xref linkend="libsoup"/> (for one test),
106 <xref linkend="libsndfile"/>,
107 <xref linkend="libssh2"/>,
108 <xref linkend="libusb"/>,
109 <xref linkend="libva"/>,
110 <xref linkend="libwebp"/>,
111 <xref linkend="libxkbcommon"/>,
112 <xref linkend="neon"/>,
113 <xref linkend="nettle"/> or <xref linkend="libgcrypt"/>
114 (for SSL support in the hls plugin, if both are not installed OpenSSL will
115 be used instead),
116 <xref linkend="opencv"/> (with additional modules),
117 <xref linkend="openjpeg2"/>,
118 <xref linkend="opus"/>,
119 <xref linkend="qrencode"/>,
120 <xref linkend="sbc"/>,
121 <xref linkend="sdl"/>,
122 <xref linkend="valgrind"/>,
123 both <xref linkend="vulkan-loader"/> and
124 <ulink url='https://github.com/google/shaderc'>glslc</ulink>
125 (for Vulkan plugin),
126 <xref linkend="wayland"/> (<xref linkend="gtk3"/> must have been
127 compiled with wayland support),
128 <xref linkend="x265"/>,
129 <!--<ulink url="https://aomedia.googlesource.com/aom/">aom</ulink>,-->
130 <ulink url="https://bs2b.sourceforge.net/">bs2b</ulink>,
131 <ulink url="https://acoustid.org/chromaprint">Chromaprint</ulink>,
132 <ulink url="https://github.com/kornelski/dssim">dssim</ulink>,
133 <ulink url="https://github.com/festvox/flite">Flite</ulink>,
134 <ulink url="https://www.fluidsynth.org/">FluidSynth</ulink>,
135 <ulink url="https://bitbucket.org/mpyne/game-music-emu/">Game Music Emu</ulink>,
136 <ulink url="https://www.quut.com/gsm/">GSM</ulink>,
137 <ulink url="https://pypi.org/project/hotdoc/">hotdoc</ulink>,
138 <ulink url="https://www.ladspa.org/">LADSPA</ulink>,
139 <ulink url="https://github.com/EHfive/ldacBT">ldacBT</ulink>,
140 <ulink url="https://github.com/aja-video/libajantv2">libajantv2</ulink>,
141 <ulink url="https://github.com/AVnu/libavtp">libavtp</ulink>,
142 <ulink url="https://sourceforge.net/projects/libdc1394/files/libdc1394-2/">libdc1394-2</ulink>,
143 <ulink url="https://www.videolan.org/developers/libdca.html">libdca</ulink>,
144 <ulink url="https://www.libde265.org">libde265</ulink>,
145 <ulink url="https://code.google.com/archive/p/libkate/">libkate</ulink>,
146 <ulink url="https://github.com/Intel-Media-SDK/MediaSDK">libmfx</ulink>,
147 <ulink url="https://sourceforge.net/projects/libmms/">libmms</ulink>,
148 <ulink url="https://github.com/Konstanty/libmodplug">libmodplug</ulink>,
149 <ulink url="https://libnice.freedesktop.org/">libnice</ulink>,
150 <ulink url="https://code.google.com/p/musicip-libofa/">libofa</ulink>,
151 <ulink url="https://lib.openmpt.org/libopenmpt/">libopenmpt</ulink>,
152 <ulink url="https://structure.io/openni">libopenni</ulink>,
153 <ulink url="https://github.com/cisco/libsrtp">libsrtp</ulink>,
154 <ulink url="https://drobilla.net/software/lilv">lilv</ulink>,
155 <ulink url="https://github.com/swh/LRDF">LRDF</ulink>,
156 <ulink url="https://github.com/x42/ltc-tools">ltc-tools</ulink>,
157 <ulink url="https://github.com/videolabs/libmicrodns">microdns</ulink>,
158 <ulink url="https://mjpeg.sourceforge.net/">MJPEG Tools</ulink>,
159 <ulink url="https://snyk.io/advisor/npm-package/mplex2">mplex2</ulink>,
160 <ulink url="https://www.musepack.net/">musepack</ulink>,
161 <ulink url="https://github.com/microsoft/onnxruntime">onnxruntime</ulink>,
162 <ulink url="https://openal.org/">OpenAL</ulink>,
163 <ulink url="https://www.openexr.com/">OpenEXR</ulink>,
164 <ulink url="https://www.openh264.org/">OpenH264</ulink>,
165 <ulink url="https://gstreamer.freedesktop.org/src/orc/">Orc</ulink>,
166 <ulink url="https://rtmpdump.mplayerhq.hu/">rtmpdump</ulink>,
167 <ulink url="https://github.com/jart/spandsp">spandsp</ulink>,
168 <ulink url="https://github.com/Haivision/srt">Srt</ulink>,
169 <ulink url="https://github.com/OpenVisualCloud/SVT-HEVC/">svthevcenc</ulink>,
170 <ulink url="https://sourceforge.net/projects/opencore-amr/files/vo-aacenc/">VO AAC</ulink>,
171 <ulink url="https://sourceforge.net/projects/opencore-amr/files/vo-amrwbenc/">VO AMRWB</ulink>,
172 <!--<ulink url="https://vulkan.lunarg.com/sdk/home/">Vulkan</ulink>,-->
173 <ulink url="https://github.com/Mindwerks/wildmidi/">WildMidi</ulink>,
174 <ulink url="https://webkit.org/wpe/">WPE-WebKit</ulink>,
175 <ulink url="https://github.com/Igalia/WPEBackend-fdo">WPEBackend-fdo</ulink>,
176 <ulink url="https://zbar.sourceforge.net/">ZBAR</ulink>,
177 <ulink url="https://zapping.sourceforge.net/ZVBI/index.html/">ZVBI</ulink>, and
178 <ulink url="https://github.com/zxing/zxing">zxing</ulink>
179 </para>
180
181 </sect2>
182
183 <sect2 role="installation">
184 <title>Installation of GStreamer Bad Plug-ins</title>
185 <!--
186 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
187 href="../../xincludes/gst10-objc-error.xml"/>
188 -->
189 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
190 href="../../xincludes/gst10-plugins.xml"/>
191
192 <para>
193 Install <application>GStreamer Bad Plug-ins</application> by running the
194 following commands:
195 </para>
196
197<screen><userinput>mkdir build &amp;&amp;
198cd build &amp;&amp;
199
200meson setup .. \
201 --prefix=/usr \
202 --buildtype=release \
203 -D gpl=enabled &amp;&amp;
204ninja</userinput></screen>
205
206 <para>
207 To test the results, issue: <command>ninja test</command>. Several tests
208 need a terminal emulator in a graphical session. Three tests,
209 <emphasis>elements_vacompositor</emphasis>,
210 <emphasis>elements_vapostproc</emphasis>, and
211 <emphasis>elements_dash_mpd</emphasis>, are known to fail.
212 <!-- Upstream issue is https://gitlab.freedesktop.org/gstreamer/gstreamer/-/issues/3124 -->
213
214 <!-- Upstream issue gst-plugins-bad/#1426 -->
215 If <xref linkend='gst10-plugins-good'/> is not installed, two tests
216 <emphasis>elements_rtpsrc</emphasis> and
217 <emphasis>elements_rtpsink</emphasis> will fail.
218 </para>
219
220 <para>
221 Now, as the <systemitem class="username">root</systemitem> user:
222 </para>
223
224<screen role="root"><userinput>ninja install</userinput></screen>
225 </sect2>
226
227 <sect2 role="commands">
228 <title>Command Explanations</title>
229
230 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
231 href="../../xincludes/meson-buildtype-release.xml"/>
232
233 <para>
234 <parameter>-Dgpl=enabled</parameter>: Without this switch, plugins with
235 dependencies on (A)GPL licensed libraries are not built.
236 </para>
237 </sect2>
238
239 <sect2 role="content">
240 <title>Contents</title>
241
242 <segmentedlist>
243 <segtitle>Installed Programs</segtitle>
244 <segtitle>Installed Libraries</segtitle>
245 <segtitle>Installed Directories</segtitle>
246
247 <seglistitem>
248 <seg>
249 gst-transcoder-1.0 and
250 playout
251 </seg>
252 <seg>
253 libgstadaptivedemux-1.0.so,
254 libgstanalytics-1.0.so,
255 libgstbadaudio-1.0.so,
256 libgstbasecamerabinsrc-1.0.so,
257 libgstcuda-1.0.so,
258 libgstcodecparsers-1.0.so,
259 libgstcodecs-1.0.so,
260 libgstdxva-1.0.so,
261 libgstinsertbin-1.0.so,
262 libgstisoff-1.0.so,
263 libgstmpegts-1.0.so,
264 libgstmse-1.0.so,
265 libgstphotography-1.0.so,
266 libgstplay-1.0.so,
267 libgstplayer-1.0.so,
268 libgstsctp-1.0.so,
269 libgsttranscoder-1.0.so,
270 libgsturidownloader-1.0.so,
271 libgstva-1.0.so,
272 libgstwayland-1.0.so,
273 libgstwebrtc-1.0.so, and
274 several plugins under /usr/lib/gstreamer-1.0
275 </seg>
276 <seg>
277 /usr/include/gstreamer-1.0/gst/{audio,basecamerabinsrc,cuda},
278 /usr/include/gstreamer-1.0/gst/{codecparsers,insertbin,interfaces},
279 /usr/include/gstreamer-1.0/gst/{isoff,mpegts,play,player,sctp}
280 /usr/include/gstreamer-1.0/gst/{transcoder,uridownloader,va}, and
281 /usr/include/gstreamer-1.0/gst/{wayland,webrtc}
282 </seg>
283 </seglistitem>
284 </segmentedlist>
285
286 <variablelist>
287 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
288 <?dbfo list-presentation="list"?>
289 <?dbhtml list-presentation="table"?>
290
291 <varlistentry id="gst-transcoder-1.0">
292 <term><command>gst-transcoder-1.0</command></term>
293 <listitem>
294 <para>
295 is used to transcode a stream into a different format
296 </para>
297 <indexterm zone="gst10-plugins-bad gst-transcoder-1.0">
298 <primary sortas="b-gst-transcoder-1.0">gst-transcoder-1.0</primary>
299 </indexterm>
300 </listitem>
301 </varlistentry>
302
303 <varlistentry id="playout">
304 <term><command>playout</command></term>
305 <listitem>
306 <para>
307 is an example application used to sequentially play a list of
308 audio-video files
309 </para>
310 <indexterm zone="gst10-plugins-bad playout">
311 <primary sortas="b-playout">playout</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 </variablelist>
317
318 </sect2>
319
320</sect1>
Note: See TracBrowser for help on using the repository browser.