version.c: Remove bad doxygen \file comment.

The file is version.h, not version.h.

configure.ac: Fix list of command line objects for OS X.

The additional .cmdline suffix causes the build to fail.

This bug was introduced 10 months ago in commit 0f4790f2.

Merge branch 't/gui_sched'

Was cooking for two months, since 2014-05-11.

* t/gui_sched: (53 commits)
  gui: Always initialize theme.
  gui: Simplify color handling.
  gui: Dont catch SIGWINCH.
  gui: Call waitpid() from exec and status task.
  Doxify para_gui.
  gui: Speed up window refresh.
  gui: Rename cmd_task to exec_task.
  gui: Move static variables of cmd_post_select() into struct cmd_task.
  gui: Move some variables into struct status_task.
  gui: Switch to the standard paraslash scheduler.
  gui: Use cpp magic to define command handlers.
  gui: Execute stat command in status_post_select().
  gui: Rename COMMAND/EXTERNAL/GETCH mode.
  gui: Get rid of do_select()'s mode parameter and call it only once.
  gui: Reorder functions.
  gui: Move signal handling code out of do_select().
  gui: Move input related code out of do_select().
  gui: Move external command handling out of do_select().
  gui: Introduce status_post_select().
  gui: Improve config reload.
  ...

Merge branch 't/cpsi_improvement'

Cooking since 2014-05-03.

* t/cpsi_improvement:
  com_cpsi(): Tell the user if nothing was copied.

manual: Mention that audio format handlers are part
of para_recv and para_play.

error.h: Remove obsolete RBTREE_ERRORS

Fix two typos in comments of attribute.c.

Merge branch 't/bitstream_improvements'

Cooking since 2014-04-22.

* t/bitstream_improvements:
  bitstream: Improve documentation.
  wma: Store ASF header info in afhi->techinfo.
  bitstream: Replace check for impossible condition by assertion.
  bitstream: Remove pointless variable "code_prefix2".
  bitstream: Micro-optimization.
  bitstream: Kill pointless variable "symbol".
  bitstream: Trivial coding style fixes.
  bitstream: Trivial spelling fix auxillary -> auxiliary.

Merge branch 't/audiod_com_version'

Cooking since 2014-04-03.

* t/audiod_com_version:
  audiod: Implement version command.
  audiod: Trival spelling fix for com_tasks().

crypt: Simplify base64_decode().

We never call this function with target == NULL.

Merge branch 't/ao_fixes'

Cooking since 2014-03-22.

* t/ao_fixes:
  ao_write: Call ao_initialize() only once.
  ao_write: Join threads before returning an error from aow_post_select().
  ao_write: Simplify locking.
  Don't unlock and lock the thread mutex unnecessarily.
  ao_write: Check return value of pthread functions.
  ao_write: Avoid segfault on exit.
  ao_write: Avoid pthread_join().
  ao_write: Enforce a 20ms timeout.
  ao_write: Fix spurious segfault.

gui: Always initialize theme.

parse_config_file_or_die() contains the following bug: If the
configuration file ~/.paraslash/gui.conf does not exist, the current
code not only skips the gengetopt config file parser (which is correct)
but also omits to call theme_init(), which is incorrect.

The bug was introduced recently in commit 18d37e (Unify config
file parsing). Fix it by moving the call to theme_init() to
the bottom of the function so that it is called if and only if
parse_config_file_or_die() succeeds.

Merge branch 't/test_man'

Cooking since 2014-03-16.

* t/test_man:
  test-lib: Make colors work on FreeBSD.
  test suite: Add sanity check for generated man pages.

gui: Simplify color handling.

Various gui elements of para_gui can be customized through struct
gui_theme. Currently this structure contains two integers for each
each element, one for the foreground and one for the background color
of the element. This is a bit clumsy and repetitive.

This commit cuts down the number of fields of struct gui_theme by
a factor of two by introducing struct gui_color_spec as a pair of
integers.

The patch is quite large but also simple.

gui: Dont catch SIGWINCH.

This is unnecessary since the curses library generates a KEY_RESIZE
event on SIGWINCH anyway. Hence window change events can be handled
as well in the normal input processing function. This allows to remove
the SIGWINCH part of the signal handling code.

