libavresample/audio_mix.h
c8af852b
 /*
  * Copyright (c) 2012 Justin Ruggles <justin.ruggles@gmail.com>
  *
d814a839
  * This file is part of FFmpeg.
c8af852b
  *
d814a839
  * FFmpeg is free software; you can redistribute it and/or
c8af852b
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
d814a839
  * FFmpeg is distributed in the hope that it will be useful,
c8af852b
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
d814a839
  * License along with FFmpeg; if not, write to the Free Software
c8af852b
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #ifndef AVRESAMPLE_AUDIO_MIX_H
 #define AVRESAMPLE_AUDIO_MIX_H
 
 #include <stdint.h>
 
 #include "libavutil/samplefmt.h"
 #include "avresample.h"
4d68269d
 #include "internal.h"
c8af852b
 #include "audio_data.h"
 
 typedef void (mix_func)(uint8_t **src, void **matrix, int len, int out_ch,
                         int in_ch);
 
 /**
  * Set mixing function if the parameters match.
  *
  * This compares the parameters of the mixing function to the parameters in the
  * AudioMix context. If the parameters do not match, no changes are made to the
  * active functions. If the parameters do match and the alignment is not
  * constrained, the function is set as the generic mixing function. If the
  * parameters match and the alignment is constrained, the function is set as
  * the optimized mixing function.
  *
  * @param am             AudioMix context
  * @param fmt            input/output sample format
  * @param coeff_type     mixing coefficient type
  * @param in_channels    number of input channels, or 0 for any number of channels
  * @param out_channels   number of output channels, or 0 for any number of channels
  * @param ptr_align      buffer pointer alignment, in bytes
804d7a1a
  * @param samples_align  buffer size alignment, in samples
c8af852b
  * @param descr          function type description (e.g. "C" or "SSE")
  * @param mix_func       mixing function pointer
  */
 void ff_audio_mix_set_func(AudioMix *am, enum AVSampleFormat fmt,
                            enum AVMixCoeffType coeff_type, int in_channels,
                            int out_channels, int ptr_align, int samples_align,
                            const char *descr, void *mix_func);
 
 /**
14758e32
  * Allocate and initialize an AudioMix context.
c8af852b
  *
  * The parameters in the AVAudioResampleContext are used to initialize the
14758e32
  * AudioMix context.
c8af852b
  *
  * @param avr  AVAudioResampleContext
14758e32
  * @return     newly-allocated AudioMix context.
c8af852b
  */
14758e32
 AudioMix *ff_audio_mix_alloc(AVAudioResampleContext *avr);
c8af852b
 
 /**
14758e32
  * Free an AudioMix context.
c8af852b
  */
14758e32
 void ff_audio_mix_free(AudioMix **am);
c8af852b
 
 /**
  * Apply channel mixing to audio data using the current mixing matrix.
  */
 int ff_audio_mix(AudioMix *am, AudioData *src);
 
14758e32
 /**
  * Get the current mixing matrix.
  */
 int ff_audio_mix_get_matrix(AudioMix *am, double *matrix, int stride);
 
 /**
  * Set the current mixing matrix.
  */
 int ff_audio_mix_set_matrix(AudioMix *am, const double *matrix, int stride);
 
c8af852b
 /* arch-specific initialization functions */
 
 void ff_audio_mix_init_x86(AudioMix *am);
 
 #endif /* AVRESAMPLE_AUDIO_MIX_H */