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 fec-decodes an audio stream. */
17 #include "portable_io.h"
22 * How many FEC groups to store in memory.
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
28 #define NUM_FEC_GROUPS 3
30 /** Size of the output buffer of the fecdec filter. */
31 #define FECDEC_OUTBUF_SIZE (1024 * 1024) /* FIXME: This has to depend on the fec params */
33 /** Data read from the header of a slice. */
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. */
43 /** Size of the data in this FEC group. */
45 /** Number of this slice in the group. */
47 /** Used data bytes of this slice. */
49 /** Non-zero if this group is the beginning of the stream. */
51 /** Non-zero if this stream embedds audio headers into fec groups. */
52 uint8_t header_stream;
56 * The status of one partially received FEC group.
59 /** The header read from the last slice. */
61 /** How many slices received so far. */
62 int num_received_slices;
63 /** The size of the \a idx and the \a data arrays below. */
65 /** Array of indices of the received slices. */
67 /** Content of the received slices. */
72 * Data private to the fecdec filter.
74 struct private_fecdec_data {
75 /** Used by the fec core code. */
76 struct fec_parms *fec;
77 /** Keeps track of what was received so far. */
78 struct fecdec_group groups[NUM_FEC_GROUPS];
82 /** Iterate over all fecdec groups. */
83 #define FOR_EACH_FECDEC_GROUP(g, d) for (g = (d)->groups; \
84 (g) - (d)->groups < NUM_FEC_GROUPS; (g)++)
86 static int group_complete(struct fecdec_group *fg)
88 return fg->num_received_slices >= fg->h.data_slices_per_group;
91 static int group_empty(struct fecdec_group *fg)
93 return fg->num_received_slices == 0;
96 static void clear_group(struct fecdec_group *fg)
100 for (i = 0; i < fg->num_slices; i++) {
108 memset(&fg->h, 0, sizeof(struct fec_header));
109 fg->num_received_slices = 0;
112 static int find_group(struct fec_header *h,
113 struct private_fecdec_data *pfd, struct fecdec_group **result)
115 struct fecdec_group *fg;
117 FOR_EACH_FECDEC_GROUP(fg, pfd) {
118 if (fg->h.group_num != h->group_num)
120 if (fg->h.slices_per_group != h->slices_per_group)
122 if (fg->h.data_slices_per_group != h->data_slices_per_group)
130 static struct fecdec_group *find_unused_group(struct private_fecdec_data *pfd)
132 struct fecdec_group *fg;
134 FOR_EACH_FECDEC_GROUP(fg, pfd) {
135 if (fg->num_received_slices == 0)
141 static struct fecdec_group *try_to_free_group(struct private_fecdec_data *pfd)
143 struct fecdec_group *fg;
145 FOR_EACH_FECDEC_GROUP(fg, pfd) {
146 if (!group_complete(fg))
154 static struct fecdec_group *free_oldest_group(struct private_fecdec_data *pfd)
156 struct fecdec_group *fg, *oldest = NULL;
158 FOR_EACH_FECDEC_GROUP(fg, pfd) {
159 if (!oldest || oldest->h.group_num > fg->h.group_num)
162 if (!group_complete(oldest) && !group_empty(oldest))
163 PARA_WARNING_LOG("Clearing incomplete group %d "
164 "(contains %d slices)\n", fg->h.group_num,
165 fg->num_received_slices);
170 /* returns 1 if the group was found, 0 if not, negative on errors */
171 static int get_group(struct fec_header *h, struct private_fecdec_data *pfd,
172 struct fecdec_group **result)
174 struct fecdec_group *fg;
175 int ret = find_group(h, pfd, &fg);
179 if (ret > 0) /* found group */
181 /* group not found */
182 fg = find_unused_group(pfd);
185 fg = try_to_free_group(pfd);
188 fg = free_oldest_group(pfd);
197 * returns 1 if slice was added, zero otherwise (because the group was already
198 * complete). In any case the number of received slices is being increased by
201 static int add_slice(char *buf, struct fecdec_group *fg)
205 if (group_complete(fg)) {
206 PARA_DEBUG_LOG("group complete, ignoring slice %d\n",
208 fg->num_received_slices++;
211 slice_num = fg->h.slice_num;
212 if (fg->num_slices == 0) {
213 fg->num_slices = fg->h.slices_per_group;
214 fg->idx = malloc(fg->num_slices * sizeof(int));
215 fg->data = malloc(fg->num_slices * sizeof(unsigned char *));
216 memset(fg->data, 0, fg->num_slices * sizeof(unsigned char *));
218 r = fg->num_received_slices;
219 fg->idx[r] = slice_num;
220 fg->data[r] = malloc(fg->h.slice_bytes);
221 memcpy(fg->data[r], buf, fg->h.slice_bytes);
222 fg->num_received_slices++;
226 enum fec_group_usability {
229 FEC_GROUP_USABLE_SKIP_HEADER,
232 static enum fec_group_usability group_is_usable(struct fecdec_group *fg,
233 struct private_fecdec_data *pfd)
235 struct fec_header *h = &fg->h;
237 if (!h->header_stream)
238 return FEC_GROUP_USABLE;
239 if (pfd->have_header) {
240 if (h->audio_header_size)
241 return FEC_GROUP_USABLE_SKIP_HEADER;
242 return FEC_GROUP_USABLE;
245 return FEC_GROUP_USABLE;
246 if (fg->h.audio_header_size)
247 return FEC_GROUP_USABLE;
248 return FEC_GROUP_UNUSABLE;
251 static int decode_group(struct fecdec_group *fg, struct filter_node *fn)
253 int i, ret, sb = fg->h.slice_bytes;
255 struct private_fecdec_data *pfd = fn->private_data;
256 enum fec_group_usability u = group_is_usable(fg, pfd);
258 if (u == FEC_GROUP_UNUSABLE) {
259 PARA_INFO_LOG("dropping unusable group %d\n", fg->h.group_num);
262 PARA_DEBUG_LOG("decoding group %d %d slices\n", fg->h.group_num,
263 fg->h.data_slices_per_group);
264 ret = fec_decode(pfd->fec, fg->data, fg->idx, sb);
267 pfd->have_header = 1;
269 if (u == FEC_GROUP_USABLE_SKIP_HEADER) {
270 i = ROUND_UP(fg->h.audio_header_size, fg->h.slice_bytes)
272 PARA_DEBUG_LOG("skipping %d header slices\n", i);
274 PARA_DEBUG_LOG("writing group %d (%d/%d decoded data bytes)\n",
275 fg->h.group_num, fg->h.group_bytes,
276 fg->h.data_slices_per_group * sb);
277 for (; i < fg->h.data_slices_per_group; i++) {
279 if (n + written > fg->h.group_bytes)
280 n = fg->h.group_bytes - written;
281 if (fn->loaded + n > fn->bufsize)
282 return -E_FECDEC_OVERRUN;
283 memcpy(fn->buf + fn->loaded, fg->data[i], n);
291 * Read a fec header from a buffer.
293 * \param buf The buffer to write to.
294 * \param h The fec header to write.
296 static int read_fec_header(char *buf, size_t len, struct fec_header *h)
300 if (len < FEC_HEADER_SIZE)
302 magic = read_u32(buf);
303 if (magic != FEC_MAGIC)
304 return -E_BAD_FEC_HEADER;
305 h->slices_per_group = read_u8(buf + 4);
306 h->data_slices_per_group = read_u8(buf + 5);
307 h->audio_header_size = read_u32(buf + 6);
309 h->group_num = read_u32(buf + 10);
310 h->group_bytes = read_u32(buf + 14);
312 h->slice_num = read_u8(buf + 18);
313 h->slice_bytes = read_u16(buf + 20);
314 h->bos = read_u8(buf + 22);
315 h->header_stream = read_u8(buf + 23);
316 if (!memcmp(buf, FEC_EOF_PACKET, FEC_EOF_PACKET_LEN))
317 return -E_FECDEC_EOF;
318 // PARA_DEBUG_LOG("group %u, slize %u, slices per group: %u\n",
319 // h->group_num, h->slice_num, h->slices_per_group);
323 /* returns 1 if we used the buffer, 0 if we didn't, negative on errors */
324 static int dispatch_slice(char *buf, size_t len, struct fec_header *h,
325 struct filter_node *fn)
327 struct fecdec_group *fg;
329 struct private_fecdec_data *pfd = fn->private_data;
331 if (h->slice_bytes > len) /* can not use the thing, try to read more */
333 ret = get_group(h, pfd, &fg);
336 if (!add_slice(buf, fg))
338 if (group_complete(fg)) {
340 int k = h->data_slices_per_group, n = h->slices_per_group;
341 PARA_NOTICE_LOG("init fec (%d, %d)\n", k, n);
342 ret = fec_new(k, n, &pfd->fec);
346 ret = decode_group(fg, fn);
353 static ssize_t fecdec(char *buf, size_t len, struct filter_node *fn)
358 ret = read_fec_header(buf, len, &h);
361 if (!h.slice_bytes || h.slice_bytes > fn->bufsize)
362 return -E_BAD_SLICE_SIZE;
363 if (h.slice_num > h.slices_per_group)
364 return -E_BAD_SLICE_NUM;
365 ret = dispatch_slice(buf + FEC_HEADER_SIZE, len - FEC_HEADER_SIZE,
367 //PARA_INFO_LOG("ret: %d, len: %d, slice_bytes: %d\n", ret, len, h.slice_bytes);
370 return FEC_HEADER_SIZE + h.slice_bytes;
373 static void fecdec_close(struct filter_node *fn)
375 struct private_fecdec_data *pfd = fn->private_data;
376 struct fecdec_group *fg;
378 FOR_EACH_FECDEC_GROUP(fg, pfd)
382 free(fn->private_data);
383 fn->private_data = NULL;
386 static void fecdec_open(struct filter_node *fn)
388 fn->bufsize = FECDEC_OUTBUF_SIZE;
389 fn->buf = para_malloc(fn->bufsize);
390 fn->private_data = para_calloc(sizeof(struct private_fecdec_data));
395 * The init function of the fecdec filter.
397 * \param f struct to initialize.
399 void fecdec_filter_init(struct filter *f)
402 f->close = fecdec_close;
403 f->open = fecdec_open;