client supervisor: Switch to the alternative post select method.

client exec: Switch to the alternative post select method.

i9e: Switch to the alternative post select method.

vss: Switch to the alternative post select method.

stdout: Switch to the alternative post select method.

stdin: Switch to the alternative post select method.

audioc: Switch to the alternative post select method.

afs command task: Switch to the alternative post select method.

afs signal task: Switch to the alternative post select method.

server signal task: Switch to the alternative post select method.

server command task: Switch to the alternative post select method.

write: Switch to the alternative post select method.

play: Switch to the alternative post select method.

afh_recv:  Switch to the alternative post select method.

client: Switch to the alternative post select method.

audiod: Switch command_task to the alternative post select method.

audiod: Switch the status task to the alternative post select method.

audiod: Switch signal task to the alternative post select method.

osx writer: Switch to the alternative post select method.

oss writer: Switch to the alternative post select method.

file writer: Switch to the alternative post select method.

ao: Switch to the alternative post select method.

alsa: Switch to the alternative post select method.

wmadec: Switch to the alternative post select method.

wav filter: Switch to the alternative post select method.

spxdec: Switch to the alternative post select method.

resample: Switch to the alternative post select method.

prebuffer: Switch to the alternative post select method.

oggdec: Switch to the alternative post select method.

mp3dec: Switch to the alternative post select method.

flacdec: Switch to the alternative post select method.

fecdec: Switch to the alternative post select method.

compress: Switch to the alternative post select method.

amp: Switch to the alternative post select method.

aacdec: Switch to the alternative post select method.

dccp_recv: Switch to the alternative post select method.

udp_recv: Switch to the alternative post select method.

sched: Provide alternative post_select variant.

Code which accesses the ->error field of another task has been
a source of bugs in the past. This patch is a first step to make
->error private to sched.c.

Currently the ->post_select() methods of all tasks are supposed
to set ->error to a negative value to indicate that the task
should be terminated, i.e. t->error being negative instructs the
scheduler to not call t->pre_select() or t->post_select() any more
in subsequent iterations.  An equivalent way to achieve the same
is to let ->post_select() return an error code instead. Benefits
include

* It reduces the use of ->error outside of sched.c
* It's impossible to miss setting the error code
* It simplifies code slightly

Therefore we'd like to change the prototype of the ->post_select()
methods from

void (*post_select)(struct sched *s, struct task *t);
to
int (*post_select)(struct sched *s, struct task *t);

Changes to struct sched affects many parts of the code base,
hence converting all users at once would result in a very
large patch. Therefore we temporarily introduce an additional
->new_post_select() method according to the second declaration
above. The scheduler calls the new method if it is defined and falls
back to the old variant otherwise. This approach allows to switch
over one task after another without breaking things.

This patch introduces the infrastructure just described and switches
over the http receiver. Subsequent commits will change all other tasks
in the same way. After all tasks have been switched over we can get
rid of the old ->post_select variant and rename ->new_post_select()
back to ->post_select().

Replace gettimeofday() by clock_gettime().

POSIX.1-2008 marks gettimeofday() as obsolete, so let's switch to
clock_gettime().

clock_gettime() operates on timespecs rather than on timevals like
gettimeofday() does. Since timevals are extensively used in all
parts of paraslash, and select() takes a timeval pointer as the
timeout parameter, it seems to be easiest to add a new wrapper,
clock_get_realtime(). It calls clock_gettime(), performs error
checking (all errors are treated fatal and abort the program), and
converts the result to a timeval.

Another difference between gettimeofday() and clock_gettime()
is that sys/time.h needs to be included for gettimeofday(), while
clock_gettime() is declared in time.h which gets included from para.h.
Hence we can remove the include statement for sys/time.h everywhere.

Programs which call clock_gettime need to be linked against librt on
glibc versions before 2.17 while BSD and newer glibc-based systems
have no such requirement. To make matters more interesting,
MacOS lacks clock_gettime() completely although this function conforms
to SUSv2 and POSIX.1-2001.

We'd like to avoid the unnecessary dependence on librt on systems that
have clock_gettime() in -lc, and we must fall back to gettimeofday()
on MacOS. Hence this commit also introduces a check in configure.ac
which determines whether clock_gettime() is available and, if it is,
whether -lrt is needed. Executables are only linked with -lrt if
configure found that this is necessary.