Another advantage of handling SIGWINCH in the same way as normal
input events is that it is easier to propagate the event. This will
turn out to be useful for the upcoming gui menu changes.

gui: Call waitpid() from exec and status task.

This commit changes signal_post_select() to not call waitpid() via
para_reap_child() any more. Instead it notifies all tasks using the
new error code E_GUI_SIGCHLD. The exec task and the status task honor
this notification and call waitpid() for their "own" pid to check
whether the executing process or the stat process has terminated and
to obtain the exit status.

Although neither task cares deeply about the exit code, the menu
commands, which will be implemented in subsequent patches, will
care. So it's good to have the option to get this information.

Doxify para_gui.

Now that para_gui is in a much better shape, let's make it a first
class citizen and document all public functions and data structures.

gui: Speed up window refresh.

We had way too many calls to wrefresh() which copies the named
window to the physical terminal screen. This slows down the display
considerably, especially on slow machines.

It is more efficient to perform the copy only once per scheduler
iteration. So this commit adds a flag "needs_update" to struct
gui_window, and all callers to wrefresh() are changed to call
refresh_window() instead. This new function is much cheaper since it
only turns on the needs_update flag but does nothing else.

In input_post_select() we check which windows have the flag set and
repaint those windows using wnoutrefresh() and then doupdate(). This
two-step approach is described in the curs_refresh(3X) man page as
more efficient then calling wrefresh() for each window separately
since it avoids alternating calls to wnoutrefresh() and doupdate().

gui: Rename cmd_task to exec_task.

The term "command" currently means either a gui command handler or
the process which is executing as a result of a defined key map. Avoid
this confusion by using the word only for command handlers.

This commit also simplifies exec_cmd() and exec_para() slightly by
moving the "hit any key to abort" message into the common function
exec_and_display().

gui: Move static variables of cmd_post_select() into struct cmd_task.

For the same reason stated in the commit message of the previous patch,
these variables belong to the context structure of the command task,
so move them there.

The COMMAND_BUF_SIZE define had to be moved above the definition of
struct cmd_task since COMMAND_BUF_SIZE uses it.

gui: Move some variables into struct status_task.

pre_select and post_select methods should never define static variables
but store their state in the context structure which also contains
the task structure.

This commit moves the static variables of status_post_select() and the
global variables next_exec and stat_pipe into the context structure
of the status task.

gui: Switch to the standard paraslash scheduler.

Due to the preparations performed in previous patches, this is a
rather simple change. Note we don't need to define a struct signal_task
since this structure is already defined in signal.h.

gui: Use cpp magic to define command handlers.

This shortens the code a bit and avoids duplications. The command
handler for cancel_scroll had to be renamed from com_cancel_scrolling()
to com_cancel_scroll() since the old name did not match command name.

gui: Execute stat command in status_post_select().

pre_select methods should only deal with fd sets and select timeouts,
so the part of status_pre_select() which restarts the status command
belongs to status_post_select().

Unfortunately, after this change both status_pre_select() and
status_post_select() need to know when to restart the stat command.
Therefore we had to add a new global variable next_exec.

The patch also moves status_pre_select() up so that the two functions
are close to each other.

gui: Rename COMMAND/EXTERNAL/GETCH mode.

This value tells if there is a command executing, and if so, whether
it is an external command or a display command. Hence "cmd_status"
is to be more to the point.

gui: Get rid of do_select()'s mode parameter and call it only once.

The current code calls do_select() from three different locations. The
mode parameter indicates whether a command is currently running
and if it is a display command or an external command (where curses
is disabled).  This is unnecessarily complex as we can tell from the
values of the command_fd[] array and the cmd_pid variable which mode
we are in.

This commit introduces get_select_mode() which looks at these variables
and returns the current mode. This allows to get rid of the mode
parameter of do_select() and to call do_select() only once at startup
from main(). It now runs in an endless loop, checking the current mode
in each iteration. The other two call sites, exec_and_display_cmd()
and external_cmd(), don't need to call do_select() any more.

This change removes more lines than it adds and makes the logic
of para_gui much simpler to follow. It is also the last big step
to replace the do_select() loop in favor of the standard paraslash
scheduler.

