git.sesse.net Git - ffmpeg/blob - libavresample/audio_mix.h

   1 /*
   2  * Copyright (c) 2012 Justin Ruggles <justin.ruggles@gmail.com>
   3  *
   4  * This file is part of Libav.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #ifndef AVRESAMPLE_AUDIO_MIX_H
  22 #define AVRESAMPLE_AUDIO_MIX_H
  23
  24 #include <stdint.h>
  25
  26 #include "libavutil/samplefmt.h"
  27 #include "avresample.h"
  28 #include "audio_data.h"
  29
  30 typedef void (mix_func)(uint8_t **src, void **matrix, int len, int out_ch,
  31                         int in_ch);
  32
  33 typedef struct AudioMix {
  34     AVAudioResampleContext *avr;
  35     enum AVSampleFormat fmt;
  36     enum AVMixCoeffType coeff_type;
  37     uint64_t in_layout;
  38     uint64_t out_layout;
  39     int in_channels;
  40     int out_channels;
  41
  42     int ptr_align;
  43     int samples_align;
  44     int has_optimized_func;
  45     const char *func_descr;
  46     const char *func_descr_generic;
  47     mix_func *mix;
  48     mix_func *mix_generic;
  49
  50     int16_t *matrix_q8[AVRESAMPLE_MAX_CHANNELS];
  51     int32_t *matrix_q15[AVRESAMPLE_MAX_CHANNELS];
  52     float   *matrix_flt[AVRESAMPLE_MAX_CHANNELS];
  53     void   **matrix;
  54 } AudioMix;
  55
  56 /**
  57  * Set mixing function if the parameters match.
  58  *
  59  * This compares the parameters of the mixing function to the parameters in the
  60  * AudioMix context. If the parameters do not match, no changes are made to the
  61  * active functions. If the parameters do match and the alignment is not
  62  * constrained, the function is set as the generic mixing function. If the
  63  * parameters match and the alignment is constrained, the function is set as
  64  * the optimized mixing function.
  65  *
  66  * @param am             AudioMix context
  67  * @param fmt            input/output sample format
  68  * @param coeff_type     mixing coefficient type
  69  * @param in_channels    number of input channels, or 0 for any number of channels
  70  * @param out_channels   number of output channels, or 0 for any number of channels
  71  * @param ptr_align      buffer pointer alignment, in bytes
  72  * @param sample_align   buffer size alignment, in samples
  73  * @param descr          function type description (e.g. "C" or "SSE")
  74  * @param mix_func       mixing function pointer
  75  */
  76 void ff_audio_mix_set_func(AudioMix *am, enum AVSampleFormat fmt,
  77                            enum AVMixCoeffType coeff_type, int in_channels,
  78                            int out_channels, int ptr_align, int samples_align,
  79                            const char *descr, void *mix_func);
  80
  81 /**
  82  * Initialize the AudioMix context in the AVAudioResampleContext.
  83  *
  84  * The parameters in the AVAudioResampleContext are used to initialize the
  85  * AudioMix context and set the mixing matrix.
  86  *
  87  * @param avr  AVAudioResampleContext
  88  * @return     0 on success, negative AVERROR code on failure
  89  */
  90 int ff_audio_mix_init(AVAudioResampleContext *avr);
  91
  92 /**
  93  * Close an AudioMix context.
  94  *
  95  * This clears and frees the mixing matrix arrays.
  96  */
  97 void ff_audio_mix_close(AudioMix *am);
  98
  99 /**
 100  * Apply channel mixing to audio data using the current mixing matrix.
 101  */
 102 int ff_audio_mix(AudioMix *am, AudioData *src);
 103
 104 /* arch-specific initialization functions */
 105
 106 void ff_audio_mix_init_x86(AudioMix *am);
 107
 108 #endif /* AVRESAMPLE_AUDIO_MIX_H */