bmcfee / pyrubberband / 82

pending completion

Build # 82

Build Type

push

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/bmcfee/pyrubberband/commit/<a class=hub.com/bmcfee/pyrubberband/commit/84ca1fe66dd9b36b2dd5a660b13fede405ec766b">84ca1fe66<a href="https://github.com/bmcfee/pyrubberband/commit/84ca1fe66dd9b36b2dd5a660b13fede405ec766b">">Merge </a><a class="double-link" href="https://github.com/bmcfee/pyrubberband/commit/<a class="double-link" href="https://github.com/bmcfee/pyrubberband/commit/5e294506e4d98e6f450b96a319a3eac23977d559">5e294506e</a>">5e294506e</a><a href="https://github.com/bmcfee/pyrubberband/commit/84ca1fe66dd9b36b2dd5a660b13fede405ec766b"> into 94ba847b9">94ba847b9</a>

Run Details

26 of 26 new or added lines in 1 file covered. (100.0%)

76 of 79 relevant lines covered (96.2%)

2.85 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.0

/pyrubberband/pyrb.py

#!/usr/bin/env python
# CREATED:2015-03-02 11:36:15 by Brian McFee <brian.mcfee@nyu.edu>
'''Command-line wrapper for rubberband

.. autosummary::
    :toctree: generated/

    time_stretch
    pitch_shift
'''


import os
import six
import subprocess
import tempfile
import numpy as np
import soundfile as sf


__all__ = ['time_stretch', 'pitch_shift', 'timemap_stretch']

__RUBBERBAND_UTIL = 'rubberband'

if six.PY2:
    DEVNULL = open(os.devnull, 'w')
else:
    DEVNULL = subprocess.DEVNULL


def __rubberband(y, sr, **kwargs):
    '''Execute rubberband

    Parameters
    ----------
    y : np.ndarray [shape=(n,) or (n, c)]
        Audio time series, either single or multichannel

    sr : int > 0
        sampling rate of y

    **kwargs
        keyword arguments to rubberband

    Returns
    -------
    y_mod : np.ndarray [shape=(n,) or (n, c)]
        `y` after rubberband transformation

    '''

    assert sr > 0

    # Get the input and output tempfile
    fd, infile = tempfile.mkstemp(suffix='.wav')
    os.close(fd)
    fd, outfile = tempfile.mkstemp(suffix='.wav')
    os.close(fd)

    # dump the audio
    sf.write(infile, y, sr)

    try:
        # Execute rubberband
        arguments = [__RUBBERBAND_UTIL, '-q']

        for key, value in six.iteritems(kwargs):
            arguments.append(str(key))
            arguments.append(str(value))

        arguments.extend([infile, outfile])

        subprocess.check_call(arguments, stdout=DEVNULL, stderr=DEVNULL)

        # Load the processed audio.
        y_out, _ = sf.read(outfile, always_2d=True)

        # make sure that output dimensions matches input
        if y.ndim == 1:
            y_out = np.squeeze(y_out)

    except OSError as exc:
        six.raise_from(RuntimeError('Failed to execute rubberband. '
                                    'Please verify that rubberband-cli '
                                    'is installed.'),
                       exc)

    finally:
        # Remove temp files
        os.unlink(infile)
        os.unlink(outfile)

    return y_out


def time_stretch(y, sr, rate, rbargs=None):
    '''Apply a time stretch of `rate` to an audio time series.

    This uses the `tempo` form for rubberband, so the
    higher the rate, the faster the playback.


    Parameters
    ----------
    y : np.ndarray [shape=(n,) or (n, c)]
        Audio time series, either single or multichannel

    sr : int > 0
        Sampling rate of `y`

    rate : float > 0
        Desired playback rate.

    rbargs
        Additional keyword parameters for rubberband

        See `rubberband -h` for details.

    Returns
    -------
    y_stretch : np.ndarray
        Time-stretched audio

    Raises
    ------
    ValueError
        if `rate <= 0`
    '''

    if rate <= 0:
        raise ValueError('rate must be strictly positive')

    if rate == 1.0:
        return y

    if rbargs is None:
        rbargs = dict()

    rbargs.setdefault('--tempo', rate)

    return __rubberband(y, sr, **rbargs)