gui: Reorder functions.

As a preparation for the removal of do_select() we need various
functions of gui.c to be in a different order. Specifically,
input_post_select() will soon call handle_command(), so the latter
function will need to be declared before the former.

Patches which move functions around are generally hard to
read, so this commit performs pure code movement only. However,
as exec_and_display_cmd() still calls do_select() we introduce a
temporary forward declaration for do_select(). It will be removed
in the next patch.

gui: Move signal handling code out of do_select().

As a further preparation for employing the standard paraslash scheduler
within para_gui, this simple patch introduces signal_pre_select()
and renames handle_signal() to signal_post_select().

The signal related part of do_select() is moved to these two functions
so that do_select() is reduced to the bare minimum: one call to each
of the two new functions.

gui: Move input related code out of do_select().

This moves the relevant part of do_select() into the new functions
input_pre_select() and input_post_select().

gui: Move external command handling out of do_select().

This commit moves the part of do_select() that deals with
external commands to separate functions, command_pre_select() and
command_post_select().

This change shortens do_select() considerably and is another step
towards the goal of using the paraslash scheduling system also for
para_gui.

One thing to note is that the new command_post_select() returns -1 if
both both fds are closed, i.e. when the currently running command has
terminated. This value gets translated back to zero in do_select(),
preserving the current semantics.

gui: Introduce status_post_select().

This moves stat pipe error handling into read_stat_pipe() and renames
the function to status_post_select(), which is more to the point. It
shortens do_select() a bit.

Since status_post_select() now calls print_all_items() and
clear_all_items() it had to be moved down to avoid a forward
declaration.

gui: Improve config reload.

There are two ways to make para_gui reload its config file: Sending
SIGUSR1 and running the internal reread_conf command. When SIGUSR1
is received, signal_post_select() calls com_reread_conf(). This is
a layer violation since command handlers should only be called from
the input task.

This patch provides the generic function reread_conf() which is called
from both the command handler and from signal_post_select().

gui: Unify config file parsing.

The gui config file is parsed on startup, when the reload command
is executed or when SIGUSR1 is received. In all cases we set up a
gengetopt params structure and pass its address to the gengetopt
command line parser.

This commit moves the common code to the new parse_config_file_or_die()
which does the right thing for both the startup and the reload
case. The new function also contains the logic of configfile_exists(),
so this latter function can be removed.

gui: Remove ->cols and ->lines of struct gui_window.

The curses library provides the getmaxyx() macro to obtain the window
geometry. It's better to use these instead of storing the number of
lines and columns in the gui_window structure because with getmaxyx()
there is no risk to have stale values gui_window structure.

While the ncurses implementation provides getmaxx() and getmaxy()
to get only the number of lines or columns, respectively, only
getmaxyx() is described in the XSI Curses standard. Hence we provide
our own version of the former two functions. These call getmaxyx()
and return one of the two numbers.

With the ->cols and ->lines fields of struct gui_window gone, all
callers had to be adjusted to use either getmaxyx() or one of the
new functions.

gui: Move call to print_all_items() into init_wins().

All three callers of init_wins() called print_all_items() directly
thereafter. init_wins() had to be moved below print_all_items().

gui: Improve check_key_map_args().

Simplify the code a bit, make it call die() on errors and print
the invalid key map in the error case.

gui: Combine exit functions.

Currently we have kill_pg_and_die(), finish(), msg_n_exit(), which
is kind of excessive. This patch replaces these three functions by
the single die() which does the right thing in all cases.

gui: Make curses_log() work also when curses is not active.

This allows to get rid of all fprintf(stderr, ...) constructs and
simplifies the code a bit.

gui: Parse command line options only once.

There is no point in calling gui_cmdline_parser_ext() when rereading
the configuration since this parser only looks at the command line
options which never change.

Removing the call in com_reread_conf() also allows to get rid of the
global _argc and _argv variables.

gui: Clear top window only once on resize.

init_wins() already clears the top window.

gui: Replace global variable curses_active by a function.

There is no need to store this information as we can easily compute it.

