Arduino library to play multi-track MML music using different sound devices.
This library is a follow-up of the ESP-MusicEngine library. It provides a device independant base to implement playing MML music on different MCUs using various devices.
Note that the library requires additional code via callback functions or an inherited child class to implement the actual production of sound on a particular device. The SN76489_MmlMusic example demonstrates using a callback function to produce multiple voice music on the SN76489 complex sound generator using the mxUnifiedSN76489 library. The MmlMusicPWM library implements a child class using which you can play single voice music through a piezo speaker connected to an output pin.
The current version can be downloaded as an Arduino library using the Sketch|Library menu. Just add the zipfile library and the enclosed examples should appear in the menu automatically.
Initialisation outside of Setup():
// include header and initialize class
#include <MmlMusic.h>
MmlMusic music();
Then to play music, call the play method where you want:
music.play("T240 L16 O6 C D E F G");
To continue playing the rest of the sequence, regular calls to continuePlaying() must be made, either in a timer interrupt or as part of a loop.
music.continuePlaying();
See the included examples for more detailed instructions on how to use this library.
Short syntax overview:
| Command | Description |
|---|---|
| Tnnn | Set tempo [32-255]. Examples: T120, T240 |
| Vnnn | Set volume [0-128]. Note: limited effect on PWM-volume. Examples: V1, T120 |
| Lnn | Set default note length [1-64]. Examples: L8, L16 |
| Mx | Set timing. Mn=default, Ml=legato, Ms=staccato |
| On | Set octave [0-7]. Examples: O6, O7 |
| A-G | Play whole note. Example: C |
| Ann-Gnn | Play note of alternative length [1-64]. Example: C4, A16 |
| Nnn | Play frequency [0-96]. Example: N48 |
| # | Play sharp note. Example: C# |
| + | Alternative for # |
| − | Play flat note. Example: D- |
| R | Rest. Example: CDEC r CDEC |
| P | Pause. Alternative for R. Example: CDEC p CDEC |
| . | Longer note. Example: CDEC. |
| > | shift octave up. Example: CDE>CDE. |
| < | shift octave down. Example: CDE<CDE. |
| , | play multiple tracks Example: CDE<CDE.,EDC<ECD. |
The supported MML-commands are a subset that may not completely cover all available music scores. If notes seem missing, check your score against the syntax above and replace unknown commands by equivalent supported alternatives. The music notation is case-insensitive. Spaces are not required but can be used for readability.
- This library was tested in the Arduino IDE v1.6.10 and v1.8.2. The current version of this library supports ESP8266, Atmel ATmega328 and ATmega168 MCUs. Support for ATtiny85 was also added, but since the ATtiny85 has limited resources, available memory limits it usage to simple applications.
- This version currently supports multi-channel playback, but performance is depending on the capabilities of the output device. Unless specified explicitely, each track uses default settings for tempo, volume, length and octave. Some downloaded multiple track MML music assumes subsequent tracks to use the settings of the first track, but the current implementation doesn't support such behavior.
- Track synchronization is not implemented (yet) and the synchronization bar | is not supported.
This library is based on the MusicEngine library ported from mBed to Arduino. It is a follow-up of the ESP-MusicEngine library.
MusicEngine class / Retro Music Engine
Original author: Chris Taylor (taylorza). Open source license: Apache 2.0
see https://developer.mbed.org/users/taylorza/code/MusicEngine/
Ported from mBed to Arduino by MMOLE (maxint-rd), inherited Apache license.
- Learn more about Music Macro Language (MML) on wikipedia:
http://en.wikipedia.org/wiki/Music_Macro_Language - For downloadable MML music see http://www.archeagemmllibrary.com/
- Extensive MML reference guide (not all commands supported):
http://woolyss.com/chipmusic/chipmusic-mml/ppmck_guide.php - Info about using PWM and other methods to generate sound:
https://developer.mbed.org/users/4180_1/notebook/using-a-speaker-for-audio-output/
- All code on this GitHub account, including this library is provided to you on an as-is basis without guarantees and with all liability dismissed. It may be used at your own risk. Unfortunately I have no means to provide support.