doc-site

send.h

senders

send/source-browser

write

afh

afh.h

f

afh

Move detailed desc to top

layout

.

.

.

.

.

.

.

dox

dox

recv.c: Do not include fd.h

doxygen

dox

doxygen

Revamp documentation of filter.c

doxygen: Hide undocumented members.

css: Remove a lot of unused cruft.

None of these are actually used in the pages generated by doxyen-1.8.

doxygen: Use a more sane default output directory.

Put the pages below build/ so that make distclean removes them.

i9e: Constify completer arrays.

This way the array of completers goes into the rodata section.

Prefer __func__ to __FUNCTION__.

The former is part of the C99 standard, while the latter is only provided
for backward compatibility. This change also silences many gcc warnings when
compiling with -Wpendantic (disabled in the default build).

imdct: Kill fftsample_t typedef.

There is no advantage in not using plain float here.

Doxgen: Do not omit brief descriptions.

Commit 3107d2411a7a was a bit overzealous because with BRIEF_MEMBER_DESC
and REPEAT_BRIEF both set to NO the short text does not even make it into
the detailed description. This was unintended, so partially revert this change.

Fixes: 3107d2411a7a8f4085d0db65851483f2cb3c4f6e

fd: Modify xwrite() and write_all() to take void * buffer argument.

That's what the underlying call to writev(2) expects.

Merge topic branch t/wmadec into master

A few patches which remove unused code from the wma decoder and audio
format handler. Notably, noise coding was removed completely since
it was only used for unusual bit rates. Most likely, it never worked
in the first place.

* refs/heads/t/wmadec:
  wmadec: Fix typo in comment.
  wmadec: Remove a stale comment in wma_init().
  wmadec: Kill pointless start/end computations.
  wmadec: Remove noise coding.
  wmadec: Simplify wma_init().
  wmadec: Remove fft().

net.c: Convert SS_IS_ADDR_V4MAPPED() to lower case.

It's not a macro, after all. Remove the superfluous braces and fix
a whitespace issue while at it.

Shrink struct rmatt_event_data.

The aft event handler needs to know the bit number of the attribute which is
being removed in order to clear the bit in the afs info structure of each row
of the audio file table. The handler does not need to know the attribute's
name, though, and remove_attribute() already prints it, so remove this field
from the event data structure.

filter.c: Constify dummy variable.

It needs to be non-static, but it may be const because the amp filter
only reads the values of this array.

filter.c: Remove unused status_item_list[].

para_filter does not need this at all, and never has, afaict.

audiod.c: Make slots[] static.

It's only used in audiod.c.

server.c: Remove unused server_get_tasks().

The last caller was removed when the tasks server subcommand was disabled
eight years ago.

Fixes: bb91597b9ecf650a63a40753f7f7c771576d252e

Merge topic branch t/select- into master

A single patch which implements the new "select -" feature to switch
back to the previous mood or playlist.

* refs/heads/t/select-:
  com_select(): Support '-' to reactivate the previous mood/playlist.

css: Remove memItem tweaks.

The pages look better without this since the tables no longer contain
horizontal lines above all entities.

css: Fix a typo in comment.

fec.c: Remove an unused #include.

The fec code does not need the helpers from portable_io.h.

Move public key to web/.

It's only needed for the web pages, so it should not be contained in the
top-level directory.

INSTALL: Remove installation instructions of lopsub.

These days, people should just install the Debian package. If lopsub is not
installed, the configure script prints detailed instructions about how to
obtain lopsub with and without apt.

http sender: Kill pointless macro.

The code is shorter and easier to read without the macro.

Introduce VSS_NEW_AUDIO_FILE to fix playlist updates.

The playlist event handler handles afsi change events by moving the affected
entry to the end of the playlist. This is the right thing to do if the
event was triggered by virtual streaming system streaming a new file. It is
incorrect, however, if the event was triggered by a subcommand such as touch.

