2 * Copyright (c) 2012 Justin Ruggles <justin.ruggles@gmail.com>
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #include "libavutil/common.h"
24 #include "libavutil/libm.h"
25 #include "libavutil/samplefmt.h"
26 #include "avresample.h"
28 #include "audio_data.h"
29 #include "audio_mix.h"
31 static const char *coeff_type_names[] = { "q8", "q15", "flt" };
34 AVAudioResampleContext *avr;
35 enum AVSampleFormat fmt;
36 enum AVMixCoeffType coeff_type;
44 int has_optimized_func;
45 const char *func_descr;
46 const char *func_descr_generic;
48 mix_func *mix_generic;
50 int in_matrix_channels;
51 int out_matrix_channels;
52 int output_zero[AVRESAMPLE_MAX_CHANNELS];
53 int input_skip[AVRESAMPLE_MAX_CHANNELS];
54 int output_skip[AVRESAMPLE_MAX_CHANNELS];
55 int16_t *matrix_q8[AVRESAMPLE_MAX_CHANNELS];
56 int32_t *matrix_q15[AVRESAMPLE_MAX_CHANNELS];
57 float *matrix_flt[AVRESAMPLE_MAX_CHANNELS];
61 void ff_audio_mix_set_func(AudioMix *am, enum AVSampleFormat fmt,
62 enum AVMixCoeffType coeff_type, int in_channels,
63 int out_channels, int ptr_align, int samples_align,
64 const char *descr, void *mix_func)
66 if (fmt == am->fmt && coeff_type == am->coeff_type &&
67 ( in_channels == am->in_matrix_channels || in_channels == 0) &&
68 (out_channels == am->out_matrix_channels || out_channels == 0)) {
71 am->func_descr = descr;
72 am->ptr_align = ptr_align;
73 am->samples_align = samples_align;
74 if (ptr_align == 1 && samples_align == 1) {
75 am->mix_generic = mix_func;
76 am->func_descr_generic = descr;
78 am->has_optimized_func = 1;
82 snprintf(chan_str, sizeof(chan_str), "[%d to %d] ",
83 in_channels, out_channels);
85 snprintf(chan_str, sizeof(chan_str), "[%d to any] ",
87 } else if (out_channels) {
88 snprintf(chan_str, sizeof(chan_str), "[any to %d] ",
91 snprintf(chan_str, sizeof(chan_str), "[any to any] ");
93 av_log(am->avr, AV_LOG_DEBUG, "audio_mix: found function: [fmt=%s] "
94 "[c=%s] %s(%s)\n", av_get_sample_fmt_name(fmt),
95 coeff_type_names[coeff_type], chan_str, descr);
99 #define MIX_FUNC_NAME(fmt, cfmt) mix_any_ ## fmt ##_## cfmt ##_c
101 #define MIX_FUNC_GENERIC(fmt, cfmt, stype, ctype, sumtype, expr) \
102 static void MIX_FUNC_NAME(fmt, cfmt)(stype **samples, ctype **matrix, \
103 int len, int out_ch, int in_ch) \
106 stype temp[AVRESAMPLE_MAX_CHANNELS]; \
107 for (i = 0; i < len; i++) { \
108 for (out = 0; out < out_ch; out++) { \
110 for (in = 0; in < in_ch; in++) \
111 sum += samples[in][i] * matrix[out][in]; \
114 for (out = 0; out < out_ch; out++) \
115 samples[out][i] = temp[out]; \
119 MIX_FUNC_GENERIC(FLTP, FLT, float, float, float, sum)
120 MIX_FUNC_GENERIC(S16P, FLT, int16_t, float, float, av_clip_int16(lrintf(sum)))
121 MIX_FUNC_GENERIC(S16P, Q15, int16_t, int32_t, int64_t, av_clip_int16(sum >> 15))
122 MIX_FUNC_GENERIC(S16P, Q8, int16_t, int16_t, int32_t, av_clip_int16(sum >> 8))
124 /* TODO: templatize the channel-specific C functions */
126 static void mix_2_to_1_fltp_flt_c(float **samples, float **matrix, int len,
127 int out_ch, int in_ch)
129 float *src0 = samples[0];
130 float *src1 = samples[1];
132 float m0 = matrix[0][0];
133 float m1 = matrix[0][1];
136 *dst++ = *src0++ * m0 + *src1++ * m1;
137 *dst++ = *src0++ * m0 + *src1++ * m1;
138 *dst++ = *src0++ * m0 + *src1++ * m1;
139 *dst++ = *src0++ * m0 + *src1++ * m1;
143 *dst++ = *src0++ * m0 + *src1++ * m1;
148 static void mix_2_to_1_s16p_flt_c(int16_t **samples, float **matrix, int len,
149 int out_ch, int in_ch)
151 int16_t *src0 = samples[0];
152 int16_t *src1 = samples[1];
154 float m0 = matrix[0][0];
155 float m1 = matrix[0][1];
158 *dst++ = av_clip_int16(lrintf(*src0++ * m0 + *src1++ * m1));
159 *dst++ = av_clip_int16(lrintf(*src0++ * m0 + *src1++ * m1));
160 *dst++ = av_clip_int16(lrintf(*src0++ * m0 + *src1++ * m1));
161 *dst++ = av_clip_int16(lrintf(*src0++ * m0 + *src1++ * m1));
165 *dst++ = av_clip_int16(lrintf(*src0++ * m0 + *src1++ * m1));
170 static void mix_2_to_1_s16p_q8_c(int16_t **samples, int16_t **matrix, int len,
171 int out_ch, int in_ch)
173 int16_t *src0 = samples[0];
174 int16_t *src1 = samples[1];
176 int16_t m0 = matrix[0][0];
177 int16_t m1 = matrix[0][1];
180 *dst++ = (*src0++ * m0 + *src1++ * m1) >> 8;
181 *dst++ = (*src0++ * m0 + *src1++ * m1) >> 8;
182 *dst++ = (*src0++ * m0 + *src1++ * m1) >> 8;
183 *dst++ = (*src0++ * m0 + *src1++ * m1) >> 8;
187 *dst++ = (*src0++ * m0 + *src1++ * m1) >> 8;
192 static void mix_1_to_2_fltp_flt_c(float **samples, float **matrix, int len,
193 int out_ch, int in_ch)
196 float *dst0 = samples[0];
197 float *dst1 = samples[1];
199 float m0 = matrix[0][0];
200 float m1 = matrix[1][0];
225 static void mix_6_to_2_fltp_flt_c(float **samples, float **matrix, int len,
226 int out_ch, int in_ch)
229 float *src0 = samples[0];
230 float *src1 = samples[1];
231 float *src2 = samples[2];
232 float *src3 = samples[3];
233 float *src4 = samples[4];
234 float *src5 = samples[5];
237 float *m0 = matrix[0];
238 float *m1 = matrix[1];
243 *dst0++ = v0 * m0[0] +
249 *dst1++ = v0 * m1[0] +
259 static void mix_2_to_6_fltp_flt_c(float **samples, float **matrix, int len,
260 int out_ch, int in_ch)
263 float *dst0 = samples[0];
264 float *dst1 = samples[1];
265 float *dst2 = samples[2];
266 float *dst3 = samples[3];
267 float *dst4 = samples[4];
268 float *dst5 = samples[5];
275 *dst0++ = v0 * matrix[0][0] + v1 * matrix[0][1];
276 *dst1++ = v0 * matrix[1][0] + v1 * matrix[1][1];
277 *dst2++ = v0 * matrix[2][0] + v1 * matrix[2][1];
278 *dst3++ = v0 * matrix[3][0] + v1 * matrix[3][1];
279 *dst4++ = v0 * matrix[4][0] + v1 * matrix[4][1];
280 *dst5++ = v0 * matrix[5][0] + v1 * matrix[5][1];
285 static int mix_function_init(AudioMix *am)
287 /* no need to set a mix function when we're skipping mixing */
288 if (!am->in_matrix_channels || !am->out_matrix_channels) {
289 am->func_descr = "n/a";
293 /* any-to-any C versions */
295 ff_audio_mix_set_func(am, AV_SAMPLE_FMT_FLTP, AV_MIX_COEFF_TYPE_FLT,
296 0, 0, 1, 1, "C", MIX_FUNC_NAME(FLTP, FLT));
298 ff_audio_mix_set_func(am, AV_SAMPLE_FMT_S16P, AV_MIX_COEFF_TYPE_FLT,
299 0, 0, 1, 1, "C", MIX_FUNC_NAME(S16P, FLT));
301 ff_audio_mix_set_func(am, AV_SAMPLE_FMT_S16P, AV_MIX_COEFF_TYPE_Q15,
302 0, 0, 1, 1, "C", MIX_FUNC_NAME(S16P, Q15));
304 ff_audio_mix_set_func(am, AV_SAMPLE_FMT_S16P, AV_MIX_COEFF_TYPE_Q8,
305 0, 0, 1, 1, "C", MIX_FUNC_NAME(S16P, Q8));
307 /* channel-specific C versions */
309 ff_audio_mix_set_func(am, AV_SAMPLE_FMT_FLTP, AV_MIX_COEFF_TYPE_FLT,
310 2, 1, 1, 1, "C", mix_2_to_1_fltp_flt_c);
312 ff_audio_mix_set_func(am, AV_SAMPLE_FMT_S16P, AV_MIX_COEFF_TYPE_FLT,
313 2, 1, 1, 1, "C", mix_2_to_1_s16p_flt_c);
315 ff_audio_mix_set_func(am, AV_SAMPLE_FMT_S16P, AV_MIX_COEFF_TYPE_Q8,
316 2, 1, 1, 1, "C", mix_2_to_1_s16p_q8_c);
318 ff_audio_mix_set_func(am, AV_SAMPLE_FMT_FLTP, AV_MIX_COEFF_TYPE_FLT,
319 1, 2, 1, 1, "C", mix_1_to_2_fltp_flt_c);
321 ff_audio_mix_set_func(am, AV_SAMPLE_FMT_FLTP, AV_MIX_COEFF_TYPE_FLT,
322 6, 2, 1, 1, "C", mix_6_to_2_fltp_flt_c);
324 ff_audio_mix_set_func(am, AV_SAMPLE_FMT_FLTP, AV_MIX_COEFF_TYPE_FLT,
325 2, 6, 1, 1, "C", mix_2_to_6_fltp_flt_c);
328 ff_audio_mix_init_x86(am);
331 av_log(am->avr, AV_LOG_ERROR, "audio_mix: NO FUNCTION FOUND: [fmt=%s] "
332 "[c=%s] [%d to %d]\n", av_get_sample_fmt_name(am->fmt),
333 coeff_type_names[am->coeff_type], am->in_channels,
335 return AVERROR_PATCHWELCOME;
340 AudioMix *ff_audio_mix_alloc(AVAudioResampleContext *avr)
345 am = av_mallocz(sizeof(*am));
350 if (avr->internal_sample_fmt != AV_SAMPLE_FMT_S16P &&
351 avr->internal_sample_fmt != AV_SAMPLE_FMT_FLTP) {
352 av_log(avr, AV_LOG_ERROR, "Unsupported internal format for "
354 av_get_sample_fmt_name(avr->internal_sample_fmt));
358 am->fmt = avr->internal_sample_fmt;
359 am->coeff_type = avr->mix_coeff_type;
360 am->in_layout = avr->in_channel_layout;
361 am->out_layout = avr->out_channel_layout;
362 am->in_channels = avr->in_channels;
363 am->out_channels = avr->out_channels;
365 /* build matrix if the user did not already set one */
366 if (avr->mix_matrix) {
367 ret = ff_audio_mix_set_matrix(am, avr->mix_matrix, avr->in_channels);
370 av_freep(&avr->mix_matrix);
373 char in_layout_name[128];
374 char out_layout_name[128];
375 double *matrix_dbl = av_mallocz(avr->out_channels * avr->in_channels *
376 sizeof(*matrix_dbl));
380 ret = avresample_build_matrix(avr->in_channel_layout,
381 avr->out_channel_layout,
382 avr->center_mix_level,
383 avr->surround_mix_level,
385 avr->normalize_mix_level,
388 avr->matrix_encoding);
394 ret = ff_audio_mix_set_matrix(am, matrix_dbl, avr->in_channels);
396 av_log(avr, AV_LOG_ERROR, "error setting mix matrix\n");
401 av_get_channel_layout_string(in_layout_name, sizeof(in_layout_name),
402 avr->in_channels, avr->in_channel_layout);
403 av_get_channel_layout_string(out_layout_name, sizeof(out_layout_name),
404 avr->out_channels, avr->out_channel_layout);
405 av_log(avr, AV_LOG_DEBUG, "audio_mix: %s to %s\n",
406 in_layout_name, out_layout_name);
407 av_log(avr, AV_LOG_DEBUG, "matrix size: %d x %d\n",
408 am->in_matrix_channels, am->out_matrix_channels);
409 for (i = 0; i < avr->out_channels; i++) {
410 for (j = 0; j < avr->in_channels; j++) {
411 if (am->output_zero[i])
412 av_log(avr, AV_LOG_DEBUG, " (ZERO)");
413 else if (am->input_skip[j] || am->output_skip[i])
414 av_log(avr, AV_LOG_DEBUG, " (SKIP)");
416 av_log(avr, AV_LOG_DEBUG, " %0.3f ",
417 matrix_dbl[i * avr->in_channels + j]);
419 av_log(avr, AV_LOG_DEBUG, "\n");
432 void ff_audio_mix_free(AudioMix **am_p)
441 av_free(am->matrix[0]);
444 memset(am->matrix_q8, 0, sizeof(am->matrix_q8 ));
445 memset(am->matrix_q15, 0, sizeof(am->matrix_q15));
446 memset(am->matrix_flt, 0, sizeof(am->matrix_flt));
451 int ff_audio_mix(AudioMix *am, AudioData *src)
454 int len = src->nb_samples;
457 /* determine whether to use the optimized function based on pointer and
458 samples alignment in both the input and output */
459 if (am->has_optimized_func) {
460 int aligned_len = FFALIGN(len, am->samples_align);
461 if (!(src->ptr_align % am->ptr_align) &&
462 src->samples_align >= aligned_len) {
467 av_dlog(am->avr, "audio_mix: %d samples - %d to %d channels (%s)\n",
468 src->nb_samples, am->in_channels, am->out_channels,
469 use_generic ? am->func_descr_generic : am->func_descr);
471 if (am->in_matrix_channels && am->out_matrix_channels) {
473 uint8_t *data0[AVRESAMPLE_MAX_CHANNELS];
475 if (am->out_matrix_channels < am->out_channels ||
476 am->in_matrix_channels < am->in_channels) {
477 for (i = 0, j = 0; i < FFMAX(am->in_channels, am->out_channels); i++) {
478 if (am->input_skip[i] || am->output_skip[i] || am->output_zero[i])
480 data0[j++] = src->data[i];
488 am->mix_generic(data, am->matrix, len, am->out_matrix_channels,
489 am->in_matrix_channels);
491 am->mix(data, am->matrix, len, am->out_matrix_channels,
492 am->in_matrix_channels);
495 if (am->out_matrix_channels < am->out_channels) {
496 for (i = 0; i < am->out_channels; i++)
497 if (am->output_zero[i])
498 av_samples_set_silence(&src->data[i], 0, len, 1, am->fmt);
501 ff_audio_data_set_channels(src, am->out_channels);
506 int ff_audio_mix_get_matrix(AudioMix *am, double *matrix, int stride)
510 if ( am->in_channels <= 0 || am->in_channels > AVRESAMPLE_MAX_CHANNELS ||
511 am->out_channels <= 0 || am->out_channels > AVRESAMPLE_MAX_CHANNELS) {
512 av_log(am->avr, AV_LOG_ERROR, "Invalid channel counts\n");
513 return AVERROR(EINVAL);
516 #define GET_MATRIX_CONVERT(suffix, scale) \
517 if (!am->matrix_ ## suffix[0]) { \
518 av_log(am->avr, AV_LOG_ERROR, "matrix is not set\n"); \
519 return AVERROR(EINVAL); \
521 for (o = 0, o0 = 0; o < am->out_channels; o++) { \
522 for (i = 0, i0 = 0; i < am->in_channels; i++) { \
523 if (am->input_skip[i] || am->output_zero[o]) \
524 matrix[o * stride + i] = 0.0; \
526 matrix[o * stride + i] = am->matrix_ ## suffix[o0][i0] * \
528 if (!am->input_skip[i]) \
531 if (!am->output_zero[o]) \
535 switch (am->coeff_type) {
536 case AV_MIX_COEFF_TYPE_Q8:
537 GET_MATRIX_CONVERT(q8, 1.0 / 256.0);
539 case AV_MIX_COEFF_TYPE_Q15:
540 GET_MATRIX_CONVERT(q15, 1.0 / 32768.0);
542 case AV_MIX_COEFF_TYPE_FLT:
543 GET_MATRIX_CONVERT(flt, 1.0);
546 av_log(am->avr, AV_LOG_ERROR, "Invalid mix coeff type\n");
547 return AVERROR(EINVAL);
553 int ff_audio_mix_set_matrix(AudioMix *am, const double *matrix, int stride)
557 if ( am->in_channels <= 0 || am->in_channels > AVRESAMPLE_MAX_CHANNELS ||
558 am->out_channels <= 0 || am->out_channels > AVRESAMPLE_MAX_CHANNELS) {
559 av_log(am->avr, AV_LOG_ERROR, "Invalid channel counts\n");
560 return AVERROR(EINVAL);
564 av_free(am->matrix[0]);
568 memset(am->output_zero, 0, sizeof(am->output_zero));
569 memset(am->input_skip, 0, sizeof(am->input_skip));
570 memset(am->output_skip, 0, sizeof(am->output_zero));
571 am->in_matrix_channels = am->in_channels;
572 am->out_matrix_channels = am->out_channels;
574 /* exclude output channels if they can be zeroed instead of mixed */
575 for (o = 0; o < am->out_channels; o++) {
578 /* check if the output is always silent */
579 for (i = 0; i < am->in_channels; i++) {
580 if (matrix[o * stride + i] != 0.0) {
585 /* check if the corresponding input channel makes a contribution to
586 any output channel */
587 if (o < am->in_channels) {
588 for (i = 0; i < am->out_channels; i++) {
589 if (matrix[i * stride + o] != 0.0) {
596 am->output_zero[o] = 1;
597 am->out_matrix_channels--;
600 if (am->out_matrix_channels == 0) {
601 am->in_matrix_channels = 0;
605 /* skip input channels that contribute fully only to the corresponding
607 for (i = 0; i < FFMIN(am->in_channels, am->out_channels); i++) {
610 for (o = 0; o < am->out_channels; o++) {
611 if ((o != i && matrix[o * stride + i] != 0.0) ||
612 (o == i && matrix[o * stride + i] != 1.0)) {
618 am->input_skip[i] = 1;
619 am->in_matrix_channels--;
622 /* skip input channels that do not contribute to any output channel */
623 for (; i < am->in_channels; i++) {
626 for (o = 0; o < am->out_channels; o++) {
627 if (matrix[o * stride + i] != 0.0) {
633 am->input_skip[i] = 1;
634 am->in_matrix_channels--;
637 if (am->in_matrix_channels == 0) {
638 am->out_matrix_channels = 0;
642 /* skip output channels that only get full contribution from the
643 corresponding input channel */
644 for (o = 0; o < FFMIN(am->in_channels, am->out_channels); o++) {
647 for (i = 0; i < am->in_channels; i++) {
648 if ((o != i && matrix[o * stride + i] != 0.0) ||
649 (o == i && matrix[o * stride + i] != 1.0)) {
655 am->output_skip[o] = 1;
656 am->out_matrix_channels--;
659 if (am->out_matrix_channels == 0) {
660 am->in_matrix_channels = 0;
664 #define CONVERT_MATRIX(type, expr) \
665 am->matrix_## type[0] = av_mallocz(am->out_matrix_channels * \
666 am->in_matrix_channels * \
667 sizeof(*am->matrix_## type[0])); \
668 if (!am->matrix_## type[0]) \
669 return AVERROR(ENOMEM); \
670 for (o = 0, o0 = 0; o < am->out_channels; o++) { \
671 if (am->output_zero[o] || am->output_skip[o]) \
674 am->matrix_## type[o0] = am->matrix_## type[o0 - 1] + \
675 am->in_matrix_channels; \
676 for (i = 0, i0 = 0; i < am->in_channels; i++) { \
678 if (am->input_skip[i]) \
680 v = matrix[o * stride + i]; \
681 am->matrix_## type[o0][i0] = expr; \
686 am->matrix = (void **)am->matrix_## type;
688 switch (am->coeff_type) {
689 case AV_MIX_COEFF_TYPE_Q8:
690 CONVERT_MATRIX(q8, av_clip_int16(lrint(256.0 * v)))
692 case AV_MIX_COEFF_TYPE_Q15:
693 CONVERT_MATRIX(q15, av_clipl_int32(llrint(32768.0 * v)))
695 case AV_MIX_COEFF_TYPE_FLT:
696 CONVERT_MATRIX(flt, v)
699 av_log(am->avr, AV_LOG_ERROR, "Invalid mix coeff type\n");
700 return AVERROR(EINVAL);
703 return mix_function_init(am);