DtVideoStreamRecord.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2021 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/

#pragma once

#include <makArchives/DtDriverRecord.h>
#include <makArchives/DtImageTaskRecord.h>
#include <makArchives/DtMetadataPublisherRecord.h>

namespace makArchives
{
   class DT_DLL_MAKARCHIVES DtVideoStreamRecord
   {
   public:
      DtVideoStreamRecord();

      DtVideoStreamRecord( const DtVideoStreamRecord& obj );

      DtVideoStreamRecord& operator=( const DtVideoStreamRecord& rhs );

      ~DtVideoStreamRecord();

      const std::string& windowName() const;

      void setWindowName( const std::string& windowName );

      const std::string& channelName() const;

      void setChannelName( const std::string& channelName );

      bool autoStart() const;

      void setAutoStart( bool autoStart );

      int frameRate() const;

      void setFrameRate( int frameRate );

      const std::string& dataType() const;

      void setDataType( const std::string& dataType );

      const std::string& pixelFormat() const;

      void setPixelFormat( const std::string& pixelFormat );

      int numBuffers() const;

      void setNumBuffers( int numBuffers );

      const std::string& readBuffer() const;

      void setReadBuffer( const std::string& readBuffer );

      bool useGPUForEncoding() const;

      void setUseGPUForEncoding( bool useGPU );

      const std::string& encodingFormat() const;

      void setEncodingFormat(const std::string& encodingFormat);

      const DtMetadataPublisherRecord& metadataPublisher() const;

      void setMetadataPublisher( 
         const DtMetadataPublisherRecord& metadataPublisher );

      typedef std::vector<DtImageTaskRecord> ImageTaskRecords;

      void setImageTasks( const ImageTaskRecords& recs );

      void addImageTask( const DtImageTaskRecord& imageTask );

      void removeImageTask( const DtImageTaskRecord& imageTask );

      void clearImageTasks();

      const ImageTaskRecords& imageTasks() const;

      ImageTaskRecords& imageTasks();

   protected:
      friend class boost::serialization::access;

      template <class Archive>
      void serialize(Archive& ar, const unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP( myWindowName );
         ar & BOOST_SERIALIZATION_NVP( myChannelName );
         ar & BOOST_SERIALIZATION_NVP( myFrameRate );
         ar & BOOST_SERIALIZATION_NVP( myDataType );
         ar & BOOST_SERIALIZATION_NVP( myPixelFormat );
         ar & BOOST_SERIALIZATION_NVP( myNumBuffers );
         ar & BOOST_SERIALIZATION_NVP( myReadBuffer );
         ar & BOOST_SERIALIZATION_NVP( myMetadataPublisherRecord );
         ar & BOOST_SERIALIZATION_NVP( myImageTaskRecords );
         if ( version >= 3 )
         {
            ar & BOOST_SERIALIZATION_NVP( myAutoStart );
         }
         if (version >= 4)
         {
            ar & BOOST_SERIALIZATION_NVP(myEncodingFormat);
         }

         if (version >= 5)
         {
            ar & BOOST_SERIALIZATION_NVP(myUseGPUForEncoding);
         }
         else
         {
            // strip _hardware from myReadBuffer since, in VRV3.0 and greater, the
            // myReadBuffer attribute isn't use to dictate whether or not overlays
            // are used AND whether or not the GPU is used. Whether or no the GPU 
            // is used has been moved to a separate attribute called 
            // myUseGPUForEncoding in record versions >= 5

            size_t foundIndex = myReadBuffer.find("_hardware");
            myUseGPUForEncoding = (foundIndex != std::string::npos);
            if (myUseGPUForEncoding)
            {
               // strip '_hardware' if found
               myReadBuffer = myReadBuffer.substr(0, foundIndex);
            }
         }
      }

      std::string myWindowName;
      std::string myChannelName;
      int myFrameRate;
      std::string myDataType;
      std::string myPixelFormat;
      int myNumBuffers;
      std::string myReadBuffer;
      bool myUseGPUForEncoding;
      std::string myEncodingFormat;
      DtMetadataPublisherRecord myMetadataPublisherRecord;
      ImageTaskRecords myImageTaskRecords;
      bool myAutoStart;
   };
}
BOOST_CLASS_VERSION(makArchives::DtVideoStreamRecord, 5)