This commit introduces the new afs event type VSS_NEW_AUDIO_FILE to distinguish
between the two different use cases. The audio file table event handler
ignores the VSS_NEW_AUDIO_FILE event while the playlist event handler ignores
the AFSI_CHANGE event. The moods event handler treats both events equally,

Get rid of a pointless static one-liner function in playlist.c while at it.

aft: Pass correct afsi argument to AFSI_CHANGE event handlers.

Each time a new audio file is opened for streaming, we update the numplayed
and lastplayed fields of its afs info entry of the audio file table, then
update the global afsi and ahfi structures, then trigger an AFSI_CHANGE event,
which calls all table event handlers. The event handlers receive as arguments
a pointer to the old afsi and a pointer to the already modified aft row.

The AFSI_CHANGE event handler of the audio file table gets called in the
situation described above, and also via the touch and cpsi subcommands,
because these also change the afsi info structure and therefore trigger
AFSI_CHANGE events as well. The handler checks whether the affected audio
file is the current audio file, and if it is, extracts the modified afsi
from the audio file table into the global afsi structure.

The problem is that in case of the above "next audio file" scenario, the
old afsi pointer points to the global afsi structure, which gets updated
by the aft event handler. Therefore the event handlers which happen to run
after the event handler of the audio file table see the already updated afsi
through the old_afsi pointer.

Since the audio file table happens to be the first table of the 7-element
afs_tables[] array iterated by afs_event(), all six other event handlers see
the incorrect afsi. However, only the moods event handler looks at the old afsi
to update the mean and quadratic variation of the lastplayed and numplayed
values of the afs statistics. Due to the bug described above, the old and
new lastplayed and numplayed values coincide, and therefore the statistics
update is a no-op. In practice, at least for moods with many admissible files,
the values will only be slightly off, so the bug is rather benign.

Fix this by renaming the on-stack new_afsi to old_afsi, adjusting
initializations accordingly, and passing a pointer to this instance instead.

Improve documentation of set_max_chunk_size().

The old text implied that the function could be removed at some point, which
is not the case. Remove this part of the documentation and clarify what the
function actually does.

Warn about old (0.5.x or earlier) on-disk afhi.

Nine years ago, starting with commit 234647bb5, old on-disk entries are
reported with a notice to re-add the file in order to update the audio file
table. Bump the loglevel for now, and add a comment to turn the check into
a hard error eventually.

doxyen: Completely suppress brief descriptions.

This shortens the doxygen pages, removing lots of pointless duplications.

buffer_tree: Assert that we don't pass NULL to memcpy().

The buffer pointer cannot be NULL here because this only happens when the
buffer tree area is full, which is not the case thanks to the previous n <=
btr_pool_unused(btrp) check.

mp.c: Remove a dead store.

Found by the clang analyzer.

wmadec: Fix typo in comment.

wmadec: Remove a stale comment in wma_init().

Noise coding has been removed.

Fixes: 9fe8a674535a00c6011f86b4ece3344200d00aa2

mood.c: Remove a dead store and fix the documentation of mood_load().

The function returns 1 on success, not the number of admissible files.

Found by the clang analyzer.

flac_afh: Check for possible integer overflows.

This is a callback function which should carefully check its inputs.

gcc-compat.h: Drop inline #define.

There is no reason to believe that the programmer does a better job than
the compiler here.

wmadec: Kill pointless start/end computations.

Neither start nor end are used. The loop simply adds up the entries of one
line of the exponent_bands matrix.

Found by the clang analyzer.

play.c: Kill pointless typedef.

The signature of the function pointer is too simple to warrant a typedef.

afs.h: Omit superfluous semicolons.

The DECLARE_BLOB_SYMBOLS macro expands to a bunch of declarations, each of
which is terminated by a semicolon. So don't add another one.

Makefile: Drop redundant -Wuninitialized.

It is implied by -Wextra, which is the same as -W, but more descriptive.

Merge topic branch t/build into master

A medium sized series for the build system which improves the way the git
version string is stored in the executables and man pages. Subsequent patches
of the series remove some warts from the makefile: we no longer use order-only
dependencies and the .PRECIOUS target.

