GCC Code Coverage Report
Directory: ../../../ffmpeg/ Exec Total Coverage
File: src/libavcodec/roqvideoenc.c Lines: 506 534 94.8 %
Date: 2021-04-18 10:33:33 Branches: 224 264 84.8 %

Line Branch Exec Source
1
/*
2
 * RoQ Video Encoder.
3
 *
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
7
 *
8
 * This file is part of FFmpeg.
9
 *
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.
14
 *
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.
19
 *
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
23
 */
24
25
/**
26
 * @file
27
 * id RoQ encoder by Vitor. Based on the Switchblade3 library and the
28
 * Switchblade3 FFmpeg glue by Eric Lasota.
29
 */
30
31
/*
32
 * COSTS:
33
 * Level 1:
34
 *  SKIP - 2 bits
35
 *  MOTION - 2 + 8 bits
36
 *  CODEBOOK - 2 + 8 bits
37
 *  SUBDIVIDE - 2 + combined subcel cost
38
 *
39
 * Level 2:
40
 *  SKIP - 2 bits
41
 *  MOTION - 2 + 8 bits
42
 *  CODEBOOK - 2 + 8 bits
43
 *  SUBDIVIDE - 2 + 4*8 bits
44
 *
45
 * Maximum cost: 138 bits per cel
46
 *
47
 * Proper evaluation requires LCD fraction comparison, which requires
48
 * Squared Error (SE) loss * savings increase
49
 *
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)
55
 */
56
57
#include <string.h>
58
59
#include "libavutil/attributes.h"
60
#include "libavutil/lfg.h"
61
#include "libavutil/opt.h"
62
#include "roqvideo.h"
63
#include "bytestream.h"
64
#include "elbg.h"
65
#include "internal.h"
66
#include "mathops.h"
67
68
#define CHROMA_BIAS 1
69
70
/**
71
 * Maximum number of generated 4x4 codebooks. Can't be 256 to workaround a
72
 * Quake 3 bug.
73
 */
74
#define MAX_CBS_4x4 256
75
76
#define MAX_CBS_2x2 256 ///< Maximum number of 2x2 codebooks.
77
78
/* The cast is useful when multiplying it by INT_MAX */
79
#define ROQ_LAMBDA_SCALE ((uint64_t) FF_LAMBDA_SCALE)
80
81
typedef struct RoqCodebooks {
82
    int numCB4;
83
    int numCB2;
84
    int usedCB2[MAX_CBS_2x2];
85
    int usedCB4[MAX_CBS_4x4];
86
    uint8_t unpacked_cb2[MAX_CBS_2x2*2*2*3];
87
    uint8_t unpacked_cb4[MAX_CBS_4x4*4*4*3];
88
    uint8_t unpacked_cb4_enlarged[MAX_CBS_4x4*8*8*3];
89
} RoqCodebooks;
90
91
/**
92
 * Temporary vars
93
 */
94
typedef struct RoqTempData
95
{
96
    int f2i4[MAX_CBS_4x4];
97
    int i2f4[MAX_CBS_4x4];
98
    int f2i2[MAX_CBS_2x2];
99
    int i2f2[MAX_CBS_2x2];
100
101
    int mainChunkSize;
102
103
    int numCB4;
104
    int numCB2;
105
106
    RoqCodebooks codebooks;
107
108
    int used_option[4];
109
} RoqTempData;
110
111
typedef struct SubcelEvaluation {
112
    int eval_dist[4];
113
    int best_bit_use;
114
    int best_coding;
115
116
    int subCels[4];
117
    motion_vect motion;
118
    int cbEntry;
119
} SubcelEvaluation;
120
121
typedef struct CelEvaluation {
122
    int eval_dist[4];
123
    int best_coding;
124
125
    SubcelEvaluation subCels[4];
126
127
    motion_vect motion;
128
    int cbEntry;
129
130
    int sourceX, sourceY;
131
} CelEvaluation;
132
133
typedef struct RoqEncContext {
134
    RoqContext common;
135
    AVLFG randctx;
136
    uint64_t lambda;
137
138
    motion_vect *this_motion4;
139
    motion_vect *last_motion4;
140
141
    motion_vect *this_motion8;
142
    motion_vect *last_motion8;
143
144
    unsigned int framesSinceKeyframe;
145
146
    const AVFrame *frame_to_enc;
147
    uint8_t *out_buf;
148
    RoqTempData tmp_data;
149
    roq_cell results4[4 * MAX_CBS_4x4];
150
    int tmp_codebook_buf[FFMAX(24 * MAX_CBS_4x4, 6 * MAX_CBS_2x2)];
151
152
    CelEvaluation *cel_evals;
153
    int *closest_cb;
154
    int *points;  // Allocated together with closest_cb
155
156
    int first_frame;
157
    int quake3_compat; // Quake 3 compatibility option
158
} RoqEncContext;
159
160
/* Macroblock support functions */
161
26796
static void unpack_roq_cell(roq_cell *cell, uint8_t u[4*3])
162
{
163
26796
    memcpy(u  , cell->y, 4);
164
26796
    memset(u+4, cell->u, 4);
165
26796
    memset(u+8, cell->v, 4);
166
26796
}
167
168
5355
static void unpack_roq_qcell(uint8_t cb2[], roq_qcell *qcell, uint8_t u[4*4*3])
169
{
170
    int i,cp;
171
    static const int offsets[4] = {0, 2, 8, 10};
172
173
21420
    for (cp=0; cp<3; cp++)
174
80325
        for (i=0; i<4; i++) {
175
64260
            u[4*4*cp + offsets[i]  ] = cb2[qcell->idx[i]*2*2*3 + 4*cp  ];
176
64260
            u[4*4*cp + offsets[i]+1] = cb2[qcell->idx[i]*2*2*3 + 4*cp+1];
177
64260
            u[4*4*cp + offsets[i]+4] = cb2[qcell->idx[i]*2*2*3 + 4*cp+2];
178
64260
            u[4*4*cp + offsets[i]+5] = cb2[qcell->idx[i]*2*2*3 + 4*cp+3];
179
        }
180
5355
}
181
182
183
5355
static void enlarge_roq_mb4(uint8_t base[3*16], uint8_t u[3*64])
184
{
185
    int x,y,cp;
186
187
21420
    for(cp=0; cp<3; cp++)
188
144585
        for(y=0; y<8; y++)
189
1156680
            for(x=0; x<8; x++)
190
1028160
                *u++ = base[(y/2)*4 + (x/2) + 16*cp];
191
5355
}
192
193
5107919472
static inline int square(int x)
194
{
195
5107919472
    return x*x;
196
}
197
198
260413116
static inline int eval_sse(const uint8_t *a, const uint8_t *b, int count)
199
{
200
260413116
    int diff=0;
201
202
5368332588
    while(count--)
203
5107919472
        diff += square(*b++ - *a++);
204
205
260413116
    return diff;
206
}
207
208
// FIXME Could use DSPContext.sse, but it is not so speed critical (used
209
// just for motion estimation).
210
3971991
static int block_sse(uint8_t * const *buf1, uint8_t * const *buf2, int x1, int y1,
211
                     int x2, int y2, const int *stride1, const int *stride2, int size)
