RubberBandLiveShifter.h

Go to the documentation of this file.

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 
/*
    Rubber Band Library
    An audio time-stretching and pitch-shifting library.
    Copyright 2007-2024 Particular Programs Ltd.
 
    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.
 
    Alternatively, if you have a valid commercial licence for the
    Rubber Band Live Pitch Shifter obtained by agreement with the
    copyright holders, you may redistribute and/or modify it under the
    terms described in that licence.
 
    If you wish to distribute code using Rubber Band Live under terms
    other than those of the GNU General Public License, you must
    obtain a valid commercial licence before doing so.
*/
 
#ifndef RUBBERBAND_LIVE_SHIFTER_H
#define RUBBERBAND_LIVE_SHIFTER_H
 
#define RUBBERBAND_VERSION "4.0.0"
#define RUBBERBAND_API_MAJOR_VERSION 3
#define RUBBERBAND_API_MINOR_VERSION 0
 
#undef RUBBERBAND_LIVE_DLLEXPORT
#ifdef _MSC_VER
#define RUBBERBAND_LIVE_DLLEXPORT __declspec(dllexport)
#else
#define RUBBERBAND_LIVE_DLLEXPORT
#endif
 
#include <vector>
#include <map>
#include <string>
#include <memory>
#include <cstddef>
 
namespace RubberBand
{
 
class RUBBERBAND_LIVE_DLLEXPORT
RubberBandLiveShifter
{
public:
    enum Option {
        OptionWindowShort          = 0x00000000,
        OptionWindowMedium         = 0x00100000,
 
        OptionFormantShifted       = 0x00000000,
        OptionFormantPreserved     = 0x01000000,
 
        OptionChannelsApart        = 0x00000000,
        OptionChannelsTogether     = 0x10000000
 
        // n.b. Options is int, so we must stop before 0x80000000
    };
 
    typedef int Options;
 
    enum PresetOption {
        DefaultOptions = 0x00000000
    };
 
    struct Logger {
        virtual void log(const char *) = 0;
 
        virtual void log(const char *, double) = 0;
 
        virtual void log(const char *, double, double) = 0;
        
        virtual ~Logger() { }
    };
    
    RubberBandLiveShifter(size_t sampleRate, size_t channels,
                          Options options);
 
    RubberBandLiveShifter(size_t sampleRate, size_t channels,
                          std::shared_ptr<Logger> logger,
                          Options options);
    
    ~RubberBandLiveShifter();
 
    void reset();
 
    void setPitchScale(double scale);
 
    void setFormantScale(double scale);
 
    double getPitchScale() const;
 
    double getFormantScale() const;
    
    size_t getStartDelay() const;
    
    size_t getChannelCount() const;
 
    void setFormantOption(Options options);
 
    size_t getBlockSize() const;
    
    void shift(const float *const *input, float *const *output);
 
    void setDebugLevel(int level);
 
    static void setDefaultDebugLevel(int level);
 
protected:
    class Impl;
    Impl *m_d;
 
    RubberBandLiveShifter(const RubberBandLiveShifter &) =delete;
    RubberBandLiveShifter &operator=(const RubberBandLiveShifter &) =delete;
};
 
}
 
#endif