esp_template.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2004, 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__ESP_TEMPLATE_H
#define MXFLIB__ESP_TEMPLATE_H

#include <math.h>   // For "floor"


namespace mxflib
{
    class TEMPLATE_EssenceSubParser : public EssenceSubParserBase
    {
    protected:
        UInt32 SampleRate;                                  
        Rational UseEditRate;                               

        Position DataStart;                                 
        Length DataSize;                                    
        Position CurrentPos;                                

        size_t CachedDataSize;                              
        UInt64 CachedCount;                                 

        int SampleSize;                                     
        UInt32 ConstSamples;                                
        int SampleSequenceSize;                             
        UInt32 *SampleSequence;                             
        int SequencePos;                                    

        MDObjectParent CurrentDescriptor;                   

    public:
        class ESP_EssenceSource : public EssenceSubParserBase::ESP_EssenceSource
        {
        protected:
            size_t BytesRemaining;                          

        public:
            ESP_EssenceSource(EssenceSubParserPtr TheCaller, FileHandle InFile, UInt32 UseStream, UInt64 Count = 1/*, IndexTablePtr UseIndex = NULL*/)
                : EssenceSubParserBase::ESP_EssenceSource(TheCaller, InFile, UseStream, Count/*, UseIndex*/) 
            {
                BytesRemaining = 0;
            };


            virtual size_t GetEssenceDataSize(void) 
            {
                TEMPLATE_EssenceSubParser *pCaller = SmartPtr_Cast(Caller, TEMPLATE_EssenceSubParser);
                return pCaller->ReadInternal(File, Stream, RequestedCount);
            };


            virtual DataChunkPtr GetEssenceData(size_t Size = 0, size_t MaxSize = 0);
        };

        // Give our essence source class privilaged access
        friend class TEMPLATE_EssenceSubParser::ESP_EssenceSource;

    public:
        TEMPLATE_EssenceSubParser()
        {
            SampleRate = 1;
            ConstSamples = 0;
            SampleSequenceSize = 0;
            SampleSequence = NULL;
            SequencePos = 0;
            DataStart = 0;
            DataSize = 0;
            CurrentPos = 0;

            // Use a sensible default if no edit rate is set - not ideal, but better than one sample!
            // It should always be possible to wrap at this rate, but the end of the data may not be a whole edit unit
            UseEditRate.Numerator = 1;
            UseEditRate.Denominator = 1;
        }

        virtual EssenceSubParserPtr NewParser(void) const { return new TEMPLATE_EssenceSubParser; }

        virtual StringList HandledExtensions(void)
        {
            StringList ExtensionList;

            // TODO: Add any supported extentions here
            //       This is used as a hint to the overall essence parser to decide which sub-parsers to try.
            //       Calls may still be made to this sub-parser for files of different extensions, but this is a starting point.

            // ExtensionList.push_back("XXX");

            return ExtensionList;
        }

        virtual EssenceStreamDescriptorList IdentifyEssence(FileHandle InFile);

        virtual WrappingOptionList IdentifyWrappingOptions(FileHandle InFile, EssenceStreamDescriptor &Descriptor);


        virtual void Use(UInt32 Stream, WrappingOptionPtr UseWrapping)
        {
            SelectedWrapping = UseWrapping;

            CurrentPos = 0;
        }



        virtual bool SetEditRate(Rational EditRate)
        {
            // See if we can figure out a sequence for this rate
            bool Ret = CalcWrappingSequence(EditRate);

            // If we can then set the rate
            if(Ret)
            {
                SequencePos = 0;
                UseEditRate = EditRate;
            }

            return Ret;
        }

        virtual Rational GetEditRate(void) { return UseEditRate; }


        virtual Rational GetPreferredEditRate(void);

        virtual UInt32 GetBytesPerEditUnit(UInt32 KAGSize = 1)
        {
            // If we haven't determined the sample sequence we do it now
            if((ConstSamples == 0) && (SampleSequenceSize == 0)) CalcWrappingSequence(UseEditRate);

            UInt32 Ret = SampleSize*ConstSamples;

            if(Ret && (SelectedWrapping->ThisWrapType == WrappingOption::Frame))
            {
                // FIXME: This assumes that 4-byte BER coding will be used - this needs to be adjusted or forced to be true!!
                Ret += 16 + 4;

                // Adjust for whole KAGs if required
                if(KAGSize > 1)
                {
                    // Work out how much short of the next KAG boundary we would be
                    UInt32 Remainder = Ret % KAGSize;
                    if(Remainder) Remainder = KAGSize - Remainder;

                    // Round up to the start of the next KAG
                    Ret += Remainder;

                    // If there is not enough space to fit a filler in the remaining space an extra KAG will be required
                    // DRAGONS: For very small KAGSizes we may need to add several KAGs
                    while((Remainder > 0) && (Remainder < 17))
                    {
                        Ret += KAGSize;
                        Remainder += KAGSize;
                    }
                }
            }

            return Ret;
        }


        virtual Position GetCurrentPosition(void);

        virtual DataChunkPtr Read(FileHandle InFile, UInt32 Stream, UInt64 Count = 1);

        virtual EssenceSubParserBase::ESP_EssenceSource *GetEssenceSource(FileHandle InFile, UInt32 Stream, UInt64 Count = 1)
        {
            return new ESP_EssenceSource(this, InFile, Stream, Count);
        };

        virtual Length Write(FileHandle InFile, UInt32 Stream, MXFFilePtr OutFile, UInt64 Count = 1);



        // TODO: Fill in the parser name
        virtual std::string GetParserName(void) const { return "template"; }


    protected:
        bool CalcWrappingSequence(Rational EditRate);

        MDObjectPtr BuildDescriptor(FileHandle InFile, UInt64 Start = 0);

        size_t ReadInternal(FileHandle InFile, UInt32 Stream, UInt64 Count);
    };


    class TEMPLATE_EssenceSubParserFactory : public EssenceSubParserFactory
    {
    public:
        virtual EssenceSubParserPtr NewParser(void) const { return new TEMPLATE_EssenceSubParser; }
    };
}

#endif // MXFLIB__ESP_TEMPLATE_H

---