Add MP3 examples

.github/workflows/examples.yml

@@ -11,6 +11,7 @@ jobs:
         example:
           - "examples/arduino-blink"
           - "examples/arduino-gnss"
+          - "examples/arduino-mp3-player"
           - "examples/arduino-multiprocessing-message"
     runs-on: ${{ matrix.os }}
     steps:

examples/arduino-mp3-decoder-installer/.gitignore

@@ -0,0 +1,2 @@
+.pio
+.vscode

examples/arduino-mp3-decoder-installer/README.md

@@ -0,0 +1,27 @@
+How to build PlatformIO based project
+=====================================
+
+1. [Install PlatformIO Core](https://docs.platformio.org/page/core.html)
+2. Download [development platform with examples](https://github.com/maxgerhardt/platform-sonyspresense/archive/main.zip)
+3. Extract ZIP archive
+4. Run these commands:
+
+```shell
+# Change directory to example
+$ cd platform-sonyspresense/examples/arduino-mp3-decoder-installer
+
+# Build project
+$ pio run
+
+# Upload firmware
+$ pio run --target upload
+
+# Build specific environment
+$ pio run -e spresense
+
+# Upload firmware for the specific environment
+$ pio run -e spresense --target upload
+
+# Clean build files
+$ pio run --target clean
+```

examples/arduino-mp3-decoder-installer/platformio.ini

@@ -0,0 +1,15 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env:spresense]
+platform = sonyspresense
+board = spresense
+framework = arduino
+monitor_speed = 115200

examples/arduino-mp3-decoder-installer/src/MP3DEC.h

@@ -0,0 +1,9 @@
+#ifndef _MP3DEC_H
+#define _MP3DEC_H
+/* Auto-generated by bin2c.py */
+#include <stddef.h>
+
+extern const unsigned char MP3DEC_start[];
+extern const size_t MP3DEC_size;
+
+#endif

examples/arduino-mp3-decoder-installer/src/main.cpp

@@ -0,0 +1,163 @@
+/*
+ *  mp3_dec_installer.ino - MP3 decoder dsp installer
+ *  Copyright 2018 Sony Semiconductor Solutions Corporation
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License as published by the Free Software Foundation; either
+ *  version 2.1 of the License, or (at your option) any later version.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ *  The DSP installer is used to load code for the Audio DSP into SD Card or SPI-Flash.
+ *  This needs to be done ahead of using the Audio DSP functions in any sketch.
+ *  A range of Audio DSP functions are available. This skecth loads MP3 decoder.
+ *
+ *  Run the sketch and you should see
+ *    Select where to install MP3DEC?
+ *     [1]: SD Card (Insert SD Card on the extension board)
+ *     [2]: SPI-Flash
+ *  After the above message appeared, input a numeral number from Serial Monitor.
+ *  If '1' is input,
+ *    Install: /mnt/sd0/BIN/MP3DEC Done.
+ *  If '2' is input,
+ *    Install: /mnt/spif/BIN/MP3DEC Done.
+ *    Finished.
+ *
+ *  The loading process only needs to be done once as the DSP code is retained when up upload a new sketch.
+ *
+ *  To check what DSP files are loaded is a board you have already programmed you can use NuttShell
+ *  - To list the files installed in the SPI-Flash. Check the directory /mnt/spif/BIN.
+ *  - To list the files installed in the SD Card. Check the directory /mnt/sd0/BIN
+ *    or put the SD card in a PC and check the SD card /BIN directory.
+ *
+ *  You can use dsp_inataller with a range of encoders and decoders as they become available.
+ *
+ *  This example code is in the public domain.
+ */
+#include <Arduino.h>
+#include <stdio.h>
+#include <sys/stat.h>
+#include <unistd.h>
+
+// Include each file generated by bin2c
+#include "MP3DEC.h"
+
+#define DSP_MOUNTPT_SDCARD   "/mnt/sd0/BIN"
+#define DSP_MOUNTPT_SPIFLASH "/mnt/spif/BIN"
+
+#define _FILEELEM(elem) { \
+  .name = #elem, \
+  .addr = elem##_start, \
+  .size = &elem##_size, \
+}
+
+struct fileinfo_s {
+  const char *name;
+  const unsigned char *addr;
+  const size_t *size;
+};
+
+struct fileinfo_s dsplist[] =
+{
+  // Add each file here
+  _FILEELEM(MP3DEC),
+};
+
+void setup()
+{
+  unsigned int i;
+  int ret;
+  FILE *fp;
+  char dirpath[64] = {0};
+  char filepath[64] = {0};
+  enum {INTO_SD, INTO_FLASH} where;
+
+  Serial.begin(115200);
+  while (!Serial) {
+    ; // wait for serial port to connect.
+  }
+
+  // Display Menu
+  Serial.println("Select where to install MP3DEC?");
+  Serial.println(" [1]: SD Card (Insert SD Card on the extension board)");
+  Serial.println(" [2]: SPI-Flash");
+
+  // User Menu Selection
+  int c;
+  while (true) {
+    Serial.println("");
+    Serial.print("Please input number. [1-2] ? ");
+    while (!Serial.available());
+    c = Serial.read();
+    while (Serial.available()) {
+      Serial.read(); // Discard inputs except for 1st character
+    }
+
+    if (c == '1') {
+      Serial.println("1 -> SD Card");
+      where = INTO_SD;
+      break;
+    } else if (c == '2') {
+      Serial.println("2 -> SPI-Flash");
+      where = INTO_FLASH;
+      break;
+    } else {
+      if ((c != '\n') && (c != '\r'))
+        Serial.write(c);
+    }
+  }
+
+  // If install to SD Card, check whether the SD Card is inserted.
+  if (where == INTO_SD) {
+    struct stat buf;
+
+    strncpy(dirpath, DSP_MOUNTPT_SDCARD, sizeof(dirpath));
+    for (;;) {
+      ret = stat("/mnt/sd0", &buf);
+      if (ret) {
+        Serial.println("Please insert formatted SD Card.");
+        sleep(1);
+      } else {
+        break;
+      }
+    }
+  } else if (where == INTO_FLASH) {
+    strncpy(dirpath, DSP_MOUNTPT_SPIFLASH, sizeof(dirpath));
+  }
+
+  mkdir(dirpath, 0777);
+
+  for (i = 0; i < sizeof(dsplist) / sizeof(dsplist[0]); i++)
+    {
+      snprintf(filepath, sizeof(filepath), "%s/%s",
+               dirpath, dsplist[i].name);
+
+      Serial.print("Install: ");
+      Serial.print(filepath);
+
+      unlink(filepath);
+
+      fp = fopen(filepath, "wb");
+
+      ret = fwrite(dsplist[i].addr, *dsplist[i].size, 1, fp);
+
+      Serial.println((ret) ? " Done." : " Fail.");
+
+      fclose(fp);
+    }
+
+  Serial.println("Finished.");
+}
+
+void loop()
+{
+  // nothing happens after setup finishes.
+}

