Hand-apply 6a3cd511559433554ab40ed72ff94b7d8dc2c5bd from master;

[dcpomatic.git] / src / lib / video_examiner.h

diff --git a/src/lib/video_examiner.h b/src/lib/video_examiner.h
index d4897213beb69634d1b777b955e4d0b9efa9a44b..55b27ac94832f42397b7a96425ee9dd22ba65d94 100644 (file)
--- a/src/lib/video_examiner.h
+++ b/src/lib/video_examiner.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 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
@@ -17,15 +17,25 @@
 
 */
 
+/** @file  src/lib/video_examiner.h
+ *  @brief VideoExaminer class.
+ */
+
 #include <dcp/types.h>
 #include "types.h"
 #include "video_content.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 boost::optional<float> video_frame_rate () const = 0;
        virtual dcp::Size video_size () const = 0;
        virtual ContentTime video_length () const = 0;
+       virtual boost::optional<float> sample_aspect_ratio () const {
+               return boost::optional<float> ();
+       }
 };