lgrRecordInterface.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2025 MAK Technologies, Inc
** All rights reserved.
******************************************************************************/


#ifndef lgrRecordInterface_H_
#define lgrRecordInterface_H_

#include "lgrTimeInterface.h"
#include <lgrUtil/absoluteTime.h>
#include "lgrCheckpointPolicy.h"
#include <vlutil/vlString.h>

namespace MAKLogger
{

   class DtLogger;
   class DtLgrRecordDriver;
   class DtLgrRecordCommandFactory;

   class DT_DLL_LGRCORE DtLgrRecordInterface : public virtual DtLgrTimeInterface
   {

   public:

      enum StopCondition
      {
         StopOnCommandOnly,
         StopOnDuration,
         StopOnSize,
         StopOnDurationOrSize
      };

      typedef DtLgrRecordCommandFactory Factory;

      static DtLgrRecordInterface* create(DtLogger&);

      static DtLgrRecordInterface* createNonThreadsafe(DtLogger& logger,
         const DtLgrRecordDriver& driver);

   protected:

      DtLgrRecordInterface(DtLogger& logger,const DtLgrRecordDriver& driver);


   public:
      virtual ~DtLgrRecordInterface();


      virtual void startNewFile(const DtString& filename, const DtString& description, bool overwrite)  const;

      virtual void recordToMultipleFiles(const DtString& filename, const DtString& description)  const;

      virtual void closeFile()  const;

      virtual void setStopCondition(StopCondition,bool close)  const;

      virtual void setStopDuration(DtRelativeTime duration)  const;

      virtual void setStopSize(DtU64 filesize)  const;

      virtual void setPauseOnRecordAs(bool record) const;

      virtual void record() const;

      virtual void pause() const;

      virtual void unpause() const;

      virtual void stop(bool closeAndOpenForPlayback) const;

      virtual void setCheckpointParameters(DtCheckpointPolicy::Policy policy,
         int size,int count,DtAbsoluteTime time, bool checkpointInteractions) const;

      virtual void cancelRecording() const;

      virtual void saveRecordedData(const DtString& filename, const DtString& description,
         bool onlySinceLastSaveData, double outputDuration) const;

      virtual void setRecordToMultipleFilesSettings(double duration,
         const DtString& namingConvention) const;

      virtual void setMediaStreamConfiguration(const DtString& streamConfiguration) const;

      virtual void setMediaStreamPipeline(const DtString& pipelines);

      virtual void setIsRecordingMediaStream(bool doRecord);

      virtual void setMediaRecordStreamParameters(int port) const;

      virtual void setMediaRecordByDefault(bool enableRecord) const;



      virtual bool isFileLoaded() const;

      virtual bool isFileEmpty() const;

      virtual const DtString& filename() const;

      virtual bool isRecording()  const;

      virtual bool isPaused()  const;

      virtual bool isStopped()  const;

      virtual bool pauseOnRecordAs() const;

      int checkpointPolicyId() const;

      int checkpointCount() const;

      int checkpointSize() const;

      DtAbsoluteTime checkpointTime() const;

      bool interactionsCheckpointed() const;

      double multipleFileDuration() const;

      const DtString& multipleFileNamingConvention() const;

      virtual const DtString& mediaStreamConfiguration() const;

      bool isRecordingMediaStream() const;

      int mediaRecordPort() const;

      bool mediaRecordByDefault() const;

      void newFileOpened(DtResponse);
      void newFileFailed(DtResponse);
      void newFileClosed(DtResponse);
      void recordingChanged(DtResponse);
      void recordingPausedChanged(DtResponse);
      void pauseOnRecordAsChanged(DtResponse);
      void checkpointParametersChanged(DtResponse);
      void fileEmptyChanged(DtResponse);
      void recordToMultipleFilesChanged(DtResponse);
      void mediaRecordFromStreamConfigurationChanged(DtResponse response);
      void mediaRecordStreamParametersChanged(DtResponse response);
      void mediaRecordByDefaultChanged(DtResponse response);
      void recordingMediaStreamChanged(DtResponse response);


      DtValueSignal<DtString> newFileOpenedSignal;
      DtValueSignal<DtString> newFileFailedSignal;
      DtValueSignal<bool> recordingChangedSignal;
      DtValueSignal<bool> recordingPausedChangedSignal;
      DtValueSignal<bool> pauseOnRecordAsChangedSignal;
      DtValueSignal<DtString> mediaStreamConfigurationChangedSignal;
      DtValueSignal<int> mediaRecordPortChangedSignal;
      DtValueSignal<bool> mediaRecordByDefaultChangedSignal;
      DtValueSignal<bool> recordingMediaStreamChangedSignal;

   protected:

      void connectResponseHandler(DtLgrCommandId id,
         void (DtLgrRecordInterface::* function)(DtResponse));

      DtString myNewFileName;
      DtString myErrorMessage;
      bool myRecordingFlag;
      bool myPausedFlag;
      bool myPauseOnRecordAs;
      bool myIsFileLoadedFlag;
      bool myEmptyFlag;
      int myCheckpointPolicy;
      int myCheckpointCount;
      int myCheckpointSize;
      DtAbsoluteTime myCheckpointTime;
      bool myCheckpointInteractions;
      double myMultipleFileDuration;
      DtString myMultipleFileNamingConvention;
      DtString myMediaStreamConfiguration;
      bool myIsRecordingMediaStream;
      int myMediaRecordPort;
      bool myMediaRecordByDefault;

   };

}

#endif