src/lib/video_examiner.h

   1 /*
   2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/lib/video_examiner.h
  21  *  @brief VideoExaminer class.
  22  */
  23
  24 #include "types.h"
  25 #include "video_content.h"
  26 #include <dcp/types.h>
  27
  28 /** @class VideoExaminer
  29  *  @brief Parent for classes which examine video sources and obtain information about them.
  30  */
  31 class VideoExaminer
  32 {
  33 public:
  34         virtual ~VideoExaminer () {}
  35         virtual boost::optional<double> video_frame_rate () const = 0;
  36         virtual dcp::Size video_size () const = 0;
  37         virtual Frame video_length () const = 0;
  38         virtual boost::optional<double> sample_aspect_ratio () const {
  39                 return boost::optional<double> ();
  40         }
  41 };