sink/source: Initialize port before fixate hook (fixes volume/mute not saved)

In case a port has not yet been saved, which is e g often the case
if a sink/source has only one port, reading volume/mute will be done
without port, whereas writing volume/mute will be done with port.

Work around this by setting a default port before the fixate hook,
so module-device-restore can read volume/mute for the correct port.

BugLink: https://bugs.launchpad.net/bugs/1289515
Signed-off-by: David Henningsson <david.henningsson@canonical.com>

introspect: Use pa_direction_valid() to validate port direction

There's no behavioral change, just nicer code.

direction: Add a couple of direction helper functions

device-restore: log restored mute state

Log the mute state as it was restored

alsa-util: Reset hwparams_copy before the second try of buffer setup

hwparams_copy needs to be reset (as it is also reset for the third and
fourth try) before the second try.

If the reset is not done and the first try fails:
D: [lt-pulseaudio] alsa-util.c: Maximum hw buffer size is 743 ms
I: [lt-pulseaudio] alsa-util.c: snd_pcm_hw_params_set_buffer_size_near() failed: Invalid argument
I: [lt-pulseaudio] alsa-util.c: snd_pcm_hw_params_set_period_size_near() failed: Invalid argument
I: [lt-pulseaudio] alsa-util.c: snd_pcm_hw_params_set_buffer_size_near() failed: Invalid argument
D: [lt-pulseaudio] alsa-util.c: Set only period size (to 1102 samples).

We have three failures and finally the fourth (only period size) succeed.

With this patch:
D: [lt-pulseaudio] alsa-util.c: Maximum hw buffer size is 743 ms
I: [lt-pulseaudio] alsa-util.c: snd_pcm_hw_params_set_buffer_size_near() failed: Invalid argument
D: [lt-pulseaudio] alsa-util.c: Set period size first (to 1102 samples), buffer size second (to 4408 samples).

We only fail with the first try, the second (period followed by buffer) is
fine.

Signed-off-by: Peter Ujfalusi <peter.ujfalusi@ti.com>

doxygen: Update the configuration file

I reviewed the changes, and I didn't find anything that would actually
have effects on the generated output.

zeroconf-publish: Don't react to messages while shutting down

This fixes a case where pa__done() is called while
AVAHI_MESSAGE_PUBLISH_ALL is waiting for processing. The
pa_asyncmsgq_wait_for(AVAHI_MESSAGE_SHUTDOWN_COMPLETE) call will
process all pending messages, and processing AVAHI_MESSAGE_PUBLISH_ALL
causes publish_all_services(), and that in turn accesses u->services,
which has been already freed at this point. If we are shutting down,
we shouldn't react to any of the messages that the Avahi thread is
sending to the main thread.

BugLink: https://bugs.freedesktop.org/show_bug.cgi?id=76184

zeroconf-publish: Add locking around pa_mainloop_api_once()

Commit e1e154c7377779377fa1a36655a10effd693f7b5 added locking around
pa_mainloop_api_once() everywhere except pa__done(). This fixes that
omission.

pacat: Fix partially translated message

The word "not" was not translated.

BugLink: https://bugs.freedesktop.org/show_bug.cgi?id=76529

core-util: Make pa_yes_no() translatable

BugLink: https://bugs.freedesktop.org/show_bug.cgi?id=76529

doc: Fix some typos/wording in man/pulse-daemon.conf.5

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>

mainloop-api: Improve pa_mainloop_api_once() documentation

volume: Increase PA_SW_VOLUME_SNPRINT_DB_MAX

10 bytes isn't enough for "-123.45 dB", including the terminating null
byte.

alsa: Use card description in default sink/source prefix when available

When given an explicit device.description in card_properties, prefer
this information over other default prefixes (e.g. 'Built-in Audio')
when constructing sink/source descriptions.

For example, if I manually configure the card description to be
"FooBar", I then expect that the sinks and created by the card also
have "FooBar" in their description instead of generic "Built-in
Audio".

tunnel: Fix inverted if condition

alsa-mixer: Fix Analog Input showing up on USB Headset

In some cases, "Analog Input" could show up as well as
"Headset Mic" (or "Headphone Mic"), because I forgot to add the
relevant "required-absent" lines when I added the headset mic path.

As a result, both "Analog Input" and "Headset Mic" showed up on the
Logitech USB 530 Headset.

Reported-by: Steve Magoun <steve.magoun@canonical.com>
Signed-off-by: David Henningsson <david.henningsson@canonical.com>

