2 * Copyright (C) 2009 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file fecdec_filter.c A filter that fec-decodes an audio stream. */
19 #include "portable_io.h"
24 * How many FEC groups to store in memory.
26 * Packet reordering requires to keep more than one FEC group in memory because
27 * slices belonging to the next FEC group may arrive before the current FEC group
30 #define NUM_FEC_GROUPS 3
32 /** Default size of the output buffer of the fecdec filter. */
33 #define FECDEC_DEFAULT_OUTBUF_SIZE (3 * 1024)
34 /** Maximal size of the output buffer of the fecdec filter. */
35 #define FECDEC_MAX_OUTBUF_SIZE (1024 * 1024)
37 /** Data read from the header of a slice. */
39 /** Total number of slices in this group. */
40 uint8_t slices_per_group;
41 /** Number of slices needed to start decoding. */
42 uint8_t data_slices_per_group;
43 /** Size of the ogg vorbis header (zero for mp3, aac). */
44 uint32_t audio_header_size;
45 /** Number of the FEC group this slice belongs to. */
47 /** Size of the data in this FEC group. */
49 /** Number of this slice in the group. */
51 /** Used data bytes of this slice. */
53 /** Non-zero if this group is the beginning of the stream. */
55 /** Non-zero if this stream embedds audio headers into fec groups. */
56 uint8_t header_stream;
60 * The status of one partially received FEC group.
63 /** The header read from the last slice. */
65 /** How many slices received so far. */
66 int num_received_slices;
67 /** The size of the \a idx and the \a data arrays below. */
69 /** Array of indices of the received slices. */
71 /** Content of the received slices. */
76 * The fecdec filter defers decoding of the first group until the first slice
77 * of the next group was received. This avoids buffer underruns in subsequent
78 * filters of the filter chain.
80 enum group_completion_status {
81 /** No complete group received so far. */
82 GCS_NO_COMPLETE_GROUP,
83 /** First group received, but not yet decoded. */
84 GCS_FIRST_GROUP_COMPLETE,
85 /** At least one complete group decoded. */
86 GCS_FIRST_GROUP_DECODED,
90 * Data private to the fecdec filter.
92 struct private_fecdec_data {
93 /** Used by the fec core code. */
94 struct fec_parms *fec;
95 /** Keeps track of what was received so far. */
96 struct fecdec_group groups[NUM_FEC_GROUPS];
97 /** Whether an audio file header was already received. */
99 /** See \ref group_completion_status. */
100 unsigned completion_status;
101 /** Points to the first received group. */
102 struct fecdec_group *first_complete_group;
105 /** Iterate over all fecdec groups. */
106 #define FOR_EACH_FECDEC_GROUP(g, d) for (g = (d)->groups; \
107 (g) < (d)->groups + NUM_FEC_GROUPS; (g)++)
109 static int group_complete(struct fecdec_group *fg)
111 return fg->num_received_slices >= fg->h.data_slices_per_group;
114 static int group_empty(struct fecdec_group *fg)
116 return fg->num_received_slices == 0;
119 static void clear_group(struct fecdec_group *fg)
123 for (i = 0; i < fg->num_slices; i++) {
131 memset(&fg->h, 0, sizeof(struct fec_header));
132 fg->num_received_slices = 0;
135 static int find_group(struct fec_header *h,
136 struct private_fecdec_data *pfd, struct fecdec_group **result)
138 struct fecdec_group *fg;
140 FOR_EACH_FECDEC_GROUP(fg, pfd) {
141 if (fg->h.group_num != h->group_num)
143 if (fg->num_received_slices == 0)
145 if (fg->h.slices_per_group != h->slices_per_group)
146 return -E_BAD_FEC_HEADER;
147 if (fg->h.data_slices_per_group != h->data_slices_per_group)
148 return -E_BAD_FEC_HEADER;
149 if (fg->h.group_bytes != h->group_bytes)
150 return -E_BAD_FEC_HEADER;
158 static struct fecdec_group *find_unused_group(struct private_fecdec_data *pfd)
160 struct fecdec_group *fg;
162 FOR_EACH_FECDEC_GROUP(fg, pfd) {
163 if (fg->num_received_slices == 0)
169 static struct fecdec_group *try_to_free_group(struct private_fecdec_data *pfd)
171 struct fecdec_group *fg;
173 FOR_EACH_FECDEC_GROUP(fg, pfd) {
174 if (!group_complete(fg))
177 * Don't clear the first complete group if it has not yet been
180 if (pfd->completion_status == GCS_FIRST_GROUP_COMPLETE
181 && pfd->first_complete_group == fg)
189 static struct fecdec_group *free_oldest_group(struct private_fecdec_data *pfd)
191 struct fecdec_group *fg, *oldest = NULL;
193 FOR_EACH_FECDEC_GROUP(fg, pfd) {
194 if (!oldest || oldest->h.group_num > fg->h.group_num)
197 if (!group_complete(oldest) && !group_empty(oldest))
198 PARA_WARNING_LOG("Clearing incomplete group %d "
199 "(contains %d slices)\n", oldest->h.group_num,
200 oldest->num_received_slices);
201 assert(pfd->completion_status != GCS_FIRST_GROUP_COMPLETE
202 || oldest != pfd->first_complete_group);
207 /* returns 1 if the group was found, 0 if not, negative on errors */
208 static int get_group(struct fec_header *h, struct private_fecdec_data *pfd,
209 struct fecdec_group **result)
211 struct fecdec_group *fg;
212 int ret = find_group(h, pfd, &fg);
216 if (ret > 0) /* found group */
218 /* group not found */
219 fg = find_unused_group(pfd);
222 fg = try_to_free_group(pfd);
225 fg = free_oldest_group(pfd);
234 * returns 1 if slice was added, zero otherwise (because the group was already
235 * complete). In any case the number of received slices is being increased by
238 static int add_slice(char *buf, struct fecdec_group *fg)
242 if (group_complete(fg)) {
243 PARA_DEBUG_LOG("group %d complete, ignoring slice %d\n",
244 fg->h.group_num, fg->h.slice_num);
245 fg->num_received_slices++;
248 slice_num = fg->h.slice_num;
249 if (fg->num_slices == 0) {
250 fg->num_slices = fg->h.slices_per_group;
251 fg->idx = para_malloc(fg->num_slices * sizeof(int));
252 fg->data = para_malloc(fg->num_slices * sizeof(unsigned char *));
253 memset(fg->data, 0, fg->num_slices * sizeof(unsigned char *));
255 r = fg->num_received_slices;
256 fg->idx[r] = slice_num;
257 fg->data[r] = para_malloc(fg->h.slice_bytes);
258 memcpy(fg->data[r], buf, fg->h.slice_bytes);
259 fg->num_received_slices++;
263 enum fec_group_usability {
266 FEC_GROUP_USABLE_SKIP_HEADER,
267 FEC_GROUP_USABLE_WITH_HEADER
270 static enum fec_group_usability group_is_usable(struct fecdec_group *fg,
271 struct private_fecdec_data *pfd)
273 struct fec_header *h = &fg->h;
275 if (!h->header_stream)
276 return FEC_GROUP_USABLE;
277 if (pfd->have_header) {
278 if (h->audio_header_size)
279 return FEC_GROUP_USABLE_SKIP_HEADER;
280 return FEC_GROUP_USABLE;
283 return FEC_GROUP_USABLE;
284 if (fg->h.audio_header_size)
285 return FEC_GROUP_USABLE_WITH_HEADER;
286 return FEC_GROUP_UNUSABLE;
289 static int decode_group(struct fecdec_group *fg, struct filter_node *fn)
291 int i, ret, sb = fg->h.slice_bytes;
292 size_t written, need;
293 struct private_fecdec_data *pfd = fn->private_data;
294 enum fec_group_usability u = group_is_usable(fg, pfd);
296 if (u == FEC_GROUP_UNUSABLE) {
297 PARA_INFO_LOG("dropping unusable group %d\n", fg->h.group_num);
300 PARA_DEBUG_LOG("decoding group %d (%d slices)\n", fg->h.group_num,
301 fg->h.data_slices_per_group);
302 ret = fec_decode(pfd->fec, fg->data, fg->idx, sb);
305 pfd->have_header = 1;
307 if (u == FEC_GROUP_USABLE_SKIP_HEADER) {
308 i = ROUND_UP(fg->h.audio_header_size, fg->h.slice_bytes)
310 PARA_DEBUG_LOG("skipping %d header slices\n", i);
312 PARA_DEBUG_LOG("writing group %d (%d/%d decoded data bytes)\n",
313 fg->h.group_num, fg->h.group_bytes,
314 fg->h.data_slices_per_group * sb);
315 need = fn->loaded + (fg->h.data_slices_per_group - i)* sb;
316 if (need > fn->bufsize) {
317 fn->bufsize = PARA_MAX(fn->bufsize * 2, need);
318 if (fn->bufsize > FECDEC_MAX_OUTBUF_SIZE)
319 return -E_FECDEC_OVERRUN;
320 PARA_INFO_LOG("increasing fec buf to %zu\n", fn->bufsize);
321 fn->buf = para_realloc(fn->buf, fn->bufsize);
323 if (u == FEC_GROUP_USABLE_WITH_HEADER) {
324 PARA_INFO_LOG("writing audio file header\n");
326 for (i = 0; i < fg->h.data_slices_per_group; i++) {
328 if (written >= fg->h.audio_header_size)
330 if (sb + written > fg->h.audio_header_size)
331 n = fg->h.audio_header_size - written;
332 memcpy(fn->buf + fn->loaded, fg->data[i], n);
338 for (; i < fg->h.data_slices_per_group; i++) {
340 if (n + written > fg->h.group_bytes)
341 n = fg->h.group_bytes - written;
342 memcpy(fn->buf + fn->loaded, fg->data[i], n);
350 * Read a fec header from a buffer.
352 * \param buf The buffer to write to.
353 * \param h The fec header to write.
355 static int read_fec_header(char *buf, size_t len, struct fec_header *h)
359 if (len < FEC_HEADER_SIZE)
361 magic = read_u32(buf);
362 if (magic != FEC_MAGIC)
363 return -E_BAD_FEC_HEADER;
364 h->slices_per_group = read_u8(buf + 4);
365 h->data_slices_per_group = read_u8(buf + 5);
366 h->audio_header_size = read_u32(buf + 6);
368 h->group_num = read_u32(buf + 10);
369 h->group_bytes = read_u32(buf + 14);
371 h->slice_num = read_u8(buf + 18);
372 h->slice_bytes = read_u16(buf + 20);
373 h->bos = read_u8(buf + 22);
374 h->header_stream = read_u8(buf + 23);
375 if (!memcmp(buf, FEC_EOF_PACKET, FEC_EOF_PACKET_LEN))
376 return -E_FECDEC_EOF;
377 // PARA_DEBUG_LOG("group %u, slize %u, slices per group: %u\n",
378 // h->group_num, h->slice_num, h->slices_per_group);
382 /* returns 1 if we used the buffer, 0 if we didn't, negative on errors */
383 static int dispatch_slice(char *buf, size_t len, struct fec_header *h,
384 struct filter_node *fn)
386 struct fecdec_group *fg;
388 struct private_fecdec_data *pfd = fn->private_data;
390 if (h->slice_bytes > len) /* can not use the thing, try to read more */
392 ret = get_group(h, pfd, &fg);
395 if (!add_slice(buf, fg))
397 if (group_complete(fg)) {
398 if (pfd->completion_status == GCS_NO_COMPLETE_GROUP) {
399 pfd->completion_status = GCS_FIRST_GROUP_COMPLETE;
400 pfd->first_complete_group = fg;
404 ret = decode_group(fg, fn);
409 if (pfd->completion_status == GCS_NO_COMPLETE_GROUP)
411 if (pfd->completion_status == GCS_FIRST_GROUP_DECODED)
413 if (fg == pfd->first_complete_group)
416 k = h->data_slices_per_group;
417 n = h->slices_per_group;
418 PARA_NOTICE_LOG("init fec (%d, %d)\n", k, n);
419 ret = fec_new(k, n, &pfd->fec);
422 ret = decode_group(pfd->first_complete_group, fn);
425 pfd->completion_status = GCS_FIRST_GROUP_DECODED;
429 static ssize_t fecdec(char *buf, size_t len, struct filter_node *fn)
434 ret = read_fec_header(buf, len, &h);
438 return -E_BAD_SLICE_SIZE;
439 if (h.slice_num > h.slices_per_group)
440 return -E_BAD_SLICE_NUM;
441 ret = dispatch_slice(buf + FEC_HEADER_SIZE, len - FEC_HEADER_SIZE,
443 //PARA_INFO_LOG("ret: %d, len: %d, slice_bytes: %d\n", ret, len, h.slice_bytes);
446 return FEC_HEADER_SIZE + h.slice_bytes;
449 static void fecdec_close(struct filter_node *fn)
451 struct private_fecdec_data *pfd = fn->private_data;
452 struct fecdec_group *fg;
454 FOR_EACH_FECDEC_GROUP(fg, pfd)
459 free(fn->private_data);
460 fn->private_data = NULL;
463 static void fecdec_open(struct filter_node *fn)
465 struct private_fecdec_data *pfd;
466 fn->bufsize = FECDEC_DEFAULT_OUTBUF_SIZE;
467 fn->buf = para_malloc(fn->bufsize);
468 pfd = para_calloc(sizeof(*pfd));
469 pfd->completion_status = GCS_NO_COMPLETE_GROUP;
470 fn->private_data = pfd;
475 * The init function of the fecdec filter.
477 * \param f struct to initialize.
479 void fecdec_filter_init(struct filter *f)
482 f->close = fecdec_close;
483 f->open = fecdec_open;