scikit-sound - Documentation

scikit-sound is a library for working with sound files.

It is hosted under https://github.com/thomas-haslwanter/scikit-sound. The main module: sounds has two classes for working with sounds:

The class Sounds lets you

The class FFMPEG_info handles the detection of FFMPEG, and the config-information for Python:

The Python standard libraries and scipy provide good support for working with WAV files. If you also want to work with other file formats (MP3, AAC, etc), the easiest way is to install the open-source software FFMPEG on your computer. You can obtain FFMPEG for free from http://ffmpeg.org

For more information, please check the help on the method Sounds.sound()

In addition, the module misc provides GUI-utilities for dir- and file-selection etc.

Installation

The simplest way to install sksound is

>>> pip install scikit-sound

For upgrading to the latest version of sksound, you have to type

>>> pip install scikit-sound -U

However, you can also install from the source files. To do this, just go to the root directory of the package, and type

>>> python setup.py install

Note: After sksound is installed, I typically import it in Python with:

>>> import sksound

Dependencies

numpy, scipy, appdirs, pygame

Testing

The easiest way to test the package is with unittest. Open a terminal, and type (on the command-line!):

>>> cd [_your_installation_dir_]\sksound\tests
>>> python -m unittest

Indices and tables

Note

Author: Thomas Haslwanter
Version: 0.2.1
Date: March 2018
Copyright (c): 2018, Thomas Haslwanter. All rights reserved.
Licence: This work is licensed under the BSD 2-Clause License