mdtraits.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2003, Matt Beard
 *
 *  This software is provided 'as-is', without any express or implied warranty.
 *  In no event will the authors be held liable for any damages arising from
 *  the use of this software.
 *
 *  Permission is granted to anyone to use this software for any purpose,
 *  including commercial applications, and to alter it and redistribute it
 *  freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must
 *       not claim that you wrote the original software. If you use this
 *       software in a product, an acknowledgment in the product
 *       documentation would be appreciated but is not required.
 *  
 *    2. Altered source versions must be plainly marked as such, and must
 *       not be misrepresented as being the original software.
 *  
 *    3. This notice may not be removed or altered from any source
 *       distribution.
 */
#ifndef MXFLIB__MDTRAITS_H
#define MXFLIB__MDTRAITS_H

namespace mxflib
{
    // Forward declare so the class can include pointers to itself (if required)
    class MDTraits;

    typedef SmartPtr<MDTraits> MDTraitsPtr;

    typedef std::list<MDTraitsPtr> MDTraitsList;

    typedef std::map<std::string, MDTraitsPtr> MDTraitsMap;
}


namespace mxflib
{

    extern UInt32 MDTraits_StringLimit;

    inline void SetStringLimit(UInt32 StringLimit) { MDTraits_StringLimit = StringLimit; }

    inline UInt32 GetStringLimit(void) { return MDTraits_StringLimit; }
}


namespace mxflib
{

    extern bool TerminateStrings;

    inline void SetStringTermination(bool Value) { TerminateStrings = Value; }

    inline bool GetStringTermination(void) { return TerminateStrings; }

    enum LabelFormat 
    {
        LabelFormatText = 0,            
        LabelFormatHex,             
        LabelFormatTextHex,         
        LabelFormatTextHexMask          
    };

    extern LabelFormat LabelFormatOption;

    inline void SetLabelFormat(LabelFormat Value) { LabelFormatOption = Value; }

    inline LabelFormat GetLabelFormat(void) { return LabelFormatOption; }
}


namespace mxflib
{
    class MDTraits : public RefCount<MDTraits>
    {
    protected:
        static MDTraitsMap AllTraits;

        MDTraits() {};

    public:
        virtual ~MDTraits() {}


        virtual bool HandlesSubdata(void) const { return false; };

        virtual std::string Name() const = 0;

    /* Static Methods */
    public:

        static bool Add(std::string Name, MDTraitsPtr Trait);


        static bool Replace(std::string Name, MDTraitsPtr Trait);


        static MDTraitsPtr Find(std::string Name);

    /* Default implementations */
    protected:
        virtual void SetInt(MDValuePtr Object, Int32 Val);
        virtual void SetInt64(MDValuePtr Object, Int64 Val);
        virtual void SetUInt(MDValuePtr Object, UInt32 Val);
        virtual void SetUInt64(MDValuePtr Object, UInt64 Val);
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual Int32 GetInt(MDValuePtr Object);
        virtual Int64 GetInt64(MDValuePtr Object);
        virtual UInt32 GetUInt(MDValuePtr Object);
        virtual UInt64 GetUInt64(MDValuePtr Object);
        virtual std::string GetString(MDValuePtr Object);

        virtual size_t ReadValue(MDValuePtr Object, const UInt8 *Buffer, size_t Size, int Count=0);

        inline void SetUint(MDValuePtr Object, UInt32 Val) { SetUInt(Object, Val); }

        inline void SetUint64(MDValuePtr Object, UInt64 Val) { SetUInt64(Object, Val); }

        inline UInt32 GetUint(MDValuePtr Object) { return GetUInt(Object); }

        inline UInt64 GetUint64(MDValuePtr Object) { return GetUInt64(Object); }

        // Give the MDValue class access to our internals to call Set/Get functions
        friend class MDValue;
    };


    template<class C> std::string CreateMDTraits(void)
    {
        MDTraitsPtr Tr = new C;
        MDTraits::Add(Tr->Name(), Tr );
        return Tr->Name();
    }

