Make return codes consistent with other Arduino API's

sandeepmistry · sandeepmistry · commit 11dbe2e827bc · 2016-12-07T09:28:09.000-05:00
diff --git a/examples/AmplitudeSerialPlotter/AmplitudeSerialPlotter.ino b/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
   }
diff --git a/examples/ClapDetector/ClapDetector.ino b/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
   }
diff --git a/examples/SpectrumSerialPlotter/SpectrumSerialPlotter.ino b/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
   }
diff --git a/examples/WhistleDetector/WhistleDetector.ino b/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
   }
diff --git a/src/AmplitudeAnalyzer.cpp b/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)
diff --git a/src/AudioIn.cpp b/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)
diff --git a/src/AudioInI2S.cpp b/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()
diff --git a/src/AudioOutI2S.cpp b/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;
     }
diff --git a/src/FFTAnalyzer.cpp b/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)
diff --git a/src/SDWaveFile.cpp b/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()

Original file line number	Diff line number	Diff line change
`@@ -32,13 +32,13 @@ void setup() {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`// setup the I2S audio input for 44.1 kHz with 32-bits per sample`
`35`		`- if (AudioInI2S.begin(44100, 32)) {`
	`35`	`+ if (!AudioInI2S.begin(44100, 32)) {`
`36`	`36`	`Serial.println("Failed to initialize I2S input!");`
`37`	`37`	`while (1); // do nothing`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`// configure the I2S input as the input for the amplitude analyzer`
`41`		`- if (amplitudeAnalyzer.input(AudioInI2S)) {`
	`41`	`+ if (!amplitudeAnalyzer.input(AudioInI2S)) {`
