source: python/lib/aubio/cmd.py @ e2010b3

#! /usr/bin/env python
# -*- coding: utf-8 -*-

"""aubio command line tool

This file was written by Paul Brossier <piem@aubio.org> and is released under
the GNU/GPL v3.

Note: this script is mostly about parsing command line arguments. For more
readable code examples, check out the `python/demos` folder."""

import sys
import argparse
import warnings
import aubio

def aubio_parser():
    epilog = 'use "%(prog)s <command> --help" for more info about each command'
    parser = argparse.ArgumentParser(epilog=epilog)
    parser.add_argument('-V', '--version', help="show version",
            action="store_true", dest="show_version")

    subparsers = parser.add_subparsers(title='commands', dest='command',
            parser_class= AubioArgumentParser,
            metavar="")

    parser_add_subcommand_help(subparsers)

    parser_add_subcommand_onset(subparsers)
    parser_add_subcommand_pitch(subparsers)
    parser_add_subcommand_beat(subparsers)
    parser_add_subcommand_tempo(subparsers)
    parser_add_subcommand_notes(subparsers)
    parser_add_subcommand_mfcc(subparsers)
    parser_add_subcommand_melbands(subparsers)
    parser_add_subcommand_quiet(subparsers)
    parser_add_subcommand_cut(subparsers)

    return parser

def parser_add_subcommand_help(subparsers):
    # global help subcommand
    subparsers.add_parser('help',
            help='show help message',
            formatter_class = argparse.ArgumentDefaultsHelpFormatter)

def parser_add_subcommand_onset(subparsers):
    # onset subcommand
    subparser = subparsers.add_parser('onset',
            help='estimate time of onsets (beginning of sound event)',
            formatter_class = argparse.ArgumentDefaultsHelpFormatter)
    subparser.add_input()
    subparser.add_buf_hop_size()
    helpstr = "onset novelty function"
    helpstr += " <default|energy|hfc|complex|phase|specdiff|kl|mkl|specflux>"
    subparser.add_method(helpstr=helpstr)
    subparser.add_threshold()
    subparser.add_silence()
    subparser.add_minioi()
    subparser.add_time_format()
    subparser.add_verbose_help()
    subparser.set_defaults(process=process_onset)

def parser_add_subcommand_pitch(subparsers):
    # pitch subcommand
    subparser = subparsers.add_parser('pitch',
            help='estimate fundamental frequency (monophonic)')
    subparser.add_input()
    subparser.add_buf_hop_size(buf_size=2048)
    helpstr = "pitch detection method <default|yinfft|yin|mcomb|fcomb|schmitt>"
    subparser.add_method(helpstr=helpstr)
    subparser.add_threshold()
    subparser.add_pitch_unit()
    subparser.add_silence()
    subparser.add_time_format()
    subparser.add_verbose_help()
    subparser.set_defaults(process=process_pitch)

def parser_add_subcommand_beat(subparsers):
    # beat subcommand
    subparser = subparsers.add_parser('beat',
            help='estimate location of beats')
    subparser.add_input()
    subparser.add_buf_hop_size(buf_size=1024, hop_size=512)
    subparser.add_time_format()
    subparser.add_verbose_help()
    subparser.set_defaults(process=process_beat)

def parser_add_subcommand_tempo(subparsers):
    # tempo subcommand
    subparser = subparsers.add_parser('tempo',
            help='estimate overall tempo in bpm')
    subparser.add_input()
    subparser.add_buf_hop_size(buf_size=1024, hop_size=512)
    subparser.add_time_format()
    subparser.add_verbose_help()
    subparser.set_defaults(process=process_tempo)

def parser_add_subcommand_notes(subparsers):
    # notes subcommand
    subparser = subparsers.add_parser('notes',
            help='estimate midi-like notes (monophonic)')
    subparser.add_input()
    subparser.add_buf_hop_size()
    subparser.add_silence()
    subparser.add_release_drop()
    subparser.add_time_format()
    subparser.add_verbose_help()
    subparser.set_defaults(process=process_notes)

