4 * Copyright (C) 2007 Vitor Sessak <vitor1001@gmail.com>
5 * Copyright (C) 2004-2007 Eric Lasota
6 * Based on RoQ specs (C) 2001 Tim Ferguson
8 * This file is part of FFmpeg.
10 * FFmpeg is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
15 * FFmpeg is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with FFmpeg; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27 * id RoQ encoder by Vitor. Based on the Switchblade3 library and the
28 * Switchblade3 FFmpeg glue by Eric Lasota.
36 * CODEBOOK - 2 + 8 bits
37 * SUBDIVIDE - 2 + combined subcel cost
42 * CODEBOOK - 2 + 8 bits
43 * SUBDIVIDE - 2 + 4*8 bits
45 * Maximum cost: 138 bits per cel
47 * Proper evaluation requires LCD fraction comparison, which requires
48 * Squared Error (SE) loss * savings increase
50 * Maximum savings increase: 136 bits
51 * Maximum SE loss without overflow: 31580641
52 * Components in 8x8 supercel: 192
53 * Maximum SE precision per component: 164482
54 * >65025, so no truncation is needed (phew)
59 #include "libavutil/attributes.h"
60 #include "libavutil/opt.h"
62 #include "bytestream.h"
70 * Maximum number of generated 4x4 codebooks. Can't be 256 to workaround a
73 #define MAX_CBS_4x4 256
75 #define MAX_CBS_2x2 256 ///< Maximum number of 2x2 codebooks.
77 /* The cast is useful when multiplying it by INT_MAX */
78 #define ROQ_LAMBDA_SCALE ((uint64_t) FF_LAMBDA_SCALE)
80 /* Macroblock support functions */
81 static void unpack_roq_cell(roq_cell *cell, uint8_t u[4*3])
83 memcpy(u , cell->y, 4);
84 memset(u+4, cell->u, 4);
85 memset(u+8, cell->v, 4);
88 static void unpack_roq_qcell(uint8_t cb2[], roq_qcell *qcell, uint8_t u[4*4*3])
91 static const int offsets[4] = {0, 2, 8, 10};
93 for (cp=0; cp<3; cp++)
95 u[4*4*cp + offsets[i] ] = cb2[qcell->idx[i]*2*2*3 + 4*cp ];
96 u[4*4*cp + offsets[i]+1] = cb2[qcell->idx[i]*2*2*3 + 4*cp+1];
97 u[4*4*cp + offsets[i]+4] = cb2[qcell->idx[i]*2*2*3 + 4*cp+2];
98 u[4*4*cp + offsets[i]+5] = cb2[qcell->idx[i]*2*2*3 + 4*cp+3];
103 static void enlarge_roq_mb4(uint8_t base[3*16], uint8_t u[3*64])
107 for(cp=0; cp<3; cp++)
110 *u++ = base[(y/2)*4 + (x/2) + 16*cp];
113 static inline int square(int x)
118 static inline int eval_sse(const uint8_t *a, const uint8_t *b, int count)
123 diff += square(*b++ - *a++);
128 // FIXME Could use DSPContext.sse, but it is not so speed critical (used
129 // just for motion estimation).
130 static int block_sse(uint8_t * const *buf1, uint8_t * const *buf2, int x1, int y1,
131 int x2, int y2, const int *stride1, const int *stride2, int size)
136 for (k=0; k<3; k++) {
137 int bias = (k ? CHROMA_BIAS : 4);
138 for (i=0; i<size; i++)
139 sse += bias*eval_sse(buf1[k] + (y1+i)*stride1[k] + x1,
140 buf2[k] + (y2+i)*stride2[k] + x2, size);
146 static int eval_motion_dist(RoqContext *enc, int x, int y, motion_vect vect,
152 if (mx < -7 || mx > 7)
155 if (my < -7 || my > 7)
161 if ((unsigned) mx > enc->width-size || (unsigned) my > enc->height-size)
164 return block_sse(enc->frame_to_enc->data, enc->last_frame->data, x, y,
166 enc->frame_to_enc->linesize, enc->last_frame->linesize,
171 * @return distortion between two macroblocks
173 static inline int squared_diff_macroblock(uint8_t a[], uint8_t b[], int size)
177 for(cp=0;cp<3;cp++) {
178 int bias = (cp ? CHROMA_BIAS : 4);
179 sdiff += bias*eval_sse(a, b, size*size);
187 typedef struct SubcelEvaluation {
197 typedef struct CelEvaluation {
201 SubcelEvaluation subCels[4];
206 int sourceX, sourceY;
209 typedef struct RoqCodebooks {
212 int usedCB2[MAX_CBS_2x2];
213 int usedCB4[MAX_CBS_4x4];
214 uint8_t unpacked_cb2[MAX_CBS_2x2*2*2*3];
215 uint8_t unpacked_cb4[MAX_CBS_4x4*4*4*3];
216 uint8_t unpacked_cb4_enlarged[MAX_CBS_4x4*8*8*3];
222 typedef struct RoqTempData
224 CelEvaluation *cel_evals;
226 int f2i4[MAX_CBS_4x4];
227 int i2f4[MAX_CBS_4x4];
228 int f2i2[MAX_CBS_2x2];
229 int i2f2[MAX_CBS_2x2];
236 RoqCodebooks codebooks;
243 * Initialize cel evaluators and set their source coordinates
245 static int create_cel_evals(RoqContext *enc, RoqTempdata *tempData)
249 tempData->cel_evals = av_malloc_array(enc->width*enc->height/64, sizeof(CelEvaluation));
250 if (!tempData->cel_evals)
251 return AVERROR(ENOMEM);
253 /* Map to the ROQ quadtree order */
254 for (y=0; y<enc->height; y+=16)
255 for (x=0; x<enc->width; x+=16)
257 tempData->cel_evals[n ].sourceX = x + (i&1)*8;
258 tempData->cel_evals[n++].sourceY = y + (i&2)*4;
265 * Get macroblocks from parts of the image
267 static void get_frame_mb(const AVFrame *frame, int x, int y, uint8_t mb[], int dim)
271 for (cp=0; cp<3; cp++) {
272 int stride = frame->linesize[cp];
273 for (i=0; i<dim; i++)
274 for (j=0; j<dim; j++)
275 *mb++ = frame->data[cp][(y+i)*stride + x + j];
280 * Find the codebook with the lowest distortion from an image
282 static int index_mb(uint8_t cluster[], uint8_t cb[], int numCB,
283 int *outIndex, int dim)
285 int i, lDiff = INT_MAX, pick=0;
287 /* Diff against the others */
288 for (i=0; i<numCB; i++) {
289 int diff = squared_diff_macroblock(cluster, cb + i*dim*dim*3, dim);
300 #define EVAL_MOTION(MOTION) \
302 diff = eval_motion_dist(enc, j, i, MOTION, blocksize); \
304 if (diff < lowestdiff) { \
310 static void motion_search(RoqContext *enc, int blocksize)
312 static const motion_vect offsets[8] = {
323 int diff, lowestdiff, oldbest;
325 motion_vect bestpick = {{0,0}};
328 motion_vect *last_motion;
329 motion_vect *this_motion;
330 motion_vect vect, vect2;
332 int max=(enc->width/blocksize)*enc->height/blocksize;
334 if (blocksize == 4) {
335 last_motion = enc->last_motion4;
336 this_motion = enc->this_motion4;
338 last_motion = enc->last_motion8;
339 this_motion = enc->this_motion8;
342 for (i=0; i<enc->height; i+=blocksize)
343 for (j=0; j<enc->width; j+=blocksize) {
344 lowestdiff = eval_motion_dist(enc, j, i, (motion_vect) {{0,0}},
350 EVAL_MOTION(enc->this_motion8[(i/8)*(enc->width/8) + j/8]);
352 offset = (i/blocksize)*enc->width/blocksize + j/blocksize;
353 if (offset < max && offset >= 0)
354 EVAL_MOTION(last_motion[offset]);
357 if (offset < max && offset >= 0)
358 EVAL_MOTION(last_motion[offset]);
360 offset = (i/blocksize + 1)*enc->width/blocksize + j/blocksize;
361 if (offset < max && offset >= 0)
362 EVAL_MOTION(last_motion[offset]);
364 off[0]= (i/blocksize)*enc->width/blocksize + j/blocksize - 1;
365 off[1]= off[0] - enc->width/blocksize + 1;
371 vect.d[k]= mid_pred(this_motion[off[0]].d[k],
372 this_motion[off[1]].d[k],
373 this_motion[off[2]].d[k]);
377 EVAL_MOTION(this_motion[off[k]]);
379 EVAL_MOTION(this_motion[off[0]]);
384 while (oldbest != lowestdiff) {
385 oldbest = lowestdiff;
386 for (k=0; k<8; k++) {
388 vect2.d[0] += offsets[k].d[0];
389 vect2.d[1] += offsets[k].d[1];
394 offset = (i/blocksize)*enc->width/blocksize + j/blocksize;
395 this_motion[offset] = bestpick;
400 * Get distortion for all options available to a subcel
402 static void gather_data_for_subcel(SubcelEvaluation *subcel, int x,
403 int y, RoqContext *enc, RoqTempdata *tempData)
410 static const int bitsUsed[4] = {2, 10, 10, 34};
412 if (enc->framesSinceKeyframe >= 1) {
413 subcel->motion = enc->this_motion4[y*enc->width/16 + x/4];
415 subcel->eval_dist[RoQ_ID_FCC] =
416 eval_motion_dist(enc, x, y,
417 enc->this_motion4[y*enc->width/16 + x/4], 4);
419 subcel->eval_dist[RoQ_ID_FCC] = INT_MAX;
421 if (enc->framesSinceKeyframe >= 2)
422 subcel->eval_dist[RoQ_ID_MOT] = block_sse(enc->frame_to_enc->data,
423 enc->current_frame->data, x,
425 enc->frame_to_enc->linesize,
426 enc->current_frame->linesize,
429 subcel->eval_dist[RoQ_ID_MOT] = INT_MAX;
431 cluster_index = y*enc->width/16 + x/4;
433 get_frame_mb(enc->frame_to_enc, x, y, mb4, 4);
435 subcel->eval_dist[RoQ_ID_SLD] = index_mb(mb4,
436 tempData->codebooks.unpacked_cb4,
437 tempData->codebooks.numCB4,
438 &subcel->cbEntry, 4);
440 subcel->eval_dist[RoQ_ID_CCC] = 0;
443 subcel->subCels[i] = tempData->closest_cb2[cluster_index*4+i];
445 get_frame_mb(enc->frame_to_enc, x+2*(i&1),
448 subcel->eval_dist[RoQ_ID_CCC] +=
449 squared_diff_macroblock(tempData->codebooks.unpacked_cb2 + subcel->subCels[i]*2*2*3, mb2, 2);
454 if (ROQ_LAMBDA_SCALE*subcel->eval_dist[i] + enc->lambda*bitsUsed[i] <
456 subcel->best_coding = i;
457 subcel->best_bit_use = bitsUsed[i];
458 best_dist = ROQ_LAMBDA_SCALE*subcel->eval_dist[i] +
459 enc->lambda*bitsUsed[i];
464 * Get distortion for all options available to a cel
466 static void gather_data_for_cel(CelEvaluation *cel, RoqContext *enc,
467 RoqTempdata *tempData)
470 int index = cel->sourceY*enc->width/64 + cel->sourceX/8;
471 int i, j, best_dist, divide_bit_use;
473 int bitsUsed[4] = {2, 10, 10, 0};
475 if (enc->framesSinceKeyframe >= 1) {
476 cel->motion = enc->this_motion8[index];
478 cel->eval_dist[RoQ_ID_FCC] =
479 eval_motion_dist(enc, cel->sourceX, cel->sourceY,
480 enc->this_motion8[index], 8);
482 cel->eval_dist[RoQ_ID_FCC] = INT_MAX;
484 if (enc->framesSinceKeyframe >= 2)
485 cel->eval_dist[RoQ_ID_MOT] = block_sse(enc->frame_to_enc->data,
486 enc->current_frame->data,
487 cel->sourceX, cel->sourceY,
488 cel->sourceX, cel->sourceY,
489 enc->frame_to_enc->linesize,
490 enc->current_frame->linesize,8);
492 cel->eval_dist[RoQ_ID_MOT] = INT_MAX;
494 get_frame_mb(enc->frame_to_enc, cel->sourceX, cel->sourceY, mb8, 8);
496 cel->eval_dist[RoQ_ID_SLD] =
497 index_mb(mb8, tempData->codebooks.unpacked_cb4_enlarged,
498 tempData->codebooks.numCB4, &cel->cbEntry, 8);
500 gather_data_for_subcel(cel->subCels + 0, cel->sourceX+0, cel->sourceY+0, enc, tempData);
501 gather_data_for_subcel(cel->subCels + 1, cel->sourceX+4, cel->sourceY+0, enc, tempData);
502 gather_data_for_subcel(cel->subCels + 2, cel->sourceX+0, cel->sourceY+4, enc, tempData);
503 gather_data_for_subcel(cel->subCels + 3, cel->sourceX+4, cel->sourceY+4, enc, tempData);
505 cel->eval_dist[RoQ_ID_CCC] = 0;
507 for (i=0; i<4; i++) {
508 cel->eval_dist[RoQ_ID_CCC] +=
509 cel->subCels[i].eval_dist[cel->subCels[i].best_coding];
510 divide_bit_use += cel->subCels[i].best_bit_use;
514 bitsUsed[3] = 2 + divide_bit_use;
517 if (ROQ_LAMBDA_SCALE*cel->eval_dist[i] + enc->lambda*bitsUsed[i] <
519 cel->best_coding = i;
520 best_dist = ROQ_LAMBDA_SCALE*cel->eval_dist[i] +
521 enc->lambda*bitsUsed[i];
524 tempData->used_option[cel->best_coding]++;
525 tempData->mainChunkSize += bitsUsed[cel->best_coding];
527 if (cel->best_coding == RoQ_ID_SLD)
528 tempData->codebooks.usedCB4[cel->cbEntry]++;
530 if (cel->best_coding == RoQ_ID_CCC)
531 for (i=0; i<4; i++) {
532 if (cel->subCels[i].best_coding == RoQ_ID_SLD)
533 tempData->codebooks.usedCB4[cel->subCels[i].cbEntry]++;
534 else if (cel->subCels[i].best_coding == RoQ_ID_CCC)
536 tempData->codebooks.usedCB2[cel->subCels[i].subCels[j]]++;
540 static void remap_codebooks(RoqContext *enc, RoqTempdata *tempData)
544 /* Make remaps for the final codebook usage */
545 for (i=0; i<(enc->quake3_compat ? MAX_CBS_4x4-1 : MAX_CBS_4x4); i++) {
546 if (tempData->codebooks.usedCB4[i]) {
547 tempData->i2f4[i] = idx;
548 tempData->f2i4[idx] = i;
550 tempData->codebooks.usedCB2[enc->cb4x4[i].idx[j]]++;
555 tempData->numCB4 = idx;
558 for (i=0; i<MAX_CBS_2x2; i++) {
559 if (tempData->codebooks.usedCB2[i]) {
560 tempData->i2f2[i] = idx;
561 tempData->f2i2[idx] = i;
565 tempData->numCB2 = idx;
570 * Write codebook chunk
572 static void write_codebooks(RoqContext *enc, RoqTempdata *tempData)
575 uint8_t **outp= &enc->out_buf;
577 if (tempData->numCB2) {
578 bytestream_put_le16(outp, RoQ_QUAD_CODEBOOK);
579 bytestream_put_le32(outp, tempData->numCB2*6 + tempData->numCB4*4);
580 bytestream_put_byte(outp, tempData->numCB4);
581 bytestream_put_byte(outp, tempData->numCB2);
583 for (i=0; i<tempData->numCB2; i++) {
584 bytestream_put_buffer(outp, enc->cb2x2[tempData->f2i2[i]].y, 4);
585 bytestream_put_byte(outp, enc->cb2x2[tempData->f2i2[i]].u);
586 bytestream_put_byte(outp, enc->cb2x2[tempData->f2i2[i]].v);
589 for (i=0; i<tempData->numCB4; i++)
591 bytestream_put_byte(outp, tempData->i2f2[enc->cb4x4[tempData->f2i4[i]].idx[j]]);
596 static inline uint8_t motion_arg(motion_vect mot)
598 uint8_t ax = 8 - ((uint8_t) mot.d[0]);
599 uint8_t ay = 8 - ((uint8_t) mot.d[1]);
600 return ((ax&15)<<4) | (ay&15);
603 typedef struct CodingSpool {
606 uint8_t argumentSpool[64];
611 /* NOTE: Typecodes must be spooled AFTER arguments!! */
612 static void write_typecode(CodingSpool *s, uint8_t type)
614 s->typeSpool |= (type & 3) << (14 - s->typeSpoolLength);
615 s->typeSpoolLength += 2;
616 if (s->typeSpoolLength == 16) {
617 bytestream_put_le16(s->pout, s->typeSpool);
618 bytestream_put_buffer(s->pout, s->argumentSpool,
619 s->args - s->argumentSpool);
620 s->typeSpoolLength = 0;
622 s->args = s->argumentSpool;
626 static void reconstruct_and_encode_image(RoqContext *enc, RoqTempdata *tempData, int w, int h, int numBlocks)
639 spool.typeSpoolLength=0;
640 spool.args = spool.argumentSpool;
641 spool.pout = &enc->out_buf;
643 if (tempData->used_option[RoQ_ID_CCC]%2)
644 tempData->mainChunkSize+=8; //FIXME
646 /* Write the video chunk header */
647 bytestream_put_le16(&enc->out_buf, RoQ_QUAD_VQ);
648 bytestream_put_le32(&enc->out_buf, tempData->mainChunkSize/8);
649 bytestream_put_byte(&enc->out_buf, 0x0);
650 bytestream_put_byte(&enc->out_buf, 0x0);
652 for (i=0; i<numBlocks; i++) {
653 eval = tempData->cel_evals + i;
657 dist += eval->eval_dist[eval->best_coding];
659 switch (eval->best_coding) {
661 write_typecode(&spool, RoQ_ID_MOT);
665 bytestream_put_byte(&spool.args, motion_arg(eval->motion));
667 write_typecode(&spool, RoQ_ID_FCC);
668 ff_apply_motion_8x8(enc, x, y,
669 eval->motion.d[0], eval->motion.d[1]);
673 bytestream_put_byte(&spool.args, tempData->i2f4[eval->cbEntry]);
674 write_typecode(&spool, RoQ_ID_SLD);
676 qcell = enc->cb4x4 + eval->cbEntry;
677 ff_apply_vector_4x4(enc, x , y , enc->cb2x2 + qcell->idx[0]);
678 ff_apply_vector_4x4(enc, x+4, y , enc->cb2x2 + qcell->idx[1]);
679 ff_apply_vector_4x4(enc, x , y+4, enc->cb2x2 + qcell->idx[2]);
680 ff_apply_vector_4x4(enc, x+4, y+4, enc->cb2x2 + qcell->idx[3]);
684 write_typecode(&spool, RoQ_ID_CCC);
686 for (j=0; j<4; j++) {
690 switch(eval->subCels[j].best_coding) {
695 bytestream_put_byte(&spool.args,
696 motion_arg(eval->subCels[j].motion));
698 ff_apply_motion_4x4(enc, subX, subY,
699 eval->subCels[j].motion.d[0],
700 eval->subCels[j].motion.d[1]);
704 bytestream_put_byte(&spool.args,
705 tempData->i2f4[eval->subCels[j].cbEntry]);
707 qcell = enc->cb4x4 + eval->subCels[j].cbEntry;
709 ff_apply_vector_2x2(enc, subX , subY ,
710 enc->cb2x2 + qcell->idx[0]);
711 ff_apply_vector_2x2(enc, subX+2, subY ,
712 enc->cb2x2 + qcell->idx[1]);
713 ff_apply_vector_2x2(enc, subX , subY+2,
714 enc->cb2x2 + qcell->idx[2]);
715 ff_apply_vector_2x2(enc, subX+2, subY+2,
716 enc->cb2x2 + qcell->idx[3]);
720 for (k=0; k<4; k++) {
721 int cb_idx = eval->subCels[j].subCels[k];
722 bytestream_put_byte(&spool.args,
723 tempData->i2f2[cb_idx]);
725 ff_apply_vector_2x2(enc, subX + 2*(k&1), subY + (k&2),
726 enc->cb2x2 + cb_idx);
730 write_typecode(&spool, eval->subCels[j].best_coding);
736 /* Flush the remainder of the argument/type spool */
737 while (spool.typeSpoolLength)
738 write_typecode(&spool, 0x0);
741 uint8_t *fdata[3] = {enc->frame_to_enc->data[0],
742 enc->frame_to_enc->data[1],
743 enc->frame_to_enc->data[2]};
744 uint8_t *cdata[3] = {enc->current_frame->data[0],
745 enc->current_frame->data[1],
746 enc->current_frame->data[2]};
747 av_log(enc->avctx, AV_LOG_ERROR, "Expected distortion: %i Actual: %i\n",
749 block_sse(fdata, cdata, 0, 0, 0, 0,
750 enc->frame_to_enc->linesize,
751 enc->current_frame->linesize,
752 enc->width)); //WARNING: Square dimensions implied...
758 * Create a single YUV cell from a 2x2 section of the image
760 static inline void frame_block_to_cell(uint8_t *block, uint8_t * const *data,
761 int top, int left, const int *stride)
766 for (j=0; j<2; j++) {
767 int x = (top+i)*stride[0] + left + j;
768 *block++ = data[0][x];
769 x = (top+i)*stride[1] + left + j;
779 * Create YUV clusters for the entire image
781 static void create_clusters(const AVFrame *frame, int w, int h, uint8_t *yuvClusters)
786 for (j=0; j<w; j+=4) {
787 for (k=0; k < 2; k++)
788 for (l=0; l < 2; l++)
789 frame_block_to_cell(yuvClusters + (l + 2*k)*6, frame->data,
790 i+2*k, j+2*l, frame->linesize);
795 static int generate_codebook(RoqContext *enc, RoqTempdata *tempdata,
796 int *points, int inputCount, roq_cell *results,
797 int size, int cbsize)
799 int i, j, k, ret = 0;
800 int c_size = size*size/4;
802 int *codebook = av_malloc_array(6*c_size, cbsize*sizeof(int));
806 return AVERROR(ENOMEM);
809 closest_cb = av_malloc_array(6*c_size, inputCount*sizeof(int));
811 ret = AVERROR(ENOMEM);
815 closest_cb = tempdata->closest_cb2;
817 ret = avpriv_init_elbg(points, 6 * c_size, inputCount, codebook,
818 cbsize, 1, closest_cb, &enc->randctx);
821 ret = avpriv_do_elbg(points, 6 * c_size, inputCount, codebook,
822 cbsize, 1, closest_cb, &enc->randctx);
827 for (i=0; i<cbsize; i++)
828 for (k=0; k<c_size; k++) {
830 results->y[j] = *buf++;
832 results->u = (*buf++ + CHROMA_BIAS/2)/CHROMA_BIAS;
833 results->v = (*buf++ + CHROMA_BIAS/2)/CHROMA_BIAS;
843 static int generate_new_codebooks(RoqContext *enc, RoqTempdata *tempData)
846 RoqCodebooks *codebooks = &tempData->codebooks;
847 int max = enc->width*enc->height/16;
849 roq_cell *results4 = av_malloc(sizeof(roq_cell)*MAX_CBS_4x4*4);
850 uint8_t *yuvClusters=av_malloc_array(max, sizeof(int)*6*4);
851 int *points = av_malloc_array(max, 6*4*sizeof(int));
854 if (!results4 || !yuvClusters || !points) {
855 ret = AVERROR(ENOMEM);
859 /* Subsample YUV data */
860 create_clusters(enc->frame_to_enc, enc->width, enc->height, yuvClusters);
862 /* Cast to integer and apply chroma bias */
863 for (i=0; i<max*24; i++) {
864 bias = ((i%6)<4) ? 1 : CHROMA_BIAS;
865 points[i] = bias*yuvClusters[i];
868 /* Create 4x4 codebooks */
869 if ((ret = generate_codebook(enc, tempData, points, max,
870 results4, 4, (enc->quake3_compat ? MAX_CBS_4x4-1 : MAX_CBS_4x4))) < 0)
873 codebooks->numCB4 = (enc->quake3_compat ? MAX_CBS_4x4-1 : MAX_CBS_4x4);
875 tempData->closest_cb2 = av_malloc_array(max, 4*sizeof(int));
876 if (!tempData->closest_cb2) {
877 ret = AVERROR(ENOMEM);
881 /* Create 2x2 codebooks */
882 if ((ret = generate_codebook(enc, tempData, points, max * 4,
883 enc->cb2x2, 2, MAX_CBS_2x2)) < 0)
886 codebooks->numCB2 = MAX_CBS_2x2;
888 /* Unpack 2x2 codebook clusters */
889 for (i=0; i<codebooks->numCB2; i++)
890 unpack_roq_cell(enc->cb2x2 + i, codebooks->unpacked_cb2 + i*2*2*3);
892 /* Index all 4x4 entries to the 2x2 entries, unpack, and enlarge */
893 for (i=0; i<codebooks->numCB4; i++) {
894 for (j=0; j<4; j++) {
895 unpack_roq_cell(&results4[4*i + j], mb2);
896 index_mb(mb2, codebooks->unpacked_cb2, codebooks->numCB2,
897 &enc->cb4x4[i].idx[j], 2);
899 unpack_roq_qcell(codebooks->unpacked_cb2, enc->cb4x4 + i,
900 codebooks->unpacked_cb4 + i*4*4*3);
901 enlarge_roq_mb4(codebooks->unpacked_cb4 + i*4*4*3,
902 codebooks->unpacked_cb4_enlarged + i*8*8*3);
905 av_free(yuvClusters);
911 static int roq_encode_video(RoqContext *enc)
913 RoqTempdata *tempData = enc->tmpData;
916 memset(tempData, 0, sizeof(*tempData));
918 ret = create_cel_evals(enc, tempData);
922 ret = generate_new_codebooks(enc, tempData);
926 if (enc->framesSinceKeyframe >= 1) {
927 motion_search(enc, 8);
928 motion_search(enc, 4);
932 for (i=0; i<enc->width*enc->height/64; i++)
933 gather_data_for_cel(tempData->cel_evals + i, enc, tempData);
935 /* Quake 3 can't handle chunks bigger than 65535 bytes */
936 if (tempData->mainChunkSize/8 > 65535 && enc->quake3_compat) {
937 if (enc->lambda > 100000) {
938 av_log(enc->avctx, AV_LOG_ERROR, "Cannot encode video in Quake compatible form\n");
939 return AVERROR(EINVAL);
941 av_log(enc->avctx, AV_LOG_ERROR,
942 "Warning, generated a frame too big for Quake (%d > 65535), "
943 "now switching to a bigger qscale value.\n",
944 tempData->mainChunkSize/8);
946 tempData->mainChunkSize = 0;
947 memset(tempData->used_option, 0, sizeof(tempData->used_option));
948 memset(tempData->codebooks.usedCB4, 0,
949 sizeof(tempData->codebooks.usedCB4));
950 memset(tempData->codebooks.usedCB2, 0,
951 sizeof(tempData->codebooks.usedCB2));
956 remap_codebooks(enc, tempData);
958 write_codebooks(enc, tempData);
960 reconstruct_and_encode_image(enc, tempData, enc->width, enc->height,
961 enc->width*enc->height/64);
963 av_frame_unref(enc->avctx->coded_frame);
964 av_frame_ref(enc->avctx->coded_frame, enc->current_frame);
966 /* Rotate frame history */
967 FFSWAP(AVFrame *, enc->current_frame, enc->last_frame);
968 FFSWAP(motion_vect *, enc->last_motion4, enc->this_motion4);
969 FFSWAP(motion_vect *, enc->last_motion8, enc->this_motion8);
971 av_freep(&tempData->cel_evals);
972 av_freep(&tempData->closest_cb2);
974 enc->framesSinceKeyframe++;
979 static av_cold int roq_encode_end(AVCodecContext *avctx)
981 RoqContext *enc = avctx->priv_data;
983 av_frame_free(&enc->current_frame);
984 av_frame_free(&enc->last_frame);
985 av_frame_free(&enc->avctx->coded_frame);
987 av_freep(&enc->tmpData);
988 av_freep(&enc->this_motion4);
989 av_freep(&enc->last_motion4);
990 av_freep(&enc->this_motion8);
991 av_freep(&enc->last_motion8);
996 static av_cold int roq_encode_init(AVCodecContext *avctx)
998 RoqContext *enc = avctx->priv_data;
1000 av_lfg_init(&enc->randctx, 1);
1004 enc->framesSinceKeyframe = 0;
1005 if ((avctx->width & 0xf) || (avctx->height & 0xf)) {
1006 av_log(avctx, AV_LOG_ERROR, "Dimensions must be divisible by 16\n");
1007 return AVERROR(EINVAL);
1010 if (avctx->width > 65535 || avctx->height > 65535) {
1011 av_log(avctx, AV_LOG_ERROR, "Dimensions are max %d\n", enc->quake3_compat ? 32768 : 65535);
1012 return AVERROR(EINVAL);
1015 if (((avctx->width)&(avctx->width-1))||((avctx->height)&(avctx->height-1)))
1016 av_log(avctx, AV_LOG_ERROR, "Warning: dimensions not power of two, this is not supported by quake\n");
1018 enc->width = avctx->width;
1019 enc->height = avctx->height;
1021 enc->framesSinceKeyframe = 0;
1022 enc->first_frame = 1;
1024 enc->last_frame = av_frame_alloc();
1025 enc->current_frame = av_frame_alloc();
1026 avctx->coded_frame = av_frame_alloc();
1027 if (!enc->last_frame || !enc->current_frame || !avctx->coded_frame) {
1028 roq_encode_end(avctx);
1029 return AVERROR(ENOMEM);
1032 enc->tmpData = av_malloc(sizeof(RoqTempdata));
1035 av_mallocz_array((enc->width*enc->height/16), sizeof(motion_vect));
1038 av_malloc_array ((enc->width*enc->height/16), sizeof(motion_vect));
1041 av_mallocz_array((enc->width*enc->height/64), sizeof(motion_vect));
1044 av_malloc_array ((enc->width*enc->height/64), sizeof(motion_vect));
1046 if (!enc->tmpData || !enc->this_motion4 || !enc->last_motion4 ||
1047 !enc->this_motion8 || !enc->last_motion8) {
1048 roq_encode_end(avctx);
1049 return AVERROR(ENOMEM);
1055 static void roq_write_video_info_chunk(RoqContext *enc)
1057 /* ROQ info chunk */
1058 bytestream_put_le16(&enc->out_buf, RoQ_INFO);
1061 bytestream_put_le32(&enc->out_buf, 8);
1063 /* Unused argument */
1064 bytestream_put_byte(&enc->out_buf, 0x00);
1065 bytestream_put_byte(&enc->out_buf, 0x00);
1068 bytestream_put_le16(&enc->out_buf, enc->width);
1071 bytestream_put_le16(&enc->out_buf, enc->height);
1073 /* Unused in Quake 3, mimics the output of the real encoder */
1074 bytestream_put_byte(&enc->out_buf, 0x08);
1075 bytestream_put_byte(&enc->out_buf, 0x00);
1076 bytestream_put_byte(&enc->out_buf, 0x04);
1077 bytestream_put_byte(&enc->out_buf, 0x00);
1080 static int roq_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
1081 const AVFrame *frame, int *got_packet)
1083 RoqContext *enc = avctx->priv_data;
1088 enc->frame_to_enc = frame;
1091 enc->lambda = frame->quality - 1;
1093 enc->lambda = 2*ROQ_LAMBDA_SCALE;
1095 /* 138 bits max per 8x8 block +
1096 * 256 codebooks*(6 bytes 2x2 + 4 bytes 4x4) + 8 bytes frame header */
1097 size = ((enc->width * enc->height / 64) * 138 + 7) / 8 + 256 * (6 + 4) + 8;
1098 if ((ret = ff_alloc_packet2(avctx, pkt, size)) < 0)
1100 enc->out_buf = pkt->data;
1102 /* Check for I frame */
1103 if (enc->framesSinceKeyframe == avctx->gop_size)
1104 enc->framesSinceKeyframe = 0;
1106 if (enc->first_frame) {
1107 /* Alloc memory for the reconstruction data (we must know the stride
1109 if ((ret = ff_get_buffer(avctx, enc->current_frame, 0)) < 0 ||
1110 (ret = ff_get_buffer(avctx, enc->last_frame, 0)) < 0)
1113 /* Before the first video frame, write a "video info" chunk */
1114 roq_write_video_info_chunk(enc);
1116 enc->first_frame = 0;
1119 /* Encode the actual frame */
1120 ret = roq_encode_video(enc);
1124 pkt->size = enc->out_buf - pkt->data;
1125 if (enc->framesSinceKeyframe == 1)
1126 pkt->flags |= AV_PKT_FLAG_KEY;
1132 #define OFFSET(x) offsetof(RoqContext, x)
1133 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
1134 static const AVOption options[] = {
1135 { "quake3_compat", "Whether to respect known limitations in Quake 3 decoder", OFFSET(quake3_compat), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, VE },
1139 static const AVClass roq_class = {
1140 .class_name = "RoQ",
1141 .item_name = av_default_item_name,
1143 .version = LIBAVUTIL_VERSION_INT,
1146 AVCodec ff_roq_encoder = {
1148 .long_name = NULL_IF_CONFIG_SMALL("id RoQ video"),
1149 .type = AVMEDIA_TYPE_VIDEO,
1150 .id = AV_CODEC_ID_ROQ,
1151 .priv_data_size = sizeof(RoqContext),
1152 .init = roq_encode_init,
1153 .encode2 = roq_encode_frame,
1154 .close = roq_encode_end,
1155 .pix_fmts = (const enum AVPixelFormat[]){ AV_PIX_FMT_YUVJ444P,
1157 .priv_class = &roq_class,