source: multimedia/libdriv/pipewire.xml@ 11eb3ae5

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 11eb3ae5 was 11eb3ae5, checked in by Douglas R. Reno <renodr@…>, 17 months ago

Update to llvm-10.0.1
Update to libseccomp-2.5.0
Update to pipewire-0.3.7
Minor text tweaks

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

  • Property mode set to 100644
File size: 13.6 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 "79111984d9cdd3d132e5f334099477cb">
10 <!ENTITY pipewire-size "1.0 MB">
11 <!ENTITY pipewire-buildsize "108 MB">
12 <!ENTITY pipewire-time "0.4 SBU (Using parallelism=4)">
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 &lfs91_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 --sysconfdir=/etc \
118 -Djack=false \
119 -Dpipewire-jack=false \
120 -Dvulkan=false \
121 .. &amp;&amp;
122ninja</userinput></screen>
123
124 <para>
125 This package does not come with a test suite.
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 pw-cat,
183 pw-cli,
184 pw-dot,
185 pw-metadata,
186 pw-mididump,
187 pw-mon,
188 pw-profiler,
189 pw-pulse,
190 spa-inspect,
191 spa-monitor, and
192 pw-midirecord, pw-midiplay, pw-play, and pw-record (symlinks to pw-cat)
193 </seg>
194 <seg>
195 libpipewire-0.3.so,
196 libpulse-mainloop-glib-pw.so,
197 libpulse.so,
198 libpulse-simple.so,
199 libasound_module_pcm_pipewire.so, and
200 libgstpipewire.so
201 </seg>
202 <seg>
203 /etc/pipewire,
204 /usr/include/pipewire-0.3,
205 /usr/include/spa-0.2,
206 /usr/lib/pipewire-0.3, and
207 /usr/lib/spa-0.2
208 </seg>
209 </seglistitem>
210 </segmentedlist>
211
212 <variablelist>
213 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
214 <?dbfo list-presentation="list"?>
215 <?dbhtml list-presentation="table"?>
216
217 <varlistentry id="pipewire-prog">
218 <term><command>pipewire</command></term>
219 <listitem>
220 <para>
221 is a service that allows access to multimedia devices and allows
222 sharing of multimedia files between applications.
223 </para>
224 <indexterm zone="pipewire pipewire-prog">
225 <primary sortas="b-pipewire">pipewire</primary>
226 </indexterm>
227 </listitem>
228 </varlistentry>
229
230 <varlistentry id="pipewire-media-session">
231 <term><command>pipewire-media-session</command></term>
232 <listitem>
233 <para>
234 is a service that allows a desktop environment to know when media
235 files are being played through pipewire.
236 </para>
237 <indexterm zone="pipewire pipewire-media-session">
238 <primary sortas="b-pipewire-media-session">pipewire-media-session</primary>
239 </indexterm>
240 </listitem>
241 </varlistentry>
242
243 <varlistentry id="pw-cat">
244 <term><command>pw-cat</command></term>
245 <listitem>
246 <para>
247 allows you to play or record media using an pipewire instance.
248 </para>
249 <indexterm zone="pipewire pw-cat">
250 <primary sortas="b-pw-cat">pw-cat</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="pw-cli">
256 <term><command>pw-cli</command></term>
257 <listitem>
258 <para>
259 allows you to interact with a pipewire instance.
260 </para>
261 <indexterm zone="pipewire pw-cli">
262 <primary sortas="b-pw-cli">pw-cli</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry id="pw-dot">
268 <term><command>pw-dot</command></term>
269 <listitem>
270 <para>
271 lists all of the daemons and objects in use by pipewire.
272 </para>
273 <indexterm zone="pipewire pw-dot">
274 <primary sortas="b-pw-dot">pw-dot</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="pw-metadata">
280 <term><command>pw-metadata</command></term>
281 <listitem>
282 <para>
283 inspects, adds, and removes metadata for objects.
284 </para>
285 <indexterm zone="pipewire pw-metadata">
286 <primary sortas="b-pw-metadata">pw-metadata</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="pw-mididump">
292 <term><command>pw-mididump</command></term>
293 <listitem>
294 <para>
295 dumps MIDI messages from a file to the screen.
296 </para>
297 <indexterm zone="pipewire pw-mididump">
298 <primary sortas="b-pw-mididump">pw-mididump</primary>
299 </indexterm>
300 </listitem>
301 </varlistentry>
302
303 <varlistentry id="pw-mon">
304 <term><command>pw-mon</command></term>
305 <listitem>
306 <para>
307 allows you to monitor pipewire instances.
308 </para>
309 <indexterm zone="pipewire pw-mon">
310 <primary sortas="b-pw-mon">pw-mon</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="pw-profiler">
316 <term><command>pw-profiler</command></term>
317 <listitem>
318 <para>
319 tracks memory usage and API calls used by pipewire.
320 </para>
321 <indexterm zone="pipewire pw-profiler">
322 <primary sortas="b-pw-profiler">pw-profiler</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="pw-pulse">
328 <term><command>pw-pulse</command></term>
329 <listitem>
330 <para>
331 runs Pulseaudio applications on pipewire
332 </para>
333 <indexterm zone="pipewire pw-pulse">
334 <primary sortas="b-pw-pulse">pw-pulse</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry id="spa-inspect">
340 <term><command>spa-inspect</command></term>
341 <listitem>
342 <para>
343 allows you to inspect pipewire plugins.
344 </para>
345 <indexterm zone="pipewire spa-inspect">
346 <primary sortas="b-spa-inspect">spa-inspect</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="spa-monitor">
352 <term><command>spa-monitor</command></term>
353 <listitem>
354 <para>
355 allows you to monitor pipewire plugins.
356 </para>
357 <indexterm zone="pipewire spa-monitor">
358 <primary sortas="b-spa-monitor">spa-monitor</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="libpipewire">
364 <term><filename class="libraryfile">libpipewire-0.3.so</filename></term>
365 <listitem>
366 <para>
367 contains API functions for handling multimedia pipelines.
368 </para>
369 <indexterm zone="pipewire libpipewire">
370 <primary sortas="c-libpipewire">libpipewire-0.3.so</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="libpulse-mainloop-glib-pw">
376 <term><filename class="libraryfile">libpulse-mainloop-glib-pw.so</filename></term>
377 <listitem>
378 <para>
379 provides a glib main() loop for pulseaudio to route media through
380 pipewire.
381 </para>
382 <indexterm zone="pipewire libpulse-mainloop-glib-pw">
383 <primary sortas="c-libpulse-mainloop-glib-pw">libpulse-mainloop-glib-pw.so</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="libpulse">
389 <term><filename class="libraryfile">libpulse.so</filename></term>
390 <listitem>
391 <para>
392 is a pipewire plugin for pulseaudio.
393 </para>
394 <indexterm zone="pipewire libpulse">
395 <primary sortas="c-libpulse">libpulse.so</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="libpulse-simple">
401 <term><filename class="libraryfile">libpulse-simple.so</filename></term>
402 <listitem>
403 <para>
404 is a simplified version of the pulseaudio plugin for pipewire.
405 </para>
406 <indexterm zone="pipewire libpulse-simple">
407 <primary sortas="c-libpulse-simple">libpulse-simple.so</primary>
408 </indexterm>
409 </listitem>
410 </varlistentry>
411
412 <varlistentry id="libasound_module_pcm_pipewire">
413 <term><filename class="libraryfile">libasound_module_pcm_pipewire.so</filename></term>
414 <listitem>
415 <para>
416 is an ALSA plugin for pipewire.
417 </para>
418 <indexterm zone="pipewire libasound_module_pcm_pipewire">
419 <primary sortas="c-libasound_module_pcm_pipewire">libasound_module_pcm_pipewire.so</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="libgstpipewire">
425 <term><filename class="libraryfile">libgstpipewire.so</filename></term>
426 <listitem>
427 <para>
428 is a Gstreamer plugin for pipewire.
429 </para>
430 <indexterm zone="pipewire libgstpipewire">
431 <primary sortas="c-libgstpipewire">libgstpipewire.so</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435 </variablelist>
436 </sect2>
437</sect1>
Note: See TracBrowser for help on using the repository browser.