headers: Some trivial fixes for some documentation typos

Note also the willneed/will_need inconsistency. I guess it could be nice to ASAP
choose one of them and introduce a backward compatibility hack for the other.

The issues was mostly found with:
for a in $(grep -r '^[ /]\*.*()' $(
find -name '*.[ch]') |
sed 's,^.* \([^ ]*\)().*$,\1,g' |
sort |
uniq |
grep ^pa_)
do
grep -rq "^.[^*].*\<$a(" $(find * -name '*.h') || echo $a
done

Subject: rtpoll: better support for DEBUG_TIMING logs

On all the platforms I tested, PulseAudio is frequently awaken and
doesn't sleep for the duration specified for the poll timeout.
Sometimes wake-ups occur within milliseconds of the poll call for no
good reason; this seems to be related to ALSA issues (see my posts on
the ALSA mailing list on null poll events).
This patch enables a better log of requested sleep times v. actual
sleep times. Enable DEBUG_TIMING to see actual messages. Please let me
know if you see odd behaviors like the one below
- Pierre

E: rtpoll.c: rtpoll_run
E: rtpoll.c: poll timeout: 188 ms
E: rtpoll.c: Process time 0 ms; sleep time 48 ms
E: rtpoll.c: rtpoll_run
E: rtpoll.c: rtpoll finish
E: rtpoll.c: rtpoll_run
E: rtpoll.c: poll timeout: 139 ms
E: rtpoll.c: Process time 0 ms; sleep time 49 ms
E: rtpoll.c: rtpoll_run
E: rtpoll.c: rtpoll finish
E: rtpoll.c: rtpoll_run
E: rtpoll.c: poll timeout: 189 ms
E: rtpoll.c: Process time 0 ms; sleep time 0 ms
E: rtpoll.c: rtpoll_run
E: rtpoll.c: rtpoll finish
E: rtpoll.c: rtpoll_run
E: rtpoll.c: poll timeout: 189 ms
E: rtpoll.c: Process time 0 ms; sleep time 49 ms

Fix typo in log message: s/may no be/may not be/

Hi, Lennart.

Spotted another typo. Patch attached.

Best wishes,
chocolateboy.

alsa: add profile set for M-Audio FastTrack Pro USB

udev: Use SOUND_CLASS instead of SOUND_FORM_FACTOR when checking for modem

The fact whether an ALSA card is a modem is stored in the SOUND_CLASS,
not the SOUND_FORM_FACTOR property. So read it from there.

Patch from Whoopie.

threaded-mainloop: Properly initialise m->n_waiting_for_accept to prevent deadlock

Compiler optimisations have been seen to initialise
m->n_waiting_for_accept to a positive non-zero value, so the while() in
pa_threaded_mainloop_signal() never proceeds. Fix this by properly
initializing m->n_waiting_for_accept in pa_threaded_mainloop_new().

Patch from Iain Bucław.

https://bugs.launchpad.net/bugs/502992

More src/pulsecore/cpu-arm.c FTBFS fixes

Fix missing argument to pa_read(), and be consistent with declaration of
state variable in pa_cpu_init_arm().

Signed-off-by: Daniel T Chen <crimsun@ubuntu.com>

Fix the following warnings (which now cause buildd failures in Ubuntu 10.04):

