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

http://echo-nest-remix.googlecode.com/ · HTML · 177 lines · 146 code · 10 blank · 21 comment · 0 complexity · 4a6b50a181af839a9e3284580569ba19 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.MidiInFile</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.         Module&nbsp;MidiInFile
    46. 

  46.       </span>
    47. 

  47.     </td>
    48. 

  48.     <td>
    49. 

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

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

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

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

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

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

  55.             >]&nbsp;|&nbsp;<a href="echonest.support.midi.MidiInFile-pysrc.html"
    56. 

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

  57.       </table>
    58. 

  58.     </td>
    59. 

  59.   </tr>
    60. 

  60. </table>
    61. 

  61. <h1 class="epydoc">Source Code for <a href="echonest.support.midi.MidiInFile-module.html">Module echonest.support.midi.MidiInFile</a></h1>
    62. 

  62. <pre class="py-src">
    63. 

  63. <a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-comment"># -*- coding: ISO-8859-1 -*-</tt>
 </tt>
    64. 

  64. <a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line">
 </tt>
    65. 

  65. <a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Module echonest.support.midi.RawInstreamFile=echonest.support.midi.RawInstreamFile-module.html,Class echonest.support.midi.RawInstreamFile.RawInstreamFile=echonest.support.midi.RawInstreamFile.RawInstreamFile-class.html"><a title="echonest.support.midi.RawInstreamFile
    66. 

  66. echonest.support.midi.RawInstreamFile.RawInstreamFile" class="py-name" href="#" onclick="return doclink('link-0', 'RawInstreamFile', 'link-0');">RawInstreamFile</a></tt> <tt class="py-keyword">import</tt> <tt id="link-1" class="py-name"><a title="echonest.support.midi.RawInstreamFile
    67. 

  67. echonest.support.midi.RawInstreamFile.RawInstreamFile" class="py-name" href="#" onclick="return doclink('link-1', 'RawInstreamFile', 'link-0');">RawInstreamFile</a></tt> </tt>

    68. 

  68. <a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-2" class="py-name" targets="Module echonest.support.midi.MidiFileParser=echonest.support.midi.MidiFileParser-module.html,Class echonest.support.midi.MidiFileParser.MidiFileParser=echonest.support.midi.MidiFileParser.MidiFileParser-class.html"><a title="echonest.support.midi.MidiFileParser
    69. 

  69. echonest.support.midi.MidiFileParser.MidiFileParser" class="py-name" href="#" onclick="return doclink('link-2', 'MidiFileParser', 'link-2');">MidiFileParser</a></tt> <tt class="py-keyword">import</tt> <tt id="link-3" class="py-name"><a title="echonest.support.midi.MidiFileParser
    70. 

  70. echonest.support.midi.MidiFileParser.MidiFileParser" class="py-name" href="#" onclick="return doclink('link-3', 'MidiFileParser', 'link-2');">MidiFileParser</a></tt> </tt>

    71. 

  71. <a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line">
 </tt>
    72. 

  72. <a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line">
 </tt>
    73. 

  73. <a name="MidiInFile"></a><div id="MidiInFile-def"><a name="L7"></a><tt class="py-lineno"> 7</tt> <a class="py-toggle" href="#" id="MidiInFile-toggle" onclick="return toggle('MidiInFile');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="echonest.support.midi.MidiInFile.MidiInFile-class.html">MidiInFile</a><tt class="py-op">:</tt> </tt>

    74. 

  74. </div><div id="MidiInFile-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="MidiInFile-expanded"><a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line">
 </tt>
    75. 

  75. <a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line">    <tt class="py-docstring">"""
</tt> </tt>
    76. 

  76. <a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line"><tt class="py-docstring">    
</tt> </tt>
    77. 

  77. <a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"><tt class="py-docstring">    Parses a midi file, and triggers the midi events on the outStream 
</tt> </tt>
    78. 

  78. <a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"><tt class="py-docstring">    object.
</tt> </tt>
    79. 

  79. <a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line"><tt class="py-docstring">    
</tt> </tt>
    80. 

  80. <a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line"><tt class="py-docstring">    Get example data from a minimal midi file, generated with cubase.
</tt> </tt>
    81. 

  81. <a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; test_file = 'C:/Documents and Settings/maxm/Desktop/temp/midi/src/midi/tests/midifiles/minimal-cubase-type0.mid'
</tt> </tt>
    82. 

  82. <a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-docstring">    
</tt> </tt>
    83. 

  83. <a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line"><tt class="py-docstring">    Do parsing, and generate events with MidiToText,
</tt> </tt>
    84. 

  84. <a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line"><tt class="py-docstring">    so we can see what a minimal midi file contains
</tt> </tt>
    85. 

  85. <a name="L19"></a><tt class="py-lineno">19</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; from MidiToText import MidiToText
</tt> </tt>
    86. 

  86. <a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; midi_in = MidiInFile(MidiToText(), test_file)
</tt> </tt>
    87. 

  87. <a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; midi_in.read()
</tt> </tt>
    88. 

  88. <a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line"><tt class="py-docstring">    format: 0, nTracks: 1, division: 480
