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>, DCPTime, VideoFrame);
  47         VideoContent (boost::shared_ptr<const Film>, boost::filesystem::path);
  48         VideoContent (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
  49         VideoContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  50
  51         void as_xml (xmlpp::Node *) const;
  52         std::string technical_summary () const;
  53         virtual std::string information () const;
  54         virtual std::string identifier () const;
  55
  56         VideoFrame video_length () const {
  57                 boost::mutex::scoped_lock lm (_mutex);
  58                 return _video_length;
  59         }
  60
  61         libdcp::Size video_size () const {
  62                 boost::mutex::scoped_lock lm (_mutex);
  63                 return _video_size;
  64         }
  65
  66         float video_frame_rate () const {
  67                 boost::mutex::scoped_lock lm (_mutex);
  68                 return _video_frame_rate;
  69         }
  70
  71         void set_video_frame_type (VideoFrameType);
  72
  73         void set_left_crop (int);
  74         void set_right_crop (int);
  75         void set_top_crop (int);
  76         void set_bottom_crop (int);
  77
  78         void set_colour_conversion (ColourConversion);
  79
  80         VideoFrameType video_frame_type () const {
  81                 boost::mutex::scoped_lock lm (_mutex);
  82                 return _video_frame_type;
  83         }
  84
  85         Crop crop () const {
  86                 boost::mutex::scoped_lock lm (_mutex);
  87                 return _crop;
  88         }
  89
  90         int left_crop () const {
  91                 boost::mutex::scoped_lock lm (_mutex);
  92                 return _crop.left;
  93         }
  94
  95         int right_crop () const {
  96                 boost::mutex::scoped_lock lm (_mutex);
  97                 return _crop.right;
  98         }
  99
 100         int top_crop () const {
 101                 boost::mutex::scoped_lock lm (_mutex);
 102                 return _crop.top;
 103         }
 104
 105         int bottom_crop () const {
 106                 boost::mutex::scoped_lock lm (_mutex);
 107                 return _crop.bottom;
 108         }
 109
 110         void set_ratio (Ratio const *);
 111
 112         /** @return ratio to scale to, or 0 if the content's own ratio should be preserved. */
 113         Ratio const * ratio () const {
 114                 boost::mutex::scoped_lock lm (_mutex);
 115                 return _ratio;
 116         }
 117
 118         ColourConversion colour_conversion () const {
 119                 boost::mutex::scoped_lock lm (_mutex);
 120                 return _colour_conversion;
 121         }
 122
 123         libdcp::Size video_size_after_3d_split () const;
 124         libdcp::Size video_size_after_crop () const;
 125
 126         VideoFrame time_to_content_video_frames (DCPTime) const;
 127
 128 protected:
 129         void take_from_video_examiner (boost::shared_ptr<VideoExaminer>);
 130
 131         VideoFrame _video_length;
 132         float _video_frame_rate;
 133
 134 private:
 135         friend class ffmpeg_pts_offset_test;
 136         friend class best_dcp_frame_rate_test_single;
 137         friend class best_dcp_frame_rate_test_double;
 138         friend class audio_sampling_rate_test;
 139
 140         void setup_default_colour_conversion ();
 141
 142         libdcp::Size _video_size;
 143         VideoFrameType _video_frame_type;
 144         Crop _crop;
 145         Ratio const * _ratio;
 146         ColourConversion _colour_conversion;
 147 };
 148
 149 #endif