def timemap_stretch(y, sr, time_map, rbargs=None):
    '''Apply a timemap stretch to an audio time series.

    A timemap stretch allows non-linear time-stretching by mapping source to
    target sample frame numbers for fixed time points within the audio data.

    This uses the `time` and `timemap` form for rubberband.

    Parameters
    ----------
    y : np.ndarray [shape=(n,) or (n, c)]
        Audio time series, either single or multichannel

    sr : int > 0
        Sampling rate of `y`

    time_map : list
        Each element is a tuple `t` of length 2 which corresponds to the
        source sample position and target sample position.

        If `t[1] < t[0]` the track will be sped up in this area.

        `time_map[-1]` must correspond to the lengths of the source audio and
        target audio.

    rbargs
        Additional keyword parameters for rubberband

        See `rubberband -h` for details.

    Returns
    -------
    y_stretch : np.ndarray
        Time-stretched audio

    Raises
    ------
    ValueError
        if `time_map` is not monotonic
        if `time_map` is not non-negative
        if `time_map[-1][0]` is not the input audio length
    '''

    if rbargs is None:
        rbargs = dict()

    is_positive = all(time_map[i][0] >= 0 and time_map[i][1] >= 0
                      for i in range(len(time_map)))
    is_monotonic = all(time_map[i][0] <= time_map[i+1][0] and
                       time_map[i][1] <= time_map[i+1][1]
                       for i in range(len(time_map)-1))
    if not is_positive:
        raise ValueError('time_map should be non-negative')

    if not is_monotonic:
        raise ValueError('time_map is not monotonic')

    if time_map[-1][0] != len(y):
        raise ValueError('time_map[-1] should correspond to the last sample')

    time_stretch = time_map[-1][1] * 1.0 / time_map[-1][0]
    rbargs.setdefault('--time', time_stretch)

    stretch_file = tempfile.NamedTemporaryFile(mode='w', suffix='.txt',
                                               delete=False)
    try:
        for t in time_map:
            stretch_file.write('{:0} {:1}\n'.format(t[0], t[1]))
        stretch_file.close()

        rbargs.setdefault('--timemap', stretch_file.name)
        y_stretch = __rubberband(y, sr, **rbargs)
    except:
        print(sys.exc_info()[0])
        raise
    finally:
        # Remove temp file
        os.unlink(stretch_file.name)

    return y_stretch


def pitch_shift(y, sr, n_steps, rbargs=None):
    '''Apply a pitch shift to an audio time series.

    Parameters
    ----------
    y : np.ndarray [shape=(n,) or (n, c)]
        Audio time series, either single or multichannel

    sr : int > 0
        Sampling rate of `y`

    n_steps : float
        Shift by `n_steps` semitones.

    rbargs
        Additional keyword parameters for rubberband

        See `rubberband -h` for details.

    Returns
    -------
    y_shift : np.ndarray
        Pitch-shifted audio
    '''

    if n_steps == 0:
        return y

    if rbargs is None:
        rbargs = dict()

    rbargs.setdefault('--pitch', n_steps)

    return __rubberband(y, sr, **rbargs)