sched: Get rid of (pre)select shortcuts.

These shortcuts let the scheduler skip any subsequent ->pre_select()
calls as well as the actual call to select(2) if the current task's
->pre_select() requested a zero timeout.

This idea turned out to be dubios at best. The main problem is that
->post_select no longer knows whether ->pre_select() and select()
have been called. For example, if ->pre_select() monitors some file
descriptor, ->post_select() might find it not ready for I/O even when
it actually is because ->pre_select() or select() was optimized away.

Another problem are tasks whose ->post_select() method expects that
->pre_select() sets some variable in a shared data structure.

This patch removes the scheduler optimizations so that all
->pre_select() methods of all tasks are called once per scheduler
interval.

audiod: Avoid delay when closing slot.

Currently we might wait up to a full scheduler interval until a slot
is closed.

This commit changes the pre_select method of the status task to check
whether some slot can be closed. In this case it requests a minimal
delay from the scheduler.

The current try_to_close_slot() is split into two functions,
must_close_slot() and close_unused_slots(). The former function is
called from ->pre_select(). It only checks whether a slot must be
closed but performs no action.

The latter function, close_unused_slots() probes all slots and closes
those for which must_close_slot() returns true.

Rename SERVER_AUDIO_FORMATS to AUDIO_FORMAT_HANDLERS.

The audio format handlers are used by para_server, para_afh and
para_play, so the old name was misleading.

configure.ac: Shorten config summary.

With many filters/writers the output line becomes rather long.
Moreover, filters and writers are also used by para_play but para_play
is not mentionend in the prefix. Just skip the prefix.

manual: Don't try to enumerate audio formats.

This is a high-level description where no details
are needed. Flac was missing anyway.

amp: Remove stray comment.

Merge branch 't/mood_fix'

Change copyright year to 2013.

Better late than never.

afs.c: Fix some spelling mistakes in comments.

Improve documentation of readv_nonblock().

Define the meaning of "sz".

Fix mood reload.

There was some confusion about how to determine whether the dummy mode
is currently active. At some places we tested if current_mood is NULL,
at others if current_mood->name is NULL. In fact neither check works:

* if a playlist is open, current_mood is NULL (but the dummy
mood is not loaded),

* loading the dummy mood currently sets current_mood->name to
"(dummy)".

This patch makes the latter variant the official one and fixes up
the code accordingly.

This also fixes the critical log message

Jan 27 18:57:29 (5) (13487) afs_event: table moods, event 9: key not found in rbtree

which occured if the dummy mood was active while an event caused the
mood to be reloaded.

afs: Add assertion to afs_cb_result_handler().

If cc is NULL we always have a bug, so it's OK to dereference this
pointer unconditionally. However, if the command handler crashes
due to cc being NULL, it is not obvious what has happened, so make
this explicit.

client: Don't print the same error message twice.

Currently, if the client task exits, the corresponding error
message is printed both by client_post_select() and by main()
of client.c.

This patch makes main() print a generic "command failed" error
message instead.

trivial: Fix typo in client.h.

signal: Restore errno on exit from signal handler.

This probably is not necessary since generic_signal_handler() calls
exit(3) if the write to the signal pipe fails. However, nobody is
going to stop write(2) from setting errno also on success, so let's
play safe and always restore its value on exit.

Speed up dep target.

By default "make" removes intermediate files during the build. However,
some of the files generated by gengetopt are needed again later for
a different target.

This patch declares these generated files as "precious", so they
will no longer be removed. On one system the build time went down
from 30s to 25s due to this one-liner.

depend.sh: Fix two typos in comment.

new codename, reset version to git

paraslash 0.4.12

Fix 'install' target.

This broke in commit 7024574d, where the AC_SUBST() was moved above
the AC_PROG_INSTALL on which it depends.  This resulted in an empty
$install_sh variable, breaking 'make install'.

Fix this bug by moving the AC_SUBST() below AC_PROG_INSTALL.

NEWS update.

Fix compilation MacOS.

The resolution of the conflict in commit 83ab4b5d introduced the
following error:

osx_write.c:329:9: error: use of undeclared label 'remove_btrn'
                        goto remove_btrn;
                             ^
Fix is trivial.

Merge branch 't/resample'