212
{
213
    int i, k;
214
3971991
    int sse=0;
215
216
15887964
    for (k=0; k<3; k++) {
217
11915973
        int bias = (k ? CHROMA_BIAS : 4);
218
68673201
        for (i=0; i<size; i++)
219
56757228
            sse += bias*eval_sse(buf1[k] + (y1+i)*stride1[k] + x1,
220
56757228
                                 buf2[k] + (y2+i)*stride2[k] + x2, size);
221
    }
222
223
3971991
    return sse;
224
}
225
226
3880940
static int eval_motion_dist(RoqEncContext *enc, int x, int y, motion_vect vect,
227
                             int size)
228
{
229
3880940
    RoqContext *const roq = &enc->common;
230
3880940
    int mx=vect.d[0];
231
3880940
    int my=vect.d[1];
232
233

3880940
    if (mx < -7 || mx > 7)
234
14964
        return INT_MAX;
235
236

3865976
    if (my < -7 || my > 7)
237
12346
        return INT_MAX;
238
239
3853630
    mx += x;
240
3853630
    my += y;
241
242

3853630
    if ((unsigned) mx > roq->width-size || (unsigned) my > roq->height-size)
243
34839
        return INT_MAX;
244
245
3818791
    return block_sse(enc->frame_to_enc->data, roq->last_frame->data, x, y,
246
                     mx, my,
247
3818791
                     enc->frame_to_enc->linesize, roq->last_frame->linesize,
248
                     size);
249
}
250
251
/**
252
 * @return distortion between two macroblocks
253
 */
254
67885296
static inline int squared_diff_macroblock(uint8_t a[], uint8_t b[], int size)
255
{
256
67885296
    int cp, sdiff=0;
257
258
271541184
    for(cp=0;cp<3;cp++) {
259
203655888
        int bias = (cp ? CHROMA_BIAS : 4);
260
203655888
        sdiff += bias*eval_sse(a, b, size*size);
261
203655888
        a += size*size;
262
203655888
        b += size*size;
263
    }
264
265
67885296
    return sdiff;
266
}
267
268
/**
269
 * Initialize cel evaluators and set their source coordinates
270
 */
271
4
static int create_cel_evals(RoqEncContext *enc)
272
{
273
4
    RoqContext *const roq = &enc->common;
274
275
4
    enc->cel_evals = av_malloc_array(roq->width * roq->height / 64, sizeof(CelEvaluation));
276
4
    if (!enc->cel_evals)
277
        return AVERROR(ENOMEM);
278
279
    /* Map to the ROQ quadtree order */
280
90
    for (int y = 0, n = 0; y < roq->height; y += 16)
281
2298
        for (int x = 0; x < roq->width; x += 16)
282
11060
            for(int i = 0; i < 4; i++) {
283
8848
                enc->cel_evals[n  ].sourceX = x + (i&1)*8;
284
8848
                enc->cel_evals[n++].sourceY = y + (i&2)*4;
285
            }
286
287
4
    return 0;
288
}
289
290
/**
291
 * Get macroblocks from parts of the image
292
 */
293
1015056
static void get_frame_mb(const AVFrame *frame, int x, int y, uint8_t mb[], int dim)
294
{
295
    int i, j, cp;
296
297
4060224
    for (cp=0; cp<3; cp++) {
298
3045168
        int stride = frame->linesize[cp];
299
11165616
        for (i=0; i<dim; i++)
300
35961984
            for (j=0; j<dim; j++)
301
27841536
                *mb++ = frame->data[cp][(y+i)*stride + x + j];
302
    }
303
1015056
}
304
305
/**
306
 * Find the codebook with the lowest distortion from an image
307
 */
308
263100
static int index_mb(uint8_t cluster[], uint8_t cb[], int numCB,
309
                    int *outIndex, int dim)
310
{
311
263100
    int i, lDiff = INT_MAX, pick=0;
312
313
    /* Diff against the others */
314
67375020
    for (i=0; i<numCB; i++) {
315
67111920
        int diff = squared_diff_macroblock(cluster, cb + i*dim*dim*3, dim);
316
67111920
        if (diff < lDiff) {
317
1698384
            lDiff = diff;
318
1698384
            pick = i;
319
        }
320
    }
321
322
263100
    *outIndex = pick;
323
263100
    return lDiff;
324
}
325
326
#define EVAL_MOTION(MOTION) \
327
    do { \
328
        diff = eval_motion_dist(enc, j, i, MOTION, blocksize); \
329
            \
330
        if (diff < lowestdiff) { \
331
            lowestdiff = diff; \
332
            bestpick = MOTION; \
333
        } \
334
    } while(0)
