Skip to content

Commit fb3b553

Browse files
committed
A bit more detail in the README
1 parent c3c7cbf commit fb3b553

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

README.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,26 @@ sphfile
55
:target: https://pypi.python.org/pypi/sphfile
66
:alt: Latest PyPI version
77

8-
Numpy-based NIST SPH audio-file reader
8+
Numpy-based NIST SPH audio-file reader. This is for use
9+
with NIST SPH audio-files, the most likely use being
10+
extracting the TEDLIUM_release2 audio into formats that
11+
standard tools can easily process.
12+
13+
Note that this library doesn't require any external tools
14+
such as `vox` or `gstreamer`. It just loads the data into a
15+
numpy array and then lets you dump it back out to wave
16+
files.
917

1018
Usage
1119
-----
1220

1321
.. code:: python
1422
1523
from sphfile import SPHFile
16-
sph =SPHFile( '/var/datasets/TEDLIUM_release2/test/sph/JamesCameron_2010.sph' )
24+
sph =SPHFile(
25+
'TEDLIUM_release2/test/sph/JamesCameron_2010.sph'
26+
)
27+
# Note that the following loads the whole file into ram
1728
print( sph.format )
1829
# write out a wav file with content from 111.29 to 123.57 seconds
1930
sph.write_wav( 'test.wav', 111.29, 123.57 )
@@ -26,7 +37,7 @@ Requirements
2637
Licence
2738
-------
2839

29-
MIT
40+
MIT License (c) 2017 Mike C. Fletcher
3041

3142
Authors
3243
-------

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
numpy

0 commit comments

Comments
 (0)