Was cooking for quite some time. The merge conflicted slightly,
but this was easy to fix.

However, even with the conflict resolved, the merged tree would not
compile because after the merge para_play depends on libsamplerate,
but this dependency was not encoded in configure.ac.

There was no way to fix this issue in either of the two branches
involved without rewriting history: The recently merged t/afh_receiver
branch (which introduced para_play) had no idea of libsamplerate
while t/resample has no idea of para_play.

This merge commit fixes both issues.

0eb69b resample filter: Implementation.
cad284 resample filter: Infrastructure.
37e0df check_wav: Ask parent nodes before falling back to defaults.
216399 Replace check_wav_task by write_task.
1af65c Move wav detection code to a separate file.
d5dc1c write: Make wav-related config options modular.
c25d04 para_filter: Call proper ->free_config method on shutdown.

Conflicts:
m4/gengetopt/makefile

Do the RC4_ALIGN dance also for sideband connections.

In commit 1199398 (March 2011) sc_send_bin_buffer() and
sc_recv_bin_buffer() received a fix for invalid reads/writes in
RC4(). The same fix is needed also for sc_crypt(), which was introduced
later in 2830b9f8 as part of the sideband API.

Without the fix, valgrind complains like this:

==14435== Invalid read of size 8
==14435==    at 0x510A03A: RC4 (in /ebio/maan/arch/Linux_x86_64/lib/libcrypto.so.0.9.8)
==14435==    by 0x40937E: sc_crypt (crypt.c:333)
==14435==    by 0x407233: sb_received (sideband.c:249)
==14435==    by 0x40770F: recv_sb (client_common.c:215)
==14435==    by 0x407FF3: client_post_select (client_common.c:427)
==14435==    by 0x406BE8: schedule (sched.c:70)
==14435==    by 0x404AE7: execute_client_command (client.c:115)
==14435==    by 0x404B77: extract_matches_from_command (client.c:133)
==14435==    by 0x404C16: generic_blob_complete (client.c:163)
==14435==    by 0x404E13: complete_lsblob (client.c:181)
==14435==    by 0x409AB0: create_matches (interactive.c:100)
==14435==    by 0x409BD0: completion_generator (interactive.c:134)
==14435==  Address 0x608bfd0 is 0 bytes inside a block of size 6 alloc'd
==14435==    at 0x4C274A8: malloc (vg_replace_malloc.c:236)
==14435==    by 0x405E64: para_malloc (string.c:65)
==14435==    by 0x40935E: sc_crypt (crypt.c:330)
==14435==    by 0x407233: sb_received (sideband.c:249)
==14435==    by 0x40770F: recv_sb (client_common.c:215)
==14435==    by 0x407FF3: client_post_select (client_common.c:427)
==14435==    by 0x406BE8: schedule (sched.c:70)
==14435==    by 0x404AE7: execute_client_command (client.c:115)
==14435==    by 0x404B77: extract_matches_from_command (client.c:133)
==14435==    by 0x404C16: generic_blob_complete (client.c:163)
==14435==    by 0x404E13: complete_lsblob (client.c:181)
==14435==    by 0x409AB0: create_matches (interactive.c:100)

See also 54cf5827.

client: Fix double free bug in interactive mode.

This can easily be reproduced: Enter "select" and type "<tab>" twice
to complete on all moods and playlists, then hit enter to trigger
the bug. On newer glibc-based systems para_client aborts due to the
double free, and valgrind outputs the following:

==10084== Invalid read of size 4
==10084==    at 0x804CA24: free_argv (string.c:813)
==10084==    by 0x804E86A: client_disconnect (client_common.c:46)
==10084==    by 0x804BF24: client_i9e_line_handler (client.c:448)
==10084==    by 0x8050140: i9e_line_handler (interactive.c:245)
==10084==    by 0x428DCF8: rl_callback_read_char (callback.c:217)
==10084==    by 0x8050264: i9e_post_select (interactive.c:265)
==10084==    by 0x804D183: schedule (sched.c:70)
==10084==    by 0x804A0C2: main (client.c:502)
==10084==  Address 0x452a928 is 0 bytes inside a block of size 8 free'd
==10084==    at 0x4028BDC: free (vg_replace_malloc.c:446)
==10084==    by 0x804E86A: client_disconnect (client_common.c:46)
==10084==    by 0x804B6B8: execute_client_command (client.c:118)
==10084==    by 0x804BA5E: select_completer (client.c:387)
==10084==    by 0x80503BF: create_matches (interactive.c:100)
==10084==    by 0x80504D0: completion_generator (interactive.c:134)
==10084==    by 0x4280B1F: rl_completion_matches (complete.c:1992)
==10084==    by 0x4280BBD: gen_completion_matches (complete.c:1062)
==10084==    by 0x4281539: rl_complete_internal (complete.c:1830)
==10084==    by 0x42819C1: rl_complete (complete.c:401)
==10084==    by 0x4278E9C: _rl_dispatch_subseq (readline.c:774)
==10084==    by 0x427917E: _rl_dispatch (readline.c:724)