1	#!/usr/bin/env python
2	# CREATED:2015-03-02 11:36:15 by Brian McFee <brian.mcfee@nyu.edu>
3	'''Command-line wrapper for rubberband	3✔
4
5	.. autosummary::
6	:toctree: generated/
7
8	time_stretch
9	pitch_shift
10	'''
11
12
13	import os	3✔
14	import six	3✔
15	import subprocess	3✔
16	import tempfile	3✔
17	import numpy as np	3✔
18	import soundfile as sf	3✔
19
20
21	__all__ = ['time_stretch', 'pitch_shift', 'timemap_stretch']	3✔
22
23	__RUBBERBAND_UTIL = 'rubberband'	3✔
24
25	if six.PY2:	3✔
26	DEVNULL = open(os.devnull, 'w')	1✔
27	else:
28	DEVNULL = subprocess.DEVNULL	2✔
29
30
31	def __rubberband(y, sr, **kwargs):	3✔
32	'''Execute rubberband
33
34	Parameters
35	----------
36	y : np.ndarray [shape=(n,) or (n, c)]
37	Audio time series, either single or multichannel
38
39	sr : int > 0
40	sampling rate of y
41
42	**kwargs
43	keyword arguments to rubberband
44
45	Returns
46	-------
47	y_mod : np.ndarray [shape=(n,) or (n, c)]
48	`y` after rubberband transformation
49
50	'''
51
52	assert sr > 0	3✔
53
54	# Get the input and output tempfile
55	fd, infile = tempfile.mkstemp(suffix='.wav')	3✔
56	os.close(fd)	3✔
57	fd, outfile = tempfile.mkstemp(suffix='.wav')	3✔
58	os.close(fd)	3✔
59
60	# dump the audio
61	sf.write(infile, y, sr)	3✔
62
63	try:	3✔
64	# Execute rubberband
65	arguments = [__RUBBERBAND_UTIL, '-q']	3✔
66
67	for key, value in six.iteritems(kwargs):	3✔
68	arguments.append(str(key))	3✔
69	arguments.append(str(value))	3✔
70
71	arguments.extend([infile, outfile])	3✔
72
73	subprocess.check_call(arguments, stdout=DEVNULL, stderr=DEVNULL)	3✔
74
75	# Load the processed audio.
76	y_out, _ = sf.read(outfile, always_2d=True)	3✔
77
78	# make sure that output dimensions matches input
79	if y.ndim == 1:	3✔
80	y_out = np.squeeze(y_out)	3✔
81
82	except OSError as exc:	3✔
83	six.raise_from(RuntimeError('Failed to execute rubberband. '	3✔
84	'Please verify that rubberband-cli '
85	'is installed.'),
86	exc)
87
88	finally:
89	# Remove temp files
90	os.unlink(infile)	3✔
91	os.unlink(outfile)	3✔
92
93	return y_out	3✔
94
95
96	def time_stretch(y, sr, rate, rbargs=None):	3✔
97	'''Apply a time stretch of `rate` to an audio time series.
98
99	This uses the `tempo` form for rubberband, so the
100	higher the rate, the faster the playback.
101
102
103	Parameters
104	----------
105	y : np.ndarray [shape=(n,) or (n, c)]
106	Audio time series, either single or multichannel
107
108	sr : int > 0
109	Sampling rate of `y`
110
111	rate : float > 0
112	Desired playback rate.
113
114	rbargs
115	Additional keyword parameters for rubberband
116
117	See `rubberband -h` for details.
118
119	Returns
120	-------
121	y_stretch : np.ndarray
122	Time-stretched audio
123
124	Raises
125	------
126	ValueError
127	if `rate <= 0`
128	'''
129
130	if rate <= 0:	3✔
131	raise ValueError('rate must be strictly positive')	3✔
132
133	if rate == 1.0:	3✔
134	return y	3✔
135
136	if rbargs is None:	3✔
137	rbargs = dict()	3✔
138
139	rbargs.setdefault('--tempo', rate)	3✔
140
141	return __rubberband(y, sr, **rbargs)	3✔
142
143
144	def timemap_stretch(y, sr, time_map, rbargs=None):	3✔
145	'''Apply a timemap stretch to an audio time series.
146
147	A timemap stretch allows non-linear time-stretching by mapping source to
148	target sample frame numbers for fixed time points within the audio data.
149
150	This uses the `time` and `timemap` form for rubberband.
151
152	Parameters
153	----------
154	y : np.ndarray [shape=(n,) or (n, c)]
155	Audio time series, either single or multichannel
156
157	sr : int > 0
158	Sampling rate of `y`
159
160	time_map : list
161	Each element is a tuple `t` of length 2 which corresponds to the
162	source sample position and target sample position.
163
164	If `t[1] < t[0]` the track will be sped up in this area.
165
166	`time_map[-1]` must correspond to the lengths of the source audio and
167	target audio.
168
169	rbargs
170	Additional keyword parameters for rubberband
171
172	See `rubberband -h` for details.
173
174	Returns
175	-------
176	y_stretch : np.ndarray
177	Time-stretched audio
178
179	Raises
180	------
181	ValueError
182	if `time_map` is not monotonic
183	if `time_map` is not non-negative
184	if `time_map[-1][0]` is not the input audio length
185	'''
186
187	if rbargs is None:	3✔
188	rbargs = dict()	3✔
189
190	is_positive = all(time_map[i][0] >= 0 and time_map[i][1] >= 0	3✔
191	for i in range(len(time_map)))
192	is_monotonic = all(time_map[i][0] <= time_map[i+1][0] and	3✔
193	time_map[i][1] <= time_map[i+1][1]
194	for i in range(len(time_map)-1))
195	if not is_positive:	3✔
196	raise ValueError('time_map should be non-negative')	3✔
197
198	if not is_monotonic:	3✔
199	raise ValueError('time_map is not monotonic')	3✔
200
201	if time_map[-1][0] != len(y):	3✔
202	raise ValueError('time_map[-1] should correspond to the last sample')	3✔
203
204	time_stretch = time_map[-1][1] * 1.0 / time_map[-1][0]	3✔
205	rbargs.setdefault('--time', time_stretch)	3✔
206
207	stretch_file = tempfile.NamedTemporaryFile(mode='w', suffix='.txt',	3✔
208	delete=False)
209	try:	3✔
210	for t in time_map:	3✔
211	stretch_file.write('{:0} {:1}\n'.format(t[0], t[1]))	3✔
212	stretch_file.close()	3✔
213
214	rbargs.setdefault('--timemap', stretch_file.name)	3✔
215	y_stretch = __rubberband(y, sr, **rbargs)	3✔
216	except:	×
217	print(sys.exc_info()[0])	×
218	raise	×
219	finally:
220	# Remove temp file
221	os.unlink(stretch_file.name)	3✔
222
223	return y_stretch	3✔
224
225
226	def pitch_shift(y, sr, n_steps, rbargs=None):	3✔
227	'''Apply a pitch shift to an audio time series.
228
229	Parameters
230	----------
231	y : np.ndarray [shape=(n,) or (n, c)]
232	Audio time series, either single or multichannel
233
234	sr : int > 0
235	Sampling rate of `y`
236
237	n_steps : float
238	Shift by `n_steps` semitones.
239
240	rbargs
241	Additional keyword parameters for rubberband
242
243	See `rubberband -h` for details.
244
245	Returns
246	-------
247	y_shift : np.ndarray
248	Pitch-shifted audio
249	'''
250
251	if n_steps == 0:	3✔
252	return y	3✔
253
254	if rbargs is None:	3✔
255	rbargs = dict()	3✔
256
257	rbargs.setdefault('--pitch', n_steps)	3✔
258
259	return __rubberband(y, sr, **rbargs)	3✔

bmcfee / pyrubberband / 82

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous