Add missing description of struct coef_vlc_table.

[paraslash.git] / fecdec_filter.c

diff --git a/fecdec_filter.c b/fecdec_filter.c
index 8cb17ad642098e81621e2be6f6c0643ac6de4038..ca7c7dd3522eae673469baee46e7a7471e7fac72 100644 (file)
--- a/fecdec_filter.c
+++ b/fecdec_filter.c
@@ -6,6 +6,8 @@
 
 /** \file fecdec_filter.c A filter that fec-decodes an audio stream. */
 
+#include <regex.h>
+
 #include <dirent.h>
 #include "para.h"
 #include "error.h"
@@ -243,10 +245,21 @@ static int add_slice(char *buf, struct fecdec_group *fg)
        return 1;
 }
 
+/**
+ * The different states of a complete FEC group.
+ *
+ * Even if a FEC group has been received successfully, it probably can not be
+ * used right away because some streams (ogg, wma) need to receive an audio
+ * file header before decoding can start.
+ */
 enum fec_group_usability {
+       /** Drop the group (because we did not receive the header yet). */
        FEC_GROUP_UNUSABLE,
+       /** Use all data in the group. */
        FEC_GROUP_USABLE,
+       /** Use the group, but drop its audio file header. */
        FEC_GROUP_USABLE_SKIP_HEADER,
+       /** Use the group, including its header. */
        FEC_GROUP_USABLE_WITH_HEADER
 };