web: Add horizontal space between table columns.

This tweaks the style sheet to make the rows of the tables easier to
read. It affects the topic list on the development page and the list
of files on the doxygen API page.

web: Clean up style sheet.

This removes some unnecessary cruft. The pages still look as before,
at least in elinks and firefox.

web: Avoid bold face on main page.

There is no reason to highlight this particular word.

web: Add padding to all pages.

Wrap text paragraphs in <p>...</p> and increase the margin value for
the html body in the css file. This looks much better in firefox.

No change to the contents.

web: Move navigation into top level table.

Now the pages no longer look as if they were made in the nineties. More
like 2001 :)

web: Link to "./index.html" rather than to ".".

When browsing the generated html locally, clicking the logo or the
about link may cause the browser to open the directory view, which
is annoying. This commit makes these links open the main page instead.

web: Remove selected APIs page.

This list was outdated and not well maintained. Change the link on
the documentation page to point to the list of files instead.

web: Avoid "integrated" in feature list of main page.

It's not clear what this is supposed to mean.

web: Shorten slogan.

The two removed words do not convey any additional information.

web: The new logo for paraslash-0.7.

This new svg logo was not made with a graphical editor but with a
plain text exitor. Unfortunately, ImageMagick is unable to create
a working .ico file from the svg source. Therefore we continue to
carry a manually created .ico file in the repo.

The new logo is less wide than the previous one, and it does not look
nice when it floats to the right side of its tabular cell. Fortunately
this can be fixed by removing some code from the style sheet.

manual: Avoid vertical space between coding style items.

For some reason markdown inserts vertical space between adjacent
items if the code example is not enclosed in <pre>...</pre>.

Merge branch 'refs/heads/t/rm_v1_moods'

A single commit which removes a long obsolete feature.

Cooking for almost a year.

* refs/heads/t/rm_v1_moods:
  Remove support for version 1 moods.

Update copyright year.

Happy new year.

Merge branch 'refs/heads/t/rm_task_subcmd'

A single commit containing an incompatible change for 0.7.0.

Cooking for almost a year.

* refs/heads/t/rm_task_subcmd:
  Remove obsolete server subcommand "task".

web: Add Download link for master tarballs.

This link was deleted by accident when v0.6.2 was released.

Merge branch 'refs/heads/t/ubsan'

A single patch which adds an option to ./configure to instruct the
compiler to activate its undefined behaviour checker.

Cooking for two months.

* refs/heads/t/ubsan:
  New configure option: --enable-ubsan.

daemon: Improve documentation of daemon_set_log_color_or_die().

The function receives a severity string, not a log level number.

Merge branch 'refs/heads/t/duration-keyword'

A single patch which was created already in 2018 but did not propagate
to next and master for no good reason.

Cooking for a month.

* refs/heads/t/duration-keyword:
  mood: Make "duration" a new keyword for the mood grammar.

error.h: Document the error code enumeration.

Doxygen complains about the missing comment.

command.c: Remove unused includes.

None of these are needed. Tested on Linux, FreeBSD and NetBSD.

Merge branch 'refs/heads/t/score-formula'

A single patch which modifies the score function of the audio file
selector to re-scale the two quantities that comprise the score value.

Cooking for six months.

* refs/heads/t/score-formula:
  Rework score formula.

Merge branch 'refs/heads/t/list-cleanups'

A bunch of simple patches which streamline the macros and inline
functions of list.h which were taken from linux long ago without
adjusting the coding style.

Cooking for three months.

* refs/heads/t/list-cleanups:
  list.h: Convert INIT_LIST_HEAD macro to inline function.
  list.h: Fix parameter doc of iterators.
  list.h: Move list_is_singular() up.
  list.h: Rename argument of list_move().
  list.h: Don't use "new" as an variable name.
  list.h: Open-code LIST_POISON1 and LIST_POISON2.
  list.h: Get rid of internal helpers.
  list.h: Trivial cleanups.
  list.h: Remove unused list_for_each_entry_safe_reverse.

i9e: Fix typo: s/ie9/i9e.

It's weird that this was not noticed for so long.

Fixes: e541d7bea7febed8cb9f8a65ae4bd9bdd1b5c8a0
Fixes: 3e3d8e1b48bbd8dbf46adf517c311b5e78dc820f