shutdown_curses() needed to be changed to cope with early failures:
On fatal errors that happen after initscr() was called but before
the top window exists, we must shut down the curses subsystem albeit
curses_active() returns false in this case.

gui: Kill struct gui_window->beg{xy}.

These values are only needed in init_wins(), so we might as well use
local variables for them.

gui: Remove change_theme().

It's silly to have a function for this.

gui: Move windows *after* resizing them.

This appeared to be the reason why refresh() was needed twice.

gui: Rename public gui theme functions.

Prefix all functions related to themes with "theme_".

Remove chop().

In curses_log() we currently we call chop(), which calls strlen()
to find the last character of the given string. This is unnecessary
since xvasprintf() returns this information anyway, we just have to
remember it.

With this change the last user of chop() is gone, so this patch
removes chop() from string.c.

gui: Use whline() for drawing the separator.

This should be slightly more efficient.

This patch also changes the type of struct gui_theme->sep_str from
const char * to plain char and renames the field to sep_char. It must
be a single-character string anyway.

For the colorful blackness theme we now use the default character
from curses.h rather than '-'. This looks nicer. Tested with ncurses
on Linux and the curses implementation that ships with NetBSD.

gui: Remove welcome message.

The only information shown by print_welcome() that is not already
contained in the status bar is the name of the current theme. This
is not very interesting, so remove the function and the corresponding
color pair.

gui: Simplify print_status_bar().

Curses is always active at this point, so remove the check. Moreover,
refreshing of all other windows is performed in init_wins(), so move
the call to wrefresh() there to be consistent. Finally, the comment
of this function is rather pointless, so remove that as well.

gui: Print the status bar only once.

Currently we print it twice on startup. Remove the redundant call
to print_status_bar().

gui: Remove macro STANDARD_STATUS_BAR.

It's only referenced once in print_status_bar(), so we may as well
print the text there without defining a macro for it.

gui: Simplify display command execution.

para_cmd() and display_cmd() are almost identical. Move the
command part into send_output() and rename this function to
exec_and_display_cmd().

gui: Don't close command fds if a key was pressed.

Killing the command is enough, as command_post_select() will notice
the EOF condition and close these fds.

gui: Avoid magic number in enum gui_color_pair.

This way it works also if the set of status items is extended.

gui: Kill pointless initialization of top.lines in main().

init_curses() sets this value anyway.

gui: Make curses_active a bool.

This variable is only used as a boolean.

gui: Rename label of check_key_map_args()

The old name is misleading since the code starting at this label will
be executed unconditionally.

gui: Rename struct win_data to gui_window.

We will pass around pointers to these structures eventually, so let's
choose a better name.

gui: Add trailing newline to all log messages.

Currently we have a funny mixture of the two styles. This is no problem
since curses_log() will chop the trailing newline. But let's better
be consistent.

gui: Fix some trivial whitespace and spelling issues.

gui: Remove unused struct stat_item.

gui: Initialize command_fds to -1.

We check at various locations whether the two members of the
command_fds array are negative to tell if an external command or a
display command is currently running. At startup, there is no such
command, hence the two integers of the array should be initialized
to a negative value.

gui: Use proper column number in print_in_bar().

This function modifies the input window, not the status bar
window. This bug is benign because both windows have the same number
of columns.

gui: Reset command buf offset on errors.

On read errors or EOF we close the pipe that corresponds to
stdout/stderr of the current display command. However, we miss to
reset the offset value of the command buffer in this case. If this
offset was positive at the time the read error occurred, we skip the
first part of the output of the next command.

Fix this by always resetting the offset after closing the pipe.

gui: Shut down curses before rereading the config file.

If the config file contains errors, gui_cmdline_parser_config_file()
calls exit() while curses is still active, leading to messed up
terminal settings. Fix this by calling shutdown_curses() before
parsing the config file, and init_curses() thereafter.

Merge branch 't/alsa_improvements'

Was cooking for almost two months.

* t/alsa_improvements:
  alsa: Remove pointless initialization.
  alsa_mix: Allow non-positive mixer values.
  alsa: New writer option: --buffer-time.
  alsa: Work around poll fd problems.
  alsa: Set period time.
  alsa: Also dump hardware params.
  alsa: Improve help text of --device.
  alsa: Improve documentation of struct private_alsa_write_data.
  alsa: Don't set t->error in ->pre_select().

