A Python wrapper for the high-quality vocoder "World"
Clone or download
Latest commit 823e9bd Oct 27, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo Small reorganizing May 10, 2017
lib Update WORLD to upstream Oct 25, 2018
pyworld update readme Oct 26, 2018
.gitignore merge Jun 26, 2017
.gitmodules Add world as a submodule Apr 20, 2017
.travis.yml remove comments Sep 21, 2018
LICENSE Build-time dependency solving with 2 hacks (numpy & cython) Aug 10, 2017
MANIFEST.in Add license Aug 10, 2017
README.md test Sep 20, 2018
appveyor.yml update appveyor Oct 26, 2018
requirements.txt use libsoundfile Mar 1, 2017
setup.cfg Add pip Jun 26, 2017
setup.py update appveyor Oct 26, 2018

README.md

PyWorldVocoder - A Python wrapper for World Vocoder

Linux Windows
Build Status Build Status

Morise's World Vocoder is a fast and high-quality vocoder. World Vocoder parameterizes speech into three components:

  1. Pitch (fundamental frequency, F0) contour
  2. Harmonic spectral envelope
  3. Aperiodic spectral envelope (relative to the harmonic spectral envelope)

It can also resynthesize speech using these features (see examples below).

For more information, please visit Morise's World repository and the official website of World Vocoder

I. APIs

Vocoder Functions

import pyworld as pw
_f0, t = pw.dio(x, fs)    # raw pitch extractor
f0 = pw.stonemask(x, _f0, t, fs)  # pitch refinement
sp = pw.cheaptrick(x, f0, t, fs)  # extract smoothed spectrogram
ap = pw.d4c(x, f0, t, fs)         # extract aperiodicity
y = pw.synthesize(f0, sp, ap, fs)

Utility

# Convert speech into features (using default options)
f0, sp, ap = pw.wav2world(x, fs)

II. Installation

Pip installation

pip install pyworld

Installing from Github

git clone https://github.com/JeremyCCHsu/Python-Wrapper-for-World-Vocoder.git
cd Python-Wrapper-for-World-Vocoder
git submodule update --init
pip install -U pip
pip install -r requirements.txt
pip install .

It will automatically git clone Morise's World Vocoder (C++ version).
(It seems to me that using virtualenv or conda is the best practice.)

You can validate installation by running

cd demo
python demo.py

to see if you get results in test/ direcotry. (Please avoid writing and executing codes in the Python-Wrapper-for-World-Vocoder folder for now.)

Other Installation Suggestions

  1. Use pip install . is safer and you can easily uninstall pyworld by pip uninstall pyworld
  2. Another way to install pyworld is via
    python setup.py install
    • Add --user if you don't have root access
    • Add --record install.txt to track the installation dir
  3. If you just want to try out some experiments, execute
    python setup.py build_ext --inplace
    Then you can use PyWorld from this directory.
    You can also copy the resulting pyworld.so (pyworld.{arch}.pyd on Windows) file to ~/.local/lib/python2.7/site-packages (or corresponding Windows directory) so that you can use it everywhere like an installed package.
    Alternatively you can copy/symlink the compiled files using pip, e.g. pip install -e .

Environment/Dependencies

  • Operating systems
    • Linux Ubuntu 16.04/14.04
    • Windows (thanks to wuaalb)
  • Python
    • 2.7 (Windows is currently not supported)
    • 3.7/3.6/3.5
    • Required packages
      • Cython 0.24 (or later versions; required)
      • Numpy
    • Optional (for demo.py only)
      • argparse
      • pysoundfile
      • Matplotlib

You can simply install these by pip install -r requirements.txt

Troubleshooting

  1. Upgrade your Cython version to 0.24.
    (I failed to build it on Cython 0.20.1post0)
    It'll require you to download Cython form http://cython.org/
    Unzip it, and python setup.py install it.
    (I tried pip install Cython but the upgrade didn't seem correct)
    (Again, add --user if you don't have root access.)
  2. Upon executing demo/demo.py, the following code might be needed in some environments (e.g. when you're working on a remote Linux server):
import matplotlib
matplotlib.use('Agg')
  1. If you encounter library not found: sndfile error upon executing demo.py,
    you might have to install it by apt-get install libsoundfile1.
    You can also replace pysoundfile with scipy or librosa, but some modification is needed:
    • librosa:
      • load(fiilename, dtype=np.float64)
      • output.write_wav(filename, wav, fs)
      • remember to pass dtype argument to ensure that the method gives you a double.
    • scipy:
      • You'll have to write a customized utility function based on the following methods
      • scipy.io.wavfile.read (but this gives you short)
      • scipy.io.wavfile.write

TODO List

  • Realtime synthesizer

Acknowledgement

Thank all contributors (tats-u, wuaalb, r9y9, rikrd, kudan2510) for making this repo better and sotelo whose world.py inspired this repo.