def parser_add_subcommand_mfcc(subparsers):
    # mfcc subcommand
    subparser = subparsers.add_parser('mfcc',
            help='extract Mel-Frequency Cepstrum Coefficients')
    subparser.add_input()
    subparser.add_buf_hop_size()
    subparser.add_time_format()
    subparser.add_verbose_help()
    subparser.set_defaults(process=process_mfcc)

def parser_add_subcommand_melbands(subparsers):
    # melbands subcommand
    subparser = subparsers.add_parser('melbands',
            help='extract energies in Mel-frequency bands')
    subparser.add_input()
    subparser.add_buf_hop_size()
    subparser.add_time_format()
    subparser.add_verbose_help()
    subparser.set_defaults(process=process_melbands)

def parser_add_subcommand_quiet(subparsers):
    # quiet subcommand
    subparser = subparsers.add_parser('quiet',
            help='extract timestamps of quiet and loud regions')
    subparser.add_input()
    subparser.add_hop_size()
    subparser.add_silence()
    subparser.add_time_format()
    subparser.add_verbose_help()
    subparser.set_defaults(process=process_quiet)

def parser_add_subcommand_cut(subparsers):
    # cut subcommand
    subparser = subparsers.add_parser('cut',
            help='slice at timestamps')
    subparser.add_input()
    helpstr = "onset novelty function"
    helpstr += " <default|energy|hfc|complex|phase|specdiff|kl|mkl|specflux>"
    subparser.add_method(helpstr=helpstr)
    subparser.add_buf_hop_size()
    subparser.add_silence()
    subparser.add_threshold(default=0.3)
    subparser.add_minioi()
    subparser.add_slicer_options()
    subparser.add_time_format()
    subparser.add_verbose_help()
    subparser.set_defaults(process=process_cut)

class AubioArgumentParser(argparse.ArgumentParser):

    def add_input(self):
        self.add_argument("source_uri", default=None, nargs='?',
                help="input sound file to analyse", metavar = "<source_uri>")
        self.add_argument("-i", "--input", dest = "source_uri2",
                help="input sound file to analyse", metavar = "<source_uri>")
        self.add_argument("-r", "--samplerate",
                metavar = "<freq>", type=int,
                action="store", dest="samplerate", default=0,
                help="samplerate at which the file should be represented")

    def add_verbose_help(self):
        self.add_argument("-v", "--verbose",
                action="count", dest="verbose", default=1,
                help="make lots of noise [default]")
        self.add_argument("-q", "--quiet",
                action="store_const", dest="verbose", const=0,
                help="be quiet")

    def add_buf_hop_size(self, buf_size=512, hop_size=256):
        self.add_buf_size(buf_size=buf_size)
        self.add_hop_size(hop_size=hop_size)

    def add_buf_size(self, buf_size=512):
        self.add_argument("-B", "--bufsize",
                action="store", dest="buf_size", default=buf_size,
                metavar = "<size>", type=int,
                help="buffer size [default=%d]" % buf_size)

    def add_hop_size(self, hop_size=256):
        self.add_argument("-H", "--hopsize",
                metavar = "<size>", type=int,
                action="store", dest="hop_size", default=hop_size,
                help="overlap size [default=%d]" % hop_size)

    def add_method(self, method='default', helpstr='method'):
        self.add_argument("-m", "--method",
                metavar = "<method>", type=str,
                action="store", dest="method", default=method,
                help="%s [default=%s]" % (helpstr, method))

    def add_threshold(self, default=None):
        self.add_argument("-t", "--threshold",
                metavar = "<threshold>", type=float,
                action="store", dest="threshold", default=default,
                help="threshold [default=%s]" % default)

    def add_silence(self):
        self.add_argument("-s", "--silence",
                metavar = "<value>", type=float,
                action="store", dest="silence", default=-70,
                help="silence threshold")

    def add_release_drop(self):
        self.add_argument("-d", "--release-drop",
                metavar = "<value>", type=float,
                action="store", dest="release_drop", default=10,
                help="release drop threshold")

    def add_minioi(self, default="12ms"):
        self.add_argument("-M", "--minioi",
                metavar = "<value>", type=str,
                action="store", dest="minioi", default=default,
                help="minimum Inter-Onset Interval [default=%s]" % default)

    def add_pitch_unit(self, default="Hz"):
        help_str = "frequency unit, should be one of Hz, midi, bin, cent"
        help_str += " [default=%s]" % default
        self.add_argument("-u", "--pitch-unit",
                metavar = "<value>", type=str,
                action="store", dest="pitch_unit", default=default,
                help=help_str)

    def add_time_format(self):
        helpstr = "select time values output format (samples, ms, seconds)"
        helpstr += " [default=seconds]"
        self.add_argument("-T", "--time-format",
                 metavar='format',
                 dest="time_format",
                 default=None,
                 help=helpstr)

    def add_slicer_options(self):
        self.add_argument("-o", "--output", type = str,
                metavar = "<outputdir>",
                action="store", dest="output_directory", default=None,
                help="specify path where slices of the original file should"
                " be created")
        self.add_argument("--cut-until-nsamples", type = int,
                metavar = "<samples>",
                action = "store", dest = "cut_until_nsamples", default = None,
                help="how many extra samples should be added at the end of"
                " each slice")
        self.add_argument("--cut-every-nslices", type = int,
                metavar = "<samples>",
                action = "store", dest = "cut_every_nslices", default = None,
                help="how many slices should be groupped together at each cut")
        self.add_argument("--cut-until-nslices", type = int,
                metavar = "<slices>",
                action = "store", dest = "cut_until_nslices", default = None,
                help="how many extra slices should be added at the end of"
                " each slice")
        self.add_argument("--create-first",
                action = "store_true", dest = "create_first", default = False,
                help="always include first slice")

# some utilities

def samples2seconds(n_frames, samplerate):
    return "%f\t" % (n_frames / float(samplerate))

def samples2milliseconds(n_frames, samplerate):
    return "%f\t" % (1000. * n_frames / float(samplerate))

def samples2samples(n_frames, _samplerate):
    return "%d\t" % n_frames

def timefunc(mode):
    if mode is None or mode == 'seconds' or mode == 's':
        return samples2seconds
    elif mode == 'ms' or mode == 'milliseconds':
        return samples2milliseconds
    elif mode == 'samples':
        return samples2samples
    else:
        raise ValueError("invalid time format '%s'" % mode)

# definition of processing classes

class default_process(object):
    def __init__(self, args):
        if 'time_format' in args:
            self.time2string = timefunc(args.time_format)
        if args.verbose > 2 and hasattr(self, 'options'):
            name = type(self).__name__.split('_')[1]
            optstr = ' '.join(['running', name, 'with options',
                repr(self.options), '\n'])
            sys.stderr.write(optstr)
    def flush(self, frames_read, samplerate):
        # optionally called at the end of process
        pass

    def parse_options(self, args, valid_opts):
        # get any valid options found in a dictionnary of arguments
        options = {k: v for k, v in vars(args).items() if k in valid_opts}
        self.options = options

    def remap_pvoc_options(self, options):
        # FIXME: we need to remap buf_size to win_s, hop_size to hop_s
        # adjust python/ext/py-phasevoc.c to understand buf_size/hop_size
        if 'buf_size' in options:
            options['win_s'] = options['buf_size']
            del options['buf_size']
        if 'hop_size' in options:
            options['hop_s'] = options['hop_size']
            del options['hop_size']
        self.options = options

