/*
- Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
- This program is free software; you can redistribute it and/or modify
+ This file is part of DCP-o-matic.
+
+ DCP-o-matic is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
- This program is distributed in the hope that it will be useful,
+ DCP-o-matic is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
*/
-#include <libdcp/types.h>
+
+/** @file src/lib/video_examiner.h
+ * @brief VideoExaminer class.
+ */
+
+
+#include "pixel_quanta.h"
#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 bool has_video () const = 0;
+
+ /** @return video frame rate (if known); must not be called if has_video() == false */
+ virtual boost::optional<double> video_frame_rate () const = 0;
+ /** @return video size; must not be called if has_video() == false */
+ virtual dcp::Size video_size () const = 0;
+ /** @return video length in frames; must not be called if has_video() == false */
+ virtual Frame video_length () const = 0;
+ /** @return video sample aspect ratio (if known); must not be called if has_video() == false */
+ virtual boost::optional<double> sample_aspect_ratio () const {
+ return boost::optional<double> ();
+ }
+ /** @return true if this video is in YUV; must not be called if has_video() == false */
+ virtual bool yuv () const = 0;
+ virtual VideoRange range () const = 0;
+ virtual PixelQuanta pixel_quanta () const = 0;
};