Skip to content

Commit 23f92ec

Browse files
committed
Update readme
1 parent 9afc0b5 commit 23f92ec

File tree

3 files changed

+16
-20
lines changed

3 files changed

+16
-20
lines changed

BUILDING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ pip wheel -v .
2020
### (Alternative method) Build using system libsoxr
2121
libsoxr should be installed before building. (e.g. `sudo apt install libsoxr-dev`)
2222
```
23-
pip wheel -v . --config-settings=cmake.define.USE_SYSTEM_LIBSOXR=ON
23+
pip wheel -v . -C cmake.define.USE_SYSTEM_LIBSOXR=ON
2424
```
2525
It will link libsoxr dynamically and won't bundle libsoxr in the wheel package.
2626

README.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -79,16 +79,11 @@ Output frame count may not be consistent. This is normal operation.
7979
📝 [More code examples](https://dofuuz.github.io/dsp/2024/05/26/sample-rate-conversion-in-python.html)
8080

8181

82-
## Requirement
83-
84-
x86 and ARM processors are supported.
85-
86-
8782
## Benchmark
8883

89-
Sweep, impulse, speed compairsion with other Python resamplers.
84+
Sweep, impulse, speed compairsion with other resamplers for Python.
9085

91-
https://colab.research.google.com/drive/1XgSOvWlRIau1FYwQG_yRSAhDK3KB8bEL?usp=sharing
86+
https://colab.research.google.com/drive/1_xYUs00VWYOAXShB85W1MFWaUjGHfO4K?usp=sharing
9287

9388

9489
### Speed comparison summary
@@ -98,16 +93,16 @@ Ran on Google Colab.
9893

9994
Library | Time on CPU (ms)
10095
------------------------ | ----------------
101-
soxr (HQ) | 7.2
102-
scipy.signal.resample | 13.4
103-
soxr (VHQ) | 15.8
104-
torchaudio | 19.2
105-
lilfilter | 21.4
106-
julius | 23.1
107-
resampy (kaiser_fast) | 62.6
108-
samplerate (sinc_medium) | 92.5
109-
resampy (kaiser_best) | 256
110-
samplerate (sinc_best) | 397
96+
soxr (HQ) | 10.8
97+
torchaudio | 13.8
98+
soxr (VHQ) | 14.5
99+
scipy.signal.resample | 21.3
100+
lilfilter | 24.7
101+
julius | 31
102+
resampy (kaiser_fast) | 108
103+
samplerate (sinc_medium) | 223
104+
resampy (kaiser_best) | 310
105+
samplerate (sinc_best) | 794
111106

112107

113108
## Technical detail
@@ -117,9 +112,9 @@ For technical details behind resampler, see libsoxr docs.
117112
- http://sox.sourceforge.net/SoX/Resampling ([archive](https://web.archive.org/web/20230626144127/https://sox.sourceforge.net/SoX/Resampling))
118113
- https://sourceforge.net/p/soxr/code/ci/master/tree/src/soxr.h
119114

120-
Python-SoXR uses [forked version](https://github.com/dofuuz/soxr) of libsoxr. [See difference here](https://github.com/dofuuz/soxr/compare/0.1.3...master).
115+
Python-SoXR uses [modified version](https://github.com/dofuuz/soxr) of libsoxr. [See changes here](https://github.com/dofuuz/soxr/compare/0.1.3...master).
121116
These changes does not apply to dynamic linked builds. (e.g. conda-forge build)
122-
To determine the version of libsoxr, use `soxr.__libsoxr_version__`.
117+
To check the version of libsoxr, use `soxr.__libsoxr_version__`.
123118

124119

125120
## Credit and License

tests/bench.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626

2727
print(f'{soxr.__version__ = }')
2828
print(f'{soxr.__libsoxr_version__ = }')
29+
print(f'{QUALITY = }')
2930

3031
# generate signal
3132
offset = 2000

0 commit comments

Comments
 (0)