py-mir-toolbox 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (291) hide show
  1. py_mir_toolbox-0.1.0/.github/workflows/ci.yml +34 -0
  2. py_mir_toolbox-0.1.0/.github/workflows/docs.yml +23 -0
  3. py_mir_toolbox-0.1.0/.github/workflows/fixtures.yml +45 -0
  4. py_mir_toolbox-0.1.0/.github/workflows/release.yml +109 -0
  5. py_mir_toolbox-0.1.0/.gitignore +33 -0
  6. py_mir_toolbox-0.1.0/CITATION.cff +50 -0
  7. py_mir_toolbox-0.1.0/LICENSE +28 -0
  8. py_mir_toolbox-0.1.0/Makefile +35 -0
  9. py_mir_toolbox-0.1.0/NOTICE +50 -0
  10. py_mir_toolbox-0.1.0/PKG-INFO +110 -0
  11. py_mir_toolbox-0.1.0/README.md +73 -0
  12. py_mir_toolbox-0.1.0/codemeta.json +70 -0
  13. py_mir_toolbox-0.1.0/docs/api.md +114 -0
  14. py_mir_toolbox-0.1.0/docs/chapters/B_basics.ipynb +124 -0
  15. py_mir_toolbox-0.1.0/docs/chapters/C3_dynamics.ipynb +438 -0
  16. py_mir_toolbox-0.1.0/docs/chapters/C4a_spectral_shape.ipynb +1229 -0
  17. py_mir_toolbox-0.1.0/docs/chapters/C4b_mfcc_flux_statistics.ipynb +878 -0
  18. py_mir_toolbox-0.1.0/docs/chapters/index.md +19 -0
  19. py_mir_toolbox-0.1.0/docs/coming_from_matlab.md +13 -0
  20. py_mir_toolbox-0.1.0/docs/conf.py +73 -0
  21. py_mir_toolbox-0.1.0/docs/credits.md +12 -0
  22. py_mir_toolbox-0.1.0/docs/getting_started.md +31 -0
  23. py_mir_toolbox-0.1.0/docs/index.md +56 -0
  24. py_mir_toolbox-0.1.0/docs/parity/results.json +1 -0
  25. py_mir_toolbox-0.1.0/docs/parity.md +61 -0
  26. py_mir_toolbox-0.1.0/docs/parity_report.py +145 -0
  27. py_mir_toolbox-0.1.0/pyproject.toml +98 -0
  28. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/+pitch/init.m +75 -0
  29. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/+pitch/main.m +16 -0
  30. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/+pitch/options.m +139 -0
  31. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/+pulseclarity/init.m +90 -0
  32. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/+pulseclarity/main.m +26 -0
  33. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/+pulseclarity/options.m +155 -0
  34. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/+spectrum/after.m +172 -0
  35. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/+spectrum/options.m +43 -0
  36. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/+tempo/init.m +100 -0
  37. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/+tempo/main.m +39 -0
  38. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/+tempo/options.m +253 -0
  39. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/@Envelope/Envelope.m +101 -0
  40. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/@Envelope/display.m +53 -0
  41. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/@Mfcc/Mfcc.m +49 -0
  42. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/@Pitch/Pitch.m +40 -0
  43. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/@Sequence/Sequence.m +29 -0
  44. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/attackleap.m +144 -0
  45. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/attackslope.m +157 -0
  46. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/attacktime.m +142 -0
  47. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/brightness.m +67 -0
  48. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/decayleap.m +138 -0
  49. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/decayslope.m +151 -0
  50. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/decaytime.m +136 -0
  51. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/display.m +75 -0
  52. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/duration.m +156 -0
  53. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/envelope.m +132 -0
  54. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/eventdensity.m +93 -0
  55. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/events.m +993 -0
  56. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/filterbank.m +224 -0
  57. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/fluctuation.m +90 -0
  58. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/flux.m +50 -0
  59. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/mfcc.m +117 -0
  60. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/param.m +7 -0
  61. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/paramstruct.m +15 -0
  62. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/pitch.m +32 -0
  63. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/pulseclarity.m +18 -0
  64. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/roughness.m +112 -0
  65. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/score.m +229 -0
  66. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/spectrum.m +14 -0
  67. py_mir_toolbox-0.1.0/reference/miningsuite/+aud/tempo.m +16 -0
  68. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/@Chromagram/Chromagram.m +86 -0
  69. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/@KeySOM/KeySOM.m +21 -0
  70. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/@KeySOM/display.m +44 -0
  71. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/@Keystrength/Keystrength.m +37 -0
  72. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/@Pitch/Pitch.m +72 -0
  73. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/@Sequence/Sequence.m +107 -0
  74. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/@mode/mode.m +67 -0
  75. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/@scale/scale.m +203 -0
  76. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/autocor.m +66 -0
  77. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/chromagram.m +327 -0
  78. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/display.m +689 -0
  79. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/gomezprofs.mat +0 -0
  80. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/group.m +287 -0
  81. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/hcdf.m +40 -0
  82. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/key.m +80 -0
  83. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/keysom.m +65 -0
  84. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/keysomaudiodata.mat +0 -0
  85. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/keystrength.m +83 -0
  86. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/majorness.m +77 -0
  87. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/midi2nmat.m +1013 -0
  88. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/modal.m +206 -0
  89. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/output.m +212 -0
  90. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/param.m +40 -0
  91. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/paramstruct.m +139 -0
  92. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/pianoroll.m +290 -0
  93. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/pitch.m +91 -0
  94. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/play.m +61 -0
  95. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/pulseclarity.m +73 -0
  96. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/score.m +721 -0
  97. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/sequence.m +322 -0
  98. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/spectrum.m +137 -0
  99. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/tempo.m +75 -0
  100. py_mir_toolbox-0.1.0/reference/miningsuite/+mus/tonalcentroid.m +61 -0
  101. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+autocor/after.m +57 -0
  102. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+autocor/combinechunks.m +24 -0
  103. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+autocor/init.m +15 -0
  104. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+autocor/main.m +187 -0
  105. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+autocor/options.m +66 -0
  106. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+centroid/algo.m +3 -0
  107. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+envelope/after.m +83 -0
  108. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+envelope/diff.m +32 -0
  109. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+envelope/init.m +48 -0
  110. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+envelope/main.m +65 -0
  111. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+envelope/options.m +168 -0
  112. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+envelope/resample.m +51 -0
  113. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+envelope/rescale.m +20 -0
  114. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+envelope/upsample.m +34 -0
  115. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+filterbank/main.m +74 -0
  116. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+filterbank/options.m +37 -0
  117. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+filterbank/specif.m +62 -0
  118. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+flux/main.m +87 -0
  119. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+flux/options.m +51 -0
  120. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+signal/options.m +76 -0
  121. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+spectrum/after1.m +121 -0
  122. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+spectrum/after2.m +87 -0
  123. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+spectrum/init.m +14 -0
  124. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+spectrum/main.m +192 -0
  125. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+spectrum/options.m +160 -0
  126. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/+spread/algo.m +13 -0
  127. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Autocor/Autocor.m +65 -0
  128. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Autocor/enhance.m +137 -0
  129. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Autocor/normalize.m +22 -0
  130. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Cepstrum/Cepstrum.m +60 -0
  131. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Crosscor/Crosscor.m +35 -0
  132. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Crosscor/display.m +53 -0
  133. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Envelope/Envelope.m +50 -0
  134. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/Signal.m +631 -0
  135. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/center.m +8 -0
  136. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/channel.m +26 -0
  137. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/detrend.m +30 -0
  138. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/display.m +503 -0
  139. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/extract.m +79 -0
  140. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/fwr.m +16 -0
  141. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/halfwave.m +8 -0
  142. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/median.m +9 -0
  143. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/resample.m +20 -0
  144. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/saveclass.m +16 -0
  145. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/selectfile.m +15 -0
  146. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/sindex.m +13 -0
  147. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/sum.m +8 -0
  148. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Signal/trim.m +57 -0
  149. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Simatrix/Simatrix.m +27 -0
  150. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Simatrix/display.m +23 -0
  151. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Spectrum/Spectrum.m +89 -0
  152. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Spectrum/playclass.m +16 -0
  153. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@Spectrum/saveclass.m +16 -0
  154. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@axis/axis.m +91 -0
  155. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@data/apply.m +236 -0
  156. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@data/data.m +392 -0
  157. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@data/median.m +20 -0
  158. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@data/scanargin.m +64 -0
  159. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@data/select.m +68 -0
  160. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@defaults/defaults.m +44 -0
  161. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@design/design.m +378 -0
  162. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@position/position.m +12 -0
  163. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@subunit/subunit.m +28 -0
  164. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@sync/sync.m +279 -0
  165. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/@unit/unit.m +68 -0
  166. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/autocor.m +13 -0
  167. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/centroid.m +92 -0
  168. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/cepstrum.m +170 -0
  169. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/chunklim.m +26 -0
  170. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/compute.m +79 -0
  171. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/convolve2.m +222 -0
  172. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/crosscor.m +134 -0
  173. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/cumsum.m +53 -0
  174. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/entropy.m +75 -0
  175. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/envelope.m +50 -0
  176. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/evaleach.m +463 -0
  177. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/events.m +381 -0
  178. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/filterbank.m +31 -0
  179. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/flatness.m +66 -0
  180. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/flux.m +56 -0
  181. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/frame.m +214 -0
  182. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/getdata.m +16 -0
  183. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/getflength.m +20 -0
  184. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/getfrate.m +32 -0
  185. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/histogram.m +90 -0
  186. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/kurtosis.m +60 -0
  187. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/length.m +68 -0
  188. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/mean.m +57 -0
  189. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/median.m +57 -0
  190. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/norm.m +63 -0
  191. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/novelty.m +243 -0
  192. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/operate.m +112 -0
  193. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/options.m +216 -0
  194. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/peaks.m +337 -0
  195. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/play.m +103 -0
  196. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/read.m +85 -0
  197. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/recent.m +9 -0
  198. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/rms.m +100 -0
  199. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/rolloff.m +80 -0
  200. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/save.m +30 -0
  201. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/savefile.m +64 -0
  202. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/segment.m +251 -0
  203. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/signal.m +38 -0
  204. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/simatrix.m +286 -0
  205. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/skewness.m +60 -0
  206. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/spectrum.m +24 -0
  207. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/spread.m +54 -0
  208. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/std.m +57 -0
  209. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/sum.m +70 -0
  210. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/warning.m +17 -0
  211. py_mir_toolbox-0.1.0/reference/miningsuite/+sig/zerocross.m +103 -0
  212. py_mir_toolbox-0.1.0/reference/miningsuite/LICENSE.txt +7 -0
  213. py_mir_toolbox-0.1.0/reference/miningsuite/README.txt +25 -0
  214. py_mir_toolbox-0.1.0/reference/miningsuite/UPSTREAM_COMMIT +1 -0
  215. py_mir_toolbox-0.1.0/src/mirpy/__init__.py +84 -0
  216. py_mir_toolbox-0.1.0/src/mirpy/_cite.py +41 -0
  217. py_mir_toolbox-0.1.0/src/mirpy/_vendor/LICENSE-APACHE-2.0.txt +202 -0
  218. py_mir_toolbox-0.1.0/src/mirpy/_vendor/__init__.py +1 -0
  219. py_mir_toolbox-0.1.0/src/mirpy/_vendor/auditory_toolbox.py +205 -0
  220. py_mir_toolbox-0.1.0/src/mirpy/_version.py +24 -0
  221. py_mir_toolbox-0.1.0/src/mirpy/core/__init__.py +1 -0
  222. py_mir_toolbox-0.1.0/src/mirpy/core/audio_ops.py +222 -0
  223. py_mir_toolbox-0.1.0/src/mirpy/core/batch.py +157 -0
  224. py_mir_toolbox-0.1.0/src/mirpy/core/data.py +314 -0
  225. py_mir_toolbox-0.1.0/src/mirpy/core/display.py +103 -0
  226. py_mir_toolbox-0.1.0/src/mirpy/core/export.py +199 -0
  227. py_mir_toolbox-0.1.0/src/mirpy/core/framing.py +122 -0
  228. py_mir_toolbox-0.1.0/src/mirpy/core/matlab_compat.py +113 -0
  229. py_mir_toolbox-0.1.0/src/mirpy/core/options.py +130 -0
  230. py_mir_toolbox-0.1.0/src/mirpy/core/peaks.py +329 -0
  231. py_mir_toolbox-0.1.0/src/mirpy/features/__init__.py +1 -0
  232. py_mir_toolbox-0.1.0/src/mirpy/features/_common.py +89 -0
  233. py_mir_toolbox-0.1.0/src/mirpy/features/dynamics.py +138 -0
  234. py_mir_toolbox-0.1.0/src/mirpy/features/flux.py +197 -0
  235. py_mir_toolbox-0.1.0/src/mirpy/features/mfcc.py +142 -0
  236. py_mir_toolbox-0.1.0/src/mirpy/features/moments.py +285 -0
  237. py_mir_toolbox-0.1.0/src/mirpy/features/spectral.py +126 -0
  238. py_mir_toolbox-0.1.0/src/mirpy/features/zerocross.py +76 -0
  239. py_mir_toolbox-0.1.0/src/mirpy/signal/__init__.py +1 -0
  240. py_mir_toolbox-0.1.0/src/mirpy/signal/_lag_axis.py +13 -0
  241. py_mir_toolbox-0.1.0/src/mirpy/signal/auditory_bands.py +93 -0
  242. py_mir_toolbox-0.1.0/src/mirpy/signal/autocor.py +285 -0
  243. py_mir_toolbox-0.1.0/src/mirpy/signal/cepstrum.py +128 -0
  244. py_mir_toolbox-0.1.0/src/mirpy/signal/filterbank.py +233 -0
  245. py_mir_toolbox-0.1.0/src/mirpy/signal/spectrum.py +312 -0
  246. py_mir_toolbox-0.1.0/src/mirpy/signal/summation.py +64 -0
  247. py_mir_toolbox-0.1.0/src/mirpy/stats/__init__.py +1 -0
  248. py_mir_toolbox-0.1.0/src/mirpy/stats/histo.py +109 -0
  249. py_mir_toolbox-0.1.0/src/mirpy/stats/summary.py +230 -0
  250. py_mir_toolbox-0.1.0/tests/parity/__init__.py +0 -0
  251. py_mir_toolbox-0.1.0/tests/parity/cases.py +51 -0
  252. py_mir_toolbox-0.1.0/tests/parity/conftest.py +67 -0
  253. py_mir_toolbox-0.1.0/tests/parity/harness.py +269 -0
  254. py_mir_toolbox-0.1.0/tests/parity/test_convert.py +130 -0
  255. py_mir_toolbox-0.1.0/tests/parity/test_harness.py +105 -0
  256. py_mir_toolbox-0.1.0/tests/parity/test_phase1.py +164 -0
  257. py_mir_toolbox-0.1.0/tests/parity/test_phase2.py +152 -0
  258. py_mir_toolbox-0.1.0/tests/parity/test_report_page.py +69 -0
  259. py_mir_toolbox-0.1.0/tests/synthetic/test_audio_ops.py +150 -0
  260. py_mir_toolbox-0.1.0/tests/synthetic/test_autocor.py +174 -0
  261. py_mir_toolbox-0.1.0/tests/synthetic/test_batch.py +107 -0
  262. py_mir_toolbox-0.1.0/tests/synthetic/test_cepstrum.py +64 -0
  263. py_mir_toolbox-0.1.0/tests/synthetic/test_data.py +53 -0
  264. py_mir_toolbox-0.1.0/tests/synthetic/test_display.py +55 -0
  265. py_mir_toolbox-0.1.0/tests/synthetic/test_dynamics.py +80 -0
  266. py_mir_toolbox-0.1.0/tests/synthetic/test_export.py +88 -0
  267. py_mir_toolbox-0.1.0/tests/synthetic/test_filterbank.py +146 -0
  268. py_mir_toolbox-0.1.0/tests/synthetic/test_flux.py +119 -0
  269. py_mir_toolbox-0.1.0/tests/synthetic/test_framing.py +111 -0
  270. py_mir_toolbox-0.1.0/tests/synthetic/test_matlab_compat.py +68 -0
  271. py_mir_toolbox-0.1.0/tests/synthetic/test_mfcc.py +71 -0
  272. py_mir_toolbox-0.1.0/tests/synthetic/test_moments.py +120 -0
  273. py_mir_toolbox-0.1.0/tests/synthetic/test_peaks.py +282 -0
  274. py_mir_toolbox-0.1.0/tests/synthetic/test_spectral_features.py +58 -0
  275. py_mir_toolbox-0.1.0/tests/synthetic/test_spectrum.py +169 -0
  276. py_mir_toolbox-0.1.0/tests/synthetic/test_stats.py +135 -0
  277. py_mir_toolbox-0.1.0/tests/synthetic/test_zerocross.py +45 -0
  278. py_mir_toolbox-0.1.0/tests/test_cite.py +11 -0
  279. py_mir_toolbox-0.1.0/tests/test_metadata.py +48 -0
  280. py_mir_toolbox-0.1.0/uv.lock +2908 -0
  281. py_mir_toolbox-0.1.0/validation/README.md +65 -0
  282. py_mir_toolbox-0.1.0/validation/convert_matlab_fixtures.py +90 -0
  283. py_mir_toolbox-0.1.0/validation/generate_fixtures.py +96 -0
  284. py_mir_toolbox-0.1.0/validation/mirtoolbox_fixtures.m +252 -0
  285. py_mir_toolbox-0.1.0/validation/phase1_cases.tsv +61 -0
  286. py_mir_toolbox-0.1.0/validation/phase2_cases.tsv +47 -0
  287. py_mir_toolbox-0.1.0/validation/phase3_cases.tsv +26 -0
  288. py_mir_toolbox-0.1.0/validation/phase4_cases.tsv +22 -0
  289. py_mir_toolbox-0.1.0/validation/phase5_cases.tsv +49 -0
  290. py_mir_toolbox-0.1.0/validation/phase6_cases.tsv +21 -0
  291. py_mir_toolbox-0.1.0/validation/phase7_cases.tsv +8 -0