335
336
34
static void motion_search(RoqEncContext *enc, int blocksize)
337
{
338
    static const motion_vect offsets[8] = {
339
        {{ 0,-1}},
340
        {{ 0, 1}},
341
        {{-1, 0}},
342
        {{ 1, 0}},
343
        {{-1, 1}},
344
        {{ 1,-1}},
345
        {{-1,-1}},
346
        {{ 1, 1}},
347
    };
348
349
34
    RoqContext *const roq = &enc->common;
350
    int diff, lowestdiff, oldbest;
351
    int off[3];
352
34
    motion_vect bestpick = {{0,0}};
353
    int i, j, k, offset;
354
355
    motion_vect *last_motion;
356
    motion_vect *this_motion;
357
    motion_vect vect, vect2;
358
34
    const int max = (roq->width / blocksize) * roq->height / blocksize;
359
360
34
    if (blocksize == 4) {
361
17
        last_motion = enc->last_motion4;
362
17
        this_motion = enc->this_motion4;
363
    } else {
364
17
        last_motion = enc->last_motion8;
365
17
        this_motion = enc->this_motion8;
366
    }
367
368
2290
    for (i = 0; i< roq->height; i += blocksize)
369
199696
        for (j = 0; j < roq->width; j += blocksize) {
370
197440
            lowestdiff = eval_motion_dist(enc, j, i, (motion_vect) {{0,0}},
371
                                          blocksize);
372
197440
            bestpick.d[0] = 0;
373
197440
            bestpick.d[1] = 0;
374
375
197440
            if (blocksize == 4)
376
157952
                EVAL_MOTION(enc->this_motion8[(i/8) * (roq->width/8) + j/8]);
377
378
197440
            offset = (i/blocksize) * roq->width / blocksize + j / blocksize;
379

197440
            if (offset < max && offset >= 0)
380
197440
                EVAL_MOTION(last_motion[offset]);
381
382
197440
            offset++;
383

197440
            if (offset < max && offset >= 0)
384
197406
                EVAL_MOTION(last_motion[offset]);
385
386
197440
            offset = (i/blocksize + 1) * roq->width / blocksize + j / blocksize;
387

197440
            if (offset < max && offset >= 0)
388
194896
                EVAL_MOTION(last_motion[offset]);
389
390
197440
            off[0]= (i/blocksize) * roq->width / blocksize + j/blocksize - 1;
391
197440
            off[1]= off[0] - roq->width / blocksize + 1;
392
197440
            off[2]= off[1] + 1;
393
394
197440
            if (i) {
395
396
584688
                for(k=0; k<2; k++)
397
389792
                    vect.d[k]= mid_pred(this_motion[off[0]].d[k],
398
389792
                                        this_motion[off[1]].d[k],
399
389792
                                        this_motion[off[2]].d[k]);
400
401
194896
                EVAL_MOTION(vect);
402
779584
                for(k=0; k<3; k++)
403
584688
                    EVAL_MOTION(this_motion[off[k]]);
404
2544
            } else if(j)
405
2510
                EVAL_MOTION(this_motion[off[0]]);
406
407
197440
            vect = bestpick;
408
409
197440
            oldbest = -1;
410
441974
            while (oldbest != lowestdiff) {
411
244534
                oldbest = lowestdiff;
412
2200806
                for (k=0; k<8; k++) {
413
1956272
                    vect2 = vect;
414
1956272
                    vect2.d[0] += offsets[k].d[0];
415
1956272
                    vect2.d[1] += offsets[k].d[1];
416
1956272
                    EVAL_MOTION(vect2);
417
                }
418
244534
                vect = bestpick;
419
            }
420
197440
            offset = (i/blocksize) * roq->width / blocksize + j/blocksize;
421
197440
            this_motion[offset] = bestpick;
422
        }
423
34
}
424
425
/**
426
 * Get distortion for all options available to a subcel
427
 */
428
193344
static void gather_data_for_subcel(SubcelEvaluation *subcel, int x,
429
                                   int y, RoqEncContext *enc)
430
{
431
193344
    RoqContext *const roq = &enc->common;
432
193344
    RoqTempData *const tempData = &enc->tmp_data;
433
    uint8_t mb4[4*4*3];
434
    uint8_t mb2[2*2*3];
435
    int cluster_index;
436
    int i, best_dist;
437
438
    static const int bitsUsed[4] = {2, 10, 10, 34};
439
440
193344
    if (enc->framesSinceKeyframe >= 1) {
441
157952
        subcel->motion = enc->this_motion4[y * roq->width / 16 + x / 4];
442
443
157952
        subcel->eval_dist[RoQ_ID_FCC] =
444
157952
            eval_motion_dist(enc, x, y,
445
157952
                             enc->this_motion4[y * roq->width / 16 + x / 4], 4);
446
    } else
447
35392
        subcel->eval_dist[RoQ_ID_FCC] = INT_MAX;
448
449
193344
    if (enc->framesSinceKeyframe >= 2)
450
122560
        subcel->eval_dist[RoQ_ID_MOT] = block_sse(enc->frame_to_enc->data,
451
122560
                                                  roq->current_frame->data, x,
452
                                                  y, x, y,
453
122560
                                                  enc->frame_to_enc->linesize,
454
122560
                                                  roq->current_frame->linesize,
455
                                                  4);
456
    else
457
70784
        subcel->eval_dist[RoQ_ID_MOT] = INT_MAX;
458
459
193344
    cluster_index = y * roq->width / 16 + x / 4;
460
461
193344
    get_frame_mb(enc->frame_to_enc, x, y, mb4, 4);
462
463
386688
    subcel->eval_dist[RoQ_ID_SLD] = index_mb(mb4,
464
193344
                                             tempData->codebooks.unpacked_cb4,
465
                                             tempData->codebooks.numCB4,
466
                                             &subcel->cbEntry, 4);
467
468
193344
    subcel->eval_dist[RoQ_ID_CCC] = 0;
469
470
966720
    for(i=0;i<4;i++) {
471
773376
        subcel->subCels[i] = enc->closest_cb[cluster_index*4+i];
472
473
773376
        get_frame_mb(enc->frame_to_enc, x+2*(i&1),
474
773376
                     y+(i&2), mb2, 2);
475
476
773376
        subcel->eval_dist[RoQ_ID_CCC] +=
477
773376
            squared_diff_macroblock(tempData->codebooks.unpacked_cb2 + subcel->subCels[i]*2*2*3, mb2, 2);
478
    }
479
480
193344
    best_dist = INT_MAX;
481
966720
    for (i=0; i<4; i++)
482
773376
        if (ROQ_LAMBDA_SCALE*subcel->eval_dist[i] + enc->lambda*bitsUsed[i] <
483
            best_dist) {
484
353674
            subcel->best_coding = i;
485
353674
            subcel->best_bit_use = bitsUsed[i];
486
353674
            best_dist = ROQ_LAMBDA_SCALE*subcel->eval_dist[i] +
487
353674
                enc->lambda*bitsUsed[i];
488
        }
489
193344
}
490
491
/**
492
 * Get distortion for all options available to a cel
493
 */