examples/arduino-mp3-player/.gitignore

@@ -0,0 +1,2 @@
+.pio
+.vscode

examples/arduino-mp3-player/README.md

@@ -0,0 +1,34 @@
+How to build PlatformIO based project
+=====================================
+
+1. [Install PlatformIO Core](https://docs.platformio.org/page/core.html)
+2. Download [development platform with examples](https://github.com/maxgerhardt/platform-sonyspresense/archive/main.zip)
+3. Extract ZIP archive
+4. Run these commands:
+
+```shell
+# Change directory to example
+$ cd platform-sonyspresense/examples/arduino-mp3-player
+
+# Build project
+$ pio run
+
+# Upload firmware
+$ pio run --target upload
+
+# Build specific environment
+$ pio run -e spresense
+
+# Upload firmware for the specific environment
+$ pio run -e spresense --target upload
+
+# Clean build files
+$ pio run --target clean
+```
+
+Important Notes
+===============
+
+Upload the `arduino-mp3-decoder-installer` sketch first to install the necessary MP3 decoder!
+
+You must also have a FAT formatted SD card installed in the board. The sketch will try to play the `Sound.mp3` file that you put on the card.

examples/arduino-mp3-player/platformio.ini

@@ -0,0 +1,15 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env:spresense]
+platform = sonyspresense
+board = spresense
+framework = arduino
+monitor_speed = 115200