Removed the indirect error message reporting in aec and aecm.

webrtc/modules/audio_processing/aecm/echo_control_mobile.c

 /*
  *  Copyright (c) 2012 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.
  */
 
@@ skipping 50 matching lines @@
 
 #ifdef AEC_DEBUG
     FILE *bufFile;
     FILE *delayFile;
     FILE *preCompFile;
     FILE *postCompFile;
 #endif // AEC_DEBUG
     // Structures
     RingBuffer *farendBuf;
 
-    int lastError;
-
     AecmCore* aecmCore;
 } AecMobile;
 
 // Estimates delay to set the position of the farend buffer read pointer
 // (controlled by knownDelay)
 static int WebRtcAecm_EstBufDelay(AecMobile* aecmInst, short msInSndCardBuf);
 
 // Stuffs the farend buffer if the estimated delay is too large
 static int WebRtcAecm_DelayComp(AecMobile* aecmInst);
 
@@ skipping 10 matching lines @@
 
     aecm->farendBuf = WebRtc_CreateBuffer(kBufSizeSamp,
                                           sizeof(int16_t));
     if (!aecm->farendBuf)
     {
         WebRtcAecm_Free(aecm);
         return NULL;
     }
 
     aecm->initFlag = 0;
-    aecm->lastError = 0;
 
 #ifdef AEC_DEBUG
     aecm->aecmCore->farFile = fopen("aecFar.pcm","wb");
     aecm->aecmCore->nearFile = fopen("aecNear.pcm","wb");
     aecm->aecmCore->outFile = fopen("aecOut.pcm","wb");
     //aecm->aecmCore->outLpFile = fopen("aecOutLp.pcm","wb");
 
     aecm->bufFile = fopen("aecBuf.dat", "wb");
     aecm->delayFile = fopen("aecDelay.dat", "wb");
     aecm->preCompFile = fopen("preComp.pcm", "wb");
@@ skipping 30 matching lines @@
   AecMobile* aecm = aecmInst;
     AecmConfig aecConfig;
 
     if (aecm == NULL)
     {
         return -1;
     }
 
     if (sampFreq != 8000 && sampFreq != 16000)
     {
-        aecm->lastError = AECM_BAD_PARAMETER_ERROR;
-        return -1;
+        return AECM_BAD_PARAMETER_ERROR;
     }
     aecm->sampFreq = sampFreq;
 
     // Initialize AECM core
     if (WebRtcAecm_InitCore(aecm->aecmCore, aecm->sampFreq) == -1)
     {
-        aecm->lastError = AECM_UNSPECIFIED_ERROR;
-        return -1;
+        return AECM_UNSPECIFIED_ERROR;
     }
 
     // Initialize farend buffer
     WebRtc_InitBuffer(aecm->farendBuf);
 
     aecm->initFlag = kInitCheck; // indicates that initialization has been done
 
     aecm->delayChange = 1;
 
     aecm->sum = 0;
@@ skipping 10 matching lines @@
     aecm->lastDelayDiff = 0;
 
     memset(&aecm->farendOld[0][0], 0, 160);
 
     // Default settings.
     aecConfig.cngMode = AecmTrue;
     aecConfig.echoMode = 3;
 
     if (WebRtcAecm_set_config(aecm, aecConfig) == -1)
     {
-        aecm->lastError = AECM_UNSPECIFIED_ERROR;
-        return -1;
+        return AECM_UNSPECIFIED_ERROR;
     }
 
     return 0;
 }
 
