]> git.tuebingen.mpg.de Git - paraslash.git/commitdiff
afh
authorAndre Noll <maan@tuebingen.mpg.de>
Sun, 8 Jun 2025 21:09:46 +0000 (23:09 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Tue, 10 Jun 2025 14:04:43 +0000 (16:04 +0200)
afh.h

diff --git a/afh.h b/afh.h
index 1ce7fb21994ce4a9b67bdccccae9451f238a7127..21353570f6003b145241fdbc460ee44884dd5149 100644 (file)
--- a/afh.h
+++ b/afh.h
@@ -3,20 +3,20 @@
 /** \file afh.h Audio format handlers
  *
  * The mission of an audio format handler is to tell whether a given file
- * is an audio file of a certain type. The core of the API is the \ref
- * audio_format_handler structure whose methods are called when an audio
- * file is added to the database of para_server(1). Also the virtual
- * streaming system calls the functions here to stream a file.
+ * is an audio file of a certain type. The central data structure of the
+ * API is struct \ref audio_format_handler whose methods are called when an
+ * audio file is added to the database of para_server(1). Also the virtual
+ * streaming system calls the functions declared here.
  *
- * More precisely, each time a file is added, the \ref
- * audio_format_handler::get_file_info() method is called to initialize an \ref
- * afh_info structure which contains all information needed for streaming,
- * including the metadata tags. A serialized version of this structure is
- * stored in the audio file table and referenced when the file is streamed.
+ * When an audio file is added, the \ref audio_format_handler::get_file_info()
+ * method is called to initialize an \ref afh_info structure which contains
+ * all information needed for streaming, including the metadata tags. A
+ * serialized version of this structure is stored in the audio file table
+ * and referenced when the file is opened for streaming.
  *
  * Each audio format handler is implemented in a dedicated .c file. For
  * example, the audio format handler for the mp3 format is \ref mp3_afh.c. All
- * helper functions decribed here are implemented in \ref afh_common.c, which
+ * helper functions declared here are implemented in \ref afh_common.c, which
  * also defines the array of audio format handlers known to para_server(1),
  * para_afh(1) and para_recv(1).
  */