Logging improvements to allow prettier displays in the server GUI.
[dcpomatic.git] / src / lib / video_examiner.h
index 98c0cdff1433d21e0ad0106c994bf06762f6ffd8..66d3ae5b57ea2b056a9678ac737b660de38ee0c9 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#include <libdcp/types.h>
+/** @file  src/lib/video_examiner.h
+ *  @brief VideoExaminer class.
+ */
+
 #include "types.h"
 #include "video_content.h"
+#include <dcp/types.h>
 
+/** @class VideoExaminer
+ *  @brief Parent for classes which examine video sources and obtain information about them.
+ */
 class VideoExaminer
 {
 public:
        virtual ~VideoExaminer () {}
-       virtual float video_frame_rate () const = 0;
-       virtual libdcp::Size video_size () const = 0;
-       virtual VideoFrame video_length () const = 0;
+       virtual boost::optional<double> video_frame_rate () const = 0;
+       virtual dcp::Size video_size () const = 0;
+       virtual Frame video_length () const = 0;
+       virtual boost::optional<double> sample_aspect_ratio () const {
+               return boost::optional<double> ();
+       }
 };