494
48336
static void gather_data_for_cel(CelEvaluation *cel, RoqEncContext *enc)
495
{
496
48336
    RoqContext *const roq = &enc->common;
497
48336
    RoqTempData *const tempData = &enc->tmp_data;
498
    uint8_t mb8[8*8*3];
499
48336
    int index = cel->sourceY * roq->width / 64 + cel->sourceX/8;
500
    int i, j, best_dist, divide_bit_use;
501
502
48336
    int bitsUsed[4] = {2, 10, 10, 0};
503
504
48336
    if (enc->framesSinceKeyframe >= 1) {
505
39488
        cel->motion = enc->this_motion8[index];
506
507
39488
        cel->eval_dist[RoQ_ID_FCC] =
508
39488
            eval_motion_dist(enc, cel->sourceX, cel->sourceY,
509
39488
                             enc->this_motion8[index], 8);
510
    } else
511
8848
        cel->eval_dist[RoQ_ID_FCC] = INT_MAX;
512
513
48336
    if (enc->framesSinceKeyframe >= 2)
514
30640
        cel->eval_dist[RoQ_ID_MOT] = block_sse(enc->frame_to_enc->data,
515
30640
                                               roq->current_frame->data,
516
                                               cel->sourceX, cel->sourceY,
517
                                               cel->sourceX, cel->sourceY,
518
30640
                                               enc->frame_to_enc->linesize,
519
30640
                                               roq->current_frame->linesize,8);
520
    else
521
17696
        cel->eval_dist[RoQ_ID_MOT] = INT_MAX;
522
523
48336
    get_frame_mb(enc->frame_to_enc, cel->sourceX, cel->sourceY, mb8, 8);
524
525
48336
    cel->eval_dist[RoQ_ID_SLD] =
526
48336
        index_mb(mb8, tempData->codebooks.unpacked_cb4_enlarged,
527
                 tempData->codebooks.numCB4, &cel->cbEntry, 8);
528
529
48336
    gather_data_for_subcel(cel->subCels + 0, cel->sourceX+0, cel->sourceY+0, enc);
530
48336
    gather_data_for_subcel(cel->subCels + 1, cel->sourceX+4, cel->sourceY+0, enc);
531
48336
    gather_data_for_subcel(cel->subCels + 2, cel->sourceX+0, cel->sourceY+4, enc);
532
48336
    gather_data_for_subcel(cel->subCels + 3, cel->sourceX+4, cel->sourceY+4, enc);
533
534
48336
    cel->eval_dist[RoQ_ID_CCC] = 0;
535
48336
    divide_bit_use = 0;
536
241680
    for (i=0; i<4; i++) {
537
193344
        cel->eval_dist[RoQ_ID_CCC] +=
538
193344
            cel->subCels[i].eval_dist[cel->subCels[i].best_coding];
539
193344
        divide_bit_use += cel->subCels[i].best_bit_use;
540
    }
541
542
48336
    best_dist = INT_MAX;
543
48336
    bitsUsed[3] = 2 + divide_bit_use;
544
545
241680
    for (i=0; i<4; i++)
546
193344
        if (ROQ_LAMBDA_SCALE*cel->eval_dist[i] + enc->lambda*bitsUsed[i] <
547
            best_dist) {
548
102893
            cel->best_coding = i;
549
102893
            best_dist = ROQ_LAMBDA_SCALE*cel->eval_dist[i] +
550
102893
                enc->lambda*bitsUsed[i];
551
        }
552
553
48336
    tempData->used_option[cel->best_coding]++;
554
48336
    tempData->mainChunkSize += bitsUsed[cel->best_coding];
555
556
48336
    if (cel->best_coding == RoQ_ID_SLD)
557
2641
        tempData->codebooks.usedCB4[cel->cbEntry]++;
558
559
48336
    if (cel->best_coding == RoQ_ID_CCC)
560
159225
        for (i=0; i<4; i++) {
561
127380
            if (cel->subCels[i].best_coding == RoQ_ID_SLD)
562
5734
                tempData->codebooks.usedCB4[cel->subCels[i].cbEntry]++;
563
121646
            else if (cel->subCels[i].best_coding == RoQ_ID_CCC)
564
328190
                for (j=0; j<4; j++)
565
262552
                    tempData->codebooks.usedCB2[cel->subCels[i].subCels[j]]++;
566
        }
567
48336
}
568
569
21
static void remap_codebooks(RoqEncContext *enc)
570
{
571
21
    RoqContext *const roq = &enc->common;
572
21
    RoqTempData *const tempData = &enc->tmp_data;
573
21
    int i, j, idx=0;
574
575
    /* Make remaps for the final codebook usage */
576

5376
    for (i=0; i<(enc->quake3_compat ? MAX_CBS_4x4-1 : MAX_CBS_4x4); i++) {
577
5355
        if (tempData->codebooks.usedCB4[i]) {
578
1635
            tempData->i2f4[i] = idx;
579
1635
            tempData->f2i4[idx] = i;
580
8175
            for (j=0; j<4; j++)
581
6540
                tempData->codebooks.usedCB2[roq->cb4x4[i].idx[j]]++;
582
1635
            idx++;
583
        }
584
    }
585
586
21
    tempData->numCB4 = idx;
587
588
21
    idx = 0;
589
5397
    for (i=0; i<MAX_CBS_2x2; i++) {
590
5376
        if (tempData->codebooks.usedCB2[i]) {
591
5375
            tempData->i2f2[i] = idx;
592
5375
            tempData->f2i2[idx] = i;
593
5375
            idx++;
594
        }
595
    }
596
21
    tempData->numCB2 = idx;
597
598
21
}
599
600
/**
601
 * Write codebook chunk
602
 */
