3 * Copyright (C) 2004 Mike Melanson <melanson@pcisys.net>
5 * This file is part of Libav.
7 * Libav is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * Libav is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Sorenson Vector Quantizer #1 (SVQ1) video codec.
25 * For more information of the SVQ1 algorithm, visit:
26 * http://www.pcisys.net/~melanson/codecs/
32 #include "mpegvideo.h"
35 #include "mpegutils.h"
37 #include "svq1enc_cb.h"
42 typedef struct SVQ1EncContext {
43 /* FIXME: Needed for motion estimation, should not be used for anything
44 * else, the idea is to make the motion estimation eventually independent
45 * of MpegEncContext, so this will be removed then. */
47 AVCodecContext *avctx;
50 AVFrame *current_picture;
51 AVFrame *last_picture;
55 /* why ooh why this sick breadth first order,
56 * everything is slower and more complex */
57 PutBitContext reorder_pb[6];
62 /* Y plane block dimensions */
66 /* U & V plane (C planes) block dimensions */
72 int16_t (*motion_val8[3])[2];
73 int16_t (*motion_val16[3])[2];
80 static void svq1_write_header(SVQ1EncContext *s, int frame_type)
85 put_bits(&s->pb, 22, 0x20);
87 /* temporal reference (sure hope this is a "don't care") */
88 put_bits(&s->pb, 8, 0x00);
91 put_bits(&s->pb, 2, frame_type - 1);
93 if (frame_type == AV_PICTURE_TYPE_I) {
94 /* no checksum since frame code is 0x20 */
95 /* no embedded string either */
96 /* output 5 unknown bits (2 + 2 + 1) */
97 put_bits(&s->pb, 5, 2); /* 2 needed by quicktime decoder */
99 i = ff_match_2uint16(ff_svq1_frame_size_table,
100 FF_ARRAY_ELEMS(ff_svq1_frame_size_table),
101 s->frame_width, s->frame_height);
102 put_bits(&s->pb, 3, i);
105 put_bits(&s->pb, 12, s->frame_width);
106 put_bits(&s->pb, 12, s->frame_height);
110 /* no checksum or extra data (next 2 bits get 0) */
111 put_bits(&s->pb, 2, 0);
114 #define QUALITY_THRESHOLD 100
115 #define THRESHOLD_MULTIPLIER 0.6
117 static int encode_block(SVQ1EncContext *s, uint8_t *src, uint8_t *ref,
118 uint8_t *decoded, int stride, int level,
119 int threshold, int lambda, int intra)
121 int count, y, x, i, j, split, best_mean, best_score, best_count;
123 int block_sum[7] = { 0, 0, 0, 0, 0, 0 };
124 int w = 2 << (level + 2 >> 1);
125 int h = 2 << (level + 1 >> 1);
127 int16_t block[7][256];
128 const int8_t *codebook_sum, *codebook;
129 const uint16_t(*mean_vlc)[2];
130 const uint8_t(*multistage_vlc)[2];
133 // FIXME: Optimize, this does not need to be done multiple times.
135 codebook_sum = svq1_intra_codebook_sum[level];
136 codebook = ff_svq1_intra_codebooks[level];
137 mean_vlc = ff_svq1_intra_mean_vlc;
138 multistage_vlc = ff_svq1_intra_multistage_vlc[level];
139 for (y = 0; y < h; y++) {
140 for (x = 0; x < w; x++) {
141 int v = src[x + y * stride];
142 block[0][x + w * y] = v;
148 codebook_sum = svq1_inter_codebook_sum[level];
149 codebook = ff_svq1_inter_codebooks[level];
150 mean_vlc = ff_svq1_inter_mean_vlc + 256;
151 multistage_vlc = ff_svq1_inter_multistage_vlc[level];
152 for (y = 0; y < h; y++) {
153 for (x = 0; x < w; x++) {
154 int v = src[x + y * stride] - ref[x + y * stride];
155 block[0][x + w * y] = v;
163 best_score -= (int)((unsigned)block_sum[0] * block_sum[0] >> (level + 3));
164 best_mean = block_sum[0] + (size >> 1) >> (level + 3);
167 for (count = 1; count < 7; count++) {
168 int best_vector_score = INT_MAX;
169 int best_vector_sum = -999, best_vector_mean = -999;
170 const int stage = count - 1;
171 const int8_t *vector;
173 for (i = 0; i < 16; i++) {
174 int sum = codebook_sum[stage * 16 + i];
175 int sqr, diff, score;
177 vector = codebook + stage * size * 16 + i * size;
178 sqr = s->dsp.ssd_int8_vs_int16(vector, block[stage], size);
179 diff = block_sum[stage] - sum;
180 score = sqr - (diff * (int64_t)diff >> (level + 3)); // FIXME: 64bit slooow
181 if (score < best_vector_score) {
182 int mean = diff + (size >> 1) >> (level + 3);
183 assert(mean > -300 && mean < 300);
184 mean = av_clip(mean, intra ? 0 : -256, 255);
185 best_vector_score = score;
186 best_vector[stage] = i;
187 best_vector_sum = sum;
188 best_vector_mean = mean;
191 assert(best_vector_mean != -999);
192 vector = codebook + stage * size * 16 + best_vector[stage] * size;
193 for (j = 0; j < size; j++)
194 block[stage + 1][j] = block[stage][j] - vector[j];
195 block_sum[stage + 1] = block_sum[stage] - best_vector_sum;
196 best_vector_score += lambda *
198 multistage_vlc[1 + count][1]
199 + mean_vlc[best_vector_mean][1]);
201 if (best_vector_score < best_score) {
202 best_score = best_vector_score;
204 best_mean = best_vector_mean;
210 if (best_score > threshold && level) {
212 int offset = level & 1 ? stride * h / 2 : w / 2;
213 PutBitContext backup[6];
215 for (i = level - 1; i >= 0; i--)
216 backup[i] = s->reorder_pb[i];
217 score += encode_block(s, src, ref, decoded, stride, level - 1,
218 threshold >> 1, lambda, intra);
219 score += encode_block(s, src + offset, ref + offset, decoded + offset,
220 stride, level - 1, threshold >> 1, lambda, intra);
223 if (score < best_score) {
227 for (i = level - 1; i >= 0; i--)
228 s->reorder_pb[i] = backup[i];
232 put_bits(&s->reorder_pb[level], 1, split);
235 assert(best_mean >= 0 && best_mean < 256 || !intra);
236 assert(best_mean >= -256 && best_mean < 256);
237 assert(best_count >= 0 && best_count < 7);
238 assert(level < 4 || best_count == 0);
240 /* output the encoding */
241 put_bits(&s->reorder_pb[level],
242 multistage_vlc[1 + best_count][1],
243 multistage_vlc[1 + best_count][0]);
244 put_bits(&s->reorder_pb[level], mean_vlc[best_mean][1],
245 mean_vlc[best_mean][0]);
247 for (i = 0; i < best_count; i++) {
248 assert(best_vector[i] >= 0 && best_vector[i] < 16);
249 put_bits(&s->reorder_pb[level], 4, best_vector[i]);
252 for (y = 0; y < h; y++)
253 for (x = 0; x < w; x++)
254 decoded[x + y * stride] = src[x + y * stride] -
255 block[best_count][x + w * y] +
262 static int svq1_encode_plane(SVQ1EncContext *s, int plane,
263 unsigned char *src_plane,
264 unsigned char *ref_plane,
265 unsigned char *decoded_plane,
266 int width, int height, int src_stride, int stride)
268 const AVFrame *f = s->avctx->coded_frame;
271 int block_width, block_height;
274 uint8_t *src = s->scratchbuf + stride * 16;
275 const int lambda = (f->quality * f->quality) >>
276 (2 * FF_LAMBDA_SHIFT);
278 /* figure out the acceptable level thresholds in advance */
279 threshold[5] = QUALITY_THRESHOLD;
280 for (level = 4; level >= 0; level--)
281 threshold[level] = threshold[level + 1] * THRESHOLD_MULTIPLIER;
283 block_width = (width + 15) / 16;
284 block_height = (height + 15) / 16;
286 if (f->pict_type == AV_PICTURE_TYPE_P) {
287 s->m.avctx = s->avctx;
288 s->m.current_picture_ptr = &s->m.current_picture;
289 s->m.last_picture_ptr = &s->m.last_picture;
290 s->m.last_picture.f->data[0] = ref_plane;
292 s->m.last_picture.f->linesize[0] =
293 s->m.new_picture.f->linesize[0] =
294 s->m.current_picture.f->linesize[0] = stride;
296 s->m.height = height;
297 s->m.mb_width = block_width;
298 s->m.mb_height = block_height;
299 s->m.mb_stride = s->m.mb_width + 1;
300 s->m.b8_stride = 2 * s->m.mb_width + 1;
302 s->m.pict_type = f->pict_type;
303 s->m.me_method = s->avctx->me_method;
304 s->m.me.scene_change_score = 0;
305 s->m.flags = s->avctx->flags;
306 // s->m.out_format = FMT_H263;
307 // s->m.unrestricted_mv = 1;
308 s->m.lambda = f->quality;
309 s->m.qscale = s->m.lambda * 139 +
310 FF_LAMBDA_SCALE * 64 >>
312 s->m.lambda2 = s->m.lambda * s->m.lambda +
313 FF_LAMBDA_SCALE / 2 >>
316 if (!s->motion_val8[plane]) {
317 s->motion_val8[plane] = av_mallocz((s->m.b8_stride *
318 block_height * 2 + 2) *
319 2 * sizeof(int16_t));
320 s->motion_val16[plane] = av_mallocz((s->m.mb_stride *
321 (block_height + 2) + 1) *
322 2 * sizeof(int16_t));
325 s->m.mb_type = s->mb_type;
327 // dummies, to avoid segfaults
328 s->m.current_picture.mb_mean = (uint8_t *)s->dummy;
329 s->m.current_picture.mb_var = (uint16_t *)s->dummy;
330 s->m.current_picture.mc_mb_var = (uint16_t *)s->dummy;
331 s->m.current_picture.mb_type = s->dummy;
333 s->m.current_picture.motion_val[0] = s->motion_val8[plane] + 2;
334 s->m.p_mv_table = s->motion_val16[plane] +
336 s->m.dsp = s->dsp; // move
339 s->m.me.dia_size = s->avctx->dia_size;
340 s->m.first_slice_line = 1;
341 for (y = 0; y < block_height; y++) {
342 s->m.new_picture.f->data[0] = src - y * 16 * stride; // ugly
345 for (i = 0; i < 16 && i + 16 * y < height; i++) {
346 memcpy(&src[i * stride], &src_plane[(i + 16 * y) * src_stride],
348 for (x = width; x < 16 * block_width; x++)
349 src[i * stride + x] = src[i * stride + x - 1];
351 for (; i < 16 && i + 16 * y < 16 * block_height; i++)
352 memcpy(&src[i * stride], &src[(i - 1) * stride],
355 for (x = 0; x < block_width; x++) {
357 ff_init_block_index(&s->m);
358 ff_update_block_index(&s->m);
360 ff_estimate_p_frame_motion(&s->m, x, y);
362 s->m.first_slice_line = 0;
365 ff_fix_long_p_mvs(&s->m);
366 ff_fix_long_mvs(&s->m, NULL, 0, s->m.p_mv_table, s->m.f_code,
367 CANDIDATE_MB_TYPE_INTER, 0);
370 s->m.first_slice_line = 1;
371 for (y = 0; y < block_height; y++) {
372 for (i = 0; i < 16 && i + 16 * y < height; i++) {
373 memcpy(&src[i * stride], &src_plane[(i + 16 * y) * src_stride],
375 for (x = width; x < 16 * block_width; x++)
376 src[i * stride + x] = src[i * stride + x - 1];
378 for (; i < 16 && i + 16 * y < 16 * block_height; i++)
379 memcpy(&src[i * stride], &src[(i - 1) * stride], 16 * block_width);
382 for (x = 0; x < block_width; x++) {
383 uint8_t reorder_buffer[3][6][7 * 32];
385 int offset = y * 16 * stride + x * 16;
386 uint8_t *decoded = decoded_plane + offset;
387 uint8_t *ref = ref_plane + offset;
388 int score[4] = { 0, 0, 0, 0 }, best;
389 uint8_t *temp = s->scratchbuf;
391 if (s->pb.buf_end - s->pb.buf -
392 (put_bits_count(&s->pb) >> 3) < 3000) { // FIXME: check size
393 av_log(s->avctx, AV_LOG_ERROR, "encoded frame too large\n");
398 ff_init_block_index(&s->m);
399 ff_update_block_index(&s->m);
401 if (f->pict_type == AV_PICTURE_TYPE_I ||
402 (s->m.mb_type[x + y * s->m.mb_stride] &
403 CANDIDATE_MB_TYPE_INTRA)) {
404 for (i = 0; i < 6; i++)
405 init_put_bits(&s->reorder_pb[i], reorder_buffer[0][i],
407 if (f->pict_type == AV_PICTURE_TYPE_P) {
408 const uint8_t *vlc = ff_svq1_block_type_vlc[SVQ1_BLOCK_INTRA];
409 put_bits(&s->reorder_pb[5], vlc[1], vlc[0]);
410 score[0] = vlc[1] * lambda;
412 score[0] += encode_block(s, src + 16 * x, NULL, temp, stride,
414 for (i = 0; i < 6; i++) {
415 count[0][i] = put_bits_count(&s->reorder_pb[i]);
416 flush_put_bits(&s->reorder_pb[i]);
423 if (f->pict_type == AV_PICTURE_TYPE_P) {
424 const uint8_t *vlc = ff_svq1_block_type_vlc[SVQ1_BLOCK_INTER];
425 int mx, my, pred_x, pred_y, dxy;
428 motion_ptr = ff_h263_pred_motion(&s->m, 0, 0, &pred_x, &pred_y);
429 if (s->m.mb_type[x + y * s->m.mb_stride] &
430 CANDIDATE_MB_TYPE_INTER) {
431 for (i = 0; i < 6; i++)
432 init_put_bits(&s->reorder_pb[i], reorder_buffer[1][i],
435 put_bits(&s->reorder_pb[5], vlc[1], vlc[0]);
437 s->m.pb = s->reorder_pb[5];
440 assert(mx >= -32 && mx <= 31);
441 assert(my >= -32 && my <= 31);
442 assert(pred_x >= -32 && pred_x <= 31);
443 assert(pred_y >= -32 && pred_y <= 31);
444 ff_h263_encode_motion(&s->m, mx - pred_x, 1);
445 ff_h263_encode_motion(&s->m, my - pred_y, 1);
446 s->reorder_pb[5] = s->m.pb;
447 score[1] += lambda * put_bits_count(&s->reorder_pb[5]);
449 dxy = (mx & 1) + 2 * (my & 1);
451 s->hdsp.put_pixels_tab[0][dxy](temp + 16,
456 score[1] += encode_block(s, src + 16 * x, temp + 16,
457 decoded, stride, 5, 64, lambda, 0);
458 best = score[1] <= score[0];
460 vlc = ff_svq1_block_type_vlc[SVQ1_BLOCK_SKIP];
461 score[2] = s->dsp.sse[0](NULL, src + 16 * x, ref,
463 score[2] += vlc[1] * lambda;
464 if (score[2] < score[best] && mx == 0 && my == 0) {
466 s->hdsp.put_pixels_tab[0][0](decoded, ref, stride, 16);
467 for (i = 0; i < 6; i++)
469 put_bits(&s->pb, vlc[1], vlc[0]);
474 for (i = 0; i < 6; i++) {
475 count[1][i] = put_bits_count(&s->reorder_pb[i]);
476 flush_put_bits(&s->reorder_pb[i]);
483 motion_ptr[0 + 2 * s->m.b8_stride] =
484 motion_ptr[1 + 2 * s->m.b8_stride] =
485 motion_ptr[2 + 2 * s->m.b8_stride] =
486 motion_ptr[3 + 2 * s->m.b8_stride] = 0;
490 s->rd_total += score[best];
492 for (i = 5; i >= 0; i--)
493 avpriv_copy_bits(&s->pb, reorder_buffer[best][i],
496 s->hdsp.put_pixels_tab[0][0](decoded, temp, stride, 16);
498 s->m.first_slice_line = 0;
503 static av_cold int svq1_encode_end(AVCodecContext *avctx)
505 SVQ1EncContext *const s = avctx->priv_data;
508 av_log(avctx, AV_LOG_DEBUG, "RD: %f\n",
509 s->rd_total / (double)(avctx->width * avctx->height *
510 avctx->frame_number));
513 ff_MPV_common_end(&s->m);
515 av_freep(&s->m.me.scratchpad);
516 av_freep(&s->m.me.map);
517 av_freep(&s->m.me.score_map);
518 av_freep(&s->mb_type);
520 av_freep(&s->scratchbuf);
522 for (i = 0; i < 3; i++) {
523 av_freep(&s->motion_val8[i]);
524 av_freep(&s->motion_val16[i]);
527 av_frame_free(&s->current_picture);
528 av_frame_free(&s->last_picture);
529 av_frame_free(&avctx->coded_frame);
534 static av_cold int svq1_encode_init(AVCodecContext *avctx)
536 SVQ1EncContext *const s = avctx->priv_data;
539 ff_dsputil_init(&s->dsp, avctx);
540 ff_hpeldsp_init(&s->hdsp, avctx->flags);
542 avctx->coded_frame = av_frame_alloc();
543 s->current_picture = av_frame_alloc();
544 s->last_picture = av_frame_alloc();
545 if (!avctx->coded_frame || !s->current_picture || !s->last_picture) {
546 svq1_encode_end(avctx);
547 return AVERROR(ENOMEM);
550 s->frame_width = avctx->width;
551 s->frame_height = avctx->height;
553 s->y_block_width = (s->frame_width + 15) / 16;
554 s->y_block_height = (s->frame_height + 15) / 16;
556 s->c_block_width = (s->frame_width / 4 + 15) / 16;
557 s->c_block_height = (s->frame_height / 4 + 15) / 16;
562 if ((ret = ff_MPV_common_init(&s->m)) < 0) {
563 svq1_encode_end(avctx);
567 s->m.picture_structure = PICT_FRAME;
569 s->m.me.scratchpad = av_mallocz((avctx->width + 64) *
570 2 * 16 * 2 * sizeof(uint8_t));
571 s->m.me.map = av_mallocz(ME_MAP_SIZE * sizeof(uint32_t));
572 s->m.me.score_map = av_mallocz(ME_MAP_SIZE * sizeof(uint32_t));
573 s->mb_type = av_mallocz((s->y_block_width + 1) *
574 s->y_block_height * sizeof(int16_t));
575 s->dummy = av_mallocz((s->y_block_width + 1) *
576 s->y_block_height * sizeof(int32_t));
577 ff_h263_encode_init(&s->m); // mv_penalty
582 static int svq1_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
583 const AVFrame *pict, int *got_packet)
585 SVQ1EncContext *const s = avctx->priv_data;
586 AVFrame *const p = avctx->coded_frame;
590 (ret = av_new_packet(pkt, s->y_block_width * s->y_block_height *
591 MAX_MB_BYTES * 3 + FF_MIN_BUFFER_SIZE)) < 0) {
592 av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
596 if (avctx->pix_fmt != AV_PIX_FMT_YUV410P) {
597 av_log(avctx, AV_LOG_ERROR, "unsupported pixel format\n");
601 if (!s->current_picture->data[0]) {
602 ff_get_buffer(avctx, s->current_picture, 0);
603 ff_get_buffer(avctx, s->last_picture, 0);
604 s->scratchbuf = av_malloc(s->current_picture->linesize[0] * 16 * 2);
607 FFSWAP(AVFrame*, s->current_picture, s->last_picture);
609 init_put_bits(&s->pb, pkt->data, pkt->size);
611 p->pict_type = avctx->gop_size && avctx->frame_number % avctx->gop_size ?
612 AV_PICTURE_TYPE_P : AV_PICTURE_TYPE_I;
613 p->key_frame = p->pict_type == AV_PICTURE_TYPE_I;
614 p->quality = pict->quality;
616 svq1_write_header(s, p->pict_type);
617 for (i = 0; i < 3; i++)
618 if (svq1_encode_plane(s, i,
620 s->last_picture->data[i],
621 s->current_picture->data[i],
622 s->frame_width / (i ? 4 : 1),
623 s->frame_height / (i ? 4 : 1),
625 s->current_picture->linesize[i]) < 0)
628 // avpriv_align_put_bits(&s->pb);
629 while (put_bits_count(&s->pb) & 31)
630 put_bits(&s->pb, 1, 0);
632 flush_put_bits(&s->pb);
634 pkt->size = put_bits_count(&s->pb) / 8;
635 if (p->pict_type == AV_PICTURE_TYPE_I)
636 pkt->flags |= AV_PKT_FLAG_KEY;
642 AVCodec ff_svq1_encoder = {
644 .long_name = NULL_IF_CONFIG_SMALL("Sorenson Vector Quantizer 1 / Sorenson Video 1 / SVQ1"),
645 .type = AVMEDIA_TYPE_VIDEO,
646 .id = AV_CODEC_ID_SVQ1,
647 .priv_data_size = sizeof(SVQ1EncContext),
648 .init = svq1_encode_init,
649 .encode2 = svq1_encode_frame,
650 .close = svq1_encode_end,
651 .pix_fmts = (const enum AVPixelFormat[]) { AV_PIX_FMT_YUV410P,