Add constructor/destructor.

Author: embedded-kiddie

BGMusic.cpp

@@ -24,8 +24,14 @@ static CBTimer cbtimer;
 MusicScore_t BGMusic::score = { 0, 0, 0, 0, false };
 int (*BGMusic::duration_function)(int wholenote, int duration) = nullptr;
 
+// Constructor / Destructor
+BGMusic::BGMusic() {}
+BGMusic::~BGMusic() {
+  end();
+}
+
 // Initialize music score sequencer
-bool BGMusic::begin(int pin, int notes[], int n_notes, int tempo, bool loop, bool start) {
+bool BGMusic::begin(int pin, const int notes[], int n_notes, int tempo, bool loop, bool start) {
   debug_begin(9600);
 
   score.pin = pin;

BGMusic.h

@@ -26,9 +26,9 @@
 // Music score
 typedef struct {
   int pin;
-  int *notes;
-  int *notes_bigin;
-  int *notes_end;
+  const int *notes;
+  const int *notes_bigin;
+  const int *notes_end;
   int wholenote;
   int loop;
 } MusicScore_t;
@@ -40,7 +40,9 @@ class BGMusic {
   static int (*duration_function)(int wholenote, int duration);
 
 public:
-  bool begin(int pin, int notes[], int n_notes, int tempo, bool loop, bool start = false);
+  BGMusic();
+  ~BGMusic();
+  bool begin(int pin, const int notes[], int n_notes, int tempo, bool loop, bool start = false);
   static bool start(void);
   static bool stop(void);
   void end(void);

README.md

@@ -46,14 +46,14 @@ void loop() {
 }
 ```
 
-Using this BGMplay library, you can add something to do inside `loop()` like this:
+Using this BGMusic library, you can add something to do inside `loop()` like this:
 
 ```C++
 /*
   Example of music score player in background
 */
 #include "Arduino.h"
-#include "BGMplay.h"
+#include "BGMusic.h"
 
 // notes (pairs of pitch and duration) in musical score.
 // duration: 4 = quarter note, 8 = eighth note, etc.
@@ -62,7 +62,7 @@ static int score[] = {
   NOTE_C4, 4, NOTE_G3, 8, NOTE_G3, 8, NOTE_A3, 4, NOTE_G3, 4, REST, 4, NOTE_B3, 4, NOTE_C4, 4
 };
 
-// Parameters for BGMPlay.begin()
+// parameters for begin()
 #define BUZZER_PIN  11    // pin number connected to the buzzer.
 #define TEMPO       140   // change this to make the song slower or faster.
 #define REPEAT      true  // playback repeatedly
@@ -74,8 +74,9 @@ void setup() {
   pinMode(LED_BUILTIN, OUTPUT);
 
   // initialize and start BGM player
-  BGMplay.begin(BUZZER_PIN, score, N_NOTES(score), TEMPO, REPEAT);
-  BGMplay.start();
+  static BGMusic music;
+  music.begin(BUZZER_PIN, score, N_NOTES(score), TEMPO, REPEAT);
+  music.start();
 }
 
 void loop() {
@@ -150,9 +151,10 @@ int calc_duration(int wholenote, int duration) {
 void setup() {
   ...
   // initialize and start the BGM player
-  BGMusic.set_duration_function(calc_duration);
-  BGMusic.begin(buzzer_pin, melody, notes, tempo, repeat);
-  BGMusic.start();
+  static BGMusic music;
+  music.set_duration_function(calc_duration);
+  music.begin(buzzer_pin, melody, notes, tempo, repeat);
+  music.start();
   ...
 }
 ```

examples/blink_and_music/blink_and_music.ino

@@ -28,7 +28,7 @@ void setup() {
   pinMode(LED_BUILTIN, OUTPUT);
 
   // initialize and start the BGM player
-  BGMusic music;
+  static BGMusic music;
   music.begin(BUZZER_PIN, melody, N_NOTES(melody), TEMPO, REPEAT);
   music.start();
 }