FIFOSamplePipe.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 FIFOSamplePipe_H
#define FIFOSamplePipe_H

#include <assert.h>
#include <stdlib.h>
#include "STTypes.h"

class FIFOSamplePipe
{
public:
    virtual soundtouch::SAMPLETYPE *ptrBegin() const = 0;

    virtual void putSamples(const soundtouch::SAMPLETYPE *samples,  
                            uint numSamples                         
                            ) = 0;


    // Moves samples from the 'other' pipe instance to this instance.
    void moveSamples(FIFOSamplePipe &other  
         )
    {
        int oNumSamples = other.numSamples();

        putSamples(other.ptrBegin(), oNumSamples);
        other.receiveSamples(oNumSamples);
    };

    virtual uint receiveSamples(soundtouch::SAMPLETYPE *output, 
                                uint maxSamples                 
                                ) = 0;

    virtual uint receiveSamples(uint maxSamples   
                                ) = 0;

    virtual uint numSamples() const = 0;

    // Returns nonzero if there aren't any samples available for outputting.
    virtual int isEmpty() const = 0;

    virtual void clear() = 0;

    virtual ~FIFOSamplePipe() {}
};



class FIFOProcessor :public FIFOSamplePipe
{
protected:
    FIFOSamplePipe *output;

    void setOutPipe(FIFOSamplePipe *pOutput)
    {
        assert(output == NULL);
        assert(pOutput != NULL);
        output = pOutput;
    }


    FIFOProcessor()
    {
        output = NULL;
    }


    FIFOProcessor(FIFOSamplePipe *pOutput   
                 )
    {
        output = pOutput;
    }


    virtual ~FIFOProcessor()
    {
    }


    virtual soundtouch::SAMPLETYPE *ptrBegin() const
    {
        return output->ptrBegin();
    }

public:

    virtual uint receiveSamples(soundtouch::SAMPLETYPE *outBuffer, 
                                uint maxSamples                    
                                )
    {
        return output->receiveSamples(outBuffer, maxSamples);
    }


    virtual uint receiveSamples(uint maxSamples   
                                )
    {
        return output->receiveSamples(maxSamples);
    }


    virtual uint numSamples() const
    {
        return output->numSamples();
    }


    virtual int isEmpty() const
    {
        return output->isEmpty();
    }
};

#endif