603
21
static void write_codebooks(RoqEncContext *enc)
604
{
605
21
    RoqContext *const roq = &enc->common;
606
21
    RoqTempData *const tempData = &enc->tmp_data;
607
    int i, j;
608
21
    uint8_t **outp= &enc->out_buf;
609
610
21
    if (tempData->numCB2) {
611
21
        bytestream_put_le16(outp, RoQ_QUAD_CODEBOOK);
612
21
        bytestream_put_le32(outp, tempData->numCB2*6 + tempData->numCB4*4);
613
21
        bytestream_put_byte(outp, tempData->numCB4);
614
21
        bytestream_put_byte(outp, tempData->numCB2);
615
616
5396
        for (i=0; i<tempData->numCB2; i++) {
617
5375
            bytestream_put_buffer(outp, roq->cb2x2[tempData->f2i2[i]].y, 4);
618
5375
            bytestream_put_byte(outp, roq->cb2x2[tempData->f2i2[i]].u);
619
5375
            bytestream_put_byte(outp, roq->cb2x2[tempData->f2i2[i]].v);
620
        }
621
622
1656
        for (i=0; i<tempData->numCB4; i++)
623
8175
            for (j=0; j<4; j++)
624
6540
                bytestream_put_byte(outp, tempData->i2f2[roq->cb4x4[tempData->f2i4[i]].idx[j]]);
625
626
    }
627
21
}
628
629
59269
static inline uint8_t motion_arg(motion_vect mot)
630
{
631
59269
    uint8_t ax = 8 - ((uint8_t) mot.d[0]);
632
59269
    uint8_t ay = 8 - ((uint8_t) mot.d[1]);
633
59269
    return ((ax&15)<<4) | (ay&15);
634
}
635
636
typedef struct CodingSpool {
637
    int typeSpool;
638
    int typeSpoolLength;
639
    uint8_t argumentSpool[64];
640
    uint8_t *args;
641
    uint8_t **pout;
642
} CodingSpool;
643
644
/* NOTE: Typecodes must be spooled AFTER arguments!! */
645
175760
static void write_typecode(CodingSpool *s, uint8_t type)
646
{
647
175760
    s->typeSpool |= (type & 3) << (14 - s->typeSpoolLength);
648
175760
    s->typeSpoolLength += 2;
649
175760
    if (s->typeSpoolLength == 16) {
650
21970
        bytestream_put_le16(s->pout, s->typeSpool);
651
21970
        bytestream_put_buffer(s->pout, s->argumentSpool,
652
21970
                              s->args - s->argumentSpool);
653
21970
        s->typeSpoolLength = 0;
654
21970
        s->typeSpool = 0;
655
21970
        s->args = s->argumentSpool;
656
    }
657
175760
}
658
659
21
static void reconstruct_and_encode_image(RoqEncContext *enc,
660
                                         int w, int h, int numBlocks)
661
{
662
21
    RoqContext *const roq = &enc->common;
663
21
    RoqTempData *const tempData = &enc->tmp_data;
664
    int i, j, k;
665
    int x, y;
666
    int subX, subY;
667
21
    int dist=0;
668
669
    roq_qcell *qcell;
670
    CelEvaluation *eval;
671
672
    CodingSpool spool;
673
674
21
    spool.typeSpool=0;
675
21
    spool.typeSpoolLength=0;
676
21
    spool.args = spool.argumentSpool;
677
21
    spool.pout = &enc->out_buf;
678
679
21
    if (tempData->used_option[RoQ_ID_CCC]%2)
680
11
        tempData->mainChunkSize+=8; //FIXME
681
682
    /* Write the video chunk header */
683
21
    bytestream_put_le16(&enc->out_buf, RoQ_QUAD_VQ);
684
21
    bytestream_put_le32(&enc->out_buf, tempData->mainChunkSize/8);
685
21
    bytestream_put_byte(&enc->out_buf, 0x0);
686
21
    bytestream_put_byte(&enc->out_buf, 0x0);
687
688
48357
    for (i=0; i<numBlocks; i++) {
689
48336
        eval = enc->cel_evals + i;
690
691
48336
        x = eval->sourceX;
692
48336
        y = eval->sourceY;
693
48336
        dist += eval->eval_dist[eval->best_coding];
694
695

48336
        switch (eval->best_coding) {
696
10068
        case RoQ_ID_MOT:
697
10068
            write_typecode(&spool, RoQ_ID_MOT);
698
10068
            break;
699
700
3782
        case RoQ_ID_FCC:
701
3782
            bytestream_put_byte(&spool.args, motion_arg(eval->motion));
702
703
3782
            write_typecode(&spool, RoQ_ID_FCC);
704
3782
            ff_apply_motion_8x8(roq, x, y,
705
                                eval->motion.d[0], eval->motion.d[1]);
706
3782
            break;
707
708
2641
        case RoQ_ID_SLD:
709
2641
            bytestream_put_byte(&spool.args, tempData->i2f4[eval->cbEntry]);
710
2641
            write_typecode(&spool, RoQ_ID_SLD);
711
712
2641
            qcell = roq->cb4x4 + eval->cbEntry;
713
2641
            ff_apply_vector_4x4(roq, x  , y  , roq->cb2x2 + qcell->idx[0]);
714
2641
            ff_apply_vector_4x4(roq, x+4, y  , roq->cb2x2 + qcell->idx[1]);
715
2641
            ff_apply_vector_4x4(roq, x  , y+4, roq->cb2x2 + qcell->idx[2]);
716
2641
            ff_apply_vector_4x4(roq, x+4, y+4, roq->cb2x2 + qcell->idx[3]);
717
2641
            break;
718
719
31845
        case RoQ_ID_CCC:
720
31845
            write_typecode(&spool, RoQ_ID_CCC);
721
722
159225
            for (j=0; j<4; j++) {
723
127380
                subX = x + 4*(j&1);
724
127380
                subY = y + 2*(j&2);
725
726

127380
                switch(eval->subCels[j].best_coding) {
727
521
                case RoQ_ID_MOT:
728
521
                    break;
729
730
55487
                case RoQ_ID_FCC:
731
55487
                    bytestream_put_byte(&spool.args,
732
55487
                                        motion_arg(eval->subCels[j].motion));
733
734
55487
                    ff_apply_motion_4x4(roq, subX, subY,
735
                                        eval->subCels[j].motion.d[0],
736
                                        eval->subCels[j].motion.d[1]);
737
55487
                    break;
738
739
5734
                case RoQ_ID_SLD:
740
5734
                    bytestream_put_byte(&spool.args,
741
5734
                                        tempData->i2f4[eval->subCels[j].cbEntry]);
742
743
5734
                    qcell = roq->cb4x4 + eval->subCels[j].cbEntry;
744
745
5734
                    ff_apply_vector_2x2(roq, subX  , subY  ,
746
5734
                                        roq->cb2x2 + qcell->idx[0]);
747
5734
                    ff_apply_vector_2x2(roq, subX+2, subY  ,
748
5734
                                        roq->cb2x2 + qcell->idx[1]);
749
5734
                    ff_apply_vector_2x2(roq, subX  , subY+2,
750
5734
                                        roq->cb2x2 + qcell->idx[2]);
751
5734
                    ff_apply_vector_2x2(roq, subX+2, subY+2,
752
5734
                                        roq->cb2x2 + qcell->idx[3]);
753
5734
                    break;
754
755
65638
                case RoQ_ID_CCC:
756
328190
                    for (k=0; k<4; k++) {
757
262552
                        int cb_idx = eval->subCels[j].subCels[k];
758
262552
                        bytestream_put_byte(&spool.args,
759
262552
                                            tempData->i2f2[cb_idx]);
760
761
262552
                        ff_apply_vector_2x2(roq, subX + 2*(k&1), subY + (k&2),
762
262552
                                            roq->cb2x2 + cb_idx);
763
                    }
764
65638
                    break;
765
                }
766
127380
                write_typecode(&spool, eval->subCels[j].best_coding);
767
            }
768
31845
            break;
769
        }
770
48336
    }
771
772
    /* Flush the remainder of the argument/type spool */
773
65
    while (spool.typeSpoolLength)
774
44
        write_typecode(&spool, 0x0);
775
21
}
776
777
778
/**
779
 * Create a single YUV cell from a 2x2 section of the image
780
 */
