View source for Arduino Music Shield V2.0

== Introduction  ==

[[File:mp3v2.jpg]]

Time to build your real-time MIDI instrument/music player! It can play many format including MP3,WMA,WAV,AAC,MIDI,Ogg VorbisThe. Music Shield is an audio encoder/decoder compatible with Arduino, iduino  mega and Arduino Mega. It is based on the VC1053B chip, which enabled it to play sound files from SD card and do short-time recording as well. You can also use it to play MIDI notes by slightly changing its hardware installations. Due to the SPI communication mode, it keeps a minimum number of IO port that facilitates users’ own developments of this device. Additionally, the new multifunction button provides greater convenience for users to control. 

'''Notice:''' The recording function works with iduino Mega and Arduino Mega only. And the maximum size SD card you can use is 2GB. <br>



<br>

== Specification  ==

<br>[[File:Music_shield_frame.jpg]]<br>

<br>'''Multifunction button:''' Change volume and select songs<br>'''Play/Pause indicator LED (GREEN)：'''Blinks while playing.<br>'''Headsets interface: '''It can drive 16 ohm or 32 ohm earphone and could serve as a external audio input port.<br>'''Micro SD card''': can be FAT16 or FAT32, The maximum size SD card you can use is 2GB.<br>'''U2:''' VS1053B IC,Ogg Vorbis/MP3/AAC/WMA/FLAC/MIDI audio codec.<br>'''U3,U7:''' 74VHC125 IC, Quad Buffer.<br>'''I2S: '''for digital audio input/output.<br>'''ISP interface''': for bringing SPI port when using with Mega series products.<br>

'''Pins usage on Arduino''' 

'''Pins Used for Play Control:<br>'''D3 - receiving signal from button for Volume Up;<br>D4 - receiving signal from switch for Next Song function;<br>D5 - receiving signal from switch for Play&amp;Stop and Record function;<br>D6 - receiving signal from switch for Previous Song function;<br>D7 - receiving signal from button for Volume Down.<br>D8 - Green Led instructions; 

<br>'''Pins Used for SPI Interface:'''<br>D10 - SPI Chip Select;<br>D11 - SPI MOSI;<br>D12 - SPI MISO;<br>D13 - SPI SCK; 

<br>'''Pins Used for VS1053 Interface:<br>'''A0 - Reset of VS1053;<br>A1- Data Require of VS1053;<br>A2 - Data Select of VS1053;<br>A3 - Chip Select of VS1053; 





<br>
== Demonstration  ==

<br>'''Note:''' 
1. If you want to use MIDI function, you need to change the hardware installation.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;
2. If you changed the hardware installation in order to use MIDI function, you are not able to use playback &amp; recording functions until you restore it to the original condition.

