CmSerialize.h

// 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 NVIDIA CORPORATION 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 ''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.
//
// Copyright (c) 2008-2022 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  
 
#ifndef CM_SERIALIZE_H
#define CM_SERIALIZE_H
 
#include "foundation/PxSimpleTypes.h"
#include "foundation/PxIO.h"
#include "common/PxPhysXCommonConfig.h"
#include "foundation/PxUtilities.h"
 
namespace physx
{
    PX_INLINE void flip(PxU16& v)
    {
        PxU8* b = reinterpret_cast<PxU8*>(&v);
        PxU8 temp = b[0];
        b[0] = b[1];
        b[1] = temp;
    }
 
    PX_INLINE void flip(PxI16& v)
    {
        PxI8* b = reinterpret_cast<PxI8*>(&v);
        PxI8 temp = b[0];
        b[0] = b[1];
        b[1] = temp;
    }
 
    PX_INLINE void flip(PxU32& v)
    {
        PxU8* b = reinterpret_cast<PxU8*>(&v);
 
        PxU8 temp = b[0];
        b[0] = b[3];
        b[3] = temp;
        temp = b[1];
        b[1] = b[2];
        b[2] = temp;
    }
 
    // MS: It is important to modify the value directly and not use a temporary variable or a return
    //     value. The reason for this is that a flipped float might have a bit pattern which indicates
    //     an invalid float. If such a float is assigned to another float, the bit pattern
    //     can change again (maybe to map invalid floats to a common invalid pattern?).
    //     When reading the float and flipping again, the changed bit pattern will result in a different
    //     float than the original one.
    PX_INLINE void flip(PxF32& v)
    {
        PxU8* b = reinterpret_cast<PxU8*>(&v);
 
        PxU8 temp = b[0];
        b[0] = b[3];
        b[3] = temp;
        temp = b[1];
        b[1] = b[2];
        b[2] = temp;
    }
 
    PX_INLINE void  writeChunk(PxI8 a, PxI8 b, PxI8 c, PxI8 d, PxOutputStream& stream)
    {
        stream.write(&a, sizeof(PxI8));
        stream.write(&b, sizeof(PxI8));
        stream.write(&c, sizeof(PxI8));
        stream.write(&d, sizeof(PxI8));
    }
 
    void    readChunk(PxI8& a, PxI8& b, PxI8& c, PxI8& d, PxInputStream& stream);
 
    PxU16   readWord(bool mismatch, PxInputStream& stream);
    PxU32   readDword(bool mismatch, PxInputStream& stream);
    PxF32   readFloat(bool mismatch, PxInputStream& stream);
 
    void    writeWord(PxU16 value, bool mismatch, PxOutputStream& stream);
    void    writeDword(PxU32 value, bool mismatch, PxOutputStream& stream);
    void    writeFloat(PxF32 value, bool mismatch, PxOutputStream& stream);
 
    bool    readFloatBuffer(PxF32* dest, PxU32 nbFloats, bool mismatch, PxInputStream& stream);
    void    writeFloatBuffer(const PxF32* src, PxU32 nb, bool mismatch, PxOutputStream& stream);
    void    writeWordBuffer(const PxU16* src, PxU32 nb, bool mismatch, PxOutputStream& stream);
    void    readWordBuffer(PxU16* dest, PxU32 nb, bool mismatch, PxInputStream& stream);
    void    writeWordBuffer(const PxI16* src, PxU32 nb, bool mismatch, PxOutputStream& stream);
    void    readWordBuffer(PxI16* dest, PxU32 nb, bool mismatch, PxInputStream& stream);
    void    writeByteBuffer(const PxU8* src, PxU32 nb, PxOutputStream& stream);
    void    readByteBuffer(PxU8* dest, PxU32 nb, PxInputStream& stream);
 
    bool    writeHeader(PxI8 a, PxI8 b, PxI8 c, PxI8 d, PxU32 version, bool mismatch, PxOutputStream& stream);
    bool    readHeader(PxI8 a, PxI8 b, PxI8 c, PxI8 d, PxU32& version, bool& mismatch, PxInputStream& stream);
 