pactl: Fix a copy-paster error

doc: Use \since doxygen command correctly in mainloop-api.h

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>

core: add missing SET_PORT_LATENCY_OFFSET to dispatcher opcode string table

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>

doc: Use correct parameter name wait_for_accept in documentation of pa_threaded_mainloop_signal()

also sneaks in a full stop in documentation elsewhere

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>

Fix a few "it's -> its" typos

tunnel-source-new: Fix shadow compiler warning

  CC     modules/module_tunnel_sink_la-module-tunnel.lo
modules/module-tunnel-source-new.c: In function 'read_new_samples':
modules/module-tunnel-source-new.c:145:16: warning: declaration of 'read' shadows a global declaration [-Wshadow]

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>

doc: Fix pa_stream_set_latency_update_callback() documentation

the latency_update callback is supported on playback AND record
streams

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>

doc: Fix a couple of 'to to' typos

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>

alsa: Remove a redundant check

If mixer_handle is not NULL, then hctl_handle won't be NULL either.
The redundant check was confusing, because it looked like we would
leak the mixer_handle if mixer_handle is non-NULL and hctl_handle is
NULL.

bluetooth: Fix timing to count based on decoded data

Currently the latency information is being updated based on the encoded
SBC data instead of the decoded PCM data. Fixing this required moving
the timing update to be after the packet has been decoded.

bluetooth: Don't abort on SBC decoding error

The Nokia E7 running Symbian Belle Refresh seems to generate invalid SBC
packets every few minutes. This causes pulseaudio to disconnect the
stream and log "SBC decoding error (-3)".

If a single packet is bad, pulseaudio should keep playing the stream.

Remove all references to the removed KDE files

daemon: ensure pulseaudio early startup on kde

daemon: consolidate startup scripts

simplify pulseaudio autostart into one, avoid needless extra
work for kde, and avoid possible startup races.

suspend-on-idle: Fix monitor source handling

Fixes a crash that happened due to calling pa_source_check_suspend()
when d->source was NULL.

Update NEWS

rtp-send: Add "inhibit_auto_suspend" module argument

Some people want module-rtp-send to send silence when the sink that is
monitored goes idle, and some people want module-rtp-send to pause the
RTP stream to avoid unnecessary bandwidth consumption.

suspend-on-idle: Ensure we still time out if a stream remains corked

If a stream is started corked and remains corked, the sink/source
remained idle without being properly suspended. This patch fixes
that issue.

BugLink: https://bugs.launchpad.net/bugs/1284415
Tested-by: Ricardo Salveti <ricardo.salveti@canonical.com>
Signed-off-by: David Henningsson <david.henningsson@canonical.com>

sink-input/source-output: Fix LFE remixing suddenly enabled

Steps to reproduce:
 1) Leave LFE remixing disabled (the default)
 2) Start playback of stereo material on e g 5.1 surround, notice nothing in LFE
 3) Now change profile to e g 4.0 surround and then back to 5.1 surround
 4) Notice that LFE channel is now remixed

Signed-off-by: David Henningsson <david.henningsson@canonical.com>

Make tests compile on FreeBSD

cpu_set_t is named cpuset_t on FreeBSD.
Add headers to allow for warning free compilation.

rtp-send: Use _cb suffix with callbacks

doc: Assorted spelling and grammar fixes for doxygen output

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>

modules: Fix uninitialized variable in rtp-send

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>

sconv, svolume: Fix compilation on 32-bit FreeBSD

Don't try to compile this code on 32-bit FreeBSD, it will error out complain
about registers only being available in 64-bit mode.

Revert "protocol-native: Don't enumerate unlinked sinks and sources"

This reverts commit bd0bd9143f8159e5475b1295e30ec026ff0b6fef.

build-sys: Bump soname

Bumping from 0->3 since we missed bumping correctly for v4.99.{1,2,3}

protocol-native: Don't enumerate unlinked sinks and sources

This makes sure that there is no window between pa_sink/source_new()
and _put() where enumerating sinks/sources causes an assert (several
calls in sink/source_get_info need a linked sink or source).

sink-input, source-output: Don't crash if format negotiation fails

A segfault was reported on this line:

pa_return_val_if_fail(PA_SINK_IS_LINKED(pa_sink_get_state(data->sink)), -PA_ERR_BADSTATE);

After expanding the pa_sink_get_state() macro, the line looks like
this:

pa_return_val_if_fail(PA_SINK_IS_LINKED(data->sink->state), -PA_ERR_BADSTATE);

