Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.57 KB

SOURCE_CODE_README.md

File metadata and controls

34 lines (27 loc) · 1.57 KB

Source Code README

Readme for Groove Scribe Source Code

Structure

  • Groove Scribe runs entirely in the browser with no back end calls
  • The main application is referred to as "Groove Writer" in the source code and includes the authoring view.
  • A secondary application is referred to as "Groove Display" in the source code and includes the sheet music generator and the midi player.

Groove Writer

  • Includes all the authoring code with the ability to click on a grid of html icons that will in turn generate music
  • Calls Groove Display functions to generate sheet music and midi play back
  • Puts an HTML grid on the screen that represents all the possible notes for a given division
  • Uses the grid to generate an array of notes that can be turned into music via the Groove Display functions
  • HTML
    • index.html -- main authoring view
  • Javascript files
    • groove_writer.js -- the authoring code. Makes calls to groove_utils.js to display

Groove Display

  • Just the playback portion of the code, can run separate from the authoring view for embeding in other applications.
  • Turns an array of notes into ABC notation code
  • SVG sheet music generation utilizing the abc2svg library
  • Midi file generation
  • Midi playback control
  • HTML
    • GrooveEmbed.html -- a simple test of embeding a single groove
    • GrooveMultiDisplay.html -- a multi test of embeding
  • Javascript files
    • groove_display.js -- includes a function call to embed the groove display in an HTML page
    • groove_utils.js -- all the functions to display grooves and play them.