]> git.tuebingen.mpg.de Git - paraslash.git/blob - fecdec_filter.c
5c01a0395e79139a0bbd09633f127b06321d5268
[paraslash.git] / fecdec_filter.c
1 /*
2  * Copyright (C) 2009 Andre Noll <maan@systemlinux.org>
3  *
4  * Licensed under the GPL v2. For licencing details see COPYING.
5  */
6
7 /** \file fecdec_filter.c A filter fec-decodes an audio stream. */
8
9 #include <dirent.h>
10 #include "para.h"
11 #include "error.h"
12 #include "list.h"
13 #include "sched.h"
14 #include "ggo.h"
15 #include "filter.h"
16 #include "string.h"
17 #include "portable_io.h"
18 #include "fec.h"
19 #include "fd.h"
20
21 /**
22  * How many FEC groups to store in memory.
23  *
24  * Packet reordering requires to keep more than one FEC group in memory because
25  * slices belonging to the next FEC group may arrive before the current FEC group
26  * is complete.
27  */
28 #define NUM_FEC_GROUPS 3
29
30 /** Size of the output buffer of the fecdec filter. */
31 #define FECDEC_OUTBUF_SIZE (128 * 1024)
32
33 /** Data read from the header of a slice. */
34 struct fec_header {
35         /** Total number of slices in this group. */
36         uint8_t slices_per_group;
37         /** Number of slices needed to start decoding. */
38         uint8_t data_slices_per_group;
39         /** Size of the ogg vorbis header (zero for mp3, aac). */
40         uint32_t audio_header_size;
41         /** Number of the FEC group this slice belongs to. */
42         uint32_t group_num;
43         /** Size of the data in this FEC group. */
44         uint32_t group_bytes;
45         /** Number of this slice in the group. */
46         uint8_t slice_num;
47         /** Used data bytes of this slice. */
48         uint16_t slice_bytes;
49 };
50
51 /**
52  * The status of one partially received FEC group.
53  */
54 struct fecdec_group {
55         /** The header read from the last slice. */
56         struct fec_header h;
57         /** How many slices received so far. */
58         int num_received_slices;
59         /** The size of the \a idx and the \a data arrays below. */
60         int num_slices;
61         /** Array of indices of the received slices. */
62         int *idx;
63         /** Content of the received slices. */
64         unsigned char **data;
65 };
66
67 /**
68  * Data private to the fecdec filter.
69  */
70 struct private_fecdec_data {
71         /** Used by the fec core code. */
72         struct fec_parms *fec;
73         /** Keeps track of what was received so far. */
74         struct fecdec_group groups[NUM_FEC_GROUPS];
75 };
76
77 /** Iterate over all fecdec groups. */
78 #define FOR_EACH_FECDEC_GROUP(g, d) for (g = (d)->groups; \
79         (g) - (d)->groups < NUM_FEC_GROUPS; (g)++)
80
81 static int group_complete(struct fecdec_group *fg)
82 {
83         return fg->num_received_slices >= fg->h.data_slices_per_group;
84 }
85
86 static int group_empty(struct fecdec_group *fg)
87 {
88         return fg->num_received_slices == 0;
89 }
90
91 static void clear_group(struct fecdec_group *fg)
92 {
93         int i;
94
95         for (i = 0; i < fg->num_slices; i++) {
96                 free(fg->data[i]);
97                 fg->data[i] = NULL;
98                 fg->idx[i] = -1;
99         }
100         free(fg->data);
101         free(fg->idx);
102         fg->num_slices = 0;
103         memset(&fg->h, 0, sizeof(struct fec_header));
104         fg->num_received_slices = 0;
105 }
106
107 static int find_group(struct fec_header *h,
108                 struct private_fecdec_data *pfd, struct fecdec_group **result)
109 {
110         struct fecdec_group *fg;
111
112         FOR_EACH_FECDEC_GROUP(fg, pfd) {
113                 if (fg->h.group_num != h->group_num)
114                         continue;
115                 if (fg->h.slices_per_group != h->slices_per_group)
116                         continue;
117                 if (fg->h.data_slices_per_group != h->data_slices_per_group)
118                         continue;
119                 *result = fg;
120                 return 1;
121         }
122         return 0;
123 }
124
125 static struct fecdec_group *find_unused_group(struct private_fecdec_data *pfd)
126 {
127         struct fecdec_group *fg;
128
129         FOR_EACH_FECDEC_GROUP(fg, pfd) {
130                 if (fg->num_received_slices == 0)
131                         return fg;
132         }
133         return NULL;
134 }
135
136 static struct fecdec_group *try_to_free_group(struct private_fecdec_data *pfd)
137 {
138         struct fecdec_group *fg;
139
140         FOR_EACH_FECDEC_GROUP(fg, pfd) {
141                 if (!group_complete(fg))
142                         continue;
143                 clear_group(fg);
144                 return fg;
145         }
146         return NULL;
147 }
148
149 static struct fecdec_group *free_oldest_group(struct private_fecdec_data *pfd)
150 {
151         struct fecdec_group *fg, *oldest = NULL;
152
153         FOR_EACH_FECDEC_GROUP(fg, pfd) {
154                 if (!oldest || oldest->h.group_num > fg->h.group_num)
155                         oldest = fg;
156         }
157         if (!group_complete(oldest) && !group_empty(oldest))
158                 PARA_WARNING_LOG("Clearing incomplete group %d "
159                         "(contains %d slices)\n", fg->h.group_num,
160                         fg->num_received_slices);
161         clear_group(oldest);
162         return oldest;
163 }
164
165 static int get_group(struct fec_header *h, struct private_fecdec_data *pfd,
166                 struct fecdec_group **result)
167 {
168         struct fecdec_group *fg;
169         int ret = find_group(h, pfd, &fg);
170
171         if (ret < 0)
172                 return ret;
173         if (ret > 0) /* found group */
174                 goto success;
175         /* group not found */
176         fg = find_unused_group(pfd);
177         if (fg)
178                 goto success;
179         fg = try_to_free_group(pfd);
180         if (fg)
181                 goto success;
182         fg = free_oldest_group(pfd);
183 success:
184         fg->h = *h;
185         *result = fg;
186         return 1;
187 }
188
189 static int add_slice(char *buf, struct fecdec_group *fg)
190 {
191         int r, slice_num;
192
193         if (group_complete(fg))
194                 return 0;
195         slice_num = fg->h.slice_num;
196         if (fg->num_slices == 0) {
197                 fg->num_slices = fg->h.slices_per_group;
198                 fg->idx = malloc(fg->num_slices * sizeof(int));
199                 fg->data = malloc(fg->num_slices * sizeof(unsigned char *));
200                 memset(fg->data, 0, fg->num_slices * sizeof(unsigned char *));
201         }
202         r = fg->num_received_slices;
203         fg->idx[r] = slice_num;
204         fg->data[r] = malloc(fg->h.slice_bytes);
205         memcpy(fg->data[r], buf, fg->h.slice_bytes);
206         fg->num_received_slices++;
207         return 1;
208 }
209
210 static int decode_group(struct fecdec_group *fg, struct filter_node *fn)
211 {
212         int i, ret, sb = fg->h.slice_bytes;
213         size_t written = 0;
214         struct private_fecdec_data *pfd = fn->private_data;
215
216         ret = fec_decode(pfd->fec, fg->data, fg->idx, sb);
217         if (ret < 0)
218                 return ret;
219         PARA_DEBUG_LOG("writing group %d (%d/%d decoded data bytes)\n",
220                 fg->h.group_num, fg->h.group_bytes,
221                 fg->h.data_slices_per_group * sb);
222         for (i = 0; i < fg->h.data_slices_per_group; i++) {
223                 size_t n = sb;
224                 if (n + written > fg->h.group_bytes)
225                         n = fg->h.group_bytes - written;
226                 if (fn->loaded + n > fn->bufsize)
227                         return -E_FECDEC_OVERRUN;
228                 memcpy(fn->buf + fn->loaded, fg->data[i], n);
229                 fn->loaded += n;
230                 written += n;
231         }
232         return 0;
233 }
234
235 /**
236  * Read a fec header from a buffer.
237  *
238  * \param buf The buffer to write to.
239  * \param h The fec header to write.
240  */
241 static int read_fec_header(char *buf, size_t len, struct fec_header *h)
242 {
243         uint32_t magic;
244
245         if (len < FEC_HEADER_SIZE)
246                 return 0;
247         magic = read_u32(buf);
248         if (magic != FEC_MAGIC)
249                 return -E_BAD_FEC_HEADER;
250         h->slices_per_group = read_u8(buf + 4);
251         h->data_slices_per_group = read_u8(buf + 5);
252         h->audio_header_size = read_u32(buf + 6);
253
254         h->group_num = read_u32(buf + 10);
255         h->group_bytes = read_u32(buf + 14);
256
257         h->slice_num = read_u8(buf + 18);
258         h->slice_bytes = read_u16(buf + 20);
259         if (!h->group_bytes && & h->slice_bytes)
260                 return -E_FECDEC_EOF;
261 //      PARA_DEBUG_LOG("group %u, slize %u, slices per group: %u\n",
262 //              h->group_num, h->slice_num, h->slices_per_group);
263         return 1;
264 }
265
266 static int dispatch_slice(char *buf, size_t len, struct fec_header *h,
267                 struct filter_node *fn)
268 {
269         struct fecdec_group *fg;
270         int ret;
271         struct private_fecdec_data *pfd = fn->private_data;
272
273         if (h->slice_bytes > len) /* can not use the thing, try to read more */
274                 return 0;
275         ret = get_group(h, pfd, &fg);
276         if (ret < 0)
277                 return ret;
278         if (group_complete(fg)) {
279                 PARA_DEBUG_LOG("group complete, ignoring slice %d\n",
280                         h->slice_num);
281                 return 1;
282         }
283         ret = add_slice(buf, fg);
284         if (ret < 0)
285                 return ret;
286         if (group_complete(fg)) {
287                 if (!pfd->fec) {
288                         int k = h->data_slices_per_group, n = h->slices_per_group;
289                         PARA_NOTICE_LOG("init fec (%d, %d)\n", k, n);
290                         ret = fec_new(k, n, &pfd->fec);
291                         if (ret < 0)
292                                 return ret;
293                 }
294                 ret = decode_group(fg, fn);
295                 if (ret < 0)
296                         return ret;
297         }
298         return 1;
299 }
300
301 static int fecdec(char *buf, size_t len, struct filter_node *fn)
302 {
303         int ret;
304         struct fec_header h;
305
306         ret = read_fec_header(buf, len, &h);
307         if (ret <= 0)
308                 return ret;
309         if (h.slice_bytes > fn->bufsize)
310                 return -E_BAD_SLICE_SIZE;
311         if (h.slice_num > h.slices_per_group)
312                 return -E_BAD_SLICE_NUM;
313         ret = dispatch_slice(buf + FEC_HEADER_SIZE, len - FEC_HEADER_SIZE,
314                 &h, fn);
315         //PARA_INFO_LOG("ret: %d, len: %d, slice_bytes: %d\n", ret, len, h.slice_bytes);
316         if (ret <= 0)
317                 return ret;
318         return FEC_HEADER_SIZE + h.slice_bytes;
319 }
320
321 static void fecdec_close(struct filter_node *fn)
322 {
323         struct private_fecdec_data *pfd = fn->private_data;
324         struct fecdec_group *fg;
325
326         FOR_EACH_FECDEC_GROUP(fg, pfd)
327                 clear_group(fg);
328         free(fn->buf);
329         fn->buf = NULL;
330         free(fn->private_data);
331         fn->private_data = NULL;
332 }
333
334 static void fecdec_open(struct filter_node *fn)
335 {
336         fn->bufsize = FECDEC_OUTBUF_SIZE;
337         fn->buf = para_malloc(fn->bufsize);
338         fn->private_data = para_calloc(sizeof(struct private_fecdec_data));
339         fn->loaded = 0;
340 }
341
342 /**
343  * The init function of the fecdec filter.
344  *
345  * \param f struct to initialize.
346  */
347 void fecdec_filter_init(struct filter *f)
348 {
349         f->convert = fecdec;
350         f->close = fecdec_close;
351         f->open = fecdec_open;
352 }