MAK Data Logger API Documentation for HLA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
lgrPlaybackInterface.h
Go to the documentation of this file.
1 /******************************************************************************
2 ** Copyright (c) 1992-2010 VT MAK
3 ** All rights reserved.
4 ******************************************************************************/
5 
8 
9 #ifndef lgrPlaybackInterface_H_
10 #define lgrPlaybackInterface_H_
11 
12 #include "lgrTimeInterface.h"
13 #include <lgrUtil/virtualConstructor.h>
14 
15 #include <vlutil/vlString.h>
16 #include <lgrUtil/signalSlot.h>
17 
18 namespace MAKLogger
19 {
20  class DtLogger;
21  class DtLgrPlaybackDriver;
22  class DtLgrPlaybackCommandFactory;
23 
24  enum DtPlayToStreamStatus
25  {
26  DtPlayToStreamDisabled,
27  DtPlayToStreamIdle,
28  DtPlayToStreamActive,
29  DtPlayToStreamFailed
30  };
31 
35  class DT_DLL_LGRCORE DtLgrPlaybackInterface : public virtual DtLgrTimeInterface
36  {
37  public:
38 
39  //Used to shorten code.
40  typedef DtLgrPlaybackCommandFactory Factory;
41 
42  //Used to shorten code.
43  typedef DtLgrPlaybackInterface ThisClass;
44 
46  static DtLgrPlaybackInterface* create(DtLogger&);
47 
50  static DtLgrPlaybackInterface* createNonThreadsafe(DtLogger& logger,
51  const DtLgrPlaybackDriver& driver);
52 
53  protected:
54 
56  DtLgrPlaybackInterface(DtLogger& logger,const DtLgrPlaybackDriver& driver);
57 
58  public:
59 
61  virtual ~DtLgrPlaybackInterface();
62 
63  private:
64 
66  DtLgrPlaybackInterface(const DtLgrPlaybackInterface&);
68  DtLgrPlaybackInterface& operator=(const DtLgrPlaybackInterface&);
69 
70  public:
71 
73 
74 
76  virtual void openFile(const DtString& filename, bool checkMediaFile) const;
77 
79  virtual void closeFile() const;
80 
82  virtual void saveFile(const bool reopenAfterSave = true) const;
83 
86  virtual void saveFileAs(const DtString& filename, const DtString& description,
87  const bool writeDescription, const bool reopenAfterSave = true) const;
88 
90  virtual void revertFile() const;
91 
95  virtual void updateTapeDescription(const DtString description);
96 
98  virtual void play() const;
99 
101  virtual void stop() const;
102 
104  virtual void pause() const;
105 
107  virtual void unpause() const;
108 
110  virtual void togglePlayPause() const;
111 
113  virtual void restart() const;
114 
116  virtual void jumpToTime(DtAbsoluteTime time) const;
117 
120  virtual void setPlaybackSpeed(double speedMultiplier, bool skipping) const;
121 
124  virtual void setSkippingPlaybackThreshold(double skippingThreshold) const;
125 
127  virtual void setSkippingPlaybackInteractions(bool skippingInteractions) const;
128 
130  virtual void setPacketViewInterval(double viewInterval) const;
131 
133  virtual void setFollowingInterval(double interval) const;
134 
136  virtual void setFollowingExportInterval(double interval) const;
137 
139  virtual void setStartStopTimes(DtAbsoluteTime startTime,
140  DtAbsoluteTime stopTime) const;
141 
143  virtual void setLoopAtEnd(bool enable) const;
144 
146  virtual void setPlayOnLoad(bool playOnLoad) const;
147 
149  virtual void setBackupOnSave(bool backup) const;
150 
152  virtual void recoverLastPacket();
153 
155  virtual void setMediaPlaybackAdjustments(double speedFactor, DtRelativeTime offset) const;
156 
158  virtual void setMediaWindowHandle(void* windowHandle);
159 
161  virtual void setMediaStreamConfiguration(const DtString& streamConfiguration) const;
162 
164  virtual void setMediaWindowConfiguration(const DtString& streamConfiguration) const;
165 
167  virtual void setMediaStreamPipeline(const DtString& pipelines,
168  const DtString& mediaFile);
169 
171  virtual void setMediaWindowPipeline(const DtString& pipelines,
172  const DtString& mediaFile);
173 
175  virtual void setMediaPlayByDefault(bool window, bool stream) const;
176 
178  virtual void setMediaPlayToStreamParameters(const DtString&, int) const;
179 
181  virtual void exposePlaybackMedia();
182 
184 
185 
187 
188 
190  virtual bool isFileLoaded() const;
191 
193  virtual bool isFileSaved() const;
194 
196  virtual bool isPlaying() const;
197 
199  virtual bool isStopped() const;
200 
202  virtual bool isPaused() const;
203 
205  virtual bool loopAtEnd() const;
206 
208  virtual bool playOnLoad() const;
209 
211  virtual const DtString& filename() const;
212 
214  virtual double playbackSpeed() const;
215 
217  virtual bool skippingPlayback() const;
218 
220  virtual double skippingPlaybackThreshold() const;
221 
223  virtual bool skippingPlaybackInteractions() const;
224 
226  virtual double packetViewInterval() const;
227 
229  virtual double followingInterval() const;
230 
232  virtual double followingExportInterval() const;
233 
235  virtual bool isFileFormatCurrent() const;
236 
238  virtual bool isFileIncomplete() const;
239 
241  virtual bool hasLastPacket() const;
242 
244  virtual bool lastPacketRecovered() const;
245 
248  virtual bool tapeDescriptionUpdated() const;
249 
251  virtual const DtString& tapeDescription() const;
252 
254  virtual int fileVersion() const;
255 
257  virtual bool isFileExpanding() const;
258 
260  virtual double mediaSpeedFactor() const;
261 
263  virtual DtRelativeTime mediaOffset() const;
264 
266  virtual const DtString& mediaStreamConfiguration() const;
267 
269  virtual const DtString& mediaWindowConfiguration() const;
270 
272  virtual bool mediaPlayInWindowByDefault() const;
273 
275  virtual bool mediaPlayToStreamByDefault() const;
276 
278  virtual bool mediaPlayInWindowActive() const;
279 
281  virtual DtPlayToStreamStatus mediaPlayToStreamStatus() const;
282 
284  virtual const DtString& mediaPlayHost() const;
285 
287  virtual int mediaPlayPort() const;
288 
290 
291 
293 
294  DtValueSignal<DtString> fileOpenedSignal;
295  DtValueSignal<bool> playbackChangedSignal;
296  DtValueSignal<bool> pausedChangedSignal;
297  DtValueSignal<double> playbackSpeedChangedSignal;
298  DtValueSignal<bool> loopAtEndChangedSignal;
299  DtValueSignal<bool> playOnLoadChangedSignal;
300  DtValueSignal<bool> fileSaveChangedSignal;
301  DtValueSignal<bool> fileExpandingSignal;
302  DtValueSignal<DtAbsoluteTime> jumpTimeChangedSignal;
303  DtValueSignal<double> followIntervalChangedSignal;
304  DtValueSignal<double> followExportIntervalChangedSignal;
305  DtValueSignal<double> mediaSpeedFactorChangedSignal;
306  DtValueSignal<DtRelativeTime> mediaOffsetChangedSignal;
307  DtValueSignal<DtString> mediaStreamConfigurationChangedSignal;
308  DtValueSignal<DtString> mediaWindowConfigurationChangedSignal;
309  DtValueSignal<bool> mediaPlayInWindowByDefaultChangedSignal;
310  DtValueSignal<bool> mediaPlayToStreamByDefaultChangedSignal;
311  DtValueSignal<DtString> mediaPlayHostChangedSignal;
312  DtValueSignal<int> mediaPlayPortChangedSignal;
313  DtValueSignal<bool> mediaPlayInWindowOperationSignal;
314  DtValueSignal<DtPlayToStreamStatus> mediaPlayToStreamOperationSignal;
315 
317  DtValueSignal<DtString> fileInvalidSignal;
318  DtValueSignal<DtString> fileDoesNotExistSignal;
320 
321  protected:
322 
324 
325 
327  void fileOpened(DtResponse);
328 
330  void fileClosed(DtResponse);
331 
333  void fileChanged(DtResponse);
334 
336  void fileSaved(DtResponse);
337 
339  void playbackChanged(DtResponse);
340 
342  void playbackSpeedChanged(DtResponse);
343 
345  void skippingPlaybackChanged(DtResponse);
346 
348  void skippingPlaybackThresholdChanged(DtResponse);
349 
351  void skippingPlaybackInteractionsChanged(DtResponse);
352 
354  void packetViewIntervalChanged(DtResponse);
355 
357  void followingIntervalChanged(DtResponse);
358 
360  void followingExportIntervalChanged(DtResponse);
361 
363  void fileInvalid(DtResponse);
364 
366  void fileDoesNotExist(DtResponse);
367 
369  void fileIncomplete(DtResponse);
370 
372  void loopAtEndChanged(DtResponse);
373 
375  void playOnLoadChanged(DtResponse);
376 
378  void fileFormatCurrent(DtResponse);
379 
381  void pausedChanged(DtResponse);
382 
384  void tapeDescriptionChanged(DtResponse);
385 
387  void fileExpandingChanged(DtResponse);
388 
390  void jumpTimeChanged(DtResponse response);
391 
393  void mediaPlaybackAdjustmentsChanged(DtResponse response);
394 
396  void mediaPlayToStreamConfigurationChanged(DtResponse response);
397 
399  void mediaPlayInWindowConfigurationChanged(DtResponse response);
400 
402  void mediaPlayByDefaultChanged(DtResponse response);
403 
405  void mediaPlayToStreamParametersChanged(DtResponse response);
406 
408  void mediaPlayInWindowOperationActive(DtResponse response);
409 
411  void mediaPlayToStreamOperationStatus(DtResponse response);
412 
414 
416  void connectResponseHandlers();
417 
419  void connectResponse(DtLgrCommandId,
420  void (DtLgrPlaybackInterface::*)(DtResponse));
421 
422  protected:
423 
424  bool myFileLoadedFlag;
425  bool myPlayingFlag;
426  bool myLoopAtEnd;
427  bool myPlayOnLoadFlag;
428  bool myFileSavedFlag;
429  bool myFileFormatCurrentFlag;
430  bool myPausedFlag;
431  bool myFileIncompleteFlag;
432  bool myHasLastPacketFlag;
433  bool myLastPacketRecovered;
434  bool mySkippingPlayback;
435  bool mySkippingPlaybackInteractions;
436  bool myTapeDescriptionUpdated;
437  bool myFileExpanding;
438  bool myMediaWindowOperationFlag;
439  DtPlayToStreamStatus myMediaStreamOperationStatus;
440  int myFileVersion;
441  double myPlaybackSpeed;
442  double mySkippingPlaybackThreshold;
443  double myPacketViewInterval;
444  double myFollowingInterval;
445  double myFollowingExportInterval;
446  DtString myFilename;
447  DtString myLastErrorMessage;
448  DtString myTapeDescription;
449  DtAbsoluteTime myJumpTime;
450  double myMediaSpeedFactor;
451  DtRelativeTime myMediaOffset;
452  DtString myMediaStreamConfiguration;
453  DtString myMediaWindowConfiguration;
454  bool myMediaPlayInWindowByDefault;
455  bool myMediaPlayToStreamByDefault;
456  DtString myMediaPlayHost;
457  int myMediaPlayPort;
458 
459  };
460 
461 }
462 
463 #endif
Document ID: Generated on Wed Jun 5 18:45:18 EDT 2019 from SVN revision 198968
Copyright © 2019 VT MAK. All Rights Reserved (www.mak.com)