README.rst 2.3 KB
Newer Older
André Anjos's avatar
André Anjos committed
1 2 3 4 5
.. vim: set fileencoding=utf-8 :
.. Andre Anjos <andre.anjos@idiap.ch>
.. Thu 29 Aug 2013 16:07:57 CEST

.. image:: http://img.shields.io/badge/docs-stable-yellow.png
André Anjos's avatar
André Anjos committed
6
   :target: http://pythonhosted.org/bob.io.audio/index.html
André Anjos's avatar
André Anjos committed
7
.. image:: http://img.shields.io/badge/docs-latest-orange.png
André Anjos's avatar
André Anjos committed
8
   :target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.io.audio/master/index.html
9 10 11 12
.. image:: https://travis-ci.org/bioidiap/bob.io.audio.svg?branch=master
   :target: https://travis-ci.org/bioidiap/bob.io.audio?branch=master
.. image:: https://coveralls.io/repos/bioidiap/bob.io.audio/badge.svg?branch=master
   :target: https://coveralls.io/r/bioidiap/bob.io.audio?branch=master
André Anjos's avatar
André Anjos committed
13
.. image:: https://img.shields.io/badge/github-master-0000c0.png
André Anjos's avatar
André Anjos committed
14 15 16 17 18
   :target: https://github.com/bioidiap/bob.io.audio/tree/master
.. image:: http://img.shields.io/pypi/v/bob.io.audio.png
   :target: https://pypi.python.org/pypi/bob.io.audio
.. image:: http://img.shields.io/pypi/dm/bob.io.audio.png
   :target: https://pypi.python.org/pypi/bob.io.audio
André Anjos's avatar
André Anjos committed
19 20

===========================
André Anjos's avatar
André Anjos committed
21
 Audio I/O Support for Bob
André Anjos's avatar
André Anjos committed
22 23
===========================

André Anjos's avatar
André Anjos committed
24 25 26 27
This package contains support for Audio I/O in Bob. Audio reading and writing
is implemented using SoX. By importing this package, you activate a transparent
plugin that makes possible reading and writing audio files using
``bob.io.base`` functionalities.
André Anjos's avatar
André Anjos committed
28 29 30

Installation
------------
André Anjos's avatar
André Anjos committed
31 32 33 34 35 36 37

To install this package -- alone or together with other `Packages of Bob
<https://github.com/idiap/bob/wiki/Packages>`_ -- please read the `Installation
Instructions <https://github.com/idiap/bob/wiki/Installation>`_.  For Bob_ to
be able to work properly, some dependent packages are required to be installed.
Please make sure that you have read the `Dependencies
<https://github.com/idiap/bob/wiki/Dependencies>`_ for your operating system.
André Anjos's avatar
André Anjos committed
38 39 40

Documentation
-------------
André Anjos's avatar
André Anjos committed
41 42 43 44 45 46 47

For further documentation on this package, please read the `Stable Version
<http://pythonhosted.org/bob.io.audio/index.html>`_ or the `Latest Version
<https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.io.audio/master/index.html>`_
of the documentation.  For a list of tutorials on this or the other packages ob
Bob_, or information on submitting issues, asking questions and starting
discussions, please visit its website.
André Anjos's avatar
André Anjos committed
48 49

.. _bob: https://www.idiap.ch/software/bob