source: multimedia/libdriv/pipewire.xml@ 7c9ae62

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

Update to guile-3.0.5
Update to pipewire-0.3.19
Update to qpdf-10.1.0

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

  • Property mode set to 100644
File size: 16.8 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 "2107281ae24b3f022c43b358ca8bfc58">
10 <!ENTITY pipewire-size "1.2 MB">
11 <!ENTITY pipewire-buildsize "122 MB (with tests)">
12 <!ENTITY pipewire-time "0.4 SBU (Using parallelism=4; with tests)">
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 &lfs10_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="pulseaudio"/>,
85 <xref linkend="sbc"/>,
86 <xref linkend="sdl2"/>, and
87 <xref linkend="v4l-utils"/>
88 </para>
89
90 <bridgehead renderas="sect4">Optional</bridgehead>
91 <para role="optional">
92 <xref linkend="valgrind"/>,
93 <xref linkend="doxygen"/> and
94 <xref linkend="graphviz"/> (for documentation),
95 <ulink url="https://jackaudio.org/">JACK</ulink>,
96 <ulink url="https://vulkan.lunarg.com/sdk/home/">Vulkan</ulink>, and
97 <ulink url="https://sourceforge.net/projects/xmltoman/">xmltoman</ulink>
98 </para>
99
100 <para condition="html" role="usernotes">
101 User Notes: <ulink url="&blfs-wiki;/pipewire"/>
102 </para>
103 </sect2>
104
105 <sect2 role="installation">
106 <title>Installation of Pipewire</title>
107
108 <para>
109 Install <application>pipewire</application> by running the following
110 commands:
111 </para>
112
113<screen><userinput>mkdir build &amp;&amp;
114cd build &amp;&amp;
115
116meson --prefix=/usr \
117 -Djack=false \
118 -Dpipewire-jack=false \
119 -Dvulkan=false \
120 .. &amp;&amp;
121ninja</userinput></screen>
122
123 <para>
124 To test the result, issue: <command>ninja test</command>.
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 pipewire-pulse,
182 pw-cat,
183 pw-cli,
184 pw-dot,
185 pw-dump,
186 pw-metadata,
187 pw-mididump,
188 pw-mon,
189 pw-profiler,
190 <!--pw-pulse,-->
191 pw-reserve,
192 pw-top,
193 spa-acp-tool,
194 spa-inspect,
195 spa-monitor,
196 spa-resample, and
197 pw-midiplay, pw-midirecord, pw-play, and pw-record (symlinks to pw-cat)
198 </seg>
199 <seg>
200 libpipewire-0.3.so and
201 30 modules below /usr/lib/pipewire-0.3<!--,
202 [pierre July 29th, 2020]: all the following libs are in subdirectories
203 of /usr/lib. I'm not sure they should appear. But if they should, there
204 are many more libs to list...
205 libpulse-mainloop-glib-pw.so,
206 libpulse.so,
207 libpulse-simple.so,
208 libasound_module_pcm_pipewire.so, and
209 libgstpipewire.so
210 [bdubbs Sep 29th, 2020]: add
211 libpipewire-module-{access,adapter,client-device,client-node,
212 link-factory,metadata,portal,profiler,protocol-native,
213 rtkit,session-manager,spa-device,spa-device-factory,spa-node,
214 spa-node-factory}.so
215 libasound_module_ctl_pipewire.so
216 libasound_module_pcm_pipewire.so
217 libspa-{alsa,audioconvert,audiomixer,bluez5,control,dbus,support
218 v4l2,videoconvert}.so
219 -->
220 </seg>
221 <seg>
222 /etc/pipewire,
223 /usr/include/pipewire-0.3,
224 /usr/include/spa-0.2,
225 /usr/lib/alsa-lib,
226 /usr/lib/gstreamer-1.0,
227 /usr/lib/pipewire-0.3, and
228 /usr/lib/spa-0.2
229 </seg>
230 </seglistitem>
231 </segmentedlist>
232
233 <variablelist>
234 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
235 <?dbfo list-presentation="list"?>
236 <?dbhtml list-presentation="table"?>
237
238 <varlistentry id="pipewire-prog">
239 <term><command>pipewire</command></term>
240 <listitem>
241 <para>
242 is a service that allows access to multimedia devices and allows
243 sharing of multimedia files between applications.
244 </para>
245 <indexterm zone="pipewire pipewire-prog">
246 <primary sortas="b-pipewire">pipewire</primary>
247 </indexterm>
248 </listitem>
249 </varlistentry>
250
251 <varlistentry id="pipewire-media-session">
252 <term><command>pipewire-media-session</command></term>
253 <listitem>
254 <para>
255 is a service that allows a desktop environment to know when media
256 files are being played through pipewire.
257 </para>
258 <indexterm zone="pipewire pipewire-media-session">
259 <primary sortas="b-pipewire-media-session">pipewire-media-session</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="pipewire-pulse">
265 <term><command>pipewire-pulse</command></term>
266 <listitem>
267 <para>
268 starts a Pulseaudio-compatible version of
269 the pipewire service.
270 </para>
271 <indexterm zone="pipewire pipewire-pulse">
272 <primary sortas="b-pipewire-pulse">pipewire-pulse</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry id="pw-cat">
278 <term><command>pw-cat</command></term>
279 <listitem>
280 <para>
281 allows you to play or record media using a pipewire instance.
282 </para>
283 <indexterm zone="pipewire pw-cat">
284 <primary sortas="b-pw-cat">pw-cat</primary>
285 </indexterm>
286 </listitem>
287 </varlistentry>
288
289 <varlistentry id="pw-cli">
290 <term><command>pw-cli</command></term>
291 <listitem>
292 <para>
293 allows you to interact with a pipewire instance.
294 </para>
295 <indexterm zone="pipewire pw-cli">
296 <primary sortas="b-pw-cli">pw-cli</primary>
297 </indexterm>
298 </listitem>
299 </varlistentry>
300
301 <varlistentry id="pw-dot">
302 <term><command>pw-dot</command></term>
303 <listitem>
304 <para>
305 lists all of the daemons and objects in use by pipewire.
306 </para>
307 <indexterm zone="pipewire pw-dot">
308 <primary sortas="b-pw-dot">pw-dot</primary>
309 </indexterm>
310 </listitem>
311 </varlistentry>
312
313 <varlistentry id="pw-dump">
314 <term><command>pw-dump</command></term>
315 <listitem>
316 <para>
317 dumps debug messages from a local or remote pipewire instance to
318 the console.
319 </para>
320 <indexterm zone="pipewire pw-dump">
321 <primary sortas="b-pw-dump">pw-dump</primary>
322 </indexterm>
323 </listitem>
324 </varlistentry>
325
326 <varlistentry id="pw-metadata">
327 <term><command>pw-metadata</command></term>
328 <listitem>
329 <para>
330 inspects, adds, and removes metadata for objects.
331 </para>
332 <indexterm zone="pipewire pw-metadata">
333 <primary sortas="b-pw-metadata">pw-metadata</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="pw-mididump">
339 <term><command>pw-mididump</command></term>
340 <listitem>
341 <para>
342 dumps MIDI messages from a file to the screen.
343 </para>
344 <indexterm zone="pipewire pw-mididump">
345 <primary sortas="b-pw-mididump">pw-mididump</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="pw-mon">
351 <term><command>pw-mon</command></term>
352 <listitem>
353 <para>
354 allows you to monitor pipewire instances.
355 </para>
356 <indexterm zone="pipewire pw-mon">
357 <primary sortas="b-pw-mon">pw-mon</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="pw-profiler">
363 <term><command>pw-profiler</command></term>
364 <listitem>
365 <para>
366 tracks memory usage and API calls used by pipewire.
367 </para>
368 <indexterm zone="pipewire pw-profiler">
369 <primary sortas="b-pw-profiler">pw-profiler</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374<!--
375 <varlistentry id="pw-pulse">
376 <term><command>pw-pulse</command></term>
377 <listitem>
378 <para>
379 runs Pulseaudio applications on pipewire.
380 </para>
381 <indexterm zone="pipewire pw-pulse">
382 <primary sortas="b-pw-pulse">pw-pulse</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386-->
387
388 <varlistentry id="pw-reserve">
389 <term><command>pw-reserve</command></term>
390 <listitem>
391 <para>
392 reserves or monitors a device via D-Bus.
393 </para>
394 <indexterm zone="pipewire pw-reserve">
395 <primary sortas="b-pw-reserve">pw-reserve</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="pw-top">
401 <term><command>pw-top</command></term>
402 <listitem>
403 <para>
404 displays real-time performance information from pipewire.
405 </para>
406 <indexterm zone="pipewire pw-top">
407 <primary sortas="b-pw-top">pw-top</primary>
408 </indexterm>
409 </listitem>
410 </varlistentry>
411
412 <varlistentry id="spa-acp-tool">
413 <term><command>spa-acp-tool</command></term>
414 <listitem>
415 <para>
416 inspects the card profile of a given sound card.
417 </para>
418 <indexterm zone="pipewire spa-acp-tool">
419 <primary sortas="b-spa-acp-tool">spa-acp-tool</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="spa-inspect">
425 <term><command>spa-inspect</command></term>
426 <listitem>
427 <para>
428 allows you to inspect pipewire plugins.
429 </para>
430 <indexterm zone="pipewire spa-inspect">
431 <primary sortas="b-spa-inspect">spa-inspect</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="spa-monitor">
437 <term><command>spa-monitor</command></term>
438 <listitem>
439 <para>
440 allows you to monitor pipewire plugins.
441 </para>
442 <indexterm zone="pipewire spa-monitor">
443 <primary sortas="b-spa-monitor">spa-monitor</primary>
444 </indexterm>
445 </listitem>
446 </varlistentry>
447
448 <varlistentry id="spa-resample">
449 <term><command>spa-resample</command></term>
450 <listitem>
451 <para>
452 resamples a given file.
453 </para>
454 <indexterm zone="pipewire spa-resample">
455 <primary sortas="b-spa-resample">spa-resample</primary>
456 </indexterm>
457 </listitem>
458 </varlistentry>
459
460 <varlistentry id="libpipewire">
461 <term><filename class="libraryfile">libpipewire-0.3.so</filename></term>
462 <listitem>
463 <para>
464 contains API functions for handling multimedia pipelines.
465 </para>
466 <indexterm zone="pipewire libpipewire">
467 <primary sortas="c-libpipewire">libpipewire-0.3.so</primary>
468 </indexterm>
469 </listitem>
470 </varlistentry>
471<!--
472 <varlistentry id="libpulse-mainloop-glib-pw">
473 <term><filename class="libraryfile">libpulse-mainloop-glib-pw.so</filename></term>
474 <listitem>
475 <para>
476 provides a glib main() loop for pulseaudio to route media through
477 pipewire.
478 </para>
479 <indexterm zone="pipewire libpulse-mainloop-glib-pw">
480 <primary sortas="c-libpulse-mainloop-glib-pw">libpulse-mainloop-glib-pw.so</primary>
481 </indexterm>
482 </listitem>
483 </varlistentry>
484
485 <varlistentry id="libpulse">
486 <term><filename class="libraryfile">libpulse.so</filename></term>
487 <listitem>
488 <para>
489 is a pipewire plugin for pulseaudio.
490 </para>
491 <indexterm zone="pipewire libpulse">
492 <primary sortas="c-libpulse">libpulse.so</primary>
493 </indexterm>
494 </listitem>
495 </varlistentry>
496
497 <varlistentry id="libpulse-simple">
498 <term><filename class="libraryfile">libpulse-simple.so</filename></term>
499 <listitem>
500 <para>
501 is a simplified version of the pulseaudio plugin for pipewire.
502 </para>
503 <indexterm zone="pipewire libpulse-simple">
504 <primary sortas="c-libpulse-simple">libpulse-simple.so</primary>
505 </indexterm>
506 </listitem>
507 </varlistentry>
508
509 <varlistentry id="libasound_module_pcm_pipewire">
510 <term><filename class="libraryfile">libasound_module_pcm_pipewire.so</filename></term>
511 <listitem>
512 <para>
513 is an ALSA plugin for pipewire.
514 </para>
515 <indexterm zone="pipewire libasound_module_pcm_pipewire">
516 <primary sortas="c-libasound_module_pcm_pipewire">libasound_module_pcm_pipewire.so</primary>
517 </indexterm>
518 </listitem>
519 </varlistentry>
520
521 <varlistentry id="libgstpipewire">
522 <term><filename class="libraryfile">libgstpipewire.so</filename></term>
523 <listitem>
524 <para>
525 is a Gstreamer plugin for pipewire.
526 </para>
527 <indexterm zone="pipewire libgstpipewire">
528 <primary sortas="c-libgstpipewire">libgstpipewire.so</primary>
529 </indexterm>
530 </listitem>
531 </varlistentry>-->
532 </variablelist>
533 </sect2>
534</sect1>
Note: See TracBrowser for help on using the repository browser.