source: multimedia/libdriv/pipewire.xml@ 3636c57e

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 3636c57e was 3636c57e, checked in by Bruce Dubbs <bdubbs@…>, 7 months ago

Update to pipewire-0.3.85.

  • Property mode set to 100644
File size: 18.2 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://gitlab.freedesktop.org/pipewire/pipewire/-/archive/&pipewire-version;/pipewire-&pipewire-version;.tar.bz2">
8 <!ENTITY pipewire-download-ftp " ">
9 <!ENTITY pipewire-md5sum "968966a7002ea4b88d1d238a1e55668c">
10 <!ENTITY pipewire-size "1.6 MB">
11 <!ENTITY pipewire-buildsize "67 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 &lfs120_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"/>,
81 <xref linkend="v4l-utils"/>, and
82 <xref role="runtime" linkend="wireplumber"/> (runtime)
83 </para>
84
85 <bridgehead renderas="sect4">Optional</bridgehead>
86 <para role="optional">
87 <xref linkend="alsa-lib"/>,
88 <xref linkend="avahi"/>,
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://github.com/hoene/libmysofa">libmysofa</ulink>,
106 <ulink url="https://vulkan.lunarg.com/sdk/home/">Vulkan</ulink>, and
107 <ulink url="https://sourceforge.net/projects/xmltoman/">xmltoman</ulink>
108 </para>
109
110 <para condition="html" role="usernotes">
111 Editor Notes: <ulink url="&blfs-wiki;/pipewire"/>
112 </para>
113
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 setup .. \
128 --prefix=/usr \
129 --buildtype=release \
130 -Dsession-managers="[]" &amp;&amp;
131ninja</userinput></screen>
132
133 <para>
134 To test the result, issue: <command>ninja test</command>.
135 </para>
136 <!--
137 <para>
138 If upgrading from an earlier release of Pipewire, it's needed to
139 remove any old binary executables that interfere with the
140 installation. As the &root; user:
141 </para>
142
143<screen role='root'><userinput>rm -vf /usr/bin/pipewire-*</userinput></screen>
144-->
145 <para>
146 Now, as the <systemitem class="username">root</systemitem> user:
147 </para>
148
149<screen role="root"><userinput>ninja install</userinput></screen>
150 </sect2>
151
152 <sect2 role="commands">
153 <title>Command Explanations</title>
154
155 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
156 href="../../xincludes/meson-buildtype-release.xml"/>
157
158 <para>
159 <parameter>-Dsession-managers=[]</parameter>: This switch
160 allows specifying the session managers to build as subprojects.
161 We specify an empty list to prevent <command>meson</command> from
162 downloading any external copy of the session managers. A Pipewire
163 session manager recommended by the PipeWire developers for general
164 use, <xref linkend="wireplumber" role="nodep"/>, is available as a
165 separate BLFS package. Build it after installing Pipewire if you
166 need to run the Pipewire daemon (for example in order to support
167 <xref linkend="snapshot" role="nodep"/>).
168 </para>
169
170 <para>
171 <option>-Ddocs=true</option>: This switch enables the generation of HTML
172 documentation. The optional dependencies for documentation need to be
173 installed for this to work.
174 </para>
175
176 <para>
177 <option>-Dman=true</option>: This switch enables the generation of manual
178 pages. The optional dependencies for documentation need to be installed
179 for this to work.
180 </para>
181
182 <para>
183 <option>-Dffmpeg=enabled</option>: This switch enables using ffmpeg for
184 audio conversion as a SPA backend.
185 </para>
186 </sect2>
187
188 <sect2 role="content">
189 <title>Contents</title>
190
191 <segmentedlist>
192 <segtitle>Installed Programs</segtitle>
193 <segtitle>Installed Libraries</segtitle>
194 <segtitle>Installed Directories</segtitle>
195
196 <seglistitem>
197 <seg>
198 pipewire,
199 pw-cat,
200 pw-cli,
201 pw-config,
202 pw-dot,
203 pw-dump,
204 pw-jack,
205 pw-link,
206 pw-loopback,
207 pw-metadata,
208 pw-mididump,
209 pw-mon,
210 pw-profiler,
211 pw-reserve,
212 pw-top,
213 pw-v4l2,
214 spa-acp-tool,
215 spa-inspect,
216 spa-json-dump,
217 spa-monitor,
218 spa-resample, and
219 pipewire-aes67, pipewire-avb, pipewire-pulse (symlinks to pipewire),
220 pw-dsdplay, pw-encplay, pw-midiplay, pw-midirecord, pw-play,
221 pw-record (symlinks to pw-cat)
222 </seg>
223 <seg>
224 libpipewire-0.3.so and
225 60 modules below /usr/lib/pipewire-0.3 and /usr/lib/spa-0.2
226 </seg>
227 <seg>
228 /usr/include/pipewire-0.3,
229 /usr/include/spa-0.2,
230 /usr/lib/alsa-lib,
231 <!--/usr/lib/gstreamer-1.0, already installed by gstreamer-->
232 /usr/lib/pipewire-0.3,
233 /usr/lib/spa-0.2,
234 /usr/share/alsa-card-profile,
235 /usr/share/pipewire, and
236 /usr/share/spa-0.2
237 </seg>
238 </seglistitem>
239 </segmentedlist>
240
241 <variablelist>
242 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
243 <?dbfo list-presentation="list"?>
244 <?dbhtml list-presentation="table"?>
245
246 <varlistentry id="pipewire-prog">
247 <term><command>pipewire</command></term>
248 <listitem>
249 <para>
250 is a service that allows access to multimedia devices and allows
251 sharing of multimedia files between applications
252 </para>
253 <indexterm zone="pipewire pipewire-prog">
254 <primary sortas="b-pipewire">pipewire</primary>
255 </indexterm>
256 </listitem>
257 </varlistentry>
258
259 <varlistentry id="pipewire-pulse">
260 <term><command>pipewire-pulse</command></term>
261 <listitem>
262 <para>
263 starts a Pulseaudio-compatible version of
264 the pipewire service
265 </para>
266 <indexterm zone="pipewire pipewire-pulse">
267 <primary sortas="b-pipewire-pulse">pipewire-pulse</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <varlistentry id="pw-cat">
273 <term><command>pw-cat</command></term>
274 <listitem>
275 <para>
276 allows you to play or record media using a pipewire instance
277 </para>
278 <indexterm zone="pipewire pw-cat">
279 <primary sortas="b-pw-cat">pw-cat</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="pw-cli">
285 <term><command>pw-cli</command></term>
286 <listitem>
287 <para>
288 allows you to interact with a pipewire instance
289 </para>
290 <indexterm zone="pipewire pw-cli">
291 <primary sortas="b-pw-cli">pw-cli</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="pw-config">
297 <term><command>pw-config</command></term>
298 <listitem>
299 <para>
300 allows you to interact with pipewire's configuration system
301 for debugging purposes or syntax checking
302 </para>
303 <indexterm zone="pipewire pw-config">
304 <primary sortas="b-pw-config">pw-config</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="pw-dot">
310 <term><command>pw-dot</command></term>
311 <listitem>
312 <para>
313 lists all of the daemons and objects in use by pipewire
314 </para>
315 <indexterm zone="pipewire pw-dot">
316 <primary sortas="b-pw-dot">pw-dot</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="pw-dump">
322 <term><command>pw-dump</command></term>
323 <listitem>
324 <para>
325 dumps debug messages from a local or remote pipewire instance to
326 the console
327 </para>
328 <indexterm zone="pipewire pw-dump">
329 <primary sortas="b-pw-dump">pw-dump</primary>
330 </indexterm>
331 </listitem>
332 </varlistentry>
333
334 <varlistentry id="pw-jack">
335 <term><command>pw-jack</command></term>
336 <listitem>
337 <para>
338 runs JACK applications on a pipewire instance
339 </para>
340 <indexterm zone="pipewire pw-jack">
341 <primary sortas="b-pw-jack">pw-jack</primary>
342 </indexterm>
343 </listitem>
344 </varlistentry>
345
346 <varlistentry id="pw-link">
347 <term><command>pw-link</command></term>
348 <listitem>
349 <para>
350 links pipewire ports together
351 </para>
352 <indexterm zone="pipewire pw-link">
353 <primary sortas="b-pw-link">pw-link</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="pw-loopback">
359 <term><command>pw-loopback</command></term>
360 <listitem>
361 <para>
362 initializes a loopback link between two different pipewire ports.
363 This is useful for testing and debugging
364 </para>
365 <indexterm zone="pipewire pw-loopback">
366 <primary sortas="b-pw-loopback">pw-loopback</primary>
367 </indexterm>
368 </listitem>
369 </varlistentry>
370
371 <varlistentry id="pw-metadata">
372 <term><command>pw-metadata</command></term>
373 <listitem>
374 <para>
375 inspects, adds, and removes metadata for objects
376 </para>
377 <indexterm zone="pipewire pw-metadata">
378 <primary sortas="b-pw-metadata">pw-metadata</primary>
379 </indexterm>
380 </listitem>
381 </varlistentry>
382
383 <varlistentry id="pw-mididump">
384 <term><command>pw-mididump</command></term>
385 <listitem>
386 <para>
387 dumps MIDI messages from a file to the screen
388 </para>
389 <indexterm zone="pipewire pw-mididump">
390 <primary sortas="b-pw-mididump">pw-mididump</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="pw-mon">
396 <term><command>pw-mon</command></term>
397 <listitem>
398 <para>
399 allows you to monitor pipewire instances
400 </para>
401 <indexterm zone="pipewire pw-mon">
402 <primary sortas="b-pw-mon">pw-mon</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="pw-profiler">
408 <term><command>pw-profiler</command></term>
409 <listitem>
410 <para>
411 tracks memory usage and API calls used by pipewire
412 </para>
413 <indexterm zone="pipewire pw-profiler">
414 <primary sortas="b-pw-profiler">pw-profiler</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
418
419 <varlistentry id="pw-reserve">
420 <term><command>pw-reserve</command></term>
421 <listitem>
422 <para>
423 reserves or monitors a device via D-Bus
424 </para>
425 <indexterm zone="pipewire pw-reserve">
426 <primary sortas="b-pw-reserve">pw-reserve</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 <varlistentry id="pw-top">
432 <term><command>pw-top</command></term>
433 <listitem>
434 <para>
435 displays real-time performance information from pipewire
436 </para>
437 <indexterm zone="pipewire pw-top">
438 <primary sortas="b-pw-top">pw-top</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="pw-v4l2">
444 <term><command>pw-v4l2</command></term>
445 <listitem>
446 <para>
447 runs v4l2 applications on a pipewire instance
448 </para>
449 <indexterm zone="pipewire pw-v4l2">
450 <primary sortas="b-pw-v4l2">pw-v4l2</primary>
451 </indexterm>
452 </listitem>
453 </varlistentry>
454
455 <varlistentry id="spa-acp-tool">
456 <term><command>spa-acp-tool</command></term>
457 <listitem>
458 <para>
459 inspects the card profile of a given sound card
460 </para>
461 <indexterm zone="pipewire spa-acp-tool">
462 <primary sortas="b-spa-acp-tool">spa-acp-tool</primary>
463 </indexterm>
464 </listitem>
465 </varlistentry>
466
467 <varlistentry id="spa-inspect">
468 <term><command>spa-inspect</command></term>
469 <listitem>
470 <para>
471 allows you to inspect pipewire plugins
472 </para>
473 <indexterm zone="pipewire spa-inspect">
474 <primary sortas="b-spa-inspect">spa-inspect</primary>
475 </indexterm>
476 </listitem>
477 </varlistentry>
478
479 <varlistentry id="spa-json-dump">
480 <term><command>spa-json-dump</command></term>
481 <listitem>
482 <para>
483 dumps the current pipewire configuration in JSON format.
484 </para>
485 <indexterm zone="pipewire spa-json-dump">
486 <primary sortas="b-spa-json-dump">spa-json-dump</primary>
487 </indexterm>
488 </listitem>
489 </varlistentry>
490
491 <varlistentry id="spa-monitor">
492 <term><command>spa-monitor</command></term>
493 <listitem>
494 <para>
495 allows you to monitor pipewire plugins
496 </para>
497 <indexterm zone="pipewire spa-monitor">
498 <primary sortas="b-spa-monitor">spa-monitor</primary>
499 </indexterm>
500 </listitem>
501 </varlistentry>
502
503 <varlistentry id="spa-resample">
504 <term><command>spa-resample</command></term>
505 <listitem>
506 <para>
507 resamples a given file
508 </para>
509 <indexterm zone="pipewire spa-resample">
510 <primary sortas="b-spa-resample">spa-resample</primary>
511 </indexterm>
512 </listitem>
513 </varlistentry>
514
515 <varlistentry id="libpipewire">
516 <term><filename class="libraryfile">libpipewire-0.3.so</filename></term>
517 <listitem>
518 <para>
519 contains API functions for handling multimedia pipelines
520 </para>
521 <indexterm zone="pipewire libpipewire">
522 <primary sortas="c-libpipewire">libpipewire-0.3.so</primary>
523 </indexterm>
524 </listitem>
525 </varlistentry>
526 <!-- not in /usr/lib
527 <varlistentry id="libpulse">
528 <term><filename class="libraryfile">libpulse.so</filename></term>
529 <listitem>
530 <para>
531 is a pipewire plugin for pulseaudio.
532 </para>
533 <indexterm zone="pipewire libpulse">
534 <primary sortas="c-libpulse">libpulse.so</primary>
535 </indexterm>
536 </listitem>
537 </varlistentry>
538
539 <varlistentry id="libpulse-simple">
540 <term><filename class="libraryfile">libpulse-simple.so</filename></term>
541 <listitem>
542 <para>
543 is a simplified version of the pulseaudio plugin for pipewire.
544 </para>
545 <indexterm zone="pipewire libpulse-simple">
546 <primary sortas="c-libpulse-simple">libpulse-simple.so</primary>
547 </indexterm>
548 </listitem>
549 </varlistentry>
550
551 <varlistentry id="libasound_module_pcm_pipewire">
552 <term><filename class="libraryfile">libasound_module_pcm_pipewire.so</filename></term>
553 <listitem>
554 <para>
555 is an ALSA plugin for pipewire.
556 </para>
557 <indexterm zone="pipewire libasound_module_pcm_pipewire">
558 <primary sortas="c-libasound_module_pcm_pipewire">libasound_module_pcm_pipewire.so</primary>
559 </indexterm>
560 </listitem>
561 </varlistentry>
562
563 <varlistentry id="libgstpipewire">
564 <term><filename class="libraryfile">libgstpipewire.so</filename></term>
565 <listitem>
566 <para>
567 is a Gstreamer plugin for pipewire.
568 </para>
569 <indexterm zone="pipewire libgstpipewire">
570 <primary sortas="c-libgstpipewire">libgstpipewire.so</primary>
571 </indexterm>
572 </listitem>
573 </varlistentry>-->
574 </variablelist>
575 </sect2>
576
577</sect1>
Note: See TracBrowser for help on using the repository browser.