com_cpsi(): Tell the user if nothing was copied.

All but the first argument to the cpsi command are treated as patterns.
Currently, if no file matches any given pattern, the command exits
silently.  This patch makes it print a "nothing copied" message in
this case.

Remove client_disconnect().

Everything this function does can be done as well when the task
terminates by returning negative in ->post_select().

This also avoids to leak the stream cipher structure of the previous
connection when running in interactive mode.

1,032 bytes in 1 blocks are definitely lost in loss record 61 of 85
   at 0x402994A: malloc (vg_replace_malloc.c:263)
   by 0x804C689: para_malloc (string.c:71)
   by 0x804FF87: sc_new (crypt.c:268)
   by 0x804E204: client_post_select (client_common.c:370)
   by 0x804D203: schedule (sched.c:59)
   by 0x804A2E7: main (client.c:500)

1,032 bytes in 1 blocks are definitely lost in loss record 62 of 85
   at 0x402994A: malloc (vg_replace_malloc.c:263)
   by 0x804C689: para_malloc (string.c:71)
   by 0x804FF87: sc_new (crypt.c:268)
   by 0x804E217: client_post_select (client_common.c:371)
   by 0x804D203: schedule (sched.c:59)
   by 0x804A2E7: main (client.c:500)

Fix memory leak in btr_splice_out_node().

Commit 072391fc (Improve btr_splice_out_node(), 2013-03) modified this
function to take a pointer to a buffer tree node pointer so that the
node pointer can be invalidated after it is spliced out. However, this
also means the caller can no longer free its resources. Hence we must
free the btrn in btr_splice_out_node() in order to avoid memory leaks.

Merge branch 't/rl_free_keymap'

Cooking since 2014-03-10.

* t/rl_free_keymap:
  build: Check whether rl_free_keymap is declared.

bitstream: Improve documentation.

Mention that the bitstream API is only used for the WMA decoder,
avoid overlong descriptions of function parameters and add some
doxygen \ref commands.

wma: Store ASF header info in afhi->techinfo.

This changes the wma audio format handler and decoder to store
the ASF header bits we care about (exp_vlc, bit reservoir, and
variable block length) in struct asf_header_info instead of struct
private_wmadec_data.

This way the wma audio format handler can print this information in
its ->techinfo string for the audio file.

bitstream: Replace check for impossible condition by assertion.

No big deal because behaviour is unchanged (abort). Calling assert()
is a bit shorter and will print a better error message.

bitstream: Remove pointless variable "code_prefix2".

This variable is only used at one place. Using the computed value
directly in the conditional allows to get rid of it.

bitstream: Micro-optimization.

Subtract n_prefix right away, and don't get the next code if n becomes
non-positive. This is equivalent and saves one comparison.

bitstream: Kill pointless variable "symbol".

It is just a copy of the loop index i. Since i is never modified
we may simply use i instead.

bitstream: Trivial coding style fixes.

bitstream: Trivial spelling fix auxillary -> auxiliary.

version.c: Fix year in version_text().

We want a single year here. The string got converted to a range by
mistake in commit 027f2c12.

flac afh: Fix off-by-one bug in meta_eof_cb().

After the full file has been read, the file position equals the number
of available bytes. The eof callback did not report EOF in this case.

wma afh: Read the description field as the comment tag.

The wma audio format handler parses the entries of the ASF content
description object and interprets its fifth field as the comment tag.

This is wrong, since this field actually corresponds to the rating
information, which is usually unused. The correct field to examine
is #4.

oggdec: Remove noisy debug message.

Also improve the comment for this code block.

reset version to 'git'

paraslash 0.5.2

Merge branch 't/oggdec_latency_improvements'

A single commit which was cooking since 2014-03-11.

* t/oggdec_latency_improvements:
  oggdec: Decode only OGGDEC_OUTPUT_CHUNK_SIZE many bytes per iteration.

Merge branch 't/opusdec_busy_loop_fix'

A single fix that was cooking since 2014-03-02.