    class MDTraits_DefaultTraits : public MDTraits
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_DefaultTraits"; };
    };

    // Extended implementations
    class MDTraits_BasicInt : public MDTraits
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_BasicInt"; };

    protected:
        virtual void SetInt64(MDValuePtr Object, Int64 Val);
        virtual void SetUInt(MDValuePtr Object, UInt32 Val);
        virtual void SetUInt64(MDValuePtr Object, UInt64 Val);
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual Int64 GetInt64(MDValuePtr Object);
        virtual UInt64 GetUInt64(MDValuePtr Object);
        virtual std::string GetString(MDValuePtr Object);

        virtual size_t ReadValue(MDValuePtr Object, const UInt8 *Buffer, size_t Size, int Count=0);
    };

    size_t ReadValueUInt(MDValuePtr Object, const UInt8 *Buffer, size_t Size, int Count=0);

    class MDTraits_Int8 : public MDTraits_BasicInt
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_Int8"; };

    protected:
        virtual void SetInt(MDValuePtr Object, Int32 Val);
        virtual Int32 GetInt(MDValuePtr Object);
        virtual UInt32 GetUInt(MDValuePtr Object);
    };

    class MDTraits_UInt8 : public MDTraits_Int8
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_UInt8"; };

    protected:
        virtual std::string GetString(MDValuePtr Object);
        virtual size_t ReadValue(MDValuePtr Object, const UInt8 *Buffer, size_t Size, int Count=0);
    };

    class MDTraits_Int16 : public MDTraits_BasicInt
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_Int16"; };

    protected:
        virtual void SetInt(MDValuePtr Object, Int32 Val);
        virtual Int32 GetInt(MDValuePtr Object);
        virtual UInt32 GetUInt(MDValuePtr Object);
    };

    class MDTraits_UInt16 : public MDTraits_Int16
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_UInt16"; };

    protected:
        virtual std::string GetString(MDValuePtr Object);
        virtual size_t ReadValue(MDValuePtr Object, const UInt8 *Buffer, size_t Size, int Count=0);
    };

    class MDTraits_Int32 : public MDTraits_BasicInt
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_Int32"; };

    protected:
        virtual void SetInt(MDValuePtr Object, Int32 Val);
        virtual Int32 GetInt(MDValuePtr Object);
        virtual UInt32 GetUInt(MDValuePtr Object);
    };

    class MDTraits_UInt32 : public MDTraits_Int32
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_UInt32"; };

    protected:
        virtual std::string GetString(MDValuePtr Object);
        virtual size_t ReadValue(MDValuePtr Object, const UInt8 *Buffer, size_t Size, int Count=0);
    };

    class MDTraits_Int64 : public MDTraits
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_Int64"; };

    protected:
        virtual void SetInt(MDValuePtr Object, Int32 Val);
        virtual void SetInt64(MDValuePtr Object, Int64 Val);
        virtual void SetUInt(MDValuePtr Object, UInt32 Val);
        virtual void SetUInt64(MDValuePtr Object, UInt64 Val);
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual Int32 GetInt(MDValuePtr Object);
        virtual UInt32 GetUInt(MDValuePtr Object);
        virtual Int64 GetInt64(MDValuePtr Object);
        virtual UInt64 GetUInt64(MDValuePtr Object);
        virtual std::string GetString(MDValuePtr Object);
    };

    class MDTraits_UInt64 : public MDTraits_Int64
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_UInt64"; };

    protected:
        virtual std::string GetString(MDValuePtr Object);
        virtual size_t ReadValue(MDValuePtr Object, const UInt8 *Buffer, size_t Size, int Count=0);
    };

    class MDTraits_ISO7 : public MDTraits_UInt8
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_ISO7"; };

    protected:
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);
    };

    class MDTraits_UTF16 : public MDTraits_UInt16
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_UTF16"; };

    protected:
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);
    };

    class MDTraits_Raw : public MDTraits
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_Raw"; };


        virtual bool HandlesSubdata(void) const { return false; };

    protected:
        //DRAGONS: Should probably have set integer functions as well
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual Int32 GetInt(MDValuePtr Object);
        virtual Int64 GetInt64(MDValuePtr Object);
        virtual UInt32 GetUInt(MDValuePtr Object);
        virtual UInt64 GetUInt64(MDValuePtr Object);
        virtual std::string GetString(MDValuePtr Object);

        virtual size_t ReadValue(MDValuePtr Object, const UInt8 *Buffer, size_t Size, int Count=0);
    };


    class MDTraits_BasicArray : public MDTraits
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_BasicArray"; };

    protected:
        virtual void SetInt(MDValuePtr Object, Int32 Val);
        virtual void SetInt64(MDValuePtr Object, Int64 Val);
        virtual void SetUInt(MDValuePtr Object, UInt32 Val);
        virtual void SetUInt64(MDValuePtr Object, UInt64 Val);
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual Int32 GetInt(MDValuePtr Object);
        virtual Int64 GetInt64(MDValuePtr Object);
        virtual UInt32 GetUInt(MDValuePtr Object);
        virtual UInt64 GetUInt64(MDValuePtr Object);
        virtual std::string GetString(MDValuePtr Object);

        virtual size_t ReadValue(MDValuePtr Object, const UInt8 *Buffer, size_t Size, int Count=0);
    };

    class MDTraits_BasicStringArray : public MDTraits_BasicArray
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_BasicStringArray"; };

    protected:
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);
    };
    
    class MDTraits_UTF16String : public MDTraits_BasicStringArray
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_UTF16String"; };

    protected:
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);
    };

    class MDTraits_RawArray : public MDTraits_BasicArray
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_RawArray"; };

    protected:
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);
    };

    class MDTraits_UUID : public MDTraits_Raw
    {
    public:

        virtual bool HandlesSubdata(void) const { return true; };

        virtual std::string Name() const { return "mxflib::MDTraits_UUID"; };

    protected:
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);
    };

    class MDTraits_Label : public MDTraits_Raw
    {
    public:

        virtual bool HandlesSubdata(void) const { return true; };

        virtual std::string Name() const { return "mxflib::MDTraits_Label"; };

    protected:
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);
    };

    class MDTraits_UMID : public MDTraits_Raw
    {
    public:

        virtual bool HandlesSubdata(void) const { return true; };

        virtual std::string Name() const { return "mxflib::MDTraits_UMID"; };

    protected:
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);
    };

    class MDTraits_RawArrayArray : public MDTraits_BasicArray
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_RawArrayArray"; };

    protected:
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);
    };

    class MDTraits_BasicCompound : public MDTraits
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_BasicCompound"; };

    protected:
        // DRAGONS: What about all the other set and get functions?
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);

        virtual size_t ReadValue(MDValuePtr Object, const UInt8 *Buffer, size_t Size, int Count=0);
    };

    class MDTraits_BasicEnum : public MDTraits
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_BasicEnum"; };

    protected:
        // DRAGONS: What about all the other set and get functions?
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);
    };

    class MDTraits_Rational : public MDTraits_BasicCompound
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_Rational"; };

    protected:
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);
    };

    class MDTraits_TimeStamp : public MDTraits_BasicCompound
    {
    public:
        virtual std::string Name() const { return "mxflib::MDTraits_TimeStamp"; };

    protected:
        virtual void SetString(MDValuePtr Object, std::string Val);
        virtual std::string GetString(MDValuePtr Object);
    };
}

#endif // MXFLIB__MDTRAITS_H

---