lgrPlaybackInterface.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
******************************************************************************/


#ifndef lgrPlaybackInterface_H_
#define lgrPlaybackInterface_H_

#include "lgrTimeInterface.h"
#include <lgrUtil/virtualConstructor.h>

#include <vlutil/vlString.h>
#include <lgrUtil/signalSlot.h>

namespace MAKLogger
{
   class DtLogger;
   class DtLgrPlaybackDriver;
   class DtLgrPlaybackCommandFactory;

   enum DtPlayToStreamStatus
   {
      DtPlayToStreamDisabled,
      DtPlayToStreamIdle,
      DtPlayToStreamActive,
      DtPlayToStreamFailed
   };

   class DT_DLL_LGRCORE DtLgrPlaybackInterface : public virtual DtLgrTimeInterface
   {
   public:

      //Used to shorten code.
      typedef DtLgrPlaybackCommandFactory Factory;

      //Used to shorten code.
      typedef DtLgrPlaybackInterface ThisClass;

      static DtLgrPlaybackInterface* create(DtLogger&);

      static DtLgrPlaybackInterface* createNonThreadsafe(DtLogger& logger,
         const DtLgrPlaybackDriver& driver);

   protected:

      DtLgrPlaybackInterface(DtLogger& logger,const DtLgrPlaybackDriver& driver);

   public:

      virtual ~DtLgrPlaybackInterface();

   private:

      DtLgrPlaybackInterface(const DtLgrPlaybackInterface&);
      DtLgrPlaybackInterface& operator=(const DtLgrPlaybackInterface&);

   public:


      virtual void openFile(const DtString& filename, bool checkMediaFile) const;

      virtual void closeFile() const;

      virtual void saveFile(const bool reopenAfterSave = true) const;

      virtual void saveFileAs(const DtString& filename, const DtString& description,
         const bool writeDescription, const bool reopenAfterSave = true) const;

      virtual void revertFile() const;

      virtual void updateTapeDescription(const DtString description);

      virtual void play() const;

      virtual void stop() const;

      virtual void pause() const;

      virtual void unpause() const;

      virtual void togglePlayPause() const;

      virtual void restart() const;

      virtual void jumpToTime(DtAbsoluteTime time) const;

      virtual void setPlaybackSpeed(double speedMultiplier, bool skipping) const;

      virtual void setSkippingPlaybackThreshold(double skippingThreshold) const;

      virtual void setSkippingPlaybackInteractions(bool skippingInteractions) const;

      virtual void setPacketViewInterval(double viewInterval) const;

      virtual void setFollowingInterval(double interval) const;

      virtual void setFollowingExportInterval(double interval) const;

      virtual void setStartStopTimes(DtAbsoluteTime startTime,
         DtAbsoluteTime stopTime) const;

      virtual void setLoopAtEnd(bool enable) const;

      virtual void setPlayOnLoad(bool playOnLoad) const;

      virtual void setBackupOnSave(bool backup) const;

      virtual void recoverLastPacket();

      virtual void setMediaPlaybackAdjustments(double speedFactor, DtRelativeTime offset) const;

      virtual void setMediaWindowHandle(void* windowHandle);

      virtual void setMediaStreamConfiguration(const DtString& streamConfiguration) const;

      virtual void setMediaWindowConfiguration(const DtString& streamConfiguration) const;

      virtual void setMediaStreamPipeline(const DtString& pipelines,
         const DtString& mediaFile);

      virtual void setMediaWindowPipeline(const DtString& pipelines,
         const DtString& mediaFile);

      virtual void setMediaPlayByDefault(bool window, bool stream) const;

      virtual void setMediaPlayToStreamParameters(const DtString&, int) const;

      virtual void exposePlaybackMedia();




      virtual bool isFileLoaded() const;

      virtual bool isFileSaved() const;

      virtual bool isPlaying() const;

      virtual bool isStopped() const;

      virtual bool isPaused() const;

      virtual bool loopAtEnd() const;

      virtual bool playOnLoad() const;

      virtual const DtString& filename() const;

      virtual double playbackSpeed() const;

      virtual bool skippingPlayback() const;

      virtual double skippingPlaybackThreshold() const;

      virtual bool skippingPlaybackInteractions() const;

      virtual double packetViewInterval() const;

      virtual double followingInterval() const;

      virtual double followingExportInterval() const;

      virtual bool isFileFormatCurrent() const;

      virtual bool isFileIncomplete() const;

      virtual bool hasLastPacket() const;

      virtual bool lastPacketRecovered() const;

      virtual bool tapeDescriptionUpdated() const;

      virtual const DtString& tapeDescription() const;

      virtual int fileVersion() const;

      virtual bool isFileExpanding() const;

      virtual double mediaSpeedFactor() const;

      virtual DtRelativeTime mediaOffset() const;

      virtual const DtString& mediaStreamConfiguration() const;

      virtual const DtString& mediaWindowConfiguration() const;

      virtual bool mediaPlayInWindowByDefault() const;