781
773376
static inline void frame_block_to_cell(int *block, uint8_t * const *data,
782
                                       int top, int left, const int *stride)
783
{
784
773376
    int i, j, u=0, v=0;
785
786
2320128
    for (i=0; i<2; i++)
787
4640256
        for (j=0; j<2; j++) {
788
3093504
            int x = (top+i)*stride[0] + left + j;
789
3093504
            *block++ = data[0][x];
790
3093504
            x = (top+i)*stride[1] + left + j;
791
3093504
            u       += data[1][x];
792
3093504
            v       += data[2][x];
793
        }
794
795
773376
    *block++ = (u + 2) / 4 * CHROMA_BIAS;
796
773376
    *block++ = (v + 2) / 4 * CHROMA_BIAS;
797
773376
}
798
799
/**
800
 * Create YUV clusters for the entire image
801
 */
802
21
static void create_clusters(const AVFrame *frame, int w, int h, int *points)
803
{
804
    int i, j, k, l;
805
806
1869
    for (i=0; i<h; i+=4)
807
195192
        for (j=0; j<w; j+=4) {
808
580032
            for (k=0; k < 2; k++)
809
1160064
                for (l=0; l < 2; l++)
810
773376
                    frame_block_to_cell(points + (l + 2*k)*6, frame->data,
811
773376
                                        i+2*k, j+2*l, frame->linesize);
812
193344
            points += 24;
813
        }
814
21
}
815
816
42
static int generate_codebook(RoqEncContext *enc,
817
                             int *points, int inputCount, roq_cell *results,
818
                             int size, int cbsize)
