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

http://echo-nest-remix.googlecode.com/ · HTML · 443 lines · 392 code · 28 blank · 23 comment · 0 complexity · ecd5d716935f5ecb9d7341bcb9070b00 MD5 · raw file

  1. <?xml version="1.0" encoding="ascii"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3. "DTD/xhtml1-transitional.dtd">
  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5. <head>
  6. <title>echonest.audio.AudioData32</title>
  7. <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8. <script type="text/javascript" src="epydoc.js"></script>
  9. </head>
  10. <body bgcolor="white" text="black" link="blue" vlink="#204080"
  11. alink="#204080">
  12. <!-- ==================== NAVIGATION BAR ==================== -->
  13. <table class="navbar" border="0" width="100%" cellpadding="0"
  14. bgcolor="#a0c0ff" cellspacing="0">
  15. <tr valign="middle">
  16. <!-- Tree link -->
  17. <th>&nbsp;&nbsp;&nbsp;<a
  18. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  19. <!-- Index link -->
  20. <th>&nbsp;&nbsp;&nbsp;<a
  21. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  22. <!-- Help link -->
  23. <th>&nbsp;&nbsp;&nbsp;<a
  24. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  25. <!-- Project homepage -->
  26. <th class="navbar" align="right" width="100%">
  27. <table border="0" cellpadding="0" cellspacing="0">
  28. <tr><th class="navbar" align="center"
  29. ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
  30. </tr></table></th>
  31. </tr>
  32. </table>
  33. <table width="100%" cellpadding="0" cellspacing="0">
  34. <tr valign="top">
  35. <td width="100%">
  36. <span class="breadcrumbs">
  37. <a href="echonest-module.html">Package&nbsp;echonest</a> ::
  38. <a href="echonest.audio-module.html">Module&nbsp;audio</a> ::
  39. Class&nbsp;AudioData32
  40. </span>
  41. </td>
  42. <td>
  43. <table cellpadding="0" cellspacing="0">
  44. <!-- hide/show private -->
  45. <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  46. onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  47. <tr><td align="right"><span class="options"
  48. >[<a href="frames.html" target="_top">frames</a
  49. >]&nbsp;|&nbsp;<a href="echonest.audio.AudioData32-class.html"
  50. target="_top">no&nbsp;frames</a>]</span></td></tr>
  51. </table>
  52. </td>
  53. </tr>
  54. </table>
  55. <!-- ==================== CLASS DESCRIPTION ==================== -->
  56. <h1 class="epydoc">Class AudioData32</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.audio-pysrc.html#AudioData32">source&nbsp;code</a></span></p>
  57. <center>
  58. </center>
  59. <hr />
  60. A 32-bit variant of AudioData, intended for data collection on
  61. audio rendering with headroom.
  62. <!-- ==================== INSTANCE METHODS ==================== -->
  63. <a name="section-InstanceMethods"></a>
  64. <table class="summary" border="1" cellpadding="3"
  65. cellspacing="0" width="100%" bgcolor="white">
  66. <tr bgcolor="#70b0f0" class="table-header">
  67. <td colspan="2" class="table-header">
  68. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  69. <tr valign="top">
  70. <td align="left"><span class="table-header">Instance Methods</span></td>
  71. <td align="right" valign="top"
  72. ><span class="options">[<a href="#section-InstanceMethods"
  73. class="privatelink" onclick="toggle_private();"
  74. >hide private</a>]</span></td>
  75. </tr>
  76. </table>
  77. </td>
  78. </tr>
  79. <tr>
  80. <td width="15%" align="right" valign="top" class="summary">
  81. <span class="summary-type">&nbsp;</span>
  82. </td><td class="summary">
  83. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  84. <tr>
  85. <td><span class="summary-sig"><a href="echonest.audio.AudioData32-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
  86. <span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>,
  87. <span class="summary-sig-arg">ndarray</span>=<span class="summary-sig-default">None</span>,
  88. <span class="summary-sig-arg">shape</span>=<span class="summary-sig-default">None</span>,
  89. <span class="summary-sig-arg">sampleRate</span>=<span class="summary-sig-default">None</span>,
  90. <span class="summary-sig-arg">numChannels</span>=<span class="summary-sig-default">None</span>,
  91. <span class="summary-sig-arg">defer</span>=<span class="summary-sig-default">False</span>,
  92. <span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">True</span>)</span><br />
  93. Special form of AudioData to allow for headroom when collecting samples.</td>
  94. <td align="right" valign="top">
  95. <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData32.__init__">source&nbsp;code</a></span>
  96. </td>
  97. </tr>
  98. </table>
  99. </td>
  100. </tr>
  101. <tr>
  102. <td width="15%" align="right" valign="top" class="summary">
  103. <span class="summary-type">&nbsp;</span>
  104. </td><td class="summary">
  105. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  106. <tr>
  107. <td><span class="summary-sig"><a href="echonest.audio.AudioData32-class.html#load" class="summary-sig-name">load</a>(<span class="summary-sig-arg">self</span>)</span></td>
  108. <td align="right" valign="top">
  109. <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData32.load">source&nbsp;code</a></span>
  110. </td>
  111. </tr>
  112. </table>
  113. </td>
  114. </tr>
  115. <tr>
  116. <td width="15%" align="right" valign="top" class="summary">
  117. <span class="summary-type">&nbsp;</span>
  118. </td><td class="summary">
  119. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  120. <tr>
  121. <td><span class="summary-sig"><a href="echonest.audio.AudioData32-class.html#encode" class="summary-sig-name">encode</a>(<span class="summary-sig-arg">self</span>,
  122. <span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>,
  123. <span class="summary-sig-arg">mp3</span>=<span class="summary-sig-default">None</span>)</span><br />
  124. Outputs an MP3 or WAVE file to <code class="link">filename</code>.</td>
  125. <td align="right" valign="top">
  126. <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData32.encode">source&nbsp;code</a></span>
  127. </td>
  128. </tr>
  129. </table>
  130. </td>
  131. </tr>
  132. <tr>
  133. <td width="15%" align="right" valign="top" class="summary">
  134. <span class="summary-type">&nbsp;</span>
  135. </td><td class="summary">
  136. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  137. <tr>
  138. <td><span class="summary-sig"><a name="normalize"></a><span class="summary-sig-name">normalize</span>(<span class="summary-sig-arg">self</span>)</span><br />
  139. Return to 16-bit for encoding.</td>
  140. <td align="right" valign="top">
  141. <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData32.normalize">source&nbsp;code</a></span>
  142. </td>
  143. </tr>
  144. </table>
  145. </td>
  146. </tr>
  147. <tr>
  148. <td width="15%" align="right" valign="top" class="summary">
  149. <span class="summary-type">&nbsp;</span>
  150. </td><td class="summary">
  151. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  152. <tr>
  153. <td><span class="summary-sig"><a href="echonest.audio.AudioData32-class.html#pad_with_zeros" class="summary-sig-name">pad_with_zeros</a>(<span class="summary-sig-arg">self</span>,
  154. <span class="summary-sig-arg">num_samples</span>)</span></td>
  155. <td align="right" valign="top">
  156. <span class="codelink"><a href="echonest.audio-pysrc.html#AudioData32.pad_with_zeros">source&nbsp;code</a></span>
  157. </td>
  158. </tr>
  159. </table>
  160. </td>
  161. </tr>
  162. <tr>
  163. <td colspan="2" class="summary">
  164. <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioData-class.html">AudioData</a></code></b>:
  165. <code><a href="echonest.audio.AudioData-class.html#__add__">__add__</a></code>,
  166. <code><a href="echonest.audio.AudioData-class.html#__getitem__">__getitem__</a></code>,
  167. <code><a href="echonest.audio.AudioData-class.html#__len__">__len__</a></code>,
  168. <code><a href="echonest.audio.AudioData-class.html#add_at">add_at</a></code>,
  169. <code><a href="echonest.audio.AudioData-class.html#append">append</a></code>,
  170. <code><a href="echonest.audio.AudioData-class.html#getsample">getsample</a></code>,
  171. <code><a href="echonest.audio.AudioData-class.html#getslice">getslice</a></code>,
  172. <code><a href="echonest.audio.AudioData-class.html#render">render</a></code>,
  173. <code><a href="echonest.audio.AudioData-class.html#sum">sum</a></code>,
  174. <code><a href="echonest.audio.AudioData-class.html#unload">unload</a></code>
  175. </p>
  176. <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioRenderable-class.html">AudioRenderable</a></code></b>:
  177. <code><a href="echonest.audio.AudioRenderable-class.html#resolve_source">resolve_source</a></code>,
  178. <code><a href="echonest.audio.AudioRenderable-class.html#sources">sources</a></code>
  179. </p>
  180. <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
  181. <code>__delattr__</code>,
  182. <code>__format__</code>,
  183. <code>__getattribute__</code>,
  184. <code>__hash__</code>,
  185. <code>__new__</code>,
  186. <code>__reduce__</code>,
  187. <code>__reduce_ex__</code>,
  188. <code>__repr__</code>,
  189. <code>__setattr__</code>,
  190. <code>__sizeof__</code>,
  191. <code>__str__</code>,
  192. <code>__subclasshook__</code>
  193. </p>
  194. </td>
  195. </tr>
  196. </table>
  197. <!-- ==================== STATIC METHODS ==================== -->
  198. <a name="section-StaticMethods"></a>
  199. <table class="summary" border="1" cellpadding="3"
  200. cellspacing="0" width="100%" bgcolor="white">
  201. <tr bgcolor="#70b0f0" class="table-header">
  202. <td colspan="2" class="table-header">
  203. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  204. <tr valign="top">
  205. <td align="left"><span class="table-header">Static Methods</span></td>
  206. <td align="right" valign="top"
  207. ><span class="options">[<a href="#section-StaticMethods"
  208. class="privatelink" onclick="toggle_private();"
  209. >hide private</a>]</span></td>
  210. </tr>
  211. </table>
  212. </td>
  213. </tr>
  214. <tr>
  215. <td colspan="2" class="summary">
  216. <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioRenderable-class.html">AudioRenderable</a></code></b>:
  217. <code><a href="echonest.audio.AudioRenderable-class.html#init_audio_data">init_audio_data</a></code>
  218. </p>
  219. </td>
  220. </tr>
  221. </table>
  222. <!-- ==================== PROPERTIES ==================== -->
  223. <a name="section-Properties"></a>
  224. <table class="summary" border="1" cellpadding="3"
  225. cellspacing="0" width="100%" bgcolor="white">
  226. <tr bgcolor="#70b0f0" class="table-header">
  227. <td colspan="2" class="table-header">
  228. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  229. <tr valign="top">
  230. <td align="left"><span class="table-header">Properties</span></td>
  231. <td align="right" valign="top"
  232. ><span class="options">[<a href="#section-Properties"
  233. class="privatelink" onclick="toggle_private();"
  234. >hide private</a>]</span></td>
  235. </tr>
  236. </table>
  237. </td>
  238. </tr>
  239. <tr>
  240. <td colspan="2" class="summary">
  241. <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioData-class.html">AudioData</a></code></b>:
  242. <code><a href="echonest.audio.AudioData-class.html#duration">duration</a></code>,
  243. <code><a href="echonest.audio.AudioData-class.html#source">source</a></code>
  244. </p>
  245. <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
  246. <code>__class__</code>
  247. </p>
  248. </td>
  249. </tr>
  250. </table>
  251. <!-- ==================== METHOD DETAILS ==================== -->
  252. <a name="section-MethodDetails"></a>
  253. <table class="details" border="1" cellpadding="3"
  254. cellspacing="0" width="100%" bgcolor="white">
  255. <tr bgcolor="#70b0f0" class="table-header">
  256. <td colspan="2" class="table-header">
  257. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  258. <tr valign="top">
  259. <td align="left"><span class="table-header">Method Details</span></td>
  260. <td align="right" valign="top"
  261. ><span class="options">[<a href="#section-MethodDetails"
  262. class="privatelink" onclick="toggle_private();"
  263. >hide private</a>]</span></td>
  264. </tr>
  265. </table>
  266. </td>
  267. </tr>
  268. </table>
  269. <a name="__init__"></a>
  270. <div>
  271. <table class="details" border="1" cellpadding="3"
  272. cellspacing="0" width="100%" bgcolor="white">
  273. <tr><td>
  274. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  275. <tr valign="top"><td>
  276. <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
  277. <span class="sig-arg">filename</span>=<span class="sig-default">None</span>,
  278. <span class="sig-arg">ndarray</span>=<span class="sig-default">None</span>,
  279. <span class="sig-arg">shape</span>=<span class="sig-default">None</span>,
  280. <span class="sig-arg">sampleRate</span>=<span class="sig-default">None</span>,
  281. <span class="sig-arg">numChannels</span>=<span class="sig-default">None</span>,
  282. <span class="sig-arg">defer</span>=<span class="sig-default">False</span>,
  283. <span class="sig-arg">verbose</span>=<span class="sig-default">True</span>)</span>
  284. <br /><em class="fname">(Constructor)</em>
  285. </h3>
  286. </td><td align="right" valign="top"
  287. ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioData32.__init__">source&nbsp;code</a></span>&nbsp;
  288. </td>
  289. </tr></table>
  290. Special form of AudioData to allow for headroom when collecting samples.
  291. <dl class="fields">
  292. <dt>Parameters:</dt>
  293. <dd><ul class="nomargin-top">
  294. <li><strong class="pname"><code>filename</code></strong> - a path to an audio file for loading its sample
  295. data into the AudioData.data</li>
  296. <li><strong class="pname"><code>ndarray</code></strong> - a <a class="rst-rst-reference external 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>
  297. <li><strong class="pname"><code>shape</code></strong> - a tuple of array dimensions</li>
  298. <li><strong class="pname"><code>sampleRate</code></strong> - sample rate, in Hz</li>
  299. <li><strong class="pname"><code>numChannels</code></strong> - number of channels</li>
  300. </ul></dd>
  301. <dt>Overrides:
  302. object.__init__
  303. </dt>
  304. </dl>
  305. </td></tr></table>
  306. </div>
  307. <a name="load"></a>
  308. <div>
  309. <table class="details" border="1" cellpadding="3"
  310. cellspacing="0" width="100%" bgcolor="white">
  311. <tr><td>
  312. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  313. <tr valign="top"><td>
  314. <h3 class="epydoc"><span class="sig"><span class="sig-name">load</span>(<span class="sig-arg">self</span>)</span>
  315. </h3>
  316. </td><td align="right" valign="top"
  317. ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioData32.load">source&nbsp;code</a></span>&nbsp;
  318. </td>
  319. </tr></table>
  320. <dl class="fields">
  321. <dt>Overrides:
  322. <a href="echonest.audio.AudioData-class.html#load">AudioData.load</a>
  323. </dt>
  324. </dl>
  325. </td></tr></table>
  326. </div>
  327. <a name="encode"></a>
  328. <div>
  329. <table class="details" border="1" cellpadding="3"
  330. cellspacing="0" width="100%" bgcolor="white">
  331. <tr><td>
  332. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  333. <tr valign="top"><td>
  334. <h3 class="epydoc"><span class="sig"><span class="sig-name">encode</span>(<span class="sig-arg">self</span>,
  335. <span class="sig-arg">filename</span>=<span class="sig-default">None</span>,
  336. <span class="sig-arg">mp3</span>=<span class="sig-default">None</span>)</span>
  337. </h3>
  338. </td><td align="right" valign="top"
  339. ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioData32.encode">source&nbsp;code</a></span>&nbsp;
  340. </td>
  341. </tr></table>
  342. Outputs an MP3 or WAVE file to <code class="link">filename</code>.
  343. Format is determined by <code class="link">mp3</code> parameter.
  344. <dl class="fields">
  345. <dt>Overrides:
  346. <a href="echonest.audio.AudioRenderable-class.html#encode">AudioRenderable.encode</a>
  347. </dt>
  348. </dl>
  349. </td></tr></table>
  350. </div>
  351. <a name="pad_with_zeros"></a>
  352. <div>
  353. <table class="details" border="1" cellpadding="3"
  354. cellspacing="0" width="100%" bgcolor="white">
  355. <tr><td>
  356. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  357. <tr valign="top"><td>
  358. <h3 class="epydoc"><span class="sig"><span class="sig-name">pad_with_zeros</span>(<span class="sig-arg">self</span>,
  359. <span class="sig-arg">num_samples</span>)</span>
  360. </h3>
  361. </td><td align="right" valign="top"
  362. ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioData32.pad_with_zeros">source&nbsp;code</a></span>&nbsp;
  363. </td>
  364. </tr></table>
  365. <dl class="fields">
  366. <dt>Overrides:
  367. <a href="echonest.audio.AudioData-class.html#pad_with_zeros">AudioData.pad_with_zeros</a>
  368. </dt>
  369. </dl>
  370. </td></tr></table>
  371. </div>
  372. <br />
  373. <!-- ==================== NAVIGATION BAR ==================== -->
  374. <table class="navbar" border="0" width="100%" cellpadding="0"
  375. bgcolor="#a0c0ff" cellspacing="0">
  376. <tr valign="middle">
  377. <!-- Tree link -->
  378. <th>&nbsp;&nbsp;&nbsp;<a
  379. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  380. <!-- Index link -->
  381. <th>&nbsp;&nbsp;&nbsp;<a
  382. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  383. <!-- Help link -->
  384. <th>&nbsp;&nbsp;&nbsp;<a
  385. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  386. <!-- Project homepage -->
  387. <th class="navbar" align="right" width="100%">
  388. <table border="0" cellpadding="0" cellspacing="0">
  389. <tr><th class="navbar" align="center"
  390. ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
  391. </tr></table></th>
  392. </tr>
  393. </table>
  394. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  395. <tr>
  396. <td align="left" class="footer">
  397. Generated by Epydoc 3.0.1 on Wed Sep 1 16:08:58 2010
  398. </td>
  399. <td align="right" class="footer">
  400. <a target="mainFrame" href="http://epydoc.sourceforge.net"
  401. >http://epydoc.sourceforge.net</a>
  402. </td>
  403. </tr>
  404. </table>
  405. <script type="text/javascript">
  406. <!--
  407. // Private objects are initially displayed (because if
  408. // javascript is turned off then we want them to be
  409. // visible); but by default, we want to hide them. So hide
  410. // them unless we have a cookie that says to show them.
  411. checkCookie();
  412. // -->
  413. </script>
  414. </body>
  415. </html>