3 * Copyright (C) 2004 Mike Melanson <melanson@pcisys.net>
5 * This file is part of FFmpeg.
7 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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"
38 #include "libavutil/avassert.h"
41 typedef struct SVQ1Context {
42 /* FIXME: Needed for motion estimation, should not be used for anything
43 * else, the idea is to make the motion estimation eventually independent
44 * of MpegEncContext, so this will be removed then. */
46 AVCodecContext *avctx;
49 AVFrame *current_picture;
50 AVFrame *last_picture;
54 /* why ooh why this sick breadth first order,
55 * everything is slower and more complex */
56 PutBitContext reorder_pb[6];
61 /* Y plane block dimensions */
65 /* U & V plane (C planes) block dimensions */
71 int16_t (*motion_val8[3])[2];
72 int16_t (*motion_val16[3])[2];
79 static void svq1_write_header(SVQ1Context *s, int frame_type)
84 put_bits(&s->pb, 22, 0x20);
86 /* temporal reference (sure hope this is a "don't care") */
87 put_bits(&s->pb, 8, 0x00);
90 put_bits(&s->pb, 2, frame_type - 1);
92 if (frame_type == AV_PICTURE_TYPE_I) {
93 /* no checksum since frame code is 0x20 */
94 /* no embedded string either */
95 /* output 5 unknown bits (2 + 2 + 1) */
96 put_bits(&s->pb, 5, 2); /* 2 needed by quicktime decoder */
98 i = ff_match_2uint16((void*)ff_svq1_frame_size_table,
99 FF_ARRAY_ELEMS(ff_svq1_frame_size_table),
100 s->frame_width, s->frame_height);
101 put_bits(&s->pb, 3, i);
104 put_bits(&s->pb, 12, s->frame_width);
105 put_bits(&s->pb, 12, s->frame_height);
109 /* no checksum or extra data (next 2 bits get 0) */
110 put_bits(&s->pb, 2, 0);
113 #define QUALITY_THRESHOLD 100
114 #define THRESHOLD_MULTIPLIER 0.6
116 static int encode_block(SVQ1Context *s, uint8_t *src, uint8_t *ref,
117 uint8_t *decoded, int stride, int level,
118 int threshold, int lambda, int intra)
120 int count, y, x, i, j, split, best_mean, best_score, best_count;
122 int block_sum[7] = { 0, 0, 0, 0, 0, 0 };
123 int w = 2 << (level + 2 >> 1);
124 int h = 2 << (level + 1 >> 1);
126 int16_t block[7][256];
127 const int8_t *codebook_sum, *codebook;
128 const uint16_t(*mean_vlc)[2];
129 const uint8_t(*multistage_vlc)[2];
132 // FIXME: Optimize, this does not need to be done multiple times.
134 codebook_sum = svq1_intra_codebook_sum[level];
135 codebook = ff_svq1_intra_codebooks[level];
136 mean_vlc = ff_svq1_intra_mean_vlc;
137 multistage_vlc = ff_svq1_intra_multistage_vlc[level];
138 for (y = 0; y < h; y++) {
139 for (x = 0; x < w; x++) {
140 int v = src[x + y * stride];
141 block[0][x + w * y] = v;
147 codebook_sum = svq1_inter_codebook_sum[level];
148 codebook = ff_svq1_inter_codebooks[level];
149 mean_vlc = ff_svq1_inter_mean_vlc + 256;
150 multistage_vlc = ff_svq1_inter_multistage_vlc[level];
151 for (y = 0; y < h; y++) {
152 for (x = 0; x < w; x++) {
153 int v = src[x + y * stride] - ref[x + y * stride];
154 block[0][x + w * y] = v;
162 best_score -= (int)((unsigned)block_sum[0] * block_sum[0] >> (level + 3));
163 best_mean = block_sum[0] + (size >> 1) >> (level + 3);
166 for (count = 1; count < 7; count++) {
167 int best_vector_score = INT_MAX;
168 int best_vector_sum = -999, best_vector_mean = -999;
169 const int stage = count - 1;
170 const int8_t *vector;
172 for (i = 0; i < 16; i++) {
173 int sum = codebook_sum[stage * 16 + i];
174 int sqr, diff, score;
176 vector = codebook + stage * size * 16 + i * size;
177 sqr = s->dsp.ssd_int8_vs_int16(vector, block[stage], size);
178 diff = block_sum[stage] - sum;
179 score = sqr - (diff * (int64_t)diff >> (level + 3)); // FIXME: 64bit slooow
180 if (score < best_vector_score) {
181 int mean = diff + (size >> 1) >> (level + 3);
182 av_assert2(mean > -300 && mean < 300);
183 mean = av_clip(mean, intra ? 0 : -256, 255);
184 best_vector_score = score;
185 best_vector[stage] = i;
186 best_vector_sum = sum;
187 best_vector_mean = mean;
190 av_assert0(best_vector_mean != -999);
191 vector = codebook + stage * size * 16 + best_vector[stage] * size;
192 for (j = 0; j < size; j++)
193 block[stage + 1][j] = block[stage][j] - vector[j];
194 block_sum[stage + 1] = block_sum[stage] - best_vector_sum;
195 best_vector_score += lambda *
197 multistage_vlc[1 + count][1]
198 + mean_vlc[best_vector_mean][1]);
200 if (best_vector_score < best_score) {
201 best_score = best_vector_score;
203 best_mean = best_vector_mean;
209 if (best_score > threshold && level) {
211 int offset = level & 1 ? stride * h / 2 : w / 2;
212 PutBitContext backup[6];
214 for (i = level - 1; i >= 0; i--)
215 backup[i] = s->reorder_pb[i];
216 score += encode_block(s, src, ref, decoded, stride, level - 1,
217 threshold >> 1, lambda, intra);
218 score += encode_block(s, src + offset, ref + offset, decoded + offset,
219 stride, level - 1, threshold >> 1, lambda, intra);
222 if (score < best_score) {
226 for (i = level - 1; i >= 0; i--)
227 s->reorder_pb[i] = backup[i];
231 put_bits(&s->reorder_pb[level], 1, split);
234 av_assert1(best_mean >= 0 && best_mean < 256 || !intra);
235 av_assert1(best_mean >= -256 && best_mean < 256);
236 av_assert1(best_count >= 0 && best_count < 7);
237 av_assert1(level < 4 || best_count == 0);
239 /* output the encoding */
240 put_bits(&s->reorder_pb[level],
241 multistage_vlc[1 + best_count][1],
242 multistage_vlc[1 + best_count][0]);
243 put_bits(&s->reorder_pb[level], mean_vlc[best_mean][1],
244 mean_vlc[best_mean][0]);
246 for (i = 0; i < best_count; i++) {
247 av_assert2(best_vector[i] >= 0 && best_vector[i] < 16);
248 put_bits(&s->reorder_pb[level], 4, best_vector[i]);
251 for (y = 0; y < h; y++)
252 for (x = 0; x < w; x++)
253 decoded[x + y * stride] = src[x + y * stride] -
254 block[best_count][x + w * y] +
261 static void init_block_index(MpegEncContext *s){
262 s->block_index[0]= s->b8_stride*(s->mb_y*2 ) + s->mb_x*2;
263 s->block_index[1]= s->b8_stride*(s->mb_y*2 ) + 1 + s->mb_x*2;
264 s->block_index[2]= s->b8_stride*(s->mb_y*2 + 1) + s->mb_x*2;
265 s->block_index[3]= s->b8_stride*(s->mb_y*2 + 1) + 1 + s->mb_x*2;
266 s->block_index[4]= s->mb_stride*(s->mb_y + 1) + s->b8_stride*s->mb_height*2 + s->mb_x;
267 s->block_index[5]= s->mb_stride*(s->mb_y + s->mb_height + 2) + s->b8_stride*s->mb_height*2 + s->mb_x;
270 static int svq1_encode_plane(SVQ1Context *s, int plane,
271 unsigned char *src_plane,
272 unsigned char *ref_plane,
273 unsigned char *decoded_plane,
274 int width, int height, int src_stride, int stride)
276 const AVFrame *f = s->avctx->coded_frame;
279 int block_width, block_height;
282 uint8_t *src = s->scratchbuf + stride * 16;
283 const int lambda = (f->quality * f->quality) >>
284 (2 * FF_LAMBDA_SHIFT);
286 /* figure out the acceptable level thresholds in advance */
287 threshold[5] = QUALITY_THRESHOLD;
288 for (level = 4; level >= 0; level--)
289 threshold[level] = threshold[level + 1] * THRESHOLD_MULTIPLIER;
291 block_width = (width + 15) / 16;
292 block_height = (height + 15) / 16;
294 if (f->pict_type == AV_PICTURE_TYPE_P) {
295 s->m.avctx = s->avctx;
296 s->m.current_picture_ptr = &s->m.current_picture;
297 s->m.last_picture_ptr = &s->m.last_picture;
298 s->m.last_picture.f->data[0] = ref_plane;
300 s->m.last_picture.f->linesize[0] =
301 s->m.new_picture.f->linesize[0] =
302 s->m.current_picture.f->linesize[0] = stride;
304 s->m.height = height;
305 s->m.mb_width = block_width;
306 s->m.mb_height = block_height;
307 s->m.mb_stride = s->m.mb_width + 1;
308 s->m.b8_stride = 2 * s->m.mb_width + 1;
310 s->m.pict_type = f->pict_type;
311 s->m.me_method = s->avctx->me_method;
312 s->m.me.scene_change_score = 0;
313 s->m.flags = s->avctx->flags;
314 // s->m.out_format = FMT_H263;
315 // s->m.unrestricted_mv = 1;
316 s->m.lambda = f->quality;
317 s->m.qscale = s->m.lambda * 139 +
318 FF_LAMBDA_SCALE * 64 >>
320 s->m.lambda2 = s->m.lambda * s->m.lambda +
321 FF_LAMBDA_SCALE / 2 >>
324 if (!s->motion_val8[plane]) {
325 s->motion_val8[plane] = av_mallocz((s->m.b8_stride *
326 block_height * 2 + 2) *
327 2 * sizeof(int16_t));
328 s->motion_val16[plane] = av_mallocz((s->m.mb_stride *
329 (block_height + 2) + 1) *
330 2 * sizeof(int16_t));
333 s->m.mb_type = s->mb_type;
335 // dummies, to avoid segfaults
336 s->m.current_picture.mb_mean = (uint8_t *)s->dummy;
337 s->m.current_picture.mb_var = (uint16_t *)s->dummy;
338 s->m.current_picture.mc_mb_var = (uint16_t *)s->dummy;
339 s->m.current_picture.mb_type = s->dummy;
341 s->m.current_picture.motion_val[0] = s->motion_val8[plane] + 2;
342 s->m.p_mv_table = s->motion_val16[plane] +
344 s->m.dsp = s->dsp; // move
347 s->m.me.dia_size = s->avctx->dia_size;
348 s->m.first_slice_line = 1;
349 for (y = 0; y < block_height; y++) {
350 s->m.new_picture.f->data[0] = src - y * 16 * stride; // ugly
353 for (i = 0; i < 16 && i + 16 * y < height; i++) {
354 memcpy(&src[i * stride], &src_plane[(i + 16 * y) * src_stride],
356 for (x = width; x < 16 * block_width; x++)
357 src[i * stride + x] = src[i * stride + x - 1];
359 for (; i < 16 && i + 16 * y < 16 * block_height; i++)
360 memcpy(&src[i * stride], &src[(i - 1) * stride],
363 for (x = 0; x < block_width; x++) {
365 init_block_index(&s->m);
367 ff_estimate_p_frame_motion(&s->m, x, y);
369 s->m.first_slice_line = 0;
372 ff_fix_long_p_mvs(&s->m);
373 ff_fix_long_mvs(&s->m, NULL, 0, s->m.p_mv_table, s->m.f_code,
374 CANDIDATE_MB_TYPE_INTER, 0);
377 s->m.first_slice_line = 1;
378 for (y = 0; y < block_height; y++) {
379 for (i = 0; i < 16 && i + 16 * y < height; i++) {
380 memcpy(&src[i * stride], &src_plane[(i + 16 * y) * src_stride],
382 for (x = width; x < 16 * block_width; x++)
383 src[i * stride + x] = src[i * stride + x - 1];
385 for (; i < 16 && i + 16 * y < 16 * block_height; i++)
386 memcpy(&src[i * stride], &src[(i - 1) * stride], 16 * block_width);
389 for (x = 0; x < block_width; x++) {
390 uint8_t reorder_buffer[3][6][7 * 32];
392 int offset = y * 16 * stride + x * 16;
393 uint8_t *decoded = decoded_plane + offset;
394 uint8_t *ref = ref_plane + offset;
395 int score[4] = { 0, 0, 0, 0 }, best;
396 uint8_t *temp = s->scratchbuf;
398 if (s->pb.buf_end - s->pb.buf -
399 (put_bits_count(&s->pb) >> 3) < 3000) { // FIXME: check size
400 av_log(s->avctx, AV_LOG_ERROR, "encoded frame too large\n");
405 init_block_index(&s->m);
407 if (f->pict_type == AV_PICTURE_TYPE_I ||
408 (s->m.mb_type[x + y * s->m.mb_stride] &
409 CANDIDATE_MB_TYPE_INTRA)) {
410 for (i = 0; i < 6; i++)
411 init_put_bits(&s->reorder_pb[i], reorder_buffer[0][i],
413 if (f->pict_type == AV_PICTURE_TYPE_P) {
414 const uint8_t *vlc = ff_svq1_block_type_vlc[SVQ1_BLOCK_INTRA];
415 put_bits(&s->reorder_pb[5], vlc[1], vlc[0]);
416 score[0] = vlc[1] * lambda;
418 score[0] += encode_block(s, src + 16 * x, NULL, temp, stride,
420 for (i = 0; i < 6; i++) {
421 count[0][i] = put_bits_count(&s->reorder_pb[i]);
422 flush_put_bits(&s->reorder_pb[i]);
429 if (f->pict_type == AV_PICTURE_TYPE_P) {
430 const uint8_t *vlc = ff_svq1_block_type_vlc[SVQ1_BLOCK_INTER];
431 int mx, my, pred_x, pred_y, dxy;
434 motion_ptr = ff_h263_pred_motion(&s->m, 0, 0, &pred_x, &pred_y);
435 if (s->m.mb_type[x + y * s->m.mb_stride] &
436 CANDIDATE_MB_TYPE_INTER) {
437 for (i = 0; i < 6; i++)
438 init_put_bits(&s->reorder_pb[i], reorder_buffer[1][i],
441 put_bits(&s->reorder_pb[5], vlc[1], vlc[0]);
443 s->m.pb = s->reorder_pb[5];
446 av_assert1(mx >= -32 && mx <= 31);
447 av_assert1(my >= -32 && my <= 31);
448 av_assert1(pred_x >= -32 && pred_x <= 31);
449 av_assert1(pred_y >= -32 && pred_y <= 31);
450 ff_h263_encode_motion(&s->m, mx - pred_x, 1);
451 ff_h263_encode_motion(&s->m, my - pred_y, 1);
452 s->reorder_pb[5] = s->m.pb;
453 score[1] += lambda * put_bits_count(&s->reorder_pb[5]);
455 dxy = (mx & 1) + 2 * (my & 1);
457 s->hdsp.put_pixels_tab[0][dxy](temp + 16,
462 score[1] += encode_block(s, src + 16 * x, temp + 16,
463 decoded, stride, 5, 64, lambda, 0);
464 best = score[1] <= score[0];
466 vlc = ff_svq1_block_type_vlc[SVQ1_BLOCK_SKIP];
467 score[2] = s->dsp.sse[0](NULL, src + 16 * x, ref,
469 score[2] += vlc[1] * lambda;
470 if (score[2] < score[best] && mx == 0 && my == 0) {
472 s->hdsp.put_pixels_tab[0][0](decoded, ref, stride, 16);
473 for (i = 0; i < 6; i++)
475 put_bits(&s->pb, vlc[1], vlc[0]);
480 for (i = 0; i < 6; i++) {
481 count[1][i] = put_bits_count(&s->reorder_pb[i]);
482 flush_put_bits(&s->reorder_pb[i]);
489 motion_ptr[0 + 2 * s->m.b8_stride] =
490 motion_ptr[1 + 2 * s->m.b8_stride] =
491 motion_ptr[2 + 2 * s->m.b8_stride] =
492 motion_ptr[3 + 2 * s->m.b8_stride] = 0;
496 s->rd_total += score[best];
498 for (i = 5; i >= 0; i--)
499 avpriv_copy_bits(&s->pb, reorder_buffer[best][i],
502 s->hdsp.put_pixels_tab[0][0](decoded, temp, stride, 16);
504 s->m.first_slice_line = 0;
509 static av_cold int svq1_encode_end(AVCodecContext *avctx)
511 SVQ1Context *const s = avctx->priv_data;
514 av_log(avctx, AV_LOG_DEBUG, "RD: %f\n",
515 s->rd_total / (double)(avctx->width * avctx->height *
516 avctx->frame_number));
519 ff_MPV_common_end(&s->m);
521 av_freep(&s->m.me.scratchpad);
522 av_freep(&s->m.me.map);
523 av_freep(&s->m.me.score_map);
524 av_freep(&s->mb_type);
526 av_freep(&s->scratchbuf);
528 for (i = 0; i < 3; i++) {
529 av_freep(&s->motion_val8[i]);
530 av_freep(&s->motion_val16[i]);
533 av_frame_free(&s->current_picture);
534 av_frame_free(&s->last_picture);
535 av_frame_free(&avctx->coded_frame);
540 static av_cold int svq1_encode_init(AVCodecContext *avctx)
542 SVQ1Context *const s = avctx->priv_data;
545 ff_dsputil_init(&s->dsp, avctx);
546 ff_hpeldsp_init(&s->hdsp, avctx->flags);
548 avctx->coded_frame = av_frame_alloc();
549 s->current_picture = av_frame_alloc();
550 s->last_picture = av_frame_alloc();
551 if (!avctx->coded_frame || !s->current_picture || !s->last_picture) {
552 svq1_encode_end(avctx);
553 return AVERROR(ENOMEM);
556 s->frame_width = avctx->width;
557 s->frame_height = avctx->height;
559 s->y_block_width = (s->frame_width + 15) / 16;
560 s->y_block_height = (s->frame_height + 15) / 16;
562 s->c_block_width = (s->frame_width / 4 + 15) / 16;
563 s->c_block_height = (s->frame_height / 4 + 15) / 16;
568 if ((ret = ff_MPV_common_init(&s->m)) < 0) {
569 svq1_encode_end(avctx);
573 s->m.picture_structure = PICT_FRAME;
575 s->m.me.scratchpad = av_mallocz((avctx->width + 64) *
576 2 * 16 * 2 * sizeof(uint8_t));
577 s->m.me.map = av_mallocz(ME_MAP_SIZE * sizeof(uint32_t));
578 s->m.me.score_map = av_mallocz(ME_MAP_SIZE * sizeof(uint32_t));
579 s->mb_type = av_mallocz((s->y_block_width + 1) *
580 s->y_block_height * sizeof(int16_t));
581 s->dummy = av_mallocz((s->y_block_width + 1) *
582 s->y_block_height * sizeof(int32_t));
583 ff_h263_encode_init(&s->m); // mv_penalty
588 static int svq1_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
589 const AVFrame *pict, int *got_packet)
591 SVQ1Context *const s = avctx->priv_data;
592 AVFrame *const p = avctx->coded_frame;
595 if ((ret = ff_alloc_packet2(avctx, pkt, s->y_block_width * s->y_block_height *
596 MAX_MB_BYTES*3 + FF_MIN_BUFFER_SIZE)) < 0)
599 if (avctx->pix_fmt != AV_PIX_FMT_YUV410P) {
600 av_log(avctx, AV_LOG_ERROR, "unsupported pixel format\n");
604 if (!s->current_picture->data[0]) {
605 if ((ret = ff_get_buffer(avctx, s->current_picture, 0))< 0 ||
606 (ret = ff_get_buffer(avctx, s->last_picture, 0)) < 0) {
609 s->scratchbuf = av_malloc(s->current_picture->linesize[0] * 16 * 2);
612 FFSWAP(AVFrame*, s->current_picture, s->last_picture);
614 init_put_bits(&s->pb, pkt->data, pkt->size);
616 p->pict_type = avctx->gop_size && avctx->frame_number % avctx->gop_size ?
617 AV_PICTURE_TYPE_P : AV_PICTURE_TYPE_I;
618 p->key_frame = p->pict_type == AV_PICTURE_TYPE_I;
619 p->quality = pict->quality;
621 svq1_write_header(s, p->pict_type);
622 for (i = 0; i < 3; i++)
623 if (svq1_encode_plane(s, i,
625 s->last_picture->data[i],
626 s->current_picture->data[i],
627 s->frame_width / (i ? 4 : 1),
628 s->frame_height / (i ? 4 : 1),
630 s->current_picture->linesize[i]) < 0)
633 // avpriv_align_put_bits(&s->pb);
634 while (put_bits_count(&s->pb) & 31)
635 put_bits(&s->pb, 1, 0);
637 flush_put_bits(&s->pb);
639 pkt->size = put_bits_count(&s->pb) / 8;
640 if (p->pict_type == AV_PICTURE_TYPE_I)
641 pkt->flags |= AV_PKT_FLAG_KEY;
647 AVCodec ff_svq1_encoder = {
649 .long_name = NULL_IF_CONFIG_SMALL("Sorenson Vector Quantizer 1 / Sorenson Video 1 / SVQ1"),
650 .type = AVMEDIA_TYPE_VIDEO,
651 .id = AV_CODEC_ID_SVQ1,
652 .priv_data_size = sizeof(SVQ1Context),
653 .init = svq1_encode_init,
654 .encode2 = svq1_encode_frame,
655 .close = svq1_encode_end,
656 .pix_fmts = (const enum AVPixelFormat[]) { AV_PIX_FMT_YUV410P,