source: multimedia/libdriv/pipewire.xml@ c65511f5

11.2 11.3 12.0 12.1 gimp3 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/soup3 xry111/spidermonkey128 xry111/xf86-video-removal
Last change on this file since c65511f5 was 555c452, checked in by Douglas R. Reno <renodr@…>, 2 years ago

Package Updates:

Update to pipewire-0.3.52
Update to gnome-bluetooth-42.1
Update to libreoffice-7.3.4.2
  • Property mode set to 100644
File size: 18.5 KB
RevLine 
[dcea4e3]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 " ">
[555c452]9 <!ENTITY pipewire-md5sum "489aa4ab3b404a4c489c5b2ebcaeae2c">
[9501a015]10 <!ENTITY pipewire-size "1.7 MB">
[555c452]11 <!ENTITY pipewire-buildsize "151 MB (with tests)">
12 <!ENTITY pipewire-time "0.4 SBU (with tests, both using parallelism=4)">
[dcea4e3]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
[394eb4c6]38 &lfs111_checked;
[dcea4e3]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
[dab0680]76 <bridgehead renderas="sect4">Recommended</bridgehead>
77 <para role="recommended">
[9bd10279]78 <xref linkend="bluez"/>,
[dcea4e3]79 <xref linkend="gstreamer10"/>,
80 <xref linkend="gst10-plugins-base"/>,
81 <xref linkend="libva"/>,
[42e419b5]82 <xref linkend="pulseaudio"/>,
[9bd10279]83 <xref linkend="sbc"/>,
84 <xref linkend="sdl2"/>, and
85 <xref linkend="v4l-utils"/>
[dcea4e3]86 </para>
87
88 <bridgehead renderas="sect4">Optional</bridgehead>
89 <para role="optional">
[e07baac6]90 <xref linkend="ffmpeg"/>,
[dcea4e3]91 <xref linkend="valgrind"/>,
92 <xref linkend="doxygen"/> and
[9bd10279]93 <xref linkend="graphviz"/> (for documentation),
94 <ulink url="https://jackaudio.org/">JACK</ulink>,
[73fb07ad]95 <ulink url="https://github.com/EHfive/ldacBT">ldacBT</ulink>,
[a4586ac9]96 <ulink url="https://libcamera.org/">libcamera</ulink>,
[9bd10279]97 <ulink url="https://vulkan.lunarg.com/sdk/home/">Vulkan</ulink>, and
98 <ulink url="https://sourceforge.net/projects/xmltoman/">xmltoman</ulink>
[dcea4e3]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;
[aa17ca8]115cd build &amp;&amp;
[dcea4e3]116
[7fa5ff6]117meson --prefix=/usr --buildtype=release -Dsession-managers= .. &amp;&amp;
[dcea4e3]118ninja</userinput></screen>
119
120 <para>
[82a9ecf]121 To test the result, issue: <command>ninja test</command>.
[dcea4e3]122 </para>
123
124 <para>
125 Now, as the <systemitem class="username">root</systemitem> user:
126 </para>
127
128<screen role="root"><userinput>ninja install</userinput></screen>
129 </sect2>
130
131 <sect2 role="commands">
132 <title>Command Explanations</title>
133
[20f070d8]134 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
135 href="../../xincludes/meson-buildtype-release.xml"/>
136
[9bd10279]137 <para>
[7a9a7b26]138 <parameter>-Dsession-managers=</parameter>: This switch
[7fa5ff6]139 prevents automatic downloading external dependencies.
[9bd10279]140 </para>
141
[dcea4e3]142 <para>
143 <option>-Ddocs=true</option>: This switch enables the generation of HTML
144 documentation. The optional dependencies for documentation need to be
145 installed for this to work.
146 </para>
147
148 <para>
149 <option>-Dman=true</option>: This switch enables the generation of manual
150 pages. The optional dependencies for documentation need to be installed
151 for this to work.
152 </para>
153 </sect2>
154
155 <sect2 role="content">
156 <title>Contents</title>
157
158 <segmentedlist>
159 <segtitle>Installed Programs</segtitle>
160 <segtitle>Installed Libraries</segtitle>
161 <segtitle>Installed Directories</segtitle>
162
163 <seglistitem>
164 <seg>
165 pipewire,
[1e2d824d]166 <!--pipewire-media-session,-->
[7a96e1b]167 pipewire-pulse,
[9bd10279]168 pw-cat,
169 pw-cli,
170 pw-dot,
[7c9ae62]171 pw-dump,
[cceceaaf]172 pw-jack,
[0ec63138]173 pw-link,
174 pw-loopback,
[42e419b5]175 pw-metadata,
176 pw-mididump,
[9bd10279]177 pw-mon,
178 pw-profiler,
[7a96e1b]179 <!--pw-pulse,-->
[fa0bead]180 pw-reserve,
[7c9ae62]181 pw-top,
[59f6a1f]182 pw-v4l2,
[fa0bead]183 spa-acp-tool,
[9bd10279]184 spa-inspect,
[5d69f635]185 spa-json-dump,
[8558044]186 spa-monitor,
[fa0bead]187 spa-resample, and
[59f6a1f]188 pw-dsdplay, pw-midiplay, pw-midirecord, pw-play, and pw-record
189 (symlinks to pw-cat)
[dcea4e3]190 </seg>
191 <seg>
[fa0bead]192 libpipewire-0.3.so and
193 30 modules below /usr/lib/pipewire-0.3<!--,
[da1575a]194 [pierre July 29th, 2020]: all the following libs are in subdirectories
195 of /usr/lib. I'm not sure they should appear. But if they should, there
[8558044]196 are many more libs to list...
[9bd10279]197 libpulse-mainloop-glib-pw.so,
[11eb3ae5]198 libpulse.so,
199 libpulse-simple.so,
[9bd10279]200 libasound_module_pcm_pipewire.so, and
[8558044]201 libgstpipewire.so
[fa0bead]202 [bdubbs Sep 29th, 2020]: add
203 libpipewire-module-{access,adapter,client-device,client-node,
204 link-factory,metadata,portal,profiler,protocol-native,
205 rtkit,session-manager,spa-device,spa-device-factory,spa-node,
206 spa-node-factory}.so
207 libasound_module_ctl_pipewire.so
208 libasound_module_pcm_pipewire.so
209 libspa-{alsa,audioconvert,audiomixer,bluez5,control,dbus,support
210 v4l2,videoconvert}.so
211 -->
[dcea4e3]212 </seg>
213 <seg>
[1e2d824d]214 <!--/etc/pipewire,-->
[8558044]215 /usr/include/pipewire-0.3,
[9bd10279]216 /usr/include/spa-0.2,
[fa0bead]217 /usr/lib/alsa-lib,
[1e2d824d]218 <!--/usr/lib/gstreamer-1.0, already installed by gstreamer-->
219 /usr/lib/pipewire-0.3,
220 /usr/lib/spa-0.2,
221 /usr/share/alsa-card-profile,
222 /usr/share/pipewire, and
223 /usr/share/spa-0.2
[dcea4e3]224 </seg>
225 </seglistitem>
226 </segmentedlist>
227
228 <variablelist>
229 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
230 <?dbfo list-presentation="list"?>
231 <?dbhtml list-presentation="table"?>
232
233 <varlistentry id="pipewire-prog">
234 <term><command>pipewire</command></term>
235 <listitem>
236 <para>
237 is a service that allows access to multimedia devices and allows
[4c24eb0a]238 sharing of multimedia files between applications
[dcea4e3]239 </para>
240 <indexterm zone="pipewire pipewire-prog">
241 <primary sortas="b-pipewire">pipewire</primary>
242 </indexterm>
243 </listitem>
244 </varlistentry>
245
[9bd10279]246 <varlistentry id="pipewire-media-session">
247 <term><command>pipewire-media-session</command></term>
248 <listitem>
249 <para>
250 is a service that allows a desktop environment to know when media
[4c24eb0a]251 files are being played through pipewire
[9bd10279]252 </para>
253 <indexterm zone="pipewire pipewire-media-session">
254 <primary sortas="b-pipewire-media-session">pipewire-media-session</primary>
255 </indexterm>
256 </listitem>
257 </varlistentry>
258
[7a96e1b]259 <varlistentry id="pipewire-pulse">
260 <term><command>pipewire-pulse</command></term>
261 <listitem>
262 <para>
[8558044]263 starts a Pulseaudio-compatible version of
[4c24eb0a]264 the pipewire service
[7a96e1b]265 </para>
266 <indexterm zone="pipewire pipewire-pulse">
267 <primary sortas="b-pipewire-pulse">pipewire-pulse</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
[9bd10279]272 <varlistentry id="pw-cat">
273 <term><command>pw-cat</command></term>
274 <listitem>
275 <para>
[4c24eb0a]276 allows you to play or record media using a pipewire instance
[9bd10279]277 </para>
278 <indexterm zone="pipewire pw-cat">
279 <primary sortas="b-pw-cat">pw-cat</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="pw-cli">
285 <term><command>pw-cli</command></term>
[dcea4e3]286 <listitem>
287 <para>
[4c24eb0a]288 allows you to interact with a pipewire instance
[dcea4e3]289 </para>
[9bd10279]290 <indexterm zone="pipewire pw-cli">
291 <primary sortas="b-pw-cli">pw-cli</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="pw-dot">
297 <term><command>pw-dot</command></term>
298 <listitem>
299 <para>
[4c24eb0a]300 lists all of the daemons and objects in use by pipewire
[9bd10279]301 </para>
302 <indexterm zone="pipewire pw-dot">
303 <primary sortas="b-pw-dot">pw-dot</primary>
[dcea4e3]304 </indexterm>
305 </listitem>
306 </varlistentry>
307
[7c9ae62]308 <varlistentry id="pw-dump">
309 <term><command>pw-dump</command></term>
310 <listitem>
311 <para>
312 dumps debug messages from a local or remote pipewire instance to
[4c24eb0a]313 the console
[7c9ae62]314 </para>
315 <indexterm zone="pipewire pw-dump">
316 <primary sortas="b-pw-dump">pw-dump</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
[cceceaaf]321 <varlistentry id="pw-jack">
322 <term><command>pw-jack</command></term>
323 <listitem>
324 <para>
[0ec63138]325 runs JACK applications on a pipewire instance
[cceceaaf]326 </para>
327 <indexterm zone="pipewire pw-jack">
328 <primary sortas="b-pw-jack">pw-jack</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
[0ec63138]333 <varlistentry id="pw-link">
334 <term><command>pw-link</command></term>
335 <listitem>
336 <para>
337 links pipewire ports together
338 </para>
339 <indexterm zone="pipewire pw-link">
340 <primary sortas="b-pw-link">pw-link</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 <varlistentry id="pw-loopback">
346 <term><command>pw-loopback</command></term>
347 <listitem>
348 <para>
349 initializes a loopback link between two different pipewire ports.
350 This is useful for testing and debugging
351 </para>
352 <indexterm zone="pipewire pw-loopback">
353 <primary sortas="b-pw-loopback">pw-loopback</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
[42e419b5]358 <varlistentry id="pw-metadata">
359 <term><command>pw-metadata</command></term>
360 <listitem>
361 <para>
[4c24eb0a]362 inspects, adds, and removes metadata for objects
[42e419b5]363 </para>
364 <indexterm zone="pipewire pw-metadata">
365 <primary sortas="b-pw-metadata">pw-metadata</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="pw-mididump">
371 <term><command>pw-mididump</command></term>
372 <listitem>
373 <para>
[4c24eb0a]374 dumps MIDI messages from a file to the screen
[42e419b5]375 </para>
376 <indexterm zone="pipewire pw-mididump">
377 <primary sortas="b-pw-mididump">pw-mididump</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
[9bd10279]382 <varlistentry id="pw-mon">
383 <term><command>pw-mon</command></term>
[dcea4e3]384 <listitem>
385 <para>
[4c24eb0a]386 allows you to monitor pipewire instances
[dcea4e3]387 </para>
[9bd10279]388 <indexterm zone="pipewire pw-mon">
389 <primary sortas="b-pw-mon">pw-mon</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="pw-profiler">
395 <term><command>pw-profiler</command></term>
396 <listitem>
397 <para>
[4c24eb0a]398 tracks memory usage and API calls used by pipewire
[9bd10279]399 </para>
400 <indexterm zone="pipewire pw-profiler">
401 <primary sortas="b-pw-profiler">pw-profiler</primary>
[dcea4e3]402 </indexterm>
403 </listitem>
404 </varlistentry>
405
[7a96e1b]406<!--
[11eb3ae5]407 <varlistentry id="pw-pulse">
408 <term><command>pw-pulse</command></term>
409 <listitem>
410 <para>
[c0221530]411 runs Pulseaudio applications on pipewire.
[11eb3ae5]412 </para>
413 <indexterm zone="pipewire pw-pulse">
414 <primary sortas="b-pw-pulse">pw-pulse</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
[7a96e1b]418-->
[11eb3ae5]419
[fa0bead]420 <varlistentry id="pw-reserve">
421 <term><command>pw-reserve</command></term>
422 <listitem>
423 <para>
[4c24eb0a]424 reserves or monitors a device via D-Bus
[fa0bead]425 </para>
426 <indexterm zone="pipewire pw-reserve">
427 <primary sortas="b-pw-reserve">pw-reserve</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
[7c9ae62]432 <varlistentry id="pw-top">
433 <term><command>pw-top</command></term>
434 <listitem>
435 <para>
[4c24eb0a]436 displays real-time performance information from pipewire
[7c9ae62]437 </para>
438 <indexterm zone="pipewire pw-top">
439 <primary sortas="b-pw-top">pw-top</primary>
440 </indexterm>
441 </listitem>
442 </varlistentry>
443
[59f6a1f]444 <varlistentry id="pw-v4l2">
445 <term><command>pw-v4l2</command></term>
446 <listitem>
447 <para>
448 runs v4l2 applications on a pipewire instance
449 </para>
450 <indexterm zone="pipewire pw-v4l2">
451 <primary sortas="b-pw-v4l2">pw-v4l2</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
[fa0bead]456 <varlistentry id="spa-acp-tool">
457 <term><command>spa-acp-tool</command></term>
458 <listitem>
459 <para>
[4c24eb0a]460 inspects the card profile of a given sound card
[fa0bead]461 </para>
462 <indexterm zone="pipewire spa-acp-tool">
463 <primary sortas="b-spa-acp-tool">spa-acp-tool</primary>
464 </indexterm>
465 </listitem>
466 </varlistentry>
467
[dcea4e3]468 <varlistentry id="spa-inspect">
469 <term><command>spa-inspect</command></term>
470 <listitem>
471 <para>
[4c24eb0a]472 allows you to inspect pipewire plugins
[dcea4e3]473 </para>
474 <indexterm zone="pipewire spa-inspect">
475 <primary sortas="b-spa-inspect">spa-inspect</primary>
476 </indexterm>
477 </listitem>
478 </varlistentry>
479
[5d69f635]480 <varlistentry id="spa-json-dump">
481 <term><command>spa-json-dump</command></term>
482 <listitem>
483 <para>
484 dumps the current pipewire configuration in JSON format.
485 </para>
486 <indexterm zone="pipewire spa-json-dump">
487 <primary sortas="b-spa-json-dump">spa-json-dump</primary>
488 </indexterm>
489 </listitem>
490 </varlistentry>
491
[dcea4e3]492 <varlistentry id="spa-monitor">
493 <term><command>spa-monitor</command></term>
494 <listitem>
495 <para>
[4c24eb0a]496 allows you to monitor pipewire plugins
[dcea4e3]497 </para>
498 <indexterm zone="pipewire spa-monitor">
499 <primary sortas="b-spa-monitor">spa-monitor</primary>
500 </indexterm>
501 </listitem>
502 </varlistentry>
503
[fa0bead]504 <varlistentry id="spa-resample">
505 <term><command>spa-resample</command></term>
506 <listitem>
507 <para>
[4c24eb0a]508 resamples a given file
[fa0bead]509 </para>
510 <indexterm zone="pipewire spa-resample">
511 <primary sortas="b-spa-resample">spa-resample</primary>
512 </indexterm>
513 </listitem>
514 </varlistentry>
515
[dcea4e3]516 <varlistentry id="libpipewire">
[9bd10279]517 <term><filename class="libraryfile">libpipewire-0.3.so</filename></term>
[dcea4e3]518 <listitem>
519 <para>
[4c24eb0a]520 contains API functions for handling multimedia pipelines
[dcea4e3]521 </para>
522 <indexterm zone="pipewire libpipewire">
[9bd10279]523 <primary sortas="c-libpipewire">libpipewire-0.3.so</primary>
524 </indexterm>
525 </listitem>
526 </varlistentry>
[da1575a]527<!--
[9bd10279]528 <varlistentry id="libpulse-mainloop-glib-pw">
529 <term><filename class="libraryfile">libpulse-mainloop-glib-pw.so</filename></term>
530 <listitem>
531 <para>
532 provides a glib main() loop for pulseaudio to route media through
533 pipewire.
534 </para>
535 <indexterm zone="pipewire libpulse-mainloop-glib-pw">
536 <primary sortas="c-libpulse-mainloop-glib-pw">libpulse-mainloop-glib-pw.so</primary>
537 </indexterm>
538 </listitem>
539 </varlistentry>
540
[11eb3ae5]541 <varlistentry id="libpulse">
542 <term><filename class="libraryfile">libpulse.so</filename></term>
[9bd10279]543 <listitem>
544 <para>
545 is a pipewire plugin for pulseaudio.
546 </para>
[11eb3ae5]547 <indexterm zone="pipewire libpulse">
548 <primary sortas="c-libpulse">libpulse.so</primary>
[9bd10279]549 </indexterm>
550 </listitem>
551 </varlistentry>
552
[11eb3ae5]553 <varlistentry id="libpulse-simple">
554 <term><filename class="libraryfile">libpulse-simple.so</filename></term>
[9bd10279]555 <listitem>
556 <para>
557 is a simplified version of the pulseaudio plugin for pipewire.
558 </para>
[11eb3ae5]559 <indexterm zone="pipewire libpulse-simple">
560 <primary sortas="c-libpulse-simple">libpulse-simple.so</primary>
[9bd10279]561 </indexterm>
562 </listitem>
563 </varlistentry>
564
565 <varlistentry id="libasound_module_pcm_pipewire">
566 <term><filename class="libraryfile">libasound_module_pcm_pipewire.so</filename></term>
567 <listitem>
568 <para>
569 is an ALSA plugin for pipewire.
570 </para>
571 <indexterm zone="pipewire libasound_module_pcm_pipewire">
572 <primary sortas="c-libasound_module_pcm_pipewire">libasound_module_pcm_pipewire.so</primary>
573 </indexterm>
574 </listitem>
575 </varlistentry>
576
577 <varlistentry id="libgstpipewire">
578 <term><filename class="libraryfile">libgstpipewire.so</filename></term>
579 <listitem>
580 <para>
581 is a Gstreamer plugin for pipewire.
582 </para>
583 <indexterm zone="pipewire libgstpipewire">
584 <primary sortas="c-libgstpipewire">libgstpipewire.so</primary>
[dcea4e3]585 </indexterm>
586 </listitem>
[da1575a]587 </varlistentry>-->
[dcea4e3]588 </variablelist>
589 </sect2>
[4c24eb0a]590
[dcea4e3]591</sect1>
Note: See TracBrowser for help on using the repository browser.