TDStretch.h

Go to the documentation of this file.

//
// Last changed  : $Date$
// File revision : $Revision$
//
// $Id$
//
//
// License :
//
//  SoundTouch audio processing library
//  Copyright (c) Olli Parviainen
//
//  This library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Lesser General Public
//  License as published by the Free Software Foundation; either
//  version 2.1 of the License, or (at your option) any later version.
//
//  This library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with this library; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//

#ifndef TDStretch_H
#define TDStretch_H

#include "STTypes.h"
#include "RateTransposer.h"
#include "FIFOSamplePipe.h"

#ifdef MULTICHANNEL
#define USE_MULTI_MMX
#endif

namespace soundtouch
{

// Default values for sound processing parameters:

#define DEFAULT_SEQUENCE_MS     82

#define DEFAULT_SEEKWINDOW_MS   14

#define DEFAULT_OVERLAP_MS      12


class TDStretch : public FIFOProcessor
{
protected:
    uint channels;
    uint sampleReq;
    float tempo;

    SAMPLETYPE *pMidBuffer;
    SAMPLETYPE *pRefMidBuffer;
    SAMPLETYPE *pRefMidBufferUnaligned;
    uint midBufferLength;
    uint overlapLength;
    uint overlapDividerBits;
    uint slopingDivider;
    uint seekLength;
    uint seekWindowLength;
    uint maxOffset;
    float nominalSkip;
    float skipFract;
    FIFOSampleBuffer outputBuffer;
    FIFOSampleBuffer inputBuffer;
    BOOL bQuickseek;
    BOOL bMidBufferDirty;

    uint sampleRate;
    uint sequenceMs;
    uint seekWindowMs;
    uint overlapMs;

    void acceptNewOverlapLength(uint newOverlapLength);

    virtual void clearCrossCorrState();
    void calculateOverlapLength(uint overlapMs);

#ifdef MULTICHANNEL
    virtual LONG_SAMPLETYPE calcCrossCorrMulti(const SAMPLETYPE *mixingPos, const SAMPLETYPE *compare) const;
#endif
    virtual LONG_SAMPLETYPE calcCrossCorrStereo(const SAMPLETYPE *mixingPos, const SAMPLETYPE *compare) const;
    virtual LONG_SAMPLETYPE calcCrossCorrMono(const SAMPLETYPE *mixingPos, const SAMPLETYPE *compare) const;

#ifdef MULTICHANNEL
    virtual uint seekBestOverlapPositionMulti(const SAMPLETYPE *refPos);
    virtual uint seekBestOverlapPositionMultiQuick(const SAMPLETYPE *refPos);
#endif
    virtual uint seekBestOverlapPositionStereo(const SAMPLETYPE *refPos);
    virtual uint seekBestOverlapPositionStereoQuick(const SAMPLETYPE *refPos);
    virtual uint seekBestOverlapPositionMono(const SAMPLETYPE *refPos);
    virtual uint seekBestOverlapPositionMonoQuick(const SAMPLETYPE *refPos);
    uint seekBestOverlapPosition(const SAMPLETYPE *refPos);

#ifdef MULTICHANNEL
    virtual void overlapMulti(SAMPLETYPE *output, const SAMPLETYPE *input) const;
#endif
    virtual void overlapStereo(SAMPLETYPE *output, const SAMPLETYPE *input) const;
    virtual void overlapMono(SAMPLETYPE *output, const SAMPLETYPE *input) const;

    void clearMidBuffer();
    void overlap(SAMPLETYPE *output, const SAMPLETYPE *input, uint ovlPos) const;

#ifdef MULTICHANNEL
    void precalcCorrReference();
#endif
    void precalcCorrReferenceMono();
    void precalcCorrReferenceStereo();

    void processNominalTempo();

    void processSamples();
    
public:
    TDStretch();
    virtual ~TDStretch();

    void *operator new(size_t s);

    static TDStretch *newInstance();
    
    FIFOSamplePipe *getOutput() { return &outputBuffer; };

    FIFOSamplePipe *getInput() { return &inputBuffer; };

    void setTempo(float newTempo);

    virtual void clear();

    void clearInput();

    void setChannels(uint numChannels);

    void enableQuickSeek(BOOL enable);

    BOOL isQuickSeekEnabled() const;

    //
    void setParameters(uint sampleRate,                             
                       uint sequenceMS = DEFAULT_SEQUENCE_MS,       
                       uint seekwindowMS = DEFAULT_SEEKWINDOW_MS,   
                       uint overlapMS = DEFAULT_OVERLAP_MS          
                       );

    void getParameters(uint *pSampleRate, uint *pSequenceMs, uint *pSeekWindowMs, uint *pOverlapMs);

    virtual void putSamples(
            const SAMPLETYPE *samples,  
            uint numSamples                         

            );
};

// Implementation-specific class declarations:

#ifdef ALLOW_SSE2

    class TDStretchSSE2 : public TDStretch
    {
    protected:
#ifdef MULTICHANNEL
        double calcCrossCorrMulti(const float *mixingPos, const float *compare) const;
        virtual void overlapMulti(float *output, const float *input) const;
#endif
        double calcCrossCorrStereo(const float *mixingPos, const float *compare) const;
        virtual void overlapStereo(float *output, const float *input) const;
    };

#endif 

#ifdef ALLOW_SSE3

    class TDStretchSSE3 : public TDStretchSSE2
    {
    protected:
#ifdef MULTICHANNEL
        double calcCrossCorrMulti(const float *mixingPos, const float *compare) const;
#endif
        double calcCrossCorrStereo(const float *mixingPos, const float *compare) const;
    };

#endif 

#ifdef ALLOW_MMX

    class TDStretchMMX : public TDStretch
    {
    protected:
#ifdef USE_MULTI_MMX
#ifdef MULTICHANNEL
        long calcCrossCorrMulti(const short *mixingPos, const short *compare) const;
#endif
#endif
        long calcCrossCorrStereo(const short *mixingPos, const short *compare) const;
        virtual void overlapStereo(short *output, const short *input) const;
        virtual void clearCrossCorrState();
    };
#endif 

}
#endif