261 lines
9.4 KiB
C
261 lines
9.4 KiB
C
/*
|
|
* Copyright (c) 2011 The WebRTC project authors. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*/
|
|
|
|
#ifndef WEBRTC_MODULES_AUDIO_PROCESSING_AEC_MAIN_INTERFACE_ECHO_CANCELLATION_H_
|
|
#define WEBRTC_MODULES_AUDIO_PROCESSING_AEC_MAIN_INTERFACE_ECHO_CANCELLATION_H_
|
|
|
|
#include "typedefs.h"
|
|
|
|
// Errors
|
|
#define AEC_UNSPECIFIED_ERROR 12000
|
|
#define AEC_UNSUPPORTED_FUNCTION_ERROR 12001
|
|
#define AEC_UNINITIALIZED_ERROR 12002
|
|
#define AEC_NULL_POINTER_ERROR 12003
|
|
#define AEC_BAD_PARAMETER_ERROR 12004
|
|
|
|
// Warnings
|
|
#define AEC_BAD_PARAMETER_WARNING 12050
|
|
|
|
enum {
|
|
kAecNlpConservative = 0,
|
|
kAecNlpModerate,
|
|
kAecNlpAggressive
|
|
};
|
|
|
|
enum {
|
|
kAecFalse = 0,
|
|
kAecTrue
|
|
};
|
|
|
|
typedef struct {
|
|
WebRtc_Word16 nlpMode; // default kAecNlpModerate
|
|
WebRtc_Word16 skewMode; // default kAecFalse
|
|
WebRtc_Word16 metricsMode; // default kAecFalse
|
|
//float realSkew;
|
|
} AecConfig;
|
|
|
|
typedef struct {
|
|
WebRtc_Word16 instant;
|
|
WebRtc_Word16 average;
|
|
WebRtc_Word16 max;
|
|
WebRtc_Word16 min;
|
|
} AecLevel;
|
|
|
|
typedef struct {
|
|
AecLevel rerl;
|
|
AecLevel erl;
|
|
AecLevel erle;
|
|
AecLevel aNlp;
|
|
} AecMetrics;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*
|
|
* Allocates the memory needed by the AEC. The memory needs to be initialized
|
|
* separately using the WebRtcAec_Init() function.
|
|
*
|
|
* Inputs Description
|
|
* -------------------------------------------------------------------
|
|
* void **aecInst Pointer to the AEC instance to be created
|
|
* and initilized
|
|
*
|
|
* Outputs Description
|
|
* -------------------------------------------------------------------
|
|
* WebRtc_Word32 return 0: OK
|
|
* -1: error
|
|
*/
|
|
WebRtc_Word32 WebRtcAec_Create(void **aecInst);
|
|
|
|
/*
|
|
* This function releases the memory allocated by WebRtcAec_Create().
|
|
*
|
|
* Inputs Description
|
|
* -------------------------------------------------------------------
|
|
* void *aecInst Pointer to the AEC instance
|
|
*
|
|
* Outputs Description
|
|
* -------------------------------------------------------------------
|
|
* WebRtc_Word32 return 0: OK
|
|
* -1: error
|
|
*/
|
|
WebRtc_Word32 WebRtcAec_Free(void *aecInst);
|
|
|
|
/*
|
|
* Initializes an AEC instance.
|
|
*
|
|
* Inputs Description
|
|
* -------------------------------------------------------------------
|
|
* void *aecInst Pointer to the AEC instance
|
|
* WebRtc_Word32 sampFreq Sampling frequency of data
|
|
* WebRtc_Word32 scSampFreq Soundcard sampling frequency
|
|
*
|
|
* Outputs Description
|
|
* -------------------------------------------------------------------
|
|
* WebRtc_Word32 return 0: OK
|
|
* -1: error
|
|
*/
|
|
WebRtc_Word32 WebRtcAec_Init(void *aecInst,
|
|
WebRtc_Word32 sampFreq,
|
|
WebRtc_Word32 scSampFreq);
|
|
|
|
/*
|
|
* Inserts an 80 or 160 sample block of data into the farend buffer.
|
|
*
|
|
* Inputs Description
|
|
* -------------------------------------------------------------------
|
|
* void *aecInst Pointer to the AEC instance
|
|
* WebRtc_Word16 *farend In buffer containing one frame of
|
|
* farend signal for L band
|
|
* WebRtc_Word16 nrOfSamples Number of samples in farend buffer
|
|
*
|
|
* Outputs Description
|
|
* -------------------------------------------------------------------
|
|
* WebRtc_Word32 return 0: OK
|
|
* -1: error
|
|
*/
|
|
WebRtc_Word32 WebRtcAec_BufferFarend(void *aecInst,
|
|
const WebRtc_Word16 *farend,
|
|
WebRtc_Word16 nrOfSamples);
|
|
|
|
/*
|
|
* Runs the echo canceller on an 80 or 160 sample blocks of data.
|
|
*
|
|
* Inputs Description
|
|
* -------------------------------------------------------------------
|
|
* void *aecInst Pointer to the AEC instance
|
|
* WebRtc_Word16 *nearend In buffer containing one frame of
|
|
* nearend+echo signal for L band
|
|
* WebRtc_Word16 *nearendH In buffer containing one frame of
|
|
* nearend+echo signal for H band
|
|
* WebRtc_Word16 nrOfSamples Number of samples in nearend buffer
|
|
* WebRtc_Word16 msInSndCardBuf Delay estimate for sound card and
|
|
* system buffers
|
|
* WebRtc_Word16 skew Difference between number of samples played
|
|
* and recorded at the soundcard (for clock skew
|
|
* compensation)
|
|
*
|
|
* Outputs Description
|
|
* -------------------------------------------------------------------
|
|
* WebRtc_Word16 *out Out buffer, one frame of processed nearend
|
|
* for L band
|
|
* WebRtc_Word16 *outH Out buffer, one frame of processed nearend
|
|
* for H band
|
|
* WebRtc_Word32 return 0: OK
|
|
* -1: error
|
|
*/
|
|
WebRtc_Word32 WebRtcAec_Process(void *aecInst,
|
|
const WebRtc_Word16 *nearend,
|
|
const WebRtc_Word16 *nearendH,
|
|
WebRtc_Word16 *out,
|
|
WebRtc_Word16 *outH,
|
|
WebRtc_Word16 nrOfSamples,
|
|
WebRtc_Word16 msInSndCardBuf,
|
|
WebRtc_Word32 skew);
|
|
|
|
/*
|
|
* This function enables the user to set certain parameters on-the-fly.
|
|
*
|
|
* Inputs Description
|
|
* -------------------------------------------------------------------
|
|
* void *aecInst Pointer to the AEC instance
|
|
* AecConfig config Config instance that contains all
|
|
* properties to be set
|
|
*
|
|
* Outputs Description
|
|
* -------------------------------------------------------------------
|
|
* WebRtc_Word32 return 0: OK
|
|
* -1: error
|
|
*/
|
|
WebRtc_Word32 WebRtcAec_set_config(void *aecInst, AecConfig config);
|
|
|
|
/*
|
|
* Gets the on-the-fly paramters.
|
|
*
|
|
* Inputs Description
|
|
* -------------------------------------------------------------------
|
|
* void *aecInst Pointer to the AEC instance
|
|
*
|
|
* Outputs Description
|
|
* -------------------------------------------------------------------
|
|
* AecConfig *config Pointer to the config instance that
|
|
* all properties will be written to
|
|
* WebRtc_Word32 return 0: OK
|
|
* -1: error
|
|
*/
|
|
WebRtc_Word32 WebRtcAec_get_config(void *aecInst, AecConfig *config);
|
|
|
|
/*
|
|
* Gets the current echo status of the nearend signal.
|
|
*
|
|
* Inputs Description
|
|
* -------------------------------------------------------------------
|
|
* void *aecInst Pointer to the AEC instance
|
|
*
|
|
* Outputs Description
|
|
* -------------------------------------------------------------------
|
|
* WebRtc_Word16 *status 0: Almost certainly nearend single-talk
|
|
* 1: Might not be neared single-talk
|
|
* WebRtc_Word32 return 0: OK
|
|
* -1: error
|
|
*/
|
|
WebRtc_Word32 WebRtcAec_get_echo_status(void *aecInst, WebRtc_Word16 *status);
|
|
|
|
/*
|
|
* Gets the current echo metrics for the session.
|
|
*
|
|
* Inputs Description
|
|
* -------------------------------------------------------------------
|
|
* void *aecInst Pointer to the AEC instance
|
|
*
|
|
* Outputs Description
|
|
* -------------------------------------------------------------------
|
|
* AecMetrics *metrics Struct which will be filled out with the
|
|
* current echo metrics.
|
|
* WebRtc_Word32 return 0: OK
|
|
* -1: error
|
|
*/
|
|
WebRtc_Word32 WebRtcAec_GetMetrics(void *aecInst, AecMetrics *metrics);
|
|
|
|
/*
|
|
* Gets the last error code.
|
|
*
|
|
* Inputs Description
|
|
* -------------------------------------------------------------------
|
|
* void *aecInst Pointer to the AEC instance
|
|
*
|
|
* Outputs Description
|
|
* -------------------------------------------------------------------
|
|
* WebRtc_Word32 return 11000-11100: error code
|
|
*/
|
|
WebRtc_Word32 WebRtcAec_get_error_code(void *aecInst);
|
|
|
|
/*
|
|
* Gets a version string.
|
|
*
|
|
* Inputs Description
|
|
* -------------------------------------------------------------------
|
|
* char *versionStr Pointer to a string array
|
|
* WebRtc_Word16 len The maximum length of the string
|
|
*
|
|
* Outputs Description
|
|
* -------------------------------------------------------------------
|
|
* WebRtc_Word8 *versionStr Pointer to a string array
|
|
* WebRtc_Word32 return 0: OK
|
|
* -1: error
|
|
*/
|
|
WebRtc_Word32 WebRtcAec_get_version(WebRtc_Word8 *versionStr, WebRtc_Word16 len);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* WEBRTC_MODULES_AUDIO_PROCESSING_AEC_MAIN_INTERFACE_ECHO_CANCELLATION_H_ */
|