Remove unused error code E_OGG_STREAM_FLUSH.

The last user was removed four years ago.

Fixes: c8466194a4842e319abdedfb38ddc93630e25471

web: Fix typo on documentation page.

This typo was introduced four years ago when para_fade was renamed
to para_mixer.

Fixes: 7031f4e380b429e9c0eea1b8e5484dabdbb12ae5

Merge branch 'refs/heads/t/writer_improvements'

A small set of patches which fix some minor issues, notably a problem
related to the handling of early EOF which affects all paraslash
writers.

* refs/heads/t/writer_improvements:
  alsa_write: Avoid spurious underrun warnings.
  Teach writers to abort gracefully on early EOF.
  alsa_write: Simplify alsa_post_select().

web: Fix internal link to manual.

This must have worked at some point...

Looks like it's no good idea to assume that these identifiers are
stable across markdown versions...

paraslash 0.6.4

Another v0.6 release to mark the destination of the maint branch
which will now be fast-forwarded to this commit. Subsequent merges
of topic branches into master will incorporate incompatible changes,
so from now on the master branch should be regarded as pre-0.7.

Merge branch 'maint'

* maint:
  paraslash 0.5.9

paraslash 0.5.9

A final v0.5-release to record the tip of the maint branch when
paraslash-0.5 became EOL. Shortly after this commit the 0.6.4 release
will be drawn from master, and maint will be fast-forwarded to point
to the v0.6.4 commit.

command.c: Make aux_info_cb() static.

It is only used in command.c.

string: Remove malloc attribute from para_realloc().

Quoting from the corresponding section of the gcc-10 manual:

This tells the compiler that a function is 'malloc'-like, i.e.,
that the pointer P returned by the function cannot alias any other
pointer valid when the function returns, and moreover no pointers to
valid objects occur in any storage addressed by P.

Using this attribute can improve optimization. Compiler predicts
that a function with the attribute returns non-null in most cases.
Functions like 'malloc' and 'calloc' have this property because they
return a pointer to uninitialized or zeroed-out storage. However,
functions like 'realloc' do not have this property, as they can return
a pointer to storage containing pointers.

Found by code inspection, the unpached code never caused problems.
Also, the function definition in string.c does not contain the
attribute.

alsa_write: Avoid spurious underrun warnings.

Receiving EPIPE does not necessarily mean that an underrun occurred. We
also have to check the pcm state.

Teach writers to abort gracefully on early EOF.

For very short streams it may happen that the receiver and decoder
unregister themselves from the buffer tree before the writer had a
chance to query the information from the decoder which it needs to
open the audio device. This leads to errors such as

Aug 25 14:24:51 schubert (5) get_btr_value: cmd sample_rate: Operation not supported
Aug 25 14:24:51 schubert (5) get_btr_value: cmd channels: Operation not supported
Aug 25 14:24:51 schubert (5) get_btr_value: cmd sample_format: Operation not supported
Aug 25 14:24:51 schubert (4) alsa_init: channels count not available: Invalid argument

This may happen with all receivers, audio formats and writers,
although it is most common with ogg streams.

This commit changes get_btr_sample_rate() and friends to return a
standard error code rather than assuming success. The alsa, ao and
oss writers are patched to check the return value and fail gracefully
if one of these functions fails.

alsa_write: Simplify alsa_post_select().

Clean up the private alsa data structure in alsa_close() and teach
this function to DTRT even if pad->handle is NULL because alsa_init()
failed.

client_common: Improve documentation of client_{pre,post}_select().

It was outdated and not worded very well. In particular, it referred
to a task pointer although the argument is named "context". Also,
client_open() does not return a "client data structure", so talk
about the effect of that function rather than its return value.

compress: Demote log level of clip message.

These messages trigger from time to time without having much audible
effect, so they are usually not serious.

mood: Make "duration" a new keyword for the mood grammar.

The new keyword makes it possible to define moods which impose a
constraint on the duration of the admissible files. For example,
the expression

duration < 120 * 1000

selects only files which are shorter than two minutes.

The implementation is pretty simple.

Remove ->fd of struct audio file data.