The merge results in a conflict against the "remove regex include" commit
67388cd4fae0. This is trivial to resolve, though.

* refs/heads/t/build:
  Doxify version functions.
  Doxify OV_EXCLUDE_STATIC_CALLBACKS #define.
  Makefile: Fix braino in tarball target.
  build: Remove superfluous dependency in Makefile.real.
  build: Remove the .PRECIOUS target.
  build: Improve clean targets.
  build: Get rid of directory order-only dependencies.
  build: Compile with -Wunused -Wall also on BSD.
  build: Revamp git versioning.
  build: Merge version.{c,h} into string.{c,h}.

Include regex.h from para.h.

Every .c file includes it anyway.

doxygen: Don't show includes.

They use a lot of space and don't help much to understand the API or code.

load_afd(): Double check shared memory sizes.

The shared memory ID is sent by a trusted source, so it is a programming error
(rather than a runtime error that could be handled) if the size of the shared
memory area is smaller than the size of an audio file data structure. Thus,
the right thing to do is to abort immediately in this case.

about: Mention that paraslash works without internet access.

It's a noteworthy feature if software works without relying on third-party
internet services.

mp3_afh: Kill FOR_EACH_FIELD().

The macro has only one user. Open-code it to shorten the code and improve
readability.

mp3_afh: Document id3_field_init() and id3_field_finish().

These functions are somewhat obscure because they are not part of the
libid3tag API. They are not part of the internal paraslash API either,
so their documentation should not be shown on the API page. Exclude the
documentation with the doxygen \cond and \endcond markers.

aft.c: Remove unused enum touch_flags.

This enum became unused ten years ago when the touch command learned to use
the lopsub library.

Fixes: fdf416e9af730a1df9eec8d7acb108d7ca881926

server: Add missing non-opts name to help text.

blob: Get rid of the two dummy event handlers.

The four blob operation structures defined in blob.c are created by
a macro which initializes the function pointer for the event handler
to ${name}_event_handler, where $name is the blob type, i.e. one of
images, lyrics, moods, playlists.

Only two of the four, moods and playlists, need an event handler
because the images and lyrics tables ignore events. Currently we
have to define dummy functions {images,lyrics}_event_handler() to
avoid link errors. This extra code can easily be avoided by making
the macros a little smarter.

Check return value of lsu_com_help().

This function fails if an invalid command name is passed as the argument, yet
all callers ignore the error. Modify the callers to print the strerror text as
appropriate and no longer do that in lsu_lopsub_error(). Rename this function
and introduce the error type argument to print more meaningful error messages.

One visible consequence is that

para_client help does-not-exist

used to succeed while it now exits with status 1.

afs.c: Improve documentation.

Add an overview of the file and expand the description of
open_next_audio_file() and afs_init().

wmadec: Remove noise coding.

It is not used anyway in most cases, and it complicates the code
considerably.

wmadec: Simplify wma_init().

This equivalent transformation saves a few lines and one level of
indentation.

wmadec: Remove fft().

It has only one caller, imdct_half(), so get rid of the trivial
function. Dedox the static imdct_half() while at it.

client: Fix completion for the select subcommand.

We missed to complete the -v option that was added recently.

Fixes: 1f31fcdd74ab1aab01cbc70942f9d69bb779156a

i9e: Rename i9e_completer() -> attempt_completion().

The old name is confusing since we also have struct i9e_completer,
which is a completely different beast. Rewrite the documentation
of the function while at it.

i9e: Improve documentation of i9e_completion_info().

Emphasize that ->word is *not* the same as ->argv[i], where i is the index of
the current word.

com_select(): Support '-' to reactivate the previous mood/playlist.

This adds two static global variables to afs.c which track the
previously active mood or playlist. The select subcommand now makes
use of this information if the argument is the special string '-'. The
subcommand then follows common Unix conventions and reactivates the
previous mood or playlist.

Add missing newline in mp_init() error string.

Because callers expect this. Also print the message to the server log.

com_check(): Report inconsistencies consistently.

