DtVideoStream.h

Go to the documentation of this file.

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


#pragma once

#include <vrvVideoStream/vrvVideoStream.h>

#include <vrvCore/DtDe.h>

#include <vrvUtil/DtUnicode.h>
#include <vrvUtil/signalslib.h>
#include <vrvUtil/DtSignalConnectionManager.h>

#include <makArchives/DtVideoStreamRecord.h>

#include <osg/ref_ptr>

namespace makVrv
{
   class DtReadFramebufferCallback;
   class DtVideoStreamManager;
   class DtOsgChannel;
   class DtChannelManager;
   class DtChannel;

   class DT_DLL_VRVVIDEOSTREAM DtVideoStream 
   {
   public:

      enum VideoStreamStatus
      {
         Stopped,    
         Started,    
         Suspended,
         Unavailable 
      };
      friend class DtVideoStreamCreator;

      friend class DtVideoStreamManager;

      virtual ~DtVideoStream();

      virtual DtUnicode instanceName() const;

      virtual DtUnicode className() const;

      virtual bool start();

      virtual void notifyOtherStreamStarted( const DtVideoStream& startedStream );

      virtual bool stop();

      virtual void setAutoStart( bool autoStart );

      virtual bool autoStart() const;

      virtual void notifyOtherStreamStopped( const DtVideoStream& stoppedStream );

      virtual VideoStreamStatus status() const;

      virtual void setFromRecord( 
         const makArchives::DtVideoStreamRecord& vsRecord );

      virtual void setFromVideoStream( const DtVideoStream& stream );


      virtual int channelWidth() const;

      virtual int channelHeight() const;

      virtual int channelX() const;

      virtual int channelY() const;

      virtual double horizontalFov() const;

      virtual double verticalFov() const;


      virtual void setWindowName( const DtUnicode& windowName );

      virtual DtUnicode windowName() const;

      virtual void setChannelName( const DtUnicode& channelName );

      virtual DtUnicode channelName() const;

      virtual void setDataType( const DtUnicode& dataType );

      virtual DtUnicode dataType() const;

      virtual void setFrameRate( int frameRate );

      virtual int frameRate() const;

      virtual void setPixelFormat( const DtUnicode& pixelFormat );

      virtual DtUnicode pixelFormat() const;

      virtual void setNumBuffers( int numBuffers );

      virtual int numBuffers() const;

      virtual void setReadBuffer( const DtUnicode& readBuffer );
      
      virtual DtUnicode readBuffer() const;

      virtual void setUseGPUForEncoding( bool useGPU );

      virtual bool useGPUForEncoding() const;

      void setEncodingFormat(const DtUnicode& encodingFormat);

      DtUnicode encodingFormat() const;

      virtual void addImageTask( 
         const makArchives::DtImageTaskRecord& imageTask );

      virtual void removeImageTask( 
         const makArchives::DtImageTaskRecord& imageTask );

      virtual void setImageTask( int index, 
         const makArchives::DtImageTaskRecord& imageTask );

      virtual void setImageTasks( 
         const makArchives::DtVideoStreamRecord::ImageTaskRecords& imageTasks );

      virtual const makArchives::DtVideoStreamRecord::ImageTaskRecords& 
         imageTasks() const;

      virtual makArchives::DtVideoStreamRecord::ImageTaskRecords& imageTasks();

      virtual void setParameterInt( int taskElementIndex, 
         const DtUnicode& parameterName, int value );

      virtual void setParameterDouble( int taskElementIndex,
         const DtUnicode& parameterName, double value );

      virtual void setParameterBool( int taskElementIndex, 
         const DtUnicode& parameterName, bool value );

      virtual void setParameterString( int taskElementIndex, 
         const DtUnicode& parameterName, const DtUnicode& value );

      virtual void setMetadataPublisher( 
         const makArchives::DtMetadataPublisherRecord& pubRecord );

      virtual void setMetadataPublisherType( const DtUnicode& pubType );

      virtual void setMetadataPublisherObserverName( 
         const DtUnicode& observer );

      virtual void setMetadataPublisherParameters( 
         const makArchives::DtNameValueLists& parameters );

      virtual const makArchives::DtMetadataPublisherRecord& metadataPublisher()
         const;

      virtual void swapImageTasks( int index1, int index2 );

      virtual bool saveVideoStream( const DtUnicode& filePath ) const;

      virtual bool loadVideoStream( const DtUnicode& filePath );

      virtual void reportFramebufferCallbackFailure();


      boost::signalslib::signal<void ( const DtUnicode& )> signal_windowNameChanged;

      boost::signalslib::signal<void ( const DtUnicode& )> signal_channelNameChanged;

      boost::signalslib::signal<void ( const DtUnicode& )> signal_dataTypeChanged;

      boost::signalslib::signal<void ( int )> signal_frameRateChanged;

      boost::signalslib::signal<void ( const DtUnicode& )> signal_pixelFormatChanged;