The bug happens since we did not set the ->features pointer of
struct client task to NULL after the feature list was freed. The fix
is trivial.

Merge branch 't/afh_receiver'

57d75e play: Fix segfault if decoder is not supported.
98f192 Interactive support depends on curses lib.
3e3d8e para_play, implementation.
d02f88 para_play, infrastructure.
3b2ee2 Make writer nodes honor notifications.
e541d7 interactive: Introduce i9e_print_status_bar().
901f66 interactive: Implement single key mode.
6cb789 interactive: Add producer to struct i9e_client_info.
c31982 Interactive: Introduce i9e_get_error().
be1074 interactive: Fix wipe_bottom_line() on MacOS.
3ba772 interactive: Honor SIGWINCH.
56561c interactive: Honor SIGTERM.
06f33c para_afh: remove streaming mode.
4a30c5 The afh receiver, documentation.
b84e37 The afh receiver, implementation.
618a25 The afh_receiver, infrastructure.
4fa8cb Add execute mechanism to receiver nodes.
7c8931 Introduce afh_get_afhi_txt().
3f1510 audiod: Replace kill_btrn() by task notifications.
5edb8f sched: Replace sched_shutdown() by task_notify_all().
58ce61 sched: Introduce task notifications.
b56199 i9e_attach_to_stdout(): Don't insist on btrn == NULL.
7867cd Interactive: Assorted whitespace/newline fixes.
b654be interactive: kill i9ep->line_handler_running.
77b607 interactive: Do not close stderr in i9e_close().
099ef4 Add missing documentation of send_strerror().

Conflicts:
osx_write.c

resample filter: Implementation.

The resample filter allows to change the sample rate of a stream on the
fly. All the magic happens within libsamplerate, so the implementation
is quite simple.

However, one tricky thing to consider is how wav headers are treated:
Although the resample filter creates only a single task, it adds
two different nodes to the buffer tree, one for the wav detector and
another one for the resample filter itself.

At startup the generic code of para_filter or para_audiod adds only
the resample filter node, which in turn inserts the wav detector as
its own parent node. This requires to insert a new internal node to
the buffer tree which is currently not supported by the buffer tree
API. It is easy to implement this feature though, so this commit adds
the missing functionality to buffer_tree.c.

resample filter: Infrastructure.

This adds configure command line options and tests for libsamplerate,
and provides a dummy implementation of the resample filter. A simple
m4 file for the configuration options is included as well.

check_wav: Ask parent nodes before falling back to defaults.

This instructs the ->execute handler of the check_wav task to ask its
parent nodes for the channel count, sample rate and sample format in
case no wav header was found and no value for the query was given at
the command line. Currently this can never succeed, since the only
parent node of the check_wav task is the stdin task, which has no
clue about these things. However, once check_wav is being used by
the resample filter, one parent might be a decoder which can tell.

This requires to add the new public btr_parent() to buffer_tree.c to
let the check_wav node obtain the node to start the search from.

Replace check_wav_task by write_task.

Besides the task(s) associated with the given writer(s), para_write
currently sets up two other tasks: The stdin task and the check_wav
task.

The resample filter, which is to be introduced in subsequent patches,
also needs the functionality that is provided by the check wav task.
However, as filters are not supposed to create their own tasks, there
should not be a dedicated task instance for checking the wav header.

To overcome this problem we move the task member from
check_wav.c to write.c and rename the check_wav_task struct to
check_wav_context. Hence the ->pre_select and ->post_select methods
become part of para_write that call into check_wav.c to do the work.

