Input/Output
============

.. currentmodule:: pyvoimooo

.. function:: readwav(filepath)

    Read a waveform from a lossless encoding using `libsndfile <https://github.com/libsndfile/libsndfile>`_.

    :arg filepath: The file from which to read the waveform.
    :type filepath: str

    :return:

        - **wav** (`array<float>`) - The waveform as an array of floats

        - **fs** (`int`,Hz) - The sampling frequency.

    .. note:: If the corresponding functions cannot be found in the wrapper
        (e.g. Voimooo has been compiled without libsndfile support),
        `scipy.io.wavfile.read` will be used instead, thus supporting only
        simple PCM wav format.

    .. versionadded:: 0.8.9


.. function:: writewav(filepath, fs, wav)

    Write down a waveform into a file using a PCM wav format.

    :arg filepath: The file where the waveform is written.
    :type filepath: str

    :arg fs: The sampling rate.
    :type fs: int, Hz

    :arg wav: The waveform.
    :type wav: array<float>

    .. note:: If the corresponding functions cannot be found in the wrapper
        (e.g. Voimooo has been compiled without libsndfile support),
        `scipy.io.wavfile.write` will be used instead.

    .. versionadded:: 0.8.9