/apidocs/echonest.audio-module.html

http://echo-nest-remix.googlecode.com/ · HTML · 722 lines · 678 code · 33 blank · 11 comment · 0 complexity · 1c6398fead98a6cde005ea20209aeb61 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</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.         Module&nbsp;audio
    44. 

  44.       </span>
    45. 

  45.     </td>
    46. 

  46.     <td>
    47. 

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

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

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

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

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

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

  53.             >]&nbsp;|&nbsp;<a href="echonest.audio-module.html"
    54. 

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

  55.       </table>
    56. 

  56.     </td>
    57. 

  57.   </tr>
    58. 

  58. </table>
    59. 

  59. <!-- ==================== MODULE DESCRIPTION ==================== -->
    60. 

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

  61. <p>The main <a class="rst-rst-rst-reference external rst-rst-reference external rst-reference external" href="http://the.echonest.com/" target="_top">Echo Nest</a> <a class="rst-rst-rst-reference external rst-rst-reference external rst-reference external" href="http://code.google.com/p/echo-nest-remix/" target="_top">Remix API</a> module for manipulating audio files and
    62. 

  62. their associated <a class="rst-rst-rst-reference external rst-rst-reference external rst-reference external" href="http://the.echonest.com/" target="_top">Echo Nest</a> <a class="rst-rst-rst-reference external rst-rst-reference external rst-reference external" href="http://developer.echonest.com/pages/overview?version=2" target="_top">Analyze API</a> analyses.</p>
    63. 

  63. <p>AudioData, and getpieces by Robert Ochshorn
    64. 

  64. on 2008-06-06.  Some refactoring and everything else by Joshua Lifton
    65. 

  65. 2008-09-07.  Refactoring by Ben Lacker 2009-02-11. Other contributions
    66. 

  66. by Adam Lindsay.</p>
    67. 

  67. 

  68. <hr />
    69. 

  69. <div class="fields">      <p><strong>Version:</strong>
    70. 

  70.         $Revision: 0 $
    71. 

  71.       </p>
    72. 

  72. </div><!-- ==================== CLASSES ==================== -->
    73. 

  73. <a name="section-Classes"></a>
    74. 

  74. <table class="summary" border="1" cellpadding="3"
    75. 

  75.        cellspacing="0" width="100%" bgcolor="white">
    76. 

  76. <tr bgcolor="#70b0f0" class="table-header">
    77. 

  77.   <td colspan="2" class="table-header">
    78. 

  78.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    79. 

  79.       <tr valign="top">
    80. 

  80.         <td align="left"><span class="table-header">Classes</span></td>
    81. 

  81.         <td align="right" valign="top"
    82. 

  82.          ><span class="options">[<a href="#section-Classes"
    83. 

  83.          class="privatelink" onclick="toggle_private();"
    84. 

  84.          >hide private</a>]</span></td>
    85. 

  85.       </tr>
    86. 

  86.     </table>
    87. 

  87.   </td>
    88. 

  88. </tr>
    89. 

  89. <tr bgcolor="#e8f0f8" >
    90. 

  90.   <th colspan="2" class="group-header"
    91. 

  91.     >&nbsp;&nbsp;&nbsp;&nbsp;Base Classes</th></tr>
    92. 

  92. <tr>
    93. 

  93.     <td width="15%" align="right" valign="top" class="summary">
    94. 

  94.       <span class="summary-type">&nbsp;</span>
    95. 

  95.     </td><td class="summary">
    96. 

  96.         <a href="echonest.audio.AudioAnalysis-class.html" class="summary-name">AudioAnalysis</a><br />
    97. 

  97.       This class wraps <code class="link">echonest.web</code> to allow transparent caching of the
    98. 

  98. audio analysis of an audio file.
    99. 

  99.     </td>
    100. 

  100.   </tr>
    101. 

  101. <tr>
    102. 

  102.     <td width="15%" align="right" valign="top" class="summary">
    103. 

  103.       <span class="summary-type">&nbsp;</span>
    104. 

  104.     </td><td class="summary">
    105. 

  105.         <a href="echonest.audio.AudioRenderable-class.html" class="summary-name">AudioRenderable</a><br />
    106. 

  106.       An object that gives an <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> in response to a call to its <code class="link">render</code>()
    107. 

  107. method.
    108. 

  108.     </td>
    109. 

  109.   </tr>
    110. 

  110. <tr>
    111. 

  111.     <td width="15%" align="right" valign="top" class="summary">
    112. 

  112.       <span class="summary-type">&nbsp;</span>
    113. 

  113.     </td><td class="summary">
    114. 

  114.         <a href="echonest.audio.AudioData-class.html" class="summary-name">AudioData</a><br />
    115. 

  115.       Handles audio data transparently.
    116. 

  116.     </td>
    117. 

  117.   </tr>
    118. 

  118. <tr>
    119. 

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

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

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

  122.         <a href="echonest.audio.AudioData32-class.html" class="summary-name">AudioData32</a><br />
    123. 

  123.       A 32-bit variant of AudioData, intended for data collection on
    124. 

  124. audio rendering with headroom.
    125. 

  125.     </td>
    126. 

  126.   </tr>
    127. 

  127. <tr bgcolor="#e8f0f8" >
    128. 

  128.   <th colspan="2" class="group-header"
    129. 

  129.     >&nbsp;&nbsp;&nbsp;&nbsp;Audio-plus-Analysis Classes</th></tr>
    130. 

  130. <tr>
    131. 

  131.     <td width="15%" align="right" valign="top" class="summary">
    132. 

  132.       <span class="summary-type">&nbsp;</span>
    133. 

  133.     </td><td class="summary">
    134. 

  134.         <a href="echonest.audio.LocalAudioFile-class.html" class="summary-name">LocalAudioFile</a><br />
    135. 

  135.       The basic do-everything class for remixing.
    136. 

  136.     </td>
    137. 

  137.   </tr>
    138. 

  138. <tr>
    139. 

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

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

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

  142.         <a href="echonest.audio.LocalAnalysis-class.html" class="summary-name">LocalAnalysis</a><br />
    143. 

  143.       Like <a href="echonest.audio.LocalAudioFile-class.html" class="link">LocalAudioFile</a>, it conditionally uploads the file with which
    144. 

  144. it was initialized.
    145. 

  145.     </td>
    146. 

  146.   </tr>
    147. 

  147. <tr bgcolor="#e8f0f8" >
    148. 

  148.   <th colspan="2" class="group-header"
    149. 

  149.     >&nbsp;&nbsp;&nbsp;&nbsp;Building Blocks</th></tr>
    150. 

  150. <tr>
    151. 

  151.     <td width="15%" align="right" valign="top" class="summary">
    152. 

  152.       <span class="summary-type">&nbsp;</span>
    153. 

  153.     </td><td class="summary">
    154. 

  154.         <a href="echonest.audio.AudioQuantum-class.html" class="summary-name">AudioQuantum</a><br />
    155. 

  155.       A unit of musical time, identified at minimum with a start time and
    156. 

  156. a duration, both in seconds.
    157. 

  157.     </td>
    158. 

  158.   </tr>
    159. 

  159. <tr>
    160. 

  160.     <td width="15%" align="right" valign="top" class="summary">
    161. 

  161.       <span class="summary-type">&nbsp;</span>
    162. 

  162.     </td><td class="summary">
    163. 

  163.         <a href="echonest.audio.AudioSegment-class.html" class="summary-name">AudioSegment</a><br />
    164. 

  164.       Subclass of <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a> for the data-rich segments returned by
    165. 

  165. the Analyze API.
    166. 

  166.     </td>
    167. 

  167.   </tr>
    168. 

  168. <tr>
    169. 

  169.     <td width="15%" align="right" valign="top" class="summary">
    170. 

  170.       <span class="summary-type">&nbsp;</span>
    171. 

  171.     </td><td class="summary">
    172. 

  172.         <a href="echonest.audio.ModifiedRenderable-class.html" class="summary-name">ModifiedRenderable</a><br />
    173. 

  173.       Class that contains any AudioRenderable, but overrides the
    174. 

  174. render() method with nested effects, called sequentially on the
    175. 

  175. result of the preceeding effect.
    176. 

  176.     </td>
    177. 

  177.   </tr>
    178. 

  178. <tr>
    179. 

  179.     <td width="15%" align="right" valign="top" class="summary">
    180. 

  180.       <span class="summary-type">&nbsp;</span>
    181. 

  181.     </td><td class="summary">
    182. 

  182.         <a href="echonest.audio.AudioQuantumList-class.html" class="summary-name">AudioQuantumList</a><br />
    183. 

  183.       A container that enables content-based selection and filtering.
    184. 

  184.     </td>
    185. 

  185.   </tr>
    186. 

  186. <tr bgcolor="#e8f0f8" >
    187. 

  187.   <th colspan="2" class="group-header"
    188. 

  188.     >&nbsp;&nbsp;&nbsp;&nbsp;Effects</th></tr>
    189. 

  189. <tr>
    190. 

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

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

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

  193.         <a href="echonest.audio.AudioEffect-class.html" class="summary-name">AudioEffect</a>
    194. 

  194.     </td>
    195. 

  195.   </tr>
    196. 

  196. <tr>
    197. 

  197.     <td width="15%" align="right" valign="top" class="summary">
    198. 

  198.       <span class="summary-type">&nbsp;</span>
    199. 

  199.     </td><td class="summary">
    200. 

  200.         <a href="echonest.audio.LevelDB-class.html" class="summary-name">LevelDB</a>
    201. 

  201.     </td>
    202. 

  202.   </tr>
    203. 

  203. <tr>
    204. 

  204.     <td width="15%" align="right" valign="top" class="summary">
    205. 

  205.       <span class="summary-type">&nbsp;</span>
    206. 

  206.     </td><td class="summary">
    207. 

  207.         <a href="echonest.audio.AmplitudeFactor-class.html" class="summary-name">AmplitudeFactor</a>
    208. 

  208.     </td>
    209. 

  209.   </tr>
    210. 

  210. <tr>
    211. 

  211.     <td width="15%" align="right" valign="top" class="summary">
    212. 

  212.       <span class="summary-type">&nbsp;</span>
    213. 

  213.     </td><td class="summary">
    214. 

  214.         <a href="echonest.audio.TimeTruncateFactor-class.html" class="summary-name">TimeTruncateFactor</a>
    215. 

  215.     </td>
    216. 

  216.   </tr>
    217. 

  217. <tr>
    218. 

  218.     <td width="15%" align="right" valign="top" class="summary">
    219. 

  219.       <span class="summary-type">&nbsp;</span>
    220. 

  220.     </td><td class="summary">
    221. 

  221.         <a href="echonest.audio.TimeTruncateLength-class.html" class="summary-name">TimeTruncateLength</a>
    222. 

  222.     </td>
    223. 

  223.   </tr>
    224. 

  224. <tr>
    225. 

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

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

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

  228.         <a href="echonest.audio.Simultaneous-class.html" class="summary-name">Simultaneous</a><br />
    229. 

  229.       Stacks all contained AudioQuanta atop one another, adding their respective
    230. 

  230. samples.
    231. 

  231.     </td>
    232. 

  232.   </tr>
    233. 

  233. <tr bgcolor="#e8f0f8" >
    234. 

  234.   <th colspan="2" class="group-header"
    235. 

  235.     >&nbsp;&nbsp;&nbsp;&nbsp;Exception Classes</th></tr>
    236. 

  236. <tr>
    237. 

  237.     <td width="15%" align="right" valign="top" class="summary">
    238. 

  238.       <span class="summary-type">&nbsp;</span>
    239. 

  239.     </td><td class="summary">
    240. 

  240.         <a href="echonest.audio.FileTypeError-class.html" class="summary-name">FileTypeError</a>
    241. 

  241.     </td>
    242. 

  242.   </tr>
    243. 

  243. <tr>
    244. 

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

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

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

  247.         <a href="echonest.audio.EchoNestRemixError-class.html" class="summary-name">EchoNestRemixError</a><br />
    248. 

  248.       Error raised by the Remix API.
    249. 

  249.     </td>
    250. 

  250.   </tr>
    251. 

  251. </table>
    252. 

  252. <!-- ==================== FUNCTIONS ==================== -->
    253. 

  253. <a name="section-Functions"></a>
    254. 

  254. <table class="summary" border="1" cellpadding="3"
    255. 

  255.        cellspacing="0" width="100%" bgcolor="white">
    256. 

  256. <tr bgcolor="#70b0f0" class="table-header">
    257. 

  257.   <td colspan="2" class="table-header">
    258. 

  258.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    259. 

  259.       <tr valign="top">
    260. 

  260.         <td align="left"><span class="table-header">Functions</span></td>
    261. 

  261.         <td align="right" valign="top"
    262. 

  262.          ><span class="options">[<a href="#section-Functions"
    263. 

  263.          class="privatelink" onclick="toggle_private();"
    264. 

  264.          >hide private</a>]</span></td>
    265. 

  265.       </tr>
    266. 

  266.     </table>
    267. 

  267.   </td>
    268. 

  268. </tr>
    269. 

  269. <tr bgcolor="#e8f0f8" >
    270. 

  270.   <th colspan="2" class="group-header"
    271. 

  271.     >&nbsp;&nbsp;&nbsp;&nbsp;Audio helper functions</th></tr>
    272. 

  272. <tr>
    273. 

  273.     <td width="15%" align="right" valign="top" class="summary">
    274. 

  274.       <span class="summary-type">&nbsp;</span>
    275. 

  275.     </td><td class="summary">
    276. 

  276.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    277. 

  277.         <tr>
    278. 

  278.           <td><span class="summary-sig"><a href="echonest.audio-module.html#getpieces" class="summary-sig-name">getpieces</a>(<span class="summary-sig-arg">audioData</span>,
    279. 

  279.         <span class="summary-sig-arg">segs</span>)</span><br />
    280. 

  280.       Collects audio samples for output.</td>
    281. 

  281.           <td align="right" valign="top">
    282. 

  282.             <span class="codelink"><a href="echonest.audio-pysrc.html#getpieces">source&nbsp;code</a></span>
    283. 

  283.             
    284. 

  284.           </td>
    285. 

  285.         </tr>
    286. 

  286.       </table>
    287. 

  287.       
    288. 

  288.     </td>
    289. 

  289.   </tr>
    290. 

  290. <tr>
    291. 

  291.     <td width="15%" align="right" valign="top" class="summary">
    292. 

  292.       <span class="summary-type">&nbsp;</span>
    293. 

  293.     </td><td class="summary">
    294. 

  294.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    295. 

  295.         <tr>
    296. 

  296.           <td><span class="summary-sig"><a href="echonest.audio-module.html#assemble" class="summary-sig-name">assemble</a>(<span class="summary-sig-arg">audioDataList</span>,
    297. 

  297.         <span class="summary-sig-arg">numChannels</span>=<span class="summary-sig-default">1</span>,
    298. 

  298.         <span class="summary-sig-arg">sampleRate</span>=<span class="summary-sig-default">44100</span>)</span><br />
    299. 

  299.       Collects audio samples for output.</td>
    300. 

  300.           <td align="right" valign="top">
    301. 

  301.             <span class="codelink"><a href="echonest.audio-pysrc.html#assemble">source&nbsp;code</a></span>
    302. 

  302.             
    303. 

  303.           </td>
    304. 

  304.         </tr>
    305. 

  305.       </table>
    306. 

  306.       
    307. 

  307.     </td>
    308. 

  308.   </tr>
    309. 

  309. <tr>
    310. 

  310.     <td width="15%" align="right" valign="top" class="summary">
    311. 

  311.       <span class="summary-type">&nbsp;</span>
    312. 

  312.     </td><td class="summary">
    313. 

  313.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    314. 

  314.         <tr>
    315. 

  315.           <td><span class="summary-sig"><a href="echonest.audio-module.html#mix" class="summary-sig-name">mix</a>(<span class="summary-sig-arg">dataA</span>,
    316. 

  316.         <span class="summary-sig-arg">dataB</span>,
    317. 

  317.         <span class="summary-sig-arg">mix</span>=<span class="summary-sig-default">0.5</span>)</span><br />
    318. 

  318.       Mixes two <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> objects.</td>
    319. 

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

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

  321.             
    322. 

  322.           </td>
    323. 

  323.         </tr>
    324. 

  324.       </table>
    325. 

  325.       
    326. 

  326.     </td>
    327. 

  327.   </tr>
    328. 

  328. <tr>
    329. 

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

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

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

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

  333.         <tr>
    334. 

  334.           <td><span class="summary-sig"><a href="echonest.audio-module.html#megamix" class="summary-sig-name">megamix</a>(<span class="summary-sig-arg">dataList</span>)</span><br />
    335. 

  335.       Mix together any number of <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> objects.</td>
    336. 

  336.           <td align="right" valign="top">
    337. 

  337.             <span class="codelink"><a href="echonest.audio-pysrc.html#megamix">source&nbsp;code</a></span>
    338. 

  338.             
    339. 

  339.           </td>
    340. 

  340.         </tr>
    341. 

  341.       </table>
    342. 

  342.       
    343. 

  343.     </td>
    344. 

  344.   </tr>
    345. 

  345. <tr bgcolor="#e8f0f8" >
    346. 

  346.   <th colspan="2" class="group-header"
    347. 

  347.     >&nbsp;&nbsp;&nbsp;&nbsp;ffmpeg helper functions</th></tr>
    348. 

  348. <tr>
    349. 

  349.     <td width="15%" align="right" valign="top" class="summary">
    350. 

  350.       <span class="summary-type">&nbsp;</span>
    351. 

  351.     </td><td class="summary">
    352. 

  352.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    353. 

  353.         <tr>
    354. 

  354.           <td><span class="summary-sig"><a name="ffmpeg"></a><span class="summary-sig-name">ffmpeg</span>(<span class="summary-sig-arg">infile</span>,
    355. 

  355.         <span class="summary-sig-arg">outfile</span>=<span class="summary-sig-default">None</span>,
    356. 

  356.         <span class="summary-sig-arg">overwrite</span>=<span class="summary-sig-default">True</span>,
    357. 

  357.         <span class="summary-sig-arg">bitRate</span>=<span class="summary-sig-default">None</span>,
    358. 

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

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

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

  361.       Executes ffmpeg through the shell to convert or read media files.</td>
    362. 

  362.           <td align="right" valign="top">
    363. 

  363.             <span class="codelink"><a href="echonest.audio-pysrc.html#ffmpeg">source&nbsp;code</a></span>
    364. 

  364.             
    365. 

  365.           </td>
    366. 

  366.         </tr>
    367. 

  367.       </table>
    368. 

  368.       
    369. 

  369.     </td>
    370. 

  370.   </tr>
    371. 

  371. <tr>
    372. 

  372.     <td width="15%" align="right" valign="top" class="summary">
    373. 

  373.       <span class="summary-type">&nbsp;</span>
    374. 

  374.     </td><td class="summary">
    375. 

  375.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    376. 

  376.         <tr>
    377. 

  377.           <td><span class="summary-sig"><a name="settings_from_ffmpeg"></a><span class="summary-sig-name">settings_from_ffmpeg</span>(<span class="summary-sig-arg">parsestring</span>)</span><br />
    378. 

  378.       Parses the output of ffmpeg to determine sample rate and frequency of
    379. 

  379. an audio file.</td>
    380. 

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

  381.             <span class="codelink"><a href="echonest.audio-pysrc.html#settings_from_ffmpeg">source&nbsp;code</a></span>
    382. 

  382.             
    383. 

  383.           </td>
    384. 

  384.         </tr>
    385. 

  385.       </table>
    386. 

  386.       
    387. 

  387.     </td>
    388. 

  388.   </tr>
    389. 

  389. <tr>
    390. 

  390.     <td width="15%" align="right" valign="top" class="summary">
    391. 

  391.       <span class="summary-type">&nbsp;</span>
    392. 

  392.     </td><td class="summary">
    393. 

  393.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    394. 

  394.         <tr>
    395. 

  395.           <td><span class="summary-sig"><a name="ffmpeg_error_check"></a><span class="summary-sig-name">ffmpeg_error_check</span>(<span class="summary-sig-arg">parsestring</span>)</span><br />
    396. 

  396.       Looks for known errors in the ffmpeg output</td>
    397. 

  397.           <td align="right" valign="top">
    398. 

  398.             <span class="codelink"><a href="echonest.audio-pysrc.html#ffmpeg_error_check">source&nbsp;code</a></span>
    399. 

  399.             
    400. 

  400.           </td>
    401. 

  401.         </tr>
    402. 

  402.       </table>
    403. 

  403.       
    404. 

  404.     </td>
    405. 

  405.   </tr>
    406. 

  406. <tr bgcolor="#e8f0f8" >
    407. 

  407.   <th colspan="2" class="group-header"
    408. 

  408.     >&nbsp;&nbsp;&nbsp;&nbsp;Utility functions</th></tr>
    409. 

  409. <tr class="private">
    410. 

  410.     <td width="15%" align="right" valign="top" class="summary">
    411. 

  411.       <span class="summary-type">&nbsp;</span>
    412. 

  412.     </td><td class="summary">
    413. 

  413.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    414. 

  414.         <tr>
    415. 

  415.           <td><span class="summary-sig"><a name="_dataParser"></a><span class="summary-sig-name">_dataParser</span>(<span class="summary-sig-arg">tag</span>,
    416. 

  416.         <span class="summary-sig-arg">nodes</span>)</span></td>
    417. 

  417.           <td align="right" valign="top">
    418. 

  418.             <span class="codelink"><a href="echonest.audio-pysrc.html#_dataParser">source&nbsp;code</a></span>
    419. 

  419.             
    420. 

  420.           </td>
    421. 

  421.         </tr>
    422. 

  422.       </table>
    423. 

  423.       
    424. 

  424.     </td>
    425. 

  425.   </tr>
    426. 

  426. <tr class="private">
    427. 

  427.     <td width="15%" align="right" valign="top" class="summary">
    428. 

  428.       <span class="summary-type">&nbsp;</span>
    429. 

  429.     </td><td class="summary">
    430. 

  430.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    431. 

  431.         <tr>
    432. 

  432.           <td><span class="summary-sig"><a name="_attributeParser"></a><span class="summary-sig-name">_attributeParser</span>(<span class="summary-sig-arg">tag</span>,
    433. 

  433.         <span class="summary-sig-arg">nodes</span>)</span></td>
    434. 

  434.           <td align="right" valign="top">
    435. 

  435.             <span class="codelink"><a href="echonest.audio-pysrc.html#_attributeParser">source&nbsp;code</a></span>
    436. 

  436.             
    437. 

  437.           </td>
    438. 

  438.         </tr>
    439. 

  439.       </table>
    440. 

  440.       
    441. 

  441.     </td>
    442. 

  442.   </tr>
    443. 

  443. <tr class="private">
    444. 

  444.     <td width="15%" align="right" valign="top" class="summary">
    445. 

  445.       <span class="summary-type">&nbsp;</span>
    446. 

  446.     </td><td class="summary">
    447. 

  447.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    448. 

  448.         <tr>
    449. 

  449.           <td><span class="summary-sig"><a name="_segmentsParser"></a><span class="summary-sig-name">_segmentsParser</span>(<span class="summary-sig-arg">nodes</span>)</span></td>
    450. 

  450.           <td align="right" valign="top">
    451. 

  451.             <span class="codelink"><a href="echonest.audio-pysrc.html#_segmentsParser">source&nbsp;code</a></span>
    452. 

  452.             
    453. 

  453.           </td>
    454. 

  454.         </tr>
    455. 

  455.       </table>
    456. 

  456.       
    457. 

  457.     </td>
    458. 

  458.   </tr>
    459. 

  459. <tr>
    460. 

  460.     <td width="15%" align="right" valign="top" class="summary">
    461. 

  461.       <span class="summary-type">&nbsp;</span>
    462. 

  462.     </td><td class="summary">
    463. 

  463.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    464. 

  464.         <tr>
    465. 

  465.           <td><span class="summary-sig"><a name="chain_from_mixed"></a><span class="summary-sig-name">chain_from_mixed</span>(<span class="summary-sig-arg">iterables</span>)</span><br />
    466. 

  466.       Helper function to flatten a list of elements and lists
    467. 

  467. into a list of elements.</td>
    468. 

  468.           <td align="right" valign="top">
    469. 

  469.             <span class="codelink"><a href="echonest.audio-pysrc.html#chain_from_mixed">source&nbsp;code</a></span>
    470. 

  470.             
    471. 

  471.           </td>
    472. 

  472.         </tr>
    473. 

  473.       </table>
    474. 

  474.       
    475. 

  475.     </td>
    476. 

  476.   </tr>
    477. 

  477. </table>
    478. 

  478. <!-- ==================== VARIABLES ==================== -->
    479. 

  479. <a name="section-Variables"></a>
    480. 

  480. <table class="summary" border="1" cellpadding="3"
    481. 

  481.        cellspacing="0" width="100%" bgcolor="white">
    482. 

  482. <tr bgcolor="#70b0f0" class="table-header">
    483. 

  483.   <td colspan="2" class="table-header">
    484. 

  484.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    485. 

  485.       <tr valign="top">
    486. 

  486.         <td align="left"><span class="table-header">Variables</span></td>
    487. 

  487.         <td align="right" valign="top"
    488. 

  488.          ><span class="options">[<a href="#section-Variables"
    489. 

  489.          class="privatelink" onclick="toggle_private();"
    490. 

  490.          >hide private</a>]</span></td>
    491. 

  491.       </tr>
    492. 

  492.     </table>
    493. 

  493.   </td>
    494. 

  494. </tr>
    495. 

  495. <tr>
    496. 

  496.     <td width="15%" align="right" valign="top" class="summary">
    497. 

  497.       <span class="summary-type">&nbsp;</span>
    498. 

  498.     </td><td class="summary">
    499. 

  499.         <a href="echonest.audio-module.html#ffmpeg_install_instructions" class="summary-name">ffmpeg_install_instructions</a> = <code title="'''
    500. 

  500. en-ffmpeg not found! Please make sure ffmpeg is installed and create a\
    501. 

  501.  link as follows:
    502. 

  502.     sudo ln -s `which ffmpeg` /usr/local/bin/en-ffmpeg
    503. 

  503. '''"><code class="variable-quote">'</code><code class="variable-string">\nen-ffmpeg not found! Please m</code><code class="variable-ellipsis">...</code></code>
    504. 

  504.     </td>
    505. 

  505.   </tr>
    506. 

  506. <tr>
    507. 

  507.     <td width="15%" align="right" valign="top" class="summary">
    508. 

  508.       <span class="summary-type">&nbsp;</span>
    509. 

  509.     </td><td class="summary">
    510. 

  510.         <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'echonest'"><code class="variable-quote">'</code><code class="variable-string">echonest</code><code class="variable-quote">'</code></code>
    511. 

  511.     </td>
    512. 

  512.   </tr>
    513. 

  513. </table>
    514. 

  514. <!-- ==================== FUNCTION DETAILS ==================== -->
    515. 

  515. <a name="section-FunctionDetails"></a>
    516. 

  516. <table class="details" border="1" cellpadding="3"
    517. 

  517.        cellspacing="0" width="100%" bgcolor="white">
    518. 

  518. <tr bgcolor="#70b0f0" class="table-header">
    519. 

  519.   <td colspan="2" class="table-header">
    520. 

  520.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    521. 

  521.       <tr valign="top">
    522. 

  522.         <td align="left"><span class="table-header">Function Details</span></td>
    523. 

  523.         <td align="right" valign="top"
    524. 

  524.          ><span class="options">[<a href="#section-FunctionDetails"
    525. 

  525.          class="privatelink" onclick="toggle_private();"
    526. 

  526.          >hide private</a>]</span></td>
    527. 

  527.       </tr>
    528. 

  528.     </table>
    529. 

  529.   </td>
    530. 

  530. </tr>
    531. 

  531. </table>
    532. 

  532. <a name="getpieces"></a>
    533. 

  533. <div>
    534. 

  534. <table class="details" border="1" cellpadding="3"
    535. 

  535.        cellspacing="0" width="100%" bgcolor="white">
    536. 

  536. <tr><td>
    537. 

  537.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    538. 

  538.   <tr valign="top"><td>
    539. 

  539.   <h3 class="epydoc"><span class="sig"><span class="sig-name">getpieces</span>(<span class="sig-arg">audioData</span>,
    540. 

  540.         <span class="sig-arg">segs</span>)</span>
    541. 

  541.   </h3>
    542. 

  542.   </td><td align="right" valign="top"
    543. 

  543.     ><span class="codelink"><a href="echonest.audio-pysrc.html#getpieces">source&nbsp;code</a></span>&nbsp;
    544. 

  544.     </td>
    545. 

  545.   </tr></table>
    546. 

  546.   
    547. 

  547.   Collects audio samples for output.
    548. 

  548. Returns a new <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> where the new sample data is assembled
    549. 

  549. from the input audioData according to the time offsets in each
    550. 

  550. of the elements of the input segs (commonly an <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>).
    551. 

  551.   <dl class="fields">
    552. 

  552.     <dt>Parameters:</dt>
    553. 

  553.     <dd><ul class="nomargin-top">
    554. 

  554.         <li><strong class="pname"><code>audioData</code></strong> - an <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> object</li>
    555. 

  555.         <li><strong class="pname"><code>segs</code></strong> - an iterable containing objects that may be accessed
    556. 

  556. as slices or indices for an <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a></li>
    557. 

  557.     </ul></dd>
    558. 

  558.   </dl>
    559. 

  559. </td></tr></table>
    560. 

  560. </div>
    561. 

  561. <a name="assemble"></a>
    562. 

  562. <div>
    563. 

  563. <table class="details" border="1" cellpadding="3"
    564. 

  564.        cellspacing="0" width="100%" bgcolor="white">
    565. 

  565. <tr><td>
    566. 

  566.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    567. 

  567.   <tr valign="top"><td>
    568. 

  568.   <h3 class="epydoc"><span class="sig"><span class="sig-name">assemble</span>(<span class="sig-arg">audioDataList</span>,
    569. 

  569.         <span class="sig-arg">numChannels</span>=<span class="sig-default">1</span>,
    570. 

  570.         <span class="sig-arg">sampleRate</span>=<span class="sig-default">44100</span>)</span>
    571. 

  571.   </h3>
    572. 

  572.   </td><td align="right" valign="top"
    573. 

  573.     ><span class="codelink"><a href="echonest.audio-pysrc.html#assemble">source&nbsp;code</a></span>&nbsp;
    574. 

  574.     </td>
    575. 

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

  576.   
    577. 

  577.   Collects audio samples for output.
    578. 

  578. Returns a new <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> object assembled
    579. 

  579. by concatenating all the elements of audioDataList.
    580. 

  580.   <dl class="fields">
    581. 

  581.     <dt>Parameters:</dt>
    582. 

  582.     <dd><ul class="nomargin-top">
    583. 

  583.         <li><strong class="pname"><code>audioDatas</code></strong> - a list of <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> objects</li>
    584. 

  584.     </ul></dd>
    585. 

  585.   </dl>
    586. 

  586. </td></tr></table>
    587. 

  587. </div>
    588. 

  588. <a name="mix"></a>
    589. 

  589. <div>
    590. 

  590. <table class="details" border="1" cellpadding="3"
    591. 

  591.        cellspacing="0" width="100%" bgcolor="white">
    592. 

  592. <tr><td>
    593. 

  593.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    594. 

  594.   <tr valign="top"><td>
    595. 

  595.   <h3 class="epydoc"><span class="sig"><span class="sig-name">mix</span>(<span class="sig-arg">dataA</span>,
    596. 

  596.         <span class="sig-arg">dataB</span>,
    597. 

  597.         <span class="sig-arg">mix</span>=<span class="sig-default">0.5</span>)</span>
    598. 

  598.   </h3>
    599. 

  599.   </td><td align="right" valign="top"
    600. 

  600.     ><span class="codelink"><a href="echonest.audio-pysrc.html#mix">source&nbsp;code</a></span>&nbsp;
    601. 

  601.     </td>
    602. 

  602.   </tr></table>
    603. 

  603.   
    604. 

  604.   <p>Mixes two <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> objects. Assumes they have the same sample rate
    605. 

  605. and number of channels.</p>
    606. 

  606. <p>Mix takes a float 0-1 and determines the relative mix of two audios.
    607. 

  607. i.e., mix=0.9 yields greater presence of dataA in the final mix.</p>
    608. 

  608.   <dl class="fields">
    609. 

  609.   </dl>
    610. 

  610. </td></tr></table>
    611. 

  611. </div>
    612. 

  612. <a name="megamix"></a>
    613. 

  613. <div>
    614. 

  614. <table class="details" border="1" cellpadding="3"
    615. 

  615.        cellspacing="0" width="100%" bgcolor="white">
    616. 

  616. <tr><td>
    617. 

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

  618.   <tr valign="top"><td>
    619. 

  619.   <h3 class="epydoc"><span class="sig"><span class="sig-name">megamix</span>(<span class="sig-arg">dataList</span>)</span>
    620. 

  620.   </h3>
    621. 

  621.   </td><td align="right" valign="top"
    622. 

  622.     ><span class="codelink"><a href="echonest.audio-pysrc.html#megamix">source&nbsp;code</a></span>&nbsp;
    623. 

  623.     </td>
    624. 

  624.   </tr></table>
    625. 

  625.   
    626. 

  626.   Mix together any number of <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> objects. Keep the shape of
    627. 

  627. the first one in the list. Assume they all have the same sample rate
    628. 

  628. and number of channels.
    629. 

  629.   <dl class="fields">
    630. 

  630.   </dl>
    631. 

  631. </td></tr></table>
    632. 

  632. </div>
    633. 

  633. <br />
    634. 

  634. <!-- ==================== VARIABLES DETAILS ==================== -->
    635. 

  635. <a name="section-VariablesDetails"></a>
    636. 

  636. <table class="details" border="1" cellpadding="3"
    637. 

  637.        cellspacing="0" width="100%" bgcolor="white">
    638. 

  638. <tr bgcolor="#70b0f0" class="table-header">
    639. 

  639.   <td colspan="2" class="table-header">
    640. 

  640.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    641. 

  641.       <tr valign="top">
    642. 

  642.         <td align="left"><span class="table-header">Variables Details</span></td>
    643. 

  643.         <td align="right" valign="top"
    644. 

  644.          ><span class="options">[<a href="#section-VariablesDetails"
    645. 

  645.          class="privatelink" onclick="toggle_private();"
    646. 

  646.          >hide private</a>]</span></td>
    647. 

  647.       </tr>
    648. 

  648.     </table>
    649. 

  649.   </td>
    650. 

  650. </tr>
    651. 

  651. </table>
    652. 

  652. <a name="ffmpeg_install_instructions"></a>
    653. 

  653. <div>
    654. 

  654. <table class="details" border="1" cellpadding="3"
    655. 

  655.        cellspacing="0" width="100%" bgcolor="white">
    656. 

  656. <tr><td>
    657. 

  657.   <h3 class="epydoc">ffmpeg_install_instructions</h3>
    658. 

  658.   
    659. 

  659.   <dl class="fields">
    660. 

  660.   </dl>
    661. 

  661.   <dl class="fields">
    662. 

  662.     <dt>Value:</dt>
    663. 

  663.       <dd><table><tr><td><pre class="variable">
    664. 

  664. <code class="variable-quote">'''</code><code class="variable-string"></code>
    665. 

  665. <code class="variable-string">en-ffmpeg not found! Please make sure ffmpeg is installed and create a</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
    666. 

  666. <code class="variable-string"> link as follows:</code>
    667. 

  667. <code class="variable-string">    sudo ln -s `which ffmpeg` /usr/local/bin/en-ffmpeg</code>
    668. 

  668. <code class="variable-string"></code><code class="variable-quote">'''</code>
    669. 

  669. </pre></td></tr></table>
    670. 

  670. </dd>
    671. 

  671.   </dl>
    672. 

  672. </td></tr></table>
    673. 

  673. </div>
    674. 

  674. <br />
    675. 

  675. <!-- ==================== NAVIGATION BAR ==================== -->
    676. 

  676. <table class="navbar" border="0" width="100%" cellpadding="0"
    677. 

  677.        bgcolor="#a0c0ff" cellspacing="0">
    678. 

  678.   <tr valign="middle">
    679. 

  679. 

  680.   <!-- Tree link -->
    681. 

  681.       <th>&nbsp;&nbsp;&nbsp;<a
    682. 

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

  683. 

  684.   <!-- Index link -->
    685. 

  685.       <th>&nbsp;&nbsp;&nbsp;<a
    686. 

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

  687. 

  688.   <!-- Help link -->
    689. 

  689.       <th>&nbsp;&nbsp;&nbsp;<a
    690. 

  690.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    691. 

  691. 

  692.   <!-- Project homepage -->
    693. 

  693.       <th class="navbar" align="right" width="100%">
    694. 

  694.         <table border="0" cellpadding="0" cellspacing="0">
    695. 

  695.           <tr><th class="navbar" align="center"
    696. 

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

  697.           </tr></table></th>
    698. 

  698.   </tr>
    699. 

  699. </table>
    700. 

  700. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    701. 

  701.   <tr>
    702. 

  702.     <td align="left" class="footer">
    703. 

  703.     Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:57 2010
    704. 

  704.     </td>
    705. 

  705.     <td align="right" class="footer">
    706. 

  706.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    707. 

  707.         >http://epydoc.sourceforge.net</a>
    708. 

  708.     </td>
    709. 

  709.   </tr>
    710. 

  710. </table>
    711. 

  711. 

  712. <script type="text/javascript">
    713. 

  713.   <!--
    714. 

  714.   // Private objects are initially displayed (because if
    715. 

  715.   // javascript is turned off then we want them to be
    716. 

  716.   // visible); but by default, we want to hide them.  So hide
    717. 

  717.   // them unless we have a cookie that says to show them.
    718. 

  718.   checkCookie();
    719. 

  719.   // -->
    720. 

  720. </script>
    721. 

  721. </body>
    722. 

  722. </html>
    723.