Make return codes consistent with other Arduino API's

Author: sandeepmistry

examples/AmplitudeSerialPlotter/AmplitudeSerialPlotter.ino

@@ -32,13 +32,13 @@ void setup() {
   }
 
   // setup the I2S audio input for 44.1 kHz with 32-bits per sample
-  if (AudioInI2S.begin(44100, 32)) {
+  if (!AudioInI2S.begin(44100, 32)) {
     Serial.println("Failed to initialize I2S input!");
     while (1); // do nothing
   }
 
   // configure the I2S input as the input for the amplitude analyzer
-  if (amplitudeAnalyzer.input(AudioInI2S)) {
+  if (!amplitudeAnalyzer.input(AudioInI2S)) {
     Serial.println("Failed to set amplitude analyzer input!");
     while (1); // do nothing
   }

examples/ClapDetector/ClapDetector.ino

@@ -38,13 +38,13 @@ void setup() {
   pinMode(ledPin, OUTPUT);
 
   // setup the I2S audio input for 44.1 kHz with 32-bits per sample
-  if (AudioInI2S.begin(44100, 32)) {
+  if (!AudioInI2S.begin(44100, 32)) {
     Serial.println("Failed to initialize I2S input!");
     while (1); // do nothing
   }
 
   // configure the I2S input as the input for the amplitude analyzer
-  if (amplitudeAnalyzer.input(AudioInI2S)) {
+  if (!amplitudeAnalyzer.input(AudioInI2S)) {
     Serial.println("Failed to set amplitude analyzer input!");
     while (1); // do nothing
   }

examples/SpectrumSerialPlotter/SpectrumSerialPlotter.ino

@@ -44,13 +44,13 @@ void setup() {
   }
 
   // setup the I2S audio input for the sample rate with 32-bits per sample
-  if (AudioInI2S.begin(sampleRate, 32)) {
+  if (!AudioInI2S.begin(sampleRate, 32)) {
     Serial.println("Failed to initialize I2S input!");
     while (1); // do nothing
   }
 
   // configure the I2S input as the input for the FFT analyzer
-  if (fftAnalyzer.input(AudioInI2S)) {
+  if (!fftAnalyzer.input(AudioInI2S)) {
     Serial.println("Failed to set FFT analyzer input!");
     while (1); // do nothing
   }

examples/WhistleDetector/WhistleDetector.ino

@@ -51,13 +51,13 @@ void setup() {
   pinMode(ledPin, OUTPUT);
 
   // setup the I2S audio input for the sample rate with 32-bits per sample
-  if (AudioInI2S.begin(sampleRate, 32)) {
+  if (!AudioInI2S.begin(sampleRate, 32)) {
     Serial.println("Failed to initialize I2S input!");
     while (1); // do nothing
   }
 
   // configure the I2S input as the input for the FFT analyzer
-  if (fftAnalyzer.input(AudioInI2S)) {
+  if (!fftAnalyzer.input(AudioInI2S)) {
     Serial.println("Failed to set FFT analyzer input!");
     while (1); // do nothing
   }

src/AmplitudeAnalyzer.cpp

@@ -51,12 +51,12 @@ int AmplitudeAnalyzer::configure(AudioIn* input)
   int bitsPerSample = input->bitsPerSample();
 
   if (bitsPerSample != 16 && bitsPerSample != 32) {
-    return 1;
+    return 0;
   }
 
   _bitsPerSample = bitsPerSample;
 
-  return 0;
+  return 1;
 }
 
 void AmplitudeAnalyzer::update(const void* buffer, size_t size)

src/AudioIn.cpp

@@ -32,16 +32,16 @@ AudioIn::~AudioIn()
 int AudioIn::setAnalyzer(AudioAnalyzer* analyzer)
 {
   if (_analyzer) {
-    return 1;
+    return 0;
   }
 
-  if (analyzer->configure(this)) {
-    return 1;
+  if (!analyzer->configure(this)) {
+    return 0;
   }
 
   _analyzer = analyzer;
 
-  return 0;
+  return 1;
 }
 
 void AudioIn::samplesRead(void* buffer, size_t size)

src/AudioInI2S.cpp

@@ -33,8 +33,8 @@ AudioInI2SClass::~AudioInI2SClass()
 
 int AudioInI2SClass::begin(long sampleRate, int bitsPerSample)
 {
-  if (I2S.begin(I2S_PHILIPS_MODE, sampleRate, bitsPerSample)) {
-    return 1;
+  if (!I2S.begin(I2S_PHILIPS_MODE, sampleRate, bitsPerSample)) {
+    return 0;
   }
 
   _sampleRate = sampleRate;
@@ -46,7 +46,7 @@ int AudioInI2SClass::begin(long sampleRate, int bitsPerSample)
   // trigger a read to kick things off
   I2S.read();
 
-  return 0;
+  return 1;
 }
 
 void AudioInI2SClass::end()

src/AudioOutI2S.cpp

@@ -61,18 +61,18 @@ int AudioOutI2SClass::loop(AudioIn& input)
 int AudioOutI2SClass::pause()
 {
   if (!isPlaying()) {
-    return 1;
+    return 0;
   }
 
   _paused = true;
 
-  return 0;
+  return 1;
 }
 
 int AudioOutI2SClass::resume()
 {
   if (!_paused) {
-    return 1;
+    return 0;
   }
 
   _paused = false;
@@ -84,13 +84,13 @@ int AudioOutI2SClass::resume()
   I2S.write(silence, sizeof(silence));
   I2S.write(silence, sizeof(silence));
 
-  return 0;
+  return 1;
 }
 
 int AudioOutI2SClass::stop()
 {
   if (!_input) {
-    return 1;    
+    return 0;    
   }
 
   endInput(_input);
@@ -119,13 +119,13 @@ int AudioOutI2SClass::startPlayback(AudioIn& input, bool loop)
 
   I2S.onTransmit(AudioOutI2SClass::onI2STransmit);
 
-  if (I2S.begin(I2S_PHILIPS_MODE, input.sampleRate(), input.bitsPerSample())) {
-    return 1;
+  if (!I2S.begin(I2S_PHILIPS_MODE, input.sampleRate(), input.bitsPerSample())) {
+    return 0;
   }
 
-  if (beginInput(&input)) {
+  if (!beginInput(&input)) {
     I2S.end();
-    return 1;
+    return 0;
   }
 
   _input = &input;
@@ -137,7 +137,7 @@ int AudioOutI2SClass::startPlayback(AudioIn& input, bool loop)
   I2S.write(silence, sizeof(silence));
   I2S.write(silence, sizeof(silence));
 
-  return 0;
+  return 1;
 }
 
 void AudioOutI2SClass::onTransmit()
@@ -158,7 +158,7 @@ void AudioOutI2SClass::onTransmit()
     }
 
     // reset the input
-    if (resetInput(_input)) {
+    if (!resetInput(_input)) {
       I2S.end();
       return;
     }

src/FFTAnalyzer.cpp

@@ -78,20 +78,20 @@ int FFTAnalyzer::configure(AudioIn* input)
   int channels = input->channels();
 
   if (bitsPerSample != 16 && bitsPerSample != 32) {
-    return 1;
+    return 0;
   }
 
   if (channels != 1 && channels != 2) {
-    return 1;
+    return 0;
   }
 
   if (bitsPerSample == 16) {
     if (ARM_MATH_SUCCESS != arm_rfft_init_q15(&_S15, _length, 0, 1)) {
-      return 1;
+      return 0;
     }
   } else {
     if (ARM_MATH_SUCCESS != arm_rfft_init_q31(&_S31, _length, 0, 1)) {
-      return 1;
+      return 0;
     }
   }
 
@@ -126,10 +126,10 @@ int FFTAnalyzer::configure(AudioIn* input)
       _spectrumBuffer = NULL;
     }
 
-    return 1;
+    return 0;
   }
 
-  return 0;
+  return 1;
 }
 
 void FFTAnalyzer::update(const void* buffer, size_t size)

src/SDWaveFile.cpp

@@ -163,14 +163,14 @@ int SDWaveFile::cue(long time)
 int SDWaveFile::begin()
 {
   if (!(*this)) {
-    return 1;
+    return 0;
   }
 
   _file = SD.open(_filename);
 
   _isPlaying = true;
 
-  return 0;
+  return 1;
 }
 
 int SDWaveFile::read(void* buffer, size_t size)
@@ -194,7 +194,7 @@ int SDWaveFile::reset()
 {
   cue(0);
 
-  return 0;
+  return 1;
 }
 
 void SDWaveFile::end()