source: multimedia/libdriv/pipewire.xml@ 4edc4fbe

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 4edc4fbe was 2a2bb77, checked in by Xi Ruoyao <xry111@…>, 12 months ago

pipewire: Uncomment Editor Notes

I've written some notes for this.

  • Property mode set to 100644
File size: 19.9 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 "b07218e9c5e0e1f3c80fe288c378d8c4">
10 <!ENTITY pipewire-size "2.0 MB">
11 <!ENTITY pipewire-buildsize "65 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 Editor Notes: <ulink url="&blfs-wiki;/pipewire"/>
113 </para>
114
115 </sect2>
116
117 <sect2 role="installation">
118 <title>Installation of Pipewire</title>
119
120 <para>
121 Install <application>pipewire</application> by running the following
122 commands:
123 </para>
124
125<screen><userinput>mkdir build &amp;&amp;
126cd build &amp;&amp;
127
128meson setup --prefix=/usr \
129 --buildtype=release \
130 -Dsession-managers= \
131 .. &amp;&amp;
132ninja</userinput></screen>
133
134 <para>
135 To test the result, issue: <command>ninja test</command>.
136 </para>
137
138 <para>
139 If upgrading from an earlier release of Pipewire, it's needed to
140 remove any old binary executables that interfere with the
141 installation. As the &root; user:
142 </para>
143
144<screen role='root'><userinput>rm -vf /usr/bin/pipewire-*</userinput></screen>
145
146 <para>
147 Now, as the <systemitem class="username">root</systemitem> user:
148 </para>
149
150<screen role="root"><userinput>ninja install</userinput></screen>
151 </sect2>
152
153 <sect2 role="commands">
154 <title>Command Explanations</title>
155
156 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
157 href="../../xincludes/meson-buildtype-release.xml"/>
158
159 <para>
160 <parameter>-Dsession-managers=</parameter>: This switch
161 prevents automatic downloading external dependencies.
162 </para>
163
164 <para>
165 <option>-Ddocs=true</option>: This switch enables the generation of HTML
166 documentation. The optional dependencies for documentation need to be
167 installed for this to work.
168 </para>
169
170 <para>
171 <option>-Dman=true</option>: This switch enables the generation of manual
172 pages. The optional dependencies for documentation need to be installed
173 for this to work.
174 </para>
175
176 <para>
177 <option>-Dffmpeg=enabled</option>: This switch enables using ffmpeg for
178 audio conversion as a SPA backend.
179 </para>
180 </sect2>
181
182 <sect2 role="content">
183 <title>Contents</title>
184
185 <segmentedlist>
186 <segtitle>Installed Programs</segtitle>
187 <segtitle>Installed Libraries</segtitle>
188 <segtitle>Installed Directories</segtitle>
189
190 <seglistitem>
191 <seg>
192 pipewire,
193 pipewire-avb,
194 pipewire-pulse,
195 pw-cat,
196 pw-cli,
197 pw-config,
198 pw-dot,
199 pw-dump,
200 pw-jack,
201 pw-link,
202 pw-loopback,
203 pw-metadata,
204 pw-mididump,
205 pw-mon,
206 pw-profiler,
207 pw-reserve,
208 pw-top,
209 pw-v4l2,
210 spa-acp-tool,
211 spa-inspect,
212 spa-json-dump,
213 spa-monitor,
214 spa-resample, and
215 pw-dsdplay, pw-midiplay, pw-midirecord, pw-play, and pw-record
216 (symlinks to pw-cat)
217 </seg>
218 <seg>
219 libpipewire-0.3.so and
220 56 modules below /usr/lib/pipewire-0.3 and /usr/lib/spa-0.2<!--,
221 [pierre July 29th, 2020]: all the following libs are in subdirectories
222 of /usr/lib. I'm not sure they should appear. But if they should, there
223 are many more libs to list...
224 libpulse-mainloop-glib-pw.so,
225 libpulse.so,
226 libpulse-simple.so,
227 libasound_module_pcm_pipewire.so, and
228 libgstpipewire.so
229 [bdubbs Sep 29th, 2020]: add
230 libpipewire-module-{access,adapter,client-device,client-node,
231 link-factory,metadata,portal,profiler,protocol-native,
232 rtkit,session-manager,spa-device,spa-device-factory,spa-node,
233 spa-node-factory}.so
234 libasound_module_ctl_pipewire.so
235 libasound_module_pcm_pipewire.so
236 libspa-{alsa,audioconvert,audiomixer,bluez5,control,dbus,support
237 v4l2,videoconvert}.so
238 -->
239 </seg>
240 <seg>
241 <!--/etc/pipewire,-->
242 /usr/include/pipewire-0.3,
243 /usr/include/spa-0.2,
244 /usr/lib/alsa-lib,
245 <!--/usr/lib/gstreamer-1.0, already installed by gstreamer-->
246 /usr/lib/pipewire-0.3,
247 /usr/lib/spa-0.2,
248 /usr/share/alsa-card-profile,
249 /usr/share/pipewire, and
250 /usr/share/spa-0.2
251 </seg>
252 </seglistitem>
253 </segmentedlist>
254
255 <variablelist>
256 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
257 <?dbfo list-presentation="list"?>
258 <?dbhtml list-presentation="table"?>
259
260 <varlistentry id="pipewire-prog">
261 <term><command>pipewire</command></term>
262 <listitem>
263 <para>
264 is a service that allows access to multimedia devices and allows
265 sharing of multimedia files between applications
266 </para>
267 <indexterm zone="pipewire pipewire-prog">
268 <primary sortas="b-pipewire">pipewire</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="pipewire-media-session">
274 <term><command>pipewire-media-session</command></term>
275 <listitem>
276 <para>
277 is a service that allows a desktop environment to know when media
278 files are being played through pipewire
279 </para>
280 <indexterm zone="pipewire pipewire-media-session">
281 <primary sortas="b-pipewire-media-session">pipewire-media-session</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="pipewire-pulse">
287 <term><command>pipewire-pulse</command></term>
288 <listitem>
289 <para>
290 starts a Pulseaudio-compatible version of
291 the pipewire service
292 </para>
293 <indexterm zone="pipewire pipewire-pulse">
294 <primary sortas="b-pipewire-pulse">pipewire-pulse</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="pw-cat">
300 <term><command>pw-cat</command></term>
301 <listitem>
302 <para>
303 allows you to play or record media using a pipewire instance
304 </para>
305 <indexterm zone="pipewire pw-cat">
306 <primary sortas="b-pw-cat">pw-cat</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="pw-cli">
312 <term><command>pw-cli</command></term>
313 <listitem>
314 <para>
315 allows you to interact with a pipewire instance
316 </para>
317 <indexterm zone="pipewire pw-cli">
318 <primary sortas="b-pw-cli">pw-cli</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="pw-config">
324 <term><command>pw-config</command></term>
325 <listitem>
326 <para>
327 allows you to interact with pipewire's configuration system
328 for debugging purposes or syntax checking
329 </para>
330 <indexterm zone="pipewire pw-config">
331 <primary sortas="b-pw-config">pw-config</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry id="pw-dot">
337 <term><command>pw-dot</command></term>
338 <listitem>
339 <para>
340 lists all of the daemons and objects in use by pipewire
341 </para>
342 <indexterm zone="pipewire pw-dot">
343 <primary sortas="b-pw-dot">pw-dot</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="pw-dump">
349 <term><command>pw-dump</command></term>
350 <listitem>
351 <para>
352 dumps debug messages from a local or remote pipewire instance to
353 the console
354 </para>
355 <indexterm zone="pipewire pw-dump">
356 <primary sortas="b-pw-dump">pw-dump</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
360
361 <varlistentry id="pw-jack">
362 <term><command>pw-jack</command></term>
363 <listitem>
364 <para>
365 runs JACK applications on a pipewire instance
366 </para>
367 <indexterm zone="pipewire pw-jack">
368 <primary sortas="b-pw-jack">pw-jack</primary>
369 </indexterm>
370 </listitem>
371 </varlistentry>
372
373 <varlistentry id="pw-link">
374 <term><command>pw-link</command></term>
375 <listitem>
376 <para>
377 links pipewire ports together
378 </para>
379 <indexterm zone="pipewire pw-link">
380 <primary sortas="b-pw-link">pw-link</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="pw-loopback">
386 <term><command>pw-loopback</command></term>
387 <listitem>
388 <para>
389 initializes a loopback link between two different pipewire ports.
390 This is useful for testing and debugging
391 </para>
392 <indexterm zone="pipewire pw-loopback">
393 <primary sortas="b-pw-loopback">pw-loopback</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="pw-metadata">
399 <term><command>pw-metadata</command></term>
400 <listitem>
401 <para>
402 inspects, adds, and removes metadata for objects
403 </para>
404 <indexterm zone="pipewire pw-metadata">
405 <primary sortas="b-pw-metadata">pw-metadata</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="pw-mididump">
411 <term><command>pw-mididump</command></term>
412 <listitem>
413 <para>
414 dumps MIDI messages from a file to the screen
415 </para>
416 <indexterm zone="pipewire pw-mididump">
417 <primary sortas="b-pw-mididump">pw-mididump</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="pw-mon">
423 <term><command>pw-mon</command></term>
424 <listitem>
425 <para>
426 allows you to monitor pipewire instances
427 </para>
428 <indexterm zone="pipewire pw-mon">
429 <primary sortas="b-pw-mon">pw-mon</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="pw-profiler">
435 <term><command>pw-profiler</command></term>
436 <listitem>
437 <para>
438 tracks memory usage and API calls used by pipewire
439 </para>
440 <indexterm zone="pipewire pw-profiler">
441 <primary sortas="b-pw-profiler">pw-profiler</primary>
442 </indexterm>
443 </listitem>
444 </varlistentry>
445
446<!--
447 <varlistentry id="pw-pulse">
448 <term><command>pw-pulse</command></term>
449 <listitem>
450 <para>
451 runs Pulseaudio applications on pipewire.
452 </para>
453 <indexterm zone="pipewire pw-pulse">
454 <primary sortas="b-pw-pulse">pw-pulse</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458-->
459
460 <varlistentry id="pw-reserve">
461 <term><command>pw-reserve</command></term>
462 <listitem>
463 <para>
464 reserves or monitors a device via D-Bus
465 </para>
466 <indexterm zone="pipewire pw-reserve">
467 <primary sortas="b-pw-reserve">pw-reserve</primary>
468 </indexterm>
469 </listitem>
470 </varlistentry>
471
472 <varlistentry id="pw-top">
473 <term><command>pw-top</command></term>
474 <listitem>
475 <para>
476 displays real-time performance information from pipewire
477 </para>
478 <indexterm zone="pipewire pw-top">
479 <primary sortas="b-pw-top">pw-top</primary>
480 </indexterm>
481 </listitem>
482 </varlistentry>
483
484 <varlistentry id="pw-v4l2">
485 <term><command>pw-v4l2</command></term>
486 <listitem>
487 <para>
488 runs v4l2 applications on a pipewire instance
489 </para>
490 <indexterm zone="pipewire pw-v4l2">
491 <primary sortas="b-pw-v4l2">pw-v4l2</primary>
492 </indexterm>
493 </listitem>
494 </varlistentry>
495
496 <varlistentry id="spa-acp-tool">
497 <term><command>spa-acp-tool</command></term>
498 <listitem>
499 <para>
500 inspects the card profile of a given sound card
501 </para>
502 <indexterm zone="pipewire spa-acp-tool">
503 <primary sortas="b-spa-acp-tool">spa-acp-tool</primary>
504 </indexterm>
505 </listitem>
506 </varlistentry>
507
508 <varlistentry id="spa-inspect">
509 <term><command>spa-inspect</command></term>
510 <listitem>
511 <para>
512 allows you to inspect pipewire plugins
513 </para>
514 <indexterm zone="pipewire spa-inspect">
515 <primary sortas="b-spa-inspect">spa-inspect</primary>
516 </indexterm>
517 </listitem>
518 </varlistentry>
519
520 <varlistentry id="spa-json-dump">
521 <term><command>spa-json-dump</command></term>
522 <listitem>
523 <para>
524 dumps the current pipewire configuration in JSON format.
525 </para>
526 <indexterm zone="pipewire spa-json-dump">
527 <primary sortas="b-spa-json-dump">spa-json-dump</primary>
528 </indexterm>
529 </listitem>
530 </varlistentry>
531
532 <varlistentry id="spa-monitor">
533 <term><command>spa-monitor</command></term>
534 <listitem>
535 <para>
536 allows you to monitor pipewire plugins
537 </para>
538 <indexterm zone="pipewire spa-monitor">
539 <primary sortas="b-spa-monitor">spa-monitor</primary>
540 </indexterm>
541 </listitem>
542 </varlistentry>
543
544 <varlistentry id="spa-resample">
545 <term><command>spa-resample</command></term>
546 <listitem>
547 <para>
548 resamples a given file
549 </para>
550 <indexterm zone="pipewire spa-resample">
551 <primary sortas="b-spa-resample">spa-resample</primary>
552 </indexterm>
553 </listitem>
554 </varlistentry>
555
556 <varlistentry id="libpipewire">
557 <term><filename class="libraryfile">libpipewire-0.3.so</filename></term>
558 <listitem>
559 <para>
560 contains API functions for handling multimedia pipelines
561 </para>
562 <indexterm zone="pipewire libpipewire">
563 <primary sortas="c-libpipewire">libpipewire-0.3.so</primary>
564 </indexterm>
565 </listitem>
566 </varlistentry>
567<!--
568 <varlistentry id="libpulse-mainloop-glib-pw">
569 <term><filename class="libraryfile">libpulse-mainloop-glib-pw.so</filename></term>
570 <listitem>
571 <para>
572 provides a glib main() loop for pulseaudio to route media through
573 pipewire.
574 </para>
575 <indexterm zone="pipewire libpulse-mainloop-glib-pw">
576 <primary sortas="c-libpulse-mainloop-glib-pw">libpulse-mainloop-glib-pw.so</primary>
577 </indexterm>
578 </listitem>
579 </varlistentry>
580
581 <varlistentry id="libpulse">
582 <term><filename class="libraryfile">libpulse.so</filename></term>
583 <listitem>
584 <para>
585 is a pipewire plugin for pulseaudio.
586 </para>
587 <indexterm zone="pipewire libpulse">
588 <primary sortas="c-libpulse">libpulse.so</primary>
589 </indexterm>
590 </listitem>
591 </varlistentry>
592
593 <varlistentry id="libpulse-simple">
594 <term><filename class="libraryfile">libpulse-simple.so</filename></term>
595 <listitem>
596 <para>
597 is a simplified version of the pulseaudio plugin for pipewire.
598 </para>
599 <indexterm zone="pipewire libpulse-simple">
600 <primary sortas="c-libpulse-simple">libpulse-simple.so</primary>
601 </indexterm>
602 </listitem>
603 </varlistentry>
604
605 <varlistentry id="libasound_module_pcm_pipewire">
606 <term><filename class="libraryfile">libasound_module_pcm_pipewire.so</filename></term>
607 <listitem>
608 <para>
609 is an ALSA plugin for pipewire.
610 </para>
611 <indexterm zone="pipewire libasound_module_pcm_pipewire">
612 <primary sortas="c-libasound_module_pcm_pipewire">libasound_module_pcm_pipewire.so</primary>
613 </indexterm>
614 </listitem>
615 </varlistentry>
616
617 <varlistentry id="libgstpipewire">
618 <term><filename class="libraryfile">libgstpipewire.so</filename></term>
619 <listitem>
620 <para>
621 is a Gstreamer plugin for pipewire.
622 </para>
623 <indexterm zone="pipewire libgstpipewire">
624 <primary sortas="c-libgstpipewire">libgstpipewire.so</primary>
625 </indexterm>
626 </listitem>
627 </varlistentry>-->
628 </variablelist>
629 </sect2>
630
631</sect1>
Note: See TracBrowser for help on using the repository browser.