The patch is quite large but large parts of the changes are just
trivial cwt -> cwc conversions.

Move wav detection code to a separate file.

The logic to detect a wav header  and delete it from an input stream
is useful also for the upcoming resample filter, so let's make this
code reusable.

The first step for doing so is to remove the relevant parts from
write.c to check_wav.c and exports those functions which are called
from write.c to check_wav.h.

There is one problem though: The wav detector code needs to know
the arguments for the --channels, --sample_rate and --sample_format
options given to para_write, but the code would not be reusable if
check_wav.c depended on the gengetop args info struct of para_write.

Hence we introduce the public structure wav_params in check_wav.h
for this information, which is independent of gengetopt. A simple
convenience helper for copying the command line arguments from an
(arbitrary) args info structure to a struct wav_params is provided
as well.

write: Make wav-related config options modular.

The --channels, --sample-rate and --sample-format options will also
be used by the resample filter. This moves these options to separate
files which are included from write.m4. This allows to include them
also from the config file of the resample filter.

para_filter: Call proper ->free_config method on shutdown.

Currently we just free the conf struct. For some filters this not
enough to deallocate all resources and therefore results in a memory
leak.  This leak is not serious though, since it does not affect
para_audiod, and para_filter is about to exit anyway at this point.

Fix it anyway.

Merge branch 't/osx_writer_improvements'

Cooking since 2012-10-30.

9eaa22 osx_write: Check return value of AudioOutputUnitStart().
831db3 osx_write: Be careful when dereferencing the private_data pointer.
97902a osx: Treat writer node as an internal buffer tree node.
1c6fa9 osx_write: Add big fat comment on callback btr node.

play: Fix segfault if decoder is not supported.

When paraslash was build without libmad, para_play still recognizes mp3
files (because the mp3 audio format handler does not require libmad),
but decoding fails of course.

Specifically, the check_filter_arg() call in load_file() fails, but
the error handling code misses to clear the receiver node structure,
which results in a subsequent seqfault due to a double free.

This patch calls wipe_receiver_node() instead of open coding the
cleanup. This fixes the bug and actually simplifies the code a bit.

Interactive support depends on curses lib.

If libreadline was detected, but no curses lib was found, we currently
try to activate interactive support, and compilation fails.

This patch deactivates interactive support in this case.

para_play, implementation.

This replaces the dummy implementation added in the previous commit
by a real implementation.

para_play makes use of all new concepts that have been previously
introduced. In particular, it employs the newly added single key
mode of the i9e subsystem and uses task notifications to shut down
the writer node when the user stops playback.

para_play, infrastructure.

Now that the preparatory changes to the interactive subsystem
(single key mode, status bar, signal handling) and the writer nodes
(notifications) and receiver nodes (btr exec mechanism) are in place,
we can move on to the para_play executable.

This patch adds only the necessary changes to the build system and
provides a dummy implementation of para_play. The real implementation
will be provided as as a separate patch in the next commit.

Make writer nodes honor notifications.

Currently, nobody is notifying any writer node but the para_play
executable, which will be introduced in subsequent patches, will use
this facility to terminate the audio stream.

interactive: Introduce i9e_print_status_bar().

When operating in single key mode, the users of the i9e API
may write a single line, called status bar, to stderr.

This patch adds a new public function to the i9e subsystem for
this purpose. It honors the width of the terminal and shortens
the given status bar string to fit in one line if necessary.

interactive: Implement single key mode.

This changes the i9e subsystem to operate in single key mode while
a command is running as determined by the existence of a buffer tree
node which is attached to the stdout_btrn of i9e.

In single key mode a different readline key map is activated and
single keystrokes are passed to the application via the new key
handler function pointer of struct i9e_client_info.

interactive: Add producer to struct i9e_client_info.

This enables users of the i9e API to open the i9e subsystem with
a producer already attached to the stdout buffer tree node of the
i9e subsystem.

Interactive: Introduce i9e_get_error().

Currently there is no easy way for a paraslash task to find out
whether the i9e task is still up and running. This commit adds the
new public function i9e_get_error() which simply returns the error
state of the i9e task.

interactive: Fix wipe_bottom_line() on MacOS.