819
{
820
42
    int i, j, k, ret = 0;
821
42
    int c_size = size*size/4;
822
    int *buf;
823
42
    int *codebook = enc->tmp_codebook_buf;
824
42
    int *closest_cb = enc->closest_cb;
825
826
42
    ret = avpriv_init_elbg(points, 6 * c_size, inputCount, codebook,
827
                       cbsize, 1, closest_cb, &enc->randctx);
828
42
    if (ret < 0)
829
        return ret;
830
42
    ret = avpriv_do_elbg(points, 6 * c_size, inputCount, codebook,
831
                     cbsize, 1, closest_cb, &enc->randctx);
832
42
    if (ret < 0)
833
        return ret;
834
835
42
    buf = codebook;
836
10773
    for (i=0; i<cbsize; i++)
837
37527
        for (k=0; k<c_size; k++) {
838
133980
            for(j=0; j<4; j++)
839
107184
                results->y[j] = *buf++;
840
841
26796
            results->u =    (*buf++ + CHROMA_BIAS/2)/CHROMA_BIAS;
842
26796
            results->v =    (*buf++ + CHROMA_BIAS/2)/CHROMA_BIAS;
843
26796
            results++;
844
        }
845
42
    return 0;
846
}
847
848
21
static int generate_new_codebooks(RoqEncContext *enc)
849
{
850
21
    int i, j, ret = 0;
851
21
    RoqCodebooks *codebooks = &enc->tmp_data.codebooks;
852
21
    RoqContext *const roq = &enc->common;
853
21
    int max = roq->width * roq->height / 16;
854
    uint8_t mb2[3*4];
855
21
    int *points = enc->points;
856
857
    /* Subsample YUV data */
858
21
    create_clusters(enc->frame_to_enc, roq->width, roq->height, points);
859
860
21
    codebooks->numCB4 = (enc->quake3_compat ? MAX_CBS_4x4-1 : MAX_CBS_4x4);
861
862
    /* Create 4x4 codebooks */
863
21
    if ((ret = generate_codebook(enc, points, max, enc->results4,
864
                                 4, codebooks->numCB4)) < 0)
865
        return ret;
866
867
    /* Create 2x2 codebooks */
868
21
    if ((ret = generate_codebook(enc, points, max * 4,
869
21
                                 roq->cb2x2, 2, MAX_CBS_2x2)) < 0)
870
        return ret;
871
872
21
    codebooks->numCB2 = MAX_CBS_2x2;
873
874
    /* Unpack 2x2 codebook clusters */
875
5397
    for (i=0; i<codebooks->numCB2; i++)
876
5376
        unpack_roq_cell(roq->cb2x2 + i, codebooks->unpacked_cb2 + i*2*2*3);
877
878
    /* Index all 4x4 entries to the 2x2 entries, unpack, and enlarge */
879
5376
    for (i=0; i<codebooks->numCB4; i++) {
880
26775
        for (j=0; j<4; j++) {
881
21420
            unpack_roq_cell(&enc->results4[4*i + j], mb2);
882
21420
            index_mb(mb2, codebooks->unpacked_cb2, codebooks->numCB2,
883
                     &roq->cb4x4[i].idx[j], 2);
884
        }
885
5355
        unpack_roq_qcell(codebooks->unpacked_cb2, roq->cb4x4 + i,
886
5355
                         codebooks->unpacked_cb4 + i*4*4*3);
887
5355
        enlarge_roq_mb4(codebooks->unpacked_cb4 + i*4*4*3,
888
5355
                        codebooks->unpacked_cb4_enlarged + i*8*8*3);
889
    }
890
891
21
    return 0;
892
}
893
894
21
static int roq_encode_video(RoqEncContext *enc)
895
{
896
21
    RoqTempData *const tempData = &enc->tmp_data;
897
21
    RoqContext *const roq = &enc->common;
898
    int ret;
899
900
21
    memset(tempData, 0, sizeof(*tempData));
901
902
21
    ret = generate_new_codebooks(enc);
903
21
    if (ret < 0)
904
        return ret;
905
906
21
    if (enc->framesSinceKeyframe >= 1) {
907
17
        motion_search(enc, 8);
908
17
        motion_search(enc, 4);
909
    }
910
911
4
 retry_encode:
912
48357
    for (int i = 0; i < roq->width * roq->height / 64; i++)
913
48336
        gather_data_for_cel(enc->cel_evals + i, enc);
914
915
    /* Quake 3 can't handle chunks bigger than 65535 bytes */
916

21
    if (tempData->mainChunkSize/8 > 65535 && enc->quake3_compat) {
917
        if (enc->lambda > 100000) {
918
            av_log(roq->avctx, AV_LOG_ERROR, "Cannot encode video in Quake compatible form\n");
919
            return AVERROR(EINVAL);
920
        }
921
        av_log(roq->avctx, AV_LOG_ERROR,
922
               "Warning, generated a frame too big for Quake (%d > 65535), "
923
               "now switching to a bigger qscale value.\n",
924
               tempData->mainChunkSize/8);
925
        enc->lambda *= 1.5;
926
        tempData->mainChunkSize = 0;
927
        memset(tempData->used_option, 0, sizeof(tempData->used_option));
928
        memset(tempData->codebooks.usedCB4, 0,
929
               sizeof(tempData->codebooks.usedCB4));
930
        memset(tempData->codebooks.usedCB2, 0,
931
               sizeof(tempData->codebooks.usedCB2));
932
933
        goto retry_encode;
934
    }
935
936
21
    remap_codebooks(enc);
937
938
21
    write_codebooks(enc);
939
940
21
    reconstruct_and_encode_image(enc, roq->width, roq->height,
941
21
                                 roq->width * roq->height / 64);
942
943
    /* Rotate frame history */
944
21
    FFSWAP(AVFrame *,    roq->current_frame,   roq->last_frame);
945
21
    FFSWAP(motion_vect *, enc->last_motion4, enc->this_motion4);
946
21
    FFSWAP(motion_vect *, enc->last_motion8, enc->this_motion8);
947
948
21
    enc->framesSinceKeyframe++;
949
950
21
    return 0;
951
}
952
953
4
static av_cold int roq_encode_end(AVCodecContext *avctx)
954
{
955
4
    RoqEncContext *const enc = avctx->priv_data;
956
957
4
    av_frame_free(&enc->common.current_frame);
958
4
    av_frame_free(&enc->common.last_frame);
959
960
4
    av_freep(&enc->cel_evals);
961
4
    av_freep(&enc->closest_cb);
962
4
    av_freep(&enc->this_motion4);
963
4
    av_freep(&enc->last_motion4);
964
4
    av_freep(&enc->this_motion8);
965
4
    av_freep(&enc->last_motion8);
966
967
4
    return 0;
968
}
969
970
4
static av_cold int roq_encode_init(AVCodecContext *avctx)
971
{
972
4
    RoqEncContext *const enc = avctx->priv_data;
973
4
    RoqContext    *const roq = &enc->common;
974
975
4
    av_lfg_init(&enc->randctx, 1);
976
977
4
    roq->avctx = avctx;
978
979
4
    enc->framesSinceKeyframe = 0;
980

4
    if ((avctx->width & 0xf) || (avctx->height & 0xf)) {
981
        av_log(avctx, AV_LOG_ERROR, "Dimensions must be divisible by 16\n");
982
        return AVERROR(EINVAL);
983
    }
984
985

4
    if (avctx->width > 65535 || avctx->height > 65535) {
986
        av_log(avctx, AV_LOG_ERROR, "Dimensions are max %d\n", enc->quake3_compat ? 32768 : 65535);
987
        return AVERROR(EINVAL);
988
    }
989
990

4
    if (((avctx->width)&(avctx->width-1))||((avctx->height)&(avctx->height-1)))
991
3
        av_log(avctx, AV_LOG_ERROR, "Warning: dimensions not power of two, this is not supported by quake\n");
992
993
4
    roq->width  = avctx->width;
994
4
    roq->height = avctx->height;
995
996
4
    enc->framesSinceKeyframe = 0;
997
4
    enc->first_frame = 1;
998
999
4
    roq->last_frame    = av_frame_alloc();
1000
4
    roq->current_frame = av_frame_alloc();
1001

4
    if (!roq->last_frame || !roq->current_frame)
1002
        return AVERROR(ENOMEM);
1003
1004
4
    enc->this_motion4 =
1005
4
        av_mallocz_array(roq->width * roq->height / 16, sizeof(motion_vect));
1006
1007
4
    enc->last_motion4 =
1008
4
        av_malloc_array (roq->width * roq->height / 16, sizeof(motion_vect));
1009
1010
4
    enc->this_motion8 =
1011
4
        av_mallocz_array(roq->width * roq->height / 64, sizeof(motion_vect));
1012
1013
4
    enc->last_motion8 =
1014
4
        av_malloc_array (roq->width * roq->height / 64, sizeof(motion_vect));
1015
1016
    /* 4x4 codebook needs 6 * 4 * 4 / 4 * width * height / 16 * sizeof(int);
1017
     * and so does the points buffer. */
1018
4
    enc->closest_cb   =
1019
4
        av_malloc_array(roq->width * roq->height, 3 * sizeof(int));
1020
1021

4
    if (!enc->this_motion4 || !enc->last_motion4 ||
1022

4
        !enc->this_motion8 || !enc->last_motion8 || !enc->closest_cb)
1023
        return AVERROR(ENOMEM);
1024
1025
4
    enc->points = enc->closest_cb + roq->width * roq->height * 3 / 2;
1026
1027
4
    return create_cel_evals(enc);
1028
}
1029
1030
4
static void roq_write_video_info_chunk(RoqEncContext *enc)
1031
{
1032
    /* ROQ info chunk */
1033
4
    bytestream_put_le16(&enc->out_buf, RoQ_INFO);
1034
1035
    /* Size: 8 bytes */
1036
4
    bytestream_put_le32(&enc->out_buf, 8);
1037
1038
    /* Unused argument */
1039
4
    bytestream_put_byte(&enc->out_buf, 0x00);
1040
4
    bytestream_put_byte(&enc->out_buf, 0x00);
1041
1042
    /* Width */
1043
4
    bytestream_put_le16(&enc->out_buf, enc->common.width);
1044
1045
    /* Height */
1046
4
    bytestream_put_le16(&enc->out_buf, enc->common.height);
1047
1048
    /* Unused in Quake 3, mimics the output of the real encoder */
1049
4
    bytestream_put_byte(&enc->out_buf, 0x08);
1050
4
    bytestream_put_byte(&enc->out_buf, 0x00);
1051
4
    bytestream_put_byte(&enc->out_buf, 0x04);
1052
4
    bytestream_put_byte(&enc->out_buf, 0x00);
1053
4
}
1054
1055
21
static int roq_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
1056
                            const AVFrame *frame, int *got_packet)