pulsecore/cpu-arm.c: In function 'get_cpuinfo':
pulsecore/cpu-arm.c:70: warning: implicit declaration of function 'pa_read' [-Wimplicit-function-declaration]
pulsecore/cpu-arm.c:72: warning: implicit declaration of function 'pa_close' [-Wimplicit-function-declaration]
pulsecore/cpu-arm.c: In function 'pa_cpu_init_arm':
pulsecore/cpu-arm.c:110: warning: implicit declaration of function 'pa_split_spaces' [-Wimplicit-function-declaration]
pulsecore/cpu-arm.c:110: warning: assignment makes pointer from integer without a cast
Function `pa_split_spaces' implicitly converted to pointer at pulsecore/cpu-arm.c:110

Signed-off-by: Daniel T Chen <crimsun@ubuntu.com>

Add a configure option to change 'udevrulesdir'

This patch serves two purposes:

  1) Allows something other than the de-facto standard udev rules dir or
     /lib/udev/rules.d to be used (the udev build system allows you to
     customise this)

  2) Allows a prefixed, non-root install (right now, the /lib/... path
     is hard-coded into the build system

Mark shared variables as volatile

'n_waiting' and 'n_waiting_for_accept' may be accessed from mulitple
threads, and thus need to be marked as volatile to suppres certain
compiler optimisations. All uses are protected by a mutex, so we don't
need to worry about cache issues (added documentation for this as well).

This addresses bug #738.

stream-restore: At startup, create dbus entries only for valid database entries.

stream-restore: Add a missing pa_xnew0() call in handle_add_entry().

stream-restore: Fix a few assertion misuses with the D-Bus code.

dbus: Add a missing break statement in handle_message_cb().

dbus: Handle the cases when a non-existing interface is detected in an incoming message.

libpulse: Store pa_stream pointers to hashmaps instead of dynarrays.

Since the stream identifiers (channels) are monotonically growing integer, it
isn't a good idea to use them as index to a dynamic array, because the array
will grow all the time. This is not a problem with client connections that
don't create many streams, but, for example, long-running clients that use
libcanberra for playing event sounds, this means that the client connection
effectively leaks memory.

Merge remote branch 'tanuk/master'

Merge branch 'master' of ssh://rootserver/home/lennart/git/public/pulseaudio

Merge remote branch 'phish3/master'

Merge branch 'master' of ssh://rootserver/home/lennart/git/public/pulseaudio

freebsd: implement pa_get_binary_name

Stolen from
http://www.freebsd.org/cgi/cvsweb.cgi/ports/audio/pulseaudio/files/patch-src_pulse_util.c?rev=1.1
and fixed for indentation.

src/utils/qpaeq: added more friendly error messages to common errors

Makefile.am: added qpaeq to installed scripts

Simplify Makefile.am handling of ALSA-related files.

Instead of declaring extra variables for the ALSA profiles and PATHS, and
using EXTRA_DIST for the udev rule, use the dist_ prefix when declaring
them for conditional installation.

This relies on the fact that automake *is* smart enough to know that there
exist *no* conditional dist, and will always distribute all of them.

Avoid using devname as a variable name.

On FreeBSD, devname() is a system function, and was overshadowed.

Rename all the signal parameters and variables to something more explicit.

Without this change, on FreeBSD you'll be bothered by tons of warnings
about overshadowing signal(2).

Since now we have FreeBSD atomic operations, don't require libatomic_ops.

This lets the original configure script to pass on FreeBSD.

Simplify handling of NetBSD atomic ops discovery.

Instead of having a parameter to enable/disable them (which was also
ignored by the source code side), simply identify NetBSD 5 (when the atomic
ops were implemented the first time) in a $host switch and ignore checking
for libatomic_ops.

Merge branch 'master' of git://git.0pointer.de/pulseaudio

remove .py extension from qpaeq

Merge remote branch 'phish3/master'

freebsd: fix atomic ops implementations

Stole from

http://www.freebsd.org/cgi/cvsweb.cgi/ports/audio/pulseaudio/files/patch-src_pulsecore_atomic.h?rev=1.6

added qpaeq script for GUI equalizer control to src/util

Check for stow using AC_CHECK_PROG rather than type -p.

The type -p check is not compatible with POSIX shells, and indeed fails
when used with the FreeBSD 8 default shell. Instead the AC_CHECK_PROG macro
is written properly to look for the command.

Include sys/filio.h if present; this makes use of FIONREAD on Solaris.

FIONREAD on OpenSolaris is declared in sys/filio.h. The RTP modules already
rely on the presence of FIONREAD, and check for the header, so this brings
the pipe source and sink modules on par with them.

Don't declare the variable l if FIONREAD is not defined.

This avoids two warnings due to FIONREAD not being defined.

Fix build on Solaris: pass the third parameter to pa_cloexec_open.

Move the platform-specific defines after the compiler has been found.

Without this change, on OpenSolaris, it's possible that the compiler will
be reported, by default, as failing to produce executables, since
_XOPEN_SOURCE=600 requires a C99 compiler to compile even the simples of
the programs.

alsa: fix minor sampling rate deviations before adjusting the buffer size

alsa: fix log output when the audio device refuses to give us again the same period settings we had before

pulse: ask for timing updates both *before* and *after* triggering a stream state change so that in the STARTED/UNDERFLOW callbacks we accurate transport latency information

pulse: delay smoother update only when unpausing, not when pausing, since we don't want the timer to advance when we are supposedly already paused

pulse: try to fix inaccuracy with uncork timing for streams that are created in corked state

daemon: complain if user passes too many arguments

module-equalizer-sink: add latency of output_q and input_q to get latency calculation

module-equalizer-sink: switch back to reference dsp implementation - cpu usage doesn't really change and there may be
a bug in the vectorized version

module-equalizer-sink: (re)added output memblockq commented out timing debug statements

Merge branch 'master' of ssh://rootserver/home/lennart/git/public/pulseaudio

rygel: fix itemCount property for sources

Fixes http://pulseaudio.org/ticket/721

build-sys: Fix missing trailing slash in 14eaf2

build-sys: Make sure all alsa path config files are installed

While all alsa path configuration files were in EXTRA_DIST not all of them were
in in alsapaths_DATA. Fixed by only defining the list in one place

device-manager: Update docs version -> 0.9.20

Third time is a charm... maybe.

core: make cpuid code compile cleanly with 32bit PIC

core: adjust volume only when there is actually a memory block

Fixes an assert that is hit in somne niche cases:

https://bugzilla.redhat.com/show_bug.cgi?id=533482

protocol: use the right sample rate for sources

Use the correct sample rate for reporting about the timing.

device-manager: Update docs version -> 0.9.20

ramping: minor cleanups

Merge remote branch 'origin/merge-queue'

Conflicts:
src/pulsecore/sink-input.c
src/pulsecore/sink.c

jack: never try to autoconnect to MIDI ports

Original patch supplied by 'adi'

http://pulseaudio.org/ticket/669

man: fix build with --disable-manpages

http://pulseaudio.org/ticket/698

lirc,mmkvd: added module parameters volume_limit, volume_step

volume_limit sets maximum volume that can be set from the module
default is PA_VOLUME_NORM*3/2 (150%)
volume_step sets step in volume changing
default is PA_VOLUME_NORM/20
values are of raw pa_volume_t type

volume: add pa_cvolume_inc_clamp function

added function to increase volume not exceeding specified limit
simply changed PA_VOLUME_MAX to 'limit' in pa_cvolume_inc
pa_cvolume_inc now calls pa_cvolume_inc_clamp with PA_VOLUME_MAX limit

alsa: disable timer-based scheduling inside a VM

In virtual machines sound card clocks and OS scheduling tend to become
unreliable, adding various 'uneven' latencies. The adaptive algorithm
that handles drop-outs does not handle it this well: in contrast to
drop-outs on real machines that are evenly distributed, small and can
easily be encountered via the adpative algorithms, drop-outs in VMs tend
to happen abruptly, and massively, which is not easy to counter.

This patch simply disables timer based scheduling in VMs reverting to
classic IO based scheduling. This should help make PA perform better in
VMs.

https://bugzilla.redhat.com/show_bug.cgi?id=532775

daemon: during startup say whether we run in a VM

core-util: add call to detect if we are called from within a VM

alsa: introduce more standard path names

alsa: cover 'Analog Output' control

http://pulseaudio.org/ticket/702

Merge remote branch 'phish3/master'

alsa: create a seperate mixer path for Speaker elements

On some cards line-out is independant of Sepaker and it is a good idea
to cover that so that they can independantly be activated.

https://bugzilla.redhat.com/show_bug.cgi?id=520884

alsa: leave other headphone control enabled if possible

alsa: lower priority for Headphone2 path

alsa: cover Input Source:AUX IN

As seen on some HDA chips:

https://bugzilla.redhat.com/attachment.cgi?id=359804

alsa: cover Headphone2 mixer element

As seen on some drivers:

https://bugzilla.redhat.com/show_bug.cgi?id=498612

alsa: cover 'Digital Input Source' element

As used by some HDA devices:

https://bugzilla.redhat.com/attachment.cgi?id=365290

alsa: cover Mic Jack Mode element

As used by some HDA chips:

https://bugzilla.redhat.com/attachment.cgi?id=366816

daemon: make sure pa has its own session and process group, but is not its leader so that we cannot acquire a tty ever

bluetooth: do not hand out access to devices that are not fully configured yet

configure.ac: enable check for CoreAudio

daemon: realpath segfault fix

Lennart,

Apparently I was debugging this at the same time as you. I can't figure out
why my Fedora 11 install with glibc-2.10 has a glibc realpath that doesn't
match the gnu documentation and returns null. But it does.

Your commit aa8ce5bb9b159abb2ffb0f43996340566fc2e9c6 almost fixed my
problem, but it needs a tweak.

Thanks,
David Yoder

Mac OS X: add semaphore implementation

On Wed, Sep 16, 2009 at 11:57:04PM +0200, Lennart Poettering wrote:
> On Wed, 16.09.09 15:15, Daniel Mack (daniel@caiaq.de) wrote:
>
> > +    s = pa_xnew(pa_semaphore, 1);
> > +    MPCreateSemaphore(UINT_MAX, value, &(s->sema));
> > +    pa_assert(s->sema != 0);
>
> Hmm, I'd prefer if the ret val of MPCreateSemaphore() would be checked
> here.
>
> Also I find it a bit weird checking for s->sema, though not
> initializing it to 0 in the beginning. If the call actually failed,
> then the assert will check uninitialized memory. Also, comparing
> pointers with 0 sucks. That should be NULL.
>
> Given that this can not realisitically fail, only in OOM or OOM-like
> situations in which case we abort anyway it mght be enough just writing:
>
> pa_assert_se(MPCreateSemaphore(UINT_MAX, value, &s->sema) == 0);
>
> (Assuming that success is signalled by retval == 0 on MacOSX)
>
> > +void pa_semaphore_free(pa_semaphore *s) {
> > +    pa_assert(s);
> > +    MPDeleteSemaphore(s->sema);
>
> Same here.
>
> > +    pa_xfree(s);
> > +}
> > +
> > +void pa_semaphore_post(pa_semaphore *s) {
> > +    pa_assert(s);
> > +    MPSignalSemaphore(s->sema);
>
> And here.
>
> > +}
> > +
> > +void pa_semaphore_wait(pa_semaphore *s) {
> > +    pa_assert(s);
> > +    /* should probably check return value (-ve is error), noErr is ok. */
> > +    MPWaitOnSemaphore(s->sema, kDurationForever);
>
> And here.

Ok, done. See the patch below.

Daniel

>From 26df2fbae6d9215a3ae084876fb5f79e4d9cf4f0 Mon Sep 17 00:00:00 2001
From: Kim Lester <kim@dfusion.com.au>
Date: Wed, 16 Sep 2009 09:23:39 +0800
Subject: [PATCH] Mac OS X: add semaphore implementation

Wrap clock_gettime and friends

On Wed, Sep 16, 2009 at 11:48:58PM +0200, Lennart Poettering wrote:
> On Wed, 16.09.09 15:15, Daniel Mack (daniel@caiaq.de) wrote:
>
> > From: Kim Lester <kim@dfusion.com.au>
> >
> > OS X does not define clockid_t or clock_gettime() and friends.
> > Add a wrapper to fix this.
>
> Hmpf. I am not particularly happy with this. This adds a lot of
> unnecessary compat code. We don't actually need implementations of
> clock_getres(). All we need is some kind of check whether system
> timers are accurate or whether they are rounded up to scheduling
> slices. On Linux we do that check with clock_getres(), but all the
> information it returns is actually not intertesting at all. We just
> check if this is below some trheshold, that's all.
>
> clock_settime() we don't use at all! We shouldn't carry compat code
> for that.
>
> And clock_gettime we don't really need either. We need some kind of
> accurate system timers (preferably monotonic), and on Linux we use
> clock_gettime() for that. But we already have a fallback there for
> gettimeofday().
>
> Or in other words, the current APIs pa_rtclock_get(),
> pa_rtclock_hrtimer() is supposed to be the abstract API that has
> different backends on different systems. I'd very much prefer if any
> MacOS specific code would simply be plugged in there instead of
> creating various new abstraction interfaces!

Ok - what about the version below? I don't particularily like the

Daniel

>From 9f0a051953ec354ccdb8aa44a9845c408b26ae0b Mon Sep 17 00:00:00 2001
From: Kim Lester <kim@dfusion.com.au>
Date: Wed, 16 Sep 2009 14:40:01 +0800
Subject: [PATCH] Implement pa_rtclock_get() and pa_rtclock_hrtimer() for Darwin

OS X does not define clockid_t or clock_gettime() and friends.
Add wrappers to fix this. Based on a patch from Kim Lester
<kim@dfusion.com.au>.

X11: attach X11 properties to Screen, not Display

git: ignore kde related files

svolume: fix MMX error

We need to sign extend the lower part of the multiplication before adding it to
the higher part. Makes -1 * 0xffff work again.

sink: simplify silence checks

daemon: don't crash if pa_realpath() fails

socket-util: drop redundant casts

socket-util: allocate at least sizeof(sockaddr_storage) space

use pa_fopen_cloexec() where applicable

tdb: use O_CLOEXEC if available

core-util: introduce pa_fopen_cloexec()

core-util: make sure to enable FD_CLOEXEC unconditionally to cope with kernels that silently accept but ignore O_CLOEXEC

use cloexec wrappers wherever applicable

core-util: introduce FD_CLOEXEC wrappers for open/socket/pipe/accept

module-equalizer-sink:
    add premultipliar to sse2 dsp_logic implementation

module-equalizer-sink: try to limit buffering to mempool's max_block_size and disable debug output

drop redundant alloc call

Merge remote branch 'origin/master'

simd: update test cases

smoother: add comments about optimization recommendations from Jason Newton