      virtual bool mediaPlayToStreamByDefault() const;

      virtual bool mediaPlayInWindowActive() const;

      virtual DtPlayToStreamStatus mediaPlayToStreamStatus() const;

      virtual const DtString& mediaPlayHost() const;

      virtual int mediaPlayPort() const;



      DtValueSignal<DtString> fileOpenedSignal;
      DtValueSignal<bool> playbackChangedSignal;
      DtValueSignal<bool> pausedChangedSignal;
      DtValueSignal<double> playbackSpeedChangedSignal;
      DtValueSignal<bool> loopAtEndChangedSignal;
      DtValueSignal<bool> playOnLoadChangedSignal;
      DtValueSignal<bool> fileSaveChangedSignal;
      DtValueSignal<bool> fileExpandingSignal;
      DtValueSignal<DtAbsoluteTime> jumpTimeChangedSignal;
      DtValueSignal<double> followIntervalChangedSignal;
      DtValueSignal<double> followExportIntervalChangedSignal;
      DtValueSignal<double> mediaSpeedFactorChangedSignal;
      DtValueSignal<DtRelativeTime> mediaOffsetChangedSignal;
      DtValueSignal<DtString> mediaStreamConfigurationChangedSignal;
      DtValueSignal<DtString> mediaWindowConfigurationChangedSignal;
      DtValueSignal<bool> mediaPlayInWindowByDefaultChangedSignal;
      DtValueSignal<bool> mediaPlayToStreamByDefaultChangedSignal;
      DtValueSignal<DtString> mediaPlayHostChangedSignal;
      DtValueSignal<int> mediaPlayPortChangedSignal;
      DtValueSignal<bool> mediaPlayInWindowOperationSignal;
      DtValueSignal<DtPlayToStreamStatus> mediaPlayToStreamOperationSignal;

      DtValueSignal<DtString> fileInvalidSignal;
      DtValueSignal<DtString> fileDoesNotExistSignal;

   protected:


      void fileOpened(DtResponse);

      void fileClosed(DtResponse);

      void fileChanged(DtResponse);

      void fileSaved(DtResponse);

      void playbackChanged(DtResponse);

      void playbackSpeedChanged(DtResponse);

      void skippingPlaybackChanged(DtResponse);

      void skippingPlaybackThresholdChanged(DtResponse);

      void skippingPlaybackInteractionsChanged(DtResponse);

      void packetViewIntervalChanged(DtResponse);

      void followingIntervalChanged(DtResponse);

      void followingExportIntervalChanged(DtResponse);

      void fileInvalid(DtResponse);

      void fileDoesNotExist(DtResponse);

      void fileIncomplete(DtResponse);

      void loopAtEndChanged(DtResponse);

      void playOnLoadChanged(DtResponse);

      void fileFormatCurrent(DtResponse);

      void pausedChanged(DtResponse);

      void tapeDescriptionChanged(DtResponse);

      void fileExpandingChanged(DtResponse);

      void jumpTimeChanged(DtResponse response);

      void mediaPlaybackAdjustmentsChanged(DtResponse response);

      void mediaPlayToStreamConfigurationChanged(DtResponse response);

      void mediaPlayInWindowConfigurationChanged(DtResponse response);

      void mediaPlayByDefaultChanged(DtResponse response);

      void mediaPlayToStreamParametersChanged(DtResponse response);

      void mediaPlayInWindowOperationActive(DtResponse response);

      void mediaPlayToStreamOperationStatus(DtResponse response);


      void connectResponseHandlers();

      void connectResponse(DtLgrCommandId,
         void (DtLgrPlaybackInterface::*)(DtResponse));

   protected:

      bool myFileLoadedFlag;
      bool myPlayingFlag;
      bool myLoopAtEnd;
      bool myPlayOnLoadFlag;
      bool myFileSavedFlag;
      bool myFileFormatCurrentFlag;
      bool myPausedFlag;
      bool myFileIncompleteFlag;
      bool myHasLastPacketFlag;
      bool myLastPacketRecovered;
      bool mySkippingPlayback;
      bool mySkippingPlaybackInteractions;
      bool myTapeDescriptionUpdated;
      bool myFileExpanding;
      bool myMediaWindowOperationFlag;
      DtPlayToStreamStatus myMediaStreamOperationStatus;
      int myFileVersion;
      double myPlaybackSpeed;
      double mySkippingPlaybackThreshold;
      double myPacketViewInterval;
      double myFollowingInterval;
      double myFollowingExportInterval;
      DtString myFilename;
      DtString myLastErrorMessage;
      DtString myTapeDescription;
      DtAbsoluteTime myJumpTime;
      double myMediaSpeedFactor;
      DtRelativeTime myMediaOffset;
      DtString myMediaStreamConfiguration;
      DtString myMediaWindowConfiguration;
      bool myMediaPlayInWindowByDefault;
      bool myMediaPlayToStreamByDefault;
      DtString myMediaPlayHost;
      int myMediaPlayPort;

   };

}

#endif