DtMetadataElement.h

Go to the documentation of this file.

// /****************************************************************************** 
// ** Copyright (c) 2022 VT-MAK Technologies, Inc. 
// ** All rights reserved. 
// ******************************************************************************/ 


#pragma once
#include <vrvVideoStream/DtKlvKey.h>

#include <vector>

namespace makVrv
{
   class DtMetadataPublisher;

   class DT_DLL_VRVVIDEOSTREAM DtMetadataElement
   {
   public:
      DtMetadataElement();

      virtual ~DtMetadataElement();

      virtual void setPublisher( DtMetadataPublisher* publisher ); 

      virtual unsigned int encodedLength() = 0;

      virtual unsigned char* encode( unsigned char* buffer ) = 0;
      
      virtual void decode( unsigned char* buffer, unsigned int length ) = 0;

      virtual bool timeForUpdate();

      virtual void tick(double dt);

      virtual void setFrequency( float timeInSeconds );

      virtual void addChild( DtMetadataElement* element );

      virtual DtKlvKey& key();

      virtual bool isMetadataSynchronous() const;

      virtual void setIsMetadataSynchronous(bool isMetadataSynchronous);


   protected: 
      virtual void update() = 0;

      virtual unsigned int encodedLengthChildren();

   protected:
      DtMetadataElement* myParent;
      std::vector<DtMetadataElement*> myChildren;
      DtMetadataPublisher* myPublisher;

      bool myIsDirty;
      DtKlvKey myKey;

      float myFrequency;
      bool myTimeToUpdate;

      bool myIsMetadataSynchronous;
   };
}