+// Returns any error that is caused when buffering the
+// farend signal.
+int32_t WebRtcAecm_GetBufferFarendError(void *aecmInst, const int16_t *farend,
+                                size_t nrOfSamples) {
+  AecMobile* aecm = aecmInst;
+
+  if (aecm == NULL)
+    return -1;
+
+  if (farend == NULL)
+    return AECM_NULL_POINTER_ERROR;
+
+  if (aecm->initFlag != kInitCheck)
+    return AECM_UNINITIALIZED_ERROR;
+
+  if (nrOfSamples != 80 && nrOfSamples != 160)
+    return AECM_BAD_PARAMETER_ERROR;
+
+  return 0;
+}
+
+
 int32_t WebRtcAecm_BufferFarend(void *aecmInst, const int16_t *farend,
-                                size_t nrOfSamples)
-{
+                                size_t nrOfSamples) {
   AecMobile* aecm = aecmInst;
-    int32_t retVal = 0;
 
-    if (aecm == NULL)
-    {
-        return -1;
-    }
+  int32_t err = WebRtcAecm_GetBufferFarendError(aecmInst, farend, nrOfSamples);

[hlundin-webrtc, 2015/10/14 14:34:49]

const

[peah-webrtc, 2015/10/14 17:57:36]

Done.

 
-    if (farend == NULL)
-    {
-        aecm->lastError = AECM_NULL_POINTER_ERROR;
-        return -1;
-    }
+  if (err != 0)
+    return err;
 
-    if (aecm->initFlag != kInitCheck)
-    {
-        aecm->lastError = AECM_UNINITIALIZED_ERROR;
-        return -1;
-    }
+  // TODO(unknown): Is this really a good idea?
+  if (!aecm->ECstartup)
+  {
+    WebRtcAecm_DelayComp(aecm);
+  }
 
-    if (nrOfSamples != 80 && nrOfSamples != 160)
-    {
-        aecm->lastError = AECM_BAD_PARAMETER_ERROR;
-        return -1;
-    }
+  WebRtc_WriteBuffer(aecm->farendBuf, farend, nrOfSamples);
 
-    // TODO: Is this really a good idea?
-    if (!aecm->ECstartup)
-    {
-        WebRtcAecm_DelayComp(aecm);
-    }
-
-    WebRtc_WriteBuffer(aecm->farendBuf, farend, nrOfSamples);
-
-    return retVal;
+  return 0;
 }
 
 int32_t WebRtcAecm_Process(void *aecmInst, const int16_t *nearendNoisy,
                            const int16_t *nearendClean, int16_t *out,
                            size_t nrOfSamples, int16_t msInSndCardBuf)
 {
   AecMobile* aecm = aecmInst;
     int32_t retVal = 0;
     size_t i;
     short nmbrOfFilledBuffers;
     size_t nBlocks10ms;
     size_t nFrames;
 #ifdef AEC_DEBUG
     short msInAECBuf;
 #endif
 
     if (aecm == NULL)
     {
         return -1;
     }
 
     if (nearendNoisy == NULL)
     {
-        aecm->lastError = AECM_NULL_POINTER_ERROR;
-        return -1;
+        return AECM_NULL_POINTER_ERROR;
     }
 
     if (out == NULL)
     {
-        aecm->lastError = AECM_NULL_POINTER_ERROR;
-        return -1;
+        return AECM_NULL_POINTER_ERROR;
     }
 
     if (aecm->initFlag != kInitCheck)
     {
-        aecm->lastError = AECM_UNINITIALIZED_ERROR;
-        return -1;
+        return AECM_UNINITIALIZED_ERROR;
     }
 
     if (nrOfSamples != 80 && nrOfSamples != 160)
     {
-        aecm->lastError = AECM_BAD_PARAMETER_ERROR;
-        return -1;
+        return AECM_BAD_PARAMETER_ERROR;
     }
 
     if (msInSndCardBuf < 0)
     {
         msInSndCardBuf = 0;
-        aecm->lastError = AECM_BAD_PARAMETER_WARNING;
-        retVal = -1;
+        retVal = AECM_BAD_PARAMETER_WARNING;
     } else if (msInSndCardBuf > 500)
     {
         msInSndCardBuf = 500;
-        aecm->lastError = AECM_BAD_PARAMETER_WARNING;
-        retVal = -1;
+        retVal = AECM_BAD_PARAMETER_WARNING;
     }
     msInSndCardBuf += 10;
     aecm->msInSndCardBuf = msInSndCardBuf;
 
     nFrames = nrOfSamples / FRAME_LEN;
     nBlocks10ms = nFrames / aecm->aecmCore->mult;
 
     if (aecm->ECstartup)
     {
         if (nearendClean == NULL)
@@ skipping 142 matching lines @@
 {
   AecMobile* aecm = aecmInst;
 
     if (aecm == NULL)
     {
         return -1;
     }
 
     if (aecm->initFlag != kInitCheck)
     {
-        aecm->lastError = AECM_UNINITIALIZED_ERROR;
-        return -1;
+        return AECM_UNINITIALIZED_ERROR;
     }
 
     if (config.cngMode != AecmFalse && config.cngMode != AecmTrue)
     {
-        aecm->lastError = AECM_BAD_PARAMETER_ERROR;
-        return -1;
+        return AECM_BAD_PARAMETER_ERROR;
     }
     aecm->aecmCore->cngMode = config.cngMode;
 
     if (config.echoMode < 0 || config.echoMode > 4)
     {
-        aecm->lastError = AECM_BAD_PARAMETER_ERROR;
-        return -1;
+        return AECM_BAD_PARAMETER_ERROR;
     }
     aecm->echoMode = config.echoMode;
 
     if (aecm->echoMode == 0)
     {
         aecm->aecmCore->supGain = SUPGAIN_DEFAULT >> 3;
         aecm->aecmCore->supGainOld = SUPGAIN_DEFAULT >> 3;
         aecm->aecmCore->supGainErrParamA = SUPGAIN_ERROR_PARAM_A >> 3;
         aecm->aecmCore->supGainErrParamD = SUPGAIN_ERROR_PARAM_D >> 3;
         aecm->aecmCore->supGainErrParamDiffAB = (SUPGAIN_ERROR_PARAM_A >> 3)
@@ skipping 36 matching lines @@
         aecm->aecmCore->supGainErrParamD = SUPGAIN_ERROR_PARAM_D << 1;
         aecm->aecmCore->supGainErrParamDiffAB = (SUPGAIN_ERROR_PARAM_A << 1)
                 - (SUPGAIN_ERROR_PARAM_B << 1);
         aecm->aecmCore->supGainErrParamDiffBD = (SUPGAIN_ERROR_PARAM_B << 1)
                 - (SUPGAIN_ERROR_PARAM_D << 1);
     }
 
     return 0;
 }
 
-int32_t WebRtcAecm_get_config(void *aecmInst, AecmConfig *config)

[hlundin-webrtc, 2015/10/14 14:34:49]

Why is this function deleted?

[peah-webrtc, 2015/10/14 17:57:36]

I removed it as it was not used anywhere. It is basically untested code as it is
not used, and as this is a submodule we intend to replace I removed it. But I'm
happy to keep it as well. 

[hlundin-webrtc, 2015/10/20 13:01:54]

OK. So it is slightly out-of-scope for this CL. But I don't mind you removing
that code now.

[peah-webrtc, 2015/10/26 09:02:17]

Acknowledged.

-{
-  AecMobile* aecm = aecmInst;
-
-    if (aecm == NULL)
-    {
-        return -1;
-    }
-
-    if (config == NULL)
-    {
-        aecm->lastError = AECM_NULL_POINTER_ERROR;
-        return -1;
-    }
-
-    if (aecm->initFlag != kInitCheck)
-    {
-        aecm->lastError = AECM_UNINITIALIZED_ERROR;
-        return -1;
-    }
-
-    config->cngMode = aecm->aecmCore->cngMode;
-    config->echoMode = aecm->echoMode;
-
-    return 0;
-}
-
 int32_t WebRtcAecm_InitEchoPath(void* aecmInst,
                                 const void* echo_path,
                                 size_t size_bytes)
 {
   AecMobile* aecm = aecmInst;
     const int16_t* echo_path_ptr = echo_path;
 
     if (aecmInst == NULL) {
       return -1;
     }
     if (echo_path == NULL) {
-      aecm->lastError = AECM_NULL_POINTER_ERROR;
-      return -1;
+      return AECM_NULL_POINTER_ERROR;
     }
     if (size_bytes != WebRtcAecm_echo_path_size_bytes())
     {
         // Input channel size does not match the size of AECM
-        aecm->lastError = AECM_BAD_PARAMETER_ERROR;
-        return -1;
+        return AECM_BAD_PARAMETER_ERROR;
     }
     if (aecm->initFlag != kInitCheck)
     {
-        aecm->lastError = AECM_UNINITIALIZED_ERROR;
-        return -1;
+        return AECM_UNINITIALIZED_ERROR;
     }
 
     WebRtcAecm_InitEchoPathCore(aecm->aecmCore, echo_path_ptr);
 
     return 0;
 }
 
 int32_t WebRtcAecm_GetEchoPath(void* aecmInst,
                                void* echo_path,
                                size_t size_bytes)
 {
   AecMobile* aecm = aecmInst;
     int16_t* echo_path_ptr = echo_path;
 
     if (aecmInst == NULL) {
       return -1;
     }
     if (echo_path == NULL) {
-      aecm->lastError = AECM_NULL_POINTER_ERROR;
-      return -1;
+      return AECM_NULL_POINTER_ERROR;
     }
     if (size_bytes != WebRtcAecm_echo_path_size_bytes())
     {
         // Input channel size does not match the size of AECM
-        aecm->lastError = AECM_BAD_PARAMETER_ERROR;
-        return -1;
+        return AECM_BAD_PARAMETER_ERROR;
     }
     if (aecm->initFlag != kInitCheck)
     {
-        aecm->lastError = AECM_UNINITIALIZED_ERROR;
-        return -1;
+        return AECM_UNINITIALIZED_ERROR;
     }
 
     memcpy(echo_path_ptr, aecm->aecmCore->channelStored, size_bytes);
     return 0;
 }
 
 size_t WebRtcAecm_echo_path_size_bytes()
 {
     return (PART_LEN1 * sizeof(int16_t));
 }
 
-int32_t WebRtcAecm_get_error_code(void *aecmInst)
-{
-  AecMobile* aecm = aecmInst;
-
-    if (aecm == NULL)
-    {
-        return -1;
-    }
-
-    return aecm->lastError;
-}
 
 static int WebRtcAecm_EstBufDelay(AecMobile* aecm, short msInSndCardBuf) {
     short delayNew, nSampSndCard;
     short nSampFar = (short) WebRtc_available_read(aecm->farendBuf);
     short diff;
 
     nSampSndCard = msInSndCardBuf * kSampMsNb * aecm->aecmCore->mult;
 
     delayNew = nSampSndCard - nSampFar;
 
@@ skipping 52 matching lines @@
         nSampAdd = (int)(WEBRTC_SPL_MAX(((nSampSndCard >> 1) - nSampFar),
                 FRAME_LEN));
         nSampAdd = WEBRTC_SPL_MIN(nSampAdd, maxStuffSamp);
 
         WebRtc_MoveReadPtr(aecm->farendBuf, -nSampAdd);
         aecm->delayChange = 1; // the delay needs to be updated
     }
 
     return 0;
 }