</tt> </tt>
    89. 

  89. <a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line"><tt class="py-docstring">    ----------------------------------
</tt> </tt>
    90. 

  90. <a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line"><tt class="py-docstring">    &lt;BLANKLINE&gt;
</tt> </tt>
    91. 

  91. <a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line"><tt class="py-docstring">    Start - track #0
</tt> </tt>
    92. 

  92. <a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line"><tt class="py-docstring">    sequence_name: Type 0
</tt> </tt>
    93. 

  93. <a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line"><tt class="py-docstring">    tempo: 500000
</tt> </tt>
    94. 

  94. <a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line"><tt class="py-docstring">    time_signature: 4 2 24 8
</tt> </tt>
    95. 

  95. <a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line"><tt class="py-docstring">    note_on  - ch:00,  note:48,  vel:64 time:0
</tt> </tt>
    96. 

  96. <a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line"><tt class="py-docstring">    note_off - ch:00,  note:48,  vel:40 time:480
</tt> </tt>
    97. 

  97. <a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line"><tt class="py-docstring">    End of track
</tt> </tt>
    98. 

  98. <a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line"><tt class="py-docstring">    &lt;BLANKLINE&gt;
</tt> </tt>
    99. 

  99. <a name="L33"></a><tt class="py-lineno">33</tt>  <tt class="py-line"><tt class="py-docstring">    End of file
</tt> </tt>
    100. 

  100. <a name="L34"></a><tt class="py-lineno">34</tt>  <tt class="py-line"><tt class="py-docstring">    
</tt> </tt>
    101. 

  101. <a name="L35"></a><tt class="py-lineno">35</tt>  <tt class="py-line"><tt class="py-docstring">    
