src/lib/video_content.h

   1 /*
   2     Copyright (C) 2013 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 #ifndef DCPOMATIC_VIDEO_CONTENT_H
  21 #define DCPOMATIC_VIDEO_CONTENT_H
  22
  23 #include "content.h"
  24 #include "colour_conversion.h"
  25
  26 class VideoExaminer;
  27 class Ratio;
  28
  29 class VideoContentProperty
  30 {
  31 public:
  32         static int const VIDEO_SIZE;
  33         static int const VIDEO_FRAME_RATE;
  34         static int const VIDEO_FRAME_TYPE;
  35         static int const VIDEO_CROP;
  36         static int const VIDEO_RATIO;
  37         static int const COLOUR_CONVERSION;
  38 };
  39
  40 class VideoContent : public virtual Content
  41 {
  42 public:
  43         typedef int Frame;
  44
  45         VideoContent (boost::shared_ptr<const Film>);
  46         VideoContent (boost::shared_ptr<const Film>, Time, VideoContent::Frame);
  47         VideoContent (boost::shared_ptr<const Film>, boost::filesystem::path);
  48         VideoContent (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
  49
  50         void as_xml (xmlpp::Node *) const;
  51         std::string technical_summary () const;
  52         virtual std::string information () const;
  53         virtual std::string identifier () const;
  54
  55         VideoContent::Frame video_length () const {
  56                 boost::mutex::scoped_lock lm (_mutex);
  57                 return _video_length;
  58         }
  59
  60         libdcp::Size video_size () const {
  61                 boost::mutex::scoped_lock lm (_mutex);
  62                 return _video_size;
  63         }
  64
  65         float video_frame_rate () const {
  66                 boost::mutex::scoped_lock lm (_mutex);
  67                 return _video_frame_rate;
  68         }
  69
  70         void set_video_frame_type (VideoFrameType);
  71
  72         void set_left_crop (int);
  73         void set_right_crop (int);
  74         void set_top_crop (int);
  75         void set_bottom_crop (int);
  76
  77         void set_colour_conversion (ColourConversion);
  78
  79         VideoFrameType video_frame_type () const {
  80                 boost::mutex::scoped_lock lm (_mutex);
  81                 return _video_frame_type;
  82         }
  83
  84         Crop crop () const {
  85                 boost::mutex::scoped_lock lm (_mutex);
  86                 return _crop;
  87         }
  88
  89         int left_crop () const {
  90                 boost::mutex::scoped_lock lm (_mutex);
  91                 return _crop.left;
  92         }
  93
  94         int right_crop () const {
  95                 boost::mutex::scoped_lock lm (_mutex);
  96                 return _crop.right;
  97         }
  98
  99         int top_crop () const {
 100                 boost::mutex::scoped_lock lm (_mutex);
 101                 return _crop.top;
 102         }
 103
 104         int bottom_crop () const {
 105                 boost::mutex::scoped_lock lm (_mutex);
 106                 return _crop.bottom;
 107         }
 108
 109         void set_ratio (Ratio const *);
 110
 111         /** @return ratio to scale to, or 0 if the content's own ratio should be preserved. */
 112         Ratio const * ratio () const {
 113                 boost::mutex::scoped_lock lm (_mutex);
 114                 return _ratio;
 115         }
 116
 117         ColourConversion colour_conversion () const {
 118                 boost::mutex::scoped_lock lm (_mutex);
 119                 return _colour_conversion;
 120         }
 121
 122         libdcp::Size video_size_after_3d_split () const;
 123         libdcp::Size video_size_after_crop () const;
 124
 125         VideoContent::Frame time_to_content_video_frames (Time) const;
 126
 127 protected:
 128         void take_from_video_examiner (boost::shared_ptr<VideoExaminer>);
 129
 130         VideoContent::Frame _video_length;
 131
 132 private:
 133         friend class ffmpeg_pts_offset_test;
 134         friend class best_dcp_frame_rate_test_single;
 135         friend class best_dcp_frame_rate_test_double;
 136         friend class audio_sampling_rate_test;
 137
 138         void setup_default_colour_conversion ();
 139
 140         libdcp::Size _video_size;
 141         float _video_frame_rate;
 142         VideoFrameType _video_frame_type;
 143         Crop _crop;
 144         Ratio const * _ratio;
 145         ColourConversion _colour_conversion;
 146 };
 147
 148 #endif