Fix some gcc warnings on x86_64.
[paraslash.git] / fecdec_filter.c
index 721fc09443011c7bfcc53e2f655f171e9cef3d8c..499c0a88931d1712bff7c3b57fef5fa75c075be8 100644 (file)
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file fecdev_filter.c A filter fec-decodes an audio stream. */
+/** \file fecdec_filter.c A filter fec-decodes an audio stream. */
 
 #include <dirent.h>
 #include "para.h"
 #include "fec.h"
 #include "fd.h"
 
+/**
+ * How many FEC groups to store in memory.
+ *
+ * Packet reordering requires to keep more than one FEC group in memory because
+ * slices belonging to the next FEC group may arrive before the current FEC group
+ * is complete.
+ */
 #define NUM_FEC_GROUPS 3
-#define INPUT_BUFFER_SIZE 16384
 
-/** size of the output buffer */
-#define FECDEC_OUTBUF_SIZE 81920
+/** Size of the output buffer of the fecdec filter. */
+#define FECDEC_OUTBUF_SIZE (128 * 1024)
 
+/** Data read from the header of a slice. */
 struct fec_header {
+       /** Total number of slices in this group. */
        uint8_t slices_per_group;
+       /** Number of slices needed to start decoding. */
        uint8_t data_slices_per_group;
+       /** Size of the ogg vorbis header (zero for mp3, aac). */
        uint32_t audio_header_size;
-
+       /** Number of the FEC group this slice belongs to. */
        uint32_t group_num;
+       /** Size of the data in this FEC group. */
        uint32_t group_bytes;
-
+       /** Number of this slice in the group. */
        uint8_t slice_num;
+       /** Used data bytes of this slice. */
        uint16_t slice_bytes;
 };
 
-struct fec_group {
+/**
+ * The status of one partially received FEC group.
+ */
+struct fecdec_group {
+       /** The header read from the last slice. */
        struct fec_header h;
+       /** How many slices received so far. */
        int num_received_slices;
+       /** The size of the \a idx and the \a data arrays below. */
        int num_slices;
+       /** Array of indices of the received slices. */
        int *idx;
+       /** Content of the received slices. */
        unsigned char **data;
 };
 
+/**
+ * Data private to the fecdec filter.
+ */
 struct private_fecdec_data {
+       /** Used by the fec core code. */
        struct fec_parms *fec;
-       struct fec_group groups[NUM_FEC_GROUPS];
+       /** Keeps track of what was received so far. */
+       struct fecdec_group groups[NUM_FEC_GROUPS];
 };
 
-#define FOR_EACH_FEC_GROUP(g, d) for (g = (d)->groups; \
+/** Iterate over all fecdec groups. */
+#define FOR_EACH_FECDEC_GROUP(g, d) for (g = (d)->groups; \
        (g) - (d)->groups < NUM_FEC_GROUPS; (g)++)
 
-#define UNUSED_GROUP_NUM 0xffffffff
-
-static int group_complete(struct fec_group *fg)
+static int group_complete(struct fecdec_group *fg)
 {
-       if (fg->h.group_num == UNUSED_GROUP_NUM)
-               return 0;
-       //PARA_INFO_LOG("received slices: %u, slices per group: %u\n", fg->num_received_slices, fg->h.data_slices_per_group);
        return fg->num_received_slices >= fg->h.data_slices_per_group;
 }
 
-static int group_empty(struct fec_group *fg)
+static int group_empty(struct fecdec_group *fg)
 {
        return fg->num_received_slices == 0;
 }
 
