source: multimedia/libdriv/pipewire.xml@ 0e09d22e

11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/soup3 xry111/xf86-video-removal
Last change on this file since 0e09d22e was 0e09d22e, checked in by Bruce Dubbs <bdubbs@…>, 22 months ago

Update to pipewire-0.3.54.

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