source: multimedia/libdriv/pulseaudio.xml@ 45ab6c7

11.0 ken/refactor-virt lazarus qt5new trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 5 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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