* t/opusdec_busy_loop_fix:
  opusdec: Fix busy loop.

Revert "Add -Wdeclaration-after-statement."

This reverts commit cf517575ef0e501c963964ba4fd62aadaf795af8. It
broke our promise that paraslash still compiles with gcc-3.3.3.

ao_write: Call ao_initialize() only once.

It is possible that another instance of the ao writer is active
when aow_close() is called. Calling ao_shutdown() in ao_close()
might disturb the other instance and lead to a segmentation fault.

Fix this by calling ao_initialize() only once during aow_init()
and never call ao_shutdown() any more.

ao_write: Join threads before returning an error from aow_post_select().

This guarantees the play thread is not active any more in aow_close().

ao_write: Simplify locking.

Currently we lock the mutex at the beginnint of each iteration
of the main loop of aow_play() and drop the lock before calling
ao_play(). On errors we leave the loop either with the mutex locked
locked or unlocked, depending on the error condition that caused us
to break out of the loop.

This is unnecessarily complex. This patch simplifies the locking
by always leave the loop with the mutex locked.

Don't unlock and lock the thread mutex unnecessarily.

ao_write: Check return value of pthread functions.

Although pthread_cond_wait() and pthread_cond_signal() should never
fail on our setup, let's be conservative here and check the return
value anyway.

This patch also adds some comments and removes a few lines of code
which were commented out since day one of the ao writer.

ao_write: Avoid segfault on exit.

If para_audiod is terminated by a signal it calls the ->close() method
of each active writer. In this method the ao writer calls ao_close()
and frees all resources but leaves the play thread active. So the
thread continues to run, prints

ao_alsa ERROR: write error: File descriptor in bad state

and probably crashes afterwards due to accessing freed memory. Fix this
by cancelling the thread in ->close() if it exists. Ironically enough,
this re-introduces a call to pthread_join(), but it's OK here since
we the cancelled thread should exit immediately (so we don't block),
and we are about to exit anyway.

ao_write: Avoid pthread_join().

The call to pthread_join() may block for hundreds of milliseconds,
depending of the amount of buffered data. This is not acceptable in
a post_select hook. Among other problems this leads to an incorrect time
display and fake "time jump" warnings.

This patch drops the call to pthread_join() and makes ->post_select()
return non-negative until the play thread has terminated. In order to
have a way to tell if the thread is still running we let the thread
(i.e. aow_play()) remove its own buffer tree node on exit instead
of doing this in ->post_select() after pthread_join(). Hence if
->thread_btrn is NULL, we know the thread has terminated. It would
be easier to use pthread_tryjoin_np() but this would not be portable,
as this function is a non-standard GNU extension.

ao_write: Enforce a 20ms timeout.

Without this, the ao writer frequently complained about buffer
underruns.

ao_write: Fix spurious segfault.

Both btr_node_status() and btr_consume() access the buffer tree of
the ao writer, so these functions must be called with the pthread
mutex locked.

Merge branch 'maint'

audiod: Avoid segfault on exit.

When para_audiod terminates, it calls clean_exit() which closes
all slots unconditionally, regardless of whether they are in use.
This may lead to a segfault due to an invalid read:

==25253== Invalid read of size 4
==25253==    at 0x40EBEA: close_slot (audiod.c:443)
==25253==    by 0x40FCE8: clean_exit (audiod.c:1163)
==25253==    by 0x40FD7D: signal_post_select (audiod.c:1014)
==25253==    by 0x41490A: schedule (sched.c:65)
==25253==    by 0x406BC3: main (audiod.c:1436)
==25253==  Address 0x5c19d8 is not stack'd, malloc'd or (recently) free'd

This bug was introduced 9 month ago in commit eec23a69 (audiod:
Fix memory leak on exit: close slots). Fix it by calling
close_unused_slots(). This also simplifies clean_exit() a bit.

audiod: Implement version command.

It's sometimes useful to tell the git version of a running instance of
para_audiod. This commit adds the "version" subcommand to para_audiod
which prints this information. A completer for the "-v" option of
the new command is provided as well.

Since the infrastructure is already in place, all of this is rather
simple.

audiod: Trival spelling fix for com_tasks().