source: multimedia/libdriv/pipewire.xml@ 9bd10279

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 9bd10279 was 9bd10279, checked in by Douglas R. Reno <renodr@…>, 22 months ago

Update to pipewire-0.3.1 (major modifications)
Update to gsetttings-desktop-schemas-3.36.0
Update to glib-networking-2.64.0
Update to libsoup-2.70.0

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22894 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 12.4 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
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 pipewire-download-http "https://github.com/PipeWire/pipewire/archive/&pipewire-version;/pipewire-&pipewire-version;.tar.gz">
8 <!ENTITY pipewire-download-ftp " ">
9 <!ENTITY pipewire-md5sum "5e08984fda2f62b2c2bbc12c6391ff3e">
10 <!ENTITY pipewire-size "860 KB">
11 <!ENTITY pipewire-buildsize "98 MB">
12 <!ENTITY pipewire-time "0.3 SBU (Using parallelism=4)">
13]>
14
15<sect1 id="pipewire" xreflabel="pipewire-&pipewire-version;">
16 <?dbhtml filename="pipewire.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Pipewire-&pipewire-version;</title>
24
25 <indexterm zone="pipewire">
26 <primary sortas="a-pipewire">pipewire</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Pipewire</title>
31
32 <para>
33 The <application>pipewire</application> package contains a server and
34 user-space API to handle multimedia pipelines. This includes a universal
35 API to connect to multimedia devices, as well as sharing multimedia
36 files between applications.
37 </para>
38
39 &lfs91_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&pipewire-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&pipewire-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &pipewire-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &pipewire-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &pipewire-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &pipewire-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Pipewire Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="bluez"/>,
80 <xref linkend="ffmpeg"/>,
81 <xref linkend="gstreamer10"/>,
82 <xref linkend="gst10-plugins-base"/>,
83 <xref linkend="libva"/>,
84 <xref linkend="sbc"/>,
85 <xref linkend="sdl2"/>, and
86 <xref linkend="v4l-utils"/>
87 </para>
88
89 <bridgehead renderas="sect4">Optional</bridgehead>
90 <para role="optional">
91 <xref linkend="valgrind"/>,
92 <xref linkend="doxygen"/> and
93 <xref linkend="graphviz"/> (for documentation),
94 <ulink url="https://jackaudio.org/">JACK</ulink>,
95 <ulink url="https://vulkan.lunarg.com/sdk/home/">Vulkan</ulink>, and
96 <ulink url="https://sourceforge.net/projects/xmltoman/">xmltoman</ulink>
97 </para>
98
99 <para condition="html" role="usernotes">
100 User Notes: <ulink url="&blfs-wiki;/pipewire"/>
101 </para>
102 </sect2>
103
104 <sect2 role="installation">
105 <title>Installation of Pipewire</title>
106
107 <para>
108 Install <application>pipewire</application> by running the following
109 commands:
110 </para>
111
112<screen><userinput>mkdir build &amp;&amp;
113cd build &amp;&amp;
114
115meson --prefix=/usr \
116 --sysconfdir=/etc \
117 -Djack=false \
118 -Dpipewire-jack=false \
119 -Dvulkan=false \
120 .. &amp;&amp;
121ninja</userinput></screen>
122
123 <para>
124 This package does not come with a test suite.
125 </para>
126
127 <para>
128 Now, as the <systemitem class="username">root</systemitem> user:
129 </para>
130
131<screen role="root"><userinput>ninja install</userinput></screen>
132 </sect2>
133
134 <sect2 role="commands">
135 <title>Command Explanations</title>
136
137 <!-- Without these three parameters, Meson fails to run. -->
138 <para>
139 <parameter>-Djack=false</parameter>: This switch prevents building the
140 <application>JACK</application> plugin since
141 <application>JACK</application> is not in BLFS.
142 </para>
143
144 <para>
145 <parameter>-Dpipewire-jack=false</parameter>: This switch prevents
146 building <application>JACK</application> support into pipewire since
147 <application>JACK</application> is not in BLFS.
148 </para>
149
150 <para>
151 <parameter>-Dvulkan=false</parameter>: This switch prevents building
152 <application>Vulkan</application> API support into pipewire since
153 <application>Vulkan</application> is not in BLFS.
154 </para>
155
156 <para>
157 <option>-Ddocs=true</option>: This switch enables the generation of HTML
158 documentation. The optional dependencies for documentation need to be
159 installed for this to work.
160 </para>
161
162 <para>
163 <option>-Dman=true</option>: This switch enables the generation of manual
164 pages. The optional dependencies for documentation need to be installed
165 for this to work.
166 </para>
167 </sect2>
168
169 <sect2 role="content">
170 <title>Contents</title>
171
172 <segmentedlist>
173 <segtitle>Installed Programs</segtitle>
174 <segtitle>Installed Libraries</segtitle>
175 <segtitle>Installed Directories</segtitle>
176
177 <seglistitem>
178 <seg>
179 pipewire,
180 pipewire-media-session,
181 pw-cat,
182 pw-cli,
183 pw-dot,
184 pw-mon,
185 pw-profiler,
186 spa-inspect,
187 spa-monitor, and
188 pw-play and pw-record (symlinks to pw-cat)
189 </seg>
190 <seg>
191 libpipewire-0.3.so,
192 libpulse-mainloop-glib-pw.so,
193 libpulse-pw.so,
194 libpulse-simple-pw.so,
195 libasound_module_pcm_pipewire.so, and
196 libgstpipewire.so
197 </seg>
198 <seg>
199 /etc/pipewire,
200 /usr/include/pipewire-0.3,
201 /usr/include/spa-0.2,
202 /usr/lib/pipewire-0.3, and
203 /usr/lib/spa-0.2
204 </seg>
205 </seglistitem>
206 </segmentedlist>
207
208 <variablelist>
209 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
210 <?dbfo list-presentation="list"?>
211 <?dbhtml list-presentation="table"?>
212
213 <varlistentry id="pipewire-prog">
214 <term><command>pipewire</command></term>
215 <listitem>
216 <para>
217 is a service that allows access to multimedia devices and allows
218 sharing of multimedia files between applications.
219 </para>
220 <indexterm zone="pipewire pipewire-prog">
221 <primary sortas="b-pipewire">pipewire</primary>
222 </indexterm>
223 </listitem>
224 </varlistentry>
225
226 <varlistentry id="pipewire-media-session">
227 <term><command>pipewire-media-session</command></term>
228 <listitem>
229 <para>
230 is a service that allows a desktop environment to know when media
231 files are being played through pipewire.
232 </para>
233 <indexterm zone="pipewire pipewire-media-session">
234 <primary sortas="b-pipewire-media-session">pipewire-media-session</primary>
235 </indexterm>
236 </listitem>
237 </varlistentry>
238
239 <varlistentry id="pw-cat">
240 <term><command>pw-cat</command></term>
241 <listitem>
242 <para>
243 allows you to play or record media using an pipewire instance.
244 </para>
245 <indexterm zone="pipewire pw-cat">
246 <primary sortas="b-pw-cat">pw-cat</primary>
247 </indexterm>
248 </listitem>
249 </varlistentry>
250
251 <varlistentry id="pw-cli">
252 <term><command>pw-cli</command></term>
253 <listitem>
254 <para>
255 allows you to interact with a pipewire instance.
256 </para>
257 <indexterm zone="pipewire pw-cli">
258 <primary sortas="b-pw-cli">pw-cli</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="pw-dot">
264 <term><command>pw-dot</command></term>
265 <listitem>
266 <para>
267 lists all of the daemons and objects in use by pipewire.
268 </para>
269 <indexterm zone="pipewire pw-dot">
270 <primary sortas="b-pw-dot">pw-dot</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="pw-mon">
276 <term><command>pw-mon</command></term>
277 <listitem>
278 <para>
279 allows you to monitor pipewire instances.
280 </para>
281 <indexterm zone="pipewire pw-mon">
282 <primary sortas="b-pw-mon">pw-mon</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="pw-profiler">
288 <term><command>pw-profiler</command></term>
289 <listitem>
290 <para>
291 tracks memory usage and API calls used by pipewire.
292 </para>
293 <indexterm zone="pipewire pw-profiler">
294 <primary sortas="b-pw-profiler">pw-profiler</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="spa-inspect">
300 <term><command>spa-inspect</command></term>
301 <listitem>
302 <para>
303 allows you to inspect pipewire plugins.
304 </para>
305 <indexterm zone="pipewire spa-inspect">
306 <primary sortas="b-spa-inspect">spa-inspect</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="spa-monitor">
312 <term><command>spa-monitor</command></term>
313 <listitem>
314 <para>
315 allows you to monitor pipewire plugins.
316 </para>
317 <indexterm zone="pipewire spa-monitor">
318 <primary sortas="b-spa-monitor">spa-monitor</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="libpipewire">
324 <term><filename class="libraryfile">libpipewire-0.3.so</filename></term>
325 <listitem>
326 <para>
327 contains API functions for handling multimedia pipelines.
328 </para>
329 <indexterm zone="pipewire libpipewire">
330 <primary sortas="c-libpipewire">libpipewire-0.3.so</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334
335 <varlistentry id="libpulse-mainloop-glib-pw">
336 <term><filename class="libraryfile">libpulse-mainloop-glib-pw.so</filename></term>
337 <listitem>
338 <para>
339 provides a glib main() loop for pulseaudio to route media through
340 pipewire.
341 </para>
342 <indexterm zone="pipewire libpulse-mainloop-glib-pw">
343 <primary sortas="c-libpulse-mainloop-glib-pw">libpulse-mainloop-glib-pw.so</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="libpulse-pw">
349 <term><filename class="libraryfile">libpulse-pw.so</filename></term>
350 <listitem>
351 <para>
352 is a pipewire plugin for pulseaudio.
353 </para>
354 <indexterm zone="pipewire libpulse-pw">
355 <primary sortas="c-libpulse-pw">libpulse-pw.so</primary>
356 </indexterm>
357 </listitem>
358 </varlistentry>
359
360 <varlistentry id="libpulse-simple-pw">
361 <term><filename class="libraryfile">libpulse-simple-pw.so</filename></term>
362 <listitem>
363 <para>
364 is a simplified version of the pulseaudio plugin for pipewire.
365 </para>
366 <indexterm zone="pipewire libpulse-simple-pw">
367 <primary sortas="c-libpulse-simple-pw">libpulse-simple-pw.so</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="libasound_module_pcm_pipewire">
373 <term><filename class="libraryfile">libasound_module_pcm_pipewire.so</filename></term>
374 <listitem>
375 <para>
376 is an ALSA plugin for pipewire.
377 </para>
378 <indexterm zone="pipewire libasound_module_pcm_pipewire">
379 <primary sortas="c-libasound_module_pcm_pipewire">libasound_module_pcm_pipewire.so</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="libgstpipewire">
385 <term><filename class="libraryfile">libgstpipewire.so</filename></term>
386 <listitem>
387 <para>
388 is a Gstreamer plugin for pipewire.
389 </para>
390 <indexterm zone="pipewire libgstpipewire">
391 <primary sortas="c-libgstpipewire">libgstpipewire.so</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395 </variablelist>
396 </sect2>
397</sect1>
Note: See TracBrowser for help on using the repository browser.