source: multimedia/libdriv/pipewire.xml@ 63b1a9a

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 63b1a9a was 63b1a9a, checked in by Douglas R. Reno <renodr@…>, 18 months ago

Update to pipewire-0.3.6

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

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