Merge pull request #25 from kattni/mp3-playback

Add MP3 playback and example with files.

Author: kattni

LICENSES/CC-BY-SA-4.0.txt

@@ -54,6 +54,7 @@
 import displayio
 import audiopwmio
 import audiocore
+import audiomp3
 import usb_hid
 from adafruit_hid.keyboard import Keyboard
 from adafruit_hid.keycode import Keycode
@@ -851,9 +852,11 @@ def stop_tone(self):
         self._speaker_enable.value = False
 
     def play_file(self, file_name):
-        """Play a .wav file using the onboard speaker.
+        """Play a .wav or .mp3 file using the onboard speaker.
 
-        :param file_name: The name of your .wav file in quotation marks including .wav
+        :param file_name: The name of your .wav or .mp3 file in quotation marks including
+                          .wav or .mp3, e.g. "sound.wav" or "sound.mp3". Include location if file
+                          is placed somewhere other than /, e.g. "audio/sound.wav".
 
         The following example plays the file "sound.wav" when the rotary encoder switch is pressed.
 
@@ -866,17 +869,39 @@ def play_file(self, file_name):
             while True:
                 if macropad.encoder_switch:
                     macropad.play_file("sound.wav")
+
+        The following example plays the file "sound.mp3" when the rotary encoder switch is pressed.
+
+        .. code-block:: python
+
+            from adafruit_macropad import MacroPad
+
+            macropad = MacroPad()
+
+            while True:
+                if macropad.encoder_switch:
+                    macropad.play_file("sound.mp3")
         """
-        # Play a specified file.
         self.stop_tone()
         self._speaker_enable.value = True
-        with audiopwmio.PWMAudioOut(
-            board.SPEAKER
-        ) as audio:  # pylint: disable=not-callable
-            wavefile = audiocore.WaveFile(open(file_name, "rb"))
-            audio.play(wavefile)
-            while audio.playing:
-                pass
+        if file_name.lower().endswith(".wav"):
+            with audiopwmio.PWMAudioOut(
+                board.SPEAKER
+            ) as audio:  # pylint: disable=not-callable
+                wavefile = audiocore.WaveFile(open(file_name, "rb"))
+                audio.play(wavefile)
+                while audio.playing:
+                    pass
+        elif file_name.lower().endswith(".mp3"):
+            with audiopwmio.PWMAudioOut(
+                board.SPEAKER
+            ) as audio:  # pylint: disable=not-callable
+                mp3file = audiomp3.MP3Decoder(open(file_name, "rb"))
+                audio.play(mp3file)
+                while audio.playing:
+                    pass
+        else:
+            raise ValueError("Filetype must be wav or MP3.")
         self._speaker_enable.value = False
 
 

adafruit_macropad.py

@@ -40,6 +40,7 @@
     "audiopwmio",
     "audiocore",
     "adafruit_debouncer",
+    "audiomp3",
 ]
 
 

docs/conf.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: Copyright (c) 2021 Bartlebeats for Adafruit Industries
+#
+# SPDX-License-Identifier: CC-BY-SA-4.0

examples/macropad_mp3/beats.mp3

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: Copyright (c) 2021 Bartlebeats for Adafruit Industries
+#
+# SPDX-License-Identifier: CC-BY-SA-4.0

examples/macropad_mp3/beats.mp3.license

@@ -0,0 +1,31 @@
+# SPDX-FileCopyrightText: Copyright (c) 2021 Kattni Rembor for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+"""
+MacroPad MP3 playback demo. Plays one of four different MP3 files when one of the first four keys
+is pressed. All keys light up a color of the rainbow when pressed, but no audio is played for the
+rest of the keys.
+"""
+from rainbowio import colorwheel
+from adafruit_macropad import MacroPad
+
+macropad = MacroPad()
+
+# To include more MP3 files, add the names to this list in the same manner as the others.
+# Then, press the key associated with the file's position in the list to play the file!
+audio_files = ["slow.mp3", "happy.mp3", "beats.mp3", "upbeats.mp3"]
+
+while True:
+    key_event = macropad.keys.events.get()
+
+    if key_event:
+        if key_event.pressed:
+            macropad.pixels[key_event.key_number] = colorwheel(
+                int(255 / 12) * key_event.key_number
+            )
+            if key_event.key_number < len(audio_files):
+                macropad.play_file(audio_files[key_event.key_number])
+
+        else:
+            macropad.pixels.fill((0, 0, 0))
+            macropad.stop_tone()

examples/macropad_mp3/happy.mp3

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: Copyright (c) 2021 Bartlebeats for Adafruit Industries
+#
+# SPDX-License-Identifier: CC-BY-SA-4.0

examples/macropad_mp3/happy.mp3.license

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: Copyright (c) 2021 Bartlebeats for Adafruit Industries
+#
+# SPDX-License-Identifier: CC-BY-SA-4.0