afh: Expand documentation of init function declarations.

[paraslash.git] / afh_common.c

diff --git a/afh_common.c b/afh_common.c
index a1021ee57a2fd67f0192a8049cfa512ecd5629d3..0d8d905c4a9c764097fa6e7acf6023c50454f958 100644 (file)
--- a/afh_common.c
+++ b/afh_common.c
@@ -16,7 +16,16 @@
 #include "afh.h"
 
 typedef void afh_init_func(struct audio_format_handler *);
-/* It does not hurt to declare init functions which are not available. */
+/*
+ * Declaration of the audio format handler init functions.
+ *
+ * These symbols are referenced in the afl array below.
+ *
+ * Most audio format handlers depend on an external library and are not
+ * compiled in if the library is not installed. Hence it is well possible that
+ * not all of these functions are defined. It does not hurt to declare them
+ * anyway, and this avoids another set of ifdefs.
+ */
 extern afh_init_func mp3_init, ogg_init, aac_afh_init, wma_afh_init,
        spx_afh_init, flac_afh_init, opus_afh_init;
 
@@ -48,7 +57,7 @@ static struct audio_format_handler afl[] = {
        },
        {
                .name = "aac",
-#if defined(HAVE_MP4V2)
+#if defined(HAVE_FAAD)
                .init = aac_afh_init,
 #endif
        },
@@ -88,7 +97,6 @@ static inline int next_audio_format(int format)
                if (afl[format].init)
                        return format;
        }
-
 }
 
 /** Iterate over each supported audio format. */
@@ -109,7 +117,18 @@ void afh_init(void)
        }
 }
 
-static bool afh_supports_dynamic_chunks(int audio_format_id)
+/**
+ * Tell whether an audio format handler provides chunk tables.
+ *
+ * Each audio format handler either provides a chunk table or supports dynamic
+ * chunks.
+ *
+ * \param audio_format_id Offset in the afl array.
+ *
+ * \return True if dynamic chunks are supported, false if the audio format
+ * handler provides chunk tables.
+ */
+bool afh_supports_dynamic_chunks(int audio_format_id)
 {
        return afl[audio_format_id].get_chunk;
 }