/apidocs/echonest.audio.AudioData-class.html

http://echo-nest-remix.googlecode.com/ · HTML · 639 lines · 570 code · 45 blank · 24 comment · 0 complexity · a5e40a202f899766df9bd1cc094999a6 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.audio.AudioData</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.audio-module.html">Module&nbsp;audio</a> ::
    44. 

  44.         Class&nbsp;AudioData
    45. 

  45.       </span>
    46. 

  46.     </td>
    47. 

  47.     <td>
    48. 

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

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

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

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

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

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

  54.             >]&nbsp;|&nbsp;<a href="echonest.audio.AudioData-class.html"
    55. 

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

  56.       </table>
    57. 

  57.     </td>
    58. 

  58.   </tr>
    59. 

  59. </table>
    60. 

  60. <!-- ==================== CLASS DESCRIPTION ==================== -->
    61. 

  61. <h1 class="epydoc">Class AudioData</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.audio-pysrc.html#AudioData">source&nbsp;code</a></span></p>
    62. 

  62. <center>
    63. 

  63. 

  64. </center>
    65. 

  65. <hr />
    66. 

  66. <p>Handles audio data transparently. A smart audio container
    67. 

  67. with accessors that include:</p>
    68. 

  68. <dl class="rst-docutils">
    69. 

  69. <dt>sampleRate</dt>
    70. 

  70. <dd>samples per second</dd>
    71. 

  71. <dt>numChannels</dt>
    72. 

  72. <dd>number of channels</dd>
    73. 

  73. <dt>data</dt>
    74. 

  74. <dd>a <a class="rst-reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.array.html" target="_top">numpy.array</a></dd>
    75. 

  75. </dl>
    76. 

  76. 

  77. <!-- ==================== INSTANCE METHODS ==================== -->
    78. 

  78. <a name="section-InstanceMethods"></a>
    79. 

  79. <table class="summary" border="1" cellpadding="3"
    80. 

  80.        cellspacing="0" width="100%" bgcolor="white">
    81. 

  81. <tr bgcolor="#70b0f0" class="table-header">
    82. 

  82.   <td colspan="2" class="table-header">
    83. 

  83.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    84. 

  84.       <tr valign="top">
    85. 

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

  86.         <td align="right" valign="top"
    87. 

  87.          ><span class="options">[<a href="#section-InstanceMethods"
    88. 

  88.          class="privatelink" onclick="toggle_private();"
    89. 

  89.          >hide private</a>]</span></td>
    90. 

  90.       </tr>
    91. 

  91.     </table>
    92. 

  92.   </td>
    93. 

  93. </tr>
    94. 

  94. <tr>
    95. 

  95.     <td width="15%" align="right" valign="top" class="summary">
    96. 

  96.       <span class="summary-type">&nbsp;</span>
    97. 

  97.     </td><td class="summary">
    98. 

  98.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    99. 

  99.         <tr>
    100. 

  100.           <td><span class="summary-sig"><a href="echonest.audio.AudioData-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
    101. 

  101.         <span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>,
    102. 

  102.         <span class="summary-sig-arg">ndarray</span>=<span class="summary-sig-default">None</span>,
    103. 

  103.         <span class="summary-sig-arg">shape</span>=<span class="summary-sig-default">None</span>,
    104. 

  104.         <span class="summary-sig-arg">sampleRate</span>=<span class="summary-sig-default">None</span>,
    105. 

  105.         <span class="summary-sig-arg">numChannels</span>=<span class="summary-sig-default">None</span>,
    106. 

  106.         <span class="summary-sig-arg">defer</span>=<span class="summary-sig-default">False</span>,
    107. 

  107.         <span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">True</span>)</span><br />
    108. 

  108.       Given an input <code class="link">ndarray</code>, import the sample values and shape
    109. 

  109. (if none is specified) of the input <code class="link">numpy.array</code>.</td>
    110. 

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

  111.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.__init__">source&nbsp;code</a></span>
    112. 

  112.             
    113. 

  113.           </td>
    114. 

  114.         </tr>
    115. 

  115.       </table>
    116. 

  116.       
    117. 

  117.     </td>
    118. 

  118.   </tr>
    119. 

  119. <tr>
    120. 

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

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

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

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

  124.         <tr>
    125. 

  125.           <td><span class="summary-sig"><a name="load"></a><span class="summary-sig-name">load</span>(<span class="summary-sig-arg">self</span>)</span></td>
    126. 

  126.           <td align="right" valign="top">
    127. 

  127.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.load">source&nbsp;code</a></span>
    128. 

  128.             
    129. 

  129.           </td>
    130. 

  130.         </tr>
    131. 

  131.       </table>
    132. 

  132.       
    133. 

  133.     </td>
    134. 

  134.   </tr>
    135. 

  135. <tr>
    136. 

  136.     <td width="15%" align="right" valign="top" class="summary">
    137. 

  137.       <span class="summary-type">&nbsp;</span>
    138. 

  138.     </td><td class="summary">
    139. 

  139.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    140. 

  140.         <tr>
    141. 

  141.           <td><span class="summary-sig"><a href="echonest.audio.AudioData-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(<span class="summary-sig-arg">self</span>,
    142. 

  142.         <span class="summary-sig-arg">index</span>)</span><br />
    143. 

  143.       Fetches a frame or slice.</td>
    144. 

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

  145.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.__getitem__">source&nbsp;code</a></span>
    146. 

  146.             
    147. 

  147.           </td>
    148. 

  148.         </tr>
    149. 

  149.       </table>
    150. 

  150.       
    151. 

  151.     </td>
    152. 

  152.   </tr>
    153. 

  153. <tr>
    154. 

  154.     <td width="15%" align="right" valign="top" class="summary">
    155. 

  155.       <span class="summary-type">&nbsp;</span>
    156. 

  156.     </td><td class="summary">
    157. 

  157.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    158. 

  158.         <tr>
    159. 

  159.           <td><span class="summary-sig"><a name="getslice"></a><span class="summary-sig-name">getslice</span>(<span class="summary-sig-arg">self</span>,
    160. 

  160.         <span class="summary-sig-arg">index</span>)</span><br />
    161. 

  161.       Help <a href="echonest.audio.AudioData-class.html#__getitem__" class="link">__getitem__</a> return a new AudioData for a given slice</td>
    162. 

  162.           <td align="right" valign="top">
    163. 

  163.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.getslice">source&nbsp;code</a></span>
    164. 

  164.             
    165. 

  165.           </td>
    166. 

  166.         </tr>
    167. 

  167.       </table>
    168. 

  168.       
    169. 

  169.     </td>
    170. 

  170.   </tr>
    171. 

  171. <tr>
    172. 

  172.     <td width="15%" align="right" valign="top" class="summary">
    173. 

  173.       <span class="summary-type">&nbsp;</span>
    174. 

  174.     </td><td class="summary">
    175. 

  175.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    176. 

  176.         <tr>
    177. 

  177.           <td><span class="summary-sig"><a name="getsample"></a><span class="summary-sig-name">getsample</span>(<span class="summary-sig-arg">self</span>,
    178. 

  178.         <span class="summary-sig-arg">index</span>)</span><br />
    179. 

  179.       Help <a href="echonest.audio.AudioData-class.html#__getitem__" class="link">__getitem__</a> return a frame (all channels for a given
    180. 

  180. sample index)</td>
    181. 

  181.           <td align="right" valign="top">
    182. 

  182.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.getsample">source&nbsp;code</a></span>
    183. 

  183.             
    184. 

  184.           </td>
    185. 

  185.         </tr>
    186. 

  186.       </table>
    187. 

  187.       
    188. 

  188.     </td>
    189. 

  189.   </tr>
    190. 

  190. <tr>
    191. 

  191.     <td width="15%" align="right" valign="top" class="summary">
    192. 

  192.       <span class="summary-type">&nbsp;</span>
    193. 

  193.     </td><td class="summary">
    194. 

  194.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    195. 

  195.         <tr>
    196. 

  196.           <td><span class="summary-sig"><a name="pad_with_zeros"></a><span class="summary-sig-name">pad_with_zeros</span>(<span class="summary-sig-arg">self</span>,
    197. 

  197.         <span class="summary-sig-arg">num_samples</span>)</span></td>
    198. 

  198.           <td align="right" valign="top">
    199. 

  199.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.pad_with_zeros">source&nbsp;code</a></span>
    200. 

  200.             
    201. 

  201.           </td>
    202. 

  202.         </tr>
    203. 

  203.       </table>
    204. 

  204.       
    205. 

  205.     </td>
    206. 

  206.   </tr>
    207. 

  207. <tr>
    208. 

  208.     <td width="15%" align="right" valign="top" class="summary">
    209. 

  209.       <span class="summary-type">&nbsp;</span>
    210. 

  210.     </td><td class="summary">
    211. 

  211.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    212. 

  212.         <tr>
    213. 

  213.           <td><span class="summary-sig"><a name="append"></a><span class="summary-sig-name">append</span>(<span class="summary-sig-arg">self</span>,
    214. 

  214.         <span class="summary-sig-arg">as2</span>)</span><br />
    215. 

  215.       Appends the input to the end of this <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a>.</td>
    216. 

  216.           <td align="right" valign="top">
    217. 

  217.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.append">source&nbsp;code</a></span>
    218. 

  218.             
    219. 

  219.           </td>
    220. 

  220.         </tr>
    221. 

  221.       </table>
    222. 

  222.       
    223. 

  223.     </td>
    224. 

  224.   </tr>
    225. 

  225. <tr>
    226. 

  226.     <td width="15%" align="right" valign="top" class="summary">
    227. 

  227.       <span class="summary-type">&nbsp;</span>
    228. 

  228.     </td><td class="summary">
    229. 

  229.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    230. 

  230.         <tr>
    231. 

  231.           <td><span class="summary-sig"><a name="sum"></a><span class="summary-sig-name">sum</span>(<span class="summary-sig-arg">self</span>,
    232. 

  232.         <span class="summary-sig-arg">as2</span>)</span></td>
    233. 

  233.           <td align="right" valign="top">
    234. 

  234.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.sum">source&nbsp;code</a></span>
    235. 

  235.             
    236. 

  236.           </td>
    237. 

  237.         </tr>
    238. 

  238.       </table>
    239. 

  239.       
    240. 

  240.     </td>
    241. 

  241.   </tr>
    242. 

  242. <tr>
    243. 

  243.     <td width="15%" align="right" valign="top" class="summary">
    244. 

  244.       <span class="summary-type">&nbsp;</span>
    245. 

  245.     </td><td class="summary">
    246. 

  246.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    247. 

  247.         <tr>
    248. 

  248.           <td><span class="summary-sig"><a name="add_at"></a><span class="summary-sig-name">add_at</span>(<span class="summary-sig-arg">self</span>,
    249. 

  249.         <span class="summary-sig-arg">time</span>,
    250. 

  250.         <span class="summary-sig-arg">as2</span>)</span></td>
    251. 

  251.           <td align="right" valign="top">
    252. 

  252.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.add_at">source&nbsp;code</a></span>
    253. 

  253.             
    254. 

  254.           </td>
    255. 

  255.         </tr>
    256. 

  256.       </table>
    257. 

  257.       
    258. 

  258.     </td>
    259. 

  259.   </tr>
    260. 

  260. <tr>
    261. 

  261.     <td width="15%" align="right" valign="top" class="summary">
    262. 

  262.       <span class="summary-type">&nbsp;</span>
    263. 

  263.     </td><td class="summary">
    264. 

  264.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    265. 

  265.         <tr>
    266. 

  266.           <td><span class="summary-sig"><a name="__len__"></a><span class="summary-sig-name">__len__</span>(<span class="summary-sig-arg">self</span>)</span></td>
    267. 

  267.           <td align="right" valign="top">
    268. 

  268.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.__len__">source&nbsp;code</a></span>
    269. 

  269.             
    270. 

  270.           </td>
    271. 

  271.         </tr>
    272. 

  272.       </table>
    273. 

  273.       
    274. 

  274.     </td>
    275. 

  275.   </tr>
    276. 

  276. <tr>
    277. 

  277.     <td width="15%" align="right" valign="top" class="summary">
    278. 

  278.       <span class="summary-type">&nbsp;</span>
    279. 

  279.     </td><td class="summary">
    280. 

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

  281.         <tr>
    282. 

  282.           <td><span class="summary-sig"><a name="__add__"></a><span class="summary-sig-name">__add__</span>(<span class="summary-sig-arg">self</span>,
    283. 

  283.         <span class="summary-sig-arg">other</span>)</span><br />
    284. 

  284.       Supports stuff like this: sound3 = sound1 + sound2</td>
    285. 

  285.           <td align="right" valign="top">
    286. 

  286.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.__add__">source&nbsp;code</a></span>
    287. 

  287.             
    288. 

  288.           </td>
    289. 

  289.         </tr>
    290. 

  290.       </table>
    291. 

  291.       
    292. 

  292.     </td>
    293. 

  293.   </tr>
    294. 

  294. <tr>
    295. 

  295.     <td width="15%" align="right" valign="top" class="summary">
    296. 

  296.       <span class="summary-type">&nbsp;</span>
    297. 

  297.     </td><td class="summary">
    298. 

  298.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    299. 

  299.         <tr>
    300. 

  300.           <td><span class="summary-sig"><a href="echonest.audio.AudioData-class.html#encode" class="summary-sig-name">encode</a>(<span class="summary-sig-arg">self</span>,
    301. 

  301.         <span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>,
    302. 

  302.         <span class="summary-sig-arg">mp3</span>=<span class="summary-sig-default">None</span>)</span><br />
    303. 

  303.       Outputs an MP3 or WAVE file to <code class="link">filename</code>.</td>
    304. 

  304.           <td align="right" valign="top">
    305. 

  305.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.encode">source&nbsp;code</a></span>
    306. 

  306.             
    307. 

  307.           </td>
    308. 

  308.         </tr>
    309. 

  309.       </table>
    310. 

  310.       
    311. 

  311.     </td>
    312. 

  312.   </tr>
    313. 

  313. <tr>
    314. 

  314.     <td width="15%" align="right" valign="top" class="summary">
    315. 

  315.       <span class="summary-type">&nbsp;</span>
    316. 

  316.     </td><td class="summary">
    317. 

  317.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    318. 

  318.         <tr>
    319. 

  319.           <td><span class="summary-sig"><a name="unload"></a><span class="summary-sig-name">unload</span>(<span class="summary-sig-arg">self</span>)</span></td>
    320. 

  320.           <td align="right" valign="top">
    321. 

  321.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.unload">source&nbsp;code</a></span>
    322. 

  322.             
    323. 

  323.           </td>
    324. 

  324.         </tr>
    325. 

  325.       </table>
    326. 

  326.       
    327. 

  327.     </td>
    328. 

  328.   </tr>
    329. 

  329. <tr>
    330. 

  330.     <td width="15%" align="right" valign="top" class="summary">
    331. 

  331.       <span class="summary-type">&nbsp;</span>
    332. 

  332.     </td><td class="summary">
    333. 

  333.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    334. 

  334.         <tr>
    335. 

  335.           <td><span class="summary-sig"><a name="render"></a><span class="summary-sig-name">render</span>(<span class="summary-sig-arg">self</span>,
    336. 

  336.         <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">0.0</span>,
    337. 

  337.         <span class="summary-sig-arg">to_audio</span>=<span class="summary-sig-default">None</span>,
    338. 

  338.         <span class="summary-sig-arg">with_source</span>=<span class="summary-sig-default">None</span>)</span></td>
    339. 

  339.           <td align="right" valign="top">
    340. 

  340.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.render">source&nbsp;code</a></span>
    341. 

  341.             
    342. 

  342.           </td>
    343. 

  343.         </tr>
    344. 

  344.       </table>
    345. 

  345.       
    346. 

  346.     </td>
    347. 

  347.   </tr>
    348. 

  348.   <tr>
    349. 

  349.     <td colspan="2" class="summary">
    350. 

  350.     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioRenderable-class.html">AudioRenderable</a></code></b>:
    351. 

  351.       <code><a href="echonest.audio.AudioRenderable-class.html#resolve_source">resolve_source</a></code>,
    352. 

  352.       <code><a href="echonest.audio.AudioRenderable-class.html#sources">sources</a></code>
    353. 

  353.       </p>
    354. 

  354.     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
    355. 

  355.       <code>__delattr__</code>,
    356. 

  356.       <code>__format__</code>,
    357. 

  357.       <code>__getattribute__</code>,
    358. 

  358.       <code>__hash__</code>,
    359. 

  359.       <code>__new__</code>,
    360. 

  360.       <code>__reduce__</code>,
    361. 

  361.       <code>__reduce_ex__</code>,
    362. 

  362.       <code>__repr__</code>,
    363. 

  363.       <code>__setattr__</code>,
    364. 

  364.       <code>__sizeof__</code>,
    365. 

  365.       <code>__str__</code>,
    366. 

  366.       <code>__subclasshook__</code>
    367. 

  367.       </p>
    368. 

  368.     </td>
    369. 

  369.   </tr>
    370. 

  370. </table>
    371. 

  371. <!-- ==================== STATIC METHODS ==================== -->
    372. 

  372. <a name="section-StaticMethods"></a>
    373. 

  373. <table class="summary" border="1" cellpadding="3"
    374. 

  374.        cellspacing="0" width="100%" bgcolor="white">
    375. 

  375. <tr bgcolor="#70b0f0" class="table-header">
    376. 

  376.   <td colspan="2" class="table-header">
    377. 

  377.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    378. 

  378.       <tr valign="top">
    379. 

  379.         <td align="left"><span class="table-header">Static Methods</span></td>
    380. 

  380.         <td align="right" valign="top"
    381. 

  381.          ><span class="options">[<a href="#section-StaticMethods"
    382. 

  382.          class="privatelink" onclick="toggle_private();"
    383. 

  383.          >hide private</a>]</span></td>
    384. 

  384.       </tr>
    385. 

  385.     </table>
    386. 

  386.   </td>
    387. 

  387. </tr>
    388. 

  388.   <tr>
    389. 

  389.     <td colspan="2" class="summary">
    390. 

  390.     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioRenderable-class.html">AudioRenderable</a></code></b>:
    391. 

  391.       <code><a href="echonest.audio.AudioRenderable-class.html#init_audio_data">init_audio_data</a></code>
    392. 

  392.       </p>
    393. 

  393.     </td>
    394. 

  394.   </tr>
    395. 

  395. </table>
    396. 

  396. <!-- ==================== PROPERTIES ==================== -->
    397. 

  397. <a name="section-Properties"></a>
    398. 

  398. <table class="summary" border="1" cellpadding="3"
    399. 

  399.        cellspacing="0" width="100%" bgcolor="white">
    400. 

  400. <tr bgcolor="#70b0f0" class="table-header">
    401. 

  401.   <td colspan="2" class="table-header">
    402. 

  402.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    403. 

  403.       <tr valign="top">
    404. 

  404.         <td align="left"><span class="table-header">Properties</span></td>
    405. 

  405.         <td align="right" valign="top"
    406. 

  406.          ><span class="options">[<a href="#section-Properties"
    407. 

  407.          class="privatelink" onclick="toggle_private();"
    408. 

  408.          >hide private</a>]</span></td>
    409. 

  409.       </tr>
    410. 

  410.     </table>
    411. 

  411.   </td>
    412. 

  412. </tr>
    413. 

  413. <tr>
    414. 

  414.     <td width="15%" align="right" valign="top" class="summary">
    415. 

  415.       <span class="summary-type">&nbsp;</span>
    416. 

  416.     </td><td class="summary">
    417. 

  417.         <a href="echonest.audio.AudioData-class.html#duration" class="summary-name">duration</a>
    418. 

  418.     </td>
    419. 

  419.   </tr>
    420. 

  420. <tr>
    421. 

  421.     <td width="15%" align="right" valign="top" class="summary">
    422. 

  422.       <span class="summary-type">&nbsp;</span>
    423. 

  423.     </td><td class="summary">
    424. 

  424.         <a href="echonest.audio.AudioData-class.html#source" class="summary-name">source</a>
    425. 

  425.     </td>
    426. 

  426.   </tr>
    427. 

  427.   <tr>
    428. 

  428.     <td colspan="2" class="summary">
    429. 

  429.     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
    430. 

  430.       <code>__class__</code>
    431. 

  431.       </p>
    432. 

  432.     </td>
    433. 

  433.   </tr>
    434. 

  434. </table>
    435. 

  435. <!-- ==================== METHOD DETAILS ==================== -->
    436. 

  436. <a name="section-MethodDetails"></a>
    437. 

  437. <table class="details" border="1" cellpadding="3"
    438. 

  438.        cellspacing="0" width="100%" bgcolor="white">
    439. 

  439. <tr bgcolor="#70b0f0" class="table-header">
    440. 

  440.   <td colspan="2" class="table-header">
    441. 

  441.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    442. 

  442.       <tr valign="top">
    443. 

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

  444.         <td align="right" valign="top"
    445. 

  445.          ><span class="options">[<a href="#section-MethodDetails"
    446. 

  446.          class="privatelink" onclick="toggle_private();"
    447. 

  447.          >hide private</a>]</span></td>
    448. 

  448.       </tr>
    449. 

  449.     </table>
    450. 

  450.   </td>
    451. 

  451. </tr>
    452. 

  452. </table>
    453. 

  453. <a name="__init__"></a>
    454. 

  454. <div>
    455. 

  455. <table class="details" border="1" cellpadding="3"
    456. 

  456.        cellspacing="0" width="100%" bgcolor="white">
    457. 

  457. <tr><td>
    458. 

  458.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    459. 

  459.   <tr valign="top"><td>
    460. 

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

  461.         <span class="sig-arg">filename</span>=<span class="sig-default">None</span>,
    462. 

  462.         <span class="sig-arg">ndarray</span>=<span class="sig-default">None</span>,
    463. 

  463.         <span class="sig-arg">shape</span>=<span class="sig-default">None</span>,
    464. 

  464.         <span class="sig-arg">sampleRate</span>=<span class="sig-default">None</span>,
    465. 

  465.         <span class="sig-arg">numChannels</span>=<span class="sig-default">None</span>,
    466. 

  466.         <span class="sig-arg">defer</span>=<span class="sig-default">False</span>,
    467. 

  467.         <span class="sig-arg">verbose</span>=<span class="sig-default">True</span>)</span>
    468. 

  468.     <br /><em class="fname">(Constructor)</em>
    469. 

  469.   </h3>
    470. 

  470.   </td><td align="right" valign="top"
    471. 

  471.     ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.__init__">source&nbsp;code</a></span>&nbsp;
    472. 

  472.     </td>
    473. 

  473.   </tr></table>
    474. 

  474.   
    475. 

  475.   <p>Given an input <code class="link">ndarray</code>, import the sample values and shape
    476. 

  476. (if none is specified) of the input <code class="link">numpy.array</code>.</p>
    477. 

  477. <p>Given a <code class="link">filename</code> (and an input ndarray), use ffmpeg to convert
    478. 

  478. the file to wave, then load the file into the data,
    479. 

  479. auto-detecting the sample rate, and number of channels.</p>
    480. 

  480.   <dl class="fields">
    481. 

  481.     <dt>Parameters:</dt>
    482. 

  482.     <dd><ul class="nomargin-top">
    483. 

  483.         <li><strong class="pname"><code>filename</code></strong> - a path to an audio file for loading its sample
    484. 

  484. data into the AudioData.data</li>
    485. 

  485.         <li><strong class="pname"><code>ndarray</code></strong> - a <a class="rst-reference external" href="http://docs.scipy.org/doc/numpy/reference/generated/numpy.array.html" target="_top">numpy.array</a> instance with sample data</li>
    486. 

  486.         <li><strong class="pname"><code>shape</code></strong> - a tuple of array dimensions</li>
    487. 

  487.         <li><strong class="pname"><code>sampleRate</code></strong> - sample rate, in Hz</li>
    488. 

  488.         <li><strong class="pname"><code>numChannels</code></strong> - number of channels</li>
    489. 

  489.     </ul></dd>
    490. 

  490.     <dt>Overrides:
    491. 

  491.         object.__init__
    492. 

  492.     </dt>
    493. 

  493.   </dl>
    494. 

  494. </td></tr></table>
    495. 

  495. </div>
    496. 

  496. <a name="__getitem__"></a>
    497. 

  497. <div>
    498. 

  498. <table class="details" border="1" cellpadding="3"
    499. 

  499.        cellspacing="0" width="100%" bgcolor="white">
    500. 

  500. <tr><td>
    501. 

  501.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    502. 

  502.   <tr valign="top"><td>
    503. 

  503.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__getitem__</span>(<span class="sig-arg">self</span>,
    504. 

  504.         <span class="sig-arg">index</span>)</span>
    505. 

  505.     <br /><em class="fname">(Indexing operator)</em>
    506. 

  506.   </h3>
    507. 

  507.   </td><td align="right" valign="top"
    508. 

  508.     ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.__getitem__">source&nbsp;code</a></span>&nbsp;
    509. 

  509.     </td>
    510. 

  510.   </tr></table>
    511. 

  511.   
    512. 

  512.   Fetches a frame or slice. Returns an individual frame (if the index
    513. 

  513. is a time offset float or an integer sample number) or a slice if
    514. 

  514. the index is an <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a> (or quacks like one).
    515. 

  515.   <dl class="fields">
    516. 

  516.   </dl>
    517. 

  517. </td></tr></table>
    518. 

  518. </div>
    519. 

  519. <a name="encode"></a>
    520. 

  520. <div>
    521. 

  521. <table class="details" border="1" cellpadding="3"
    522. 

  522.        cellspacing="0" width="100%" bgcolor="white">
    523. 

  523. <tr><td>
    524. 

  524.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    525. 

  525.   <tr valign="top"><td>
    526. 

  526.   <h3 class="epydoc"><span class="sig"><span class="sig-name">encode</span>(<span class="sig-arg">self</span>,
    527. 

  527.         <span class="sig-arg">filename</span>=<span class="sig-default">None</span>,
    528. 

  528.         <span class="sig-arg">mp3</span>=<span class="sig-default">None</span>)</span>
    529. 

  529.   </h3>
    530. 

  530.   </td><td align="right" valign="top"
    531. 

  531.     ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioData.encode">source&nbsp;code</a></span>&nbsp;
    532. 

  532.     </td>
    533. 

  533.   </tr></table>
    534. 

  534.   
    535. 

  535.   Outputs an MP3 or WAVE file to <code class="link">filename</code>.
    536. 

  536. Format is determined by <code class="link">mp3</code> parameter.
    537. 

  537.   <dl class="fields">
    538. 

  538.     <dt>Overrides:
    539. 

  539.         <a href="echonest.audio.AudioRenderable-class.html#encode">AudioRenderable.encode</a>
    540. 

  540.     </dt>
    541. 

  541.   </dl>
    542. 

  542. </td></tr></table>
    543. 

  543. </div>
    544. 

  544. <br />
    545. 

  545. <!-- ==================== PROPERTY DETAILS ==================== -->
    546. 

  546. <a name="section-PropertyDetails"></a>
    547. 

  547. <table class="details" border="1" cellpadding="3"
    548. 

  548.        cellspacing="0" width="100%" bgcolor="white">
    549. 

  549. <tr bgcolor="#70b0f0" class="table-header">
    550. 

  550.   <td colspan="2" class="table-header">
    551. 

  551.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    552. 

  552.       <tr valign="top">
    553. 

  553.         <td align="left"><span class="table-header">Property Details</span></td>
    554. 

  554.         <td align="right" valign="top"
    555. 

  555.          ><span class="options">[<a href="#section-PropertyDetails"
    556. 

  556.          class="privatelink" onclick="toggle_private();"
    557. 

  557.          >hide private</a>]</span></td>
    558. 

  558.       </tr>
    559. 

  559.     </table>
    560. 

  560.   </td>
    561. 

  561. </tr>
    562. 

  562. </table>
    563. 

  563. <a name="duration"></a>
    564. 

  564. <div>
    565. 

  565. <table class="details" border="1" cellpadding="3"
    566. 

  566.        cellspacing="0" width="100%" bgcolor="white">
    567. 

  567. <tr><td>
    568. 

  568.   <h3 class="epydoc">duration</h3>
    569. 

  569.   
    570. 

  570.   <dl class="fields">
    571. 

  571.     <dt>Get Method:</dt>
    572. 

  572.     <dd class="value"><span class="summary-sig"><i>unreachable</i>.duration(<span class="summary-sig-arg">self</span>)</span>
    573. 

  573.     </dd>
    574. 

  574.   </dl>
    575. 

  575. </td></tr></table>
    576. 

  576. </div>
    577. 

  577. <a name="source"></a>
    578. 

  578. <div>
    579. 

  579. <table class="details" border="1" cellpadding="3"
    580. 

  580.        cellspacing="0" width="100%" bgcolor="white">
    581. 

  581. <tr><td>
    582. 

  582.   <h3 class="epydoc">source</h3>
    583. 

  583.   
    584. 

  584.   <dl class="fields">
    585. 

  585.     <dt>Get Method:</dt>
    586. 

  586.     <dd class="value"><span class="summary-sig"><i>unreachable</i>.source(<span class="summary-sig-arg">self</span>)</span>
    587. 

  587.     </dd>
    588. 

  588.   </dl>
    589. 

  589. </td></tr></table>
    590. 

  590. </div>
    591. 

  591. <br />
    592. 

  592. <!-- ==================== NAVIGATION BAR ==================== -->
    593. 

  593. <table class="navbar" border="0" width="100%" cellpadding="0"
    594. 

  594.        bgcolor="#a0c0ff" cellspacing="0">
    595. 

  595.   <tr valign="middle">
    596. 

  596. 

  597.   <!-- Tree link -->
    598. 

  598.       <th>&nbsp;&nbsp;&nbsp;<a
    599. 

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

  600. 

  601.   <!-- Index link -->
    602. 

  602.       <th>&nbsp;&nbsp;&nbsp;<a
    603. 

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

  604. 

  605.   <!-- Help link -->
    606. 

  606.       <th>&nbsp;&nbsp;&nbsp;<a
    607. 

  607.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    608. 

  608. 

  609.   <!-- Project homepage -->
    610. 

  610.       <th class="navbar" align="right" width="100%">
    611. 

  611.         <table border="0" cellpadding="0" cellspacing="0">
    612. 

  612.           <tr><th class="navbar" align="center"
    613. 

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

  614.           </tr></table></th>
    615. 

  615.   </tr>
    616. 

  616. </table>
    617. 

  617. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    618. 

  618.   <tr>
    619. 

  619.     <td align="left" class="footer">
    620. 

  620.     Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:58 2010
    621. 

  621.     </td>
    622. 

  622.     <td align="right" class="footer">
    623. 

  623.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    624. 

  624.         >http://epydoc.sourceforge.net</a>
    625. 

  625.     </td>
    626. 

  626.   </tr>
    627. 

  627. </table>
    628. 

  628. 

  629. <script type="text/javascript">
    630. 

  630.   <!--
    631. 

  631.   // Private objects are initially displayed (because if
    632. 

  632.   // javascript is turned off then we want them to be
    633. 

  633.   // visible); but by default, we want to hide them.  So hide
    634. 

  634.   // them unless we have a cookie that says to show them.
    635. 

  635.   checkCookie();
    636. 

  636.   // -->
    637. 

  637. </script>
    638. 

  638. </body>
    639. 

  639. </html>
    640.