pymatchmaker 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.
- pymatchmaker-0.1.0/LICENSE +201 -0
- pymatchmaker-0.1.0/PKG-INFO +244 -0
- pymatchmaker-0.1.0/README.md +203 -0
- pymatchmaker-0.1.0/docs/source/conf.py +45 -0
- pymatchmaker-0.1.0/matchmaker/__init__.py +38 -0
- pymatchmaker-0.1.0/matchmaker/base.py +26 -0
- pymatchmaker-0.1.0/matchmaker/dp/__init__.py +11 -0
- pymatchmaker-0.1.0/matchmaker/dp/dtw_loop.pyx +177 -0
- pymatchmaker-0.1.0/matchmaker/dp/oltw_arzt.py +295 -0
- pymatchmaker-0.1.0/matchmaker/dp/oltw_dixon.py +410 -0
- pymatchmaker-0.1.0/matchmaker/features/__init__.py +7 -0
- pymatchmaker-0.1.0/matchmaker/features/audio.py +260 -0
- pymatchmaker-0.1.0/matchmaker/features/midi.py +350 -0
- pymatchmaker-0.1.0/matchmaker/io/__init__.py +13 -0
- pymatchmaker-0.1.0/matchmaker/io/audio.py +278 -0
- pymatchmaker-0.1.0/matchmaker/io/mediator.py +194 -0
- pymatchmaker-0.1.0/matchmaker/io/midi.py +314 -0
- pymatchmaker-0.1.0/matchmaker/matchmaker.py +213 -0
- pymatchmaker-0.1.0/matchmaker/prob/__init__.py +6 -0
- pymatchmaker-0.1.0/matchmaker/prob/hmm.py +1055 -0
- pymatchmaker-0.1.0/matchmaker/utils/__init__.py +17 -0
- pymatchmaker-0.1.0/matchmaker/utils/audio.py +134 -0
- pymatchmaker-0.1.0/matchmaker/utils/distances.pyx +228 -0
- pymatchmaker-0.1.0/matchmaker/utils/misc.py +170 -0
- pymatchmaker-0.1.0/matchmaker/utils/processor.py +89 -0
- pymatchmaker-0.1.0/matchmaker/utils/stream.py +114 -0
- pymatchmaker-0.1.0/matchmaker/utils/symbolic.py +459 -0
- pymatchmaker-0.1.0/matchmaker/utils/tempo_models.py +514 -0
- pymatchmaker-0.1.0/matchmaker/utils/typing.py +21 -0
- pymatchmaker-0.1.0/pymatchmaker.egg-info/PKG-INFO +244 -0
- pymatchmaker-0.1.0/pymatchmaker.egg-info/SOURCES.txt +50 -0
- pymatchmaker-0.1.0/pymatchmaker.egg-info/dependency_links.txt +1 -0
- pymatchmaker-0.1.0/pymatchmaker.egg-info/requires.txt +22 -0
- pymatchmaker-0.1.0/pymatchmaker.egg-info/top_level.txt +4 -0
- pymatchmaker-0.1.0/pyproject.toml +60 -0
- pymatchmaker-0.1.0/setup.cfg +4 -0
- pymatchmaker-0.1.0/setup.py +24 -0
- pymatchmaker-0.1.0/tests/test_base.py +31 -0
- pymatchmaker-0.1.0/tests/test_features_audio.py +199 -0
- pymatchmaker-0.1.0/tests/test_features_midi.py +486 -0
- pymatchmaker-0.1.0/tests/test_init.py +52 -0
- pymatchmaker-0.1.0/tests/test_io_audio.py +309 -0
- pymatchmaker-0.1.0/tests/test_io_mediator.py +93 -0
- pymatchmaker-0.1.0/tests/test_io_midi.py +438 -0
- pymatchmaker-0.1.0/tests/test_matchmaker.py +149 -0
- pymatchmaker-0.1.0/tests/test_oltw_arzt.py +162 -0
- pymatchmaker-0.1.0/tests/test_prob_hmm.py +195 -0
- pymatchmaker-0.1.0/tests/test_utils_audio.py +102 -0
- pymatchmaker-0.1.0/tests/test_utils_misc.py +126 -0
- pymatchmaker-0.1.0/tests/test_utils_processor.py +50 -0
- pymatchmaker-0.1.0/tests/test_utils_stream.py +67 -0
- pymatchmaker-0.1.0/tests/test_utils_symbolic.py +171 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2024 The Matchmaker Development Team
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,244 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: pymatchmaker
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A package for real-time music alignment
|
|
5
|
+
Author-email: Matchmaker Development Team <carloscancinochacon@gmail.com>
|
|
6
|
+
License: Apache 2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/pymatchmaker/matchmaker
|
|
8
|
+
Keywords: music,alignment,midi,audio
|
|
9
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
10
|
+
Classifier: Programming Language :: Python
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Classifier: Programming Language :: Cython
|
|
13
|
+
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
14
|
+
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
15
|
+
Classifier: Topic :: Multimedia :: Sound/Audio
|
|
16
|
+
Classifier: Topic :: Multimedia :: Sound/Audio :: MIDI
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
18
|
+
Requires-Python: >=3.9
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
Requires-Dist: cython>=3.0.8
|
|
22
|
+
Requires-Dist: python-rtmidi>=1.5.8
|
|
23
|
+
Requires-Dist: mido>=1.3.2
|
|
24
|
+
Requires-Dist: numpy>=1.26.3
|
|
25
|
+
Requires-Dist: scipy>=1.11.4
|
|
26
|
+
Requires-Dist: librosa>=0.10.1
|
|
27
|
+
Requires-Dist: partitura>=1.5.0
|
|
28
|
+
Requires-Dist: python-hiddenmarkov>=0.1.3
|
|
29
|
+
Requires-Dist: pyaudio>=0.2.14
|
|
30
|
+
Requires-Dist: pyfluidsynth>=1.3.3
|
|
31
|
+
Provides-Extra: dev
|
|
32
|
+
Requires-Dist: black>=23.12.1; extra == "dev"
|
|
33
|
+
Requires-Dist: isort>=5.13.2; extra == "dev"
|
|
34
|
+
Requires-Dist: pre-commit>=3.6.0; extra == "dev"
|
|
35
|
+
Requires-Dist: ipython>=8.12.0; extra == "dev"
|
|
36
|
+
Requires-Dist: pyclean>=3.0.0; extra == "dev"
|
|
37
|
+
Provides-Extra: platforms
|
|
38
|
+
Requires-Dist: macos_11_0_arm64; extra == "platforms"
|
|
39
|
+
Requires-Dist: macos_x86_64; extra == "platforms"
|
|
40
|
+
Requires-Dist: linux_x86_64; extra == "platforms"
|
|
41
|
+
|
|
42
|
+
# Matchmaker
|
|
43
|
+
|
|
44
|
+
Matchmaker is a Python library for real-time music alignment.
|
|
45
|
+
|
|
46
|
+
Music alignment is a fundamental MIR task, and real-time music alignment is a necessary component of many interactive applications (e.g., automatic accompaniment systems, automatic page turning).
|
|
47
|
+
|
|
48
|
+
Unlike offline alignment methods, for which state-of-the-art implementations are publicly available, real-time (online) methods have no standard implementation, forcing researchers and developers to build them from scratch for their projects.
|
|
49
|
+
|
|
50
|
+
We aim to provide efficient reference implementations of score followers for use in real-time applications which can be easily integrated into existing projects.
|
|
51
|
+
|
|
52
|
+
The full documentation for matchmaker is available online at [readthedocs.org](https://matchmaker.readthedocs.io).
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
## Setup
|
|
56
|
+
|
|
57
|
+
### Prerequisites
|
|
58
|
+
|
|
59
|
+
- Available Python version: 3.9, 3.10, 3.11, 3.12 (3.12 recommended)
|
|
60
|
+
- [Fluidsynth](https://www.fluidsynth.org/)
|
|
61
|
+
- [PortAudio](http://www.portaudio.com/)
|
|
62
|
+
|
|
63
|
+
Please ensure that you've installed the above packages before proceeding.
|
|
64
|
+
You should not install `fluidsynth` using `pip install fluidsynth` as it is not compatible with `matchmaker`.
|
|
65
|
+
|
|
66
|
+
### Install from PyPI
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
pip install pymatchmaker
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Install from source using conda
|
|
73
|
+
|
|
74
|
+
Please refer to the [requirements.txt](requirements.txt) file for the minimum required versions of the packages.
|
|
75
|
+
Setting up the code as described here requires [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html). Follow the instructions for your OS.
|
|
76
|
+
|
|
77
|
+
To setup the experiments, use the following script.
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
# Clone matchmaker
|
|
81
|
+
git clone https://github.com/pymatchmaker/matchmaker.git
|
|
82
|
+
|
|
83
|
+
cd matchmaker
|
|
84
|
+
|
|
85
|
+
# Create the conda environment
|
|
86
|
+
conda create -n matchmaker python=3.12
|
|
87
|
+
conda activate matchmaker
|
|
88
|
+
|
|
89
|
+
# Install matchmaker
|
|
90
|
+
pip install -e .
|
|
91
|
+
|
|
92
|
+
# Install matchmaker with dev tools
|
|
93
|
+
pip install -e .[dev]
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
If you have a ImportError with 'Fluidsynth' by `pyfluidsynth` library on MacOS, please refer to the following [link](https://stackoverflow.com/a/75339618).
|
|
97
|
+
|
|
98
|
+
## Usage Examples
|
|
99
|
+
|
|
100
|
+
### Quickstart for live streaming
|
|
101
|
+
|
|
102
|
+
To get started quickly, you can use the `Matchmaker` class, which provides a simple interface for running the alignment process. You can use a `musicxml` or `midi` file as the score file. Specify `"audio"` or `"midi"` as the `input_type` argument, and the default device for that input type will be automatically set up.
|
|
103
|
+
|
|
104
|
+
```python
|
|
105
|
+
from matchmaker import Matchmaker
|
|
106
|
+
|
|
107
|
+
mm = Matchmaker(
|
|
108
|
+
score_file="path/to/score",
|
|
109
|
+
input_type="audio",
|
|
110
|
+
)
|
|
111
|
+
for current_position in mm.run():
|
|
112
|
+
print(current_position) # beat position in the score
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
The returned value is the current position in the score, represented in beats defined by `partitura` library's note array system.
|
|
116
|
+
Specifically, each position is calculated for every frame input and interpolated within the score's `onset_beat` array.
|
|
117
|
+
Please refer to [here](https://partitura.readthedocs.io/en/latest/Tutorial/notebook.html) for more information about the `onset_beat` concept.
|
|
118
|
+
|
|
119
|
+
### Testing with the performance file
|
|
120
|
+
|
|
121
|
+
You can simulate the real-time alignment by putting a specific performance file as input, rather than running it as a live stream.
|
|
122
|
+
The type of performance file can be either audio file or midi file, depending on the `input_type`.
|
|
123
|
+
|
|
124
|
+
```python
|
|
125
|
+
from matchmaker import Matchmaker
|
|
126
|
+
|
|
127
|
+
mm = Matchmaker(
|
|
128
|
+
score_file="path/to/score",
|
|
129
|
+
performance_file="path/to/performance.mid",
|
|
130
|
+
input_type="midi",
|
|
131
|
+
)
|
|
132
|
+
for current_position in mm.run():
|
|
133
|
+
print(current_position)
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Testing with Specific Input Device
|
|
137
|
+
|
|
138
|
+
To use a specific audio or MIDI device that is not the default device, you can pass the device name or index.
|
|
139
|
+
|
|
140
|
+
```python
|
|
141
|
+
from matchmaker import Matchmaker
|
|
142
|
+
|
|
143
|
+
mm = Matchmaker(
|
|
144
|
+
score_file="path/to/score",
|
|
145
|
+
input_type="audio",
|
|
146
|
+
device_name_or_index="MacBookPro Microphone",
|
|
147
|
+
)
|
|
148
|
+
for current_position in mm.run():
|
|
149
|
+
print(current_position)
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Testing with Different Methods or Features
|
|
153
|
+
|
|
154
|
+
For testing with Audio input, you can specify the alignment method as follows:
|
|
155
|
+
|
|
156
|
+
```python
|
|
157
|
+
from matchmaker import Matchmaker
|
|
158
|
+
|
|
159
|
+
mm = Matchmaker(
|
|
160
|
+
score_file="path/to/score",
|
|
161
|
+
input_type="audio",
|
|
162
|
+
method="dixon", # or "arzt" (default)
|
|
163
|
+
)
|
|
164
|
+
for current_position in mm.run():
|
|
165
|
+
print(current_position)
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
For options regarding the `method`, please refer to the [Alignment Methods](#alignment-methods) section.
|
|
169
|
+
For options regarding the `feature_type`, please refer to the [Features](#features) section.
|
|
170
|
+
|
|
171
|
+
### Custom Example
|
|
172
|
+
|
|
173
|
+
If you want to use a different alignment method or custom method, you can do so by importing the specific class and passing the necessary parameters.
|
|
174
|
+
In order to define a custom alignment class, you need to inherit from the Base `OnlineAlignment` class and implement the `run` method. Note that the returned value from the `OnlineAlignment` class should be the current frame number in the reference features, not in beats.
|
|
175
|
+
|
|
176
|
+
```python
|
|
177
|
+
from matchmaker.dp import OnlineTimeWarpingDixon
|
|
178
|
+
from matchmaker.io.audio import AudioStream
|
|
179
|
+
from matchmaker.features import ChromagramProcessor
|
|
180
|
+
|
|
181
|
+
feature_processor = ChromagramProcessor()
|
|
182
|
+
reference_features = feature_processor('path/to/score/audio.wav')
|
|
183
|
+
|
|
184
|
+
with AudioStream(processor=feature_processor) as stream:
|
|
185
|
+
score_follower = OnlineTimeWarpingDixon(reference_features, stream.queue)
|
|
186
|
+
for current_frame in score_follower.run():
|
|
187
|
+
print(current_frame) # frame number in the reference features
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
## Alignment Methods
|
|
191
|
+
|
|
192
|
+
Matchmaker currently supports the following alignment methods:
|
|
193
|
+
|
|
194
|
+
- `"dixon"`: On-line time warping algorithm by S. Dixon (2005). Supports audio input only.
|
|
195
|
+
- `"arzt"`: On-line time warping algorithm adapted from Brazier and Widmer (2020) (based on the work by Arzt et al. (2010)). Supports audio input only.
|
|
196
|
+
- `"hmm"`: Hidden Markov Model-based score follower by Cancino-Chacón et al. (2023), based on the state-space score followers by Duan et al. (2011) and Jiang and Raphael (2020). Supports MIDI input only.
|
|
197
|
+
|
|
198
|
+
## Features
|
|
199
|
+
|
|
200
|
+
Matchmaker currently supports the following feature types:
|
|
201
|
+
|
|
202
|
+
- For audio:
|
|
203
|
+
- `"chroma"`: Chroma features. Default feature type for audio input.
|
|
204
|
+
- `"mfcc"`: Mel-frequency cepstral coefficients.
|
|
205
|
+
- `"mel"`: Mel-Spectrogram.
|
|
206
|
+
- `"logspectral"`: Log-spectral features used in Dixon (2005).
|
|
207
|
+
- For MIDI:
|
|
208
|
+
- `pianoroll`: Piano-roll features. Default feature type for MIDI input.
|
|
209
|
+
- `"pitch"`: Pitch features for MIDI input.
|
|
210
|
+
- `"pitchclass"`: Pitch class features for MIDI input.
|
|
211
|
+
|
|
212
|
+
## Configurations
|
|
213
|
+
|
|
214
|
+
Initialization parameters for the `Matchmaker` class:
|
|
215
|
+
|
|
216
|
+
- `score_file` (str): Path to the score file.
|
|
217
|
+
- `input_type` (str): Type of input data. Options: `"audio"`, `"midi"`.
|
|
218
|
+
- `feature_type` (str): Type of feature to use. Options: `"chroma"`, `"mfcc"`, `"cqt"`, `"spectrogram"`, `"onset"`.
|
|
219
|
+
- `method` (str): Alignment method to use. Options: `"dixon"`, `"arzt"`, `"hmm"`.
|
|
220
|
+
- `sample_rate` (int): Sample rate of the input audio data.
|
|
221
|
+
- `frame_rate` (int): Frame rate of the input audio/MIDI data.
|
|
222
|
+
- `device_name_or_index` (str or int): The audio/MIDI device name or index you want to use. If `None`, the default device will be used.
|
|
223
|
+
|
|
224
|
+
## Citing Matchmaker
|
|
225
|
+
|
|
226
|
+
If you find Matchmaker useful, we would appreciate if you could cite us!
|
|
227
|
+
|
|
228
|
+
```
|
|
229
|
+
@inproceedings{matchmaker_lbd,
|
|
230
|
+
title={{Matchmaker: A Python library for Real-time Music Alignment}},
|
|
231
|
+
author={Park, Jiyun and Cancino-Chac\'{o}n, Carlos and Kwon, Taegyun and Nam, Juhan},
|
|
232
|
+
booktitle={{Proceedings of the Late Breaking/Demo Session at the 25th International Society for Music Information Retrieval Conference}},
|
|
233
|
+
address={San Francisco, USA.},
|
|
234
|
+
year={2024}
|
|
235
|
+
}
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
## Acknowledgments
|
|
239
|
+
|
|
240
|
+
This work has been supported by the Austrian Science Fund (FWF), grant agreement PAT 8820923 ("*Rach3: A Computational Approach to Study Piano Rehearsals*"). Additionally, this work was supported by the National Research Foundation of Korea (NRF) grant funded by the Korea government (MSIT) (No. NRF-2023R1A2C3007605).
|
|
241
|
+
|
|
242
|
+
## License
|
|
243
|
+
|
|
244
|
+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
|
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
# Matchmaker
|
|
2
|
+
|
|
3
|
+
Matchmaker is a Python library for real-time music alignment.
|
|
4
|
+
|
|
5
|
+
Music alignment is a fundamental MIR task, and real-time music alignment is a necessary component of many interactive applications (e.g., automatic accompaniment systems, automatic page turning).
|
|
6
|
+
|
|
7
|
+
Unlike offline alignment methods, for which state-of-the-art implementations are publicly available, real-time (online) methods have no standard implementation, forcing researchers and developers to build them from scratch for their projects.
|
|
8
|
+
|
|
9
|
+
We aim to provide efficient reference implementations of score followers for use in real-time applications which can be easily integrated into existing projects.
|
|
10
|
+
|
|
11
|
+
The full documentation for matchmaker is available online at [readthedocs.org](https://matchmaker.readthedocs.io).
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## Setup
|
|
15
|
+
|
|
16
|
+
### Prerequisites
|
|
17
|
+
|
|
18
|
+
- Available Python version: 3.9, 3.10, 3.11, 3.12 (3.12 recommended)
|
|
19
|
+
- [Fluidsynth](https://www.fluidsynth.org/)
|
|
20
|
+
- [PortAudio](http://www.portaudio.com/)
|
|
21
|
+
|
|
22
|
+
Please ensure that you've installed the above packages before proceeding.
|
|
23
|
+
You should not install `fluidsynth` using `pip install fluidsynth` as it is not compatible with `matchmaker`.
|
|
24
|
+
|
|
25
|
+
### Install from PyPI
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
pip install pymatchmaker
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Install from source using conda
|
|
32
|
+
|
|
33
|
+
Please refer to the [requirements.txt](requirements.txt) file for the minimum required versions of the packages.
|
|
34
|
+
Setting up the code as described here requires [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html). Follow the instructions for your OS.
|
|
35
|
+
|
|
36
|
+
To setup the experiments, use the following script.
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
# Clone matchmaker
|
|
40
|
+
git clone https://github.com/pymatchmaker/matchmaker.git
|
|
41
|
+
|
|
42
|
+
cd matchmaker
|
|
43
|
+
|
|
44
|
+
# Create the conda environment
|
|
45
|
+
conda create -n matchmaker python=3.12
|
|
46
|
+
conda activate matchmaker
|
|
47
|
+
|
|
48
|
+
# Install matchmaker
|
|
49
|
+
pip install -e .
|
|
50
|
+
|
|
51
|
+
# Install matchmaker with dev tools
|
|
52
|
+
pip install -e .[dev]
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
If you have a ImportError with 'Fluidsynth' by `pyfluidsynth` library on MacOS, please refer to the following [link](https://stackoverflow.com/a/75339618).
|
|
56
|
+
|
|
57
|
+
## Usage Examples
|
|
58
|
+
|
|
59
|
+
### Quickstart for live streaming
|
|
60
|
+
|
|
61
|
+
To get started quickly, you can use the `Matchmaker` class, which provides a simple interface for running the alignment process. You can use a `musicxml` or `midi` file as the score file. Specify `"audio"` or `"midi"` as the `input_type` argument, and the default device for that input type will be automatically set up.
|
|
62
|
+
|
|
63
|
+
```python
|
|
64
|
+
from matchmaker import Matchmaker
|
|
65
|
+
|
|
66
|
+
mm = Matchmaker(
|
|
67
|
+
score_file="path/to/score",
|
|
68
|
+
input_type="audio",
|
|
69
|
+
)
|
|
70
|
+
for current_position in mm.run():
|
|
71
|
+
print(current_position) # beat position in the score
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
The returned value is the current position in the score, represented in beats defined by `partitura` library's note array system.
|
|
75
|
+
Specifically, each position is calculated for every frame input and interpolated within the score's `onset_beat` array.
|
|
76
|
+
Please refer to [here](https://partitura.readthedocs.io/en/latest/Tutorial/notebook.html) for more information about the `onset_beat` concept.
|
|
77
|
+
|
|
78
|
+
### Testing with the performance file
|
|
79
|
+
|
|
80
|
+
You can simulate the real-time alignment by putting a specific performance file as input, rather than running it as a live stream.
|
|
81
|
+
The type of performance file can be either audio file or midi file, depending on the `input_type`.
|
|
82
|
+
|
|
83
|
+
```python
|
|
84
|
+
from matchmaker import Matchmaker
|
|
85
|
+
|
|
86
|
+
mm = Matchmaker(
|
|
87
|
+
score_file="path/to/score",
|
|
88
|
+
performance_file="path/to/performance.mid",
|
|
89
|
+
input_type="midi",
|
|
90
|
+
)
|
|
91
|
+
for current_position in mm.run():
|
|
92
|
+
print(current_position)
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Testing with Specific Input Device
|
|
96
|
+
|
|
97
|
+
To use a specific audio or MIDI device that is not the default device, you can pass the device name or index.
|
|
98
|
+
|
|
99
|
+
```python
|
|
100
|
+
from matchmaker import Matchmaker
|
|
101
|
+
|
|
102
|
+
mm = Matchmaker(
|
|
103
|
+
score_file="path/to/score",
|
|
104
|
+
input_type="audio",
|
|
105
|
+
device_name_or_index="MacBookPro Microphone",
|
|
106
|
+
)
|
|
107
|
+
for current_position in mm.run():
|
|
108
|
+
print(current_position)
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Testing with Different Methods or Features
|
|
112
|
+
|
|
113
|
+
For testing with Audio input, you can specify the alignment method as follows:
|
|
114
|
+
|
|
115
|
+
```python
|
|
116
|
+
from matchmaker import Matchmaker
|
|
117
|
+
|
|
118
|
+
mm = Matchmaker(
|
|
119
|
+
score_file="path/to/score",
|
|
120
|
+
input_type="audio",
|
|
121
|
+
method="dixon", # or "arzt" (default)
|
|
122
|
+
)
|
|
123
|
+
for current_position in mm.run():
|
|
124
|
+
print(current_position)
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
For options regarding the `method`, please refer to the [Alignment Methods](#alignment-methods) section.
|
|
128
|
+
For options regarding the `feature_type`, please refer to the [Features](#features) section.
|
|
129
|
+
|
|
130
|
+
### Custom Example
|
|
131
|
+
|
|
132
|
+
If you want to use a different alignment method or custom method, you can do so by importing the specific class and passing the necessary parameters.
|
|
133
|
+
In order to define a custom alignment class, you need to inherit from the Base `OnlineAlignment` class and implement the `run` method. Note that the returned value from the `OnlineAlignment` class should be the current frame number in the reference features, not in beats.
|
|
134
|
+
|
|
135
|
+
```python
|
|
136
|
+
from matchmaker.dp import OnlineTimeWarpingDixon
|
|
137
|
+
from matchmaker.io.audio import AudioStream
|
|
138
|
+
from matchmaker.features import ChromagramProcessor
|
|
139
|
+
|
|
140
|
+
feature_processor = ChromagramProcessor()
|
|
141
|
+
reference_features = feature_processor('path/to/score/audio.wav')
|
|
142
|
+
|
|
143
|
+
with AudioStream(processor=feature_processor) as stream:
|
|
144
|
+
score_follower = OnlineTimeWarpingDixon(reference_features, stream.queue)
|
|
145
|
+
for current_frame in score_follower.run():
|
|
146
|
+
print(current_frame) # frame number in the reference features
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
## Alignment Methods
|
|
150
|
+
|
|
151
|
+
Matchmaker currently supports the following alignment methods:
|
|
152
|
+
|
|
153
|
+
- `"dixon"`: On-line time warping algorithm by S. Dixon (2005). Supports audio input only.
|
|
154
|
+
- `"arzt"`: On-line time warping algorithm adapted from Brazier and Widmer (2020) (based on the work by Arzt et al. (2010)). Supports audio input only.
|
|
155
|
+
- `"hmm"`: Hidden Markov Model-based score follower by Cancino-Chacón et al. (2023), based on the state-space score followers by Duan et al. (2011) and Jiang and Raphael (2020). Supports MIDI input only.
|
|
156
|
+
|
|
157
|
+
## Features
|
|
158
|
+
|
|
159
|
+
Matchmaker currently supports the following feature types:
|
|
160
|
+
|
|
161
|
+
- For audio:
|
|
162
|
+
- `"chroma"`: Chroma features. Default feature type for audio input.
|
|
163
|
+
- `"mfcc"`: Mel-frequency cepstral coefficients.
|
|
164
|
+
- `"mel"`: Mel-Spectrogram.
|
|
165
|
+
- `"logspectral"`: Log-spectral features used in Dixon (2005).
|
|
166
|
+
- For MIDI:
|
|
167
|
+
- `pianoroll`: Piano-roll features. Default feature type for MIDI input.
|
|
168
|
+
- `"pitch"`: Pitch features for MIDI input.
|
|
169
|
+
- `"pitchclass"`: Pitch class features for MIDI input.
|
|
170
|
+
|
|
171
|
+
## Configurations
|
|
172
|
+
|
|
173
|
+
Initialization parameters for the `Matchmaker` class:
|
|
174
|
+
|
|
175
|
+
- `score_file` (str): Path to the score file.
|
|
176
|
+
- `input_type` (str): Type of input data. Options: `"audio"`, `"midi"`.
|
|
177
|
+
- `feature_type` (str): Type of feature to use. Options: `"chroma"`, `"mfcc"`, `"cqt"`, `"spectrogram"`, `"onset"`.
|
|
178
|
+
- `method` (str): Alignment method to use. Options: `"dixon"`, `"arzt"`, `"hmm"`.
|
|
179
|
+
- `sample_rate` (int): Sample rate of the input audio data.
|
|
180
|
+
- `frame_rate` (int): Frame rate of the input audio/MIDI data.
|
|
181
|
+
- `device_name_or_index` (str or int): The audio/MIDI device name or index you want to use. If `None`, the default device will be used.
|
|
182
|
+
|
|
183
|
+
## Citing Matchmaker
|
|
184
|
+
|
|
185
|
+
If you find Matchmaker useful, we would appreciate if you could cite us!
|
|
186
|
+
|
|
187
|
+
```
|
|
188
|
+
@inproceedings{matchmaker_lbd,
|
|
189
|
+
title={{Matchmaker: A Python library for Real-time Music Alignment}},
|
|
190
|
+
author={Park, Jiyun and Cancino-Chac\'{o}n, Carlos and Kwon, Taegyun and Nam, Juhan},
|
|
191
|
+
booktitle={{Proceedings of the Late Breaking/Demo Session at the 25th International Society for Music Information Retrieval Conference}},
|
|
192
|
+
address={San Francisco, USA.},
|
|
193
|
+
year={2024}
|
|
194
|
+
}
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
## Acknowledgments
|
|
198
|
+
|
|
199
|
+
This work has been supported by the Austrian Science Fund (FWF), grant agreement PAT 8820923 ("*Rach3: A Computational Approach to Study Piano Rehearsals*"). Additionally, this work was supported by the National Research Foundation of Korea (NRF) grant funded by the Korea government (MSIT) (No. NRF-2023R1A2C3007605).
|
|
200
|
+
|
|
201
|
+
## License
|
|
202
|
+
|
|
203
|
+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
|