{"author":"Pyworld Contributors","author_email":"jeremycchsu@gmail.com","bugtrack_url":null,"classifiers":[],"description":"# PyWORLD - A Python wrapper of WORLD Vocoder\n\n\n| **`Linux`** | **`Windows`** |\n|-----------------|-----------|\n| [![Build Status](https://app.travis-ci.com/JeremyCCHsu/Python-Wrapper-for-World-Vocoder.svg?branch=master)](https://app.travis-ci.com/JeremyCCHsu/Python-Wrapper-for-World-Vocoder) | [![Build Status](https://ci.appveyor.com/api/projects/status/github/JeremyCCHsu/Python-Wrapper-for-World-Vocoder?svg=true)](https://ci.appveyor.com/project/JeremyCCHsu/python-wrapper-for-world-vocoder) |\n\n\n\n\nWORLD Vocoder is a fast and high-quality vocoder\nwhich parameterizes speech into three components:\n\n 1. `f0`: Pitch contour\n 2. `sp`: Harmonic spectral envelope\n 3. `ap`: Aperiodic spectral envelope (relative to the harmonic spectral envelope)\n\nIt can also (re)synthesize speech using these features (see examples below).\n\nFor more information, please visit Dr. Morise's [WORLD repository](https://github.com/mmorise/World)\nand the [official website of WORLD Vocoder](http://ml.cs.yamanashi.ac.jp/world/english)\n\n\n## APIs\n\n### Vocoder Functions\n```python\nimport pyworld as pw\n_f0, t = pw.dio(x, fs) # raw pitch extractor\nf0 = pw.stonemask(x, _f0, t, fs) # pitch refinement\nsp = pw.cheaptrick(x, f0, t, fs) # extract smoothed spectrogram\nap = pw.d4c(x, f0, t, fs) # extract aperiodicity\n\ny = pw.synthesize(f0, sp, ap, fs) # synthesize an utterance using the parameters\n```\n\n\n### Utility\n```python\n# Convert speech into features (using default arguments)\nf0, sp, ap = pw.wav2world(x, fs)\n```\n
\n\nYou can change the default arguments of the function, too.\nSee more info using `help`.\n\n\n## Installation\n\n### Using Pip\n`pip install pyworld`\n
\n\n### Building from Source\n```bash\ngit clone https://github.com/JeremyCCHsu/Python-Wrapper-for-World-Vocoder.git\ncd Python-Wrapper-for-World-Vocoder\ngit submodule update --init\npip install -U pip\npip install -r requirements.txt\npip install .\n```\nIt will automatically `git clone` Morise's World Vocoder (C++ version).
\n(It seems to me that using `virtualenv` or `conda` is the best practice.)
\n
\n\n### Installation Validation\nYou can validate installation by running\n```bash\ncd demo\npython demo.py\n```\nto see if you get results in `test/` direcotry.\n(Please avoid writing and executing codes in the `Python-Wrapper-for-World-Vocoder` folder for now.)
\n\n### Environment/Dependencies\n- Operating systems\n - Linux Ubuntu 14.04+\n - Windows (thanks to [wuaalb](https://github.com/wuaalb))\n - WSL\n- Python\n - 3.7+\n\nYou can install dependencies these by `pip install -r requirements.txt`\n\n\n\n## Notice\n- WORLD vocoder is designed for speech sampled ≥ 16 kHz.\n Applying WORLD to 8 kHz speech will fail.\n See a possible workaround [here](https://github.com/JeremyCCHsu/Python-Wrapper-for-World-Vocoder/issues/54).\n- When the SNR is low, extracting pitch using `harvest` instead of `dio`\n is a better option.\n\n\n## Troubleshooting\n1. Upgrade your Cython version to 0.24.
\n (I failed to build it on Cython 0.20.1post0)
\n It'll require you to download Cython form http://cython.org/
\n Unzip it, and `python setup.py install` it.
\n (I tried `pip install Cython` but the upgrade didn't seem correct)
\n (Again, add `--user` if you don't have root access.)\n2. 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):
\n\n ```python\n import matplotlib\n matplotlib.use('Agg')\n ```\n3. If you encounter `library not found: sndfile` error upon executing `demo.py`,\n you might have to install it by `apt-get install libsoundfile1`.\n You can also replace `pysoundfile` with `scipy` or `librosa`, but some modification is needed:\n - librosa:\n - load(fiilename, dtype=np.float64)\n - output.write_wav(filename, wav, fs)\n - remember to pass `dtype` argument to ensure that the method gives you a `double`.\n - scipy:\n - You'll have to write a customized utility function based on the following methods\n - scipy.io.wavfile.read (but this gives you `short`)\n - scipy.io.wavfile.write\n\n4. If you have installation issue on Windows, I probably could not provide\n much help because my development environment is Ubuntu\n and Windows Subsystem for Linux ([read this if you are interested in installing it](https://github.com/JeremyCCHsu/wsl)).\n\n\n### Other Installation Suggestions\n1. Use `pip install .` is safer and you can easily uninstall pyworld by `pip uninstall pyworld`\n - For Mac users: You might need to do `MACOSX_DEPLOYMENT_TARGET=10.9 pip install .` See [issue](https://github.com/SeanNaren/warp-ctc/issues/129#issuecomment-502349652).\n2. Another way to install pyworld is via
\n `python setup.py install`
\n - Add `--user` if you don't have root access
\n - Add `--record install.txt` to track the installation dir
\n3. If you just want to try out some experiments, execute
\n `python setup.py build_ext --inplace`
\n Then you can use PyWorld from this directory.
\n You can also copy the resulting **pyworld.so** (pyworld.{arch}.pyd on Windows) file to\n `~/.local/lib/python2.7/site-packages` (or corresponding Windows directory)\n so that you can use it everywhere like an installed package.
\n Alternatively you can copy/symlink the compiled files using pip, e.g. `pip install -e .`\n\n\n\n## Acknowledgement\nThank all contributors ([tats-u](https://github.com/tats-u), [wuaalb](https://github.com/wuaalb), [r9y9](https://github.com/r9y9), [rikrd](https://github.com/rikrd), [kudan2510](https://github.com/kundan2510), [sabonerune](https://github.com/sabonerune)) for making this repo better and [sotelo](https://github.com/sotelo) whose [world.py](https://github.com/sotelo/world.py) inspired this repo.
\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/JeremyCCHsu/Python-Wrapper-for-World-Vocoder","keywords":"vocoder","license":null,"license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"pyworld","package_url":"https://pypi.org/project/pyworld/","platform":null,"project_url":"https://pypi.org/project/pyworld/","project_urls":{"Homepage":"https://github.com/JeremyCCHsu/Python-Wrapper-for-World-Vocoder"},"provides_extra":["test","sdist"],"release_url":"https://pypi.org/project/pyworld/0.3.5/","requires_dist":["numpy","nose; extra == \"test\"","numpy; extra == \"sdist\"","cython>=0.24; extra == \"sdist\""],"requires_python":null,"summary":"PyWorld: a Python wrapper for WORLD vocoder","version":"0.3.5","yanked":false,"yanked_reason":null}

Dependencies of pyworld (3).
Dependency	Optional
numpy	false
cython	true
nose	true

Package search

pyworld

project_urls

Dependencies

All package metadata

Releases