genesis-3d_engine/Engine/foundation/io/binaryreader.cc

/****************************************************************************
Copyright (c) 2006, Radon Labs GmbH
Copyright (c) 2011-2013,WebJet Business Division,CYOU
 
http://www.genesis-3d.com.cn

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/

#include "stdneb.h"
#include "io/binaryreader.h"

namespace IO
{
__ImplementClass(IO::BinaryReader, 'BINR', IO::StreamReader);

using namespace Util;
using namespace System;

//------------------------------------------------------------------------------
/**
*/
BinaryReader::BinaryReader() :
    enableMapping(false),
    isMapped(false),
    mapCursor(0),
    mapEnd(0)
{
    // empty
}

//------------------------------------------------------------------------------
/**
*/
BinaryReader::~BinaryReader()
{
    if (this->IsOpen())
    {
        this->Close();
    }
}

//------------------------------------------------------------------------------
/**
*/
bool
BinaryReader::Open()
{
    if (StreamReader::Open())
    {
        if (this->enableMapping && this->stream->CanBeMapped())
        {
            this->isMapped = true;
            this->mapCursor = (unsigned char*) this->stream->Map();
            this->mapEnd = this->mapCursor + this->stream->GetSize();
        }
        else
        {
            this->isMapped = false;
            this->mapCursor = 0;
            this->mapEnd = 0;
        }
        return true;
    }
    return false;
}

//------------------------------------------------------------------------------
/**
*/
void
BinaryReader::Close()
{
    StreamReader::Close();
    this->isMapped = false;
    this->mapCursor = 0;
    this->mapEnd = 0;
}

//------------------------------------------------------------------------------
/**
*/
char
BinaryReader::ReadChar()
{
    if (this->isMapped)
    {
        n_assert(this->mapCursor < this->mapEnd);
        return *this->mapCursor++;
    }
    else
    {
        char c;
        this->stream->Read(&c, sizeof(c));
        return c;
    }
}

//------------------------------------------------------------------------------
/**
*/
unsigned char
BinaryReader::ReadUChar()
{
    if (this->isMapped)
    {
        n_assert(this->mapCursor < this->mapEnd);
        return *this->mapCursor++;
    }
    else
    {
        unsigned char c;
        this->stream->Read(&c, sizeof(c));
        return c;
    }
}

//------------------------------------------------------------------------------
/**
*/
short
BinaryReader::ReadShort()
{
    short val;
    if (this->isMapped)
    {
        // note: the memory copy is necessary to circumvent alignment problem on some CPUs
        n_assert((this->mapCursor + sizeof(short)) <= this->mapEnd);        
        Memory::Copy(this->mapCursor, &val, sizeof(val));
        this->mapCursor += sizeof(val);
    }
    else
    {
        this->stream->Read(&val, sizeof(val));
    }
    return this->byteOrder.Convert<short>(val);
}

//------------------------------------------------------------------------------
/**
*/ 
unsigned short
BinaryReader::ReadUShort()
{
    ushort val;
    if (this->isMapped)
    {
        // note: the memory copy is necessary to circumvent alignment problem on some CPUs
        n_assert((this->mapCursor + sizeof(unsigned short)) <= this->mapEnd);
        Memory::Copy(this->mapCursor, &val, sizeof(val));
        this->mapCursor += sizeof(val);
    }
    else
    {
        this->stream->Read(&val, sizeof(val));
    }
    return this->byteOrder.Convert<ushort>(val);
}

//------------------------------------------------------------------------------
/**
*/
int
BinaryReader::ReadInt()
{
    int val;
    if (this->isMapped)
    {
        // note: the memory copy is necessary to circumvent alignment problem on some CPUs
        n_assert((this->mapCursor + sizeof(int)) <= this->mapEnd);
        Memory::Copy(this->mapCursor, &val, sizeof(val));
        this->mapCursor += sizeof(val);
    }
    else
    {
        this->stream->Read(&val, sizeof(val));
    }
    return this->byteOrder.Convert<int>(val);
}