So data->sink was apparently NULL. That could happen if we try to fall
back to the default sink, but format negotiation fails.

This bug was introduced in commit
71816ecb7f81fe7a124cefa2258cfa64046908a1.

BugLink: https://bugs.freedesktop.org/show_bug.cgi?id=74646

i18n: Update Polish translation

man: pulse-cli-syntax: Document the "journal" log target

dbus: Use correct idxset when getting sources

This fixes get_sources() which iterates wrong idxset when
getting source object paths in GetSources or GetAll.

man: improve man page and help for cmdline options

source: Increase max outputs per source

This change is just for being symmetric with sinks, which got this
change in 26bf2df903b1c7439ad3eef0dc3bb1e777835cc3.

protocol-native: Fix a crash

Without this check pa_source_output_set_volume() crashes if
so->volume_writable is false. The same check already exists for sink
inputs.

BugLink: https://bugs.freedesktop.org/show_bug.cgi?id=74529

thread-win32: Implement pa_thread_free_nojoin()

This fixes a build error with mingw32:

pulsecore/.libs/libpulsecommon_4.99_la-lock-autospawn.o: In function `unref':
/home/abuild/rpmbuild/BUILD/pulseaudio-4.99.2/src/pulsecore/lock-autospawn.c:123: undefined reference to `pa_thread_free_nojoin'
collect2: error: ld returned 1 exit status

pa_thread_free_nojoin() was initially only implemented for the pthread
based pa_thread backend, because it was incorrectly assumed that
autospawning (the only user of pa_thread_free_nojoin()) is not used on
Windows.

Reported-By: Michael DePaulo <mikedep333@gmail.com>

card-restore: Fix a memory leak

entry_read() may set entry->profile, so we need to free that string
before we can replace it with a new string.

resampler: Resample first followed by remapping if have more out channels than in channels

Reintroduces a cleaned-up version of commit 30ce3a14e5ae1cd316a18bec95b831c07ac57a1a which
was reverted by 1ce71cbd8206d1be59ac62274ad83cdbe693a96a; for more information see
http://thread.gmane.org/gmane.comp.audio.pulseaudio.general/17479/focus=17487

The patch intends to reduce computational load when resampling AND remapping. The PA
resampler performs the following steps:

sample format conversion -> remapping -> resampling -> sample format conversion

In case the number of output channels is higher than the number of input channels, the
resampler has to be run more often than necessary. E.g. in case of mono to 4-channel remapping,
the resampler runs on 4 channels separately.

To ímprove this, the PA resampler pipeline is made adaptive:

if out-channels <= in-channels:
  sample format conversion -> remapping -> resampling -> sample format conversion
if out-channels > in-channels:
  sample format conversion -> resampling -> remapping -> sample format conversion

Signed-off-by: Peter Meerwald <p.meerwald@bct-electronic.com>

resampler: Implement leftover handling in convert_to_work_format()

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>

resampler: Extend fit_buf() helper to copy leftover data to new buffer

the patch changes the interface of the (internal) fit_buf() function:
fit_buf() manages the memblock of the buf chunk, it reallocates the memblock
if the requested number of bytes ('len') if larger than the memblock's size ('size')
and optionally preserves 'copy' bytes

the code should be in line with the comment now

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>

module: Replace rindex() with strrchr()

rindex() appears to be "non-standard" to an extent, and it caused a
build failure on mingw32.

From the man page of rindex(): "POSIX.1-2008 removes the
specifications of index() and rindex(), recommending strchr(3) and
strrchr(3) instead."

device-manager: Don't try to use unlinked devices

This fixes an assertion crash:

[pulseaudio] source.c: Assertion 'PA_SOURCE_IS_LINKED(s->state)' failed at pulsecore/source.c:734, function pa_source_update_status(). Aborting.

The crash happened when a Bluetooth headset profile was changed from
a2dp to hsp. During the profile change three devices are created:
a sink, a monitor source for the sink, and a regular source. First
pa_sink/source_new() are called for each device, and that puts the
devices to u->core->sinks/sources. Then, pa_sink_put() is called for
the sink, and that in turn calls pa_source_put() for the source. At
that point module-device-manager decides to reroute all source
outputs. The non-monitor source that the Bluetooth card created hasn't
been linked yet at this stage, because it will only be linked after
the sink and the monitor source have been linked. So,
module-device-manager should take into account during the rerouting
that not all sinks and sources are necessarily linked. This patch does
that.

