source: multimedia/libdriv/pulseaudio.xml@ e4be4bf

11.0 ken/refactor-virt lazarus qt5new trunk
Last change on this file since e4be4bf was e4be4bf, checked in by Bruce Dubbs <bdubbs@…>, 3 months ago

Package Updates
Update to pulseaudio-15.0.
Update to imlib2-1.7.2.
Update to cmake-3.21.1.
Update to libmbim-1.26.0.

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