This structure contains information about the next audio file. It
is stored in a shared memory area, and a reference to this area is
sent through a pipe from the afs process to the server process. The
file descriptor of the next audio file, however, must be passed via
Unix socket magic (SCM_RIGHTS) and thus does not need to be part of
the structure.

Moreover, it's easier to define the afd structure in
open_and_update_audio_file() of aft.c rather than in its caller,
open_next_audio_file() of afs.c, because the caller only needs the
fd of the audio file and the shared memory ID but not the audio file
data structure itself.

Expand the documentation of open_and_update_audio_file() a bit while
at it.

audiod: Use para_malloc().

If the allocation fails we feed NULL to strncpy(3) which should
result in a segfault. With para_malloc() a clear error message will
be shown instead.

Found by gcc's -fanalyzer option.

sync_filter: Silence noisy warning.

It's perfectly fine to fail here due to EOF, so don't print a log
message in this case.

afs: Improve error diagnostics if no admissible files are found.

Currently, the server prints something like the following with
loglevel error:

Sep 05 21:19:42 (4) (31845) open_next_audio_file: key not found in rbtree
Sep 05 21:19:42 (4) (31844) recv_afs_result: afs code: 1, expected: 0
Sep 05 21:19:42 (4) (31844) recv_afs_result: did not receive open fd from afs

This is both cryptic and scary, given that this error is handled by
simply clearing the play bit from the vss status flags.

This commit changes the code to only print one clear log message with
loglevel notice:

Sep 05 21:34:45 (3) (5233) log_statistics: no admissible files

play: Avoid gcc warning when compiling without readline.

The EXPORT_PLAY_CMD_HANDLER() macro is only used when READLINE support
is enabled, which leads to

play.c:112: warning: macro "EXPORT_PLAY_CMD_HANDLER" is not used [-Wunused-macros]

Define the macro only when HAVE_READLINE is defined by moving down
the definition to the first user, com_quit().

server: Wait for command handler exit also when afs dies.

When para_server is running in foreground mode in a terminal session,
and gets signalled by hitting CTRL+C, it is unspecified whether the
server or the afs process receive the resulting SIGINT first. It may
even happen that the afs process dies first, and that the server sees
the resulting SIGCHLD *before* the SIGINT.

In this case we currently don't wait for the command handlers to exit
but proceed right away with the shutdown, closing the signal pipe and
destroying the shared memory area which contains the mmd structure.
This leads to error messages on shutdown such as

Sep 21 12:38:18 (5) (29166) para_semop: semaphore set 12648470 was removed
Sep 21 12:38:18 (6) (29166) para_semop: fatal semop error Invalid argument: pid 29166
Sep 21 12:38:18 (6) (29161) generic_signal_handler: Bad file descriptor
Sep 21 12:38:18 (6) (29164) para_semop: fatal semop error Invalid argument: pid 29164
Sep 21 12:38:18 (6) (29165) command_handler_sighandler: terminating on signal 15
Sep 21 12:38:18 (6) (29165) para_semop: fatal semop error Invalid argument: pid 29165

This commit avoids the issue by letting the server wait for all
its children also in the SIGCHILD case when we exit because the afs
process has terminated.

vss: Avoid double free on exit.

When para_server fails to receive the fd for the next audio file,
the memory pointed to by mmd->afd.afhi.chunk_table is freed but the
pointer is not set to NULL. If the failure was due to server and afs
receiving SIGINT, the subsequent signal handling code might attempt
to free the chunk table again. This double free error is detected by
glibc, which results resulting in messages such as

free(): invalid size
Aborted

Fortunately, this is easy to fix.

vss: Handle empty chunk groups gracefully.

The assertion in compute_group_size() triggers if the stream is
positioned right at the end of the file when the next chunk group
starts. This was observed with an mp3 file and the udp sender when
pausing and restarting the stream at the end of the file.

Fix this braino by returning EOF instead of aborting if the next
chunk group happens to be empty.

upd sender: Don't send FEC EOF from command handler context.

Without this, the EOF packet might be sent twice: once by the command
handler which stopped the stream and once by the server process. This
does not hurt, but results in additional unnecessary network traffic,
so return early from udp_close_target() when we're running in command
handler context.

New configure option: --enable-ubsan.

