source: multimedia/libdriv/pipewire.xml@ fa0bead

10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since fa0bead was fa0bead, checked in by Bruce Dubbs <bdubbs@…>, 14 months ago

Update to pipewire-0.3.13.

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

  • Property mode set to 100644
File size: 15.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 "8261f4827182a24faee23e1df93026ce">
10 <!ENTITY pipewire-size "1.1 MB">
11 <!ENTITY pipewire-buildsize "117 MB (with tests)">
12 <!ENTITY pipewire-time "0.3 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 &lfs10_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://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 \
117 -Djack=false \
118 -Dpipewire-jack=false \
119 -Dvulkan=false \
120 .. &amp;&amp;
121ninja</userinput></screen>
122
123 <para>
124 To test the result, issue: <command>ninja test</command>.
125 </para>
126
127 <para>
128 Now, as the <systemitem class="username">root</systemitem> user:
129 </para>
130
131<screen role="root"><userinput>ninja install</userinput></screen>
132 </sect2>
133
134 <sect2 role="commands">
135 <title>Command Explanations</title>
136
137 <!-- Without these three parameters, Meson fails to run. -->
138 <para>
139 <parameter>-Djack=false</parameter>: This switch prevents building the
140 <application>JACK</application> plugin since
141 <application>JACK</application> is not in BLFS.
142 </para>
143
144 <para>
145 <parameter>-Dpipewire-jack=false</parameter>: This switch prevents
146 building <application>JACK</application> support into pipewire since
147 <application>JACK</application> is not in BLFS.
148 </para>
149
150 <para>
151 <parameter>-Dvulkan=false</parameter>: This switch prevents building
152 <application>Vulkan</application> API support into pipewire since
153 <application>Vulkan</application> is not in BLFS.
154 </para>
155
156 <para>
157 <option>-Ddocs=true</option>: This switch enables the generation of HTML
158 documentation. The optional dependencies for documentation need to be
159 installed for this to work.
160 </para>
161
162 <para>
163 <option>-Dman=true</option>: This switch enables the generation of manual
164 pages. The optional dependencies for documentation need to be installed
165 for this to work.
166 </para>
167 </sect2>
168
169 <sect2 role="content">
170 <title>Contents</title>
171
172 <segmentedlist>
173 <segtitle>Installed Programs</segtitle>
174 <segtitle>Installed Libraries</segtitle>
175 <segtitle>Installed Directories</segtitle>
176
177 <seglistitem>
178 <seg>
179 pipewire,
180 pipewire-media-session,
181 pw-cat,
182 pw-cli,
183 pw-dot,
184 pw-metadata,
185 pw-mididump,
186 pw-mon,
187 pw-profiler,
188 pw-pulse,
189 pw-reserve,
190 spa-acp-tool,
191 spa-inspect,
192 spa-monitor,
193 spa-resample, and
194 pw-midiplay, pw-midirecord, pw-play, and pw-record (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,
224 /usr/lib/pipewire-0.3, and
225 /usr/lib/spa-0.2
226 </seg>
227 </seglistitem>
228 </segmentedlist>
229
230 <variablelist>
231 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
232 <?dbfo list-presentation="list"?>
233 <?dbhtml list-presentation="table"?>
234
235 <varlistentry id="pipewire-prog">
236 <term><command>pipewire</command></term>
237 <listitem>
238 <para>
239 is a service that allows access to multimedia devices and allows
240 sharing of multimedia files between applications
241 </para>
242 <indexterm zone="pipewire pipewire-prog">
243 <primary sortas="b-pipewire">pipewire</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="pipewire-media-session">
249 <term><command>pipewire-media-session</command></term>
250 <listitem>
251 <para>
252 is a service that allows a desktop environment to know when media
253 files are being played through pipewire
254 </para>
255 <indexterm zone="pipewire pipewire-media-session">
256 <primary sortas="b-pipewire-media-session">pipewire-media-session</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="pw-cat">
262 <term><command>pw-cat</command></term>
263 <listitem>
264 <para>
265 allows you to play or record media using a pipewire instance
266 </para>
267 <indexterm zone="pipewire pw-cat">
268 <primary sortas="b-pw-cat">pw-cat</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="pw-cli">
274 <term><command>pw-cli</command></term>
275 <listitem>
276 <para>
277 allows you to interact with a pipewire instance
278 </para>
279 <indexterm zone="pipewire pw-cli">
280 <primary sortas="b-pw-cli">pw-cli</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="pw-dot">
286 <term><command>pw-dot</command></term>
287 <listitem>
288 <para>
289 lists all of the daemons and objects in use by pipewire
290 </para>
291 <indexterm zone="pipewire pw-dot">
292 <primary sortas="b-pw-dot">pw-dot</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="pw-metadata">
298 <term><command>pw-metadata</command></term>
299 <listitem>
300 <para>
301 inspects, adds, and removes metadata for objects
302 </para>
303 <indexterm zone="pipewire pw-metadata">
304 <primary sortas="b-pw-metadata">pw-metadata</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="pw-mididump">
310 <term><command>pw-mididump</command></term>
311 <listitem>
312 <para>
313 dumps MIDI messages from a file to the screen
314 </para>
315 <indexterm zone="pipewire pw-mididump">
316 <primary sortas="b-pw-mididump">pw-mididump</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="pw-mon">
322 <term><command>pw-mon</command></term>
323 <listitem>
324 <para>
325 allows you to monitor pipewire instances
326 </para>
327 <indexterm zone="pipewire pw-mon">
328 <primary sortas="b-pw-mon">pw-mon</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="pw-profiler">
334 <term><command>pw-profiler</command></term>
335 <listitem>
336 <para>
337 tracks memory usage and API calls used by pipewire.
338 </para>
339 <indexterm zone="pipewire pw-profiler">
340 <primary sortas="b-pw-profiler">pw-profiler</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 <varlistentry id="pw-pulse">
346 <term><command>pw-pulse</command></term>
347 <listitem>
348 <para>
349 runs Pulseaudio applications on pipewire
350 </para>
351 <indexterm zone="pipewire pw-pulse">
352 <primary sortas="b-pw-pulse">pw-pulse</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="pw-reserve">
358 <term><command>pw-reserve</command></term>
359 <listitem>
360 <para>
361 reserves or monitors a device via D-Bus
362 </para>
363 <indexterm zone="pipewire pw-reserve">
364 <primary sortas="b-pw-reserve">pw-reserve</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="spa-acp-tool">
370 <term><command>spa-acp-tool</command></term>
371 <listitem>
372 <para>
373 inspects the card profile of a given sound card
374 </para>
375 <indexterm zone="pipewire spa-acp-tool">
376 <primary sortas="b-spa-acp-tool">spa-acp-tool</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="spa-inspect">
382 <term><command>spa-inspect</command></term>
383 <listitem>
384 <para>
385 allows you to inspect pipewire plugins
386 </para>
387 <indexterm zone="pipewire spa-inspect">
388 <primary sortas="b-spa-inspect">spa-inspect</primary>
389 </indexterm>
390 </listitem>
391 </varlistentry>
392
393 <varlistentry id="spa-monitor">
394 <term><command>spa-monitor</command></term>
395 <listitem>
396 <para>
397 allows you to monitor pipewire plugins
398 </para>
399 <indexterm zone="pipewire spa-monitor">
400 <primary sortas="b-spa-monitor">spa-monitor</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="spa-resample">
406 <term><command>spa-resample</command></term>
407 <listitem>
408 <para>
409 esamples a given file
410 </para>
411 <indexterm zone="pipewire spa-resample">
412 <primary sortas="b-spa-resample">spa-resample</primary>
413 </indexterm>
414 </listitem>
415 </varlistentry>
416
417 <varlistentry id="libpipewire">
418 <term><filename class="libraryfile">libpipewire-0.3.so</filename></term>
419 <listitem>
420 <para>
421 contains API functions for handling multimedia pipelines.
422 </para>
423 <indexterm zone="pipewire libpipewire">
424 <primary sortas="c-libpipewire">libpipewire-0.3.so</primary>
425 </indexterm>
426 </listitem>
427 </varlistentry>
428<!--
429 <varlistentry id="libpulse-mainloop-glib-pw">
430 <term><filename class="libraryfile">libpulse-mainloop-glib-pw.so</filename></term>
431 <listitem>
432 <para>
433 provides a glib main() loop for pulseaudio to route media through
434 pipewire.
435 </para>
436 <indexterm zone="pipewire libpulse-mainloop-glib-pw">
437 <primary sortas="c-libpulse-mainloop-glib-pw">libpulse-mainloop-glib-pw.so</primary>
438 </indexterm>
439 </listitem>
440 </varlistentry>
441
442 <varlistentry id="libpulse">
443 <term><filename class="libraryfile">libpulse.so</filename></term>
444 <listitem>
445 <para>
446 is a pipewire plugin for pulseaudio.
447 </para>
448 <indexterm zone="pipewire libpulse">
449 <primary sortas="c-libpulse">libpulse.so</primary>
450 </indexterm>
451 </listitem>
452 </varlistentry>
453
454 <varlistentry id="libpulse-simple">
455 <term><filename class="libraryfile">libpulse-simple.so</filename></term>
456 <listitem>
457 <para>
458 is a simplified version of the pulseaudio plugin for pipewire.
459 </para>
460 <indexterm zone="pipewire libpulse-simple">
461 <primary sortas="c-libpulse-simple">libpulse-simple.so</primary>
462 </indexterm>
463 </listitem>
464 </varlistentry>
465
466 <varlistentry id="libasound_module_pcm_pipewire">
467 <term><filename class="libraryfile">libasound_module_pcm_pipewire.so</filename></term>
468 <listitem>
469 <para>
470 is an ALSA plugin for pipewire.
471 </para>
472 <indexterm zone="pipewire libasound_module_pcm_pipewire">
473 <primary sortas="c-libasound_module_pcm_pipewire">libasound_module_pcm_pipewire.so</primary>
474 </indexterm>
475 </listitem>
476 </varlistentry>
477
478 <varlistentry id="libgstpipewire">
479 <term><filename class="libraryfile">libgstpipewire.so</filename></term>
480 <listitem>
481 <para>
482 is a Gstreamer plugin for pipewire.
483 </para>
484 <indexterm zone="pipewire libgstpipewire">
485 <primary sortas="c-libgstpipewire">libgstpipewire.so</primary>
486 </indexterm>
487 </listitem>
488 </varlistentry>-->
489 </variablelist>
490 </sect2>
491</sect1>
Note: See TracBrowser for help on using the repository browser.