/apidocs/echonest.support.midi.MidiFileParser.MidiFileParser-class.html

http://echo-nest-remix.googlecode.com/ · HTML · 240 lines · 199 code · 20 blank · 21 comment · 0 complexity · fdd7139c054c9f00a7cd0ddceac4cbd4 MD5 · raw file 

    

  1. <?xml version="1.0" encoding="ascii"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.           "DTD/xhtml1-transitional.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.   <title>echonest.support.midi.MidiFileParser.MidiFileParser</title>
    7. 

  7.   <link rel="stylesheet" href="epydoc.css" type="text/css" />
    8. 

  8.   <script type="text/javascript" src="epydoc.js"></script>
    9. 

  9. </head>
    10. 

  10. 

  11. <body bgcolor="white" text="black" link="blue" vlink="#204080"
    12. 

  12.       alink="#204080">
    13. 

  13. <!-- ==================== NAVIGATION BAR ==================== -->
    14. 

  14. <table class="navbar" border="0" width="100%" cellpadding="0"
    15. 

  15.        bgcolor="#a0c0ff" cellspacing="0">
    16. 

  16.   <tr valign="middle">
    17. 

  17. 

  18.   <!-- Tree link -->
    19. 

  19.       <th>&nbsp;&nbsp;&nbsp;<a
    20. 

  20.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    21. 

  21. 

  22.   <!-- Index link -->
    23. 

  23.       <th>&nbsp;&nbsp;&nbsp;<a
    24. 

  24.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    25. 

  25. 

  26.   <!-- Help link -->
    27. 

  27.       <th>&nbsp;&nbsp;&nbsp;<a
    28. 

  28.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    29. 

  29. 

  30.   <!-- Project homepage -->
    31. 

  31.       <th class="navbar" align="right" width="100%">
    32. 

  32.         <table border="0" cellpadding="0" cellspacing="0">
    33. 

  33.           <tr><th class="navbar" align="center"
    34. 

  34.             ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
    35. 

  35.           </tr></table></th>
    36. 

  36.   </tr>
    37. 

  37. </table>
    38. 

  38. <table width="100%" cellpadding="0" cellspacing="0">
    39. 

  39.   <tr valign="top">
    40. 

  40.     <td width="100%">
    41. 

  41.       <span class="breadcrumbs">
    42. 

  42.         <a href="echonest-module.html">Package&nbsp;echonest</a> ::
    43. 

  43.         <a href="echonest.support-module.html">Package&nbsp;support</a> ::
    44. 

  44.         <a href="echonest.support.midi-module.html">Package&nbsp;midi</a> ::
    45. 

  45.         <a href="echonest.support.midi.MidiFileParser-module.html">Module&nbsp;MidiFileParser</a> ::
    46. 

  46.         Class&nbsp;MidiFileParser
    47. 

  47.       </span>
    48. 

  48.     </td>
    49. 

  49.     <td>
    50. 

  50.       <table cellpadding="0" cellspacing="0">
    51. 

  51.         <!-- hide/show private -->
    52. 

  52.         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    53. 

  53.     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
    54. 

  54.         <tr><td align="right"><span class="options"
    55. 

  55.             >[<a href="frames.html" target="_top">frames</a
    56. 

  56.             >]&nbsp;|&nbsp;<a href="echonest.support.midi.MidiFileParser.MidiFileParser-class.html"
    57. 

  57.             target="_top">no&nbsp;frames</a>]</span></td></tr>
    58. 

  58.       </table>
    59. 

  59.     </td>
    60. 

  60.   </tr>
    61. 

  61. </table>
    62. 

  62. <!-- ==================== CLASS DESCRIPTION ==================== -->
    63. 

  63. <h1 class="epydoc">Class MidiFileParser</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.support.midi.MidiFileParser-pysrc.html#MidiFileParser">source&nbsp;code</a></span></p>
    64. 

  64. The MidiFileParser is the lowest level parser that see the data as
    65. 

  65. midi data. It generates events that gets triggered on the outstream.
    66. 

  66. 

  67. <!-- ==================== INSTANCE METHODS ==================== -->
    68. 

  68. <a name="section-InstanceMethods"></a>
    69. 

  69. <table class="summary" border="1" cellpadding="3"
    70. 

  70.        cellspacing="0" width="100%" bgcolor="white">
    71. 

  71. <tr bgcolor="#70b0f0" class="table-header">
    72. 

  72.   <td colspan="2" class="table-header">
    73. 

  73.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    74. 

  74.       <tr valign="top">
    75. 

  75.         <td align="left"><span class="table-header">Instance Methods</span></td>
    76. 

  76.         <td align="right" valign="top"
    77. 

  77.          ><span class="options">[<a href="#section-InstanceMethods"
    78. 

  78.          class="privatelink" onclick="toggle_private();"
    79. 

  79.          >hide private</a>]</span></td>
    80. 

  80.       </tr>
    81. 

  81.     </table>
    82. 

  82.   </td>
    83. 

  83. </tr>
    84. 

  84. <tr>
    85. 

  85.     <td width="15%" align="right" valign="top" class="summary">
    86. 

  86.       <span class="summary-type">&nbsp;</span>
    87. 

  87.     </td><td class="summary">
    88. 

  88.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    89. 

  89.         <tr>
    90. 

  90.           <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
    91. 

  91.         <span class="summary-sig-arg">raw_in</span>,
    92. 

  92.         <span class="summary-sig-arg">outstream</span>)</span><br />
    93. 

  93.       raw_data is the raw content of a midi file as a string.</td>
    94. 

  94.           <td align="right" valign="top">
    95. 

  95.             <span class="codelink"><a href="echonest.support.midi.MidiFileParser-pysrc.html#MidiFileParser.__init__">source&nbsp;code</a></span>
    96. 

  96.             
    97. 

  97.           </td>
    98. 

  98.         </tr>
    99. 

  99.       </table>
    100. 

  100.       
    101. 

  101.     </td>
    102. 

  102.   </tr>
    103. 

  103. <tr>
    104. 

  104.     <td width="15%" align="right" valign="top" class="summary">
    105. 

  105.       <span class="summary-type">&nbsp;</span>
    106. 

  106.     </td><td class="summary">
    107. 

  107.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    108. 

  108.         <tr>
    109. 

  109.           <td><span class="summary-sig"><a name="parseMThdChunk"></a><span class="summary-sig-name">parseMThdChunk</span>(<span class="summary-sig-arg">self</span>)</span><br />
    110. 

  110.       Parses the header chunk</td>
    111. 

  111.           <td align="right" valign="top">
    112. 

  112.             <span class="codelink"><a href="echonest.support.midi.MidiFileParser-pysrc.html#MidiFileParser.parseMThdChunk">source&nbsp;code</a></span>
    113. 

  113.             
    114. 

  114.           </td>
    115. 

  115.         </tr>
    116. 

  116.       </table>
    117. 

  117.       
    118. 

  118.     </td>
    119. 

  119.   </tr>
    120. 

  120. <tr>
    121. 

  121.     <td width="15%" align="right" valign="top" class="summary">
    122. 

  122.       <span class="summary-type">&nbsp;</span>
    123. 

  123.     </td><td class="summary">
    124. 

  124.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    125. 

  125.         <tr>
    126. 

  126.           <td><span class="summary-sig"><a href="echonest.support.midi.MidiFileParser.MidiFileParser-class.html#parseMTrkChunk" class="summary-sig-name">parseMTrkChunk</a>(<span class="summary-sig-arg">self</span>)</span><br />
    127. 

  127.       Parses a track chunk.</td>
    128. 

  128.           <td align="right" valign="top">
    129. 

  129.             <span class="codelink"><a href="echonest.support.midi.MidiFileParser-pysrc.html#MidiFileParser.parseMTrkChunk">source&nbsp;code</a></span>
    130. 

  130.             
    131. 

  131.           </td>
    132. 

  132.         </tr>
    133. 

  133.       </table>
    134. 

  134.       
    135. 

  135.     </td>
    136. 

  136.   </tr>
    137. 

  137. <tr>
    138. 

  138.     <td width="15%" align="right" valign="top" class="summary">
    139. 

  139.       <span class="summary-type">&nbsp;</span>
    140. 

  140.     </td><td class="summary">
    141. 

  141.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    142. 

  142.         <tr>
    143. 

  143.           <td><span class="summary-sig"><a name="parseMTrkChunks"></a><span class="summary-sig-name">parseMTrkChunks</span>(<span class="summary-sig-arg">self</span>)</span><br />
    144. 

  144.       Parses all track chunks.</td>
    145. 

  145.           <td align="right" valign="top">
    146. 

  146.             <span class="codelink"><a href="echonest.support.midi.MidiFileParser-pysrc.html#MidiFileParser.parseMTrkChunks">source&nbsp;code</a></span>
    147. 

  147.             
    148. 

  148.           </td>
    149. 

  149.         </tr>
    150. 

  150.       </table>
    151. 

  151.       
    152. 

  152.     </td>
    153. 

  153.   </tr>
    154. 

  154. </table>
    155. 

  155. <!-- ==================== METHOD DETAILS ==================== -->
    156. 

  156. <a name="section-MethodDetails"></a>
    157. 

  157. <table class="details" border="1" cellpadding="3"
    158. 

  158.        cellspacing="0" width="100%" bgcolor="white">
    159. 

  159. <tr bgcolor="#70b0f0" class="table-header">
    160. 

  160.   <td colspan="2" class="table-header">
    161. 

  161.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    162. 

  162.       <tr valign="top">
    163. 

  163.         <td align="left"><span class="table-header">Method Details</span></td>
    164. 

  164.         <td align="right" valign="top"
    165. 

  165.          ><span class="options">[<a href="#section-MethodDetails"
    166. 

  166.          class="privatelink" onclick="toggle_private();"
    167. 

  167.          >hide private</a>]</span></td>
    168. 

  168.       </tr>
    169. 

  169.     </table>
    170. 

  170.   </td>
    171. 

  171. </tr>
    172. 

  172. </table>
    173. 

  173. <a name="parseMTrkChunk"></a>
    174. 

  174. <div>
    175. 

  175. <table class="details" border="1" cellpadding="3"
    176. 

  176.        cellspacing="0" width="100%" bgcolor="white">
    177. 

  177. <tr><td>
    178. 

  178.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    179. 

  179.   <tr valign="top"><td>
    180. 

  180.   <h3 class="epydoc"><span class="sig"><span class="sig-name">parseMTrkChunk</span>(<span class="sig-arg">self</span>)</span>
    181. 

  181.   </h3>
    182. 

  182.   </td><td align="right" valign="top"
    183. 

  183.     ><span class="codelink"><a href="echonest.support.midi.MidiFileParser-pysrc.html#MidiFileParser.parseMTrkChunk">source&nbsp;code</a></span>&nbsp;
    184. 

  184.     </td>
    185. 

  185.   </tr></table>
    186. 

  186.   
    187. 

  187.   Parses a track chunk. This is the most important part of the parser.
    188. 

  188.   <dl class="fields">
    189. 

  189.   </dl>
    190. 

  190. </td></tr></table>
    191. 

  191. </div>
    192. 

  192. <br />
    193. 

  193. <!-- ==================== NAVIGATION BAR ==================== -->
    194. 

  194. <table class="navbar" border="0" width="100%" cellpadding="0"
    195. 

  195.        bgcolor="#a0c0ff" cellspacing="0">
    196. 

  196.   <tr valign="middle">
    197. 

  197. 

  198.   <!-- Tree link -->
    199. 

  199.       <th>&nbsp;&nbsp;&nbsp;<a
    200. 

  200.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    201. 

  201. 

  202.   <!-- Index link -->
    203. 

  203.       <th>&nbsp;&nbsp;&nbsp;<a
    204. 

  204.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    205. 

  205. 

  206.   <!-- Help link -->
    207. 

  207.       <th>&nbsp;&nbsp;&nbsp;<a
    208. 

  208.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    209. 

  209. 

  210.   <!-- Project homepage -->
    211. 

  211.       <th class="navbar" align="right" width="100%">
    212. 

  212.         <table border="0" cellpadding="0" cellspacing="0">
    213. 

  213.           <tr><th class="navbar" align="center"
    214. 

  214.             ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
    215. 

  215.           </tr></table></th>
    216. 

  216.   </tr>
    217. 

  217. </table>
    218. 

  218. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    219. 

  219.   <tr>
    220. 

  220.     <td align="left" class="footer">
    221. 

  221.     Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:58 2010
    222. 

  222.     </td>
    223. 

  223.     <td align="right" class="footer">
    224. 

  224.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    225. 

  225.         >http://epydoc.sourceforge.net</a>
    226. 

  226.     </td>
    227. 

  227.   </tr>
    228. 

  228. </table>
    229. 

  229. 

  230. <script type="text/javascript">
    231. 

  231.   <!--
    232. 

  232.   // Private objects are initially displayed (because if
    233. 

  233.   // javascript is turned off then we want them to be
    234. 

  234.   // visible); but by default, we want to hide them.  So hide
    235. 

  235.   // them unless we have a cookie that says to show them.
    236. 

  236.   checkCookie();
    237. 

  237.   // -->
    238. 

  238. </script>
    239. 

  239. </body>
    240. 

  240. </html>
    241.