1057
{
1058
21
    RoqEncContext *const enc = avctx->priv_data;
1059
21
    RoqContext    *const roq = &enc->common;
1060
    int size, ret;
1061
1062
21
    roq->avctx = avctx;
1063
1064
21
    enc->frame_to_enc = frame;
1065
1066
21
    if (frame->quality)
1067
        enc->lambda = frame->quality - 1;
1068
    else
1069
21
        enc->lambda = 2*ROQ_LAMBDA_SCALE;
1070
1071
    /* 138 bits max per 8x8 block +
1072
     *     256 codebooks*(6 bytes 2x2 + 4 bytes 4x4) + 8 bytes frame header */
1073
21
    size = ((roq->width * roq->height / 64) * 138 + 7) / 8 + 256 * (6 + 4) + 8;
1074
21
    if ((ret = ff_alloc_packet2(avctx, pkt, size, 0)) < 0)
1075
        return ret;
1076
21
    enc->out_buf = pkt->data;
1077
1078
    /* Check for I-frame */
1079
21
    if (enc->framesSinceKeyframe == avctx->gop_size)
1080
        enc->framesSinceKeyframe = 0;
1081
1082
21
    if (enc->first_frame) {
1083
        /* Alloc memory for the reconstruction data (we must know the stride
1084
         for that) */
1085

8
        if ((ret = ff_get_buffer(avctx, roq->current_frame, 0)) < 0 ||
1086
4
            (ret = ff_get_buffer(avctx, roq->last_frame,    0)) < 0)
1087
            return ret;
1088
1089
        /* Before the first video frame, write a "video info" chunk */
1090
4
        roq_write_video_info_chunk(enc);
1091
1092
4
        enc->first_frame = 0;
1093
    }
1094
1095
    /* Encode the actual frame */
1096
21
    ret = roq_encode_video(enc);
1097
21
    if (ret < 0)
1098
        return ret;
1099
1100
21
    pkt->size   = enc->out_buf - pkt->data;
1101
21
    if (enc->framesSinceKeyframe == 1)
1102
4
        pkt->flags |= AV_PKT_FLAG_KEY;
1103
21
    *got_packet = 1;
1104
1105
21
    return 0;
1106
}
1107
1108
#define OFFSET(x) offsetof(RoqEncContext, x)
1109
#define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
1110
static const AVOption options[] = {
1111
    { "quake3_compat", "Whether to respect known limitations in Quake 3 decoder", OFFSET(quake3_compat), AV_OPT_TYPE_BOOL, { .i64 = 1 }, 0, 1, VE },
1112
    { NULL },
1113
};
1114
1115
static const AVClass roq_class = {
1116
    .class_name = "RoQ",
1117
    .item_name  = av_default_item_name,
1118
    .option     = options,
1119
    .version    = LIBAVUTIL_VERSION_INT,
1120
};
1121
1122
AVCodec ff_roq_encoder = {
1123
    .name                 = "roqvideo",
1124
    .long_name            = NULL_IF_CONFIG_SMALL("id RoQ video"),
1125
    .type                 = AVMEDIA_TYPE_VIDEO,
1126
    .id                   = AV_CODEC_ID_ROQ,
1127
    .priv_data_size       = sizeof(RoqEncContext),
1128
    .init                 = roq_encode_init,
1129
    .encode2              = roq_encode_frame,
1130
    .close                = roq_encode_end,
1131
    .pix_fmts             = (const enum AVPixelFormat[]){ AV_PIX_FMT_YUVJ444P,
1132
                                                        AV_PIX_FMT_NONE },
1133
    .priv_class     = &roq_class,
1134
    .caps_internal        = FF_CODEC_CAP_INIT_CLEANUP,
1135
};