-static void clear_group(struct fec_group *fg)
+static void clear_group(struct fecdec_group *fg)
 {
        int i;
 
-       if (!group_complete(fg) && !group_empty(fg))
-               PARA_WARNING_LOG("Clearing incomplete group %d "
-                       "(contains %d slices)\n", fg->h.group_num,
-                       fg->num_received_slices);
        for (i = 0; i < fg->num_slices; i++) {
                free(fg->data[i]);
                fg->data[i] = NULL;
@@ -85,39 +102,42 @@ static void clear_group(struct fec_group *fg)
        fg->num_slices = 0;
        memset(&fg->h, 0, sizeof(struct fec_header));
        fg->num_received_slices = 0;
-       fg->h.group_num = UNUSED_GROUP_NUM;
 }
 
 static int find_group(struct fec_header *h,
-               struct private_fecdec_data *pfd, struct fec_group **result)
+               struct private_fecdec_data *pfd, struct fecdec_group **result)
 {
-       struct fec_group *fg;
+       struct fecdec_group *fg;
 
-       FOR_EACH_FEC_GROUP(fg, pfd) {
+       FOR_EACH_FECDEC_GROUP(fg, pfd) {
                if (fg->h.group_num != h->group_num)
                        continue;
+               if (fg->h.slices_per_group != h->slices_per_group)
+                       continue;
+               if (fg->h.data_slices_per_group != h->data_slices_per_group)
+                       continue;
                *result = fg;
                return 1;
        }
        return 0;
 }
 
-static struct fec_group *find_unused_group(struct private_fecdec_data *pfd)
+static struct fecdec_group *find_unused_group(struct private_fecdec_data *pfd)
 {
-       struct fec_group *fg;
+       struct fecdec_group *fg;
 
-       FOR_EACH_FEC_GROUP(fg, pfd) {
+       FOR_EACH_FECDEC_GROUP(fg, pfd) {
                if (fg->num_received_slices == 0)
                        return fg;
        }
        return NULL;
 }
 
-static struct fec_group *try_to_free_group(struct private_fecdec_data *pfd)
+static struct fecdec_group *try_to_free_group(struct private_fecdec_data *pfd)
 {
-       struct fec_group *fg;
+       struct fecdec_group *fg;
 
-       FOR_EACH_FEC_GROUP(fg, pfd) {
+       FOR_EACH_FECDEC_GROUP(fg, pfd) {
                if (!group_complete(fg))
                        continue;
                clear_group(fg);
@@ -126,22 +146,27 @@ static struct fec_group *try_to_free_group(struct private_fecdec_data *pfd)
        return NULL;
 }
 
-static struct fec_group *free_oldest_group(struct private_fecdec_data *pfd)
+static struct fecdec_group *free_oldest_group(struct private_fecdec_data *pfd)
 {
-       struct fec_group *fg, *oldest = NULL;
+       struct fecdec_group *fg, *oldest = NULL;
 
-       FOR_EACH_FEC_GROUP(fg, pfd) {
+       FOR_EACH_FECDEC_GROUP(fg, pfd) {
                if (!oldest || oldest->h.group_num > fg->h.group_num)
                        oldest = fg;
        }
+       if (!group_complete(oldest) && !group_empty(oldest))
+               PARA_WARNING_LOG("Clearing incomplete group %d "
+                       "(contains %d slices)\n", fg->h.group_num,
+                       fg->num_received_slices);
        clear_group(oldest);
        return oldest;
 }
 
+/* returns 1 if the group was found, 0 if not, negative on errors */
 static int get_group(struct fec_header *h, struct private_fecdec_data *pfd,
-               struct fec_group **result)
+               struct fecdec_group **result)
 {
-       struct fec_group *fg;
+       struct fecdec_group *fg;
        int ret = find_group(h, pfd, &fg);
 
        if (ret < 0)
@@ -151,24 +176,33 @@ static int get_group(struct fec_header *h, struct private_fecdec_data *pfd,
        /* group not found */
        fg = find_unused_group(pfd);
        if (fg)
-               goto update_header;
+               goto success;
        fg = try_to_free_group(pfd);
        if (fg)
-               goto update_header;
+               goto success;
        fg = free_oldest_group(pfd);
-update_header:
-       fg->h = *h;
+       ret = 0;
 success:
+       fg->h = *h;
        *result = fg;
-       return 1;
+       return ret;
 }
 
-static int add_slice(char *buf, struct fec_group *fg)
+/*
+ * returns 1 if slice was added, zero otherwise (because the group was already
+ * complete). In any case the number of received slices is being increased by
+ * one.
+ */
+static int add_slice(char *buf, struct fecdec_group *fg)
 {
        int r, slice_num;
 
-       if (group_complete(fg))
+       if (group_complete(fg)) {
+               PARA_DEBUG_LOG("group complete, ignoring slice %d\n",
+                       fg->h.slice_num);
+               fg->num_received_slices++;
                return 0;
+       }
        slice_num = fg->h.slice_num;
        if (fg->num_slices == 0) {
                fg->num_slices = fg->h.slices_per_group;
@@ -184,7 +218,7 @@ static int add_slice(char *buf, struct fec_group *fg)
        return 1;
 }
 
-static int decode_group(struct fec_group *fg, struct filter_node *fn)
+static int decode_group(struct fecdec_group *fg, struct filter_node *fn)
 {
        int i, ret, sb = fg->h.slice_bytes;
        size_t written = 0;
@@ -240,10 +274,11 @@ static int read_fec_header(char *buf, size_t len, struct fec_header *h)
        return 1;
 }
 
+/* returns 1 if we used the buffer, 0 if we didn't, negative on errors */
 static int dispatch_slice(char *buf, size_t len, struct fec_header *h,
                struct filter_node *fn)
 {
-       struct fec_group *fg;
+       struct fecdec_group *fg;
        int ret;
        struct private_fecdec_data *pfd = fn->private_data;
 
@@ -252,15 +287,8 @@ static int dispatch_slice(char *buf, size_t len, struct fec_header *h,
        ret = get_group(h, pfd, &fg);
        if (ret < 0)
                return ret;
-       if (group_complete(fg)) {
-               PARA_DEBUG_LOG("group complete, ignoring slice %d\n",
-                       h->slice_num);
+       if (!add_slice(buf, fg))
                return 1;
-       }
-       fg->h = *h;
-       ret = add_slice(buf, fg);
-       if (ret < 0)
-               return ret;
        if (group_complete(fg)) {
                if (!pfd->fec) {
                        int k = h->data_slices_per_group, n = h->slices_per_group;
@@ -276,7 +304,7 @@ static int dispatch_slice(char *buf, size_t len, struct fec_header *h,
        return 1;
 }
 
-static int fecdec(char *buf, size_t len, struct filter_node *fn)
+static ssize_t fecdec(char *buf, size_t len, struct filter_node *fn)
 {
        int ret;
        struct fec_header h;
@@ -284,7 +312,7 @@ static int fecdec(char *buf, size_t len, struct filter_node *fn)
        ret = read_fec_header(buf, len, &h);
        if (ret <= 0)
                return ret;
-       if (h.slice_bytes > INPUT_BUFFER_SIZE)
+       if (h.slice_bytes > fn->bufsize)
                return -E_BAD_SLICE_SIZE;
        if (h.slice_num > h.slices_per_group)
                return -E_BAD_SLICE_NUM;
@@ -299,9 +327,9 @@ static int fecdec(char *buf, size_t len, struct filter_node *fn)
 static void fecdec_close(struct filter_node *fn)
 {
        struct private_fecdec_data *pfd = fn->private_data;
-       struct fec_group *fg;
+       struct fecdec_group *fg;
 
-       FOR_EACH_FEC_GROUP(fg, pfd)
+       FOR_EACH_FECDEC_GROUP(fg, pfd)
                clear_group(fg);
        free(fn->buf);
        fn->buf = NULL;