class process_onset(default_process):
    valid_opts = ['method', 'hop_size', 'buf_size', 'samplerate']
    def __init__(self, args):
        self.parse_options(args, self.valid_opts)
        self.onset = aubio.onset(**self.options)
        if args.threshold is not None:
            self.onset.set_threshold(args.threshold)
        if args.minioi:
            if args.minioi.endswith('ms'):
                self.onset.set_minioi_ms(float(args.minioi[:-2]))
            elif args.minioi.endswith('s'):
                self.onset.set_minioi_s(float(args.minioi[:-1]))
            else:
                self.onset.set_minioi(int(args.minioi))
        if args.silence:
            self.onset.set_silence(args.silence)
        super(process_onset, self).__init__(args)
    def __call__(self, block):
        return self.onset(block)
    def repr_res(self, res, _frames_read, samplerate):
        if res[0] != 0:
            outstr = self.time2string(self.onset.get_last(), samplerate)
            sys.stdout.write(outstr + '\n')

class process_pitch(default_process):
    valid_opts = ['method', 'hop_size', 'buf_size', 'samplerate']
    def __init__(self, args):
        self.parse_options(args, self.valid_opts)
        self.pitch = aubio.pitch(**self.options)
        if args.pitch_unit is not None:
            self.pitch.set_unit(args.pitch_unit)
        if args.threshold is not None:
            self.pitch.set_tolerance(args.threshold)
        if args.silence is not None:
            self.pitch.set_silence(args.silence)
        super(process_pitch, self).__init__(args)
    def __call__(self, block):
        return self.pitch(block)
    def repr_res(self, res, frames_read, samplerate):
        fmt_out = self.time2string(frames_read, samplerate)
        sys.stdout.write(fmt_out + "%.6f\n" % res[0])

class process_beat(default_process):
    valid_opts = ['method', 'hop_size', 'buf_size', 'samplerate']
    def __init__(self, args):
        self.parse_options(args, self.valid_opts)
        self.tempo = aubio.tempo(**self.options)
        super(process_beat, self).__init__(args)
    def __call__(self, block):
        return self.tempo(block)
    def repr_res(self, res, _frames_read, samplerate):
        if res[0] != 0:
            outstr = self.time2string(self.tempo.get_last(), samplerate)
            sys.stdout.write(outstr + '\n')

class process_tempo(process_beat):
    def __init__(self, args):
        super(process_tempo, self).__init__(args)
        self.beat_locations = []
    def repr_res(self, res, _frames_read, samplerate):
        if res[0] != 0:
            self.beat_locations.append(self.tempo.get_last_s())
    def flush(self, frames_read, samplerate):
        import numpy as np
        if len(self.beat_locations) < 2:
            outstr = "unknown bpm"
        else:
            bpms = 60. / np.diff(self.beat_locations)
            median_bpm = np.mean(bpms)
            if len(self.beat_locations) < 10:
                outstr = "%.2f bpm (uncertain)" % median_bpm
            else:
                outstr = "%.2f bpm" % median_bpm
        sys.stdout.write(outstr + '\n')

class process_notes(default_process):
    valid_opts = ['method', 'hop_size', 'buf_size', 'samplerate']
    def __init__(self, args):
        self.parse_options(args, self.valid_opts)
        self.notes = aubio.notes(**self.options)
        if args.silence is not None:
            self.notes.set_silence(args.silence)
        if args.release_drop is not None:
            self.notes.set_release_drop(args.release_drop)
        super(process_notes, self).__init__(args)
    def __call__(self, block):
        return self.notes(block)
    def repr_res(self, res, frames_read, samplerate):
        if res[2] != 0:  # note off
            fmt_out = self.time2string(frames_read, samplerate)
            sys.stdout.write(fmt_out + '\n')
        if res[0] != 0:  # note on
            lastmidi = res[0]
            fmt_out = "%f\t" % lastmidi
            fmt_out += self.time2string(frames_read, samplerate)
            sys.stdout.write(fmt_out)  # + '\t')
    def flush(self, frames_read, samplerate):
        eof = self.time2string(frames_read, samplerate)
        sys.stdout.write(eof + '\n')