//------------------------------------------------------------------------------
/**
*/
unsigned int
BinaryReader::ReadUInt()
{
    uint val;
    if (this->isMapped)
    {
        // note: the memory copy is necessary to circumvent alignment problem on some CPUs
        n_assert((this->mapCursor + sizeof(unsigned int)) <= this->mapEnd);
        Memory::Copy(this->mapCursor, &val, sizeof(val));
        this->mapCursor += sizeof(val);
    }
    else
    {
        this->stream->Read(&val, sizeof(val));
    }
    return this->byteOrder.Convert<uint>(val);
}

//------------------------------------------------------------------------------
/**
*/
float
BinaryReader::ReadFloat()
{
    float val;
    if (this->isMapped)
    {
        // note: the memory copy is necessary to circumvent alignment problem on some CPUs
        n_assert((this->mapCursor + sizeof(float)) <= this->mapEnd);
        Memory::Copy(this->mapCursor, &val, sizeof(val));
        this->mapCursor += sizeof(val);
    }
    else
    {
        this->stream->Read(&val, sizeof(val));
    }
    return this->byteOrder.Convert<float>(val);
}

//------------------------------------------------------------------------------
/**
*/
float
BinaryReader::ReadFloatFromNormalizedUByte2()
{
    unsigned short compressedVal = this->ReadUShort();
    float result = ((float)compressedVal / 32767.5f) + 1.0f;
    return result;
}

//------------------------------------------------------------------------------
/**
*/
float
BinaryReader::ReadFloatFromUnsignedNormalizedUByte2()
{
    unsigned short compressedVal = this->ReadUShort();
    float result = (float)compressedVal / 65535.0f;
    return result;
}

//------------------------------------------------------------------------------
/**
*/
double
BinaryReader::ReadDouble()
{
    double val;
    if (this->isMapped)
    {
        // note: the memory copy is necessary to circumvent alignment problem on some CPUs
        n_assert((this->mapCursor + sizeof(double)) <= this->mapEnd);
        Memory::Copy(this->mapCursor, &val, sizeof(val));
        this->mapCursor += sizeof(val);
    }
    else
    {
        this->stream->Read(&val, sizeof(val));
    }
    return this->byteOrder.Convert<double>(val);
}

//------------------------------------------------------------------------------
/**
*/
bool
BinaryReader::ReadBool()
{
    bool val;
    if (this->isMapped)
    {
        // note: the memory copy is necessary to circumvent alignment problem on some CPUs
        n_assert((this->mapCursor + sizeof(bool)) <= this->mapEnd);
        Memory::Copy(this->mapCursor, &val, sizeof(val));
        this->mapCursor += sizeof(val);
    }
    else
    {
        this->stream->Read(&val, sizeof(val));        
    }
    return val;
}

//------------------------------------------------------------------------------
/**
*/
Util::String
BinaryReader::ReadString()
{
    if (this->isMapped)
    {
        ushort length = this->ReadUShort();
        n_assert((this->mapCursor + length) <= this->mapEnd);
        Util::String str;
        if (length > 0)
        {
            str.Reserve(length + 1);
            char* buf = (char*) str.AsCharPtr();
            Memory::Copy(this->mapCursor, buf, length);
            this->mapCursor += length;
            buf[length] = 0;
        }
        return str;    
    }
    else
    {
        ushort length = this->ReadUShort();
        Util::String str;
        if (length > 0)
        {
            str.Reserve(length + 1);
            char* buf = (char*) str.AsCharPtr();
            this->stream->Read((void*)buf, length);
            buf[length] = 0;
        }
        return str;
    }
}

//------------------------------------------------------------------------------
/**
*/
Util::Blob
BinaryReader::ReadBlob()
{
    SizeT numBytes = this->ReadUInt();
    Util::Blob blob(numBytes);
    void* ptr = const_cast<void*>(blob.GetPtr());
    if (this->isMapped)
    {
        n_assert((this->mapCursor + numBytes) <= this->mapEnd);
        Memory::Copy(this->mapCursor, ptr, numBytes);
        this->mapCursor += numBytes;
    }
    else
    {
        this->stream->Read(ptr, numBytes);
    }
    return blob;
}

//------------------------------------------------------------------------------
/**
*/
Util::Guid
BinaryReader::ReadGuid()
{
    Util::Blob blob = this->ReadBlob();
    return Util::Guid((const unsigned char*) blob.GetPtr(), blob.Size());
}
     

