buffer.h

Go to the documentation of this file.

/* Copyright, 2001 Nevrax Ltd.
 *
 * This file is part of NEVRAX NEL.
 * NEVRAX NEL 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, or (at your option)
 * any later version.

 * NEVRAX NEL 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
 * General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with NEVRAX NEL; see the file COPYING. If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */

#ifndef NL_BUFFER_H
#define NL_BUFFER_H

#include "nel/misc/types_nl.h"
#include "nel/misc/string_mapper.h"
#include "sound_driver.h"

namespace NLMISC {
    class IStream;
}

namespace NLSOUND {

class IBuffer
{
public:
    enum TBufferFormat
    {
        FormatUnknown = 0, 
        FormatPcm = 1, 
        FormatDviAdpcm = 11, 
    };
    enum TStorageMode
    {
        StorageAuto, 
        StorageHardware, 
        StorageSoftware
    };
    
    virtual void setName(NLMISC::TStringId bufferName) = 0;
    virtual NLMISC::TStringId getName() const = 0;

    virtual void setFormat(TBufferFormat format, uint8 channels, uint8 bitsPerSample, uint32 frequency) = 0;
    virtual void getFormat(TBufferFormat &format, uint8 &channels, uint8 &bitsPerSample, uint32 &frequency) const = 0;
    virtual void setStorageMode(TStorageMode storageMode = IBuffer::StorageAuto) = 0;
    virtual TStorageMode getStorageMode() = 0;

    virtual uint8 *lock(uint capacity) = 0;
    virtual bool unlock(uint size) = 0;
    virtual bool fill(const uint8 *src, uint size) = 0;
    
    virtual uint getSize() const = 0;
    virtual float getDuration() const = 0;
    virtual bool isStereo() const = 0;  
    virtual bool isBufferLoaded() const = 0;
    
    //\name ***deprecated***
    void setFormat(TSampleFormat format, uint freq);
    void getFormat(TSampleFormat& format, uint& freq) const;
    static void sampleFormatToBufferFormat(TSampleFormat sampleFormat, TBufferFormat &bufferFormat, uint8 &channels, uint8 &bitsPerSample);
    static void bufferFormatToSampleFormat(TBufferFormat bufferFormat, uint8 channels, uint8 bitsPerSample, TSampleFormat &sampleFormat);

    //\name Utility functions
    static uint getPCMSizeFromDuration(float duration, uint8 channels, uint8 bitsPerSample, uint32 frequency);
    static float getDurationFromPCMSize(uint size, uint8 channels, uint8 bitsPerSample, uint32 frequency);
    
    //\name ADPCM and sample bank building utility methods
    struct TADPCMState
    {
        sint16  PreviousSample;
        uint8   StepIndex;
    };
    static void encodeADPCM(const sint16 *indata, uint8 *outdata, uint nbSample, TADPCMState &state);
    static void decodeADPCM(const uint8 *indata, sint16 *outdata, uint nbSample, TADPCMState &state);   
    static bool readWav(const uint8 *wav, uint size, std::vector<uint8> &result, TBufferFormat &bufferFormat, uint8 &channels, uint8 &bitsPerSample, uint32 &frequency);
    static bool writeWav(const uint8 *buffer, uint size, TBufferFormat bufferFormat, uint8 channels, uint8 bitsPerSample, uint32 frequency, NLMISC::IStream &out);
    static bool convertToMono16PCM(const uint8 *buffer, uint size, std::vector<sint16> &result, TBufferFormat bufferFormat, uint8 channels, uint8 bitsPerSample);
    static bool convertMono16PCMToMonoADPCM(const sint16 *buffer, uint samples, std::vector<uint8> &result);
    
private:
    static const sint _IndexTable[16];
    static const uint _StepsizeTable[89];
    
protected:
    IBuffer() { }
    
public:
    virtual ~IBuffer() { }
    
};

} // NLSOUND

#endif // NL_BUFFER_H

/* End of buffer.h */