class process_mfcc(default_process):
    def __init__(self, args):
        valid_opts1 = ['hop_size', 'buf_size']
        self.parse_options(args, valid_opts1)
        self.remap_pvoc_options(self.options)
        self.pv = aubio.pvoc(**self.options)

        valid_opts2 = ['buf_size', 'n_filters', 'n_coeffs', 'samplerate']
        self.parse_options(args, valid_opts2)
        self.mfcc = aubio.mfcc(**self.options)

        # remember all options
        self.parse_options(args, list(set(valid_opts1 + valid_opts2)))

        super(process_mfcc, self).__init__(args)

    def __call__(self, block):
        fftgrain = self.pv(block)
        return self.mfcc(fftgrain)
    def repr_res(self, res, frames_read, samplerate):
        fmt_out = self.time2string(frames_read, samplerate)
        fmt_out += ' '.join(["% 9.7f" % f for f in res.tolist()])
        sys.stdout.write(fmt_out + '\n')

class process_melbands(default_process):
    def __init__(self, args):
        self.args = args
        valid_opts = ['hop_size', 'buf_size']
        self.parse_options(args, valid_opts)
        self.remap_pvoc_options(self.options)
        self.pv = aubio.pvoc(**self.options)

        valid_opts = ['buf_size', 'n_filters']
        self.parse_options(args, valid_opts)
        self.remap_pvoc_options(self.options)
        self.filterbank = aubio.filterbank(**self.options)
        self.filterbank.set_mel_coeffs_slaney(args.samplerate)

        super(process_melbands, self).__init__(args)
    def __call__(self, block):
        fftgrain = self.pv(block)
        return self.filterbank(fftgrain)
    def repr_res(self, res, frames_read, samplerate):
        fmt_out = self.time2string(frames_read, samplerate)
        fmt_out += ' '.join(["% 9.7f" % f for f in res.tolist()])
        sys.stdout.write(fmt_out + '\n')

class process_quiet(default_process):
    def __init__(self, args):
        self.args = args
        valid_opts = ['hop_size', 'silence']
        self.parse_options(args, valid_opts)
        self.wassilence = 1

        if args.silence is not None:
            self.silence = args.silence
        super(process_quiet, self).__init__(args)

    def __call__(self, block):
        if aubio.silence_detection(block, self.silence) == 1:
            if self.wassilence != 1:
                self.wassilence = 1
                return 2   # newly found silence
            return 1       # silence again
        else:
            if self.wassilence != 0:
                self.wassilence = 0
                return -1  # newly found noise
            return 0       # noise again

    def repr_res(self, res, frames_read, samplerate):
        fmt_out = None
        if res == -1:
            fmt_out = "NOISY: "
        if res == 2:
            fmt_out = "QUIET: "
        if fmt_out is not None:
            fmt_out += self.time2string(frames_read, samplerate)
            sys.stdout.write(fmt_out + '\n')

class process_cut(process_onset):
    def __init__(self, args):
        super(process_cut, self).__init__(args)
        self.slices = []
        self.options = args

    def __call__(self, block):
        ret = super(process_cut, self).__call__(block)
        if ret:
            self.slices.append(self.onset.get_last())
        return ret

    def flush(self, frames_read, samplerate):
        _cut_slice(self.options, self.slices)
        duration = float(frames_read) / float(samplerate)
        base_info = '%(source_file)s' % \
                    {'source_file': self.options.source_uri}
        base_info += ' (total %(duration).2fs at %(samplerate)dHz)\n' % \
                     {'duration': duration, 'samplerate': samplerate}
        info = "created %d slices from " % len(self.slices)
        info += base_info
        sys.stderr.write(info)

