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

http://echo-nest-remix.googlecode.com/ · HTML · 365 lines · 314 code · 30 blank · 21 comment · 0 complexity · 3467b45594ac8ac5fe36ef3eb01303f3 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.RawInstreamFile.RawInstreamFile</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.RawInstreamFile-module.html">Module&nbsp;RawInstreamFile</a> ::
    46. 

  46.         Class&nbsp;RawInstreamFile
    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.RawInstreamFile.RawInstreamFile-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 RawInstreamFile</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.support.midi.RawInstreamFile-pysrc.html#RawInstreamFile">source&nbsp;code</a></span></p>
    64. 

  64. It parses and reads data from an input file. It takes care of big
    65. 

  65. endianess, and keeps track of the cursor position. The midi parser
    66. 

  66. only reads from this object. Never directly from the file.
    67. 

  67. 

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

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

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

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

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

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

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

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

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

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

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

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

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

  81.       </tr>
    82. 

  82.     </table>
    83. 

  83.   </td>
    84. 

  84. </tr>
    85. 

  85. <tr>
    86. 

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

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

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

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

  90.         <tr>
    91. 

  91.           <td><span class="summary-sig"><a href="echonest.support.midi.RawInstreamFile.RawInstreamFile-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
    92. 

  92.         <span class="summary-sig-arg">infile</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
    93. 

  93.       If 'file' is a string we assume it is a path and read from
    94. 

  94. that file.</td>
    95. 

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

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

  97.             
    98. 

  98.           </td>
    99. 

  99.         </tr>
    100. 

  100.       </table>
    101. 

  101.       
    102. 

  102.     </td>
    103. 

  103.   </tr>
    104. 

  104. <tr>
    105. 

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

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

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

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

  109.         <tr>
    110. 

  110.           <td><span class="summary-sig"><a name="setData"></a><span class="summary-sig-name">setData</span>(<span class="summary-sig-arg">self</span>,
    111. 

  111.         <span class="summary-sig-arg">data</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
    112. 

  112.       Sets the data from a string.</td>
    113. 

  113.           <td align="right" valign="top">
    114. 

  114.             <span class="codelink"><a href="echonest.support.midi.RawInstreamFile-pysrc.html#RawInstreamFile.setData">source&nbsp;code</a></span>
    115. 

  115.             
    116. 

  116.           </td>
    117. 

  117.         </tr>
    118. 

  118.       </table>
    119. 

  119.       
    120. 

  120.     </td>
    121. 

  121.   </tr>
    122. 

  122. <tr>
    123. 

  123.     <td width="15%" align="right" valign="top" class="summary">
    124. 

  124.       <span class="summary-type">&nbsp;</span>
    125. 

  125.     </td><td class="summary">
    126. 

  126.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    127. 

  127.         <tr>
    128. 

  128.           <td><span class="summary-sig"><a name="setCursor"></a><span class="summary-sig-name">setCursor</span>(<span class="summary-sig-arg">self</span>,
    129. 

  129.         <span class="summary-sig-arg">position</span>=<span class="summary-sig-default">0</span>)</span><br />
    130. 

  130.       Sets the absolute position if the cursor</td>
    131. 

  131.           <td align="right" valign="top">
    132. 

  132.             <span class="codelink"><a href="echonest.support.midi.RawInstreamFile-pysrc.html#RawInstreamFile.setCursor">source&nbsp;code</a></span>
    133. 

  133.             
    134. 

  134.           </td>
    135. 

  135.         </tr>
    136. 

  136.       </table>
    137. 

  137.       
    138. 

  138.     </td>
    139. 

  139.   </tr>
    140. 

  140. <tr>
    141. 

  141.     <td width="15%" align="right" valign="top" class="summary">
    142. 

  142.       <span class="summary-type">&nbsp;</span>
    143. 

  143.     </td><td class="summary">
    144. 

  144.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    145. 

  145.         <tr>
    146. 

  146.           <td><span class="summary-sig"><a name="getCursor"></a><span class="summary-sig-name">getCursor</span>(<span class="summary-sig-arg">self</span>)</span><br />
    147. 

  147.       Returns the value of the cursor</td>
    148. 

  148.           <td align="right" valign="top">
    149. 

  149.             <span class="codelink"><a href="echonest.support.midi.RawInstreamFile-pysrc.html#RawInstreamFile.getCursor">source&nbsp;code</a></span>
    150. 

  150.             
    151. 

  151.           </td>
    152. 

  152.         </tr>
    153. 

  153.       </table>
    154. 

  154.       
    155. 

  155.     </td>
    156. 

  156.   </tr>
    157. 

  157. <tr>
    158. 

  158.     <td width="15%" align="right" valign="top" class="summary">
    159. 

  159.       <span class="summary-type">&nbsp;</span>
    160. 

  160.     </td><td class="summary">
    161. 

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

  162.         <tr>
    163. 

  163.           <td><span class="summary-sig"><a name="moveCursor"></a><span class="summary-sig-name">moveCursor</span>(<span class="summary-sig-arg">self</span>,
    164. 

  164.         <span class="summary-sig-arg">relative_position</span>=<span class="summary-sig-default">0</span>)</span><br />
    165. 

  165.       Moves the cursor to a new relative position</td>
    166. 

  166.           <td align="right" valign="top">
    167. 

  167.             <span class="codelink"><a href="echonest.support.midi.RawInstreamFile-pysrc.html#RawInstreamFile.moveCursor">source&nbsp;code</a></span>
    168. 

  168.             
    169. 

  169.           </td>
    170. 

  170.         </tr>
    171. 

  171.       </table>
    172. 

  172.       
    173. 

  173.     </td>
    174. 

  174.   </tr>
    175. 

  175. <tr>
    176. 

  176.     <td width="15%" align="right" valign="top" class="summary">
    177. 

  177.       <span class="summary-type">&nbsp;</span>
    178. 

  178.     </td><td class="summary">
    179. 

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

  180.         <tr>
    181. 

  181.           <td><span class="summary-sig"><a name="nextSlice"></a><span class="summary-sig-name">nextSlice</span>(<span class="summary-sig-arg">self</span>,
    182. 

  182.         <span class="summary-sig-arg">length</span>,
    183. 

  183.         <span class="summary-sig-arg">move_cursor</span>=<span class="summary-sig-default">1</span>)</span><br />
    184. 

  184.       Reads the next text slice from the raw data, with length</td>
    185. 

  185.           <td align="right" valign="top">
    186. 

  186.             <span class="codelink"><a href="echonest.support.midi.RawInstreamFile-pysrc.html#RawInstreamFile.nextSlice">source&nbsp;code</a></span>
    187. 

  187.             
    188. 

  188.           </td>
    189. 

  189.         </tr>
    190. 

  190.       </table>
    191. 

  191.       
    192. 

  192.     </td>
    193. 

  193.   </tr>
    194. 

  194. <tr>
    195. 

  195.     <td width="15%" align="right" valign="top" class="summary">
    196. 

  196.       <span class="summary-type">&nbsp;</span>
    197. 

  197.     </td><td class="summary">
    198. 

  198.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    199. 

  199.         <tr>
    200. 

  200.           <td><span class="summary-sig"><a href="echonest.support.midi.RawInstreamFile.RawInstreamFile-class.html#readBew" class="summary-sig-name">readBew</a>(<span class="summary-sig-arg">self</span>,
    201. 

  201.         <span class="summary-sig-arg">n_bytes</span>=<span class="summary-sig-default">1</span>,
    202. 

  202.         <span class="summary-sig-arg">move_cursor</span>=<span class="summary-sig-default">1</span>)</span><br />
    203. 

  203.       Reads n bytes of date from the current cursor position.</td>
    204. 

  204.           <td align="right" valign="top">
    205. 

  205.             <span class="codelink"><a href="echonest.support.midi.RawInstreamFile-pysrc.html#RawInstreamFile.readBew">source&nbsp;code</a></span>
    206. 

  206.             
    207. 

  207.           </td>
    208. 

  208.         </tr>
    209. 

  209.       </table>
    210. 

  210.       
    211. 

  211.     </td>
    212. 

  212.   </tr>
    213. 

  213. <tr>
    214. 

  214.     <td width="15%" align="right" valign="top" class="summary">
    215. 

  215.       <span class="summary-type">&nbsp;</span>
    216. 

  216.     </td><td class="summary">
    217. 

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

  218.         <tr>
    219. 

  219.           <td><span class="summary-sig"><a href="echonest.support.midi.RawInstreamFile.RawInstreamFile-class.html#readVarLen" class="summary-sig-name">readVarLen</a>(<span class="summary-sig-arg">self</span>)</span><br />
    220. 

  220.       Reads a variable length value from the current cursor position.</td>
    221. 

  221.           <td align="right" valign="top">
    222. 

  222.             <span class="codelink"><a href="echonest.support.midi.RawInstreamFile-pysrc.html#RawInstreamFile.readVarLen">source&nbsp;code</a></span>
    223. 

  223.             
    224. 

  224.           </td>
    225. 

  225.         </tr>
    226. 

  226.       </table>
    227. 

  227.       
    228. 

  228.     </td>
    229. 

  229.   </tr>
    230. 

  230. </table>
    231. 

  231. <!-- ==================== METHOD DETAILS ==================== -->
    232. 

  232. <a name="section-MethodDetails"></a>
    233. 

  233. <table class="details" border="1" cellpadding="3"
    234. 

  234.        cellspacing="0" width="100%" bgcolor="white">
    235. 

  235. <tr bgcolor="#70b0f0" class="table-header">
    236. 

  236.   <td colspan="2" class="table-header">
    237. 

  237.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    238. 

  238.       <tr valign="top">
    239. 

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

  240.         <td align="right" valign="top"
    241. 

  241.          ><span class="options">[<a href="#section-MethodDetails"
    242. 

  242.          class="privatelink" onclick="toggle_private();"
    243. 

  243.          >hide private</a>]</span></td>
    244. 

  244.       </tr>
    245. 

  245.     </table>
    246. 

  246.   </td>
    247. 

  247. </tr>
    248. 

  248. </table>
    249. 

  249. <a name="__init__"></a>
    250. 

  250. <div>
    251. 

  251. <table class="details" border="1" cellpadding="3"
    252. 

  252.        cellspacing="0" width="100%" bgcolor="white">
    253. 

  253. <tr><td>
    254. 

  254.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    255. 

  255.   <tr valign="top"><td>
    256. 

  256.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
    257. 

  257.         <span class="sig-arg">infile</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
    258. 

  258.     <br /><em class="fname">(Constructor)</em>
    259. 

  259.   </h3>
    260. 

  260.   </td><td align="right" valign="top"
    261. 

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

  262.     </td>
    263. 

  263.   </tr></table>
    264. 

  264.   
    265. 

  265.   If 'file' is a string we assume it is a path and read from
    266. 

  266. that file.
    267. 

  267. If it is a file descriptor we read from the file, but we don't
    268. 

  268. close it.
    269. 

  269. Midi files are usually pretty small, so it should be safe to
    270. 

  270. copy them into memory.
    271. 

  271.   <dl class="fields">
    272. 

  272.   </dl>
    273. 

  273. </td></tr></table>
    274. 

  274. </div>
    275. 

  275. <a name="readBew"></a>
    276. 

  276. <div>
    277. 

  277. <table class="details" border="1" cellpadding="3"
    278. 

  278.        cellspacing="0" width="100%" bgcolor="white">
    279. 

  279. <tr><td>
    280. 

  280.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    281. 

  281.   <tr valign="top"><td>
    282. 

  282.   <h3 class="epydoc"><span class="sig"><span class="sig-name">readBew</span>(<span class="sig-arg">self</span>,
    283. 

  283.         <span class="sig-arg">n_bytes</span>=<span class="sig-default">1</span>,
    284. 

  284.         <span class="sig-arg">move_cursor</span>=<span class="sig-default">1</span>)</span>
    285. 

  285.   </h3>
    286. 

  286.   </td><td align="right" valign="top"
    287. 

  287.     ><span class="codelink"><a href="echonest.support.midi.RawInstreamFile-pysrc.html#RawInstreamFile.readBew">source&nbsp;code</a></span>&nbsp;
    288. 

  288.     </td>
    289. 

  289.   </tr></table>
    290. 

  290.   
    291. 

  291.   Reads n bytes of date from the current cursor position.
    292. 

  292. Moves cursor if move_cursor is true
    293. 

  293.   <dl class="fields">
    294. 

  294.   </dl>
    295. 

  295. </td></tr></table>
    296. 

  296. </div>
    297. 

  297. <a name="readVarLen"></a>
    298. 

  298. <div>
    299. 

  299. <table class="details" border="1" cellpadding="3"
    300. 

  300.        cellspacing="0" width="100%" bgcolor="white">
    301. 

  301. <tr><td>
    302. 

  302.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    303. 

  303.   <tr valign="top"><td>
    304. 

  304.   <h3 class="epydoc"><span class="sig"><span class="sig-name">readVarLen</span>(<span class="sig-arg">self</span>)</span>
    305. 

  305.   </h3>
    306. 

  306.   </td><td align="right" valign="top"
    307. 

  307.     ><span class="codelink"><a href="echonest.support.midi.RawInstreamFile-pysrc.html#RawInstreamFile.readVarLen">source&nbsp;code</a></span>&nbsp;
    308. 

  308.     </td>
    309. 

  309.   </tr></table>
    310. 

  310.   
    311. 

  311.   Reads a variable length value from the current cursor position.
    312. 

  312. Moves cursor if move_cursor is true
    313. 

  313.   <dl class="fields">
    314. 

  314.   </dl>
    315. 

  315. </td></tr></table>
    316. 

  316. </div>
    317. 

  317. <br />
    318. 

  318. <!-- ==================== NAVIGATION BAR ==================== -->
    319. 

  319. <table class="navbar" border="0" width="100%" cellpadding="0"
    320. 

  320.        bgcolor="#a0c0ff" cellspacing="0">
    321. 

  321.   <tr valign="middle">
    322. 

  322. 

  323.   <!-- Tree link -->
    324. 

  324.       <th>&nbsp;&nbsp;&nbsp;<a
    325. 

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

  326. 

  327.   <!-- Index link -->
    328. 

  328.       <th>&nbsp;&nbsp;&nbsp;<a
    329. 

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

  330. 

  331.   <!-- Help link -->
    332. 

  332.       <th>&nbsp;&nbsp;&nbsp;<a
    333. 

  333.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    334. 

  334. 

  335.   <!-- Project homepage -->
    336. 

  336.       <th class="navbar" align="right" width="100%">
    337. 

  337.         <table border="0" cellpadding="0" cellspacing="0">
    338. 

  338.           <tr><th class="navbar" align="center"
    339. 

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

  340.           </tr></table></th>
    341. 

  341.   </tr>
    342. 

  342. </table>
    343. 

  343. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    344. 

  344.   <tr>
    345. 

  345.     <td align="left" class="footer">
    346. 

  346.     Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:59 2010
    347. 

  347.     </td>
    348. 

  348.     <td align="right" class="footer">
    349. 

  349.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    350. 

  350.         >http://epydoc.sourceforge.net</a>
    351. 

  351.     </td>
    352. 

  352.   </tr>
    353. 

  353. </table>
    354. 

  354. 

  355. <script type="text/javascript">
    356. 

  356.   <!--
    357. 

  357.   // Private objects are initially displayed (because if
    358. 

  358.   // javascript is turned off then we want them to be
    359. 

  359.   // visible); but by default, we want to hide them.  So hide
    360. 

  360.   // them unless we have a cookie that says to show them.
    361. 

  361.   checkCookie();
    362. 

  362.   // -->
    363. 

  363. </script>
    364. 

  364. </body>
    365. 

  365. </html>
    366.