Once readline has been initialized, writing more than 68 characters in one go
to stderr using stdio causes interesting effects on Mac OS. Specifically, the
terminal is completely messed up. To increase the anticipated weirdness level,
writing the same string in smaller chunks just works fine. This patch adds such
code to interactive.c.

interactive: Honor SIGWINCH.

For the upcoming single key mode of the i9e subsystem, we need to
know the width of the terminal.

This makes this information available to all functions in interactive.c
via the i9e_private structure. The new num_columns variable of this
structure is updated whenever i9e_signal_dispatch() is called with
sig_num equal to SIGWINCH.

interactive: Honor SIGTERM.

Currently i9e_signal_dispatch() only looks at SIGINT and ignores all
other signals. We'd like to honor SIGTERM as well because this provides
a handy way for other paraslash tasks to shut down the i9e subsystem,
even if no signal was received.

para_afh: remove streaming mode.

Since the afh receiver is also capable of streaming local audio files,
this feature can be removed from para_afh.

This patch also replaces "--human" by "--parser-friendly", hence
making human-readable chunk output the default.

The afh receiver, documentation.

Small patch to manual.m4 which removes the text on the streaming
mode of para_afh and adds a section on the afh receiver.

The afh receiver, implementation.

This replaces the dummy implementation added in the previous patch
by a working one. It employs the recently added ->execute method for
receivers to let other buffer tree nodes query information about the
current audio file and reposition the stream.

The afh_receiver, infrastructure.

This adds a dummy implementation of the new afh_receiver which will
replace the streaming mode of para_afh.

It "receives" its input data from a local audio file rather than from
a network socket, but supports the same API as all other receivers. In
particular it provides a buffer tree node which feeds the chunks of
the audio file to any filter which is connected to that node. This
mechanism will be used by the para_play executable.

The afh receiver is not needed for para_audiod, so we link afh_recv.o
only to para_recv.

Add execute mechanism to receiver nodes.

Currently, receiver nodes have not much information to offer which could
be interesting for their child buffer tree nodes. This is about to change
with the introduction of the afh receiver and the para_play executable.
For example, para_play needs to query the number of chunks of the current
audio file from the afh receiver in order to display playback progress.

This patch adds only the new function pointer to struct receiver. The afh
receiver will be the first user of this.

Introduce afh_get_afhi_txt().

The afh receiver needs a pretty-printed version of the audio format
handler structure, like the one that is printed in print_info()
of afh.c.

This commit moves print_info() to afh_common.c and makes it print
into a buffer rather than to stdout. The function is renamed to the
more descriptive afh_get_afhi_txt().

The single caller in afh.c is changed accordingly.

audiod: Replace kill_btrn() by task notifications.

sched: Replace sched_shutdown() by task_notify_all().

sched_shutdown() was mis-designed from the beginning as the registered
tasks have no chance to clean up. Using task notifiers allows to
replace the single caller of sched_shutdown().

sched: Introduce task notifications.

Currently there is no canonical way to perform inter-task
communications. This leads to ugly hacks like kill_all_decoders()
of audiod which is called when audiod switches to "off" or "standby"
mode. This function sets the error state of the receiver task to a
negative value and removes the receiver's buffer tree node, magically
knowing that this is the correct action to take in order to shut down
the receiver cleanly.

This patch provides a simple infrastructure for task communications
which makes such hacks unnecessary. Tasks may send a notification
value, which is a standard error code, to another task by calling the
new task_notify() function. The receiving task is supposed to check
for any pending notifications in its ->post_select function.

As a first application of the notification concept, the above mentioned
kill_all_decoders() function is changed to use notifications instead.

i9e_attach_to_stdout(): Don't insist on btrn == NULL.

This allows to call this function even if the stdout buffer tree node
is already attached. In this case i9e_attach_to_stdout() detaches
the current btr node first.

Interactive: Assorted whitespace/newline fixes.

This avoids printing unnecessary newlines and fixes the
"double-prompt" bug.

interactive: kill i9ep->line_handler_running.

What we are interested in is not if the line handler is currently
running but if there exists a buffer tree node for the stdout task. So
check this condition instead and remove the unnecessary variable.

interactive: Do not close stderr in i9e_close().

Closing stderr prevents further log messages from being printed.

Add missing documentation of send_strerror().

Merge branch 't/filter_parse_config_cleanup'

8e290f Cleanup filter command line parsers.