If the new option is given, -fsanitize=undefined is passed to the
compiler to enable the undefined behavior detector.

We don't check whether this option is supported because the configure
option is off by default.

afh: Avoid memory leak at exit.

We missed to free the lopsub parse result. This is not a real leak
because it's a one-off allocation and we are about to exit anyway. It's
worth to fix nevertheless, though, because with the patch applied,
valgrind says "no leaks are possible". Hence any other output means
we have introduced a new memory leak.

aac_afh: Fix check of return value of mp4ff_meta_update().

This function returns zero on failure, and one on success, so the
current check for a negative return value is incorrect. The call to
mp4ff_meta_get_by_index() suffers from the same mistake.

com_jmp(): Handle negative values gracefully.

Currently these get silently converted to a (large) unsigned number,
which causes para_server to skip to the next audio file. This patch
modifies the command handler to check whether the given value is
within range and fails the command if it is out of range.

Remove an uninteresting log message while at it.

server.c: Fix double "the" in comment.

Found by the vim spell checker.

Merge branch 'maint'

Just one cherry-picked commit to make the maint branch compile with
newer glibc.

* maint:
  Avoid warning about sys/sysctl.h on glibc-2.30.

Avoid warning about sys/sysctl.h on glibc-2.30.

From glibc-2.30 NEWS:

The Linux-specific <sys/sysctl.h> header and the sysctl function have
been deprecated and will be removed from a future version of glibc.

Compilation against the glibc-2.30 headers results in the following warning:

In file included from ipc.c:10:
/usr/include/sys/sysctl.h:21:2: warning: #warning "The <sys/sysctl.h> header is deprecated and will be removed." [-Wcpp]

On NetBSD and FreeBSD, however, we still need to include the header
to get the declaration of sysctlbyname(3).

This patch changes ipc.c to include sys/sysctl.h only if __FreeBSD__ or
__NetBSD__ is defined.  Also remove the pointless check for __APPLE__.

list.h: Convert INIT_LIST_HEAD macro to inline function.

Inline functions are easier to read and write, and we get type
safety.

list.h: Fix parameter doc of iterators.

list.h: Move list_is_singular() up.

This way all simple inline functions come before the various iterators.

list.h: Rename argument of list_move().

It's only the entry that is moved to a different list, so call the
argument "entry" rather than "list".

list.h: Don't use "new" as an variable name.

vim syntax highlighting trips over it.

list.h: Open-code LIST_POISON1 and LIST_POISON2.

There is only one user of each.

list.h: Get rid of internal helpers.

They only obfuscate the code.

list.h: Trivial cleanups.

Just whitespace fixes and comment improvements.

list.h: Remove unused list_for_each_entry_safe_reverse.

play: Create ~/.paraslash.

Currently para_play won't save its history if this directory does
not exist. This patch makes it create the directory at startup.

client.c: Fix typo in comment.

manual: Fix package name of flac library.

These days it is spellt lower case. Also realpath is not a separate
package anymore, so drop that.

Update copyright year.

INSTALL: Fix instructions for compiling from git.

The command line lacked the configure command.

Rework score formula.

Currently the two scales for the num_played and the last_played
components of the score value are computed independently of each
other. There is, however, a natural link between the two scales:
a file with best possible num_played value (zero) and worst possible
last_played value (now) should receive the average score zero.

This patch employs this idea to rescale the two components. See the
new comment to compute_score() for details about the implementation.

server: Don't crash on blank moods.

We special-case empty mood definitions (because we can't map the
osl object anyway), but we don't check whether the mood definition
contains anything else than whitespace or comments.

Such blank mood definitions result in an empty abstract syntax tree
indicated by ->ast of the mood parser's context structure being
NULL. We happily dereference that pointer in mp_eval_row() and die
by the resulting SIGSEGV.

The fix is trivial: simply treat blank moods in the same way as the
dummy mood, i.e. regard each audio file as admissible.

aft: Silence format-overflow warning with gcc-10.