    PX_INLINE   bool    readIntBuffer(PxU32* dest, PxU32 nbInts, bool mismatch, PxInputStream& stream)
                        {
                            return readFloatBuffer(reinterpret_cast<PxF32*>(dest), nbInts, mismatch, stream);
                        }
 
    PX_INLINE   void    writeIntBuffer(const PxU32* src, PxU32 nb, bool mismatch, PxOutputStream& stream)
                        {
                            writeFloatBuffer(reinterpret_cast<const PxF32*>(src), nb, mismatch, stream);
                        }
 
    PX_INLINE   bool    ReadDwordBuffer(PxU32* dest, PxU32 nb, bool mismatch, PxInputStream& stream)
                        {
                            return readFloatBuffer(reinterpret_cast<float*>(dest), nb, mismatch, stream);
                        }
 
    PX_INLINE   void    WriteDwordBuffer(const PxU32* src, PxU32 nb, bool mismatch, PxOutputStream& stream)
                        {
                            writeFloatBuffer(reinterpret_cast<const float*>(src), nb, mismatch, stream);
                        }
 
     PxU32  computeMaxIndex(const PxU32* indices, PxU32 nbIndices);
     PxU16  computeMaxIndex(const PxU16* indices, PxU32 nbIndices);
     void   storeIndices(PxU32 maxIndex, PxU32 nbIndices, const PxU32* indices, PxOutputStream& stream, bool platformMismatch);
     void   readIndices(PxU32 maxIndex, PxU32 nbIndices, PxU32* indices, PxInputStream& stream, bool platformMismatch);
 
    // PT: see PX-1163
    PX_FORCE_INLINE bool readBigEndianVersionNumber(PxInputStream& stream, bool mismatch_, PxU32& fileVersion, bool& mismatch)
    {
        // PT: allright this is going to be subtle:
        // - in version 1 the data was always saved in big-endian format
        // - *including the version number*!
        // - so we cannot just read the version "as usual" using the passed mismatch param
 
        // PT: mismatch value for version 1
        mismatch = (PxLittleEndian() == 1);
 
        const PxU32 rawFileVersion = readDword(false, stream);
        if(rawFileVersion==1)
        {
            // PT: this is a version-1 file with no flip
            fileVersion = 1;
            PX_ASSERT(!mismatch);
        }
        else
        {
            PxU32 fileVersionFlipped = rawFileVersion;
            flip(fileVersionFlipped);
            if(fileVersionFlipped==1)
            {
                // PT: this is a version-1 file with flip
                fileVersion = 1;
                PX_ASSERT(mismatch);
            }
            else
            {
                // PT: this is at least version 2 so we can process it "as usual"
                mismatch = mismatch_;
                fileVersion = mismatch_ ? fileVersionFlipped : rawFileVersion;
            }
        }
 
        PX_ASSERT(fileVersion<=3);
        if(fileVersion>3)
            return false;
        return true;
    }
 
// PT: TODO: copied from IceSerialize.h, still needs to be refactored/cleaned up.
namespace Cm
{
    bool WriteHeader(PxU8 a, PxU8 b, PxU8 c, PxU8 d, PxU32 version, bool mismatch, PxOutputStream& stream);
    bool ReadHeader(PxU8 a_, PxU8 b_, PxU8 c_, PxU8 d_, PxU32& version, bool& mismatch, PxInputStream& stream);
 
    void StoreIndices(PxU32 maxIndex, PxU32 nbIndices, const PxU32* indices, PxOutputStream& stream, bool platformMismatch);
    void ReadIndices(PxU32 maxIndex, PxU32 nbIndices, PxU32* indices, PxInputStream& stream, bool platformMismatch);
 
    void StoreIndices(PxU16 maxIndex, PxU32 nbIndices, const PxU16* indices, PxOutputStream& stream, bool platformMismatch);
    void ReadIndices(PxU16 maxIndex, PxU32 nbIndices, PxU16* indices, PxInputStream& stream, bool platformMismatch);
}
 
}
 
#endif