src/lib/video_content.h

   1 /*
   2     Copyright (C) 2013-2014 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 #include "video_content_scale.h"
  26
  27 class VideoExaminer;
  28 class Ratio;
  29
  30 class VideoContentProperty
  31 {
  32 public:
  33         static int const VIDEO_SIZE;
  34         static int const VIDEO_FRAME_RATE;
  35         static int const VIDEO_FRAME_TYPE;
  36         static int const VIDEO_CROP;
  37         static int const VIDEO_SCALE;
  38         static int const COLOUR_CONVERSION;
  39 };
  40
  41 class VideoContent : public virtual Content
  42 {
  43 public:
  44         typedef int Frame;
  45
  46         VideoContent (boost::shared_ptr<const Film>);
  47         VideoContent (boost::shared_ptr<const Film>, Time, VideoContent::Frame);
  48         VideoContent (boost::shared_ptr<const Film>, boost::filesystem::path);
  49         VideoContent (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>, int);
  50         VideoContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  51
  52         void as_xml (xmlpp::Node *) const;
  53         std::string technical_summary () const;
  54         virtual std::string information () const;
  55         virtual std::string identifier () const;
  56
  57         VideoContent::Frame video_length () const {
  58                 boost::mutex::scoped_lock lm (_mutex);
  59                 return _video_length;
  60         }
  61
  62         VideoContent::Frame video_length_after_3d_combine () const {
  63                 boost::mutex::scoped_lock lm (_mutex);
  64                 if (_video_frame_type == VIDEO_FRAME_TYPE_3D_ALTERNATE) {
  65                         return _video_length / 2;
  66                 }
  67
  68                 return _video_length;
  69         }
  70
  71         libdcp::Size video_size () const {
  72                 boost::mutex::scoped_lock lm (_mutex);
  73                 return _video_size;
  74         }
  75
  76         float video_frame_rate () const {
  77                 boost::mutex::scoped_lock lm (_mutex);
  78                 return _video_frame_rate;
  79         }
  80
  81         float original_video_frame_rate () const {
  82                 boost::mutex::scoped_lock lm (_mutex);
  83                 return _original_video_frame_rate;
  84         }
  85
  86         void set_video_frame_type (VideoFrameType);
  87         void set_video_frame_rate (float);
  88
  89         void set_left_crop (int);
  90         void set_right_crop (int);
  91         void set_top_crop (int);
  92         void set_bottom_crop (int);
  93
  94         void set_scale (VideoContentScale);
  95         void unset_colour_conversion ();
  96         void set_colour_conversion (ColourConversion);
  97         void set_default_colour_conversion ();
  98
  99         VideoFrameType video_frame_type () const {
 100                 boost::mutex::scoped_lock lm (_mutex);
 101                 return _video_frame_type;
 102         }
 103
 104         Crop crop () const {
 105                 boost::mutex::scoped_lock lm (_mutex);
 106                 return _crop;
 107         }
 108
 109         int left_crop () const {
 110                 boost::mutex::scoped_lock lm (_mutex);
 111                 return _crop.left;
 112         }
 113
 114         int right_crop () const {
 115                 boost::mutex::scoped_lock lm (_mutex);
 116                 return _crop.right;
 117         }
 118
 119         int top_crop () const {
 120                 boost::mutex::scoped_lock lm (_mutex);
 121                 return _crop.top;
 122         }
 123
 124         int bottom_crop () const {
 125                 boost::mutex::scoped_lock lm (_mutex);
 126                 return _crop.bottom;
 127         }
 128
 129         /** @return Description of how to scale this content (if indeed it should be scaled) */
 130         VideoContentScale scale () const {
 131                 boost::mutex::scoped_lock lm (_mutex);
 132                 return _scale;
 133         }
 134
 135         boost::optional<ColourConversion> colour_conversion () const {
 136                 boost::mutex::scoped_lock lm (_mutex);
 137                 return _colour_conversion;
 138         }
 139
 140         libdcp::Size video_size_after_3d_split () const;
 141         libdcp::Size video_size_after_crop () const;
 142
 143         VideoContent::Frame time_to_content_video_frames (Time) const;
 144
 145         void scale_and_crop_to_fit_width ();
 146         void scale_and_crop_to_fit_height ();
 147
 148 protected:
 149         void take_from_video_examiner (boost::shared_ptr<VideoExaminer>);
 150
 151         VideoContent::Frame _video_length;
 152         float _original_video_frame_rate;
 153         float _video_frame_rate;
 154
 155 private:
 156         friend class ffmpeg_pts_offset_test;
 157         friend class best_dcp_frame_rate_test_single;
 158         friend class best_dcp_frame_rate_test_double;
 159         friend class audio_sampling_rate_test;
 160
 161         libdcp::Size _video_size;
 162         VideoFrameType _video_frame_type;
 163         Crop _crop;
 164         VideoContentScale _scale;
 165         boost::optional<ColourConversion> _colour_conversion;
 166 };
 167
 168 #endif