aft.c: In function 'print_list_item':
aft.c:736:17: warning: '%*u' directive writing between 1 and 65529 bytes into a region of size 30 [-Wformat-overflow=]
  736 |   sprintf(buf, "%*u:%02u:%02d", max_width - 6, hours, mins,
      |                 ^~~
aft.c:736:16: note: directive argument in the range [1, 4294967295]
  736 |   sprintf(buf, "%*u:%02u:%02d", max_width - 6, hours, mins,
      |                ^~~~~~~~~~~~~~~
aft.c:736:16: note: directive argument in the range [-59, 59]
aft.c:736:3: note: 'sprintf' output between 8 and 65545 bytes into a destination of size 30
  736 |   sprintf(buf, "%*u:%02u:%02d", max_width - 6, hours, mins,
      |   ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  737 |    seconds % 60);
      |    ~~~~~~~~~~~~~

The code is correct but gcc can't prove it. Silence the warning by
passing the size of the buffer and asserting that it won't overflow
before printing to it.

manual: Fix dead audiocoding.com link.

As pointed out by Sven, audiocoding.com has been out of service and
shut down the website since August of 2020. The library is still
available for download on the sourceforge project page, so link to
that page instead.

Reported-by: Sven <sven.videoproc@gmail.com>

prebuffer: Remove buffer tree node on errors.

When the ->post_select method of a filter returns negative, it *must*
remove its buffer tree node as well. The prebuffer missed to do that,
which results in a stale reference to the buffer tree which keeps
the audiod slot busy. When no more slots are free, audiod hangs or
exits with a "no more free slots" message. This patch avoids this.

Remove obsolete server subcommand "task".

It was deprecated long ago. Since v0.6.2 it does nothing anyway.

Remove support for version 1 moods.

Version 2 moods were introduced in v0.6.1 which was released more
than three years ago. Since then the older version 1 moods have
been deprecated. This commit gets rid of them removing quite some
questionable and unmaintained code.

paraslash 0.6.3

alsa_write: Avoid hung tasks.

Without this fix the alsa writer may never shutdown, occupying a
slot of audiod. The hang was observed with in conjunction to the
udp receiver and the prebuffer filter. See also the recent commit
23913cbbfc98.

Merge branch 'refs/heads/t/fec'

A single patch which improves the memory management of the
fec encoder.

Cooking for half a year.

* refs/heads/t/fec:
  vss: Fix NULL pointer dereference in vss_del_fec_client().
  vss: Rework fec client setup.

gui: Fix length of audio format field.

Without this, the contents of the subsequent item (numplayed) are
overwritten by spaces. This only affects the colorful blackness theme.

aft: Avoid NULL pointer dereference.

osl_get_object() must not be called with a NULL row pointer. Currently
this may happen on blob events. This patch avoids the problem and
makes sure we catch this programming error early.

prebuffer: Bail out on bufffer tree errors.

Without this, the prebuffer filter might stay active forever, occupying
a slot of para_audiod until no more slots are available. This was
observed with the udp receiver.

Replace /* fallthrouth*/ by __attribute__ ((fallthrough));

Some (recent) gcc versions still complain because the switch case
falls through. The new code causes a warning on old compilers which
don't know the fallthrough attribute, but this is still better than
seeing the warning on systems with a recent compiler.

aft: Avoid invalid read.

A short chunk table is fatal for all audio formats except aac,
which employs dynamic chunks. The below valgrind spat was found when
para_server tried to open an aac audio file. Setting afhi->chunk_table
to NULL in this case should fix it.

==17667== Invalid read of size 4
==17667==    at 0x805A862: write_u32 (portable_io.h:95)
==17667==    by 0x805A862: save_chunk_table (aft.c:402)
==17667==    by 0x805A862: save_chunk_table (aft.c:395)
==17667==    by 0x805DDE6: save_afd (aft.c:616)
==17667==    by 0x805DDE6: open_and_update_audio_file (aft.c:1113)
==17667==    by 0x8058AA2: open_next_audio_file (afs.c:425)
==17667==    by 0x8058AA2: execute_server_command (afs.c:867)
==17667==    by 0x8058AA2: command_post_select.part.0 (afs.c:921)
==17667==    by 0x8063062: call_post_select (sched.c:80)
==17667==    by 0x8063062: sched_post_select (sched.c:106)
==17667==    by 0x8063062: schedule (sched.c:159)
==17667==    by 0x8059643: afs_init (afs.c:1006)
==17667==    by 0x804D747: init_afs (server.c:529)
==17667==    by 0x804D747: server_init (server.c:601)
==17667==    by 0x804D747: main (server.c:690)
==17667==  Address 0x4d7dcd0 is 0 bytes after a block of size 40 alloc'd
==17667==    at 0x40365E2: malloc (vg_replace_malloc.c:309)
==17667==    by 0x8053AB6: para_malloc (string.c:63)
==17667==    by 0x805B20D: load_chunk_table (aft.c:415)
==17667==    by 0x805DD65: open_and_update_audio_file (aft.c:1103)
==17667==    by 0x8058AA2: open_next_audio_file (afs.c:425)
==17667==    by 0x8058AA2: execute_server_command (afs.c:867)
==17667==    by 0x8058AA2: command_post_select.part.0 (afs.c:921)
==17667==    by 0x8063062: call_post_select (sched.c:80)
==17667==    by 0x8063062: sched_post_select (sched.c:106)
==17667==    by 0x8063062: schedule (sched.c:159)
==17667==    by 0x8059643: afs_init (afs.c:1006)
==17667==    by 0x804D747: init_afs (server.c:529)
==17667==    by 0x804D747: server_init (server.c:601)
==17667==    by 0x804D747: main (server.c:690)

mp: Always set mp_context to NULL on errors.

In mp_init(), if mp_yyparse() fails, we return early without setting
the result pointer to NULL. This does not matter much because both
callers of mood.c pass in NULL, but still..

gui: Do not decode the pressed key multiple times.

Although the key name is a loop invariant, we recompute it during
every iteration of the loop. Fix this.

gui: Have km_keyname() return const.

We neither want the caller to write there nor to free the memory.

server: Add --dccp-no-autostart.

We already have --http-no-autostart and --udp-no-autostart. Add the
new option for consistency.

vss: Fix NULL pointer dereference in vss_del_fec_client().

fc->src_data may well be NULL here, for example if para_server is
not currently playing.

This bug was introduced in the previous commit after the topic branch
had been promoted to next.

afs: Improve error diagnostics.

If an afs table can not be opened, we miss to log the error reason.
Also, if the audio file table does not exist, state this fact
explicitly.

doc: Add missing \ref in crypt.h.

This way, we get a warning when the name of the function changes but
the comment is left unmodified.

crypt_common: Constify hash pointers.

hash_to_asc() and hash_compare() only read from the memory locations
given by these pointers.

vss: Rework fec client setup.

The current fec code assumes that the chunks of the audio file form a
contigous buffer. At least for aac/m4a this is not true, which is
why streaming m4a files over udp never worked well.

This patch should be a big improvement in this regard. We now copy
the chunks to preallocated buffers, which also makes the code easier
to follow because we can get rid of the two extra buffers in struct
fec_client.

vss.c: Fix typo in comment.

gui: Adjust position of num_played value.

If the terminal window is only 80 characters wide, the num_played
value may be adjacent to the bitrate value, with no space between.
This happens only if the num_played value is bigger than 99, and only
with the "colorful blackness" theme.

This simple patch should fix the issue.

Avoid audiod hangs when prebuffer filter is active.

This filter misses to honor task notifications. As a result of this
omission, when CTRL+C is pressed while audiod is running in foreground
mode and the prebuffer filter is active, the audiod process hangs.

The fix is obvious.

Merge branch 'refs/heads/t/para_play'

A single patch which adds --end-of-playlist to control the behaviour
of para_play when the end of the playlist is reached.

Cooking for three weeks.

* refs/heads/t/para_play:
  play: New option: --end-of-playlist.

Update copyright year.

Fortunately, there is only a single location that needs to be
updated.

aft: Update afhi after addblob.

The old status_item_ls_data.afhi might refer to unmapped memory.

Merge branch 'refs/heads/t/stale-pointer-fix'

This bug only triggered if the kernel changes the address of the memory
mapping of the audio file table after a file was added, and a subsequent
operation would access the then stale pointer.

Cooking for a week.

* refs/heads/t/stale-pointer-fix:
  Don't use strdup() to copy hash.
  aft: Avoid stale pointer pointer reference.

Don't use strdup() to copy hash.

There was a braino in the previous patch: the hash may well contain
a zero byte, so we need to use memcpy().