Remove ArduinoLog dependency (#13)

To get rid of ArduinoLog 3rd party dependency. 
To make use of ESP Arduino framework built in logger.
Depending on the platform it's the one which comes from 
Arduino core for ESP32 or Arduino core for ESP8266. 
Documentation updated accordingly.

The original plan to provide ESP-IDF framework compatibility is not yet done, 
as the library implementation uses much more Arduino core for ESP dependent stuff.

Author: baldram

README.md

@@ -62,23 +62,46 @@ Please note that `player.switchToMp3Mode()` is an optional switch. Some of VS105
 You can modify the board, but there is a more elegant way without soldering. For more details please read a discussion here: [http://www.bajdi.com/lcsoft-vs1053-mp3-module/#comment-33773](http://www.bajdi.com/lcsoft-vs1053-mp3-module/#comment-33773).
 <br />No side effects for boards which do not need this switch, so you can call it just in case.
 
-#### Third-party dependencies
+#### Logging / debugging
 
-The library use also a third-party logging framework [ArduinoLog](http://platformio.org/lib/show/1532/ArduinoLog/) for debugging purposes.<br /> 
-This dependency will be resolved automatically.
+The library uses ESP Arduino framework built in logger (Arduino core for [ESP32](https://github.com/espressif/arduino-esp32/issues/893#issuecomment-348069135) and [ESP8266](https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst#debug-level)).<br /> 
 
-Then you are able to include and use this library from your code (it offers several log levels):
+To see debug messages please add build flags to your `platformio.ini` as below (depending on platform):
 
+- for ESP8266:
+
+`build_flags = -D DEBUG_ESP_PORT=Serial`
+
+- for ESP32:
+
+`build_flags = -DCORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_DEBUG`
+
+The Serial Interface needs to be initialized in the `setup()`.
+
+```
+void setup() {
+    Serial.begin(115200);
+}
 ```
-#include <ArduinoLog.h>
+Now if something is wrong, you'll see the output like below (from ESP32):
+
 ```
-...
+[I][main.cpp:117] setup(): Hello # VS1053!
+[D][VS1053.cpp:156] begin(): 
+[D][VS1053.cpp:157] begin(): Reset VS1053...
+[D][VS1053.cpp:161] begin(): End reset VS1053...
+[D][VS1053.cpp:119] testComm(): VS1053 not properly installed!
 ```
-Serial.begin(9600);
-while(!Serial && !Serial.available()){}
-Log.begin(LOG_LEVEL_VERBOSE, &Serial);
+In successful case it would start with something like this:
 
-Log.notice("Hello, this is a debug message!");
+```
+[I][main.cpp:117] setup(): Hello # VS1053!
+[D][VS1053.cpp:156] begin(): 
+[D][VS1053.cpp:157] begin(): Reset VS1053...
+[D][VS1053.cpp:161] begin(): End reset VS1053...
+[D][VS1053.cpp:132] testComm(): Slow SPI,Testing VS1053 read/write registers...
+[D][VS1053.cpp:132] testComm(): Fast SPI, Testing VS1053 read/write registers again...
+[D][VS1053.cpp:183] begin(): endFillByte is 0
 ```
 
 ## Example wiring

platformio.ini

@@ -13,5 +13,10 @@ platform = espressif8266
 board = nodemcuv2
 framework = arduino
 
+[env:esp32dev]
+platform = espressif32
+framework = espidf
+board = esp32dev
+
 lib_deps =
     ArduinoLog

src/ConsoleLogger.h

@@ -0,0 +1,29 @@
+/**
+ * Licensed under GNU GPLv3 <http://gplv3.fsf.org/>
+ * Copyright © 2018
+ *
+ * @author Marcin Szalomski (github: @baldram | twitter: @baldram)
+ */
+
+#ifndef __ESP_VS1053_LIBRARY_CONSOLE_LOGGER__
+    #define __ESP_VS1053_LIBRARY_CONSOLE_LOGGER__
+
+    /**
+     * To enable debug, add build flag to your platformio.ini as below (depending on platform).
+     *
+     * For ESP8266:
+     *      build_flags = -D DEBUG_ESP_PORT=Serial
+     *
+     * For ESP32:
+     *      build_flags = -DCORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_DEBUG
+     *
+     */
+    #ifdef ARDUINO_ARCH_ESP32
+        #define LOG(...) ESP_LOGD("ESP_VS1053", __VA_ARGS__)
+    #elif defined(ARDUINO_ARCH_ESP8266) && defined(DEBUG_ESP_PORT)
+        #define LOG(...) DEBUG_ESP_PORT.printf(__VA_ARGS__)
+    #else
+        #define LOG(...)
+    #endif
+
+#endif // __ESP_VS1053_LIBRARY_CONSOLE_LOGGER__

src/VS1053.cpp

@@ -6,7 +6,7 @@
  * version 1.0.1
  *
  * Licensed under GNU GPLv3 <http://gplv3.fsf.org/>
- * Copyright © 2017
+ * Copyright © 2018
  *
  * @authors baldram, edzelf, MagicCube, maniacbug
  *
@@ -30,10 +30,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-
-#include <ArduinoLog.h>
-#include <VS1053.h>
-#include <string>
+#include "VS1053.h"
 
 VS1053::VS1053(uint8_t _cs_pin, uint8_t _dcs_pin, uint8_t _dreq_pin)
         : cs_pin(_cs_pin), dcs_pin(_dcs_pin), dreq_pin(_dreq_pin) {
@@ -119,7 +116,7 @@ bool VS1053::testComm(const char *header) {
     uint16_t delta = 300; // 3 for fast SPI
 
     if (!digitalRead(dreq_pin)) {
-        Log.error("VS1053 not properly installed!" CR);
+        LOG("VS1053 not properly installed!\n");
         // Allow testing without the VS1053 module
         pinMode(dreq_pin, INPUT_PULLUP); // DREQ is now input with pull-up
         return false;                    // Return bad result
@@ -132,16 +129,15 @@ bool VS1053::testComm(const char *header) {
         delta = 3; // Fast SPI, more loops
     }
 
-    std::string headerCr = std::string(header) + CR;
-    Log.notice(headerCr.c_str());  // Show a header
+    LOG("%s", header);  // Show a header
 
     for (i = 0; (i < 0xFFFF) && (cnt < 20); i += delta) {
         write_register(SCI_VOL, i);         // Write data to SCI_VOL
         r1 = read_register(SCI_VOL);        // Read back for the first time
         r2 = read_register(SCI_VOL);        // Read back a second time
         if (r1 != r2 || i != r1 || i != r2) // Check for 2 equal reads
         {
-            Log.error("VS1053 error retry SB:%04X R1:%04X R2:%04X" CR, i, r1, r2);
+            LOG("VS1053 error retry SB:%04X R1:%04X R2:%04X\n", i, r1, r2);
             cnt++;
             delay(10);
         }
@@ -150,46 +146,44 @@ bool VS1053::testComm(const char *header) {
     return (cnt == 0); // Return the result
 }
 
-bool VS1053::begin() {
-    bool result = false;
+void VS1053::begin() {
     pinMode(dreq_pin, INPUT); // DREQ is an input
     pinMode(cs_pin, OUTPUT);  // The SCI and SDI signals
     pinMode(dcs_pin, OUTPUT);
     digitalWrite(dcs_pin, HIGH); // Start HIGH for SCI en SDI
     digitalWrite(cs_pin, HIGH);
     delay(100);
-    Log.notice("Reset VS1053..." CR);
+    LOG("\n");
+    LOG("Reset VS1053...\n");
     digitalWrite(dcs_pin, LOW); // Low & Low will bring reset pin low
     digitalWrite(cs_pin, LOW);
     delay(500);
-    Log.notice("End reset VS1053..." CR);
+    LOG("End reset VS1053...\n");
     digitalWrite(dcs_pin, HIGH); // Back to normal again
     digitalWrite(cs_pin, HIGH);
     delay(500);
     // Init SPI in slow mode ( 0.2 MHz )
     VS1053_SPI = SPISettings(200000, MSBFIRST, SPI_MODE0);
-    // printDetails ( "Right after reset/startup" ) ;
+    // printDetails("Right after reset/startup");
     delay(20);
-    // printDetails ( "20 msec after reset" ) ;
-    result = testComm("Slow SPI,Testing VS1053 read/write registers...");
-
-    //softReset();
-
-    // Switch on the analog parts
-    write_register(SCI_AUDATA, 44101); // 44.1kHz stereo
-    // The next clocksetting allows SPI clocking at 5 MHz, 4 MHz is safe then.
-    write_register(SCI_CLOCKF, 6 << 12); // Normal clock settings multiplyer 3.0 = 12.2 MHz
-    // SPI Clock to 4 MHz. Now you can set high speed SPI clock.
-    VS1053_SPI = SPISettings(4000000, MSBFIRST, SPI_MODE0);
-    write_register(SCI_MODE, _BV(SM_SDINEW) | _BV(SM_LINE1));
-    result = testComm("Fast SPI, Testing VS1053 read/write registers again...");
-    delay(10);
-    await_data_request();
-    endFillByte = wram_read(0x1E06) & 0xFF;
-    Log.notice("endFillByte is %X" CR, endFillByte);
-    // printDetails ( "After last clocksetting" ) ;
-    delay(100);
-    return result;
+    // printDetails("20 msec after reset");
+    if (testComm("Slow SPI,Testing VS1053 read/write registers...\n")) {
+        //softReset();
+        // Switch on the analog parts
+        write_register(SCI_AUDATA, 44101); // 44.1kHz stereo
+        // The next clocksetting allows SPI clocking at 5 MHz, 4 MHz is safe then.
+        write_register(SCI_CLOCKF, 6 << 12); // Normal clock settings multiplyer 3.0 = 12.2 MHz
+        // SPI Clock to 4 MHz. Now you can set high speed SPI clock.
+        VS1053_SPI = SPISettings(4000000, MSBFIRST, SPI_MODE0);
+        write_register(SCI_MODE, _BV(SM_SDINEW) | _BV(SM_LINE1));
+        testComm("Fast SPI, Testing VS1053 read/write registers again...\n");
+        delay(10);
+        await_data_request();
+        endFillByte = wram_read(0x1E06) & 0xFF;
+        LOG("endFillByte is %X\n", endFillByte);
+        //printDetails("After last clocksetting") ;
+        delay(100);
+    }
 }
 
 void VS1053::setVolume(uint8_t vol) {
@@ -205,8 +199,7 @@ void VS1053::setVolume(uint8_t vol) {
     }
 }
 
-void VS1053::setTone(uint8_t *rtone) // Set bass/treble (4 nibbles)
-{
+void VS1053::setTone(uint8_t *rtone) { // Set bass/treble (4 nibbles)
     // Set tone characteristics.  See documentation for the 4 nibbles.
     uint16_t value = 0; // Value to send to SCI_BASS
     int i;              // Loop control
@@ -217,8 +210,7 @@ void VS1053::setTone(uint8_t *rtone) // Set bass/treble (4 nibbles)
     write_register(SCI_BASS, value); // Volume left and right
 }
 
-uint8_t VS1053::getVolume() // Get the currenet volume setting.
-{
+uint8_t VS1053::getVolume() { // Get the currenet volume setting.
     return curvol;
 }
 
@@ -242,7 +234,7 @@ void VS1053::stopSong() {
         modereg = read_register(SCI_MODE); // Read status
         if ((modereg & _BV(SM_CANCEL)) == 0) {
             sdi_send_fillers(2052);
-            Log.notice("Song stopped correctly after %d msec" CR, i * 10);
+            LOG("Song stopped correctly after %d msec\n", i * 10);
             return;
         }
         delay(10);
@@ -260,17 +252,15 @@ void VS1053::printDetails(const char *header) {
     uint16_t regbuf[16];
     uint8_t i;
 
-    std::string headerCr = std::string(header) + CR;
-    Log.notice(headerCr.c_str());
-
-    Log.notice("REG   Contents" CR);
-    Log.notice("---   -----" CR);
+    LOG("%s", header);
+    LOG("REG   Contents\n");
+    LOG("---   -----\n");
     for (i = 0; i <= SCI_num_registers; i++) {
         regbuf[i] = read_register(i);
     }
     for (i = 0; i <= SCI_num_registers; i++) {
         delay(5);
-        Log.notice("%3X - %5X" CR, i, regbuf[i]);
+        LOG("%3X - %5X\n", i, regbuf[i]);
     }
 }
 
@@ -282,8 +272,7 @@ void VS1053::printDetails(const char *header) {
  *
  * Read more here: http://www.bajdi.com/lcsoft-vs1053-mp3-module/#comment-33773
  */
-void VS1053::switchToMp3Mode(void)
-{
+void VS1053::switchToMp3Mode() {
     wram_write(0xC017, 3); // GPIO DDR = 3
     wram_write(0xC019, 0); // GPIO ODATA = 0
     delay(100);

src/VS1053.h

@@ -36,6 +36,7 @@
 
 #include <Arduino.h>
 #include <SPI.h>
+#include "ConsoleLogger.h"
 
 class VS1053 {
 private:
@@ -109,7 +110,7 @@ class VS1053 {
     // Constructor.  Only sets pin values.  Doesn't touch the chip.  Be sure to call begin()!
     VS1053(uint8_t _cs_pin, uint8_t _dcs_pin, uint8_t _dreq_pin);
 
-    bool begin();                               // Begin operation.  Sets pins correctly,
+    void begin();                               // Begin operation.  Sets pins correctly,
                                                 // and prepares SPI bus.
     void startSong();                           // Prepare to start playing. Call this each
                                                 // time a new song starts.