source: multimedia/libdriv/pipewire.xml@ 45ab6c7

11.0 ken/refactor-virt lazarus qt5new trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 5 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

  • Property mode set to 100644
File size: 17.5 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 "887be3193a91f18c7ea63e3f5c61976b">
10 <!ENTITY pipewire-size "1.3 MB">
11 <!ENTITY pipewire-buildsize "135 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 <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 &lfs101_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">Required</bridgehead>
77 <para role="required">
78 <xref linkend="bluez"/>,
79 <xref linkend="ffmpeg"/>,
80 <xref linkend="gstreamer10"/>,
81 <xref linkend="gst10-plugins-base"/>,
82 <xref linkend="libva"/>,
83 <xref linkend="pulseaudio"/>,
84 <xref linkend="sbc"/>,
85 <xref linkend="sdl2"/>, and
86 <xref linkend="v4l-utils"/>
87 </para>
88
89 <bridgehead renderas="sect4">Optional</bridgehead>
90 <para role="optional">
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://vulkan.lunarg.com/sdk/home/">Vulkan</ulink>, and
97 <ulink url="https://sourceforge.net/projects/xmltoman/">xmltoman</ulink>
98 </para>
99
100 <para condition="html" role="usernotes">
101 User Notes: <ulink url="&blfs-wiki;/pipewire"/>
102 </para>
103 </sect2>
104
105 <sect2 role="installation">
106 <title>Installation of Pipewire</title>
107
108 <para>
109 Install <application>pipewire</application> by running the following
110 commands:
111 </para>
112
113<screen><userinput>mkdir build &amp;&amp;
114cd build &amp;&amp;
115
116meson --prefix=/usr .. &amp;&amp;
117ninja</userinput></screen>
118
119 <para>
120 To test the result, issue: <command>ninja test</command>.
121 </para>
122
123 <para>
124 Now, as the <systemitem class="username">root</systemitem> user:
125 </para>
126
127<screen role="root"><userinput>ninja install</userinput></screen>
128 </sect2>
129
130 <sect2 role="commands">
131 <title>Command Explanations</title>
132
133 <!-- Without these three parameters, Meson fails to run. -->
134 <!-- Not true anymore, commenting out as of 0.3.24
135 <para>
136 <parameter>-Djack=false</parameter>: This switch prevents building the
137 <application>JACK</application> plugin since
138 <application>JACK</application> is not in BLFS.
139 </para>
140
141 <para>
142 <parameter>-Dpipewire-jack=false</parameter>: This switch prevents
143 building <application>JACK</application> support into pipewire since
144 <application>JACK</application> is not in BLFS.
145 </para>
146
147 <para>
148 <parameter>-Dvulkan=false</parameter>: This switch prevents building
149 <application>Vulkan</application> API support into pipewire since
150 <application>Vulkan</application> is not in BLFS.
151 </para>
152 -->
153
154 <para>
155 <option>-Ddocs=true</option>: This switch enables the generation of HTML
156 documentation. The optional dependencies for documentation need to be
157 installed for this to work.
158 </para>
159
160 <para>
161 <option>-Dman=true</option>: This switch enables the generation of manual
162 pages. The optional dependencies for documentation need to be installed
163 for this to work.
164 </para>
165 </sect2>
166
167 <sect2 role="content">
168 <title>Contents</title>
169
170 <segmentedlist>
171 <segtitle>Installed Programs</segtitle>
172 <segtitle>Installed Libraries</segtitle>
173 <segtitle>Installed Directories</segtitle>
174
175 <seglistitem>
176 <seg>
177 pipewire,
178 pipewire-media-session,
179 pipewire-pulse,
180 pw-cat,
181 pw-cli,
182 pw-dot,
183 pw-dump,
184 pw-jack,
185 pw-metadata,
186 pw-mididump,
187 pw-mon,
188 pw-profiler,
189 <!--pw-pulse,-->
190 pw-reserve,
191 pw-top,
192 spa-acp-tool,
193 spa-inspect,
194 spa-json-dump,
195 spa-monitor,
196 spa-resample, and
197 pw-midiplay, pw-midirecord, pw-play, and pw-record (symlinks to pw-cat)
198 </seg>
199 <seg>
200 libpipewire-0.3.so and
201 30 modules below /usr/lib/pipewire-0.3<!--,
202 [pierre July 29th, 2020]: all the following libs are in subdirectories
203 of /usr/lib. I'm not sure they should appear. But if they should, there
204 are many more libs to list...
205 libpulse-mainloop-glib-pw.so,
206 libpulse.so,
207 libpulse-simple.so,
208 libasound_module_pcm_pipewire.so, and
209 libgstpipewire.so
210 [bdubbs Sep 29th, 2020]: add
211 libpipewire-module-{access,adapter,client-device,client-node,
212 link-factory,metadata,portal,profiler,protocol-native,
213 rtkit,session-manager,spa-device,spa-device-factory,spa-node,
214 spa-node-factory}.so
215 libasound_module_ctl_pipewire.so
216 libasound_module_pcm_pipewire.so
217 libspa-{alsa,audioconvert,audiomixer,bluez5,control,dbus,support
218 v4l2,videoconvert}.so
219 -->
220 </seg>
221 <seg>
222 /etc/pipewire,
223 /usr/include/pipewire-0.3,
224 /usr/include/spa-0.2,
225 /usr/lib/alsa-lib,
226 /usr/lib/gstreamer-1.0,
227 /usr/lib/pipewire-0.3, and
228 /usr/lib/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-metadata">
339 <term><command>pw-metadata</command></term>
340 <listitem>
341 <para>
342 inspects, adds, and removes metadata for objects
343 </para>
344 <indexterm zone="pipewire pw-metadata">
345 <primary sortas="b-pw-metadata">pw-metadata</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="pw-mididump">
351 <term><command>pw-mididump</command></term>
352 <listitem>
353 <para>
354 dumps MIDI messages from a file to the screen
355 </para>
356 <indexterm zone="pipewire pw-mididump">
357 <primary sortas="b-pw-mididump">pw-mididump</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="pw-mon">
363 <term><command>pw-mon</command></term>
364 <listitem>
365 <para>
366 allows you to monitor pipewire instances
367 </para>
368 <indexterm zone="pipewire pw-mon">
369 <primary sortas="b-pw-mon">pw-mon</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 <varlistentry id="pw-profiler">
375 <term><command>pw-profiler</command></term>
376 <listitem>
377 <para>
378 tracks memory usage and API calls used by pipewire
379 </para>
380 <indexterm zone="pipewire pw-profiler">
381 <primary sortas="b-pw-profiler">pw-profiler</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386<!--
387 <varlistentry id="pw-pulse">
388 <term><command>pw-pulse</command></term>
389 <listitem>
390 <para>
391 runs Pulseaudio applications on pipewire.
392 </para>
393 <indexterm zone="pipewire pw-pulse">
394 <primary sortas="b-pw-pulse">pw-pulse</primary>
395 </indexterm>
396 </listitem>
397 </varlistentry>
398-->
399
400 <varlistentry id="pw-reserve">
401 <term><command>pw-reserve</command></term>
402 <listitem>
403 <para>
404 reserves or monitors a device via D-Bus
405 </para>
406 <indexterm zone="pipewire pw-reserve">
407 <primary sortas="b-pw-reserve">pw-reserve</primary>
408 </indexterm>
409 </listitem>
410 </varlistentry>
411
412 <varlistentry id="pw-top">
413 <term><command>pw-top</command></term>
414 <listitem>
415 <para>
416 displays real-time performance information from pipewire
417 </para>
418 <indexterm zone="pipewire pw-top">
419 <primary sortas="b-pw-top">pw-top</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="spa-acp-tool">
425 <term><command>spa-acp-tool</command></term>
426 <listitem>
427 <para>
428 inspects the card profile of a given sound card
429 </para>
430 <indexterm zone="pipewire spa-acp-tool">
431 <primary sortas="b-spa-acp-tool">spa-acp-tool</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="spa-inspect">
437 <term><command>spa-inspect</command></term>
438 <listitem>
439 <para>
440 allows you to inspect pipewire plugins
441 </para>
442 <indexterm zone="pipewire spa-inspect">
443 <primary sortas="b-spa-inspect">spa-inspect</primary>
444 </indexterm>
445 </listitem>
446 </varlistentry>
447
448 <varlistentry id="spa-json-dump">
449 <term><command>spa-json-dump</command></term>
450 <listitem>
451 <para>
452 dumps the current pipewire configuration in JSON format.
453 </para>
454 <indexterm zone="pipewire spa-json-dump">
455 <primary sortas="b-spa-json-dump">spa-json-dump</primary>
456 </indexterm>
457 </listitem>
458 </varlistentry>
459
460 <varlistentry id="spa-monitor">
461 <term><command>spa-monitor</command></term>
462 <listitem>
463 <para>
464 allows you to monitor pipewire plugins
465 </para>
466 <indexterm zone="pipewire spa-monitor">
467 <primary sortas="b-spa-monitor">spa-monitor</primary>
468 </indexterm>
469 </listitem>
470 </varlistentry>
471
472 <varlistentry id="spa-resample">
473 <term><command>spa-resample</command></term>
474 <listitem>
475 <para>
476 resamples a given file
477 </para>
478 <indexterm zone="pipewire spa-resample">
479 <primary sortas="b-spa-resample">spa-resample</primary>
480 </indexterm>
481 </listitem>
482 </varlistentry>
483
484 <varlistentry id="libpipewire">
485 <term><filename class="libraryfile">libpipewire-0.3.so</filename></term>
486 <listitem>
487 <para>
488 contains API functions for handling multimedia pipelines
489 </para>
490 <indexterm zone="pipewire libpipewire">
491 <primary sortas="c-libpipewire">libpipewire-0.3.so</primary>
492 </indexterm>
493 </listitem>
494 </varlistentry>
495<!--
496 <varlistentry id="libpulse-mainloop-glib-pw">
497 <term><filename class="libraryfile">libpulse-mainloop-glib-pw.so</filename></term>
498 <listitem>
499 <para>
500 provides a glib main() loop for pulseaudio to route media through
501 pipewire.
502 </para>
503 <indexterm zone="pipewire libpulse-mainloop-glib-pw">
504 <primary sortas="c-libpulse-mainloop-glib-pw">libpulse-mainloop-glib-pw.so</primary>
505 </indexterm>
506 </listitem>
507 </varlistentry>
508
509 <varlistentry id="libpulse">
510 <term><filename class="libraryfile">libpulse.so</filename></term>
511 <listitem>
512 <para>
513 is a pipewire plugin for pulseaudio.
514 </para>
515 <indexterm zone="pipewire libpulse">
516 <primary sortas="c-libpulse">libpulse.so</primary>
517 </indexterm>
518 </listitem>
519 </varlistentry>
520
521 <varlistentry id="libpulse-simple">
522 <term><filename class="libraryfile">libpulse-simple.so</filename></term>
523 <listitem>
524 <para>
525 is a simplified version of the pulseaudio plugin for pipewire.
526 </para>
527 <indexterm zone="pipewire libpulse-simple">
528 <primary sortas="c-libpulse-simple">libpulse-simple.so</primary>
529 </indexterm>
530 </listitem>
531 </varlistentry>
532
533 <varlistentry id="libasound_module_pcm_pipewire">
534 <term><filename class="libraryfile">libasound_module_pcm_pipewire.so</filename></term>
535 <listitem>
536 <para>
537 is an ALSA plugin for pipewire.
538 </para>
539 <indexterm zone="pipewire libasound_module_pcm_pipewire">
540 <primary sortas="c-libasound_module_pcm_pipewire">libasound_module_pcm_pipewire.so</primary>
541 </indexterm>
542 </listitem>
543 </varlistentry>
544
545 <varlistentry id="libgstpipewire">
546 <term><filename class="libraryfile">libgstpipewire.so</filename></term>
547 <listitem>
548 <para>
549 is a Gstreamer plugin for pipewire.
550 </para>
551 <indexterm zone="pipewire libgstpipewire">
552 <primary sortas="c-libgstpipewire">libgstpipewire.so</primary>
553 </indexterm>
554 </listitem>
555 </varlistentry>-->
556 </variablelist>
557 </sect2>
558
559</sect1>
Note: See TracBrowser for help on using the repository browser.