//------------------------------------------------------------------------------
/**
*/
Math::float2 
BinaryReader::ReadFloat2()
{
    Math::float2 val;
    if (this->isMapped)
    {
        // note: the memory copy is necessary to circumvent alignment problem on some CPUs
        n_assert((this->mapCursor + sizeof(Math::float2)) <= this->mapEnd);
        Memory::Copy(this->mapCursor, &val, sizeof(val));
        this->mapCursor += sizeof(val);
    }
    else
    {
        this->stream->Read(&val, sizeof(val));
    }

    val.set(this->byteOrder.Convert<float>(val.x()),
            this->byteOrder.Convert<float>(val.y()));
    return val;    
}

//------------------------------------------------------------------------------
/**
*/ 
Math::float4
BinaryReader::ReadFloat4()
{
    Math::float4 val;
    if (this->isMapped)
    {
        // note: the memory copy is necessary to circumvent alignment problem on some CPUs
        n_assert((this->mapCursor + sizeof(Math::float4)) <= this->mapEnd);
        Memory::Copy(this->mapCursor, &val, sizeof(val));     
        this->mapCursor += sizeof(val);
    }
    else
    {
        this->stream->Read(&val, sizeof(val));
    }
    this->byteOrder.ConvertInPlace<Math::float4>(val);
    return val;
}    

//------------------------------------------------------------------------------
/**
*/
Math::point 
BinaryReader::ReadPoint()
{
    float val[3];
    const SizeT readSize = sizeof(float) * 3;
    if (this->isMapped)
    {
        // note: the memory copy is necessary to circumvent alignment problem on some CPUs
        n_assert((this->mapCursor + readSize) <= this->mapEnd);
        Memory::Copy(this->mapCursor, val, readSize);
        this->mapCursor += readSize;
    }
    else
    {
        this->stream->Read(val, readSize);
    }

    this->byteOrder.ConvertInPlace<float>(val[0]);
    this->byteOrder.ConvertInPlace<float>(val[1]);
    this->byteOrder.ConvertInPlace<float>(val[2]);

    return Math::point(val[0], val[1], val[2]);
}

//------------------------------------------------------------------------------
/**
*/
Math::vector 
BinaryReader::ReadVector()
{
    float val[3];    
    const SizeT readSize = sizeof(float) * 3;
    if (this->isMapped)
    {
        // note: the memory copy is necessary to circumvent alignment problem on some CPUs
        n_assert((this->mapCursor + readSize) <= this->mapEnd);
        Memory::Copy(this->mapCursor, val, readSize);
        this->mapCursor += readSize;
    }
    else
    {
        this->stream->Read(val, readSize);
    }

    this->byteOrder.ConvertInPlace<float>(val[0]);
    this->byteOrder.ConvertInPlace<float>(val[1]);
    this->byteOrder.ConvertInPlace<float>(val[2]);

    return Math::vector(val[0], val[1], val[2]);
}

//------------------------------------------------------------------------------
/**
*/ 
Math::matrix44
BinaryReader::ReadMatrix44()
{
    Math::matrix44 val;
    if (this->isMapped)
    {
        // note: the memory copy is necessary to circumvent alignment problem on some CPUs
        n_assert((this->mapCursor + sizeof(Math::matrix44)) <= this->mapEnd);
        Memory::Copy(this->mapCursor, &val, sizeof(val));        
        this->mapCursor += sizeof(val);
    }
    else
    {
        this->stream->Read(&val, sizeof(val));
    }
    this->byteOrder.ConvertInPlace<Math::matrix44>(val);
    return val;
}

    
//------------------------------------------------------------------------------
/**
*/ 
void
BinaryReader::ReadRawData(void* ptr, SizeT numBytes)
{
    n_assert((ptr != 0) && (numBytes > 0));
    if (this->isMapped)
    {
        n_assert((this->mapCursor + numBytes) <= this->mapEnd);
        Memory::Copy(this->mapCursor, ptr, numBytes);
        this->mapCursor += numBytes;
    }
    else
    {
        this->stream->Read(ptr, numBytes);
    }
}
} // namespace IO