Reported-By: Iskren Hadzhinedev <i.hadzhinedev@gmail.com>

caps: Don't require --without-caps on FreeBSD

BugLink: https://bugs.freedesktop.org/show_bug.cgi?id=72580

daemon: Remove deprecated Encoding from .desktop files

Encoding is deprecated according to
http://standards.freedesktop.org/desktop-entry-spec/latest/apc.html

build-sys: Move ORC_SOURCE definitions outside of "if HAVE_ORC"

Not having ORC_SOURCE defined results in different tarballs depending on
whether the dev issuing 'make dist' has orc support enabled or disabled.

Specifying ORC_SOURCE unconditionally addresses that, without causing
negative effects on users not having orc in the end.

build-sys: Add tests/runtime-test-util.h to the tarball

The file is used by three test binaries, but none of them mentioned
it in Makefile.am, which caused the file to be left out of the
tarball.

build-sys: Bump sonames

The bigger than usual bump in libpulse-simple was warranted by the
change in pa_simple_flush() that allows also record streams to be
flushed. There are no changes to the function signature, but it's in
practice a change in the ABI anyway, because new clients using the new
possibility won't work with older versions of the library.

libpulse-mainloop-glib got a bug fix in commit
68156d3f79b67c77f88050e6c9de180698377c64.

introspect, thread-mainloop: Fix Doxygen "since" tags

combine-sink: fix segfault

Update Russian translation

Translated in sync with the guidelines at http://l10n.lrn.ru/wiki/Pulseaudio

Update Ukrainian translation

sink, source: Remove useless attach/detach stuff

The removed stuff wasn't used anywhere.

Revert "ladspa-sink: Handle empty chunks in sink_input_pop_cb"

This reverts commit dbe66b0b5e6b6e24df45bda8bf656836f18e7f4b.

I accidentally pushed this patch that was superseded by
e96785c1c34706e902f28c25844f31d8201db2b2.

ladspa-sink: Set a silence memchunk for the memblockq

A crash was observed that was caused by pa_memblockq_peek() returning
a NULL memblock in sink_input_pop_cb(). The scenario where this was
happening was

1. Delete 2 rtp-recv's connected to a ladspa-sink
2. Delete ladspa-sink
3. Delete alsa-sink
4. Create alsa-sink
5. Create ladspa-sink
6. Create 2 rtp-recv's connected to the ladspa-sink

The crash was probably caused by a rewind that made the read index go
negative while the write index was at least zero, causing there to be
a gap in the memblockq. The problematic rewind might have been caused
by adding the rtp-recv stream to the ladspa-sink. That has not been
proven, but this looks very similar to the bug that was fixed in
module-virtual-sink in commit 6bd34156b130c07b130de10111a12ef6dab18b52.

ladspa-sink: Handle empty chunks in sink_input_pop_cb

zeroconf-discover: Specify the interface when connecting to a link-local IPv6 address

BugLink: https://bugs.freedesktop.org/show_bug.cgi?id=40785

alsa: Mute "Bass Speaker" when using headphones or lineout

BugLink: https://bugs.freedesktop.org/show_bug.cgi?id=73604

rtp-send: Remove "don't inhibit auto-suspend" flag

A source is no longer considered idle in pa_source_check_suspend when
module-rtp-send is consuming data from it.

build-sys: Fix building with --as-needed

pulsecore/core-format.c was recently added to libpulsecommon, and
core-format.c depends on functions in libpulse, which libpulsecommon
doesn't link to. That broke building with --as-needed. This patch adds
pulse/format.c to libpulsecommon, so that core-format.c doesn't need
to depend on libpulse any more. format.c pulls in also the dependency
to json-c.

Reported-By: Jan Steffens <jan.steffens@gmail.com>

rtp-recv: Only try adding the group membership for multicast addresses

caps: Use standard macro when checking for Linux

linux and __linux are non-standard, according to
http://sourceforge.net/p/predef/wiki/OperatingSystems/

Reported-By: Damir Jelić <poljarinho@gmail.com>

alsa-card: Don't free the modargs in pa__init

The modargs are in both cases (a succesfull as well as a failed module
initialization) freed already in pa__done().

To avoid leaking modargs memory before they are assigned to u->modargs, the
code is reorganized to first allocate userdata, and then allocate the modargs.
Local variable ma is not needed anymore.

discussion here
http://lists.freedesktop.org/archives/pulseaudio-discuss/2013-December/019661.html

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
Reported-by: poljar (Damir Jelić) <poljarinho@gmail.com>

