/src/echonest/support/midi/readme.txt

http://echo-nest-remix.googlecode.com/ · Plain Text · 50 lines · 23 code · 27 blank · 0 comment · 0 complexity · acb646d148e642fbf5883fc5e45cb312 MD5 · raw file 

    

  1. This is the documentation for the midi package

    2. 

  2. ==============================================

    3. 

  3. 

    4. 

  4. 

    5. 

  5. The modules follows the following naming convention:

    6. 

  6. 

    7. 

  7. 

    8. 

  8. MidiIn<StreamType>.py

    9. 

  9. ---------------------

    10. 

  10. 

    11. 

  11. The MidiIn modules reads midi content for a specific type of stream. Ie. a file or a midi port. It then generates events and triggers them on a MidiOutStream.

    12. 

  12. 

    13. 

  13. 

    14. 

  14. MidiOut<StreamType>.py

    15. 

  15. ----------------------

    16. 

  16. 

    17. 

  17. The MidiOut modules are event handlers, that reacts to events generated by a a Midi in module.

    18. 

  18. 

    19. 

  19. 

    20. 

  20. MidiInBase.py

    21. 

  21. ---------------

    22. 

  22. 

    23. 

  23. The base class for input streams.

    24. 

  24. 

    25. 

  25. 

    26. 

  26. MidiOutBase.py

    27. 

  27. ----------------

    28. 

  28. 

    29. 

  29. The base class for the output streams.

    30. 

  30. 

    31. 

  31. 

    32. 

  32. 

    33. 

  33. 

    34. 

  34. 

    35. 

  35. 

    36. 

  36. Internal modules

    37. 

  37. ================

    38. 

  38. 

    39. 

  39. 

    40. 

  40. DataTypeConverters.py

    41. 

  41. ---------------------

    42. 

  42. 

    43. 

  43. A collection of functions that converts the special data types used in midi files to and from strings.

    44. 

  44. 

    45. 

  45. 

    46. 

  46. constants.py

    47. 

  47. ------------

    48. 

  48. 

    49. 

  49. A collection of constants from the midi spec.
    50.