Currently the various checkers report the inconsistencies they detect
in one of the osl tables to either stdout via the pbout para_buffer
or to stderr by calling afs_error(), Unify this by replacing all
calls to afs_error().

aft: Simplify print_list_item().

The function performs no cleanup, so we don't need to jump to "out"
just to return ret.

vss_init(): Adjust loglevel.

These messages are not that interesting, so decrease their log level
by one.

manual: s/pipe/socket in the section on AFS.

The AFS process passes an open file descriptor to the server process,
which is only possible with sockets but not with pipes.

base64: Document PAD64.

This fixes another warning when doxygen is run with EXTRACT_ALL=NO.

Doxify version functions.

The two auto-generated public functions come undoxified, so document
their declarations in string.h.

Fixes: 69bace22205b4bb01673f7c9873f57a43bd6a0f7

Doxify OV_EXCLUDE_STATIC_CALLBACKS #define.

That's useful information that should make it into the generated web
pages.

Makefile: Fix braino in tarball target.

$(RM) implies -f, but not -r.

Fixes: 35a7569b2a7c66e40246aeaa135224f469584209

build: Remove superfluous dependency in Makefile.real.

This dependency is also covered by the CC_PREREQUISITES variable.

build: Remove the .PRECIOUS target.

Instruct make(1) to never remove any intermediate files by defining
.SECONDARY. This way we don't need to maintain the list of precious
targets.

build: Improve clean targets.

In a "fresh build" (e.g. after a make clean) we create the .d and the
.o file in one go to speed up this common case. However, if one runs
"make clean" followed by e.g. "make para_audioc", this will create
*all* object and dependency files, not just the ones needed to build
para_audioc. This behaviour is unfortunate because most dependencies
are irrelevant for a single target, and even the few which do matter
are ignored as well in this case because the object file does not
exist and needs to be recreated anyway,

Work around this shortcoming by shuffling the commands of the four
rules a little so that the clean target only removes object files
but keeps the dependency files.

Also remove the calls to SAY in the recipe of the clean targets because
with the rm commands spelled out it is clear what is being removed.

build: Get rid of directory order-only dependencies.

They only clutter the Makefile for no good reason. Just create all
build directories beforehand when running ./version-gen.sh.

One order-only dependency remains: We want to invoke the compiler
only after all generated .h files have been created. Otherwise the
.d files may be created incorrectly.

build: Compile with -Wunused -Wall also on BSD.

The new #define in oggdec_filter.c gets rid of the warnings such as

'OV_CALLBACKS_STREAMONLY_NOCLOSE' defined but not used [-Wunused-variable]

on NetBSD. With the patch applied, the code still compiles without
warnings. Tested on Linux, FreeBSD and NetBSD.

build: Revamp git versioning.

This rewrites GIT-VERSION-GEN and renames it to version-gen.sh. The
main difference is that the script now generates version.c rather
than version.h, speeding up the build because switching branches
or transitioning from a clean to a dirty work-tree (or vice versa)
changes the version string. Before the patch, all files which included
version.h were recompiled. With the patch applied, only the short
version.c needs to be recompiled.

The generated version,c defines one function which returns the
single-line version string and a second function which returns
the multi-line version information (author, copyright, git URL
etc). This information is now passed to version-gen.sh via environment
variables. The CPP macros we had before are removed.

build: Merge version.{c,h} into string.{c,h}.

This is a preparatory patch for the upcoming revamp of the git
version script. The revamped script generates version.c, a file
which is currently tracked by git. We can easily get rid of it (and
of version.h) since all paraslash executables link in both string.o
and version.o. So let's move the three small functions of version.c
to string.c and their declarations from version.h to string.h.

Teach the mood parser to not leak on errors.

Attempting to load an incomplete mood definition such as "1 &&"
currently causes memory leaks because the memory for the partial
syntax tree is never freed.

Employ bison's %destructor directive to call mp_free_ast() whenever
a syntax error happens.

mp.y: Fix some trivialities.

Some lines were indented with spaces rather than tabs, and the file
contained a few stray semicolons with no effect.