2 * Copyright (C) 2003 the ffmpeg project
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Id RoQ Video Decoder by Dr. Tim Ferguson
25 * For more information about the Id RoQ format, visit:
26 * http://www.csse.monash.edu.au/~timf/
38 unsigned char y0, y1, y2, y3, u, v;
45 static int uiclip[1024], *uiclp; /* clipping table */
46 #define avg2(a,b) uiclp[(((int)(a)+(int)(b)+1)>>1)]
47 #define avg4(a,b,c,d) uiclp[(((int)(a)+(int)(b)+(int)(c)+(int)(d)+2)>>2)]
49 typedef struct RoqContext {
51 AVCodecContext *avctx;
55 AVFrame *current_frame;
61 roq_qcell qcells[256];
68 #define RoQ_INFO 0x1001
69 #define RoQ_QUAD_CODEBOOK 0x1002
70 #define RoQ_QUAD_VQ 0x1011
71 #define RoQ_SOUND_MONO 0x1020
72 #define RoQ_SOUND_STEREO 0x1021
74 #define RoQ_ID_MOT 0x00
75 #define RoQ_ID_FCC 0x01
76 #define RoQ_ID_SLD 0x02
77 #define RoQ_ID_CCC 0x03
79 #define get_byte(in_buffer) *(in_buffer++)
80 #define get_word(in_buffer) ((unsigned short)(in_buffer += 2, \
81 (in_buffer[-1] << 8 | in_buffer[-2])))
82 #define get_long(in_buffer) ((unsigned long)(in_buffer += 4, \
83 (in_buffer[-1] << 24 | in_buffer[-2] << 16 | in_buffer[-3] << 8 | in_buffer[-4])))
86 static void apply_vector_2x2(RoqContext *ri, int x, int y, roq_cell *cell)
90 yptr = ri->current_frame->data[0] + (y * ri->y_stride) + x;
93 yptr += (ri->y_stride - 2);
96 ri->current_frame->data[1][(y/2) * (ri->c_stride) + x/2] = cell->u;
97 ri->current_frame->data[2][(y/2) * (ri->c_stride) + x/2] = cell->v;
100 static void apply_vector_4x4(RoqContext *ri, int x, int y, roq_cell *cell)
102 unsigned long row_inc, c_row_inc;
103 register unsigned char y0, y1, u, v;
104 unsigned char *yptr, *uptr, *vptr;
106 yptr = ri->current_frame->data[0] + (y * ri->y_stride) + x;
107 uptr = ri->current_frame->data[1] + (y/2) * (ri->c_stride) + x/2;
108 vptr = ri->current_frame->data[2] + (y/2) * (ri->c_stride) + x/2;
110 row_inc = ri->y_stride - 4;
111 c_row_inc = (ri->c_stride) - 2;
112 *yptr++ = y0 = cell->y0; *uptr++ = u = cell->u; *vptr++ = v = cell->v;
114 *yptr++ = y1 = cell->y1; *uptr++ = u; *vptr++ = v;
124 yptr += row_inc; uptr += c_row_inc; vptr += c_row_inc;
126 *yptr++ = y0 = cell->y2; *uptr++ = u; *vptr++ = v;
128 *yptr++ = y1 = cell->y3; *uptr++ = u; *vptr++ = v;
139 static void apply_motion_4x4(RoqContext *ri, int x, int y, unsigned char mv,
140 signed char mean_x, signed char mean_y)
143 unsigned char *pa, *pb;
145 mx = x + 8 - (mv >> 4) - mean_x;
146 my = y + 8 - (mv & 0xf) - mean_y;
148 /* check MV against frame boundaries */
149 if ((mx < 0) || (mx > ri->avctx->width - 4) ||
150 (my < 0) || (my > ri->avctx->height - 4)) {
151 av_log(ri->avctx, AV_LOG_ERROR, "motion vector out of bounds: MV = (%d, %d), boundaries = (0, 0, %d, %d)\n",
152 mx, my, ri->avctx->width, ri->avctx->height);
156 pa = ri->current_frame->data[0] + (y * ri->y_stride) + x;
157 pb = ri->last_frame->data[0] + (my * ri->y_stride) + mx;
158 for(i = 0; i < 4; i++) {
168 pa = ri->current_frame->data[1] + (y * ri->y_stride)/4 + x/2;
169 pb = ri->last_frame->data[1] + (my/2) * (ri->y_stride/2) + (mx + 1)/2;
171 for(i = 0; i < 2; i++) {
172 switch(((my & 0x01) << 1) | (mx & 0x01)) {
182 pa[0] = avg2(pb[0], pb[1]);
183 pa[1] = avg2(pb[1], pb[2]);
184 pa[hw] = avg2(pb[hw], pb[hw+1]);
185 pa[hw+1] = avg2(pb[hw+1], pb[hw+2]);
189 pa[0] = avg2(pb[0], pb[hw]);
190 pa[1] = avg2(pb[1], pb[hw+1]);
191 pa[hw] = avg2(pb[hw], pb[hw*2]);
192 pa[hw+1] = avg2(pb[hw+1], pb[(hw*2)+1]);
196 pa[0] = avg4(pb[0], pb[1], pb[hw], pb[hw+1]);
197 pa[1] = avg4(pb[1], pb[2], pb[hw+1], pb[hw+2]);
198 pa[hw] = avg4(pb[hw], pb[hw+1], pb[hw*2], pb[(hw*2)+1]);
199 pa[hw+1] = avg4(pb[hw+1], pb[hw+2], pb[(hw*2)+1], pb[(hw*2)+1]);
203 pa = ri->current_frame->data[2] + (y * ri->y_stride)/4 + x/2;
204 pb = ri->last_frame->data[2] + (my/2) * (ri->y_stride/2) + (mx + 1)/2;
208 static void apply_motion_8x8(RoqContext *ri, int x, int y,
209 unsigned char mv, signed char mean_x, signed char mean_y)
211 int mx, my, i, j, hw;
212 unsigned char *pa, *pb;
214 mx = x + 8 - (mv >> 4) - mean_x;
215 my = y + 8 - (mv & 0xf) - mean_y;
217 /* check MV against frame boundaries */
218 if ((mx < 0) || (mx > ri->avctx->width - 8) ||
219 (my < 0) || (my > ri->avctx->height - 8)) {
220 av_log(ri->avctx, AV_LOG_ERROR, "motion vector out of bounds: MV = (%d, %d), boundaries = (0, 0, %d, %d)\n",
221 mx, my, ri->avctx->width, ri->avctx->height);
225 pa = ri->current_frame->data[0] + (y * ri->y_stride) + x;
226 pb = ri->last_frame->data[0] + (my * ri->y_stride) + mx;
227 for(i = 0; i < 8; i++) {
241 pa = ri->current_frame->data[1] + (y * ri->y_stride)/4 + x/2;
242 pb = ri->last_frame->data[1] + (my/2) * (ri->y_stride/2) + (mx + 1)/2;
243 for(j = 0; j < 2; j++) {
244 for(i = 0; i < 4; i++) {
245 switch(((my & 0x01) << 1) | (mx & 0x01)) {
255 pa[0] = avg2(pb[0], pb[1]);
256 pa[1] = avg2(pb[1], pb[2]);
257 pa[2] = avg2(pb[2], pb[3]);
258 pa[3] = avg2(pb[3], pb[4]);
262 pa[0] = avg2(pb[0], pb[hw]);
263 pa[1] = avg2(pb[1], pb[hw+1]);
264 pa[2] = avg2(pb[2], pb[hw+2]);
265 pa[3] = avg2(pb[3], pb[hw+3]);
269 pa[0] = avg4(pb[0], pb[1], pb[hw], pb[hw+1]);
270 pa[1] = avg4(pb[1], pb[2], pb[hw+1], pb[hw+2]);
271 pa[2] = avg4(pb[2], pb[3], pb[hw+2], pb[hw+3]);
272 pa[3] = avg4(pb[3], pb[4], pb[hw+3], pb[hw+4]);
279 pa = ri->current_frame->data[2] + (y * ri->y_stride)/4 + x/2;
280 pb = ri->last_frame->data[2] + (my/2) * (ri->y_stride/2) + (mx + 1)/2;
284 static void roqvideo_decode_frame(RoqContext *ri)
286 unsigned int chunk_id = 0, chunk_arg = 0;
287 unsigned long chunk_size = 0;
288 int i, j, k, nv1, nv2, vqflg = 0, vqflg_pos = -1;
289 int vqid, bpos, xpos, ypos, xp, yp, x, y;
290 int frame_stats[2][4] = {{0},{0}};
292 unsigned char *buf = ri->buf;
293 unsigned char *buf_end = ri->buf + ri->size;
295 while (buf < buf_end) {
296 chunk_id = get_word(buf);
297 chunk_size = get_long(buf);
298 chunk_arg = get_word(buf);
300 if(chunk_id == RoQ_QUAD_VQ)
302 if(chunk_id == RoQ_QUAD_CODEBOOK) {
303 if((nv1 = chunk_arg >> 8) == 0)
305 if((nv2 = chunk_arg & 0xff) == 0 && nv1 * 6 < chunk_size)
307 for(i = 0; i < nv1; i++) {
308 ri->cells[i].y0 = get_byte(buf);
309 ri->cells[i].y1 = get_byte(buf);
310 ri->cells[i].y2 = get_byte(buf);
311 ri->cells[i].y3 = get_byte(buf);
312 ri->cells[i].u = get_byte(buf);
313 ri->cells[i].v = get_byte(buf);
315 for(i = 0; i < nv2; i++)
316 for(j = 0; j < 4; j++)
317 ri->qcells[i].idx[j] = get_byte(buf);
321 bpos = xpos = ypos = 0;
322 while(bpos < chunk_size) {
323 for (yp = ypos; yp < ypos + 16; yp += 8)
324 for (xp = xpos; xp < xpos + 16; xp += 8) {
326 vqflg = buf[bpos++]; vqflg |= (buf[bpos++] << 8);
329 vqid = (vqflg >> (vqflg_pos * 2)) & 0x3;
330 frame_stats[0][vqid]++;
335 apply_motion_8x8(ri, xp, yp, 0, 8, 8);
338 apply_motion_8x8(ri, xp, yp, buf[bpos++], chunk_arg >> 8,
342 qcell = ri->qcells + buf[bpos++];
343 apply_vector_4x4(ri, xp, yp, ri->cells + qcell->idx[0]);
344 apply_vector_4x4(ri, xp+4, yp, ri->cells + qcell->idx[1]);
345 apply_vector_4x4(ri, xp, yp+4, ri->cells + qcell->idx[2]);
346 apply_vector_4x4(ri, xp+4, yp+4, ri->cells + qcell->idx[3]);
349 for (k = 0; k < 4; k++) {
356 vqflg |= (buf[bpos++] << 8);
359 vqid = (vqflg >> (vqflg_pos * 2)) & 0x3;
360 frame_stats[1][vqid]++;
364 apply_motion_4x4(ri, x, y, 0, 8, 8);
367 apply_motion_4x4(ri, x, y, buf[bpos++],
368 chunk_arg >> 8, chunk_arg & 0xff);
371 qcell = ri->qcells + buf[bpos++];
372 apply_vector_2x2(ri, x, y, ri->cells + qcell->idx[0]);
373 apply_vector_2x2(ri, x+2, y, ri->cells + qcell->idx[1]);
374 apply_vector_2x2(ri, x, y+2, ri->cells + qcell->idx[2]);
375 apply_vector_2x2(ri, x+2, y+2, ri->cells + qcell->idx[3]);
378 apply_vector_2x2(ri, x, y, ri->cells + buf[bpos]);
379 apply_vector_2x2(ri, x+2, y, ri->cells + buf[bpos+1]);
380 apply_vector_2x2(ri, x, y+2, ri->cells + buf[bpos+2]);
381 apply_vector_2x2(ri, x+2, y+2, ri->cells + buf[bpos+3]);
388 av_log(ri->avctx, AV_LOG_ERROR, "Unknown vq code: %d\n", vqid);
393 if (xpos >= ri->avctx->width) {
394 xpos -= ri->avctx->width;
397 if(ypos >= ri->avctx->height)
403 static int roq_decode_init(AVCodecContext *avctx)
405 RoqContext *s = avctx->priv_data;
410 s->last_frame = &s->frames[0];
411 s->current_frame = &s->frames[1];
412 avctx->pix_fmt = PIX_FMT_YUV420P;
413 dsputil_init(&s->dsp, avctx);
416 for(i = -512; i < 512; i++)
417 uiclp[i] = (i < 0 ? 0 : (i > 255 ? 255 : i));
422 static int roq_decode_frame(AVCodecContext *avctx,
423 void *data, int *data_size,
424 uint8_t *buf, int buf_size)
426 RoqContext *s = avctx->priv_data;
428 if (avctx->get_buffer(avctx, s->current_frame)) {
429 av_log(avctx, AV_LOG_ERROR, " RoQ: get_buffer() failed\n");
432 s->y_stride = s->current_frame->linesize[0];
433 s->c_stride = s->current_frame->linesize[1];
437 roqvideo_decode_frame(s);
439 /* release the last frame if it is allocated */
443 avctx->release_buffer(avctx, s->last_frame);
445 *data_size = sizeof(AVFrame);
446 *(AVFrame*)data = *s->current_frame;
449 FFSWAP(AVFrame *, s->current_frame, s->last_frame);
454 static int roq_decode_end(AVCodecContext *avctx)
456 RoqContext *s = avctx->priv_data;
458 /* release the last frame */
459 if (s->last_frame->data[0])
460 avctx->release_buffer(avctx, s->last_frame);
465 AVCodec roq_decoder = {