fstreamer.h

Go to the documentation of this file.

 //------------------------------------------------------------------------
// Project     : SDK Base
// Version     : 1.0
//
// Category    : Helpers
// Filename    : base/source/fstreamer.h
// Created by  : Steinberg, 12/2005
// Description : Extract of typed stream i/o methods from FStream
//
//-----------------------------------------------------------------------------
// LICENSE
// (c) 2023, Steinberg Media Technologies GmbH, All Rights Reserved
//-----------------------------------------------------------------------------
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
// 
//   * Redistributions of source code must retain the above copyright notice, 
//     this list of conditions and the following disclaimer.
//   * Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation 
//     and/or other materials provided with the distribution.
//   * Neither the name of the Steinberg Media Technologies nor the names of its
//     contributors may be used to endorse or promote products derived from this 
//     software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
 
#pragma once
 
#include "pluginterfaces/base/funknown.h"
 
namespace Steinberg {
 
//------------------------------------------------------------------------
enum FSeekMode
{
    kSeekSet,
    kSeekCurrent,
    kSeekEnd
};
 
//------------------------------------------------------------------------
// FStreamer
//------------------------------------------------------------------------
//------------------------------------------------------------------------
class FStreamer
{
public:
//------------------------------------------------------------------------
    FStreamer (int16 byteOrder = BYTEORDER);
    virtual ~FStreamer () {}
 
    virtual TSize readRaw (void*, TSize) = 0;          
    virtual TSize writeRaw (const void*, TSize) = 0;   
    virtual int64 seek (int64, FSeekMode) = 0;         
    virtual int64 tell () = 0;                         
 
    inline void setByteOrder (int32 e) { byteOrder = (int16)e; }
    inline int32 getByteOrder () const { return byteOrder; }
 
    bool writeChar8 (char8); 
    bool readChar8 (char8&);                         
    bool writeUChar8 (unsigned char);   
    bool readUChar8 (unsigned char&);
    bool writeChar16 (char16 c); 
    bool readChar16 (char16& c); 
 
    bool writeInt8 (int8 c);   
    bool readInt8 (int8& c);
    bool writeInt8u (uint8 c);   
    bool readInt8u (uint8& c);
 
    bool writeInt16 (int16);
    bool readInt16 (int16&);
    bool writeInt16Array (const int16* array, int32 count);  
    bool readInt16Array (int16* array, int32 count);  
    bool writeInt16u (uint16);
    bool readInt16u (uint16&);
    bool writeInt16uArray (const uint16* array, int32 count);  
    bool readInt16uArray (uint16* array, int32 count);  
 
    bool writeInt32 (int32);  
    bool readInt32 (int32&);  
    bool writeInt32Array (const int32* array, int32 count);  
    bool readInt32Array (int32* array, int32 count);  
    bool writeInt32u (uint32);
    bool readInt32u (uint32&); 
    bool writeInt32uArray (const uint32* array, int32 count);  
    bool readInt32uArray (uint32* array, int32 count);  
 
    bool writeInt64 (int64);
    bool readInt64 (int64&);
    bool writeInt64Array (const int64* array, int32 count);  
    bool readInt64Array (int64* array, int32 count);  
    bool writeInt64u (uint64);
    bool readInt64u (uint64&);
    bool writeInt64uArray (const uint64* array, int32 count);  
    bool readInt64uArray (uint64* array, int32 count);  
 
    bool writeFloat (float);
    bool readFloat (float&);
    bool writeFloatArray (const float* array, int32 count);  
    bool readFloatArray (float* array, int32 count);  
 
    bool writeDouble (double);                         
    bool readDouble (double&);                         
    bool writeDoubleArray (const double* array, int32 count);  
    bool readDoubleArray (double* array, int32 count);  
 
    bool writeBool (bool);                                   
    bool readBool (bool&);                                   
 
    TSize writeString8 (const char8* ptr, bool terminate = false); 
    TSize readString8 (char8* ptr, TSize size);             
    
    bool writeStr8 (const char8* ptr);                     
    char8* readStr8 ();                                    
 
    static int32 getStr8Size (const char8* ptr);           
 
    bool writeStringUtf8 (const tchar* ptr);               
    int32 readStringUtf8 (tchar* ptr, int32 maxSize);      
 
    bool skip (uint32 bytes);
    bool pad (uint32 bytes);
 
 
//------------------------------------------------------------------------
protected:
    int16 byteOrder;
};
 
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
class FStreamSizeHolder
{
public:
    FStreamSizeHolder (FStreamer &s);
 
    void beginWrite (); 
    int32 endWrite ();  
    int32 beginRead (); 
    void endRead ();    
 
protected:
    FStreamer &stream;
    int64 sizePos;
};
 
class IBStream;
 
//------------------------------------------------------------------------
// IBStreamer
//------------------------------------------------------------------------
//------------------------------------------------------------------------
class IBStreamer: public FStreamer
{
public:
//------------------------------------------------------------------------
    IBStreamer (IBStream* stream, int16 byteOrder = BYTEORDER);
 
    IBStream* getStream () { return stream; }   
 
    // FStreamer overrides:                 
    TSize readRaw (void*, TSize) SMTG_OVERRIDE;             
    TSize writeRaw (const void*, TSize) SMTG_OVERRIDE;      
    int64 seek (int64, FSeekMode) SMTG_OVERRIDE;            
    int64 tell () SMTG_OVERRIDE;                            
//------------------------------------------------------------------------
protected:
    IBStream* stream;
};
 
//------------------------------------------------------------------------
} // namespace Steinberg