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"
38 #include "svq1enc_cb.h"
43 static void svq1_write_header(SVQ1EncContext *s, int frame_type)
48 put_bits(&s->pb, 22, 0x20);
50 /* temporal reference (sure hope this is a "don't care") */
51 put_bits(&s->pb, 8, 0x00);
54 put_bits(&s->pb, 2, frame_type - 1);
56 if (frame_type == AV_PICTURE_TYPE_I) {
57 /* no checksum since frame code is 0x20 */
58 /* no embedded string either */
59 /* output 5 unknown bits (2 + 2 + 1) */
60 put_bits(&s->pb, 5, 2); /* 2 needed by quicktime decoder */
62 i = ff_match_2uint16(ff_svq1_frame_size_table,
63 FF_ARRAY_ELEMS(ff_svq1_frame_size_table),
64 s->frame_width, s->frame_height);
65 put_bits(&s->pb, 3, i);
68 put_bits(&s->pb, 12, s->frame_width);
69 put_bits(&s->pb, 12, s->frame_height);
73 /* no checksum or extra data (next 2 bits get 0) */
74 put_bits(&s->pb, 2, 0);
77 #define QUALITY_THRESHOLD 100
78 #define THRESHOLD_MULTIPLIER 0.6
80 static int ssd_int8_vs_int16_c(const int8_t *pix1, const int16_t *pix2,
85 for (i = 0; i < size; i++)
86 score += (pix1[i] - pix2[i]) * (pix1[i] - pix2[i]);
90 static int encode_block(SVQ1EncContext *s, uint8_t *src, uint8_t *ref,
91 uint8_t *decoded, int stride, int level,
92 int threshold, int lambda, int intra)
94 int count, y, x, i, j, split, best_mean, best_score, best_count;
96 int block_sum[7] = { 0, 0, 0, 0, 0, 0 };
97 int w = 2 << (level + 2 >> 1);
98 int h = 2 << (level + 1 >> 1);
100 int16_t block[7][256];
101 const int8_t *codebook_sum, *codebook;
102 const uint16_t(*mean_vlc)[2];
103 const uint8_t(*multistage_vlc)[2];
106 // FIXME: Optimize, this does not need to be done multiple times.
108 codebook_sum = svq1_intra_codebook_sum[level];
109 codebook = ff_svq1_intra_codebooks[level];
110 mean_vlc = ff_svq1_intra_mean_vlc;
111 multistage_vlc = ff_svq1_intra_multistage_vlc[level];
112 for (y = 0; y < h; y++) {
113 for (x = 0; x < w; x++) {
114 int v = src[x + y * stride];
115 block[0][x + w * y] = v;
121 codebook_sum = svq1_inter_codebook_sum[level];
122 codebook = ff_svq1_inter_codebooks[level];
123 mean_vlc = ff_svq1_inter_mean_vlc + 256;
124 multistage_vlc = ff_svq1_inter_multistage_vlc[level];
125 for (y = 0; y < h; y++) {
126 for (x = 0; x < w; x++) {
127 int v = src[x + y * stride] - ref[x + y * stride];
128 block[0][x + w * y] = v;
136 best_score -= (int)((unsigned)block_sum[0] * block_sum[0] >> (level + 3));
137 best_mean = block_sum[0] + (size >> 1) >> (level + 3);
140 for (count = 1; count < 7; count++) {
141 int best_vector_score = INT_MAX;
142 int best_vector_sum = -999, best_vector_mean = -999;
143 const int stage = count - 1;
144 const int8_t *vector;
146 for (i = 0; i < 16; i++) {
147 int sum = codebook_sum[stage * 16 + i];
148 int sqr, diff, score;
150 vector = codebook + stage * size * 16 + i * size;
151 sqr = s->ssd_int8_vs_int16(vector, block[stage], size);
152 diff = block_sum[stage] - sum;
153 score = sqr - (diff * (int64_t)diff >> (level + 3)); // FIXME: 64 bits slooow
154 if (score < best_vector_score) {
155 int mean = diff + (size >> 1) >> (level + 3);
156 assert(mean > -300 && mean < 300);
157 mean = av_clip(mean, intra ? 0 : -256, 255);
158 best_vector_score = score;
159 best_vector[stage] = i;
160 best_vector_sum = sum;
161 best_vector_mean = mean;
164 assert(best_vector_mean != -999);
165 vector = codebook + stage * size * 16 + best_vector[stage] * size;
166 for (j = 0; j < size; j++)
167 block[stage + 1][j] = block[stage][j] - vector[j];
168 block_sum[stage + 1] = block_sum[stage] - best_vector_sum;
169 best_vector_score += lambda *
171 multistage_vlc[1 + count][1]
172 + mean_vlc[best_vector_mean][1]);
174 if (best_vector_score < best_score) {
175 best_score = best_vector_score;
177 best_mean = best_vector_mean;
183 if (best_score > threshold && level) {
185 int offset = level & 1 ? stride * h / 2 : w / 2;
186 PutBitContext backup[6];
188 for (i = level - 1; i >= 0; i--)
189 backup[i] = s->reorder_pb[i];
190 score += encode_block(s, src, ref, decoded, stride, level - 1,
191 threshold >> 1, lambda, intra);
192 score += encode_block(s, src + offset, ref + offset, decoded + offset,
193 stride, level - 1, threshold >> 1, lambda, intra);
196 if (score < best_score) {
200 for (i = level - 1; i >= 0; i--)
201 s->reorder_pb[i] = backup[i];
205 put_bits(&s->reorder_pb[level], 1, split);
208 assert(best_mean >= 0 && best_mean < 256 || !intra);
209 assert(best_mean >= -256 && best_mean < 256);
210 assert(best_count >= 0 && best_count < 7);
211 assert(level < 4 || best_count == 0);
213 /* output the encoding */
214 put_bits(&s->reorder_pb[level],
215 multistage_vlc[1 + best_count][1],
216 multistage_vlc[1 + best_count][0]);
217 put_bits(&s->reorder_pb[level], mean_vlc[best_mean][1],
218 mean_vlc[best_mean][0]);
220 for (i = 0; i < best_count; i++) {
221 assert(best_vector[i] >= 0 && best_vector[i] < 16);
222 put_bits(&s->reorder_pb[level], 4, best_vector[i]);
225 for (y = 0; y < h; y++)
226 for (x = 0; x < w; x++)
227 decoded[x + y * stride] = src[x + y * stride] -
228 block[best_count][x + w * y] +
235 static int svq1_encode_plane(SVQ1EncContext *s, int plane,
236 unsigned char *src_plane,
237 unsigned char *ref_plane,
238 unsigned char *decoded_plane,
239 int width, int height, int src_stride, int stride)
243 int block_width, block_height;
246 uint8_t *src = s->scratchbuf + stride * 16;
247 const int lambda = (s->quality * s->quality) >>
248 (2 * FF_LAMBDA_SHIFT);
250 /* figure out the acceptable level thresholds in advance */
251 threshold[5] = QUALITY_THRESHOLD;
252 for (level = 4; level >= 0; level--)
253 threshold[level] = threshold[level + 1] * THRESHOLD_MULTIPLIER;
255 block_width = (width + 15) / 16;
256 block_height = (height + 15) / 16;
258 if (s->pict_type == AV_PICTURE_TYPE_P) {
259 s->m.avctx = s->avctx;
260 s->m.current_picture_ptr = &s->m.current_picture;
261 s->m.last_picture_ptr = &s->m.last_picture;
262 s->m.last_picture.f->data[0] = ref_plane;
264 s->m.last_picture.f->linesize[0] =
265 s->m.new_picture.f->linesize[0] =
266 s->m.current_picture.f->linesize[0] = stride;
268 s->m.height = height;
269 s->m.mb_width = block_width;
270 s->m.mb_height = block_height;
271 s->m.mb_stride = s->m.mb_width + 1;
272 s->m.b8_stride = 2 * s->m.mb_width + 1;
274 s->m.pict_type = s->pict_type;
275 #if FF_API_MOTION_EST
276 FF_DISABLE_DEPRECATION_WARNINGS
277 s->m.me_method = s->avctx->me_method;
278 if (s->motion_est == FF_ME_EPZS) {
279 if (s->avctx->me_method == ME_ZERO)
280 s->motion_est = FF_ME_ZERO;
281 else if (s->avctx->me_method == ME_EPZS)
282 s->motion_est = FF_ME_EPZS;
283 else if (s->avctx->me_method == ME_X1)
284 s->motion_est = FF_ME_XONE;
286 FF_ENABLE_DEPRECATION_WARNINGS
288 s->m.motion_est = s->motion_est;
289 s->m.me.scene_change_score = 0;
290 // s->m.out_format = FMT_H263;
291 // s->m.unrestricted_mv = 1;
292 s->m.lambda = s->quality;
293 s->m.qscale = s->m.lambda * 139 +
294 FF_LAMBDA_SCALE * 64 >>
296 s->m.lambda2 = s->m.lambda * s->m.lambda +
297 FF_LAMBDA_SCALE / 2 >>
300 if (!s->motion_val8[plane]) {
301 s->motion_val8[plane] = av_mallocz((s->m.b8_stride *
302 block_height * 2 + 2) *
303 2 * sizeof(int16_t));
304 s->motion_val16[plane] = av_mallocz((s->m.mb_stride *
305 (block_height + 2) + 1) *
306 2 * sizeof(int16_t));
307 if (!s->motion_val8[plane] || !s->motion_val16[plane])
308 return AVERROR(ENOMEM);
311 s->m.mb_type = s->mb_type;
313 // dummies, to avoid segfaults
314 s->m.current_picture.mb_mean = (uint8_t *)s->dummy;
315 s->m.current_picture.mb_var = (uint16_t *)s->dummy;
316 s->m.current_picture.mc_mb_var = (uint16_t *)s->dummy;
317 s->m.current_picture.mb_type = s->dummy;
319 s->m.current_picture.motion_val[0] = s->motion_val8[plane] + 2;
320 s->m.p_mv_table = s->motion_val16[plane] +
322 s->m.mecc = s->mecc; // move
325 s->m.me.dia_size = s->avctx->dia_size;
326 s->m.first_slice_line = 1;
327 for (y = 0; y < block_height; y++) {
328 s->m.new_picture.f->data[0] = src - y * 16 * stride; // ugly
331 for (i = 0; i < 16 && i + 16 * y < height; i++) {
332 memcpy(&src[i * stride], &src_plane[(i + 16 * y) * src_stride],
334 for (x = width; x < 16 * block_width; x++)
335 src[i * stride + x] = src[i * stride + x - 1];
337 for (; i < 16 && i + 16 * y < 16 * block_height; i++)
338 memcpy(&src[i * stride], &src[(i - 1) * stride],
341 for (x = 0; x < block_width; x++) {
343 ff_init_block_index(&s->m);
344 ff_update_block_index(&s->m);
346 ff_estimate_p_frame_motion(&s->m, x, y);
348 s->m.first_slice_line = 0;
351 ff_fix_long_p_mvs(&s->m);
352 ff_fix_long_mvs(&s->m, NULL, 0, s->m.p_mv_table, s->m.f_code,
353 CANDIDATE_MB_TYPE_INTER, 0);
356 s->m.first_slice_line = 1;
357 for (y = 0; y < block_height; y++) {
358 for (i = 0; i < 16 && i + 16 * y < height; i++) {
359 memcpy(&src[i * stride], &src_plane[(i + 16 * y) * src_stride],
361 for (x = width; x < 16 * block_width; x++)
362 src[i * stride + x] = src[i * stride + x - 1];
364 for (; i < 16 && i + 16 * y < 16 * block_height; i++)
365 memcpy(&src[i * stride], &src[(i - 1) * stride], 16 * block_width);
368 for (x = 0; x < block_width; x++) {
369 uint8_t reorder_buffer[3][6][7 * 32];
371 int offset = y * 16 * stride + x * 16;
372 uint8_t *decoded = decoded_plane + offset;
373 uint8_t *ref = ref_plane + offset;
374 int score[4] = { 0, 0, 0, 0 }, best;
375 uint8_t *temp = s->scratchbuf;
377 if (s->pb.buf_end - s->pb.buf -
378 (put_bits_count(&s->pb) >> 3) < 3000) { // FIXME: check size
379 av_log(s->avctx, AV_LOG_ERROR, "encoded frame too large\n");
384 ff_init_block_index(&s->m);
385 ff_update_block_index(&s->m);
387 if (s->pict_type == AV_PICTURE_TYPE_I ||
388 (s->m.mb_type[x + y * s->m.mb_stride] &
389 CANDIDATE_MB_TYPE_INTRA)) {
390 for (i = 0; i < 6; i++)
391 init_put_bits(&s->reorder_pb[i], reorder_buffer[0][i],
393 if (s->pict_type == AV_PICTURE_TYPE_P) {
394 const uint8_t *vlc = ff_svq1_block_type_vlc[SVQ1_BLOCK_INTRA];
395 put_bits(&s->reorder_pb[5], vlc[1], vlc[0]);
396 score[0] = vlc[1] * lambda;
398 score[0] += encode_block(s, src + 16 * x, NULL, temp, stride,
400 for (i = 0; i < 6; i++) {
401 count[0][i] = put_bits_count(&s->reorder_pb[i]);
402 flush_put_bits(&s->reorder_pb[i]);
409 if (s->pict_type == AV_PICTURE_TYPE_P) {
410 const uint8_t *vlc = ff_svq1_block_type_vlc[SVQ1_BLOCK_INTER];
411 int mx, my, pred_x, pred_y, dxy;
414 motion_ptr = ff_h263_pred_motion(&s->m, 0, 0, &pred_x, &pred_y);
415 if (s->m.mb_type[x + y * s->m.mb_stride] &
416 CANDIDATE_MB_TYPE_INTER) {
417 for (i = 0; i < 6; i++)
418 init_put_bits(&s->reorder_pb[i], reorder_buffer[1][i],
421 put_bits(&s->reorder_pb[5], vlc[1], vlc[0]);
423 s->m.pb = s->reorder_pb[5];
426 assert(mx >= -32 && mx <= 31);
427 assert(my >= -32 && my <= 31);
428 assert(pred_x >= -32 && pred_x <= 31);
429 assert(pred_y >= -32 && pred_y <= 31);
430 ff_h263_encode_motion(&s->m, mx - pred_x, 1);
431 ff_h263_encode_motion(&s->m, my - pred_y, 1);
432 s->reorder_pb[5] = s->m.pb;
433 score[1] += lambda * put_bits_count(&s->reorder_pb[5]);
435 dxy = (mx & 1) + 2 * (my & 1);
437 s->hdsp.put_pixels_tab[0][dxy](temp + 16,
442 score[1] += encode_block(s, src + 16 * x, temp + 16,
443 decoded, stride, 5, 64, lambda, 0);
444 best = score[1] <= score[0];
446 vlc = ff_svq1_block_type_vlc[SVQ1_BLOCK_SKIP];
447 score[2] = s->mecc.sse[0](NULL, src + 16 * x, ref,
449 score[2] += vlc[1] * lambda;
450 if (score[2] < score[best] && mx == 0 && my == 0) {
452 s->hdsp.put_pixels_tab[0][0](decoded, ref, stride, 16);
453 for (i = 0; i < 6; i++)
455 put_bits(&s->pb, vlc[1], vlc[0]);
460 for (i = 0; i < 6; i++) {
461 count[1][i] = put_bits_count(&s->reorder_pb[i]);
462 flush_put_bits(&s->reorder_pb[i]);
469 motion_ptr[0 + 2 * s->m.b8_stride] =
470 motion_ptr[1 + 2 * s->m.b8_stride] =
471 motion_ptr[2 + 2 * s->m.b8_stride] =
472 motion_ptr[3 + 2 * s->m.b8_stride] = 0;
476 s->rd_total += score[best];
478 for (i = 5; i >= 0; i--)
479 avpriv_copy_bits(&s->pb, reorder_buffer[best][i],
482 s->hdsp.put_pixels_tab[0][0](decoded, temp, stride, 16);
484 s->m.first_slice_line = 0;
489 static av_cold int svq1_encode_end(AVCodecContext *avctx)
491 SVQ1EncContext *const s = avctx->priv_data;
494 av_log(avctx, AV_LOG_DEBUG, "RD: %f\n",
495 s->rd_total / (double)(avctx->width * avctx->height *
496 avctx->frame_number));
499 ff_mpv_common_end(&s->m);
501 av_freep(&s->m.me.scratchpad);
502 av_freep(&s->m.me.map);
503 av_freep(&s->m.me.score_map);
504 av_freep(&s->mb_type);
506 av_freep(&s->scratchbuf);
508 for (i = 0; i < 3; i++) {
509 av_freep(&s->motion_val8[i]);
510 av_freep(&s->motion_val16[i]);
513 av_frame_free(&s->current_picture);
514 av_frame_free(&s->last_picture);
519 static av_cold int svq1_encode_init(AVCodecContext *avctx)
521 SVQ1EncContext *const s = avctx->priv_data;
524 ff_hpeldsp_init(&s->hdsp, avctx->flags);
525 ff_me_cmp_init(&s->mecc, avctx);
526 ff_mpegvideoencdsp_init(&s->m.mpvencdsp, avctx);
528 s->current_picture = av_frame_alloc();
529 s->last_picture = av_frame_alloc();
530 if (!s->current_picture || !s->last_picture) {
531 svq1_encode_end(avctx);
532 return AVERROR(ENOMEM);
535 s->frame_width = avctx->width;
536 s->frame_height = avctx->height;
538 s->y_block_width = (s->frame_width + 15) / 16;
539 s->y_block_height = (s->frame_height + 15) / 16;
541 s->c_block_width = (s->frame_width / 4 + 15) / 16;
542 s->c_block_height = (s->frame_height / 4 + 15) / 16;
547 if ((ret = ff_mpv_common_init(&s->m)) < 0) {
548 svq1_encode_end(avctx);
552 s->m.picture_structure = PICT_FRAME;
554 s->m.me.scratchpad = av_mallocz((avctx->width + 64) *
555 2 * 16 * 2 * sizeof(uint8_t));
556 s->m.me.map = av_mallocz(ME_MAP_SIZE * sizeof(uint32_t));
557 s->m.me.score_map = av_mallocz(ME_MAP_SIZE * sizeof(uint32_t));
558 s->mb_type = av_mallocz((s->y_block_width + 1) *
559 s->y_block_height * sizeof(int16_t));
560 s->dummy = av_mallocz((s->y_block_width + 1) *
561 s->y_block_height * sizeof(int32_t));
562 s->ssd_int8_vs_int16 = ssd_int8_vs_int16_c;
564 if (!s->m.me.temp || !s->m.me.scratchpad || !s->m.me.map ||
565 !s->m.me.score_map || !s->mb_type || !s->dummy) {
566 svq1_encode_end(avctx);
567 return AVERROR(ENOMEM);
571 ff_svq1enc_init_ppc(s);
573 ff_svq1enc_init_x86(s);
575 ff_h263_encode_init(&s->m); // mv_penalty
580 static int svq1_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
581 const AVFrame *pict, int *got_packet)
583 SVQ1EncContext *const s = avctx->priv_data;
588 (ret = av_new_packet(pkt, s->y_block_width * s->y_block_height *
589 MAX_MB_BYTES * 3 + AV_INPUT_BUFFER_MIN_SIZE)) < 0) {
590 av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
594 if (avctx->pix_fmt != AV_PIX_FMT_YUV410P) {
595 av_log(avctx, AV_LOG_ERROR, "unsupported pixel format\n");
599 if (!s->current_picture->data[0]) {
600 ret = ff_get_buffer(avctx, s->current_picture, 0);
604 if (!s->last_picture->data[0]) {
605 ret = ff_get_buffer(avctx, s->last_picture, 0);
609 if (!s->scratchbuf) {
610 s->scratchbuf = av_malloc(s->current_picture->linesize[0] * 16 * 2);
612 return AVERROR(ENOMEM);
615 FFSWAP(AVFrame*, s->current_picture, s->last_picture);
617 init_put_bits(&s->pb, pkt->data, pkt->size);
619 if (avctx->gop_size && (avctx->frame_number % avctx->gop_size))
620 s->pict_type = AV_PICTURE_TYPE_P;
622 s->pict_type = AV_PICTURE_TYPE_I;
623 s->quality = pict->quality;
625 #if FF_API_CODED_FRAME
626 FF_DISABLE_DEPRECATION_WARNINGS
627 avctx->coded_frame->pict_type = s->pict_type;
628 avctx->coded_frame->key_frame = s->pict_type == AV_PICTURE_TYPE_I;
629 FF_ENABLE_DEPRECATION_WARNINGS
632 sd = av_packet_new_side_data(pkt, AV_PKT_DATA_QUALITY_FACTOR, sizeof(int));
634 return AVERROR(ENOMEM);
635 *(int *)sd = pict->quality;
637 svq1_write_header(s, s->pict_type);
638 for (i = 0; i < 3; i++)
639 if (svq1_encode_plane(s, i,
641 s->last_picture->data[i],
642 s->current_picture->data[i],
643 s->frame_width / (i ? 4 : 1),
644 s->frame_height / (i ? 4 : 1),
646 s->current_picture->linesize[i]) < 0) {
648 for (j = 0; j < i; j++) {
649 av_freep(&s->motion_val8[j]);
650 av_freep(&s->motion_val16[j]);
652 av_freep(&s->scratchbuf);
656 // avpriv_align_put_bits(&s->pb);
657 while (put_bits_count(&s->pb) & 31)
658 put_bits(&s->pb, 1, 0);
660 flush_put_bits(&s->pb);
662 pkt->size = put_bits_count(&s->pb) / 8;
663 if (s->pict_type == AV_PICTURE_TYPE_I)
664 pkt->flags |= AV_PKT_FLAG_KEY;
670 #define OFFSET(x) offsetof(struct SVQ1EncContext, x)
671 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
672 static const AVOption options[] = {
673 { "motion-est", "Motion estimation algorithm", OFFSET(motion_est), AV_OPT_TYPE_INT, { .i64 = FF_ME_EPZS }, FF_ME_ZERO, FF_ME_XONE, VE, "motion-est"},
674 { "zero", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FF_ME_ZERO }, 0, 0, FF_MPV_OPT_FLAGS, "motion-est" },
675 { "epzs", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FF_ME_EPZS }, 0, 0, FF_MPV_OPT_FLAGS, "motion-est" },
676 { "xone", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FF_ME_XONE }, 0, 0, FF_MPV_OPT_FLAGS, "motion-est" },
681 static const AVClass svq1enc_class = {
682 .class_name = "svq1enc",
683 .item_name = av_default_item_name,
685 .version = LIBAVUTIL_VERSION_INT,
688 AVCodec ff_svq1_encoder = {
690 .long_name = NULL_IF_CONFIG_SMALL("Sorenson Vector Quantizer 1 / Sorenson Video 1 / SVQ1"),
691 .type = AVMEDIA_TYPE_VIDEO,
692 .id = AV_CODEC_ID_SVQ1,
693 .priv_data_size = sizeof(SVQ1EncContext),
694 .priv_class = &svq1enc_class,
695 .init = svq1_encode_init,
696 .encode2 = svq1_encode_frame,
697 .close = svq1_encode_end,
698 .pix_fmts = (const enum AVPixelFormat[]) { AV_PIX_FMT_YUV410P,