source: multimedia/libdriv/pipewire.xml@ 5d69f635

11.0 11.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 5d69f635 was 5d69f635, checked in by Douglas R. Reno <renodr@…>, 17 months ago

Update to php-8.0.3
Update to pipewire-0.3.23
Update to libgdata-0.18.1

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

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