</tt> </tt>
    102. 

  102. <a name="L36"></a><tt class="py-lineno">36</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>

    103. 

  103. <a name="L37"></a><tt class="py-lineno">37</tt>  <tt class="py-line">
 </tt>
    104. 

  104. <a name="MidiInFile.__init__"></a><div id="MidiInFile.__init__-def"><a name="L38"></a><tt class="py-lineno">38</tt> <a class="py-toggle" href="#" id="MidiInFile.__init__-toggle" onclick="return toggle('MidiInFile.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="echonest.support.midi.MidiInFile.MidiInFile-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">outStream</tt><tt class="py-op">,</tt> <tt class="py-param">infile</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

    105. 

  105. </div><div id="MidiInFile.__init__-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="MidiInFile.__init__-expanded"><a name="L39"></a><tt class="py-lineno">39</tt>  <tt class="py-line">        <tt class="py-comment"># these could also have been mixins, would that be better? Nah!</tt>
 </tt>
    106. 

  106. <a name="L40"></a><tt class="py-lineno">40</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">raw_in</tt> <tt class="py-op">=</tt> <tt id="link-4" class="py-name"><a title="echonest.support.midi.RawInstreamFile
    107. 

  107. echonest.support.midi.RawInstreamFile.RawInstreamFile" class="py-name" href="#" onclick="return doclink('link-4', 'RawInstreamFile', 'link-0');">RawInstreamFile</a></tt><tt class="py-op">(</tt><tt class="py-name">infile</tt><tt class="py-op">)</tt> </tt>

    108. 

  108. <a name="L41"></a><tt class="py-lineno">41</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parser</tt> <tt class="py-op">=</tt> <tt id="link-5" class="py-name"><a title="echonest.support.midi.MidiFileParser
    109. 

  109. echonest.support.midi.MidiFileParser.MidiFileParser" class="py-name" href="#" onclick="return doclink('link-5', 'MidiFileParser', 'link-2');">MidiFileParser</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">raw_in</tt><tt class="py-op">,</tt> <tt class="py-name">outStream</tt><tt class="py-op">)</tt> </tt>

    110. 

  110. </div><a name="L42"></a><tt class="py-lineno">42</tt>  <tt class="py-line">
 </tt>
    111. 

  111. <a name="L43"></a><tt class="py-lineno">43</tt>  <tt class="py-line">
 </tt>
    112. 

  112. <a name="MidiInFile.read"></a><div id="MidiInFile.read-def"><a name="L44"></a><tt class="py-lineno">44</tt> <a class="py-toggle" href="#" id="MidiInFile.read-toggle" onclick="return toggle('MidiInFile.read');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="echonest.support.midi.MidiInFile.MidiInFile-class.html#read">read</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

    113. 

  113. </div><div id="MidiInFile.read-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="MidiInFile.read-expanded"><a name="L45"></a><tt class="py-lineno">45</tt>  <tt class="py-line">        <tt class="py-docstring">"Start parsing the file"</tt> </tt>

    114. 

  114. <a name="L46"></a><tt class="py-lineno">46</tt>  <tt class="py-line">        <tt class="py-name">p</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">parser</tt> </tt>

    115. 

  115. <a name="L47"></a><tt class="py-lineno">47</tt>  <tt class="py-line">        <tt class="py-name">p</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Method echonest.support.midi.MidiFileParser.MidiFileParser.parseMThdChunk()=echonest.support.midi.MidiFileParser.MidiFileParser-class.html#parseMThdChunk"><a title="echonest.support.midi.MidiFileParser.MidiFileParser.parseMThdChunk" class="py-name" href="#" onclick="return doclink('link-6', 'parseMThdChunk', 'link-6');">parseMThdChunk</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>

    116. 

  116. <a name="L48"></a><tt class="py-lineno">48</tt>  <tt class="py-line">        <tt class="py-name">p</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method echonest.support.midi.MidiFileParser.MidiFileParser.parseMTrkChunks()=echonest.support.midi.MidiFileParser.MidiFileParser-class.html#parseMTrkChunks"><a title="echonest.support.midi.MidiFileParser.MidiFileParser.parseMTrkChunks" class="py-name" href="#" onclick="return doclink('link-7', 'parseMTrkChunks', 'link-7');">parseMTrkChunks</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>

    117. 

  117. </div><a name="L49"></a><tt class="py-lineno">49</tt>  <tt class="py-line">
 </tt>
    118. 

  118. <a name="L50"></a><tt class="py-lineno">50</tt>  <tt class="py-line">
 </tt>
    119. 

  119. <a name="MidiInFile.setData"></a><div id="MidiInFile.setData-def"><a name="L51"></a><tt class="py-lineno">51</tt> <a class="py-toggle" href="#" id="MidiInFile.setData-toggle" onclick="return toggle('MidiInFile.setData');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="echonest.support.midi.MidiInFile.MidiInFile-class.html#setData">setData</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">data</tt><tt class="py-op">=</tt><tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

    120. 

  120. </div><div id="MidiInFile.setData-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="MidiInFile.setData-expanded"><a name="L52"></a><tt class="py-lineno">52</tt>  <tt class="py-line">        <tt class="py-docstring">"Sets the data from a plain string"</tt> </tt>

    121. 

  121. <a name="L53"></a><tt class="py-lineno">53</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">raw_in</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Method echonest.support.midi.MidiInFile.MidiInFile.setData()=echonest.support.midi.MidiInFile.MidiInFile-class.html#setData,Method echonest.support.midi.RawInstreamFile.RawInstreamFile.setData()=echonest.support.midi.RawInstreamFile.RawInstreamFile-class.html#setData"><a title="echonest.support.midi.MidiInFile.MidiInFile.setData
    122. 

  122. echonest.support.midi.RawInstreamFile.RawInstreamFile.setData" class="py-name" href="#" onclick="return doclink('link-8', 'setData', 'link-8');">setData</a></tt><tt class="py-op">(</tt><tt class="py-name">data</tt><tt class="py-op">)</tt> </tt>
    123. 

  123. </div></div><a name="L54"></a><tt class="py-lineno">54</tt>  <tt class="py-line"> </tt><script type="text/javascript">
    124. 

  124. <!--
    125. 

  125. expandto(location.href);
    126. 

  126. // -->
    127. 

  127. </script>
    128. 

  128. </pre>
    129. 

  129. <br />
    130. 

  130. <!-- ==================== NAVIGATION BAR ==================== -->
    131. 

  131. <table class="navbar" border="0" width="100%" cellpadding="0"
    132. 

  132.        bgcolor="#a0c0ff" cellspacing="0">
    133. 

  133.   <tr valign="middle">
    134. 

  134. 

  135.   <!-- Tree link -->
    136. 

  136.       <th>&nbsp;&nbsp;&nbsp;<a
    137. 

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

  138. 

  139.   <!-- Index link -->
    140. 

  140.       <th>&nbsp;&nbsp;&nbsp;<a
    141. 

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

  142. 

  143.   <!-- Help link -->
    144. 

  144.       <th>&nbsp;&nbsp;&nbsp;<a
    145. 

  145.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    146. 

  146. 

  147.   <!-- Project homepage -->
    148. 

  148.       <th class="navbar" align="right" width="100%">
    149. 

  149.         <table border="0" cellpadding="0" cellspacing="0">
    150. 

  150.           <tr><th class="navbar" align="center"
    151. 

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

  152.           </tr></table></th>
    153. 

  153.   </tr>
    154. 

  154. </table>
    155. 

  155. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    156. 

  156.   <tr>
    157. 

  157.     <td align="left" class="footer">
    158. 

  158.     Generated by Epydoc 3.0.1 on Wed Sep  1 16:09:00 2010
    159. 

  159.     </td>
    160. 

  160.     <td align="right" class="footer">
    161. 

  161.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    162. 

  162.         >http://epydoc.sourceforge.net</a>
    163. 

  163.     </td>
    164. 

  164.   </tr>
    165. 

  165. </table>
    166. 

  166. 

  167. <script type="text/javascript">
    168. 

  168.   <!--
    169. 

  169.   // Private objects are initially displayed (because if
    170. 

  170.   // javascript is turned off then we want them to be
    171. 

  171.   // visible); but by default, we want to hide them.  So hide
    172. 

  172.   // them unless we have a cookie that says to show them.
    173. 

  173.   checkCookie();
    174. 

  174.   // -->
    175. 

  175. </script>
    176. 

  176. </body>
    177. 

  177. </html>
    178.