      boost::signalslib::signal<void ( int )> signal_numBuffersChanged;

      boost::signalslib::signal<void ( const DtUnicode& )> signal_readBufferChanged;
      
      boost::signalslib::signal<void ( bool )> signal_useGPUForEncodingChanged;

      boost::signalslib::signal<void(const DtUnicode&)> signal_encodingFormatChanged;

      boost::signalslib::signal<void ( const makArchives::DtImageTaskRecord& )> 
         signal_imageTaskAdded;

      boost::signalslib::signal<void ( const makArchives::DtImageTaskRecord& )> 
         signal_imageTaskToBeRemoved;

      boost::signalslib::signal<void ( int imageTaskIndex )> signal_imageTaskRemoved;

      boost::signalslib::signal<void ( 
         const makArchives::DtVideoStreamRecord::ImageTaskRecords& )> 
         signal_imageTasksChanged;

      boost::signalslib::signal<void ( int  index, const makArchives::DtImageTaskRecord& )> 
         signal_imageTaskChanged;

      boost::signalslib::signal<void ( const makArchives::DtMetadataPublisherRecord& )>
         signal_metadataPublisherChanged;

      boost::signalslib::signal<void ( const DtUnicode& )>  
         signal_metadataPublisherTypeChanged;

      boost::signalslib::signal<void ( const DtUnicode& )> 
         signal_metadataPublisherObserverNameChanged;

      boost::signalslib::signal<void ( const makArchives::DtNameValueLists& )> 
         signal_metadataPublisherParametersChanged;

      boost::signalslib::signal<void ( int index1, int index2 )> signal_imageTasksSwapped;

      boost::signalslib::signal<void ( VideoStreamStatus )> signal_videoStreamStatusChanged;

      boost::signalslib::signal< void ( bool )> signal_videoStreamAutoStartChanged;

      boost::signalslib::signal<void ( 
         int taskIndex, const DtUnicode& parameter, int value )> 
         signal_intTaskParameterChanged;

      boost::signalslib::signal<void ( 
         int taskIndex, const DtUnicode& parameter, double value )> 
         signal_doubleTaskParameterChanged;

      boost::signalslib::signal<void ( 
         int taskIndex, const DtUnicode& parameter, bool value )> 
         signal_boolTaskParameterChanged;

      boost::signalslib::signal<void ( 
         int taskIndex, const DtUnicode& parameter, const DtUnicode& value )> 
         signal_stringTaskParameterChanged;

   protected:

      DtVideoStream(DtDe& de, DtVideoStreamManager& mgr, 
         const DtUnicode& className, const DtUnicode& instanceName );

      virtual DtReadFramebufferCallback* createFramebufferReadbackIfNecessary();

      virtual void updateFov();

      virtual void updateChannelWidthAndHeight();

      virtual bool installFramebufferCallback();

      virtual void removeFrameReadback();

      virtual void slot_channelConfigurationModified(const std::string& displayName,
         const std::string& windowName, const std::string& channelName );
      
      virtual void slot_windowConfigurationModified(const std::string& displayName,
         const std::string& windowName );

      virtual void slot_channelToBeDestroyed(DtChannelManager*  mgr, DtChannel*  channel);

      virtual void slot_deleteReadFramebufferCallback();

      virtual void slot_updateReadFramebufferCallbackIfNeeded();
      
      virtual void cleanChannel(DtOsgChannel* channel);

      virtual DtOsgChannel* findMatchingOsgChannel(void) const;

   private:

      DtVideoStream();

      DtVideoStream( const DtVideoStream& rhs );

      DtVideoStream& operator=( const DtVideoStream& rhs );

   protected:
      makArchives::DtVideoStreamRecord myVideoStreamRecord;
      DtVideoStreamManager& myVideoStreamManager;
      osg::ref_ptr<DtReadFramebufferCallback> myChannelReadback;
      DtOsgChannel* myChannel;
      DtDe& myDe;
      DtUnicode myInstanceName;
      DtUnicode myClassName;
      int myChannelWidth;
      int myChannelHeight;
      int myChannelX;
      int myChannelY;
      double myHorizontalFov;
      double myVerticalFov;
      VideoStreamStatus myStatus;
      DtSignalConnectionManager myConnections;

      boost::signalslib::connection myPreTickConnection;
      boost::signalslib::connection myPostTickConnection;
      boost::signalslib::connection myChannelConfigurationModifiedConnection;
      boost::signalslib::connection myWindowConfigurationModifiedConnection;
   };

   class DT_DLL_VRVVIDEOSTREAM DtVideoStreamCreator
   {
   public:   
      friend class DtVideoStreamManager;

      DtVideoStreamCreator();

      virtual ~DtVideoStreamCreator();

   protected:
      virtual DtVideoStream* create( DtDe& de, DtVideoStreamManager& mgr,
         const DtUnicode& className, const DtUnicode& instanceName ) const;
   };
}