source: multimedia/libdriv/pulseaudio.xml@ da54a62

11.0 11.1 11.2 11.3 12.0 12.1 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 upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since da54a62 was da54a62, checked in by Pierre Labastie <pierre.labastie@…>, 3 years ago

Tags for kde and some deps

  • Property mode set to 100644
File size: 18.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 pulseaudio-download-http
8 "https://www.freedesktop.org/software/pulseaudio/releases/pulseaudio-&pulseaudio-version;.tar.xz">
9 <!ENTITY pulseaudio-download-ftp " ">
10 <!ENTITY pulseaudio-md5sum "bb888e7747b778c1c487c63b582ddf40">
11 <!ENTITY pulseaudio-size "1.5 MB">
12 <!ENTITY pulseaudio-buildsize "49 MB (add 1 MB for tests)">
13 <!ENTITY pulseaudio-time "0.2 SBU (Using parallelism=4; add 0.2 SBU for tests)">
14]>
15
16<sect1 id="pulseaudio" xreflabel="PulseAudio-&pulseaudio-version;">
17 <?dbhtml filename="pulseaudio.html"?>
18
19 <sect1info>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>PulseAudio-&pulseaudio-version;</title>
24
25 <indexterm zone="pulseaudio">
26 <primary sortas="a-PulseAudio">PulseAudio</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to PulseAudio</title>
31
32 <para>
33 <application>PulseAudio</application> is a sound system for POSIX OSes,
34 meaning that it is a proxy for sound applications. It allows you to do
35 advanced operations on your sound data as it passes between your
36 application and your hardware. Things like transferring the audio to a
37 different machine, changing the sample format or channel count and mixing
38 several sounds into one are easily achieved using a sound server.
39 </para>
40
41 &lfs110a_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>
47 Download (HTTP): <ulink url="&pulseaudio-download-http;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download (FTP): <ulink url="&pulseaudio-download-ftp;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download MD5 sum: &pulseaudio-md5sum;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download size: &pulseaudio-size;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated disk space required: &pulseaudio-buildsize;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated build time: &pulseaudio-time;
73 </para>
74 </listitem>
75 </itemizedlist>
76
77 <bridgehead renderas="sect3">PulseAudio Dependencies</bridgehead>
78
79 <bridgehead renderas="sect4">Required</bridgehead>
80 <para role="required">
81 <xref linkend="libsndfile"/>
82 </para>
83
84 <bridgehead renderas="sect4">Recommended</bridgehead>
85 <para role="recommended">
86 <xref linkend="alsa-lib"/>,
87 <xref linkend="dbus"/>,
88 <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
89 <xref linkend="glib2"/>,
90 <xref linkend="libcap-pam"/>,
91 <xref linkend="speex"/> and
92 <xref linkend="xorg7-lib"/>
93 </para>
94
95 <bridgehead renderas="sect4">Optional</bridgehead>
96 <para role="optional">
97 <xref linkend="avahi"/>,
98 <xref linkend="bluez"/>,
99 <xref linkend="doxygen"/> (for documentation),
100 <xref linkend="fftw"/>,
101 <xref linkend="gtk3"/>,
102 <xref linkend="libsamplerate"/>,
103 <xref linkend="sbc"/> (Bluetooth support),
104 <xref linkend="valgrind"/>,
105 <ulink url="http://www.jackaudio.org/">JACK</ulink>,
106 <ulink url="http://0pointer.de/lennart/projects/libasyncns/">libasyncns</ulink>,
107 <ulink url="http://www.lirc.org/">LIRC</ulink>,
108 <ulink url="http://gstreamer.freedesktop.org/src/orc/">ORC</ulink>,
109 <ulink url="https://sourceforge.net/projects/soxr/">soxr</ulink>,
110 <ulink url="http://tdb.samba.org/">TDB</ulink>, and
111 <ulink url="http://freedesktop.org/software/pulseaudio/webrtc-audio-processing/">
112 WebRTC AudioProcessing</ulink>
113 <!--<ulink url="http://www.xenproject.org/">XEN</ulink>-->
114 </para>
115
116 <para condition="html" role="usernotes">User Notes:
117 <ulink url="&blfs-wiki;/pulseaudio"/>
118 </para>
119 </sect2>
120
121 <sect2 role="installation">
122 <title>Installation of PulseAudio</title>
123<!--
124 <para>
125 If <xref linkend="doxygen"/> is not installed, workaround a building
126 issue because of the changes in meson-0.57.2:
127 </para>
128
129<screen><userinput>sed '/doxygen/d' -i meson.build</userinput></screen>
130-->
131 <para>
132 Install <application>PulseAudio</application> by running the following
133 commands:
134 </para>
135<!--
136<screen revision="sysv"><userinput>./configure - -prefix=/usr \
137 - -sysconfdir=/etc \
138 - -localstatedir=/var \
139 - -disable-bluez5 \
140 - -disable-rpath \
141 - -with-systemduserunitdir=no &amp;&amp;
142make</userinput></screen>
143
144<screen revision="systemd"><userinput>./configure - -prefix=/usr \
145 - -sysconfdir=/etc \
146 - -localstatedir=/var \
147 - -disable-bluez5 \
148 - -disable-rpath &amp;&amp;
149make</userinput></screen>
150-->
151
152<screen><userinput>mkdir build &amp;&amp;
153cd build &amp;&amp;
154
155meson --prefix=/usr \
156 --buildtype=release \
157 -Ddatabase=gdbm \
158 -Ddoxygen=false \
159 -Dbluez5=disabled &amp;&amp;
160ninja</userinput></screen>
161
162 <para>
163 To test the results, issue: <command>ninja test</command>. One test
164 fails if the tests are not run as the root user, but this can be ignored.
165 </para>
166
167 <para>
168 Now, as the <systemitem class="username">root</systemitem> user:
169 </para>
170
171<screen role="root"><userinput>ninja install</userinput></screen>
172
173 <!-- http://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SystemWide/ -->
174 <para>Running PulseAudio as a system-wide daemon is possible but not
175 recommended. See <ulink
176 url="https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SystemWide/"/>
177 for more information.
178 While still as the <systemitem class="username">root</systemitem>
179 user, remove the <application>D-Bus</application> configuration file
180 for the system wide daemon to avoid creating unnecessary system
181 users and groups:
182 </para>
183
184<screen role="root"><userinput>rm -fv /etc/dbus-1/system.d/pulseaudio-system.conf</userinput></screen>
185
186 </sect2>
187 <sect2 role="commands">
188 <title>Command Explanations</title>
189
190 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
191 href="../../xincludes/meson-buildtype-release.xml"/>
192
193 <para>
194 <parameter>-Dbluez5=false</parameter>: This switch prevents
195 a runtime error if <xref linkend="dbus"/> and <xref linkend="sbc"/>
196 are both installed but <xref linkend="bluez"/> is not installed.
197 Remove this if you have installed all three packages.
198 </para>
199
200 <para>
201 <parameter>-Ddoxygen=false</parameter>: This allows the package to
202 compile if <xref linkend="doxygen"/> is not installed. Remove this
203 if you have installed this and wish to build the documentation.
204 </para>
205<!--
206 <para>
207 <parameter>- -disable-rpath</parameter>: This switch prevents
208 linker from adding a hardcoded runtime path to the installed
209 programs and libraries.
210 </para>-->
211
212 </sect2>
213 <sect2 role="configuration">
214 <title>Configuring PulseAudio</title>
215
216 <sect3 id="pulseaudio-config">
217 <title>Config Files</title>
218 <para>
219 There are system wide configuration files:
220 <filename>/etc/pulse/daemon.conf</filename>,
221 <filename>/etc/pulse/client.conf</filename>,
222 <filename>/etc/pulse/default.pa</filename>, and user configuration
223 files with the same names in
224 <filename class="directory">~/.config/pulse</filename>. User
225 configuration files take precedence over system wide ones.
226 </para>
227
228 <indexterm zone="pulseaudio pulseaudio-config">
229 <primary sortas="e-AA.config-pulse">~/.config/pulse</primary>
230 </indexterm>
231
232 <indexterm zone="pulseaudio pulseaudio-config">
233 <primary
234 sortas="e-etc-pulse-daemon.conf">/etc/pulse/daemon.conf</primary>
235 </indexterm>
236
237 <indexterm zone="pulseaudio pulseaudio-config">
238 <primary
239 sortas="e-etc-pulse-client.conf">/etc/pulse/client.conf</primary>
240 </indexterm>
241
242 <indexterm zone="pulseaudio pulseaudio-config">
243 <primary
244 sortas="e-etc-pulse-default.pa">/etc/pulse/default.pa</primary>
245 </indexterm>
246 </sect3>
247
248 <sect3><title>Configuration Information</title>
249<!--
250 <para>
251 The default configuration files allow setting up a working installation.
252 However, a reference to Console-Kit needs to be removed.
253 Issue the following command as the
254 <systemitem class="username">root</systemitem> user:
255 </para>
256
257<screen role="root"><userinput>sed -i '/load-module module-console-kit/s/^/#/' /etc/pulse/default.pa</userinput></screen>
258
259 In 13.0 this is protected via .ifexists module-console-kit.so
260-->
261 <para>
262 You may have to configure the audio system. You can start
263 <application>pulseaudio</application> in command line mode using
264 <command>pulseaudio -C</command> and then list various
265 information and change settings. See
266 <command>man pulse-cli-syntax</command>.
267 </para>
268
269 <para>
270 If <application>pulseaudio</application> was working but you no-longer
271 have sound, after checking for hardware issues (speakers or headphones
272 not connected, external amplifier not connected) you may need to fix it.
273 </para>
274
275 <para>
276 One suggestion is to close the application, such as
277 <application>firefox</application> where sound has stopped working, then
278 run: <command>pactl list short sinks</command> followed by:
279 <command>pacmd set-default-sink &lt;sink #&gt;</command> and then
280 restart the application.
281 </para>
282
283 <para>
284 If that does not work, a more drastic approach often works. After closing
285 the application, close pulseaudio, either using <command>pulseaudio
286 --kill</command> or, if that fails, <command>killall -KILL
287 pulseaudio</command> and then <command>rm -rf
288 ~/.config/pulse/*</command> (and perhaps also
289 <command>rm -rf ~/.pulse/*</command> if you have used a very old version
290 of pulse on this machine), then run <command>pulseaudio
291 --verbose</command> to restart it. If the daemon starts, restart the
292 application. See <command>man pulseaudio</command> for more options.
293 </para>
294
295 </sect3>
296 </sect2>
297
298 <sect2 role="content">
299 <title>Contents</title>
300
301 <segmentedlist>
302 <segtitle>Installed Programs</segtitle>
303 <segtitle>Installed Libraries</segtitle>
304 <segtitle>Installed Directories</segtitle>
305
306 <seglistitem>
307 <seg>
308 <!--esdcompat,--> pacat, pacmd, pactl, padsp,
309 pamon (symlink to pacat), paplay (symlink to pacat),
310 parec (symlink to pacat), parecord (symlink to pacat), qpaeq,
311 pasuspender, pax11publish, pulseaudio, and
312 <!-- it looks like the equalizer needs FFTW: qpaeq, -->
313 start-pulseaudio-x11
314 </seg>
315 <seg>
316 libpulse.so,
317 libpulse-mainloop-glib.so,
318 libpulse-simple.so,
319 libpulsecommon-&pulseaudio-major-version;.so,
320 libpulsecore-&pulseaudio-major-version;.so, and
321 libpulsedsp.so
322 </seg>
323 <seg>
324 /etc/pulse,
325 /usr/include/pulse,
326 /usr/lib/cmake/PulseAudio,
327 /usr/lib/{pulseaudio,pulse-&pulseaudio-major-version;},
328 /usr/libexec/pulse, and
329 /usr/share/pulseaudio
330 </seg>
331 </seglistitem>
332 </segmentedlist>
333
334 <variablelist>
335 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
336 <?dbfo list-presentation="list"?>
337 <?dbhtml list-presentation="table"?>
338
339<!--
340 <varlistentry id="esdcompat">
341 <term><command>esdcompat</command></term>
342 <listitem>
343 <para>
344 is the <application>PulseAudio</application> ESD wrapper script.
345 </para>
346 <indexterm zone="pulseaudio esdcompat">
347 <primary sortas="b-esdcompat">esdcompat</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351-->
352
353 <varlistentry id="pacat">
354 <term><command>pacat</command></term>
355 <listitem>
356 <para>
357 plays back or records raw or encoded audio streams on a
358 <application>PulseAudio</application> sound server
359 </para>
360 <indexterm zone="pulseaudio pacat">
361 <primary sortas="b-pacat">pacat</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="pacmd">
367 <term><command>pacmd</command></term>
368 <listitem>
369 <para>
370 is a tool used to reconfigure a <application>PulseAudio</application>
371 sound server during runtime
372 </para>
373 <indexterm zone="pulseaudio pacmd">
374 <primary sortas="b-pacmd">pacmd</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry id="pactl">
380 <term><command>pactl</command></term>
381 <listitem>
382 <para>
383 is used to control a running <application>PulseAudio</application>
384 sound server
385 </para>
386 <indexterm zone="pulseaudio pactl">
387 <primary sortas="b-pactl">pactl</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="padsp">
393 <term><command>padsp</command></term>
394 <listitem>
395 <para>
396 is the <application>PulseAudio</application> OSS Wrapper
397 </para>
398 <indexterm zone="pulseaudio padsp">
399 <primary sortas="b-padsp">padsp</primary>
400 </indexterm>
401 </listitem>
402 </varlistentry>
403
404 <varlistentry id="pamon">
405 <term><command>pamon</command></term>
406 <listitem>
407 <para>
408 is a symbolic link to <command>pacat</command>
409 </para>
410 <indexterm zone="pulseaudio pamon">
411 <primary sortas="b-pamon">pamon</primary>
412 </indexterm>
413 </listitem>
414 </varlistentry>
415
416 <varlistentry id="paplay">
417 <term><command>paplay</command></term>
418 <listitem>
419 <para>
420 is used to play audio files on a
421 <application>PulseAudio</application> sound server
422 </para>
423 <indexterm zone="pulseaudio paplay">
424 <primary sortas="b-paplay">paplay</primary>
425 </indexterm>
426 </listitem>
427 </varlistentry>
428
429 <varlistentry id="parec">
430 <term><command>parec</command></term>
431 <listitem>
432 <para>
433 is a symbolic link to <command>pacat</command>
434 </para>
435 <indexterm zone="pulseaudio parec">
436 <primary sortas="b-parec">parec</primary>
437 </indexterm>
438 </listitem>
439 </varlistentry>
440
441 <varlistentry id="parecord">
442 <term><command>parecord</command></term>
443 <listitem>
444 <para>
445 is a symbolic link to <command>pacat</command>
446 </para>
447 <indexterm zone="pulseaudio parecord">
448 <primary sortas="b-parecord">parecord</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 <varlistentry id="pasuspender">
454 <term><command>pasuspender</command></term>
455 <listitem>
456 <para>
457 is a tool that can be used to tell a local
458 <application>PulseAudio</application> sound server to temporarily
459 suspend access to the audio devices, to allow other applications
460 to access them directly
461 </para>
462 <indexterm zone="pulseaudio pasuspender">
463 <primary sortas="b-pasuspender">pasuspender</primary>
464 </indexterm>
465 </listitem>
466 </varlistentry>
467
468 <varlistentry id="pax11publish">
469 <term><command>pax11publish</command></term>
470 <listitem>
471 <para>
472 is the <application>PulseAudio</application>
473 X11 Credential Utility
474 </para>
475 <indexterm zone="pulseaudio pax11publish">
476 <primary sortas="b-pax11publish">pax11publish</primary>
477 </indexterm>
478 </listitem>
479 </varlistentry>
480
481 <varlistentry id="pa-info">
482 <term><command>pa-info</command></term>
483 <listitem>
484 <para>
485 is a shell script that prints various information relating to the
486 <application>Pulseaudio</application> server currently in use
487 </para>
488 <indexterm zone="pulseaudio pa-info">
489 <primary sortas="b-pa-info">pa-info</primary>
490 </indexterm>
491 </listitem>
492 </varlistentry>
493
494 <varlistentry id="pulseaudio-prog">
495 <term><command>pulseaudio</command></term>
496 <listitem>
497 <para>
498 is a networked low-latency sound server for Linux
499 </para>
500 <indexterm zone="pulseaudio pulseaudio-prog">
501 <primary sortas="b-pulseaudio">pulseaudio</primary>
502 </indexterm>
503 </listitem>
504 </varlistentry>
505
506<!-- only installed if FFTW is present -->
507 <varlistentry id="qpaeq">
508 <term><command>qpaeq</command></term>
509 <listitem>
510 <para>
511 is an equalizer interface for
512 <application>PulseAudio</application> equalizer sinks
513 (Requires <xref linkend="fftw"/> at build time)
514 </para>
515 <indexterm zone="pulseaudio qpaeq">
516 <primary sortas="b-qpaeq">qpaeq</primary>
517 </indexterm>
518 </listitem>
519 </varlistentry>
520
521<!-- Not found in PA 7.0
522 <varlistentry id="start-pulseaudio-kde">
523 <term><command>start-pulseaudio-kde</command></term>
524 <listitem>
525 <para>
526 Starts <application>PulseAudio</application> and loads
527 module-device-manager to use KDE routing policies.
528 </para>
529 <indexterm zone="pulseaudio start-pulseaudio-kde">
530 <primary sortas="b-start-pulseaudio-kde">start-pulseaudio-kde</primary>
531 </indexterm>
532 </listitem>
533 </varlistentry>
534-->
535 <varlistentry id="start-pulseaudio-x11">
536 <term><command>start-pulseaudio-x11</command></term>
537 <listitem>
538 <para>
539 starts <application>PulseAudio</application> and registers it to
540 the X11 session manager
541 </para>
542 <indexterm zone="pulseaudio start-pulseaudio-x11">
543 <primary sortas="b-start-pulseaudio-x11">start-pulseaudio-x11</primary>
544 </indexterm>
545 </listitem>
546 </varlistentry>
547
548 </variablelist>
549
550 </sect2>
551
552</sect1>
Note: See TracBrowser for help on using the repository browser.