format: Add some error logging

stream: Mention pa_stream_new_extended() in the high-level stream creation documentation

stream: Improve pa_stream_connect_playback() documentation

def, format: Document how to leave PCM parameters to be decided by the server

sink-input, source-output: Interpret missing PCM parameters in format info as a request to decide those parameters at the server end

The "fix flags" (PA_SINK_INPUT_FIX_FORMAT etc.) don't work properly
with the pa_stream_new_extended() interface. This patch fixes it so
that the same effect can be achieved by leaving some of the PCM
parameters unspecified in format info objects. Also, when converting
a sample spec to a format info when using the old pa_stream_new()
interface, the "fix flags" are taken into account in that conversion.

BugLink: https://bugs.freedesktop.org/show_bug.cgi?id=68952

stream: Remove a volume channel validity check

The check is done for clients that use pa_stream_new() but not for
clients that use pa_stream_new_extended(). This is inconsistent. We
could check that the volume channels match the channels set in the
format info struct that is passed to pa_stream_new_extended(), but
that doesn't work if the format info doesn't contain the channel
information (that can happen if the client wants the server to choose
the channel count for the stream). And it should also be possible to
pass a mono volume for a multi-channel stream. The check could be
extended to handle all these cases, but I don't see much point in
wasting time on that. The server will anyway validate the stream
parameters, it's not particularly important to fail already when the
stream is being created at the client side.

stream-util: Add pa_stream_get_volume_channel_map()

The new function isn't used yet, but it soon will.

format, core-format: Constify some function parameters

sink-input, source-output: Do routing related validity checks immediately after routing

It's more logical that way.

core-format: Add pa_format_info_from_sample_spec2()

The function will be used in pa_sink_input_new() and
pa_source_output_new() to convert the sample spec given by the client
to a format info object. The set_format, set_rate and set_channels
will be set according to the stream flags (PA_SINK_INPUT_FIX_FORMAT
etc.).

core-format: Add pa_format_info_to_sample_spec2()

The function will be used in pa_sink_input_new() and
pa_source_output_new(). The fallback parameters are used to merge the
data in the format info with the sink/source sample spec and channel
map, when the format info is lacking some information.

format: Simplify pa_format_info_to_sample_spec()

core-format: Add pa_format_info_get_channel_map()

core-format: Add pa_format_info_get_channels()

This also fixes an issue in pa_format_info_to_sample_spec(): it did
no validation for the channels value. Now the validation is taken care
of in pa_format_info_get_channels().

core-format: Add pa_format_info_get_rate()

This also fixes an issue in pa_format_info_to_sample_spec(): it did
no validation for the rate value. Now the validation is taken care of
in pa_format_info_get_rate().

core-format: Add pa_format_info_get_sample_format()

Move pa_format_info_to_sample_spec_fake() to core-format

I will need to use the function from outside libpulse.

I added the channel map argument, because the function will be called
from another function that is expected to initialize the channel map.
I don't know if it's in practice necessary, but it shouldn't do any
harm either.

volume-test: Increase the allowed number of rouding errors

BugLink: https://bugs.freedesktop.org/show_bug.cgi?id=72374

module-rtp-recv: Add an argument for latency

caps: Remove the FreeBSD implementation of pa_drop_caps()

Quoting Ryan Lortie from [1]:

I assumed from my reading of the Linux code ("cap_clear()...") that it
was clearing all capabilities of the process when in fact it is only
clearing the "special to root" capabilities.

The FreeBSD version of the code indeed clears _all_ capabilities beyond
ones that the process already has (ie: cannot open any new files, create
sockets, etc.)

This has a pretty obvious adverse effect on pulseaudio's ability to do
what it needs to do -- indeed, it bombs out pretty quickly due to an
inability to read its own config file.

[1] https://bugs.freedesktop.org/show_bug.cgi?id=72580#c11

alsa-mixer: Free the description key in alsa_path_free().

bluez5-util: Free the adapter_path in device_free().

Documentation of known misuse of PulseAudio API

Hello.

Over time, I became aware of several instances of tempting but
semantically incorrect usage of PulseAudio API (one from my own bad
proposal of "improving" Wine, one from Parole media player and one
from Webkit-GTK). I want to document these gotchas so that other
developers don't fall for that. See the attached patch.

I have checked that the rendered HTML is correct, but need someone to
confirm the factual accuracy of the proposed changes and, possibly, to
improve the wording.

--
Alexander E. Patrakov