def _cut_slice(options, timestamps):
    # cutting pass
    nstamps = len(timestamps)
    if nstamps > 0:
        # generate output files
        timestamps_end = None
        if options.cut_every_nslices:
            timestamps = timestamps[::options.cut_every_nslices]
            nstamps = len(timestamps)
        if options.cut_until_nslices and options.cut_until_nsamples:
            msg = "using cut_until_nslices, but cut_until_nsamples is set"
            warnings.warn(msg)
        if options.cut_until_nsamples:
            lag = options.cut_until_nsamples
            timestamps_end = [t + lag for t in timestamps[1:]]
            timestamps_end += [1e120]
        if options.cut_until_nslices:
            slice_lag = options.cut_until_nslices
            timestamps_end = [t for t in timestamps[1 + slice_lag:]]
            timestamps_end += [1e120] * (options.cut_until_nslices + 1)
        aubio.slice_source_at_stamps(options.source_uri,
                timestamps, timestamps_end = timestamps_end,
                output_dir = options.output_directory,
                samplerate = options.samplerate,
                create_first = options.create_first)

def main():
    parser = aubio_parser()
    if sys.version_info[0] != 3:
        # on py2, create a dummy ArgumentParser to workaround the
        # optional subcommand issue. See https://bugs.python.org/issue9253
        # This ensures that:
        #  - version string is shown when only '-V' is passed
        #  - help is printed if  '-V' is passed with any other argument
        #  - any other argument get forwarded to the real parser
        parser_root = argparse.ArgumentParser(add_help=False)
        parser_root.add_argument('-V', '--version', help="show version",
                action="store_true", dest="show_version")
        args, extras = parser_root.parse_known_args()
        if not args.show_version:  # no -V, forward to parser
            args = parser.parse_args(extras, namespace=args)
        elif len(extras) != 0:     # -V with other arguments, print help
            parser.print_help()
            sys.exit(1)
    else:  # in py3, we can simply use parser directly
        args = parser.parse_args()
    if 'show_version' in args and args.show_version:
        sys.stdout.write('aubio version ' + aubio.version + '\n')
        sys.exit(0)
    elif 'verbose' in args and args.verbose > 3:
        sys.stderr.write('aubio version ' + aubio.version + '\n')
    if 'command' not in args or args.command is None \
            or args.command in ['help']:
        # no command given, print help and return 1
        parser.print_help()
        if args.command and args.command in ['help']:
            sys.exit(0)
        else:
            sys.exit(1)
    elif not args.source_uri and not args.source_uri2:
        sys.stderr.write("Error: a source is required\n")
        parser.print_help()
        sys.exit(1)
    elif args.source_uri2 is not None:
        args.source_uri = args.source_uri2
    try:
        # open source_uri
        with aubio.source(args.source_uri, hop_size=args.hop_size,
                samplerate=args.samplerate) as a_source:
            # always update args.samplerate to native samplerate, in case
            # source was opened with args.samplerate=0
            args.samplerate = a_source.samplerate
            # create the processor for this subcommand
            processor = args.process(args)
            frames_read = 0
            while True:
                # read new block from source
                block, read = a_source()
                # execute processor on this block
                res = processor(block)
                # print results for this block
                if args.verbose > 0:
                    processor.repr_res(res, frames_read, a_source.samplerate)
                # increment total number of frames read
                frames_read += read
                # exit loop at end of file
                if read < a_source.hop_size:
                    break
            # flush the processor if needed
            processor.flush(frames_read, a_source.samplerate)
            if args.verbose > 1:
                fmt_string = "read {:.2f}s"
                fmt_string += " ({:d} samples in {:d} blocks of {:d})"
                fmt_string += " from {:s} at {:d}Hz\n"
                sys.stderr.write(fmt_string.format(
                        frames_read / float(a_source.samplerate),
                        frames_read,
                        frames_read // a_source.hop_size + 1,
                        a_source.hop_size,
                        a_source.uri,
                        a_source.samplerate))
    except KeyboardInterrupt:
        sys.exit(1)