librubberband/src/main.cpp

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    Rubber Band
    An audio time-stretching and pitch-shifting library.
    Copyright 2007 Chris Cannam.
    
    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.  See the file
    COPYING included with this distribution for more information.
*/

#include "RubberBandStretcher.h"

#include <iostream>
#include <sndfile.h>
#include <cmath>
#include <sys/time.h>
#include <time.h>

#include <getopt.h>

using namespace std;
using namespace RubberBand;

int main(int argc, char **argv)
{
    int c;

    double ratio = 1.0;
    double pitchshift = 1.0;
    double frequencyshift = 1.0;
    int debug = 1;
    bool realtime = false;
    bool precise = false;
    bool threaded = true;
    bool transients = true;
    bool peaklock = true;
    bool longwin = false;
    bool shortwin = false;
    int crispness = -1;
    bool help = false;

    float fthresh0 = -1.f;
    float fthresh1 = -1.f;
    float fthresh2 = -1.f;

    while (1) {
        int thisOptind = optind ? optind : 1;
        int optionIndex = 0;

        static struct option longOpts[] = {
            { "help",          0, 0, 'h' },
            { "time",          1, 0, 't' },
            { "tempo",         1, 0, 'T' },
            { "pitch",         1, 0, 'p' },
            { "frequency",     1, 0, 'f' },
            { "crisp",         1, 0, 'c' },
            { "crispness",     1, 0, 'c' },
            { "debug",         1, 0, 'd' },
            { "realtime",      0, 0, 'R' },
            { "precise",       0, 0, 'P' },
            { "no-threads",    0, 0, '0' },
            { "no-transients", 0, 0, '1' },
            { "no-peaklock",   0, 0, '2' },
            { "window-long",   0, 0, '3' },
            { "window-short",  0, 0, '4' },
            { "thresh0",       1, 0, '5' },
            { "thresh1",       1, 0, '6' },
            { "thresh2",       1, 0, '7' },
            { 0, 0, 0 }
        };

        c = getopt_long(argc, argv, "t:p:d:RPc:f:", longOpts, &optionIndex);
        if (c == -1) break;

        switch (c) {
        case 'h': help = true; break;
        case 't': ratio *= atof(optarg); break;
        case 'T': { double m = atof(optarg); if (m != 0.0) ratio /= m; } break;
        case 'p': pitchshift = atof(optarg); break;
        case 'f': frequencyshift = atof(optarg); break;
        case 'd': debug = atoi(optarg); break;
        case 'R': realtime = true; break;
        case 'P': precise = true; break;
        case '0': threaded = false; break;
        case '1': transients = false; break;
        case '2': peaklock = false; break;
        case '3': longwin = true; break;
        case '4': shortwin = true; break;
        case '5': fthresh0 = atof(optarg); break;
        case '6': fthresh1 = atof(optarg); break;
        case '7': fthresh2 = atof(optarg); break;
        case 'c': crispness = atoi(optarg); break;
        default: break;
        }
    }

    if (help || optind + 2 != argc) {
        cerr << endl;
	cerr << "Rubber Band" << endl;
        cerr << "An audio time-stretching and pitch-shifting library and utility program." << endl;
	cerr << "Copyright 2007 Chris Cannam.  Distributed under the GNU General Public License." << endl;
        cerr << endl;
	cerr << "Usage: " << argv[0] << " [options] <infile.wav> <outfile.wav>" << endl;
        cerr << endl;
        cerr << "where options may be:" << endl;
        cerr << endl;
        cerr << "  -t<X>, --time <X>       Stretch to X times original duration, or" << endl;
        cerr << "  -T<X>, --tempo <X>      Change tempo by multiple X (equivalent to --time 1/X)" << endl;
        cerr << endl;
        cerr << "  -p<X>, --pitch <X>      Raise pitch by X semitones, or" << endl;
        cerr << "  -f<X>, --frequency <X>  Change frequency by multiple X" << endl;
        cerr << endl;
        cerr << "  -c<N>, --crisp <N>      Crispness (N = 0,1,2,3); default 2 (see below)" << endl;
        cerr << endl;
        cerr << "The following options adjust the processing mode and stretch algorithm." << endl;
        cerr << "These are mostly included for test purposes; the default settings and standard" << endl;
        cerr << "crispness parameter are intended to provide the best sounding set of options" << endl;
        cerr << "for most situations." << endl;
        cerr << endl;
        cerr << "  -P,    --precise        Aim for minimal time distortion (implied by -R)" << endl;
        cerr << "  -R,    --realtime       Select realtime mode (implies -P --no-threads)" << endl;
        cerr << "         --no-threads     No extra threads regardless of cpus/channel count" << endl;
        cerr << "         --no-transients  Disable phase resynchronisation at transients" << endl;
        cerr << "         --no-peaklock    Disable phase locking to peak frequencies" << endl;
        cerr << "         --window-long    Use longer processing window (actual size may vary)" << endl;
        cerr << "         --window-short   Use shorter processing window" << endl;
        cerr << "         --thresh<N> <F>  Set internal freq threshold N (N = 0,1,2) to F Hz" << endl;
        cerr << endl;
        cerr << "  -d<N>, --debug <N>      Select debug level (N = 0,1,2,3); default 1, full 3" << std::endl;
        cerr << "                          (N.B. debug level 3 includes audible ticks in output)" << endl;
        cerr << endl;
        cerr << "  -h,    --help           Show this help" << endl;
        cerr << endl;
        cerr << "\"Crispness\" levels:" << endl;
        cerr << "  -c 0   equivalent to --no-transients --no-peaklock" << endl;
        cerr << "  -c 1   equivalent to --no-peaklock" << endl;
        cerr << "  -c 2   default processing options" << endl;
        cerr << "  -c 3   equivalent to --no-peaklock --window-short (may be suitable for drums)" << endl;
        cerr << endl;
	return 2;
    }

    switch (crispness) {
    case -1: crispness = 2; break;
    case 0: transients = false; peaklock = false; longwin = false; shortwin = false; break;
    case 1: transients = true; peaklock = false; longwin = false; shortwin = false; break;
    case 2: transients = true; peaklock = true; longwin = false; shortwin = false; break;
    case 3: transients = true; peaklock = false; longwin = false; shortwin = true; break;
    };

    char *fileName = strdup(argv[optind++]);
    char *fileNameOut = strdup(argv[optind++]);
    
    SNDFILE *sndfile;
    SNDFILE *sndfileOut;
    SF_INFO sfinfo;
    SF_INFO sfinfoOut;
    memset(&sfinfo, 0, sizeof(SF_INFO));

    sndfile = sf_open(fileName, SFM_READ, &sfinfo);
    if (!sndfile) {
	cerr << "ERROR: Failed to open input file \"" << fileName << "\": "
	     << sf_strerror(sndfile) << endl;
	return 1;
    }

    sfinfoOut.channels = sfinfo.channels;
    sfinfoOut.format = sfinfo.format;
    sfinfoOut.frames = int(sfinfo.frames * ratio + 0.1);
    sfinfoOut.samplerate = sfinfo.samplerate;
    sfinfoOut.sections = sfinfo.sections;
    sfinfoOut.seekable = sfinfo.seekable;

    sndfileOut = sf_open(fileNameOut, SFM_WRITE, &sfinfoOut) ;
    if (!sndfileOut) {
	cerr << "ERROR: Failed to open output file \"" << fileName << "\" for writing: "
	     << sf_strerror(sndfile) << endl;
	return 1;
    }
    
    int ibs = 1024;
    size_t channels = sfinfo.channels;

    RubberBandStretcher::Options options = 0;
    if (realtime)    options |= RubberBandStretcher::OptionProcessRealTime;
    if (precise)     options |= RubberBandStretcher::OptionStretchPrecise;
    if (!transients) options |= RubberBandStretcher::OptionTransientsSmooth;
    if (!peaklock)   options |= RubberBandStretcher::OptionPhaseIndependent;
    if (!threaded)   options |= RubberBandStretcher::OptionThreadingNone;
    if (longwin)     options |= RubberBandStretcher::OptionWindowLong;
    if (shortwin)    options |= RubberBandStretcher::OptionWindowShort;

    if (pitchshift != 1.0) {
        frequencyshift *= pow(2.0, pitchshift / 12);
    }

    RubberBandStretcher ts(sfinfo.samplerate, channels, options,
                           ratio, frequencyshift);
    
    ts.setDebugLevel(debug);

    ts.setExpectedInputDuration(sfinfo.frames);

//    ts.setTimeRatio(ratio);
//    ts.setPitchScale(pitchshift);

    float *fbuf = new float[channels * ibs];
    float **ibuf = new float *[channels];
    for (size_t i = 0; i < channels; ++i) ibuf[i] = new float[ibs];

    int frame = 0;
    int percent = 0;

    struct timeval tv;
    (void)gettimeofday(&tv, 0);

    if (!realtime) {

        cerr << "First pass (studying)..." << endl;

        while (frame < sfinfo.frames) {

//        std::cout << "study frame " << frame << std::endl;

            int count = -1;

            if (sf_seek(sndfile, frame, SEEK_SET) < 0) break;
            if ((count = sf_readf_float(sndfile, fbuf, ibs)) <= 0) break;
        
            for (size_t c = 0; c < channels; ++c) {
                for (int i = 0; i < count; ++i) {
                    float value = fbuf[i * channels + c];
                    ibuf[c][i] = value;
                }
            }

            bool final = (frame + ibs >= sfinfo.frames);

            ts.study(ibuf, count, final);

            int p = int((double(frame) * 100.0) / sfinfo.frames);
            if (p > percent || frame == 0) {
                percent = p;
                cerr << "\r" << percent << "% ";
            }

            frame += ibs;
        }

        cerr << endl;

        cerr << "Second pass (processing)..." << endl;
    }

    frame = 0;
    percent = 0;
    
    float inpeak = 0;
    double insum = 0;
    float outpeak = 0.0;
    double outsum = 0.0;
    size_t countIn = 0, countOut = 0;

    while (frame < sfinfo.frames) {

        int count = -1;

	if (sf_seek(sndfile, frame, SEEK_SET) < 0) break;
	if ((count = sf_readf_float(sndfile, fbuf, ibs)) < 0) break;
        
        countIn += count;

        for (size_t c = 0; c < channels; ++c) {
            for (int i = 0; i < count; ++i) {
                float value = fbuf[i * channels + c];
                ibuf[c][i] = value;
                if (fabsf(value) > inpeak) inpeak = fabsf(value);
                insum += value * value;
            }
        }

        bool final = (frame + ibs >= sfinfo.frames);

        ts.process(ibuf, count, final);

//        if 
//            std::cerr << frame << " + " << ibs << " >= " << sfinfo.frames << ": calling ts.complete()!" << std::endl;
//            ts.complete();
//        }

        int avail = ts.available();
        if (debug > 1) std::cerr << "available = " << avail << std::endl;

        if (avail > 0) {
            float **obf = new float *[channels];
            for (size_t i = 0; i < channels; ++i) {
                obf[i] = new float[avail];
            }
            ts.retrieve(obf, avail);
            countOut += avail;
            float *fobf = new float[channels * avail];
            for (size_t c = 0; c < channels; ++c) {
                for (size_t i = 0; i < avail; ++i) {
                    float value = obf[c][i];
                    if (fabsf(value) > outpeak) outpeak = fabsf(value);
                    outsum += value * value;
                    value *= 0.75;
                    if (value > 1.f) value = 1.f;
                    if (value < -1.f) value = -1.f;
                    fobf[i * channels + c] = value;
                }
            }
//            std::cout << "fobf mean: ";
//    double d = 0;
//    for (int i = 0; i < avail; ++i) {
//        d += fobf[i];
//    }
//    d /= avail;
//    std::cout << d << std::endl;
            sf_writef_float(sndfileOut, fobf, avail);
            delete[] fobf;
            for (size_t i = 0; i < channels; ++i) {
                delete[] obf[i];
            }
            delete[] obf;
        }

	int p = int((double(frame) * 100.0) / sfinfo.frames);
	if (p > percent || frame == 0) {
	    percent = p;
	    cerr << "\r" << percent << "% ";
	}

        frame += ibs;
    }

    int avail;

    while ((avail = ts.available()) >= 0) {

        if (debug > 1) std::cerr << "(completing) available = " << avail << std::endl;

        if (avail > 0) {
            float **obf = new float *[channels];
            for (size_t i = 0; i < channels; ++i) {
                obf[i] = new float[avail];
            }
            ts.retrieve(obf, avail);
            countOut += avail;
            float *fobf = new float[channels * avail];
            for (size_t c = 0; c < channels; ++c) {
                for (size_t i = 0; i < avail; ++i) {
                    float value = obf[c][i];
                    if (fabsf(value) > outpeak) outpeak = fabsf(value);
                    outsum += value * value;
                    value *= 0.75;
                    if (value > 1.f) value = 1.f;
                    if (value < -1.f) value = -1.f;
                    fobf[i * channels + c] = value;
                }
            }

            sf_writef_float(sndfileOut, fobf, avail);
            delete[] fobf;
            for (size_t i = 0; i < channels; ++i) {
                delete[] obf[i];
            }
            delete[] obf;
        }
    }

    sf_close(sndfile);
    sf_close(sndfileOut);

    double inmean = sqrt(insum / (sfinfo.frames * sfinfo.channels));
    double outmean = sqrt(outsum / (countOut * sfinfo.channels));

    cerr << endl << "in: " << countIn << ", out: " << countOut << ", ratio: " << float(countOut)/float(countIn) << ", ideal output: " << lrint(countIn * ratio) << ", diff: " << abs(lrint(countIn * ratio) - int(countOut)) << endl;

    cerr << "input peak: " << inpeak << "; output peak " << outpeak << "; gain " << (inpeak > 0 ? outpeak/inpeak : 1) << endl;
    cerr << "input rms: " << inmean << "; output rms " << outmean << "; gain " << (inmean > 0 ? outmean/inmean : 1) << endl;

    struct timeval etv;
    (void)gettimeofday(&etv, 0);

    cerr << "\nstart:   " << tv.tv_sec << ":" << tv.tv_usec << endl;
    cerr << "finish:  " << etv.tv_sec << ":" << etv.tv_usec << endl;
    
    etv.tv_sec -= tv.tv_sec;
    if (etv.tv_usec < tv.tv_usec) {
        etv.tv_usec += 1000000;
        etv.tv_sec -= 1;
    }
    etv.tv_usec -= tv.tv_usec;

    cerr << "elapsed: " << etv.tv_sec << ":" << etv.tv_usec << endl;

    double sec = double(etv.tv_sec) + (double(etv.tv_usec) / 1000000.0);
    cerr << "\nin/sec: " << countIn/sec << ", out/sec: " << countOut/sec << endl;

    return 0;
}