3 * Copyright (c) 2006 Justin Ruggles <justin.ruggles@gmail.com>
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
22 #include "libavutil/avassert.h"
23 #include "libavutil/crc.h"
24 #include "libavutil/intmath.h"
25 #include "libavutil/md5.h"
26 #include "libavutil/opt.h"
37 #define FLAC_SUBFRAME_CONSTANT 0
38 #define FLAC_SUBFRAME_VERBATIM 1
39 #define FLAC_SUBFRAME_FIXED 8
40 #define FLAC_SUBFRAME_LPC 32
42 #define MAX_FIXED_ORDER 4
43 #define MAX_PARTITION_ORDER 8
44 #define MAX_PARTITIONS (1 << MAX_PARTITION_ORDER)
45 #define MAX_LPC_PRECISION 15
46 #define MAX_LPC_SHIFT 15
50 CODING_MODE_RICE2 = 5,
53 typedef struct CompressionOptions {
54 int compression_level;
56 enum FFLPCType lpc_type;
58 int lpc_coeff_precision;
59 int min_prediction_order;
60 int max_prediction_order;
61 int prediction_order_method;
62 int min_partition_order;
63 int max_partition_order;
67 typedef struct RiceContext {
68 enum CodingMode coding_mode;
70 int params[MAX_PARTITIONS];
73 typedef struct FlacSubframe {
79 int32_t coefs[MAX_LPC_ORDER];
82 int32_t samples[FLAC_MAX_BLOCKSIZE];
83 int32_t residual[FLAC_MAX_BLOCKSIZE+1];
86 typedef struct FlacFrame {
87 FlacSubframe subframes[FLAC_MAX_CHANNELS];
95 typedef struct FlacEncodeContext {
105 int max_encoded_framesize;
106 uint32_t frame_count;
107 uint64_t sample_count;
110 CompressionOptions options;
111 AVCodecContext *avctx;
113 struct AVMD5 *md5ctx;
115 unsigned int md5_buffer_size;
117 FLACDSPContext flac_dsp;
122 * Write streaminfo metadata block to byte array.
124 static void write_streaminfo(FlacEncodeContext *s, uint8_t *header)
128 memset(header, 0, FLAC_STREAMINFO_SIZE);
129 init_put_bits(&pb, header, FLAC_STREAMINFO_SIZE);
131 /* streaminfo metadata block */
132 put_bits(&pb, 16, s->max_blocksize);
133 put_bits(&pb, 16, s->max_blocksize);
134 put_bits(&pb, 24, s->min_framesize);
135 put_bits(&pb, 24, s->max_framesize);
136 put_bits(&pb, 20, s->samplerate);
137 put_bits(&pb, 3, s->channels-1);
138 put_bits(&pb, 5, s->avctx->bits_per_raw_sample - 1);
139 /* write 36-bit sample count in 2 put_bits() calls */
140 put_bits(&pb, 24, (s->sample_count & 0xFFFFFF000LL) >> 12);
141 put_bits(&pb, 12, s->sample_count & 0x000000FFFLL);
143 memcpy(&header[18], s->md5sum, 16);
148 * Set blocksize based on samplerate.
149 * Choose the closest predefined blocksize >= BLOCK_TIME_MS milliseconds.
151 static int select_blocksize(int samplerate, int block_time_ms)
157 av_assert0(samplerate > 0);
158 blocksize = ff_flac_blocksize_table[1];
159 target = (samplerate * block_time_ms) / 1000;
160 for (i = 0; i < 16; i++) {
161 if (target >= ff_flac_blocksize_table[i] &&
162 ff_flac_blocksize_table[i] > blocksize) {
163 blocksize = ff_flac_blocksize_table[i];
170 static av_cold void dprint_compression_options(FlacEncodeContext *s)
172 AVCodecContext *avctx = s->avctx;
173 CompressionOptions *opt = &s->options;
175 av_log(avctx, AV_LOG_DEBUG, " compression: %d\n", opt->compression_level);
177 switch (opt->lpc_type) {
178 case FF_LPC_TYPE_NONE:
179 av_log(avctx, AV_LOG_DEBUG, " lpc type: None\n");
181 case FF_LPC_TYPE_FIXED:
182 av_log(avctx, AV_LOG_DEBUG, " lpc type: Fixed pre-defined coefficients\n");
184 case FF_LPC_TYPE_LEVINSON:
185 av_log(avctx, AV_LOG_DEBUG, " lpc type: Levinson-Durbin recursion with Welch window\n");
187 case FF_LPC_TYPE_CHOLESKY:
188 av_log(avctx, AV_LOG_DEBUG, " lpc type: Cholesky factorization, %d pass%s\n",
189 opt->lpc_passes, opt->lpc_passes == 1 ? "" : "es");
193 av_log(avctx, AV_LOG_DEBUG, " prediction order: %d, %d\n",
194 opt->min_prediction_order, opt->max_prediction_order);
196 switch (opt->prediction_order_method) {
197 case ORDER_METHOD_EST:
198 av_log(avctx, AV_LOG_DEBUG, " order method: %s\n", "estimate");
200 case ORDER_METHOD_2LEVEL:
201 av_log(avctx, AV_LOG_DEBUG, " order method: %s\n", "2-level");
203 case ORDER_METHOD_4LEVEL:
204 av_log(avctx, AV_LOG_DEBUG, " order method: %s\n", "4-level");
206 case ORDER_METHOD_8LEVEL:
207 av_log(avctx, AV_LOG_DEBUG, " order method: %s\n", "8-level");
209 case ORDER_METHOD_SEARCH:
210 av_log(avctx, AV_LOG_DEBUG, " order method: %s\n", "full search");
212 case ORDER_METHOD_LOG:
213 av_log(avctx, AV_LOG_DEBUG, " order method: %s\n", "log search");
218 av_log(avctx, AV_LOG_DEBUG, " partition order: %d, %d\n",
219 opt->min_partition_order, opt->max_partition_order);
221 av_log(avctx, AV_LOG_DEBUG, " block size: %d\n", avctx->frame_size);
223 av_log(avctx, AV_LOG_DEBUG, " lpc precision: %d\n",
224 opt->lpc_coeff_precision);
228 static av_cold int flac_encode_init(AVCodecContext *avctx)
230 int freq = avctx->sample_rate;
231 int channels = avctx->channels;
232 FlacEncodeContext *s = avctx->priv_data;
238 switch (avctx->sample_fmt) {
239 case AV_SAMPLE_FMT_S16:
240 avctx->bits_per_raw_sample = 16;
243 case AV_SAMPLE_FMT_S32:
244 if (avctx->bits_per_raw_sample != 24)
245 av_log(avctx, AV_LOG_WARNING, "encoding as 24 bits-per-sample\n");
246 avctx->bits_per_raw_sample = 24;
251 if (channels < 1 || channels > FLAC_MAX_CHANNELS) {
252 av_log(avctx, AV_LOG_ERROR, "%d channels not supported (max %d)\n",
253 channels, FLAC_MAX_CHANNELS);
254 return AVERROR(EINVAL);
256 s->channels = channels;
258 /* find samplerate in table */
261 for (i = 4; i < 12; i++) {
262 if (freq == ff_flac_sample_rate_table[i]) {
263 s->samplerate = ff_flac_sample_rate_table[i];
269 /* if not in table, samplerate is non-standard */
271 if (freq % 1000 == 0 && freq < 255000) {
273 s->sr_code[1] = freq / 1000;
274 } else if (freq % 10 == 0 && freq < 655350) {
276 s->sr_code[1] = freq / 10;
277 } else if (freq < 65535) {
279 s->sr_code[1] = freq;
281 av_log(avctx, AV_LOG_ERROR, "%d Hz not supported\n", freq);
282 return AVERROR(EINVAL);
284 s->samplerate = freq;
287 /* set compression option defaults based on avctx->compression_level */
288 if (avctx->compression_level < 0)
289 s->options.compression_level = 5;
291 s->options.compression_level = avctx->compression_level;
293 level = s->options.compression_level;
295 av_log(avctx, AV_LOG_ERROR, "invalid compression level: %d\n",
296 s->options.compression_level);
297 return AVERROR(EINVAL);
300 s->options.block_time_ms = ((int[]){ 27, 27, 27,105,105,105,105,105,105,105,105,105,105})[level];
302 if (s->options.lpc_type == FF_LPC_TYPE_DEFAULT)
303 s->options.lpc_type = ((int[]){ FF_LPC_TYPE_FIXED, FF_LPC_TYPE_FIXED, FF_LPC_TYPE_FIXED,
304 FF_LPC_TYPE_LEVINSON, FF_LPC_TYPE_LEVINSON, FF_LPC_TYPE_LEVINSON,
305 FF_LPC_TYPE_LEVINSON, FF_LPC_TYPE_LEVINSON, FF_LPC_TYPE_LEVINSON,
306 FF_LPC_TYPE_LEVINSON, FF_LPC_TYPE_LEVINSON, FF_LPC_TYPE_LEVINSON,
307 FF_LPC_TYPE_LEVINSON})[level];
309 s->options.min_prediction_order = ((int[]){ 2, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1})[level];
310 s->options.max_prediction_order = ((int[]){ 3, 4, 4, 6, 8, 8, 8, 8, 12, 12, 12, 32, 32})[level];
312 if (s->options.prediction_order_method < 0)
313 s->options.prediction_order_method = ((int[]){ ORDER_METHOD_EST, ORDER_METHOD_EST, ORDER_METHOD_EST,
314 ORDER_METHOD_EST, ORDER_METHOD_EST, ORDER_METHOD_EST,
315 ORDER_METHOD_4LEVEL, ORDER_METHOD_LOG, ORDER_METHOD_4LEVEL,
316 ORDER_METHOD_LOG, ORDER_METHOD_SEARCH, ORDER_METHOD_LOG,
317 ORDER_METHOD_SEARCH})[level];
319 if (s->options.min_partition_order > s->options.max_partition_order) {
320 av_log(avctx, AV_LOG_ERROR, "invalid partition orders: min=%d max=%d\n",
321 s->options.min_partition_order, s->options.max_partition_order);
322 return AVERROR(EINVAL);
324 if (s->options.min_partition_order < 0)
325 s->options.min_partition_order = ((int[]){ 2, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0})[level];
326 if (s->options.max_partition_order < 0)
327 s->options.max_partition_order = ((int[]){ 2, 2, 3, 3, 3, 8, 8, 8, 8, 8, 8, 8, 8})[level];
329 if (s->options.lpc_type == FF_LPC_TYPE_NONE) {
330 s->options.min_prediction_order = 0;
331 } else if (avctx->min_prediction_order >= 0) {
332 if (s->options.lpc_type == FF_LPC_TYPE_FIXED) {
333 if (avctx->min_prediction_order > MAX_FIXED_ORDER) {
334 av_log(avctx, AV_LOG_ERROR, "invalid min prediction order: %d\n",
335 avctx->min_prediction_order);
336 return AVERROR(EINVAL);
338 } else if (avctx->min_prediction_order < MIN_LPC_ORDER ||
339 avctx->min_prediction_order > MAX_LPC_ORDER) {
340 av_log(avctx, AV_LOG_ERROR, "invalid min prediction order: %d\n",
341 avctx->min_prediction_order);
342 return AVERROR(EINVAL);
344 s->options.min_prediction_order = avctx->min_prediction_order;
346 if (s->options.lpc_type == FF_LPC_TYPE_NONE) {
347 s->options.max_prediction_order = 0;
348 } else if (avctx->max_prediction_order >= 0) {
349 if (s->options.lpc_type == FF_LPC_TYPE_FIXED) {
350 if (avctx->max_prediction_order > MAX_FIXED_ORDER) {
351 av_log(avctx, AV_LOG_ERROR, "invalid max prediction order: %d\n",
352 avctx->max_prediction_order);
353 return AVERROR(EINVAL);
355 } else if (avctx->max_prediction_order < MIN_LPC_ORDER ||
356 avctx->max_prediction_order > MAX_LPC_ORDER) {
357 av_log(avctx, AV_LOG_ERROR, "invalid max prediction order: %d\n",
358 avctx->max_prediction_order);
359 return AVERROR(EINVAL);
361 s->options.max_prediction_order = avctx->max_prediction_order;
363 if (s->options.max_prediction_order < s->options.min_prediction_order) {
364 av_log(avctx, AV_LOG_ERROR, "invalid prediction orders: min=%d max=%d\n",
365 s->options.min_prediction_order, s->options.max_prediction_order);
366 return AVERROR(EINVAL);
369 if (avctx->frame_size > 0) {
370 if (avctx->frame_size < FLAC_MIN_BLOCKSIZE ||
371 avctx->frame_size > FLAC_MAX_BLOCKSIZE) {
372 av_log(avctx, AV_LOG_ERROR, "invalid block size: %d\n",
374 return AVERROR(EINVAL);
377 s->avctx->frame_size = select_blocksize(s->samplerate, s->options.block_time_ms);
379 s->max_blocksize = s->avctx->frame_size;
381 /* set maximum encoded frame size in verbatim mode */
382 s->max_framesize = ff_flac_get_max_frame_size(s->avctx->frame_size,
384 s->avctx->bits_per_raw_sample);
386 /* initialize MD5 context */
387 s->md5ctx = av_md5_alloc();
389 return AVERROR(ENOMEM);
390 av_md5_init(s->md5ctx);
392 streaminfo = av_malloc(FLAC_STREAMINFO_SIZE);
394 return AVERROR(ENOMEM);
395 write_streaminfo(s, streaminfo);
396 avctx->extradata = streaminfo;
397 avctx->extradata_size = FLAC_STREAMINFO_SIZE;
400 s->min_framesize = s->max_framesize;
403 avctx->channel_layout != (AV_CH_LAYOUT_STEREO|AV_CH_FRONT_CENTER) ||
405 avctx->channel_layout != AV_CH_LAYOUT_2_2 &&
406 avctx->channel_layout != AV_CH_LAYOUT_QUAD ||
408 avctx->channel_layout != AV_CH_LAYOUT_5POINT0 &&
409 avctx->channel_layout != AV_CH_LAYOUT_5POINT0_BACK ||
411 avctx->channel_layout != AV_CH_LAYOUT_5POINT1 &&
412 avctx->channel_layout != AV_CH_LAYOUT_5POINT1_BACK) {
413 if (avctx->channel_layout) {
414 av_log(avctx, AV_LOG_ERROR, "Channel layout not supported by Flac, "
415 "output stream will have incorrect "
416 "channel layout.\n");
418 av_log(avctx, AV_LOG_WARNING, "No channel layout specified. The encoder "
419 "will use Flac channel layout for "
420 "%d channels.\n", channels);
424 ret = ff_lpc_init(&s->lpc_ctx, avctx->frame_size,
425 s->options.max_prediction_order, FF_LPC_TYPE_LEVINSON);
427 ff_dsputil_init(&s->dsp, avctx);
428 ff_flacdsp_init(&s->flac_dsp, avctx->sample_fmt,
429 avctx->bits_per_raw_sample);
431 dprint_compression_options(s);
437 static void init_frame(FlacEncodeContext *s, int nb_samples)
444 for (i = 0; i < 16; i++) {
445 if (nb_samples == ff_flac_blocksize_table[i]) {
446 frame->blocksize = ff_flac_blocksize_table[i];
447 frame->bs_code[0] = i;
448 frame->bs_code[1] = 0;
453 frame->blocksize = nb_samples;
454 if (frame->blocksize <= 256) {
455 frame->bs_code[0] = 6;
456 frame->bs_code[1] = frame->blocksize-1;
458 frame->bs_code[0] = 7;
459 frame->bs_code[1] = frame->blocksize-1;
463 for (ch = 0; ch < s->channels; ch++) {
464 FlacSubframe *sub = &frame->subframes[ch];
467 sub->obits = s->avctx->bits_per_raw_sample;
470 sub->rc.coding_mode = CODING_MODE_RICE2;
472 sub->rc.coding_mode = CODING_MODE_RICE;
475 frame->verbatim_only = 0;
480 * Copy channel-interleaved input samples into separate subframes.
482 static void copy_samples(FlacEncodeContext *s, const void *samples)
486 int shift = av_get_bytes_per_sample(s->avctx->sample_fmt) * 8 -
487 s->avctx->bits_per_raw_sample;
489 #define COPY_SAMPLES(bits) do { \
490 const int ## bits ## _t *samples0 = samples; \
492 for (i = 0, j = 0; i < frame->blocksize; i++) \
493 for (ch = 0; ch < s->channels; ch++, j++) \
494 frame->subframes[ch].samples[i] = samples0[j] >> shift; \
497 if (s->avctx->sample_fmt == AV_SAMPLE_FMT_S16)
504 static uint64_t rice_count_exact(int32_t *res, int n, int k)
509 for (i = 0; i < n; i++) {
510 int32_t v = -2 * res[i] - 1;
512 count += (v >> k) + 1 + k;
518 static uint64_t subframe_count_exact(FlacEncodeContext *s, FlacSubframe *sub,
521 int p, porder, psize;
525 /* subframe header */
529 if (sub->type == FLAC_SUBFRAME_CONSTANT) {
531 } else if (sub->type == FLAC_SUBFRAME_VERBATIM) {
532 count += s->frame.blocksize * sub->obits;
534 /* warm-up samples */
535 count += pred_order * sub->obits;
537 /* LPC coefficients */
538 if (sub->type == FLAC_SUBFRAME_LPC)
539 count += 4 + 5 + pred_order * s->options.lpc_coeff_precision;
541 /* rice-encoded block */
544 /* partition order */
545 porder = sub->rc.porder;
546 psize = s->frame.blocksize >> porder;
552 for (p = 0; p < 1 << porder; p++) {
553 int k = sub->rc.params[p];
554 count += sub->rc.coding_mode;
555 count += rice_count_exact(&sub->residual[i], part_end - i, k);
557 part_end = FFMIN(s->frame.blocksize, part_end + psize);
565 #define rice_encode_count(sum, n, k) (((n)*((k)+1))+((sum-(n>>1))>>(k)))
568 * Solve for d/dk(rice_encode_count) = n-((sum-(n>>1))>>(k+1)) = 0.
570 static int find_optimal_param(uint64_t sum, int n, int max_param)
577 sum2 = sum - (n >> 1);
578 k = av_log2(av_clipl_int32(sum2 / n));
579 return FFMIN(k, max_param);
583 static uint64_t calc_optimal_rice_params(RiceContext *rc, int porder,
584 uint64_t *sums, int n, int pred_order)
587 int k, cnt, part, max_param;
590 max_param = (1 << rc->coding_mode) - 2;
592 part = (1 << porder);
595 cnt = (n >> porder) - pred_order;
596 for (i = 0; i < part; i++) {
597 k = find_optimal_param(sums[i], cnt, max_param);
599 all_bits += rice_encode_count(sums[i], cnt, k);
609 static void calc_sums(int pmin, int pmax, uint32_t *data, int n, int pred_order,
610 uint64_t sums[][MAX_PARTITIONS])
614 uint32_t *res, *res_end;
616 /* sums for highest level */
618 res = &data[pred_order];
619 res_end = &data[n >> pmax];
620 for (i = 0; i < parts; i++) {
622 while (res < res_end)
625 res_end += n >> pmax;
627 /* sums for lower levels */
628 for (i = pmax - 1; i >= pmin; i--) {
630 for (j = 0; j < parts; j++)
631 sums[i][j] = sums[i+1][2*j] + sums[i+1][2*j+1];
636 static uint64_t calc_rice_params(RiceContext *rc, int pmin, int pmax,
637 int32_t *data, int n, int pred_order)
640 uint64_t bits[MAX_PARTITION_ORDER+1];
644 uint64_t sums[MAX_PARTITION_ORDER+1][MAX_PARTITIONS];
646 av_assert1(pmin >= 0 && pmin <= MAX_PARTITION_ORDER);
647 av_assert1(pmax >= 0 && pmax <= MAX_PARTITION_ORDER);
648 av_assert1(pmin <= pmax);
650 tmp_rc.coding_mode = rc->coding_mode;
652 udata = av_malloc(n * sizeof(uint32_t));
653 for (i = 0; i < n; i++)
654 udata[i] = (2*data[i]) ^ (data[i]>>31);
656 calc_sums(pmin, pmax, udata, n, pred_order, sums);
659 bits[pmin] = UINT32_MAX;
660 for (i = pmin; i <= pmax; i++) {
661 bits[i] = calc_optimal_rice_params(&tmp_rc, i, sums[i], n, pred_order);
662 if (bits[i] <= bits[opt_porder]) {
669 return bits[opt_porder];
673 static int get_max_p_order(int max_porder, int n, int order)
675 int porder = FFMIN(max_porder, av_log2(n^(n-1)));
677 porder = FFMIN(porder, av_log2(n/order));
682 static uint64_t find_subframe_rice_params(FlacEncodeContext *s,
683 FlacSubframe *sub, int pred_order)
685 int pmin = get_max_p_order(s->options.min_partition_order,
686 s->frame.blocksize, pred_order);
687 int pmax = get_max_p_order(s->options.max_partition_order,
688 s->frame.blocksize, pred_order);
690 uint64_t bits = 8 + pred_order * sub->obits + 2 + sub->rc.coding_mode;
691 if (sub->type == FLAC_SUBFRAME_LPC)
692 bits += 4 + 5 + pred_order * s->options.lpc_coeff_precision;
693 bits += calc_rice_params(&sub->rc, pmin, pmax, sub->residual,
694 s->frame.blocksize, pred_order);
699 static void encode_residual_fixed(int32_t *res, const int32_t *smp, int n,
704 for (i = 0; i < order; i++)
708 for (i = order; i < n; i++)
710 } else if (order == 1) {
711 for (i = order; i < n; i++)
712 res[i] = smp[i] - smp[i-1];
713 } else if (order == 2) {
714 int a = smp[order-1] - smp[order-2];
715 for (i = order; i < n; i += 2) {
716 int b = smp[i ] - smp[i-1];
718 a = smp[i+1] - smp[i ];
721 } else if (order == 3) {
722 int a = smp[order-1] - smp[order-2];
723 int c = smp[order-1] - 2*smp[order-2] + smp[order-3];
724 for (i = order; i < n; i += 2) {
725 int b = smp[i ] - smp[i-1];
728 a = smp[i+1] - smp[i ];
733 int a = smp[order-1] - smp[order-2];
734 int c = smp[order-1] - 2*smp[order-2] + smp[order-3];
735 int e = smp[order-1] - 3*smp[order-2] + 3*smp[order-3] - smp[order-4];
736 for (i = order; i < n; i += 2) {
737 int b = smp[i ] - smp[i-1];
741 a = smp[i+1] - smp[i ];
750 static int encode_residual_ch(FlacEncodeContext *s, int ch)
753 int min_order, max_order, opt_order, omethod;
756 int32_t coefs[MAX_LPC_ORDER][MAX_LPC_ORDER];
757 int shift[MAX_LPC_ORDER];
761 sub = &frame->subframes[ch];
764 n = frame->blocksize;
767 for (i = 1; i < n; i++)
771 sub->type = sub->type_code = FLAC_SUBFRAME_CONSTANT;
773 return subframe_count_exact(s, sub, 0);
777 if (frame->verbatim_only || n < 5) {
778 sub->type = sub->type_code = FLAC_SUBFRAME_VERBATIM;
779 memcpy(res, smp, n * sizeof(int32_t));
780 return subframe_count_exact(s, sub, 0);
783 min_order = s->options.min_prediction_order;
784 max_order = s->options.max_prediction_order;
785 omethod = s->options.prediction_order_method;
788 sub->type = FLAC_SUBFRAME_FIXED;
789 if (s->options.lpc_type == FF_LPC_TYPE_NONE ||
790 s->options.lpc_type == FF_LPC_TYPE_FIXED || n <= max_order) {
791 uint64_t bits[MAX_FIXED_ORDER+1];
792 if (max_order > MAX_FIXED_ORDER)
793 max_order = MAX_FIXED_ORDER;
795 bits[0] = UINT32_MAX;
796 for (i = min_order; i <= max_order; i++) {
797 encode_residual_fixed(res, smp, n, i);
798 bits[i] = find_subframe_rice_params(s, sub, i);
799 if (bits[i] < bits[opt_order])
802 sub->order = opt_order;
803 sub->type_code = sub->type | sub->order;
804 if (sub->order != max_order) {
805 encode_residual_fixed(res, smp, n, sub->order);
806 find_subframe_rice_params(s, sub, sub->order);
808 return subframe_count_exact(s, sub, sub->order);
812 sub->type = FLAC_SUBFRAME_LPC;
813 opt_order = ff_lpc_calc_coefs(&s->lpc_ctx, smp, n, min_order, max_order,
814 s->options.lpc_coeff_precision, coefs, shift, s->options.lpc_type,
815 s->options.lpc_passes, omethod,
818 if (omethod == ORDER_METHOD_2LEVEL ||
819 omethod == ORDER_METHOD_4LEVEL ||
820 omethod == ORDER_METHOD_8LEVEL) {
821 int levels = 1 << omethod;
822 uint64_t bits[1 << ORDER_METHOD_8LEVEL];
824 int opt_index = levels-1;
825 opt_order = max_order-1;
826 bits[opt_index] = UINT32_MAX;
827 for (i = levels-1; i >= 0; i--) {
828 int last_order = order;
829 order = min_order + (((max_order-min_order+1) * (i+1)) / levels)-1;
830 order = av_clip(order, min_order - 1, max_order - 1);
831 if (order == last_order)
833 s->flac_dsp.lpc_encode(res, smp, n, order+1, coefs[order],
835 bits[i] = find_subframe_rice_params(s, sub, order+1);
836 if (bits[i] < bits[opt_index]) {
842 } else if (omethod == ORDER_METHOD_SEARCH) {
843 // brute-force optimal order search
844 uint64_t bits[MAX_LPC_ORDER];
846 bits[0] = UINT32_MAX;
847 for (i = min_order-1; i < max_order; i++) {
848 s->flac_dsp.lpc_encode(res, smp, n, i+1, coefs[i], shift[i]);
849 bits[i] = find_subframe_rice_params(s, sub, i+1);
850 if (bits[i] < bits[opt_order])
854 } else if (omethod == ORDER_METHOD_LOG) {
855 uint64_t bits[MAX_LPC_ORDER];
858 opt_order = min_order - 1 + (max_order-min_order)/3;
859 memset(bits, -1, sizeof(bits));
861 for (step = 16; step; step >>= 1) {
862 int last = opt_order;
863 for (i = last-step; i <= last+step; i += step) {
864 if (i < min_order-1 || i >= max_order || bits[i] < UINT32_MAX)
866 s->flac_dsp.lpc_encode(res, smp, n, i+1, coefs[i], shift[i]);
867 bits[i] = find_subframe_rice_params(s, sub, i+1);
868 if (bits[i] < bits[opt_order])
875 sub->order = opt_order;
876 sub->type_code = sub->type | (sub->order-1);
877 sub->shift = shift[sub->order-1];
878 for (i = 0; i < sub->order; i++)
879 sub->coefs[i] = coefs[sub->order-1][i];
881 s->flac_dsp.lpc_encode(res, smp, n, sub->order, sub->coefs, sub->shift);
883 find_subframe_rice_params(s, sub, sub->order);
885 return subframe_count_exact(s, sub, sub->order);
889 static int count_frame_header(FlacEncodeContext *s)
891 uint8_t av_unused tmp;
897 <1> Blocking strategy
898 <4> Block size in inter-channel samples
900 <4> Channel assignment
901 <3> Sample size in bits
906 /* coded frame number */
907 PUT_UTF8(s->frame_count, tmp, count += 8;)
909 /* explicit block size */
910 if (s->frame.bs_code[0] == 6)
912 else if (s->frame.bs_code[0] == 7)
915 /* explicit sample rate */
916 count += ((s->sr_code[0] == 12) + (s->sr_code[0] > 12)) * 8;
918 /* frame header CRC-8 */
925 static int encode_frame(FlacEncodeContext *s)
930 count = count_frame_header(s);
932 for (ch = 0; ch < s->channels; ch++)
933 count += encode_residual_ch(s, ch);
935 count += (8 - (count & 7)) & 7; // byte alignment
936 count += 16; // CRC-16
945 static void remove_wasted_bits(FlacEncodeContext *s)
949 for (ch = 0; ch < s->channels; ch++) {
950 FlacSubframe *sub = &s->frame.subframes[ch];
953 for (i = 0; i < s->frame.blocksize; i++) {
954 v |= sub->samples[i];
962 for (i = 0; i < s->frame.blocksize; i++)
963 sub->samples[i] >>= v;
968 /* for 24-bit, check if removing wasted bits makes the range better
969 suited for using RICE instead of RICE2 for entropy coding */
970 if (sub->obits <= 17)
971 sub->rc.coding_mode = CODING_MODE_RICE;
977 static int estimate_stereo_mode(int32_t *left_ch, int32_t *right_ch, int n,
986 /* calculate sum of 2nd order residual for each channel */
987 sum[0] = sum[1] = sum[2] = sum[3] = 0;
988 for (i = 2; i < n; i++) {
989 lt = left_ch[i] - 2*left_ch[i-1] + left_ch[i-2];
990 rt = right_ch[i] - 2*right_ch[i-1] + right_ch[i-2];
991 sum[2] += FFABS((lt + rt) >> 1);
992 sum[3] += FFABS(lt - rt);
996 /* estimate bit counts */
997 for (i = 0; i < 4; i++) {
998 k = find_optimal_param(2 * sum[i], n, max_rice_param);
999 sum[i] = rice_encode_count( 2 * sum[i], n, k);
1002 /* calculate score for each mode */
1003 score[0] = sum[0] + sum[1];
1004 score[1] = sum[0] + sum[3];
1005 score[2] = sum[1] + sum[3];
1006 score[3] = sum[2] + sum[3];
1008 /* return mode with lowest score */
1010 for (i = 1; i < 4; i++)
1011 if (score[i] < score[best])
1019 * Perform stereo channel decorrelation.
1021 static void channel_decorrelation(FlacEncodeContext *s)
1024 int32_t *left, *right;
1028 n = frame->blocksize;
1029 left = frame->subframes[0].samples;
1030 right = frame->subframes[1].samples;
1032 if (s->channels != 2) {
1033 frame->ch_mode = FLAC_CHMODE_INDEPENDENT;
1037 if (s->options.ch_mode < 0) {
1038 int max_rice_param = (1 << frame->subframes[0].rc.coding_mode) - 2;
1039 frame->ch_mode = estimate_stereo_mode(left, right, n, max_rice_param);
1041 frame->ch_mode = s->options.ch_mode;
1043 /* perform decorrelation and adjust bits-per-sample */
1044 if (frame->ch_mode == FLAC_CHMODE_INDEPENDENT)
1046 if (frame->ch_mode == FLAC_CHMODE_MID_SIDE) {
1048 for (i = 0; i < n; i++) {
1050 left[i] = (tmp + right[i]) >> 1;
1051 right[i] = tmp - right[i];
1053 frame->subframes[1].obits++;
1054 } else if (frame->ch_mode == FLAC_CHMODE_LEFT_SIDE) {
1055 for (i = 0; i < n; i++)
1056 right[i] = left[i] - right[i];
1057 frame->subframes[1].obits++;
1059 for (i = 0; i < n; i++)
1060 left[i] -= right[i];
1061 frame->subframes[0].obits++;
1066 static void write_utf8(PutBitContext *pb, uint32_t val)
1069 PUT_UTF8(val, tmp, put_bits(pb, 8, tmp);)
1073 static void write_frame_header(FlacEncodeContext *s)
1080 put_bits(&s->pb, 16, 0xFFF8);
1081 put_bits(&s->pb, 4, frame->bs_code[0]);
1082 put_bits(&s->pb, 4, s->sr_code[0]);
1084 if (frame->ch_mode == FLAC_CHMODE_INDEPENDENT)
1085 put_bits(&s->pb, 4, s->channels-1);
1087 put_bits(&s->pb, 4, frame->ch_mode + FLAC_MAX_CHANNELS - 1);
1089 put_bits(&s->pb, 3, s->bps_code);
1090 put_bits(&s->pb, 1, 0);
1091 write_utf8(&s->pb, s->frame_count);
1093 if (frame->bs_code[0] == 6)
1094 put_bits(&s->pb, 8, frame->bs_code[1]);
1095 else if (frame->bs_code[0] == 7)
1096 put_bits(&s->pb, 16, frame->bs_code[1]);
1098 if (s->sr_code[0] == 12)
1099 put_bits(&s->pb, 8, s->sr_code[1]);
1100 else if (s->sr_code[0] > 12)
1101 put_bits(&s->pb, 16, s->sr_code[1]);
1103 flush_put_bits(&s->pb);
1104 crc = av_crc(av_crc_get_table(AV_CRC_8_ATM), 0, s->pb.buf,
1105 put_bits_count(&s->pb) >> 3);
1106 put_bits(&s->pb, 8, crc);
1110 static void write_subframes(FlacEncodeContext *s)
1114 for (ch = 0; ch < s->channels; ch++) {
1115 FlacSubframe *sub = &s->frame.subframes[ch];
1116 int i, p, porder, psize;
1118 int32_t *res = sub->residual;
1119 int32_t *frame_end = &sub->residual[s->frame.blocksize];
1121 /* subframe header */
1122 put_bits(&s->pb, 1, 0);
1123 put_bits(&s->pb, 6, sub->type_code);
1124 put_bits(&s->pb, 1, !!sub->wasted);
1126 put_bits(&s->pb, sub->wasted, 1);
1129 if (sub->type == FLAC_SUBFRAME_CONSTANT) {
1130 put_sbits(&s->pb, sub->obits, res[0]);
1131 } else if (sub->type == FLAC_SUBFRAME_VERBATIM) {
1132 while (res < frame_end)
1133 put_sbits(&s->pb, sub->obits, *res++);
1135 /* warm-up samples */
1136 for (i = 0; i < sub->order; i++)
1137 put_sbits(&s->pb, sub->obits, *res++);
1139 /* LPC coefficients */
1140 if (sub->type == FLAC_SUBFRAME_LPC) {
1141 int cbits = s->options.lpc_coeff_precision;
1142 put_bits( &s->pb, 4, cbits-1);
1143 put_sbits(&s->pb, 5, sub->shift);
1144 for (i = 0; i < sub->order; i++)
1145 put_sbits(&s->pb, cbits, sub->coefs[i]);
1148 /* rice-encoded block */
1149 put_bits(&s->pb, 2, sub->rc.coding_mode - 4);
1151 /* partition order */
1152 porder = sub->rc.porder;
1153 psize = s->frame.blocksize >> porder;
1154 put_bits(&s->pb, 4, porder);
1157 part_end = &sub->residual[psize];
1158 for (p = 0; p < 1 << porder; p++) {
1159 int k = sub->rc.params[p];
1160 put_bits(&s->pb, sub->rc.coding_mode, k);
1161 while (res < part_end)
1162 set_sr_golomb_flac(&s->pb, *res++, k, INT32_MAX, 0);
1163 part_end = FFMIN(frame_end, part_end + psize);
1170 static void write_frame_footer(FlacEncodeContext *s)
1173 flush_put_bits(&s->pb);
1174 crc = av_bswap16(av_crc(av_crc_get_table(AV_CRC_16_ANSI), 0, s->pb.buf,
1175 put_bits_count(&s->pb)>>3));
1176 put_bits(&s->pb, 16, crc);
1177 flush_put_bits(&s->pb);
1181 static int write_frame(FlacEncodeContext *s, AVPacket *avpkt)
1183 init_put_bits(&s->pb, avpkt->data, avpkt->size);
1184 write_frame_header(s);
1186 write_frame_footer(s);
1187 return put_bits_count(&s->pb) >> 3;
1191 static int update_md5_sum(FlacEncodeContext *s, const void *samples)
1194 int buf_size = s->frame.blocksize * s->channels *
1195 ((s->avctx->bits_per_raw_sample + 7) / 8);
1197 if (s->avctx->bits_per_raw_sample > 16 || HAVE_BIGENDIAN) {
1198 av_fast_malloc(&s->md5_buffer, &s->md5_buffer_size, buf_size);
1200 return AVERROR(ENOMEM);
1203 if (s->avctx->bits_per_raw_sample <= 16) {
1204 buf = (const uint8_t *)samples;
1206 s->dsp.bswap16_buf((uint16_t *)s->md5_buffer,
1207 (const uint16_t *)samples, buf_size / 2);
1208 buf = s->md5_buffer;
1212 const int32_t *samples0 = samples;
1213 uint8_t *tmp = s->md5_buffer;
1215 for (i = 0; i < s->frame.blocksize * s->channels; i++) {
1216 int32_t v = samples0[i] >> 8;
1217 *tmp++ = (v ) & 0xFF;
1218 *tmp++ = (v >> 8) & 0xFF;
1219 *tmp++ = (v >> 16) & 0xFF;
1221 buf = s->md5_buffer;
1223 av_md5_update(s->md5ctx, buf, buf_size);
1229 static int flac_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
1230 const AVFrame *frame, int *got_packet_ptr)
1232 FlacEncodeContext *s;
1233 int frame_bytes, out_bytes, ret;
1235 s = avctx->priv_data;
1237 /* when the last block is reached, update the header in extradata */
1239 s->max_framesize = s->max_encoded_framesize;
1240 av_md5_final(s->md5ctx, s->md5sum);
1241 write_streaminfo(s, avctx->extradata);
1245 /* change max_framesize for small final frame */
1246 if (frame->nb_samples < s->frame.blocksize) {
1247 s->max_framesize = ff_flac_get_max_frame_size(frame->nb_samples,
1249 avctx->bits_per_raw_sample);
1252 init_frame(s, frame->nb_samples);
1254 copy_samples(s, frame->data[0]);
1256 channel_decorrelation(s);
1258 remove_wasted_bits(s);
1260 frame_bytes = encode_frame(s);
1262 /* fallback to verbatim mode if the compressed frame is larger than it
1263 would be if encoded uncompressed. */
1264 if (frame_bytes < 0 || frame_bytes > s->max_framesize) {
1265 s->frame.verbatim_only = 1;
1266 frame_bytes = encode_frame(s);
1267 if (frame_bytes < 0) {
1268 av_log(avctx, AV_LOG_ERROR, "Bad frame count\n");
1273 if ((ret = ff_alloc_packet2(avctx, avpkt, frame_bytes)) < 0)
1276 out_bytes = write_frame(s, avpkt);
1279 s->sample_count += frame->nb_samples;
1280 if ((ret = update_md5_sum(s, frame->data[0])) < 0) {
1281 av_log(avctx, AV_LOG_ERROR, "Error updating MD5 checksum\n");
1284 if (out_bytes > s->max_encoded_framesize)
1285 s->max_encoded_framesize = out_bytes;
1286 if (out_bytes < s->min_framesize)
1287 s->min_framesize = out_bytes;
1289 avpkt->pts = frame->pts;
1290 avpkt->duration = ff_samples_to_time_base(avctx, frame->nb_samples);
1291 avpkt->size = out_bytes;
1292 *got_packet_ptr = 1;
1297 static av_cold int flac_encode_close(AVCodecContext *avctx)
1299 if (avctx->priv_data) {
1300 FlacEncodeContext *s = avctx->priv_data;
1301 av_freep(&s->md5ctx);
1302 av_freep(&s->md5_buffer);
1303 ff_lpc_end(&s->lpc_ctx);
1305 av_freep(&avctx->extradata);
1306 avctx->extradata_size = 0;
1310 #define FLAGS AV_OPT_FLAG_ENCODING_PARAM | AV_OPT_FLAG_AUDIO_PARAM
1311 static const AVOption options[] = {
1312 { "lpc_coeff_precision", "LPC coefficient precision", offsetof(FlacEncodeContext, options.lpc_coeff_precision), AV_OPT_TYPE_INT, {.i64 = 15 }, 0, MAX_LPC_PRECISION, FLAGS },
1313 { "lpc_type", "LPC algorithm", offsetof(FlacEncodeContext, options.lpc_type), AV_OPT_TYPE_INT, {.i64 = FF_LPC_TYPE_DEFAULT }, FF_LPC_TYPE_DEFAULT, FF_LPC_TYPE_NB-1, FLAGS, "lpc_type" },
1314 { "none", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = FF_LPC_TYPE_NONE }, INT_MIN, INT_MAX, FLAGS, "lpc_type" },
1315 { "fixed", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = FF_LPC_TYPE_FIXED }, INT_MIN, INT_MAX, FLAGS, "lpc_type" },
1316 { "levinson", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = FF_LPC_TYPE_LEVINSON }, INT_MIN, INT_MAX, FLAGS, "lpc_type" },
1317 { "cholesky", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = FF_LPC_TYPE_CHOLESKY }, INT_MIN, INT_MAX, FLAGS, "lpc_type" },
1318 { "lpc_passes", "Number of passes to use for Cholesky factorization during LPC analysis", offsetof(FlacEncodeContext, options.lpc_passes), AV_OPT_TYPE_INT, {.i64 = 2 }, 1, INT_MAX, FLAGS },
1319 { "min_partition_order", NULL, offsetof(FlacEncodeContext, options.min_partition_order), AV_OPT_TYPE_INT, {.i64 = -1 }, -1, MAX_PARTITION_ORDER, FLAGS },
1320 { "max_partition_order", NULL, offsetof(FlacEncodeContext, options.max_partition_order), AV_OPT_TYPE_INT, {.i64 = -1 }, -1, MAX_PARTITION_ORDER, FLAGS },
1321 { "prediction_order_method", "Search method for selecting prediction order", offsetof(FlacEncodeContext, options.prediction_order_method), AV_OPT_TYPE_INT, {.i64 = -1 }, -1, ORDER_METHOD_LOG, FLAGS, "predm" },
1322 { "estimation", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = ORDER_METHOD_EST }, INT_MIN, INT_MAX, FLAGS, "predm" },
1323 { "2level", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = ORDER_METHOD_2LEVEL }, INT_MIN, INT_MAX, FLAGS, "predm" },
1324 { "4level", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = ORDER_METHOD_4LEVEL }, INT_MIN, INT_MAX, FLAGS, "predm" },
1325 { "8level", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = ORDER_METHOD_8LEVEL }, INT_MIN, INT_MAX, FLAGS, "predm" },
1326 { "search", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = ORDER_METHOD_SEARCH }, INT_MIN, INT_MAX, FLAGS, "predm" },
1327 { "log", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = ORDER_METHOD_LOG }, INT_MIN, INT_MAX, FLAGS, "predm" },
1328 { "ch_mode", "Stereo decorrelation mode", offsetof(FlacEncodeContext, options.ch_mode), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, FLAC_CHMODE_MID_SIDE, FLAGS, "ch_mode" },
1329 { "auto", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = -1 }, INT_MIN, INT_MAX, FLAGS, "ch_mode" },
1330 { "indep", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FLAC_CHMODE_INDEPENDENT }, INT_MIN, INT_MAX, FLAGS, "ch_mode" },
1331 { "left_side", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FLAC_CHMODE_LEFT_SIDE }, INT_MIN, INT_MAX, FLAGS, "ch_mode" },
1332 { "right_side", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FLAC_CHMODE_RIGHT_SIDE }, INT_MIN, INT_MAX, FLAGS, "ch_mode" },
1333 { "mid_side", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = FLAC_CHMODE_MID_SIDE }, INT_MIN, INT_MAX, FLAGS, "ch_mode" },
1337 static const AVClass flac_encoder_class = {
1339 av_default_item_name,
1341 LIBAVUTIL_VERSION_INT,
1344 AVCodec ff_flac_encoder = {
1346 .type = AVMEDIA_TYPE_AUDIO,
1347 .id = AV_CODEC_ID_FLAC,
1348 .priv_data_size = sizeof(FlacEncodeContext),
1349 .init = flac_encode_init,
1350 .encode2 = flac_encode_frame,
1351 .close = flac_encode_close,
1352 .capabilities = CODEC_CAP_SMALL_LAST_FRAME | CODEC_CAP_DELAY | CODEC_CAP_LOSSLESS,
1353 .sample_fmts = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
1355 AV_SAMPLE_FMT_NONE },
1356 .long_name = NULL_IF_CONFIG_SMALL("FLAC (Free Lossless Audio Codec)"),
1357 .priv_class = &flac_encoder_class,