Skip to content

Commit 4d91906

Browse files
wtq2255wtq2255
authored
Merge pull request #34 from wtq2255/master
update v0.1.8
2 parents 51a5314 + d87ef69 commit 4d91906

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+2090
-164
lines changed

‎LICENSE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## MIT License
22

3-
Copyright (c) 2021--2023, `audioFlux` development team.
3+
Copyright (c) 2021--2024, `audioFlux` development team.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,6 @@
22

33
# audioFlux
44

5-
<!--<p align="center">
6-
<img src='./image/logo.png' width="380" style="max-width: 100%;" >
7-
</p>-->
8-
9-
10-
<!--
11-
[![Pypi Downloads](https://img.shields.io/pypi/dm/aubio.svg?label=Pypi%20downloads)](https://pypi.org/project/aubio/)
12-
[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/aubio.svg?label=Conda%20downloads)](https://anaconda.org/conda-forge/aubio)
13-
[![Documentation](https://readthedocs.org/projects/aubio/badge/?version=latest)](http://aubio.readthedocs.io/en/latest/?badge=latest "Latest documentation") -->
14-
<!--![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/libAudioFlux/audioFlux)-->
15-
165
<!-- shields.io -->
176
![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/libAudioFlux/audioFlux/build.yml?branch=master)
187
![example branch parameter](https://github.com/libAudioFlux/audioFlux/actions/workflows/build.yml/badge.svg?branch=master)
@@ -39,6 +28,13 @@ field such as Classification, Separation, Music Information Retrieval(MIR) and A
3928
- High performance, core part C implementation, FFT hardware acceleration based on different platforms, convenient for large-scale data feature extraction.
4029
- It supports the mobile end and meets the real-time calculation of audio stream at the mobile end. -->
4130

31+
32+
##### New Features
33+
* v0.1.8
34+
* Add a variety of Pitch algorithms: `YIN`, `CEP`, `PEF`, `NCF`, `HPS`, `LHS`, `STFT` and `FFP`.
35+
* Add `PitchShift` and `TimeStretch` algorithms.
36+
37+
4238
### Table of Contents
4339

4440
- [Overview](#overview)

‎conda/meta.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{% set version = "0.1.7" %}
1+
{% set version = "0.1.8" %}
22

33
package:
44
name: audioflux

‎docs/_static/versions.json‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
[
22
{
3-
"name": "0.1.7 (stable)",
4-
"version": "0.1.7",
3+
"name": "0.1.8 (stable)",
4+
"version": "0.1.8",
55
"url": "https://audioflux.top/stable/"
66
},
7+
{
8+
"name": "0.1.7",
9+
"version": "0.1.7",
10+
"url": "https://audioflux.top/v0.1.7/"
11+
},
712
{
813
"name": "0.1.6",
914
"version": "0.1.6",

‎docs/changelog.rst‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
ChangeLog
22
=========
3+
v0.1.8
4+
------
5+
* New features:
6+
* Add `audioflux.STFT` algorithm.
7+
* Add `audioflux.PitchFFP` algorithm.
8+
* Add `audioflux.PitchShift` and `audioflux.TimeStretch` algorithms.
9+
* Add method `temporal` to `audioflux.Temporal`.
10+
* Optimize performance.
11+
* Fix bug:
12+
* Fix `nmf` bug.
13+
314
v0.1.7
415
------
516
* New features:
6-
* Add Cepstrogram algorithm.
17+
* Add `audioflux.Cepstrogram` algorithm.
718
* Add PitchCEP/PitchHPS/PitchLHS/PitchNCF/PitchPEF/PitchSTFT/PitchYIN algorithm.
819
* Modified API:
920
* `audioflux.display.fill_wave` add `times` params.

‎docs/installation.rst‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ Linux build
7979
# For CentOS:
8080
$ sudo yum install -y cmake clang
8181

82-
2. Installing **MKL** lib dependencies on Linux
82+
2. Installing **MKL** lib dependencies on Linux (Optional, Recommended installation)
8383

8484
You can
85-
use `this installation document <https://www.intel.cn/content/www/cn/zh/developer/tools/oneapi/onemkl-download.html?operatingsystem=linux>`_
85+
use `this installation document <https://www.intel.com/content/www/us/en/developer/tools/oneapi/onemkl-download.html?operatingsystem=linux>`_
8686
to install MKL
8787

8888
After installation, you need to set the environment variable `MKL_INCLUDE_PATH` and `MKL_LIB_PATH` for MKL.
@@ -128,8 +128,9 @@ macOS build
128128
Windows build
129129
^^^^^^^^^^^^^
130130

131-
Building from source is currently not supported. Only supports pip installation. If you need to build from source, The
132-
easiest way to build audioFlux is by cross-compilation on Linux/macOS using MinGW::
131+
Building from source code is currently not supported on Windows; it is recommended to use pip installation.
132+
133+
If you need to build from source, The easiest way to build audioFlux is by cross-compilation on Linux/macOS using MinGW.::
133134

134135
$ python setup.py build_py_win
135136
$ python setup.py install

‎docs/installing.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,10 @@ Build and compile successfully, the project build compilation results are in the
8484
$ sudo yum install -y cmake clang
8585
```
8686

87-
2. Installing **MKL** lib dependencies on Linux
87+
2. Installing **MKL** lib dependencies on Linux (Optional, Recommended installation)
8888

8989
You can
90-
use [this installation document](https://www.intel.cn/content/www/cn/zh/developer/tools/oneapi/onemkl-download.html?operatingsystem=linux)
90+
use [this installation document](https://www.intel.com/content/www/us/en/developer/tools/oneapi/onemkl-download.html?operatingsystem=linux)
9191
to install MKL
9292

9393
After installation, you need to set the environment variable `MKL_INCLUDE_PATH` and `MKL_LIB_PATH` for MKL.
@@ -151,8 +151,9 @@ Build and compile successfully, the project build compilation results are in the
151151

152152
#### Windows build
153153

154-
Building from source is currently not supported. Only supports pip installation. If you need to build from source, The
155-
easiest way to build audioFlux is by cross-compilation on Linux/macOS using MinGW.
154+
Building from source code is currently not supported on Windows; it is recommended to use pip installation.
155+
156+
If you need to build from source, The easiest way to build audioFlux is by cross-compilation on Linux/macOS using MinGW.
156157

157158
```shell
158159
$ python setup.py build_py_win

‎docs/mir/harmonics.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Harmonics
2+
=========
3+
4+
.. autoclass:: audioflux.Harmonic
5+
:members:
6+
7+
.. autoclass:: audioflux.HarmonicRatio
8+
:members:

‎docs/mir/mir.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ The mir module contains the following algorithms:
99
pitch
1010
onsetBase
1111
hpss
12+
harmonics
13+
pitchShift
14+
timeStretch
15+
1216

1317
+-----------------+---------------------------------+
1418
| MIR | algorithm |

‎docs/mir/pitch.rst‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
Pitch
22
=====
33

4+
.. autoclass:: audioflux.PitchYIN
5+
:members:
6+
7+
.. autoclass:: audioflux.PitchPEF
8+
:members:
9+
410
.. autoclass:: audioflux.PitchCEP
511
:members:
612

@@ -13,11 +19,8 @@ Pitch
1319
.. autoclass:: audioflux.PitchNCF
1420
:members:
1521

16-
.. autoclass:: audioflux.PitchPEF
17-
:members:
18-
1922
.. autoclass:: audioflux.PitchSTFT
2023
:members:
2124

22-
.. autoclass:: audioflux.PitchYIN
25+
.. autoclass:: audioflux.PitchFFP
2326
:members:

0 commit comments

Comments
 (0)