paraslash/filter.h, branch master

Switch to SPDX identifiers.

2026-03-17T22:45:43Z

Generated with sed -i 's|Copyright.*Andre Noll.*|SPDX-License-Identifier: GPL-2.0 */|g' *.c *.h followed by manually tweaking the result a bit. No license change intended.

Improve filter documentation.

2025-10-08T18:58:23Z

This extends the top level doxygen comments of filter.c and filter.h and the documentation of para_filter(1)'s main function. The new text outlines how filters in general and para_filter(1) in particular set up their buffer tree nodes and register the corresponding tasks. We re-order the function declarations of filter.h so that they are grouped together. The previously undocumented write_int16_host_endian() is doxified using the _static_inline_ macro to prevent doxygen from excluding the documentation. On the other hand, most comments of filter.c are dedoxified, so that only the top level file comment and the documentation of the main function make it into the web docs. Everything else is too special to be useful there.

Make struct sched private, introduce sched_new().

2025-07-13T14:38:46Z

This moves the declaration of the structure from sched.h to sched.c because the information stored in this structure has almost no users outside of the scheduler core. As a result, the size of the structure is no longer known outside of sched.c. To initialize a scheduler instance, users now must call the new sched_new(), passing an alternative poll function if needed, We don't let applications set the default timeout anymore because the value is kind of arbitrary anyway and most users specified one second. So hardcode this as the default. Besides allocating the scheduler structure, sched_new() also initializes the task list and the poll function pointer. Thanks to these initializations, the two conditions of sched.c removed in this patch are never true.

Rename ->{pre,post}_select methods to ->{pre,post}_monitor.

2022-08-25T13:37:26Z

The word "monitor" is neutral and continues to be correct after the switch from select(2) to poll(2). Pure rename, nothing to see here.

Consolidate receiver/filter/writer {pre,post}_select() docs.

2022-08-25T13:37:26Z

The documentation of these three ->pre_select() and ->post_select() methods overlapped quite a bit. Some comments stated general properties of the sched API which fit better in the documentation of sched.h, so move these bits there. Improve the text a bit while at it and avoid talking about select(2) and fd sets as these are implementation details. Instead, focus on the general concept of fd monitoring. Pure comment cleanups, no code changes.

Shorten copyright notice.

2017-09-22T14:35:22Z

The GPLv2 line does not add any additional information, so drop it. This leaves a single line of legalese text for most files, which is about the amount of screen real estate it deserves. This patch was created with the following script (plus some manual fixups): awk '{ if (NR <= 5) { gs = gensub(/.*Copyright.* ([0-9]+).*Andre Noll.*/, "\\1", "g") if (gs != $0) year = gs next } if (NR == 6 && year != "") printf("/* Copyright (C) %s Andre Noll , see file COPYING. */\n", year) print }'

filter: Remove duplicate documentation of filter_get().

2017-06-25T18:11:09Z

This public function is documented both in filter.h and in filter_common.c. Get rid of the comment in the header file as this is incomplete and causes a doxygen warning.

doxygen: Add \ref to references.

2017-06-25T18:11:08Z

This way doxygen issues a warning if the file/function/structure no longer exists and a stale reference remains.

Convert para_filter to lopsub.

2017-03-26T09:02:28Z

Changes the semantics in case --filter is not given. We used to print an error, but it makes more sense to show the list of supported filters in this case. If no filters are given, we now print the list of available filters. A new function in filter_common.c, print_filter_list(), is introduced for this purpose. The manual page of para_filter has been extended to include an overall description of the command. The only error code of filter.c, E_NO_FILTERS, becomes unused and is removed.

make converter_arg in resamplefilter an enum option

2017-03-26T09:02:28Z