@@ -0,0 +1,34 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+
8
+ permissions:
9
+ contents: read
10
+
11
+ jobs:
12
+ lint:
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - uses: actions/checkout@v5
16
+ - uses: astral-sh/setup-uv@v6
17
+ - run: uvx ruff check .
18
+ - run: uvx ruff format --check .
19
+
20
+ test:
21
+ runs-on: ${{ matrix.os }}
22
+ strategy:
23
+ fail-fast: false
24
+ matrix:
25
+ os: [ubuntu-latest, macos-latest, windows-latest]
26
+ python-version: ["3.12", "3.13", "3.14"]
27
+ steps:
28
+ - uses: actions/checkout@v5
29
+ with:
30
+ fetch-depth: 0
31
+ - uses: astral-sh/setup-uv@v6
32
+ with:
33
+ python-version: ${{ matrix.python-version }}
34
+ - run: uv run --group test pytest --doctest-modules src tests
@@ -0,0 +1,23 @@
1
+ name: Docs
2
+
3
+ # Checks that the documentation builds without warnings. The site itself is
4
+ # deployed to CCRMA by hand with `make deploy`.
5
+ on:
6
+ push:
7
+ branches: [main]
8
+ pull_request:
9
+
10
+ permissions:
11
+ contents: read
12
+
13
+ jobs:
14
+ build:
15
+ runs-on: ubuntu-latest
16
+ steps:
17
+ - uses: actions/checkout@v5
18
+ with:
19
+ fetch-depth: 0
20
+ - uses: astral-sh/setup-uv@v6
21
+ with:
22
+ python-version: "3.12"
23
+ - run: make docs
@@ -0,0 +1,45 @@
1
+ name: Generate MIRtoolbox fixtures
2
+
3
+ # Started by hand: downloads the MATLAB Runtime (several GB) and runs
4
+ # MIRtoolbox 1.8.2 through pymirtoolbox. See validation/README.md.
5
+ on:
6
+ workflow_dispatch:
7
+ inputs:
8
+ runtime_url:
9
+ description: "URL of the MATLAB Runtime R2025b installer zip for glnxa64 (from mathworks.com)"
10
+ required: true
11
+ audio_dir:
12
+ description: "Directory of WAV files in this repository to analyse"
13
+ required: true
14
+ default: "validation/audio"
15
+
16
+ permissions:
17
+ contents: read
18
+
19
+ env:
20
+ RUNTIME_ROOT: /usr/local/MATLAB/MATLAB_Runtime/R2025b
21
+
22
+ jobs:
23
+ fixtures:
24
+ runs-on: ubuntu-latest
25
+ steps:
26
+ - uses: actions/checkout@v5
27
+ - name: Install MATLAB Runtime
28
+ run: |
29
+ wget -q -O runtime.zip "${{ inputs.runtime_url }}"
30
+ unzip -qq -d runtime runtime.zip
31
+ sudo ./runtime/install -agreeToLicense yes
32
+ for d in runtime/glnxa64 bin/glnxa64 sys/os/glnxa64 extern/bin/glnxa64; do
33
+ echo "LD_LIBRARY_PATH=${RUNTIME_ROOT}/$d:${LD_LIBRARY_PATH}" >> "$GITHUB_ENV"
34
+ done
35
+ - uses: actions/setup-python@v6
36
+ with:
37
+ python-version: "3.12"
38
+ - name: Install pymirtoolbox
39
+ run: pip install numpy git+https://github.com/frshdjfry/pymirtoolbox
40
+ - name: Generate fixtures
41
+ run: python validation/generate_fixtures.py --audio-dir "${{ inputs.audio_dir }}" --out-dir validation/fixtures
42
+ - uses: actions/upload-artifact@v4
43
+ with:
44
+ name: mirtoolbox-1.8.2-fixtures
45
+ path: validation/fixtures/
@@ -0,0 +1,109 @@
1
+ name: Release
2
+
3
+ on:
4
+ push:
5
+ tags: ["v*"]
6
+
7
+ permissions:
8
+ contents: read
9
+
10
+ jobs:
11
+ build:
12
+ runs-on: ubuntu-latest
13
+ steps:
14
+ - uses: actions/checkout@v5
15
+ with:
16
+ fetch-depth: 0
17
+ persist-credentials: false
18
+ - uses: astral-sh/setup-uv@v6
19
+ - run: uv build
20
+ - uses: actions/upload-artifact@v4
21
+ with:
22
+ name: dist
23
+ path: dist/
24
+
25
+ publish-testpypi:
26
+ needs: build
27
+ runs-on: ubuntu-latest
28
+ environment: testpypi
29
+ permissions:
30
+ id-token: write
31
+ steps:
32
+ - uses: actions/download-artifact@v5
33
+ with:
34
+ name: dist
35
+ path: dist/
36
+ - uses: pypa/gh-action-pypi-publish@release/v1
37
+ with:
38
+ repository-url: https://test.pypi.org/legacy/
39
+ skip-existing: true # a re-run after a failed install check finds this version there
40
+
41
+ install-testpypi:
42
+ # Install the TestPyPI upload in a clean venv on each OS before publishing
43
+ # to PyPI. No checkout, so the installed package is tested, not the source.
44
+ needs: publish-testpypi
45
+ runs-on: ${{ matrix.os }}
46
+ strategy:
47
+ fail-fast: false
48
+ matrix:
49
+ os: [ubuntu-latest, macos-latest, windows-latest]
50
+ python-version: ["3.12", "3.14"] # lowest and highest supported
51
+ defaults:
52
+ run:
53
+ shell: bash
54
+ env:
55
+ TESTPYPI: https://test.pypi.org/simple/
56
+ PACKAGE: py-mir-toolbox
57
+ INDEX_ATTEMPTS: 5
58
+ INDEX_WAIT_SECONDS: 30
59
+ steps:
60
+ - uses: astral-sh/setup-uv@v6
61
+ with:
62
+ enable-cache: false # a clean install, nothing restored from earlier runs
63
+ - name: Create a clean venv
64
+ run: |
65
+ uv venv clean-venv --python ${{ matrix.python-version }}
66
+ if [ "$RUNNER_OS" = Windows ]; then py=clean-venv/Scripts/python.exe; else py=clean-venv/bin/python; fi
67
+ echo "PY=$py" >> "$GITHUB_ENV"
68
+ echo "VERSION=${GITHUB_REF_NAME#v}" >> "$GITHUB_ENV"
69
+ - name: Install the package from TestPyPI
70
+ # Only the package comes from TestPyPI (--no-deps); its dependencies come
71
+ # from PyPI, so a look-alike upload on TestPyPI cannot replace them.
72
+ run: |
73
+ for attempt in $(seq "$INDEX_ATTEMPTS"); do
74
+ uv pip install --python "$PY" --no-deps --index-url "$TESTPYPI" "$PACKAGE==$VERSION" && break
75
+ [ "$attempt" = "$INDEX_ATTEMPTS" ] && exit 1
76
+ sleep "$INDEX_WAIT_SECONDS" # the upload can take a minute to be listed
77
+ done
78
+ "$PY" -c "import importlib.metadata as m; print('\n'.join(m.requires('$PACKAGE') or []))" > requirements.txt
79
+ uv pip install --python "$PY" -r requirements.txt
80
+ - name: Smoke test
81
+ run: |
82
+ "$PY" - <<'PY'
83
+ import importlib.metadata
84
+ import os
85
+
86
+ import numpy as np
87
+
88
+ import mirpy as mir
89
+
90
+ assert importlib.metadata.version(os.environ["PACKAGE"]) == os.environ["VERSION"]
91
+ sr = 22050
92
+ sine = np.sin(2 * np.pi * 440 * np.arange(sr) / sr)
93
+ rms = mir.rms(mir.Audio.from_array(sine, sr=sr)).data.item()
94
+ assert abs(rms - 1 / np.sqrt(2)) < 1e-3, rms
95
+ print("mirpy", mir.__version__, "rms", rms)
96
+ PY
97
+
98
+ publish-pypi:
99
+ needs: install-testpypi
100
+ runs-on: ubuntu-latest
101
+ environment: pypi
102
+ permissions:
103
+ id-token: write
104
+ steps:
105
+ - uses: actions/download-artifact@v5
106
+ with:
107
+ name: dist
108
+ path: dist/
109
+ - uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,33 @@
1
+ # Original MIRtoolbox (GPL-2.0, ~86 MB with binaries): reading reference only, never committed
2
+ reference/MIRtoolbox1.8.2/
3
+
4
+ # Private outreach drafts
5
+ drafts/
6
+
7
+ # Interactive website: deployed to CCRMA only (make deploy), not published on GitHub
8
+ site/
9
+
10
+ # Python
11
+ __pycache__/
12
+ *.py[cod]
13
+ .venv/
14
+ build/
15
+ dist/
16
+ *.egg-info/
17
+ .pytest_cache/
18
+ .ruff_cache/
19
+ .coverage
20
+
21
+ # Docs
22
+ docs/_build/
23
+ docs/jupyter_execute/
24
+
25
+ # Validation fixtures live in a separate repository
26
+ validation/fixtures/
27
+ validation/mirtoolbox_mat/
28
+ validation/*_probe.mat
29
+
30
+ .DS_Store
31
+ src/mirpy/_version.py
32
+ _site/
33
+ docs/generated/
@@ -0,0 +1,50 @@
1
+ cff-version: 1.2.0
2
+ message: "If you use py-mir-toolbox, please cite it and the original MIRtoolbox papers listed under references."
3
+ title: "py-mir-toolbox: a Python port of MIRtoolbox"
4
+ type: software
5
+ authors:
6
+ - family-names: "Gómez-Cañón"
7
+ given-names: "Juan Sebastián"
8
+ orcid: "https://orcid.org/0000-0002-2544-6311"
9
+ license: BSD-3-Clause
10
+ repository-code: "https://github.com/juansgomez87/py-mir-toolbox"
11
+ url: "https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox"
12
+ keywords:
13
+ - music information retrieval
14
+ - music psychology
15
+ - audio feature extraction
16
+ - MIRtoolbox
17
+ references:
18
+ - type: conference-paper
19
+ title: "A Matlab Toolbox for Musical Feature Extraction from Audio"
20
+ authors:
21
+ - family-names: "Lartillot"
22
+ given-names: "Olivier"
23
+ - family-names: "Toiviainen"
24
+ given-names: "Petri"
25
+ collection-title: "Proceedings of the 10th International Conference on Digital Audio Effects (DAFx-07)"
26
+ conference:
27
+ name: "DAFx-07"
28
+ city: "Bordeaux"
29
+ country: "FR"
30
+ year: 2007
31
+ - type: book
32
+ title: "A Matlab Toolbox for Music Information Retrieval"
33
+ authors:
34
+ - family-names: "Lartillot"
35
+ given-names: "Olivier"
36
+ - family-names: "Toiviainen"
37
+ given-names: "Petri"
38
+ - family-names: "Eerola"
39
+ given-names: "Tuomas"
40
+ collection-title: "Data Analysis, Machine Learning and Applications"
41
+ publisher:
42
+ name: "Springer"
43
+ year: 2008
44
+ - type: software
45
+ title: "MiningSuite"
46
+ authors:
47
+ - family-names: "Lartillot"
48
+ given-names: "Olivier"
49
+ license: BSD-3-Clause
50
+ repository-code: "https://github.com/olivierlar/miningsuite"
@@ -0,0 +1,28 @@
1
+ BSD 3-Clause License
2
+
3
+ Copyright (c) 2026, Juan Sebastián Gómez-Cañón and the py-mir-toolbox contributors
4
+
5
+ Redistribution and use in source and binary forms, with or without
6
+ modification, are permitted provided that the following conditions are met:
7
+
8
+ 1. Redistributions of source code must retain the above copyright notice, this
9
+ list of conditions and the following disclaimer.
10
+
11
+ 2. Redistributions in binary form must reproduce the above copyright notice,
12
+ this list of conditions and the following disclaimer in the documentation
13
+ and/or other materials provided with the distribution.
14
+
15
+ 3. Neither the name of the copyright holder nor the names of its
16
+ contributors may be used to endorse or promote products derived from
17
+ this software without specific prior written permission.
18
+
19
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,35 @@
1
+ # Build and deploy the interactive site (site/) with the Sphinx docs under /docs/.
2
+ # make site build everything into _site/
3
+ # make deploy copy _site/ to the CCRMA web space (needs SSH access)
4
+ # make parity-report compare with the local MIRtoolbox fixtures and save the
5
+ # results shown on the docs Parity report page
6
+
7
+ SITE_DIR := _site
8
+ CCRMA_HOST ?= ccrma-gate.stanford.edu
9
+ CCRMA_USER ?= jsgomezc
10
+ CCRMA_PATH ?= Library/Web/py-mir-toolbox
11
+ FIXTURES_DIR ?= validation/fixtures
12
+ PARITY_JSON := docs/parity/results.json
13
+
14
+ .PHONY: docs site deploy clean parity-report
15
+
16
+ docs:
17
+ uv run --group docs sphinx-build -W -b html docs docs/_build/html
18
+
19
+ site: docs
20
+ rm -rf $(SITE_DIR)
21
+ cp -R site $(SITE_DIR)
22
+ cp -R docs/_build/html $(SITE_DIR)/docs
23
+
24
+ deploy: site
25
+ rsync -avz --delete $(SITE_DIR)/ $(CCRMA_USER)@$(CCRMA_HOST):$(CCRMA_PATH)/
26
+
27
+ # The parity run exits non-zero while a case fails (e.g. the accepted
28
+ # filterbank_2channels difference); the report is written either way.
29
+ parity-report:
30
+ -MIRPY_FIXTURES=$(FIXTURES_DIR) MIRPY_PARITY_REPORT=$(PARITY_JSON) \
31
+ uv run --group test pytest tests/parity -q
32
+ @test -f $(PARITY_JSON) && echo "Wrote $(PARITY_JSON)"
33
+
34
+ clean:
35
+ rm -rf $(SITE_DIR) docs/_build docs/generated docs/jupyter_execute
@@ -0,0 +1,50 @@
1
+ py-mir-toolbox
2
+ ==============
3
+
4
+ py-mir-toolbox is a Python port of MIRtoolbox. Its code is translated from
5
+ MiningSuite, the BSD-licensed successor of MIRtoolbox.
6
+
7
+ MiningSuite
8
+ -----------
9
+ Copyright (C) 2014-2015, 2017-2018 Olivier Lartillot and the MiningSuite contributors.
10
+ Licensed under the BSD 3-Clause License (see reference/miningsuite/LICENSE.txt).
11
+ Upstream: https://github.com/olivierlar/miningsuite (commit 7b3e4688b2b33e1d3b8c580c95e518457a4ee627)
12
+ Packages used: +sig, +aud, +mus
13
+
14
+ MIRtoolbox
15
+ ----------
16
+ MIRtoolbox 1.8.2, Copyright (C) 2023 Olivier Lartillot, University of Jyväskylä,
17
+ University of Geneva, University of Oslo. Developed by Olivier Lartillot,
18
+ Petri Toiviainen, Pasi Saari et al. Licensed under GPL-2.0.
19
+ Upstream: https://github.com/olivierlar/mirtoolbox
20
+
21
+ MIRtoolbox source code is NOT included in or translated into this package.
22
+ MIRtoolbox 1.8.2 is used only as a numerical reference: outputs are compared
23
+ against it in the validation suite. The MIRtoolbox manual is used as documentation.
24
+
25
+ python_auditory_toolbox
26
+ -----------------------
27
+ Copyright Malcolm Slaney. Licensed under the Apache License, Version 2.0
28
+ (see src/mirpy/_vendor/LICENSE-APACHE-2.0.txt).
29
+ Upstream: https://github.com/MalcolmSlaney/python_auditory_toolbox (version 1.0.6)
30
+ Vendored in src/mirpy/_vendor/auditory_toolbox.py: ErbSpace, MakeErbFilters and
31
+ ErbFilterBank (gammatone filterbank, Slaney 1993, Apple TR #35), unchanged; other
32
+ functions removed.
33
+
34
+ Data files
35
+ ----------
36
+ Key profiles (gomezprofs.mat) and the key self-organizing map
37
+ (keysomaudiodata.mat) come from MiningSuite (+mus) under its BSD license.
38
+
39
+ Citing
40
+ ------
41
+ If you use py-mir-toolbox in academic work, please also cite the original MIRtoolbox:
42
+
43
+ Lartillot, O., & Toiviainen, P. (2007). A Matlab toolbox for musical feature
44
+ extraction from audio. Proceedings of the 10th International Conference on
45
+ Digital Audio Effects (DAFx-07), Bordeaux, France.
46
+
47
+ Lartillot, O., Toiviainen, P., & Eerola, T. (2008). A Matlab toolbox for music
48
+ information retrieval. In C. Preisach, H. Burkhardt, L. Schmidt-Thieme, &
49
+ R. Decker (Eds.), Data Analysis, Machine Learning and Applications
50
+ Springer.
@@ -0,0 +1,110 @@
1
+ Metadata-Version: 2.5
2
+ Name: py-mir-toolbox
3
+ Version: 0.1.0
4
+ Summary: A Python port of MIRtoolbox for music feature extraction, designed as a bridge from music psychology to the Python MIR ecosystem.
5
+ Project-URL: Homepage, https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox
6
+ Project-URL: Documentation, https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox
7
+ Project-URL: Source, https://github.com/juansgomez87/py-mir-toolbox
8
+ Project-URL: Issues, https://github.com/juansgomez87/py-mir-toolbox/issues
9
+ Author: Juan Sebastián Gómez-Cañón
10
+ License-Expression: BSD-3-Clause
11
+ License-File: LICENSE
12
+ License-File: NOTICE
13
+ License-File: reference/miningsuite/LICENSE.txt
14
+ Keywords: MIR,MIRtoolbox,audio,feature extraction,music,music information retrieval,music psychology
15
+ Classifier: Development Status :: 2 - Pre-Alpha
16
+ Classifier: Intended Audience :: Education
17
+ Classifier: Intended Audience :: Science/Research
18
+ Classifier: Operating System :: OS Independent
19
+ Classifier: Programming Language :: Python :: 3
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Programming Language :: Python :: 3.14
23
+ Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
24
+ Classifier: Topic :: Scientific/Engineering :: Information Analysis
25
+ Requires-Python: >=3.12
26
+ Requires-Dist: matplotlib>=3.8
27
+ Requires-Dist: numpy>=2.0
28
+ Requires-Dist: scipy>=1.13
29
+ Requires-Dist: soundfile>=0.12
30
+ Provides-Extra: export
31
+ Requires-Dist: pandas>=2.2; extra == 'export'
32
+ Provides-Extra: librosa
33
+ Requires-Dist: librosa>=1.0; extra == 'librosa'
34
+ Provides-Extra: parallel
35
+ Requires-Dist: joblib>=1.3; extra == 'parallel'
36
+ Description-Content-Type: text/markdown
37
+
38
+ # py-mir-toolbox
39
+
40
+ **A Python port of [MIRtoolbox](https://github.com/olivierlar/mirtoolbox) for music feature extraction, designed as a bridge from music psychology to the Python music information retrieval (MIR) ecosystem.**
41
+
42
+ MIRtoolbox (Lartillot & Toiviainen, 2007) is the MATLAB toolbox most music cognition and music psychology students learn first. py-mir-toolbox:
43
+
44
+ 1. keeps the MIRtoolbox function names and default parameters, so existing analyses carry over;
45
+ 2. is validated numerically against MIRtoolbox 1.8.2 (see the [Parity report](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/parity.html)); and
46
+ 3. comes with course notebooks that compute each feature with py-mir-toolbox, [librosa](https://librosa.org) and [Essentia](https://essentia.upf.edu) side by side, runnable in Google Colab with no installation.
47
+
48
+ ## Install
49
+
50
+ ```bash
51
+ pip install py-mir-toolbox
52
+ ```
53
+
54
+ Optional extras: `py-mir-toolbox[export]` (pandas, for `mir.to_dataframe`), `py-mir-toolbox[parallel]` (joblib, for `mir.batch(..., n_jobs=4)`), `py-mir-toolbox[librosa]`.
55
+
56
+ ## Example
57
+
58
+ ```python
59
+ import mirpy as mir
60
+
61
+ a = mir.audio("song.wav") # a = miraudio('song.wav')
62
+ rms = mir.rms(a, frame=True) # mirrms(a, 'Frame')
63
+ mir.stat(mir.centroid(a, frame=True)) # mirstat(mircentroid(a, 'Frame'))
64
+
65
+ # One row per file of a folder, saved for R, SPSS or JASP
66
+ features = {"rms": mir.rms, "centroid": lambda a: mir.centroid(a, frame=True)}
67
+ mir.to_csv(mir.file_table(mir.batch("songs/", features)), "features.csv")
68
+ ```
69
+
70
+ ## What release 0.1 covers
71
+
72
+ - **Audio and framing:** `audio`, `frame`.
73
+ - **Signal processing:** `spectrum`, `cepstrum`, `autocor`, `filterbank`, `sum`, `peaks`.
74
+ - **Dynamics:** `rms`, `lowenergy`.
75
+ - **Timbre:** `zerocross`, `centroid`, `spread`, `skewness`, `kurtosis`, `flatness`, `entropy`, `rolloff`, `brightness`, `mfcc`, `flux`.
76
+ - **Statistics and export:** `mean`, `std`, `median`, `stat`, `histo`, `batch`, `list_audio`, `get_data`, `file_table`, `frame_table`, `to_csv`, `to_arff`, `to_dataframe`.
77
+
78
+ Pitch, tonality, rhythm and structure follow in later releases.
79
+
80
+ ## Documentation and course
81
+
82
+ - Website: https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox
83
+ - [API reference](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/api.html) and [Parity report](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/parity.html)
84
+ - Course chapters (open in Colab from each page): [Basics](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/chapters/B_basics.html), [Dynamics](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/chapters/C3_dynamics.html), [Spectral shape](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/chapters/C4a_spectral_shape.html), [MFCCs, flux and statistics](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/chapters/C4b_mfcc_flux_statistics.html)
85
+
86
+ ## Credits and citing
87
+
88
+ py-mir-toolbox is translated from [MiningSuite](https://github.com/olivierlar/miningsuite) (BSD-3-Clause, © Olivier Lartillot and the MiningSuite contributors), the successor of MIRtoolbox. MIRtoolbox 1.8.2 (GPL-2.0) is used only as a numerical reference; its source code is not included or translated. See [`NOTICE`](https://github.com/juansgomez87/py-mir-toolbox/blob/main/NOTICE).
89
+
90
+ If you use py-mir-toolbox, please cite it (see [`CITATION.cff`](https://github.com/juansgomez87/py-mir-toolbox/blob/main/CITATION.cff); metadata also in [`codemeta.json`](https://github.com/juansgomez87/py-mir-toolbox/blob/main/codemeta.json)) **and** the original MIRtoolbox papers:
91
+
92
+ - Lartillot, O., & Toiviainen, P. (2007). A Matlab toolbox for musical feature extraction from audio. *Proceedings of the 10th International Conference on Digital Audio Effects (DAFx-07)*, Bordeaux, France.
93
+ - Lartillot, O., Toiviainen, P., & Eerola, T. (2008). A Matlab toolbox for music information retrieval. In C. Preisach, H. Burkhardt, L. Schmidt-Thieme, & R. Decker (Eds.), *Data Analysis, Machine Learning and Applications*. Springer.
94
+
95
+ `mirpy.cite()` prints these entries as BibTeX.
96
+
97
+ ## Repository layout
98
+
99
+ | Path | Contents |
100
+ |---|---|
101
+ | `src/mirpy/` | The package |
102
+ | `tests/` | Unit and parity tests |
103
+ | `validation/` | Scripts that generate MIRtoolbox 1.8.2 reference outputs |
104
+ | `docs/` | Sphinx documentation and course (served under `/docs/`) |
105
+ | `docs/chapters/` | Course notebooks (Colab-ready) |
106
+ | `reference/miningsuite/` | MiningSuite `+sig`, `+aud`, `+mus` (BSD-3) |
107
+
108
+ ## License
109
+
110
+ Code: BSD-3-Clause. Course text: CC-BY 4.0.
@@ -0,0 +1,73 @@
1
+ # py-mir-toolbox
2
+
3
+ **A Python port of [MIRtoolbox](https://github.com/olivierlar/mirtoolbox) for music feature extraction, designed as a bridge from music psychology to the Python music information retrieval (MIR) ecosystem.**
4
+
5
+ MIRtoolbox (Lartillot & Toiviainen, 2007) is the MATLAB toolbox most music cognition and music psychology students learn first. py-mir-toolbox:
6
+
7
+ 1. keeps the MIRtoolbox function names and default parameters, so existing analyses carry over;
8
+ 2. is validated numerically against MIRtoolbox 1.8.2 (see the [Parity report](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/parity.html)); and
9
+ 3. comes with course notebooks that compute each feature with py-mir-toolbox, [librosa](https://librosa.org) and [Essentia](https://essentia.upf.edu) side by side, runnable in Google Colab with no installation.
10
+
11
+ ## Install
12
+
13
+ ```bash
14
+ pip install py-mir-toolbox
15
+ ```
16
+
17
+ Optional extras: `py-mir-toolbox[export]` (pandas, for `mir.to_dataframe`), `py-mir-toolbox[parallel]` (joblib, for `mir.batch(..., n_jobs=4)`), `py-mir-toolbox[librosa]`.
18
+
19
+ ## Example
20
+
21
+ ```python
22
+ import mirpy as mir
23
+
24
+ a = mir.audio("song.wav") # a = miraudio('song.wav')
25
+ rms = mir.rms(a, frame=True) # mirrms(a, 'Frame')
26
+ mir.stat(mir.centroid(a, frame=True)) # mirstat(mircentroid(a, 'Frame'))
27
+
28
+ # One row per file of a folder, saved for R, SPSS or JASP
29
+ features = {"rms": mir.rms, "centroid": lambda a: mir.centroid(a, frame=True)}
30
+ mir.to_csv(mir.file_table(mir.batch("songs/", features)), "features.csv")
31
+ ```
32
+
33
+ ## What release 0.1 covers
34
+
35
+ - **Audio and framing:** `audio`, `frame`.
36
+ - **Signal processing:** `spectrum`, `cepstrum`, `autocor`, `filterbank`, `sum`, `peaks`.
37
+ - **Dynamics:** `rms`, `lowenergy`.
38
+ - **Timbre:** `zerocross`, `centroid`, `spread`, `skewness`, `kurtosis`, `flatness`, `entropy`, `rolloff`, `brightness`, `mfcc`, `flux`.
39
+ - **Statistics and export:** `mean`, `std`, `median`, `stat`, `histo`, `batch`, `list_audio`, `get_data`, `file_table`, `frame_table`, `to_csv`, `to_arff`, `to_dataframe`.
40
+
41
+ Pitch, tonality, rhythm and structure follow in later releases.
42
+
43
+ ## Documentation and course
44
+
45
+ - Website: https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox
46
+ - [API reference](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/api.html) and [Parity report](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/parity.html)
47
+ - Course chapters (open in Colab from each page): [Basics](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/chapters/B_basics.html), [Dynamics](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/chapters/C3_dynamics.html), [Spectral shape](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/chapters/C4a_spectral_shape.html), [MFCCs, flux and statistics](https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox/docs/chapters/C4b_mfcc_flux_statistics.html)
48
+
49
+ ## Credits and citing
50
+
51
+ py-mir-toolbox is translated from [MiningSuite](https://github.com/olivierlar/miningsuite) (BSD-3-Clause, © Olivier Lartillot and the MiningSuite contributors), the successor of MIRtoolbox. MIRtoolbox 1.8.2 (GPL-2.0) is used only as a numerical reference; its source code is not included or translated. See [`NOTICE`](https://github.com/juansgomez87/py-mir-toolbox/blob/main/NOTICE).
52
+
53
+ If you use py-mir-toolbox, please cite it (see [`CITATION.cff`](https://github.com/juansgomez87/py-mir-toolbox/blob/main/CITATION.cff); metadata also in [`codemeta.json`](https://github.com/juansgomez87/py-mir-toolbox/blob/main/codemeta.json)) **and** the original MIRtoolbox papers:
54
+
55
+ - Lartillot, O., & Toiviainen, P. (2007). A Matlab toolbox for musical feature extraction from audio. *Proceedings of the 10th International Conference on Digital Audio Effects (DAFx-07)*, Bordeaux, France.
56
+ - Lartillot, O., Toiviainen, P., & Eerola, T. (2008). A Matlab toolbox for music information retrieval. In C. Preisach, H. Burkhardt, L. Schmidt-Thieme, & R. Decker (Eds.), *Data Analysis, Machine Learning and Applications*. Springer.
57
+
58
+ `mirpy.cite()` prints these entries as BibTeX.
59
+
60
+ ## Repository layout
61
+
62
+ | Path | Contents |
63
+ |---|---|
64
+ | `src/mirpy/` | The package |
65
+ | `tests/` | Unit and parity tests |
66
+ | `validation/` | Scripts that generate MIRtoolbox 1.8.2 reference outputs |
67
+ | `docs/` | Sphinx documentation and course (served under `/docs/`) |
68
+ | `docs/chapters/` | Course notebooks (Colab-ready) |
69
+ | `reference/miningsuite/` | MiningSuite `+sig`, `+aud`, `+mus` (BSD-3) |
70
+
71
+ ## License
72
+
73
+ Code: BSD-3-Clause. Course text: CC-BY 4.0.
@@ -0,0 +1,70 @@
1
+ {
2
+ "@context": "https://w3id.org/codemeta/3.0",
3
+ "@type": "SoftwareSourceCode",
4
+ "name": "py-mir-toolbox",
5
+ "description": "A Python port of MIRtoolbox for music feature extraction, designed as a bridge from music psychology to the Python MIR ecosystem.",
6
+ "author": [
7
+ {
8
+ "@type": "Person",
9
+ "@id": "https://orcid.org/0000-0002-2544-6311",
10
+ "givenName": "Juan Sebastián",
11
+ "familyName": "Gómez-Cañón"
12
+ }
13
+ ],
14
+ "license": "https://spdx.org/licenses/BSD-3-Clause",
15
+ "codeRepository": "https://github.com/juansgomez87/py-mir-toolbox",
16
+ "issueTracker": "https://github.com/juansgomez87/py-mir-toolbox/issues",
17
+ "url": "https://ccrma.stanford.edu/~jsgomezc/py-mir-toolbox",
18
+ "readme": "https://github.com/juansgomez87/py-mir-toolbox/blob/main/README.md",
19
+ "developmentStatus": "wip",
20
+ "programmingLanguage": "Python",
21
+ "runtimePlatform": "Python 3.12+",
22
+ "operatingSystem": ["Linux", "macOS", "Windows"],
23
+ "applicationCategory": "Music information retrieval",
24
+ "keywords": [
25
+ "music",
26
+ "audio",
27
+ "MIR",
28
+ "music information retrieval",
29
+ "music psychology",
30
+ "MIRtoolbox",
31
+ "feature extraction"
32
+ ],
33
+ "softwareRequirements": [
34
+ "numpy>=2.0",
35
+ "scipy>=1.13",
36
+ "soundfile>=0.12",
37
+ "matplotlib>=3.8"
38
+ ],
39
+ "citation": [
40
+ {
41
+ "@type": "ScholarlyArticle",
42
+ "name": "A Matlab Toolbox for Musical Feature Extraction from Audio",
43
+ "author": [
44
+ {"@type": "Person", "givenName": "Olivier", "familyName": "Lartillot"},
45
+ {"@type": "Person", "givenName": "Petri", "familyName": "Toiviainen"}
46
+ ],
47
+ "isPartOf": "Proceedings of the 10th International Conference on Digital Audio Effects (DAFx-07)",
48
+ "datePublished": "2007"
49
+ },
50
+ {
51
+ "@type": "Chapter",
52
+ "name": "A Matlab Toolbox for Music Information Retrieval",
53
+ "author": [
54
+ {"@type": "Person", "givenName": "Olivier", "familyName": "Lartillot"},
55
+ {"@type": "Person", "givenName": "Petri", "familyName": "Toiviainen"},
56
+ {"@type": "Person", "givenName": "Tuomas", "familyName": "Eerola"}
57
+ ],
58
+ "isPartOf": "Data Analysis, Machine Learning and Applications",
59
+ "publisher": "Springer",
60
+ "datePublished": "2008"
61
+ },
62
+ {
63
+ "@type": "SoftwareSourceCode",
64
+ "name": "MiningSuite",
65
+ "author": [{"@type": "Person", "givenName": "Olivier", "familyName": "Lartillot"}],
66
+ "license": "https://spdx.org/licenses/BSD-3-Clause",
67
+ "codeRepository": "https://github.com/olivierlar/miningsuite"
68
+ }
69
+ ]
70
+ }