zqz/platform-external-webrtc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Echo cancellation functions docs: Follow style guide w.r.t. placement of *

Browse Source 
The style guide says to use "void* x", not void *x", and the code in
these files already do so, but the comments do not. Fix that.

Also, in the interest of reducing eye strain, I fixed the vertical
alignment in a small number of cases.

BUG=
R=aluebs@webrtc.org, andrew@webrtc.org

Review URL: https://webrtc-codereview.appspot.com/12509004

git-svn-id: http://webrtc.googlecode.com/svn/trunk@6101 4adac7df-926f-26a2-2b94-8c16560cd09d
This commit is contained in:
kwiberg@webrtc.org
2014-05-12 09:55:19 +00:00
parent 66021e0fa2
commit 924e81f797
2 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
webrtc/modules/audio_processing/aec/include/echo_cancellation.h
View File

@ -68,7 +68,7 @@ extern "C" {
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void **aecInst Pointer to the AEC instance to be created * void** aecInst Pointer to the AEC instance to be created
* and initialized * and initialized
* *
* Outputs Description * Outputs Description
@ -83,7 +83,7 @@ int32_t WebRtcAec_Create(void** aecInst);
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *aecInst Pointer to the AEC instance * void* aecInst Pointer to the AEC instance
* *
* Outputs Description * Outputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
@ -97,7 +97,7 @@ int32_t WebRtcAec_Free(void* aecInst);
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *aecInst Pointer to the AEC instance * void* aecInst Pointer to the AEC instance
* int32_t sampFreq Sampling frequency of data * int32_t sampFreq Sampling frequency of data
* int32_t scSampFreq Soundcard sampling frequency * int32_t scSampFreq Soundcard sampling frequency
* *
@ -113,8 +113,8 @@ int32_t WebRtcAec_Init(void* aecInst, int32_t sampFreq, int32_t scSampFreq);
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *aecInst Pointer to the AEC instance * void* aecInst Pointer to the AEC instance
* int16_t *farend In buffer containing one frame of * int16_t* farend In buffer containing one frame of
* farend signal for L band * farend signal for L band
* int16_t nrOfSamples Number of samples in farend buffer * int16_t nrOfSamples Number of samples in farend buffer
* *
@ -132,10 +132,10 @@ int32_t WebRtcAec_BufferFarend(void* aecInst,
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *aecInst Pointer to the AEC instance * void* aecInst Pointer to the AEC instance
* int16_t *nearend In buffer containing one frame of * int16_t* nearend In buffer containing one frame of
* nearend+echo signal for L band * nearend+echo signal for L band
* int16_t *nearendH In buffer containing one frame of * int16_t* nearendH In buffer containing one frame of
* nearend+echo signal for H band * nearend+echo signal for H band
* int16_t nrOfSamples Number of samples in nearend buffer * int16_t nrOfSamples Number of samples in nearend buffer
* int16_t msInSndCardBuf Delay estimate for sound card and * int16_t msInSndCardBuf Delay estimate for sound card and
@ -146,9 +146,9 @@ int32_t WebRtcAec_BufferFarend(void* aecInst,
* *
* Outputs Description * Outputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* int16_t *out Out buffer, one frame of processed nearend * int16_t* out Out buffer, one frame of processed nearend
* for L band * for L band
* int16_t *outH Out buffer, one frame of processed nearend * int16_t* outH Out buffer, one frame of processed nearend
* for H band * for H band
* int32_t return 0: OK * int32_t return 0: OK
* -1: error * -1: error
@ -167,7 +167,7 @@ int32_t WebRtcAec_Process(void* aecInst,
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *handle Pointer to the AEC instance * void* handle Pointer to the AEC instance
* AecConfig config Config instance that contains all * AecConfig config Config instance that contains all
* properties to be set * properties to be set
* *
@ -183,11 +183,11 @@ int WebRtcAec_set_config(void* handle, AecConfig config);
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *handle Pointer to the AEC instance * void* handle Pointer to the AEC instance
* *
* Outputs Description * Outputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* int *status 0: Almost certainly nearend single-talk * int* status 0: Almost certainly nearend single-talk
* 1: Might not be neared single-talk * 1: Might not be neared single-talk
* int return 0: OK * int return 0: OK
* -1: error * -1: error
@ -199,11 +199,11 @@ int WebRtcAec_get_echo_status(void* handle, int* status);
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *handle Pointer to the AEC instance * void* handle Pointer to the AEC instance
* *
* Outputs Description * Outputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* AecMetrics *metrics Struct which will be filled out with the * AecMetrics* metrics Struct which will be filled out with the
* current echo metrics. * current echo metrics.
* int return 0: OK * int return 0: OK
* -1: error * -1: error
@ -232,7 +232,7 @@ int WebRtcAec_GetDelayMetrics(void* handle, int* median, int* std);
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *aecInst Pointer to the AEC instance * void* aecInst Pointer to the AEC instance
* *
* Outputs Description * Outputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------

44
webrtc/modules/audio_processing/aecm/include/echo_control_mobile.h
View File

@ -45,7 +45,7 @@ extern "C" {
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void **aecmInst Pointer to the AECM instance to be * void** aecmInst Pointer to the AECM instance to be
* created and initialized * created and initialized
* *
* Outputs Description * Outputs Description
@ -60,11 +60,11 @@ int32_t WebRtcAecm_Create(void **aecmInst);
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *aecmInst Pointer to the AECM instance * void* aecmInst Pointer to the AECM instance
* *
* Outputs Description * Outputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* int32_t return 0: OK * int32_t return 0: OK
* -1: error * -1: error
*/ */
int32_t WebRtcAecm_Free(void *aecmInst); int32_t WebRtcAecm_Free(void *aecmInst);
@ -74,7 +74,7 @@ int32_t WebRtcAecm_Free(void *aecmInst);
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *aecmInst Pointer to the AECM instance * void* aecmInst Pointer to the AECM instance
* int32_t sampFreq Sampling frequency of data * int32_t sampFreq Sampling frequency of data
* *
* Outputs Description * Outputs Description
@ -89,8 +89,8 @@ int32_t WebRtcAecm_Init(void* aecmInst, int32_t sampFreq);
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *aecmInst Pointer to the AECM instance * void* aecmInst Pointer to the AECM instance
* int16_t *farend In buffer containing one frame of * int16_t* farend In buffer containing one frame of
* farend signal * farend signal
* int16_t nrOfSamples Number of samples in farend buffer * int16_t nrOfSamples Number of samples in farend buffer
* *
@ -106,14 +106,14 @@ int32_t WebRtcAecm_BufferFarend(void* aecmInst,
/* /*
* Runs the AECM on an 80 or 160 sample blocks of data. * Runs the AECM on an 80 or 160 sample blocks of data.
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *aecmInst Pointer to the AECM instance * void* aecmInst Pointer to the AECM instance
* int16_t *nearendNoisy In buffer containing one frame of * int16_t* nearendNoisy In buffer containing one frame of
* reference nearend+echo signal. If * reference nearend+echo signal. If
* noise reduction is active, provide * noise reduction is active, provide
* the noisy signal here. * the noisy signal here.
* int16_t *nearendClean In buffer containing one frame of * int16_t* nearendClean In buffer containing one frame of
* nearend+echo signal. If noise * nearend+echo signal. If noise
* reduction is active, provide the * reduction is active, provide the
* clean signal here. Otherwise pass a * clean signal here. Otherwise pass a
@ -122,11 +122,11 @@ int32_t WebRtcAecm_BufferFarend(void* aecmInst,
* int16_t msInSndCardBuf Delay estimate for sound card and * int16_t msInSndCardBuf Delay estimate for sound card and
* system buffers * system buffers
* *
* Outputs Description * Outputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* int16_t *out Out buffer, one frame of processed nearend * int16_t* out Out buffer, one frame of processed nearend
* int32_t return 0: OK * int32_t return 0: OK
* -1: error * -1: error
*/ */
int32_t WebRtcAecm_Process(void* aecmInst, int32_t WebRtcAecm_Process(void* aecmInst,
const int16_t* nearendNoisy, const int16_t* nearendNoisy,
@ -140,8 +140,8 @@ int32_t WebRtcAecm_Process(void* aecmInst,
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *aecmInst Pointer to the AECM instance * void* aecmInst Pointer to the AECM instance
* AecmConfig config Config instance that contains all * AecmConfig config Config instance that contains all
* properties to be set * properties to be set
* *
* Outputs Description * Outputs Description
@ -156,11 +156,11 @@ int32_t WebRtcAecm_set_config(void* aecmInst, AecmConfig config);
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *aecmInst Pointer to the AECM instance * void* aecmInst Pointer to the AECM instance
* *
* Outputs Description * Outputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* AecmConfig *config Pointer to the config instance that * AecmConfig* config Pointer to the config instance that
* all properties will be written to * all properties will be written to
* int32_t return 0: OK * int32_t return 0: OK
* -1: error * -1: error
@ -178,7 +178,7 @@ int32_t WebRtcAecm_get_config(void *aecmInst, AecmConfig *config);
* *
* Outputs Description * Outputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* int32_t return 0: OK * int32_t return 0: OK
* -1: error * -1: error
*/ */
int32_t WebRtcAecm_InitEchoPath(void* aecmInst, int32_t WebRtcAecm_InitEchoPath(void* aecmInst,
@ -197,7 +197,7 @@ int32_t WebRtcAecm_InitEchoPath(void* aecmInst,
* *
* Outputs Description * Outputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* int32_t return 0: OK * int32_t return 0: OK
* -1: error * -1: error
*/ */
int32_t WebRtcAecm_GetEchoPath(void* aecmInst, int32_t WebRtcAecm_GetEchoPath(void* aecmInst,
@ -209,7 +209,7 @@ int32_t WebRtcAecm_GetEchoPath(void* aecmInst,
* *
* Outputs Description * Outputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* size_t return : size in bytes * size_t return Size in bytes
*/ */
size_t WebRtcAecm_echo_path_size_bytes(); size_t WebRtcAecm_echo_path_size_bytes();
@ -218,7 +218,7 @@ size_t WebRtcAecm_echo_path_size_bytes();
* *
* Inputs Description * Inputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------
* void *aecmInst Pointer to the AECM instance * void* aecmInst Pointer to the AECM instance
* *
* Outputs Description * Outputs Description
* ------------------------------------------------------------------- * -------------------------------------------------------------------