`42`	`42`	`Serial.println("Failed to set amplitude analyzer input!");`
`43`	`43`	`while (1); // do nothing`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,13 +38,13 @@ void setup() {`
`38`	`38`	`pinMode(ledPin, OUTPUT);`
`39`	`39`
`40`	`40`	`// setup the I2S audio input for 44.1 kHz with 32-bits per sample`
`41`		`- if (AudioInI2S.begin(44100, 32)) {`
	`41`	`+ if (!AudioInI2S.begin(44100, 32)) {`
`42`	`42`	`Serial.println("Failed to initialize I2S input!");`
`43`	`43`	`while (1); // do nothing`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`// configure the I2S input as the input for the amplitude analyzer`
`47`		`- if (amplitudeAnalyzer.input(AudioInI2S)) {`
	`47`	`+ if (!amplitudeAnalyzer.input(AudioInI2S)) {`
`48`	`48`	`Serial.println("Failed to set amplitude analyzer input!");`
`49`	`49`	`while (1); // do nothing`
`50`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,13 +44,13 @@ void setup() {`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`// setup the I2S audio input for the sample rate with 32-bits per sample`
`47`		`- if (AudioInI2S.begin(sampleRate, 32)) {`
	`47`	`+ if (!AudioInI2S.begin(sampleRate, 32)) {`
`48`	`48`	`Serial.println("Failed to initialize I2S input!");`
`49`	`49`	`while (1); // do nothing`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`// configure the I2S input as the input for the FFT analyzer`
`53`		`- if (fftAnalyzer.input(AudioInI2S)) {`
	`53`	`+ if (!fftAnalyzer.input(AudioInI2S)) {`
`54`	`54`	`Serial.println("Failed to set FFT analyzer input!");`
`55`	`55`	`while (1); // do nothing`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,13 +51,13 @@ void setup() {`
`51`	`51`	`pinMode(ledPin, OUTPUT);`
`52`	`52`
`53`	`53`	`// setup the I2S audio input for the sample rate with 32-bits per sample`
`54`		`- if (AudioInI2S.begin(sampleRate, 32)) {`
	`54`	`+ if (!AudioInI2S.begin(sampleRate, 32)) {`
`55`	`55`	`Serial.println("Failed to initialize I2S input!");`
`56`	`56`	`while (1); // do nothing`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`// configure the I2S input as the input for the FFT analyzer`
`60`		`- if (fftAnalyzer.input(AudioInI2S)) {`
	`60`	`+ if (!fftAnalyzer.input(AudioInI2S)) {`
`61`	`61`	`Serial.println("Failed to set FFT analyzer input!");`
`62`	`62`	`while (1); // do nothing`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,12 +51,12 @@ int AmplitudeAnalyzer::configure(AudioIn* input)`
`51`	`51`	`int bitsPerSample = input->bitsPerSample();`
`52`	`52`
`53`	`53`	`if (bitsPerSample != 16 && bitsPerSample != 32) {`
`54`		`- return 1;`
	`54`	`+ return 0;`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`_bitsPerSample = bitsPerSample;`
`58`	`58`
`59`		`- return 0;`
	`59`	`+ return 1;`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`void AmplitudeAnalyzer::update(const void* buffer, size_t size)`
Original file line number	Diff line number	Diff line change
`@@ -32,16 +32,16 @@ AudioIn::~AudioIn()`
`32`	`32`	`int AudioIn::setAnalyzer(AudioAnalyzer* analyzer)`
`33`	`33`	`{`
`34`	`34`	`if (_analyzer) {`
`35`		`- return 1;`
	`35`	`+ return 0;`
`36`	`36`	`}`
`37`	`37`
`38`		`- if (analyzer->configure(this)) {`
`39`		`- return 1;`
	`38`	`+ if (!analyzer->configure(this)) {`
	`39`	`+ return 0;`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`_analyzer = analyzer;`
`43`	`43`
`44`		`- return 0;`
	`44`	`+ return 1;`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`void AudioIn::samplesRead(void* buffer, size_t size)`
Original file line number	Diff line number	Diff line change
`@@ -33,8 +33,8 @@ AudioInI2SClass::~AudioInI2SClass()`
`33`	`33`
`34`	`34`	`int AudioInI2SClass::begin(long sampleRate, int bitsPerSample)`
`35`	`35`	`{`
`36`		`- if (I2S.begin(I2S_PHILIPS_MODE, sampleRate, bitsPerSample)) {`
`37`		`- return 1;`
	`36`	`+ if (!I2S.begin(I2S_PHILIPS_MODE, sampleRate, bitsPerSample)) {`
	`37`	`+ return 0;`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`_sampleRate = sampleRate;`
`@@ -46,7 +46,7 @@ int AudioInI2SClass::begin(long sampleRate, int bitsPerSample)`
`46`	`46`	`// trigger a read to kick things off`
`47`	`47`	`I2S.read();`
`48`	`48`
`49`		`- return 0;`
	`49`	`+ return 1;`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`void AudioInI2SClass::end()`
Original file line number	Diff line number	Diff line change
`@@ -61,18 +61,18 @@ int AudioOutI2SClass::loop(AudioIn& input)`
`61`	`61`	`int AudioOutI2SClass::pause()`
`62`	`62`	`{`
`63`	`63`	`if (!isPlaying()) {`
`64`		`- return 1;`
	`64`	`+ return 0;`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`_paused = true;`
`68`	`68`
`69`		`- return 0;`
	`69`	`+ return 1;`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`int AudioOutI2SClass::resume()`
`73`	`73`	`{`
`74`	`74`	`if (!_paused) {`
`75`		`- return 1;`
	`75`	`+ return 0;`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`_paused = false;`
`@@ -84,13 +84,13 @@ int AudioOutI2SClass::resume()`
`84`	`84`	`I2S.write(silence, sizeof(silence));`
`85`	`85`	`I2S.write(silence, sizeof(silence));`
`86`	`86`
`87`		`- return 0;`
	`87`	`+ return 1;`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`int AudioOutI2SClass::stop()`
`91`	`91`	`{`
`92`	`92`	`if (!_input) {`
`93`		`- return 1;`
	`93`	`+ return 0;`
`94`	`94`	`}`
`95`	`95`
`96`	`96`	`endInput(_input);`
`@@ -119,13 +119,13 @@ int AudioOutI2SClass::startPlayback(AudioIn& input, bool loop)`
`119`	`119`
`120`	`120`	`I2S.onTransmit(AudioOutI2SClass::onI2STransmit);`
`121`	`121`
`122`		`- if (I2S.begin(I2S_PHILIPS_MODE, input.sampleRate(), input.bitsPerSample())) {`
`123`		`- return 1;`
	`122`	`+ if (!I2S.begin(I2S_PHILIPS_MODE, input.sampleRate(), input.bitsPerSample())) {`
	`123`	`+ return 0;`
`124`	`124`	`}`
`125`	`125`
`126`		`- if (beginInput(&input)) {`
	`126`	`+ if (!beginInput(&input)) {`
`127`	`127`	`I2S.end();`
`128`		`- return 1;`
	`128`	`+ return 0;`
`129`	`129`	`}`
`130`	`130`
`131`	`131`	`_input = &input;`
`@@ -137,7 +137,7 @@ int AudioOutI2SClass::startPlayback(AudioIn& input, bool loop)`
`137`	`137`	`I2S.write(silence, sizeof(silence));`
`138`	`138`	`I2S.write(silence, sizeof(silence));`
`139`	`139`
`140`		`- return 0;`
	`140`	`+ return 1;`
`141`	`141`	`}`
`142`	`142`
`143`	`143`	`void AudioOutI2SClass::onTransmit()`
`@@ -158,7 +158,7 @@ void AudioOutI2SClass::onTransmit()`
`158`	`158`	`}`
`159`	`159`
`160`	`160`	`// reset the input`
`161`		`- if (resetInput(_input)) {`
	`161`	`+ if (!resetInput(_input)) {`
`162`	`162`	`I2S.end();`
`163`	`163`	`return;`
`164`	`164`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,20 +78,20 @@ int FFTAnalyzer::configure(AudioIn* input)`
`78`	`78`	`int channels = input->channels();`
`79`	`79`
`80`	`80`	`if (bitsPerSample != 16 && bitsPerSample != 32) {`
`81`		`- return 1;`
	`81`	`+ return 0;`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`if (channels != 1 && channels != 2) {`
`85`		`- return 1;`
	`85`	`+ return 0;`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`if (bitsPerSample == 16) {`
`89`	`89`	`if (ARM_MATH_SUCCESS != arm_rfft_init_q15(&_S15, _length, 0, 1)) {`
`90`		`- return 1;`
	`90`	`+ return 0;`
`91`	`91`	`}`
`92`	`92`	`} else {`
`93`	`93`	`if (ARM_MATH_SUCCESS != arm_rfft_init_q31(&_S31, _length, 0, 1)) {`
`94`		`- return 1;`
	`94`	`+ return 0;`
`95`	`95`	`}`
`96`	`96`	`}`
`97`	`97`
`@@ -126,10 +126,10 @@ int FFTAnalyzer::configure(AudioIn* input)`
`126`	`126`	`_spectrumBuffer = NULL;`
`127`	`127`	`}`
`128`	`128`
`129`		`- return 1;`
	`129`	`+ return 0;`
`130`	`130`	`}`
`131`	`131`
`132`		`- return 0;`
	`132`	`+ return 1;`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`void FFTAnalyzer::update(const void* buffer, size_t size)`
Original file line number	Diff line number	Diff line change
`@@ -163,14 +163,14 @@ int SDWaveFile::cue(long time)`
`163`	`163`	`int SDWaveFile::begin()`
`164`	`164`	`{`
`165`	`165`	`if (!(*this)) {`
`166`		`- return 1;`
	`166`	`+ return 0;`
`167`	`167`	`}`
`168`	`168`
`169`	`169`	`_file = SD.open(_filename);`
`170`	`170`
`171`	`171`	`_isPlaying = true;`
`172`	`172`
`173`		`- return 0;`
	`173`	`+ return 1;`
`174`	`174`	`}`
`175`	`175`
`176`	`176`	`int SDWaveFile::read(void* buffer, size_t size)`
`@@ -194,7 +194,7 @@ int SDWaveFile::reset()`
`194`	`194`	`{`
`195`	`195`	`cue(0);`
`196`	`196`
`197`		`- return 0;`
	`197`	`+ return 1;`
`198`	`198`	`}`
`199`	`199`
`200`	`200`	`void SDWaveFile::end()`