/apidocs/echonest.support.midi-pysrc.html

http://echo-nest-remix.googlecode.com/ · HTML · 173 lines · 142 code · 10 blank · 21 comment · 0 complexity · 9148a87fbb7d4334d05be69570838ce0 MD5 · raw file

  1. <?xml version="1.0" encoding="ascii"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3. "DTD/xhtml1-transitional.dtd">
  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5. <head>
  6. <title>echonest.support.midi</title>
  7. <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8. <script type="text/javascript" src="epydoc.js"></script>
  9. </head>
  10. <body bgcolor="white" text="black" link="blue" vlink="#204080"
  11. alink="#204080">
  12. <!-- ==================== NAVIGATION BAR ==================== -->
  13. <table class="navbar" border="0" width="100%" cellpadding="0"
  14. bgcolor="#a0c0ff" cellspacing="0">
  15. <tr valign="middle">
  16. <!-- Tree link -->
  17. <th>&nbsp;&nbsp;&nbsp;<a
  18. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  19. <!-- Index link -->
  20. <th>&nbsp;&nbsp;&nbsp;<a
  21. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  22. <!-- Help link -->
  23. <th>&nbsp;&nbsp;&nbsp;<a
  24. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  25. <!-- Project homepage -->
  26. <th class="navbar" align="right" width="100%">
  27. <table border="0" cellpadding="0" cellspacing="0">
  28. <tr><th class="navbar" align="center"
  29. ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
  30. </tr></table></th>
  31. </tr>
  32. </table>
  33. <table width="100%" cellpadding="0" cellspacing="0">
  34. <tr valign="top">
  35. <td width="100%">
  36. <span class="breadcrumbs">
  37. <a href="echonest-module.html">Package&nbsp;echonest</a> ::
  38. <a href="echonest.support-module.html">Package&nbsp;support</a> ::
  39. Package&nbsp;midi
  40. </span>
  41. </td>
  42. <td>
  43. <table cellpadding="0" cellspacing="0">
  44. <!-- hide/show private -->
  45. <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  46. onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  47. <tr><td align="right"><span class="options"
  48. >[<a href="frames.html" target="_top">frames</a
  49. >]&nbsp;|&nbsp;<a href="echonest.support.midi-pysrc.html"
  50. target="_top">no&nbsp;frames</a>]</span></td></tr>
  51. </table>
  52. </td>
  53. </tr>
  54. </table>
  55. <h1 class="epydoc">Source Code for <a href="echonest.support.midi-module.html">Package echonest.support.midi</a></h1>
  56. <pre class="py-src">
  57. <a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># -*- coding: ISO-8859-1 -*-</tt> </tt>
  58. <a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-docstring">""" </tt> </tt>
  59. <a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-docstring">This is the documentation for the midi package </tt> </tt>
  60. <a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-docstring">============================================== </tt> </tt>
  61. <a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  62. <a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  63. <a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-docstring">The modules follows the following naming convention: </tt> </tt>
  64. <a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  65. <a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  66. <a name="L10"></a><tt class="py-lineno">10</tt> <tt class="py-line"><tt class="py-docstring">MidiIn&lt;StreamType&gt;.py </tt> </tt>
  67. <a name="L11"></a><tt class="py-lineno">11</tt> <tt class="py-line"><tt class="py-docstring">--------------------- </tt> </tt>
  68. <a name="L12"></a><tt class="py-lineno">12</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  69. <a name="L13"></a><tt class="py-lineno">13</tt> <tt class="py-line"><tt class="py-docstring">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. </tt> </tt>
  70. <a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  71. <a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  72. <a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"><tt class="py-docstring">MidiOut&lt;StreamType&gt;.py </tt> </tt>
  73. <a name="L17"></a><tt class="py-lineno">17</tt> <tt class="py-line"><tt class="py-docstring">---------------------- </tt> </tt>
  74. <a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  75. <a name="L19"></a><tt class="py-lineno">19</tt> <tt class="py-line"><tt class="py-docstring">The MidiOut modules are event handlers, that reacts to events generated by a a Midi in module. </tt> </tt>
  76. <a name="L20"></a><tt class="py-lineno">20</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  77. <a name="L21"></a><tt class="py-lineno">21</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  78. <a name="L22"></a><tt class="py-lineno">22</tt> <tt class="py-line"><tt class="py-docstring">MidiInBase.py </tt> </tt>
  79. <a name="L23"></a><tt class="py-lineno">23</tt> <tt class="py-line"><tt class="py-docstring">--------------- </tt> </tt>
  80. <a name="L24"></a><tt class="py-lineno">24</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  81. <a name="L25"></a><tt class="py-lineno">25</tt> <tt class="py-line"><tt class="py-docstring">The base class for input streams. </tt> </tt>
  82. <a name="L26"></a><tt class="py-lineno">26</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  83. <a name="L27"></a><tt class="py-lineno">27</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  84. <a name="L28"></a><tt class="py-lineno">28</tt> <tt class="py-line"><tt class="py-docstring">MidiOutBase.py </tt> </tt>
  85. <a name="L29"></a><tt class="py-lineno">29</tt> <tt class="py-line"><tt class="py-docstring">---------------- </tt> </tt>
  86. <a name="L30"></a><tt class="py-lineno">30</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  87. <a name="L31"></a><tt class="py-lineno">31</tt> <tt class="py-line"><tt class="py-docstring">The base class for the output streams. </tt> </tt>
  88. <a name="L32"></a><tt class="py-lineno">32</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  89. <a name="L33"></a><tt class="py-lineno">33</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  90. <a name="L34"></a><tt class="py-lineno">34</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  91. <a name="L35"></a><tt class="py-lineno">35</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  92. <a name="L36"></a><tt class="py-lineno">36</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  93. <a name="L37"></a><tt class="py-lineno">37</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  94. <a name="L38"></a><tt class="py-lineno">38</tt> <tt class="py-line"><tt class="py-docstring">Internal modules </tt> </tt>
  95. <a name="L39"></a><tt class="py-lineno">39</tt> <tt class="py-line"><tt class="py-docstring">================ </tt> </tt>
  96. <a name="L40"></a><tt class="py-lineno">40</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  97. <a name="L41"></a><tt class="py-lineno">41</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  98. <a name="L42"></a><tt class="py-lineno">42</tt> <tt class="py-line"><tt class="py-docstring">DataTypeConverters.py </tt> </tt>
  99. <a name="L43"></a><tt class="py-lineno">43</tt> <tt class="py-line"><tt class="py-docstring">--------------------- </tt> </tt>
  100. <a name="L44"></a><tt class="py-lineno">44</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  101. <a name="L45"></a><tt class="py-lineno">45</tt> <tt class="py-line"><tt class="py-docstring">A collection of functions that converts the special data types used in midi files to and from strings. </tt> </tt>
  102. <a name="L46"></a><tt class="py-lineno">46</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  103. <a name="L47"></a><tt class="py-lineno">47</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  104. <a name="L48"></a><tt class="py-lineno">48</tt> <tt class="py-line"><tt class="py-docstring">constants.py </tt> </tt>
  105. <a name="L49"></a><tt class="py-lineno">49</tt> <tt class="py-line"><tt class="py-docstring">------------ </tt> </tt>
  106. <a name="L50"></a><tt class="py-lineno">50</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  107. <a name="L51"></a><tt class="py-lineno">51</tt> <tt class="py-line"><tt class="py-docstring">A collection of constants from the midi spec. </tt> </tt>
  108. <a name="L52"></a><tt class="py-lineno">52</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  109. <a name="L53"></a><tt class="py-lineno">53</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
  110. <a name="L54"></a><tt class="py-lineno">54</tt> <tt class="py-line"><tt class="py-comment">#import MidiOutStream</tt> </tt>
  111. <a name="L55"></a><tt class="py-lineno">55</tt> <tt class="py-line"><tt class="py-comment">#import MidiInStream</tt> </tt>
  112. <a name="L56"></a><tt class="py-lineno">56</tt> <tt class="py-line"><tt class="py-comment">#import MidiInFile</tt> </tt>
  113. <a name="L57"></a><tt class="py-lineno">57</tt> <tt class="py-line"><tt class="py-comment">#import MidiToText</tt> </tt>
  114. <a name="L58"></a><tt class="py-lineno">58</tt> <tt class="py-line"> </tt><script type="text/javascript">
  115. <!--
  116. expandto(location.href);
  117. // -->
  118. </script>
  119. </pre>
  120. <br />
  121. <!-- ==================== NAVIGATION BAR ==================== -->
  122. <table class="navbar" border="0" width="100%" cellpadding="0"
  123. bgcolor="#a0c0ff" cellspacing="0">
  124. <tr valign="middle">
  125. <!-- Tree link -->
  126. <th>&nbsp;&nbsp;&nbsp;<a
  127. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  128. <!-- Index link -->
  129. <th>&nbsp;&nbsp;&nbsp;<a
  130. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  131. <!-- Help link -->
  132. <th>&nbsp;&nbsp;&nbsp;<a
  133. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  134. <!-- Project homepage -->
  135. <th class="navbar" align="right" width="100%">
  136. <table border="0" cellpadding="0" cellspacing="0">
  137. <tr><th class="navbar" align="center"
  138. ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
  139. </tr></table></th>
  140. </tr>
  141. </table>
  142. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  143. <tr>
  144. <td align="left" class="footer">
  145. Generated by Epydoc 3.0.1 on Wed Sep 1 16:09:00 2010
  146. </td>
  147. <td align="right" class="footer">
  148. <a target="mainFrame" href="http://epydoc.sourceforge.net"
  149. >http://epydoc.sourceforge.net</a>
  150. </td>
  151. </tr>
  152. </table>
  153. <script type="text/javascript">
  154. <!--
  155. // Private objects are initially displayed (because if
  156. // javascript is turned off then we want them to be
  157. // visible); but by default, we want to hide them. So hide
  158. // them unless we have a cookie that says to show them.
  159. checkCookie();
  160. // -->
  161. </script>
  162. </body>
  163. </html>