visqol-python 3.3.3__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 (31) hide show
  1. visqol_python-3.3.3/LICENSE +201 -0
  2. visqol_python-3.3.3/MANIFEST.in +4 -0
  3. visqol_python-3.3.3/PKG-INFO +223 -0
  4. visqol_python-3.3.3/README.md +188 -0
  5. visqol_python-3.3.3/pyproject.toml +53 -0
  6. visqol_python-3.3.3/requirements.txt +4 -0
  7. visqol_python-3.3.3/setup.cfg +4 -0
  8. visqol_python-3.3.3/setup.py +58 -0
  9. visqol_python-3.3.3/tests/test_conformance.py +173 -0
  10. visqol_python-3.3.3/tests/test_quick.py +81 -0
  11. visqol_python-3.3.3/visqol/__init__.py +20 -0
  12. visqol_python-3.3.3/visqol/__main__.py +92 -0
  13. visqol_python-3.3.3/visqol/alignment.py +82 -0
  14. visqol_python-3.3.3/visqol/analysis_window.py +52 -0
  15. visqol_python-3.3.3/visqol/api.py +110 -0
  16. visqol_python-3.3.3/visqol/audio_utils.py +90 -0
  17. visqol_python-3.3.3/visqol/gammatone.py +418 -0
  18. visqol_python-3.3.3/visqol/model/libsvm_nu_svr_model.txt +324 -0
  19. visqol_python-3.3.3/visqol/nsim.py +134 -0
  20. visqol_python-3.3.3/visqol/patch_creator.py +222 -0
  21. visqol_python-3.3.3/visqol/patch_selector.py +357 -0
  22. visqol_python-3.3.3/visqol/quality_mapper.py +114 -0
  23. visqol_python-3.3.3/visqol/signal_utils.py +83 -0
  24. visqol_python-3.3.3/visqol/visqol_core.py +240 -0
  25. visqol_python-3.3.3/visqol/visqol_manager.py +194 -0
  26. visqol_python-3.3.3/visqol_python.egg-info/PKG-INFO +223 -0
  27. visqol_python-3.3.3/visqol_python.egg-info/SOURCES.txt +29 -0
  28. visqol_python-3.3.3/visqol_python.egg-info/dependency_links.txt +1 -0
  29. visqol_python-3.3.3/visqol_python.egg-info/entry_points.txt +2 -0
  30. visqol_python-3.3.3/visqol_python.egg-info/requires.txt +4 -0
  31. visqol_python-3.3.3/visqol_python.egg-info/top_level.txt +2 -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 [yyyy] [name of copyright owner]
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,4 @@
1
+ include README.md
2
+ include LICENSE
3
+ include requirements.txt
4
+ recursive-include visqol/model *.txt
@@ -0,0 +1,223 @@
1
+ Metadata-Version: 2.4
2
+ Name: visqol-python
3
+ Version: 3.3.3
4
+ Summary: ViSQOL - Virtual Speech Quality Objective Listener (Pure Python)
5
+ Home-page: https://github.com/talker93/visqol-python
6
+ Author: Shan Jiang
7
+ License-Expression: Apache-2.0
8
+ Project-URL: Homepage, https://github.com/talker93/visqol-python
9
+ Project-URL: Bug Reports, https://github.com/talker93/visqol-python/issues
10
+ Project-URL: Source, https://github.com/talker93/visqol-python
11
+ Project-URL: Original C++, https://github.com/google/visqol
12
+ Keywords: audio-quality,speech-quality,MOS,PESQ,POLQA,visqol,objective-metric,perceptual-quality
13
+ Classifier: Development Status :: 4 - Beta
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Intended Audience :: Science/Research
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.8
18
+ Classifier: Programming Language :: Python :: 3.9
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
24
+ Classifier: Topic :: Scientific/Engineering
25
+ Requires-Python: >=3.8
26
+ Description-Content-Type: text/markdown
27
+ License-File: LICENSE
28
+ Requires-Dist: numpy>=1.20
29
+ Requires-Dist: scipy>=1.7
30
+ Requires-Dist: soundfile>=0.10
31
+ Requires-Dist: libsvm-official>=3.25
32
+ Dynamic: home-page
33
+ Dynamic: license-file
34
+ Dynamic: requires-python
35
+
36
+ # ViSQOL (Python)
37
+
38
+ A pure Python implementation of [Google's ViSQOL](https://github.com/google/visqol) (Virtual Speech Quality Objective Listener) v3.3.3 for objective audio/speech quality assessment.
39
+
40
+ ViSQOL compares a reference audio signal with a degraded version and outputs a **MOS-LQO** (Mean Opinion Score - Listening Quality Objective) score on a scale of **1.0 – 5.0**.
41
+
42
+ ## Features
43
+
44
+ - **Two modes**: Audio mode (music/general audio at 48 kHz) and Speech mode (speech at 16 kHz)
45
+ - **High accuracy**: 11/11 conformance tests pass against the official C++ implementation
46
+ - Audio mode: 9/10 tests produce **identical** MOS scores (diff = 0.000000), 1 test diff = 0.000117
47
+ - Speech mode: diff = 0.006715
48
+ - **Pure Python**: no C/C++ compilation required
49
+ - **Minimal dependencies**: only 4 pip packages (`numpy`, `scipy`, `soundfile`, `libsvm-official`)
50
+ - **Faster than real-time**: Audio RTF ≈ 0.71x, Speech RTF ≈ 0.38x
51
+
52
+ ## Installation
53
+
54
+ ```bash
55
+ pip install numpy scipy soundfile libsvm-official
56
+ ```
57
+
58
+ Or install as a package:
59
+
60
+ ```bash
61
+ git clone https://github.com/talker93/visqol-python.git
62
+ cd visqol-python
63
+ pip install -e .
64
+ ```
65
+
66
+ ## Quick Start
67
+
68
+ ### Python API
69
+
70
+ ```python
71
+ from visqol import VisqolApi
72
+
73
+ # Audio mode (default) - for music and general audio
74
+ api = VisqolApi()
75
+ api.create(mode="audio")
76
+ result = api.measure("reference.wav", "degraded.wav")
77
+ print(f"MOS-LQO: {result.moslqo:.4f}")
78
+
79
+ # Speech mode - for speech signals
80
+ api = VisqolApi()
81
+ api.create(mode="speech")
82
+ result = api.measure("ref_speech.wav", "deg_speech.wav")
83
+ print(f"MOS-LQO: {result.moslqo:.4f}")
84
+ ```
85
+
86
+ ### Using NumPy Arrays
87
+
88
+ ```python
89
+ import numpy as np
90
+ import soundfile as sf
91
+ from visqol import VisqolApi
92
+
93
+ ref, sr = sf.read("reference.wav")
94
+ deg, _ = sf.read("degraded.wav")
95
+
96
+ api = VisqolApi()
97
+ api.create(mode="audio")
98
+ result = api.measure_from_arrays(ref, deg, sample_rate=sr)
99
+ print(f"MOS-LQO: {result.moslqo:.4f}")
100
+ ```
101
+
102
+ ### Command Line
103
+
104
+ ```bash
105
+ # Audio mode (default)
106
+ python -m visqol -r reference.wav -d degraded.wav
107
+
108
+ # Speech mode
109
+ python -m visqol -r reference.wav -d degraded.wav --speech_mode
110
+
111
+ # Verbose output (per-patch details)
112
+ python -m visqol -r reference.wav -d degraded.wav -v
113
+ ```
114
+
115
+ **CLI options:**
116
+
117
+ | Flag | Description |
118
+ |------|-------------|
119
+ | `-r`, `--reference` | Path to reference WAV file (required) |
120
+ | `-d`, `--degraded` | Path to degraded WAV file (required) |
121
+ | `--speech_mode` | Use speech mode (16 kHz, polynomial mapping) |
122
+ | `--model` | Custom SVR model file path (audio mode only) |
123
+ | `--search_window` | Search window radius (default: 60) |
124
+ | `--verbose`, `-v` | Show detailed per-patch results |
125
+
126
+ ## Output
127
+
128
+ The `measure()` method returns a `SimilarityResult` object with:
129
+
130
+ | Field | Description |
131
+ |-------|-------------|
132
+ | `moslqo` | MOS-LQO score (1.0 – 5.0) |
133
+ | `vnsim` | Mean NSIM across all patches |
134
+ | `fvnsim` | Per-frequency-band mean NSIM |
135
+ | `fstdnsim` | Per-frequency-band std of NSIM |
136
+ | `fvdegenergy` | Per-frequency-band degraded energy |
137
+ | `patch_sims` | List of per-patch similarity details |
138
+
139
+ ## Modes
140
+
141
+ ### Audio Mode (default)
142
+ - Target sample rate: **48 kHz**
143
+ - 32 Gammatone frequency bands (50 Hz – 15 000 Hz)
144
+ - Quality mapping: SVR (Support Vector Regression) model
145
+ - Best for: music, environmental audio, codecs
146
+
147
+ ### Speech Mode
148
+ - Target sample rate: **16 kHz**
149
+ - 32 Gammatone frequency bands (50 Hz – 8 000 Hz)
150
+ - Quality mapping: exponential polynomial fit
151
+ - VAD (Voice Activity Detection) based patch selection
152
+ - Best for: speech, VoIP, telephony
153
+
154
+ ## Performance
155
+
156
+ Measured on Apple M-series, Python 3.13:
157
+
158
+ | Mode | Avg RTF | Typical Time |
159
+ |------|---------|-------------|
160
+ | Audio (48 kHz) | **0.71x** | 7 – 12 s per file pair |
161
+ | Speech (16 kHz) | **0.38x** | ~1 s per file pair |
162
+
163
+ > RTF (Real-Time Factor) < 1.0 means faster than real-time.
164
+
165
+ ## Project Structure
166
+
167
+ ```
168
+ visqol-python/
169
+ ├── visqol/ # Main package
170
+ │ ├── __init__.py # Package exports
171
+ │ ├── api.py # Public API
172
+ │ ├── visqol_manager.py # Pipeline orchestrator
173
+ │ ├── visqol_core.py # Core algorithm
174
+ │ ├── audio_utils.py # Audio I/O & SPL normalization
175
+ │ ├── signal_utils.py # Envelope, cross-correlation
176
+ │ ├── analysis_window.py # Hann window
177
+ │ ├── gammatone.py # ERB + Gammatone filterbank + spectrogram
178
+ │ ├── patch_creator.py # Patch creation (Image + VAD modes)
179
+ │ ├── patch_selector.py # DP-based optimal patch matching
180
+ │ ├── alignment.py # Global alignment via cross-correlation
181
+ │ ├── nsim.py # NSIM similarity metric
182
+ │ ├── quality_mapper.py # SVR & exponential quality mapping
183
+ │ └── __main__.py # CLI entry point
184
+ ├── model/ # Bundled SVR model
185
+ │ └── libsvm_nu_svr_model.txt
186
+ ├── tests/ # Conformance tests
187
+ │ ├── test_conformance.py
188
+ │ └── test_quick.py
189
+ ├── setup.py
190
+ ├── requirements.txt
191
+ ├── LICENSE
192
+ └── README.md
193
+ ```
194
+
195
+ ## Conformance Test Results
196
+
197
+ Tested against the [official C++ ViSQOL v3.3.3](https://github.com/google/visqol) expected values:
198
+
199
+ | Test Case | Mode | Expected MOS | Python MOS | Δ |
200
+ |-----------|------|-------------|------------|---|
201
+ | strauss_lp35 | Audio | 1.3889 | 1.3889 | 0.000000 |
202
+ | steely_lp7 | Audio | 2.2502 | 2.2502 | 0.000000 |
203
+ | sopr_256aac | Audio | 4.6823 | 4.6823 | 0.000000 |
204
+ | ravel_128opus | Audio | 4.4651 | 4.4651 | 0.000000 |
205
+ | moonlight_128aac | Audio | 4.6843 | 4.6843 | 0.000000 |
206
+ | harpsichord_96mp3 | Audio | 4.2237 | 4.2237 | 0.000000 |
207
+ | guitar_64aac | Audio | 4.3497 | 4.3497 | 0.000000 |
208
+ | glock_48aac | Audio | 4.3325 | 4.3325 | 0.000000 |
209
+ | contrabassoon_24aac | Audio | 2.3469 | 2.3468 | 0.000117 |
210
+ | castanets_identity | Audio | 4.7321 | 4.7321 | 0.000000 |
211
+ | speech_CA01 | Speech | 3.3745 | 3.3678 | 0.006715 |
212
+
213
+ ## References
214
+
215
+ - [Google ViSQOL (C++)](https://github.com/google/visqol) — the original implementation this project is ported from
216
+ - Hines, A., Gillen, E., Kelly, D., Skoglund, J., Kokaram, A., & Harte, N. (2015). *ViSQOLAudio: An Objective Audio Quality Metric for Low Bitrate Codecs.* The Journal of the Acoustical Society of America.
217
+ - Chinen, M., Lim, F. S., Skoglund, J., Gureev, N., O'Gorman, F., & Hines, A. (2020). *ViSQOL v3: An Open Source Production Ready Objective Speech and Audio Metric.* 2020 Twelfth International Conference on Quality of Multimedia Experience (QoMEX).
218
+
219
+ ## License
220
+
221
+ Apache License 2.0. See [LICENSE](LICENSE) for details.
222
+
223
+ This project is a Python port of [Google's ViSQOL](https://github.com/google/visqol), which is also licensed under Apache 2.0.
@@ -0,0 +1,188 @@
1
+ # ViSQOL (Python)
2
+
3
+ A pure Python implementation of [Google's ViSQOL](https://github.com/google/visqol) (Virtual Speech Quality Objective Listener) v3.3.3 for objective audio/speech quality assessment.
4
+
5
+ ViSQOL compares a reference audio signal with a degraded version and outputs a **MOS-LQO** (Mean Opinion Score - Listening Quality Objective) score on a scale of **1.0 – 5.0**.
6
+
7
+ ## Features
8
+
9
+ - **Two modes**: Audio mode (music/general audio at 48 kHz) and Speech mode (speech at 16 kHz)
10
+ - **High accuracy**: 11/11 conformance tests pass against the official C++ implementation
11
+ - Audio mode: 9/10 tests produce **identical** MOS scores (diff = 0.000000), 1 test diff = 0.000117
12
+ - Speech mode: diff = 0.006715
13
+ - **Pure Python**: no C/C++ compilation required
14
+ - **Minimal dependencies**: only 4 pip packages (`numpy`, `scipy`, `soundfile`, `libsvm-official`)
15
+ - **Faster than real-time**: Audio RTF ≈ 0.71x, Speech RTF ≈ 0.38x
16
+
17
+ ## Installation
18
+
19
+ ```bash
20
+ pip install numpy scipy soundfile libsvm-official
21
+ ```
22
+
23
+ Or install as a package:
24
+
25
+ ```bash
26
+ git clone https://github.com/talker93/visqol-python.git
27
+ cd visqol-python
28
+ pip install -e .
29
+ ```
30
+
31
+ ## Quick Start
32
+
33
+ ### Python API
34
+
35
+ ```python
36
+ from visqol import VisqolApi
37
+
38
+ # Audio mode (default) - for music and general audio
39
+ api = VisqolApi()
40
+ api.create(mode="audio")
41
+ result = api.measure("reference.wav", "degraded.wav")
42
+ print(f"MOS-LQO: {result.moslqo:.4f}")
43
+
44
+ # Speech mode - for speech signals
45
+ api = VisqolApi()
46
+ api.create(mode="speech")
47
+ result = api.measure("ref_speech.wav", "deg_speech.wav")
48
+ print(f"MOS-LQO: {result.moslqo:.4f}")
49
+ ```
50
+
51
+ ### Using NumPy Arrays
52
+
53
+ ```python
54
+ import numpy as np
55
+ import soundfile as sf
56
+ from visqol import VisqolApi
57
+
58
+ ref, sr = sf.read("reference.wav")
59
+ deg, _ = sf.read("degraded.wav")
60
+
61
+ api = VisqolApi()
62
+ api.create(mode="audio")
63
+ result = api.measure_from_arrays(ref, deg, sample_rate=sr)
64
+ print(f"MOS-LQO: {result.moslqo:.4f}")
65
+ ```
66
+
67
+ ### Command Line
68
+
69
+ ```bash
70
+ # Audio mode (default)
71
+ python -m visqol -r reference.wav -d degraded.wav
72
+
73
+ # Speech mode
74
+ python -m visqol -r reference.wav -d degraded.wav --speech_mode
75
+
76
+ # Verbose output (per-patch details)
77
+ python -m visqol -r reference.wav -d degraded.wav -v
78
+ ```
79
+
80
+ **CLI options:**
81
+
82
+ | Flag | Description |
83
+ |------|-------------|
84
+ | `-r`, `--reference` | Path to reference WAV file (required) |
85
+ | `-d`, `--degraded` | Path to degraded WAV file (required) |
86
+ | `--speech_mode` | Use speech mode (16 kHz, polynomial mapping) |
87
+ | `--model` | Custom SVR model file path (audio mode only) |
88
+ | `--search_window` | Search window radius (default: 60) |
89
+ | `--verbose`, `-v` | Show detailed per-patch results |
90
+
91
+ ## Output
92
+
93
+ The `measure()` method returns a `SimilarityResult` object with:
94
+
95
+ | Field | Description |
96
+ |-------|-------------|
97
+ | `moslqo` | MOS-LQO score (1.0 – 5.0) |
98
+ | `vnsim` | Mean NSIM across all patches |
99
+ | `fvnsim` | Per-frequency-band mean NSIM |
100
+ | `fstdnsim` | Per-frequency-band std of NSIM |
101
+ | `fvdegenergy` | Per-frequency-band degraded energy |
102
+ | `patch_sims` | List of per-patch similarity details |
103
+
104
+ ## Modes
105
+
106
+ ### Audio Mode (default)
107
+ - Target sample rate: **48 kHz**
108
+ - 32 Gammatone frequency bands (50 Hz – 15 000 Hz)
109
+ - Quality mapping: SVR (Support Vector Regression) model
110
+ - Best for: music, environmental audio, codecs
111
+
112
+ ### Speech Mode
113
+ - Target sample rate: **16 kHz**
114
+ - 32 Gammatone frequency bands (50 Hz – 8 000 Hz)
115
+ - Quality mapping: exponential polynomial fit
116
+ - VAD (Voice Activity Detection) based patch selection
117
+ - Best for: speech, VoIP, telephony
118
+
119
+ ## Performance
120
+
121
+ Measured on Apple M-series, Python 3.13:
122
+
123
+ | Mode | Avg RTF | Typical Time |
124
+ |------|---------|-------------|
125
+ | Audio (48 kHz) | **0.71x** | 7 – 12 s per file pair |
126
+ | Speech (16 kHz) | **0.38x** | ~1 s per file pair |
127
+
128
+ > RTF (Real-Time Factor) < 1.0 means faster than real-time.
129
+
130
+ ## Project Structure
131
+
132
+ ```
133
+ visqol-python/
134
+ ├── visqol/ # Main package
135
+ │ ├── __init__.py # Package exports
136
+ │ ├── api.py # Public API
137
+ │ ├── visqol_manager.py # Pipeline orchestrator
138
+ │ ├── visqol_core.py # Core algorithm
139
+ │ ├── audio_utils.py # Audio I/O & SPL normalization
140
+ │ ├── signal_utils.py # Envelope, cross-correlation
141
+ │ ├── analysis_window.py # Hann window
142
+ │ ├── gammatone.py # ERB + Gammatone filterbank + spectrogram
143
+ │ ├── patch_creator.py # Patch creation (Image + VAD modes)
144
+ │ ├── patch_selector.py # DP-based optimal patch matching
145
+ │ ├── alignment.py # Global alignment via cross-correlation
146
+ │ ├── nsim.py # NSIM similarity metric
147
+ │ ├── quality_mapper.py # SVR & exponential quality mapping
148
+ │ └── __main__.py # CLI entry point
149
+ ├── model/ # Bundled SVR model
150
+ │ └── libsvm_nu_svr_model.txt
151
+ ├── tests/ # Conformance tests
152
+ │ ├── test_conformance.py
153
+ │ └── test_quick.py
154
+ ├── setup.py
155
+ ├── requirements.txt
156
+ ├── LICENSE
157
+ └── README.md
158
+ ```
159
+
160
+ ## Conformance Test Results
161
+
162
+ Tested against the [official C++ ViSQOL v3.3.3](https://github.com/google/visqol) expected values:
163
+
164
+ | Test Case | Mode | Expected MOS | Python MOS | Δ |
165
+ |-----------|------|-------------|------------|---|
166
+ | strauss_lp35 | Audio | 1.3889 | 1.3889 | 0.000000 |
167
+ | steely_lp7 | Audio | 2.2502 | 2.2502 | 0.000000 |
168
+ | sopr_256aac | Audio | 4.6823 | 4.6823 | 0.000000 |
169
+ | ravel_128opus | Audio | 4.4651 | 4.4651 | 0.000000 |
170
+ | moonlight_128aac | Audio | 4.6843 | 4.6843 | 0.000000 |
171
+ | harpsichord_96mp3 | Audio | 4.2237 | 4.2237 | 0.000000 |
172
+ | guitar_64aac | Audio | 4.3497 | 4.3497 | 0.000000 |
173
+ | glock_48aac | Audio | 4.3325 | 4.3325 | 0.000000 |
174
+ | contrabassoon_24aac | Audio | 2.3469 | 2.3468 | 0.000117 |
175
+ | castanets_identity | Audio | 4.7321 | 4.7321 | 0.000000 |
176
+ | speech_CA01 | Speech | 3.3745 | 3.3678 | 0.006715 |
177
+
178
+ ## References
179
+
180
+ - [Google ViSQOL (C++)](https://github.com/google/visqol) — the original implementation this project is ported from
181
+ - Hines, A., Gillen, E., Kelly, D., Skoglund, J., Kokaram, A., & Harte, N. (2015). *ViSQOLAudio: An Objective Audio Quality Metric for Low Bitrate Codecs.* The Journal of the Acoustical Society of America.
182
+ - Chinen, M., Lim, F. S., Skoglund, J., Gureev, N., O'Gorman, F., & Hines, A. (2020). *ViSQOL v3: An Open Source Production Ready Objective Speech and Audio Metric.* 2020 Twelfth International Conference on Quality of Multimedia Experience (QoMEX).
183
+
184
+ ## License
185
+
186
+ Apache License 2.0. See [LICENSE](LICENSE) for details.
187
+
188
+ This project is a Python port of [Google's ViSQOL](https://github.com/google/visqol), which is also licensed under Apache 2.0.
@@ -0,0 +1,53 @@
1
+ [build-system]
2
+ requires = ["setuptools>=64", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "visqol-python"
7
+ version = "3.3.3"
8
+ description = "ViSQOL - Virtual Speech Quality Objective Listener (Pure Python)"
9
+ readme = "README.md"
10
+ license = "Apache-2.0"
11
+ requires-python = ">=3.8"
12
+ authors = [
13
+ {name = "Shan Jiang"},
14
+ ]
15
+ keywords = [
16
+ "audio-quality", "speech-quality", "MOS", "PESQ", "POLQA",
17
+ "visqol", "objective-metric", "perceptual-quality",
18
+ ]
19
+ classifiers = [
20
+ "Development Status :: 4 - Beta",
21
+ "Intended Audience :: Developers",
22
+ "Intended Audience :: Science/Research",
23
+ "Programming Language :: Python :: 3",
24
+ "Programming Language :: Python :: 3.8",
25
+ "Programming Language :: Python :: 3.9",
26
+ "Programming Language :: Python :: 3.10",
27
+ "Programming Language :: Python :: 3.11",
28
+ "Programming Language :: Python :: 3.12",
29
+ "Programming Language :: Python :: 3.13",
30
+ "Topic :: Multimedia :: Sound/Audio :: Analysis",
31
+ "Topic :: Scientific/Engineering",
32
+ ]
33
+ dependencies = [
34
+ "numpy>=1.20",
35
+ "scipy>=1.7",
36
+ "soundfile>=0.10",
37
+ "libsvm-official>=3.25",
38
+ ]
39
+
40
+ [project.urls]
41
+ Homepage = "https://github.com/talker93/visqol-python"
42
+ "Bug Reports" = "https://github.com/talker93/visqol-python/issues"
43
+ Source = "https://github.com/talker93/visqol-python"
44
+ "Original C++" = "https://github.com/google/visqol"
45
+
46
+ [project.scripts]
47
+ visqol = "visqol.__main__:main"
48
+
49
+ [tool.setuptools.packages.find]
50
+ exclude = ["tests*"]
51
+
52
+ [tool.setuptools.package-data]
53
+ visqol = ["model/*.txt"]
@@ -0,0 +1,4 @@
1
+ numpy>=1.20
2
+ scipy>=1.7
3
+ soundfile>=0.10
4
+ libsvm-official>=3.25
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+