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
  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_SCALE;
  37         static int const COLOUR_CONVERSION;
  38 };
  39
  40 class VideoContentScale
  41 {
  42 public:
  43         VideoContentScale ();
  44         VideoContentScale (Ratio const *);
  45         VideoContentScale (bool);
  46         VideoContentScale (cxml::NodePtr);
  47
  48         dcp::Size size (boost::shared_ptr<const VideoContent>, dcp::Size, dcp::Size) const;
  49         std::string id () const;
  50         std::string name () const;
  51         void as_xml (xmlpp::Node *) const;
  52
  53         Ratio const * ratio () const {
  54                 return _ratio;
  55         }
  56
  57         bool scale () const {
  58                 return _scale;
  59         }
  60
  61         static void setup_scales ();
  62         static std::vector<VideoContentScale> all () {
  63                 return _scales;
  64         }
  65
  66 private:
  67         /** a ratio to stretch the content to, or 0 for no stretch */
  68         Ratio const * _ratio;
  69         /** true if we want to scale the content */
  70         bool _scale;
  71
  72         static std::vector<VideoContentScale> _scales;
  73 };
  74
  75 bool operator== (VideoContentScale const & a, VideoContentScale const & b);
  76 bool operator!= (VideoContentScale const & a, VideoContentScale const & b);
  77
  78 class VideoContent : public virtual Content
  79 {
  80 public:
  81         typedef int Frame;
  82
  83         VideoContent (boost::shared_ptr<const Film>);
  84         VideoContent (boost::shared_ptr<const Film>, DCPTime, ContentTime);
  85         VideoContent (boost::shared_ptr<const Film>, boost::filesystem::path);
  86         VideoContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int);
  87         VideoContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  88
  89         void as_xml (xmlpp::Node *) const;
  90         std::string technical_summary () const;
  91         virtual std::string information () const;
  92         virtual std::string identifier () const;
  93
  94         ContentTime video_length () const {
  95                 boost::mutex::scoped_lock lm (_mutex);
  96                 return _video_length;
  97         }
  98
  99         ContentTime video_length_after_3d_combine () const {
 100                 boost::mutex::scoped_lock lm (_mutex);
 101                 if (_video_frame_type == VIDEO_FRAME_TYPE_3D_ALTERNATE) {
 102                         return ContentTime (_video_length.get() / 2);
 103                 }
 104
 105                 return _video_length;
 106         }
 107
 108         dcp::Size video_size () const {
 109                 boost::mutex::scoped_lock lm (_mutex);
 110                 return _video_size;
 111         }
 112
 113         float video_frame_rate () const {
 114                 boost::mutex::scoped_lock lm (_mutex);
 115                 return _video_frame_rate;
 116         }
 117
 118         void set_video_frame_type (VideoFrameType);
 119         void set_video_frame_rate (float);
 120
 121         void set_left_crop (int);
 122         void set_right_crop (int);
 123         void set_top_crop (int);
 124         void set_bottom_crop (int);
 125
 126         void set_scale (VideoContentScale);
 127         void set_colour_conversion (ColourConversion);
 128
 129         VideoFrameType video_frame_type () const {
 130                 boost::mutex::scoped_lock lm (_mutex);
 131                 return _video_frame_type;
 132         }
 133
 134         Crop crop () const {
 135                 boost::mutex::scoped_lock lm (_mutex);
 136                 return _crop;
 137         }
 138
 139         int left_crop () const {
 140                 boost::mutex::scoped_lock lm (_mutex);
 141                 return _crop.left;
 142         }
 143
 144         int right_crop () const {
 145                 boost::mutex::scoped_lock lm (_mutex);
 146                 return _crop.right;
 147         }
 148
 149         int top_crop () const {
 150                 boost::mutex::scoped_lock lm (_mutex);
 151                 return _crop.top;
 152         }
 153
 154         int bottom_crop () const {
 155                 boost::mutex::scoped_lock lm (_mutex);
 156                 return _crop.bottom;
 157         }
 158
 159         /** @return Description of how to scale this content (if indeed it should be scaled) */
 160         VideoContentScale scale () const {
 161                 boost::mutex::scoped_lock lm (_mutex);
 162                 return _scale;
 163         }
 164
 165         ColourConversion colour_conversion () const {
 166                 boost::mutex::scoped_lock lm (_mutex);
 167                 return _colour_conversion;
 168         }
 169
 170         dcp::Size video_size_after_3d_split () const;
 171         dcp::Size video_size_after_crop () const;
 172
 173         ContentTime dcp_time_to_content_time (DCPTime) const;
 174
 175         void scale_and_crop_to_fit_width ();
 176         void scale_and_crop_to_fit_height ();
 177
 178 protected:
 179         void take_from_video_examiner (boost::shared_ptr<VideoExaminer>);
 180
 181         ContentTime _video_length;
 182         float _video_frame_rate;
 183
 184 private:
 185         friend class ffmpeg_pts_offset_test;
 186         friend class best_dcp_frame_rate_test_single;
 187         friend class best_dcp_frame_rate_test_double;
 188         friend class audio_sampling_rate_test;
 189
 190         void setup_default_colour_conversion ();
 191
 192         dcp::Size _video_size;
 193         VideoFrameType _video_frame_type;
 194         Crop _crop;
 195         VideoContentScale _scale;
 196         ColourConversion _colour_conversion;
 197 };
 198
 199 #endif