python/scripts/aubiocut: add --cut-until-nsamples and --cut-until-nslices options
[aubio.git] / python / scripts / aubiocut
1 #! /usr/bin/env python
2
3 """ this file was written by Paul Brossier
4   it is released under the GNU/GPL license.
5 """
6
7 import sys
8 #from aubio.task import *
9
10 usage = "usage: %s [options] -i soundfile" % sys.argv[0]
11 usage += "\n help: %s -h" % sys.argv[0]
12
13 def parse_args():
14     from optparse import OptionParser
15     parser = OptionParser(usage=usage)
16     parser.add_option("-i", "--input", action = "store", dest = "source_file",
17             help="input sound file to analyse", metavar = "<source_file>")
18     parser.add_option("-O","--onset-method",
19             action="store", dest="onset_method", default='default',
20             metavar = "<onset_method>",
21             help="onset detection method [default=default] \
22                     complexdomain|hfc|phase|specdiff|energy|kl|mkl")
23     # cutting methods
24     parser.add_option("-b","--beat",
25             action="store_true", dest="beat", default=False,
26             help="use beat locations")
27     """
28     parser.add_option("-S","--silencecut",
29             action="store_true", dest="silencecut", default=False,
30             help="use silence locations")
31     parser.add_option("-s","--silence",
32             metavar = "<value>",
33             action="store", dest="silence", default=-70,
34             help="silence threshold [default=-70]")
35             """
36     # algorithm parameters
37     parser.add_option("-r", "--samplerate",
38             metavar = "<freq>", type='int',
39             action="store", dest="samplerate", default=0,
40             help="samplerate at which the file should be represented")
41     parser.add_option("-B","--bufsize",
42             action="store", dest="bufsize", default=512,
43             metavar = "<size>", type='int',
44             help="buffer size [default=512]")
45     parser.add_option("-H","--hopsize",
46             metavar = "<size>", type='int',
47             action="store", dest="hopsize", default=256,
48             help="overlap size [default=256]")
49     parser.add_option("-t","--onset-threshold",
50             metavar = "<value>", type="float",
51             action="store", dest="threshold", default=0.3,
52             help="onset peak picking threshold [default=0.3]")
53     parser.add_option("-c","--cut",
54             action="store_true", dest="cut", default=False,
55             help="cut input sound file at detected labels \
56                     best used with option -L")
57     """
58     parser.add_option("-D","--delay",
59             action = "store", dest = "delay", type = "float",
60             metavar = "<seconds>", default=0,
61             help="number of seconds to take back [default=system]\
62                     default system delay is 3*hopsize/samplerate")
63     parser.add_option("-C","--dcthreshold",
64             metavar = "<value>",
65             action="store", dest="dcthreshold", default=1.,
66             help="onset peak picking DC component [default=1.]")
67     parser.add_option("-M","--mintol",
68             metavar = "<value>",
69             action="store", dest="mintol", default=0.048,
70             help="minimum inter onset interval [default=0.048]")
71     parser.add_option("-L","--localmin",
72             action="store_true", dest="localmin", default=False,
73             help="use local minima after peak detection")
74     parser.add_option("-d","--derivate",
75             action="store_true", dest="derivate", default=False,
76             help="derivate onset detection function")
77     parser.add_option("-z","--zerocross",
78             metavar = "<value>",
79             action="store", dest="zerothres", default=0.008,
80             help="zero-crossing threshold for slicing [default=0.00008]")
81             """
82     # plotting functions
83     """
84     parser.add_option("-p","--plot",
85             action="store_true", dest="plot", default=False,
86             help="draw plot")
87     parser.add_option("-x","--xsize",
88             metavar = "<size>",
89             action="store", dest="xsize", default=1.,
90             type='float', help="define xsize for plot")
91     parser.add_option("-y","--ysize",
92             metavar = "<size>",
93             action="store", dest="ysize", default=1.,
94             type='float', help="define ysize for plot")
95     parser.add_option("-f","--function",
96             action="store_true", dest="func", default=False,
97             help="print detection function")
98     parser.add_option("-n","--no-onsets",
99             action="store_true", dest="nplot", default=False,
100             help="do not plot detected onsets")
101     parser.add_option("-O","--outplot",
102             metavar = "<output_image>",
103             action="store", dest="outplot", default=None,
104             help="save plot to output.{ps,png}")
105     parser.add_option("-F","--spectrogram",
106             action="store_true", dest="spectro", default=False,
107             help="add spectrogram to the plot")
108     """
109     parser.add_option("-o","--output", type = str,
110             metavar = "<outputdir>",
111             action="store", dest="output_directory", default=None,
112             help="specify path where slices of the original file should be created")
113     parser.add_option("--cut-until-nsamples", type = int,
114             metavar = "<samples>",
115             action = "store", dest = "cut_until_nsamples", default = None,
116             help="how many extra samples should be added at the end of each slice")
117     parser.add_option("--cut-until-nslices", type = int,
118             metavar = "<slices>",
119             action = "store", dest = "cut_until_nslices", default = None,
120             help="how many extra slices should be added at the end of each slice")
121
122     parser.add_option("-v","--verbose",
123             action="store_true", dest="verbose", default=True,
124             help="make lots of noise [default]")
125     parser.add_option("-q","--quiet",
126             action="store_false", dest="verbose", default=True,
127             help="be quiet")
128     (options, args) = parser.parse_args()
129     if not options.source_file:
130         import os.path
131         if len(args) == 1:
132             options.source_file = args[0]
133         else:
134             print "no file name given\n", usage
135             sys.exit(1)
136     return options, args
137
138 if __name__ == '__main__':
139     options, args = parse_args()
140
141     hopsize = options.hopsize
142     bufsize = options.bufsize
143     samplerate = options.samplerate
144     source_file = options.source_file
145
146     from aubio import onset, tempo, source, sink
147
148     s = source(source_file, samplerate, hopsize)
149     if samplerate == 0: samplerate = s.get_samplerate()
150
151     if options.beat:
152         o = tempo(options.onset_method, bufsize, hopsize)
153     else:
154         o = onset(options.onset_method, bufsize, hopsize)
155     o.set_threshold(options.threshold)
156
157     timestamps = []
158     total_frames = 0
159     # analyze pass
160     while True:
161         samples, read = s()
162         if o(samples):
163             timestamps.append (o.get_last())
164             if options.verbose: print "%.4f" % o.get_last_s()
165         total_frames += read
166         if read < hopsize: break
167     del s
168     # print some info
169     nstamps = len(timestamps)
170     duration = float (total_frames) / float(samplerate)
171     info = 'found %(nstamps)d timestamps in %(source_file)s' % locals()
172     info += ' (total %(duration).2fs at %(samplerate)dHz)\n' % locals()
173     sys.stderr.write(info)
174
175     # cutting pass
176     if options.cut and nstamps > 0:
177         # generate output files
178         from aubio.slicing import slice_source_at_stamps
179         timestamps_end = None
180         if options.cut_until_nslices and options.cut_until_nsamples:
181             print "warning: using cut_until_nslices, but cut_until_nsamples is set"
182         if options.cut_until_nsamples:
183             timestamps_end = [t + options.cut_until_nsamples for t in timestamps[1:]]
184             timestamps_end += [ 1e120 ]
185         if options.cut_until_nslices:
186             timestamps_end = [t for t in timestamps[1 + options.cut_until_nslices:]]
187             timestamps_end += [ 1e120 ] * (options.cut_until_nslices + 1)
188         slice_source_at_stamps(source_file, timestamps, timestamps_end = timestamps_end,
189                 output_dir = options.output_directory)
190
191         # print some info
192         duration = float (total_frames) / float(samplerate)
193         info = 'created %(nstamps)d slices from %(source_file)s' % locals()
194         info += ' (total %(duration).2fs at %(samplerate)dHz)\n' % locals()
195         sys.stderr.write(info)