source: multimedia/libdriv/pipewire.xml@ ca66edf

12.0 12.1 12.2 gimp3 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/for-12.3 xry111/llvm18 xry111/spidermonkey128 xry111/xf86-video-removal
Last change on this file since ca66edf was 3165d82, checked in by Xi Ruoyao <xry111@…>, 19 months ago

Revert "pipewire: document a test failure with systemd"

This reverts commit 3cbfa4557ebf0179237c0d3ff66e683f508323e6.

Fixed in systemd-253.

  • Property mode set to 100644
File size: 19.1 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 "8a85d990c159409578b456f8c8dcf075">
10 <!ENTITY pipewire-size "1.9 MB">
11 <!ENTITY pipewire-buildsize "62 MB (with tests)">
12 <!ENTITY pipewire-time "0.5 SBU (with tests, both using parallelism=4)">
13]>
14
15<sect1 id="pipewire" xreflabel="pipewire-&pipewire-version;">
16 <?dbhtml filename="pipewire.html"?>
17
18
19 <title>Pipewire-&pipewire-version;</title>
20
21 <indexterm zone="pipewire">
22 <primary sortas="a-pipewire">pipewire</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Pipewire</title>
27
28 <para>
29 The <application>pipewire</application> package contains a server and
30 userspace API to handle multimedia pipelines. This includes a universal
31 API to connect to multimedia devices, as well as sharing multimedia
32 files between applications.
33 </para>
34
35 &lfs113_checked;
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
41 Download (HTTP): <ulink url="&pipewire-download-http;"/>
42 </para>
43 </listitem>
44 <listitem>
45 <para>
46 Download (FTP): <ulink url="&pipewire-download-ftp;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download MD5 sum: &pipewire-md5sum;
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download size: &pipewire-size;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Estimated disk space required: &pipewire-buildsize;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated build time: &pipewire-time;
67 </para>
68 </listitem>
69 </itemizedlist>
70
71 <bridgehead renderas="sect3">Pipewire Dependencies</bridgehead>
72
73 <bridgehead renderas="sect4">Recommended</bridgehead>
74 <para role="recommended">
75 <xref linkend="bluez"/>,
76 <phrase revision="sysv"><xref linkend="dbus"/>,</phrase>
77 <xref linkend="gstreamer10"/>,
78 <xref linkend="gst10-plugins-base"/>,
79 <xref linkend="pulseaudio"/>,
80 <xref linkend="sbc"/>, and
81 <xref linkend="v4l-utils"/>
82 </para>
83
84 <bridgehead renderas="sect4">Optional</bridgehead>
85 <para role="optional">
86 <xref linkend="alsa-lib"/>,
87 <xref linkend="avahi"/>,
88 <xref linkend="bluez"/>,
89 <xref linkend="fdk-aac"/>,
90 <xref linkend="ffmpeg"/>,
91 <xref linkend="libcanberra"/>,
92 <xref linkend="libdrm"/> (for one example and libcamera support),
93 <xref linkend="libxcb"/>,
94 <xref linkend="libsndfile"/>,
95 <xref linkend="libusb"/>,
96 <xref linkend="opus"/>,
97 <xref linkend="sdl2"/> (for some examples),
98 <xref linkend="valgrind"/>,
99 <xref linkend="xorg7-lib"/>,
100 <xref linkend="doxygen"/> and
101 <xref linkend="graphviz"/> (for documentation),
102 <ulink url="https://jackaudio.org/">JACK</ulink>,
103 <ulink url="https://github.com/EHfive/ldacBT">ldacBT</ulink>,
104 <ulink url="https://libcamera.org/">libcamera</ulink>,
105 <ulink url="https://vulkan.lunarg.com/sdk/home/">Vulkan</ulink>,
106 <ulink url="https://gitlab.freedesktop.org/pipewire/wireplumber/">WirePlumber</ulink>
107 (runtime, for running Pipewire daemon), and
108 <ulink url="https://sourceforge.net/projects/xmltoman/">xmltoman</ulink>
109 </para>
110
111 <para condition="html" role="usernotes">
112 User Notes: <ulink url="&blfs-wiki;/pipewire"/>
113 </para>
114 </sect2>
115
116 <sect2 role="installation">
117 <title>Installation of Pipewire</title>
118
119 <para>
120 Install <application>pipewire</application> by running the following
121 commands:
122 </para>
123
124<screen><userinput>mkdir build &amp;&amp;
125cd build &amp;&amp;
126
127meson --prefix=/usr --buildtype=release -Dsession-managers= .. &amp;&amp;
128ninja</userinput></screen>
129
130 <para>
131 To test the result, issue: <command>ninja test</command>.
132 </para>
133
134 <para>
135 Now, as the <systemitem class="username">root</systemitem> user:
136 </para>
137
138<screen role="root"><userinput>ninja install</userinput></screen>
139 </sect2>
140
141 <sect2 role="commands">
142 <title>Command Explanations</title>
143
144 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
145 href="../../xincludes/meson-buildtype-release.xml"/>
146
147 <para>
148 <parameter>-Dsession-managers=</parameter>: This switch
149 prevents automatic downloading external dependencies.
150 </para>
151
152 <para>
153 <option>-Ddocs=true</option>: This switch enables the generation of HTML
154 documentation. The optional dependencies for documentation need to be
155 installed for this to work.
156 </para>
157
158 <para>
159 <option>-Dman=true</option>: This switch enables the generation of manual
160 pages. The optional dependencies for documentation need to be installed
161 for this to work.
162 </para>
163
164 <para>
165 <option>-Dffmpeg=enabled</option>: This switch enables using ffmpeg for
166 audio conversion as a SPA backend.
167 </para>
168 </sect2>
169
170 <sect2 role="content">
171 <title>Contents</title>
172
173 <segmentedlist>
174 <segtitle>Installed Programs</segtitle>
175 <segtitle>Installed Libraries</segtitle>
176 <segtitle>Installed Directories</segtitle>
177
178 <seglistitem>
179 <seg>
180 pipewire,
181 pipewire-avb,
182 pipewire-pulse,
183 pw-cat,
184 pw-cli,
185 pw-dot,
186 pw-dump,
187 pw-jack,
188 pw-link,
189 pw-loopback,
190 pw-metadata,
191 pw-mididump,
192 pw-mon,
193 pw-profiler,
194 pw-reserve,
195 pw-top,
196 pw-v4l2,
197 spa-acp-tool,
198 spa-inspect,
199 spa-json-dump,
200 spa-monitor,
201 spa-resample, and
202 pw-dsdplay, pw-midiplay, pw-midirecord, pw-play, and pw-record
203 (symlinks to pw-cat)
204 </seg>
205 <seg>
206 libpipewire-0.3.so and
207 56 modules below /usr/lib/pipewire-0.3 and /usr/lib/spa-0.2<!--,
208 [pierre July 29th, 2020]: all the following libs are in subdirectories
209 of /usr/lib. I'm not sure they should appear. But if they should, there
210 are many more libs to list...
211 libpulse-mainloop-glib-pw.so,
212 libpulse.so,
213 libpulse-simple.so,
214 libasound_module_pcm_pipewire.so, and
215 libgstpipewire.so
216 [bdubbs Sep 29th, 2020]: add
217 libpipewire-module-{access,adapter,client-device,client-node,
218 link-factory,metadata,portal,profiler,protocol-native,
219 rtkit,session-manager,spa-device,spa-device-factory,spa-node,
220 spa-node-factory}.so
221 libasound_module_ctl_pipewire.so
222 libasound_module_pcm_pipewire.so
223 libspa-{alsa,audioconvert,audiomixer,bluez5,control,dbus,support
224 v4l2,videoconvert}.so
225 -->
226 </seg>
227 <seg>
228 <!--/etc/pipewire,-->
229 /usr/include/pipewire-0.3,
230 /usr/include/spa-0.2,
231 /usr/lib/alsa-lib,
232 <!--/usr/lib/gstreamer-1.0, already installed by gstreamer-->
233 /usr/lib/pipewire-0.3,
234 /usr/lib/spa-0.2,
235 /usr/share/alsa-card-profile,
236 /usr/share/pipewire, and
237 /usr/share/spa-0.2
238 </seg>
239 </seglistitem>
240 </segmentedlist>
241
242 <variablelist>
243 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
244 <?dbfo list-presentation="list"?>
245 <?dbhtml list-presentation="table"?>
246
247 <varlistentry id="pipewire-prog">
248 <term><command>pipewire</command></term>
249 <listitem>
250 <para>
251 is a service that allows access to multimedia devices and allows
252 sharing of multimedia files between applications
253 </para>
254 <indexterm zone="pipewire pipewire-prog">
255 <primary sortas="b-pipewire">pipewire</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="pipewire-media-session">
261 <term><command>pipewire-media-session</command></term>
262 <listitem>
263 <para>
264 is a service that allows a desktop environment to know when media
265 files are being played through pipewire
266 </para>
267 <indexterm zone="pipewire pipewire-media-session">
268 <primary sortas="b-pipewire-media-session">pipewire-media-session</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="pipewire-pulse">
274 <term><command>pipewire-pulse</command></term>
275 <listitem>
276 <para>
277 starts a Pulseaudio-compatible version of
278 the pipewire service
279 </para>
280 <indexterm zone="pipewire pipewire-pulse">
281 <primary sortas="b-pipewire-pulse">pipewire-pulse</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="pw-cat">
287 <term><command>pw-cat</command></term>
288 <listitem>
289 <para>
290 allows you to play or record media using a pipewire instance
291 </para>
292 <indexterm zone="pipewire pw-cat">
293 <primary sortas="b-pw-cat">pw-cat</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="pw-cli">
299 <term><command>pw-cli</command></term>
300 <listitem>
301 <para>
302 allows you to interact with a pipewire instance
303 </para>
304 <indexterm zone="pipewire pw-cli">
305 <primary sortas="b-pw-cli">pw-cli</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="pw-dot">
311 <term><command>pw-dot</command></term>
312 <listitem>
313 <para>
314 lists all of the daemons and objects in use by pipewire
315 </para>
316 <indexterm zone="pipewire pw-dot">
317 <primary sortas="b-pw-dot">pw-dot</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="pw-dump">
323 <term><command>pw-dump</command></term>
324 <listitem>
325 <para>
326 dumps debug messages from a local or remote pipewire instance to
327 the console
328 </para>
329 <indexterm zone="pipewire pw-dump">
330 <primary sortas="b-pw-dump">pw-dump</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334
335 <varlistentry id="pw-jack">
336 <term><command>pw-jack</command></term>
337 <listitem>
338 <para>
339 runs JACK applications on a pipewire instance
340 </para>
341 <indexterm zone="pipewire pw-jack">
342 <primary sortas="b-pw-jack">pw-jack</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="pw-link">
348 <term><command>pw-link</command></term>
349 <listitem>
350 <para>
351 links pipewire ports together
352 </para>
353 <indexterm zone="pipewire pw-link">
354 <primary sortas="b-pw-link">pw-link</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="pw-loopback">
360 <term><command>pw-loopback</command></term>
361 <listitem>
362 <para>
363 initializes a loopback link between two different pipewire ports.
364 This is useful for testing and debugging
365 </para>
366 <indexterm zone="pipewire pw-loopback">
367 <primary sortas="b-pw-loopback">pw-loopback</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="pw-metadata">
373 <term><command>pw-metadata</command></term>
374 <listitem>
375 <para>
376 inspects, adds, and removes metadata for objects
377 </para>
378 <indexterm zone="pipewire pw-metadata">
379 <primary sortas="b-pw-metadata">pw-metadata</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="pw-mididump">
385 <term><command>pw-mididump</command></term>
386 <listitem>
387 <para>
388 dumps MIDI messages from a file to the screen
389 </para>
390 <indexterm zone="pipewire pw-mididump">
391 <primary sortas="b-pw-mididump">pw-mididump</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="pw-mon">
397 <term><command>pw-mon</command></term>
398 <listitem>
399 <para>
400 allows you to monitor pipewire instances
401 </para>
402 <indexterm zone="pipewire pw-mon">
403 <primary sortas="b-pw-mon">pw-mon</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="pw-profiler">
409 <term><command>pw-profiler</command></term>
410 <listitem>
411 <para>
412 tracks memory usage and API calls used by pipewire
413 </para>
414 <indexterm zone="pipewire pw-profiler">
415 <primary sortas="b-pw-profiler">pw-profiler</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420<!--
421 <varlistentry id="pw-pulse">
422 <term><command>pw-pulse</command></term>
423 <listitem>
424 <para>
425 runs Pulseaudio applications on pipewire.
426 </para>
427 <indexterm zone="pipewire pw-pulse">
428 <primary sortas="b-pw-pulse">pw-pulse</primary>
429 </indexterm>
430 </listitem>
431 </varlistentry>
432-->
433
434 <varlistentry id="pw-reserve">
435 <term><command>pw-reserve</command></term>
436 <listitem>
437 <para>
438 reserves or monitors a device via D-Bus
439 </para>
440 <indexterm zone="pipewire pw-reserve">
441 <primary sortas="b-pw-reserve">pw-reserve</primary>
442 </indexterm>
443 </listitem>
444 </varlistentry>
445
446 <varlistentry id="pw-top">
447 <term><command>pw-top</command></term>
448 <listitem>
449 <para>
450 displays real-time performance information from pipewire
451 </para>
452 <indexterm zone="pipewire pw-top">
453 <primary sortas="b-pw-top">pw-top</primary>
454 </indexterm>
455 </listitem>
456 </varlistentry>
457
458 <varlistentry id="pw-v4l2">
459 <term><command>pw-v4l2</command></term>
460 <listitem>
461 <para>
462 runs v4l2 applications on a pipewire instance
463 </para>
464 <indexterm zone="pipewire pw-v4l2">
465 <primary sortas="b-pw-v4l2">pw-v4l2</primary>
466 </indexterm>
467 </listitem>
468 </varlistentry>
469
470 <varlistentry id="spa-acp-tool">
471 <term><command>spa-acp-tool</command></term>
472 <listitem>
473 <para>
474 inspects the card profile of a given sound card
475 </para>
476 <indexterm zone="pipewire spa-acp-tool">
477 <primary sortas="b-spa-acp-tool">spa-acp-tool</primary>
478 </indexterm>
479 </listitem>
480 </varlistentry>
481
482 <varlistentry id="spa-inspect">
483 <term><command>spa-inspect</command></term>
484 <listitem>
485 <para>
486 allows you to inspect pipewire plugins
487 </para>
488 <indexterm zone="pipewire spa-inspect">
489 <primary sortas="b-spa-inspect">spa-inspect</primary>
490 </indexterm>
491 </listitem>
492 </varlistentry>
493
494 <varlistentry id="spa-json-dump">
495 <term><command>spa-json-dump</command></term>
496 <listitem>
497 <para>
498 dumps the current pipewire configuration in JSON format.
499 </para>
500 <indexterm zone="pipewire spa-json-dump">
501 <primary sortas="b-spa-json-dump">spa-json-dump</primary>
502 </indexterm>
503 </listitem>
504 </varlistentry>
505
506 <varlistentry id="spa-monitor">
507 <term><command>spa-monitor</command></term>
508 <listitem>
509 <para>
510 allows you to monitor pipewire plugins
511 </para>
512 <indexterm zone="pipewire spa-monitor">
513 <primary sortas="b-spa-monitor">spa-monitor</primary>
514 </indexterm>
515 </listitem>
516 </varlistentry>
517
518 <varlistentry id="spa-resample">
519 <term><command>spa-resample</command></term>
520 <listitem>
521 <para>
522 resamples a given file
523 </para>
524 <indexterm zone="pipewire spa-resample">
525 <primary sortas="b-spa-resample">spa-resample</primary>
526 </indexterm>
527 </listitem>
528 </varlistentry>
529
530 <varlistentry id="libpipewire">
531 <term><filename class="libraryfile">libpipewire-0.3.so</filename></term>
532 <listitem>
533 <para>
534 contains API functions for handling multimedia pipelines
535 </para>
536 <indexterm zone="pipewire libpipewire">
537 <primary sortas="c-libpipewire">libpipewire-0.3.so</primary>
538 </indexterm>
539 </listitem>
540 </varlistentry>
541<!--
542 <varlistentry id="libpulse-mainloop-glib-pw">
543 <term><filename class="libraryfile">libpulse-mainloop-glib-pw.so</filename></term>
544 <listitem>
545 <para>
546 provides a glib main() loop for pulseaudio to route media through
547 pipewire.
548 </para>
549 <indexterm zone="pipewire libpulse-mainloop-glib-pw">
550 <primary sortas="c-libpulse-mainloop-glib-pw">libpulse-mainloop-glib-pw.so</primary>
551 </indexterm>
552 </listitem>
553 </varlistentry>
554
555 <varlistentry id="libpulse">
556 <term><filename class="libraryfile">libpulse.so</filename></term>
557 <listitem>
558 <para>
559 is a pipewire plugin for pulseaudio.
560 </para>
561 <indexterm zone="pipewire libpulse">
562 <primary sortas="c-libpulse">libpulse.so</primary>
563 </indexterm>
564 </listitem>
565 </varlistentry>
566
567 <varlistentry id="libpulse-simple">
568 <term><filename class="libraryfile">libpulse-simple.so</filename></term>
569 <listitem>
570 <para>
571 is a simplified version of the pulseaudio plugin for pipewire.
572 </para>
573 <indexterm zone="pipewire libpulse-simple">
574 <primary sortas="c-libpulse-simple">libpulse-simple.so</primary>
575 </indexterm>
576 </listitem>
577 </varlistentry>
578
579 <varlistentry id="libasound_module_pcm_pipewire">
580 <term><filename class="libraryfile">libasound_module_pcm_pipewire.so</filename></term>
581 <listitem>
582 <para>
583 is an ALSA plugin for pipewire.
584 </para>
585 <indexterm zone="pipewire libasound_module_pcm_pipewire">
586 <primary sortas="c-libasound_module_pcm_pipewire">libasound_module_pcm_pipewire.so</primary>
587 </indexterm>
588 </listitem>
589 </varlistentry>
590
591 <varlistentry id="libgstpipewire">
592 <term><filename class="libraryfile">libgstpipewire.so</filename></term>
593 <listitem>
594 <para>
595 is a Gstreamer plugin for pipewire.
596 </para>
597 <indexterm zone="pipewire libgstpipewire">
598 <primary sortas="c-libgstpipewire">libgstpipewire.so</primary>
599 </indexterm>
600 </listitem>
601 </varlistentry>-->
602 </variablelist>
603 </sect2>
604
605</sect1>
Note: See TracBrowser for help on using the repository browser.