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