<br>
==='''&nbsp;Play music<br>'''===
1. Make sure there are songs in the micro SD card;<br>
2. Download [https://github.com/Seeed-Studio/Music_Shield/tree/musicshield_lib_for_hw_v2 Music shield library]<br>
3. Unzip and copy the folder to Arduino’s library path: ..\arduino-1.0\libraries; 

'''Demo 1: Play songs (e.g. in shuffle mode)<br>'''In order to use the playback function, you need to create a playlist first. <br>1. Restart the Arduino IDE. Open “creatList” example via the path: File --&gt; Examples --&gt; MusicPlayer --&gt; creatList as below. <br>[[Image:OpenCreatListCode.jpg]]&nbsp; 

<br>2. Set the play mode. In “creatList”, the function we use is described as follow.<br>'''&nbsp;&nbsp; Name:''' setPlayMode(unsigned char playmode); <br>'''&nbsp;&nbsp; Function:''' Set the play mode. There are four modes you can set: MODE_NORMAL、 MODE_SHUFFLE、 MODE_REPEAT_LIST、 MODE_REPEAT_ONE. Each mode stands for different playing orders. 

<br>[[Image:Play Mode.jpg]]<br>

3. Select the type of Arduino board that you are using by the path: Tools --&gt; Board --&gt; for example Arduino UNO.<br>4. Select the correct serial port you are using by the path: Tools --&gt; Serial Port --&gt; for example COM3.<br>5. Upload the code. Click to Serial Monitor when “Done uploading” appears, you will find the order of songs is randomized on the list.<br><br>[[Image:Play List.jpg]]<br>When press multifunction button to up or down, the volume will change. Of course, you can try others play modes.<br>.<br>'''Demo 2: Play selected songs <br>'''1. This demo will show you how to play part of the songs from all songs in the SD card. Open the “addToList” example via the path: File --&gt; Examples --&gt; MusicPlayer --&gt; addToList.<br>[[Image:Select play.jpg]] <br>

2.Select songs from the playlist.You just need to list songs you want to play by name correctly in the function addToPlayList(char *songName) .<br>But you must ensure that the song has been stored in the SD card and the format of those songs must be one of MP3,WMA,WAV,AAC,MIDI,Ogg Vorbis.<br>3.Upload code. When you complete the upload,new add songs will be played. 

'''Demo 3: Control Volume by analog port<br>'''1．Plug the Grove-Base Shield onto the Music shield, Connect the Grove socket of the Rotary and anolog port 4 of the Base Shield with a Grove cable. You can change to<br>the digital port as well. But don't forget to change the port number in the definition of the demo code at the same time. <br>[[Image:Music shield 5.jpg]]<br>2. Open the “analogInputControl” example and upload it onto your Arduino Board.<br>3. Rotate the knob to change music volume. 

'''Demo 4: Record music:(Only support ATmega1280 and ATmega2560 based board)''' 

1. Download [http://www.seeedstudio.com/wiki/File:MusicShieldRecord.zip File:Music Shield Record&nbsp;library;]<br>2. Unzip and copy the folder to Arduino’s library path: ..\arduino-1.0\libraries; <br>3.Open the library and upload the code to Mega.<br>4. Press down the multifunction button before pressing down the RESET button ofArduino.<br>5. Release the RESET button for a second and then release the multifunction button. At this point the music shield is beginning to record, the green indicator LED will blink.<br>6. Pressing down the multifunction button again will stop recording.<br>6. Record will be played in the last place. 




==='''Using MIDI,no need to modify the hardware'''===

The VS1058X's real time MIDI mode:

The "real time MIDI mode",in which it will instantly execute MIDI commands send to it through either SPI or UART,can be enabled with the method below:

Method:
       At the beginning,send a small software patch through SPI port.
    
    /*software patch for MIDI Play*/
    const unsigned short gVS1053_MIDI_Patch[28]={
    /*if you don't let GPIO1 = H,please send this patch by spi*/
    0x0007, 0x0001, 0x8050, 0x0006, 0x0014, 0x0030, 0x0715, 0xb080, /* 0 */
    0x3400, 0x0007, 0x9255, 0x3d00, 0x0024, 0x0030, 0x0295, 0x6890, /* 8 */
    0x3400, 0x0030, 0x0495, 0x3d00, 0x0024, 0x2908, 0x4d40, 0x0030, /* 10 */
    0x0200, 0x000a, 0x0001, 0x0050,
    };
    using that function to load:
    /*
    **@ function name: loadMidiPatch
    **@ usage:load a software patch for vs10xx
    **@ input:none
    **@ retval:none
    */
    void VS10XX::loadMidiPlugin(void)
    {
      int i=0;
      Serial.print("load MIDI Plugin...\r\n");
      while(i < sizeof(gVS1053_MIDI_Patch)/sizeof(gVS1053_MIDI_Patch[0]))
      {
        unsigned short addr, n, val;
        addr = gVS1053_MIDI_Patch[i++];
        n = gVS1053_MIDI_Patch[i++];
        while(n--)
        {
          val = gVS1053_MIDI_Patch[i++];
          writeRegister(addr, val >> 8, val&0xff);
        }
      }
      Serial.print("done\r\n");
    }
    I would like to tell you that there is an open source library called jdksmidi,by which you can make your own MIDI decoder through some small changes.
    jdksmidi git-hub page:https://github.com/jdkoftinoff/jdksmidi
    we offer you some real time mode MIDI APIs(MusicPlayer.cpp):
    midiNoteOn()
    midiNoteOff()
    midiWriteData()
   
    Now,it's time to build your real-time MIDI instrument/music player in any format(single-channel or multi-channel).
    Your contribution is appreciated.
    A demo MIDI player was add to the latest library.
    MIDI Demo(upload the code. When completed, you will hear Fancy MIDI music):
[[File:Music shield midi demo.jpeg]]
<br>

<br>

== Resources  ==

<br>[[File:Music_Shield_Schematic.pdf]]<br>
<br>[[File:VS1053.pdf]]<br>
<br>[[File:Music_Shield-musicshield_lib_for_hw_v2.zip]]<br>

<br>

'''MIDI number to note reference list:'''

<br>[[Image:MIDIlist.jpg]]


==HOW TO BUY IT==
click here: http://www.geeetech.com/arduino-mp3-music-shield-v20-vc1053b-p-799.html