src/lib/video_content.h

   1 /*
   2     Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22 #ifndef DCPOMATIC_VIDEO_CONTENT_H
  23 #define DCPOMATIC_VIDEO_CONTENT_H
  24
  25
  26 #include "colour_conversion.h"
  27 #include "content_part.h"
  28 #include "crop.h"
  29 #include "dcpomatic_time.h"
  30 #include "pixel_quanta.h"
  31 #include "user_property.h"
  32 #include "video_frame_type.h"
  33 #include "video_range.h"
  34 #include <dcp/language_tag.h>
  35 #include <boost/thread/mutex.hpp>
  36
  37
  38 class VideoExaminer;
  39 class Ratio;
  40 class Film;
  41 class Content;
  42
  43
  44 class VideoContentProperty
  45 {
  46 public:
  47         static int const USE;
  48         static int const SIZE;
  49         static int const FRAME_TYPE;
  50         static int const CROP;
  51         static int const COLOUR_CONVERSION;
  52         static int const FADE_IN;
  53         static int const FADE_OUT;
  54         static int const RANGE;
  55         static int const CUSTOM_RATIO;
  56         static int const CUSTOM_SIZE;
  57         static int const BURNT_SUBTITLE_LANGUAGE;
  58 };
  59
  60
  61 class VideoContent : public ContentPart, public std::enable_shared_from_this<VideoContent>
  62 {
  63 public:
  64         explicit VideoContent (Content* parent);
  65         VideoContent (Content* parent, cxml::ConstNodePtr node, int version, VideoRange video_range_hint);
  66         VideoContent (Content* parent, std::vector<std::shared_ptr<Content>>);
  67
  68         void as_xml (xmlpp::Node *) const;
  69         std::string technical_summary () const;
  70         std::string identifier () const;
  71         void take_settings_from (std::shared_ptr<const VideoContent> c);
  72
  73         Frame length () const {
  74                 boost::mutex::scoped_lock lm (_mutex);
  75                 return _length;
  76         }
  77
  78         Frame length_after_3d_combine () const {
  79                 boost::mutex::scoped_lock lm (_mutex);
  80                 if (_frame_type == VideoFrameType::THREE_D_ALTERNATE) {
  81                         return _length / 2;
  82                 }
  83
  84                 return _length;
  85         }
  86
  87         dcp::Size size () const {
  88                 boost::mutex::scoped_lock lm (_mutex);
  89                 return _size;
  90         }
  91
  92         void set_frame_type (VideoFrameType);
  93
  94         void set_crop (Crop crop);
  95         void set_left_crop (int);
  96         void set_right_crop (int);
  97         void set_top_crop (int);
  98         void set_bottom_crop (int);
  99
 100         void set_custom_ratio (boost::optional<float> ratio);
 101         void set_custom_size (boost::optional<dcp::Size> size);
 102
 103         void unset_colour_conversion ();
 104         void set_colour_conversion (ColourConversion);
 105
 106         void set_fade_in (Frame);
 107         void set_fade_out (Frame);
 108
 109         void set_range (VideoRange);
 110         void set_use (bool);
 111
 112         void set_burnt_subtitle_language (boost::optional<dcp::LanguageTag> language);
 113
 114         VideoFrameType frame_type () const {
 115                 boost::mutex::scoped_lock lm (_mutex);
 116                 return _frame_type;
 117         }
 118
 119         Crop actual_crop () const;
 120
 121         Crop requested_crop () const {
 122                 boost::mutex::scoped_lock lm (_mutex);
 123                 return _crop;
 124         }
 125
 126         int requested_left_crop () const {
 127                 boost::mutex::scoped_lock lm (_mutex);
 128                 return _crop.left;
 129         }
 130
 131         int requested_right_crop () const {
 132                 boost::mutex::scoped_lock lm (_mutex);
 133                 return _crop.right;
 134         }
 135
 136         int requested_top_crop () const {
 137                 boost::mutex::scoped_lock lm (_mutex);
 138                 return _crop.top;
 139         }
 140
 141         int requested_bottom_crop () const {
 142                 boost::mutex::scoped_lock lm (_mutex);
 143                 return _crop.bottom;
 144         }
 145
 146
 147         boost::optional<float> custom_ratio () const {
 148                 boost::mutex::scoped_lock lm (_mutex);
 149                 return _custom_ratio;
 150         }
 151
 152
 153         boost::optional<dcp::Size> custom_size () const {
 154                 boost::mutex::scoped_lock lm (_mutex);
 155                 return _custom_size;
 156         }
 157
 158
 159         boost::optional<ColourConversion> colour_conversion () const {
 160                 boost::mutex::scoped_lock lm (_mutex);
 161                 return _colour_conversion;
 162         }
 163
 164         boost::optional<double> sample_aspect_ratio () const {
 165                 boost::mutex::scoped_lock lm (_mutex);
 166                 return _sample_aspect_ratio;
 167         }
 168
 169         bool yuv () const {
 170                 boost::mutex::scoped_lock lm (_mutex);
 171                 return _yuv;
 172         }
 173
 174         Frame fade_in () const {
 175                 boost::mutex::scoped_lock lm (_mutex);
 176                 return _fade_in;
 177         }
 178
 179         Frame fade_out () const {
 180                 boost::mutex::scoped_lock lm (_mutex);
 181                 return _fade_out;
 182         }
 183
 184         VideoRange range () const {
 185                 boost::mutex::scoped_lock lm (_mutex);
 186                 return _range;
 187         }
 188
 189         PixelQuanta pixel_quanta () const {
 190                 boost::mutex::scoped_lock lm (_mutex);
 191                 return _pixel_quanta;
 192         }
 193
 194         bool use () const {
 195                 boost::mutex::scoped_lock lm (_mutex);
 196                 return _use;
 197         }
 198
 199         boost::optional<dcp::LanguageTag> burnt_subtitle_language () const {
 200                 boost::mutex::scoped_lock lm (_mutex);
 201                 return _burnt_subtitle_language;
 202         }
 203
 204
 205         /* XXX: names for these? */
 206         dcp::Size size_after_3d_split () const;
 207         dcp::Size size_after_crop () const;
 208         dcp::Size scaled_size (dcp::Size container_size);
 209
 210         boost::optional<double> fade (std::shared_ptr<const Film> film, Frame) const;
 211
 212         std::string processing_description (std::shared_ptr<const Film> film);
 213
 214         void set_length (Frame);
 215
 216         void take_from_examiner(std::shared_ptr<const Film> film, std::shared_ptr<VideoExaminer>);
 217         void add_properties (std::list<UserProperty> &) const;
 218
 219         void modify_position (std::shared_ptr<const Film> film, dcpomatic::DCPTime& pos) const;
 220         void modify_trim_start (dcpomatic::ContentTime& pos) const;
 221
 222         static std::shared_ptr<VideoContent> from_xml (Content* parent, cxml::ConstNodePtr node, int version, VideoRange video_range_hint);
 223
 224 private:
 225
 226         friend struct ffmpeg_pts_offset_test;
 227         friend struct best_dcp_frame_rate_test_single;
 228         friend struct best_dcp_frame_rate_test_double;
 229         friend struct audio_sampling_rate_test;
 230         friend struct scaled_size_test1;
 231         friend struct scaled_size_test2;
 232         friend struct scaled_size_legacy_test;
 233
 234         void setup_default_colour_conversion ();
 235
 236         bool _use;
 237         Frame _length;
 238         boost::optional<ColourConversion> _colour_conversion;
 239         dcp::Size _size;
 240         VideoFrameType _frame_type;
 241         Crop _crop;
 242         /** ratio to scale cropped image to (or none to guess); i.e. if set, scale to _custom_ratio:1 */
 243         boost::optional<float> _custom_ratio;
 244         /** size to scale cropped image to; only used if _custom_ratio is none */
 245         boost::optional<dcp::Size> _custom_size;
 246         /** ratio obtained from an older metadata file; will be used to set up
 247          *  _custom_{ratio,size} (or not, if not required) on the first call to
 248          *  scaled_size()
 249          */
 250         boost::optional<float> _legacy_ratio;
 251         /** Sample aspect ratio obtained from the content file's header, if there is one */
 252         boost::optional<double> _sample_aspect_ratio;
 253         bool _yuv;
 254         /** fade in time in content frames */
 255         Frame _fade_in;
 256         /** fade out time in content frames */
 257         Frame _fade_out;
 258         VideoRange _range;
 259         PixelQuanta _pixel_quanta;
 260         boost::optional<dcp::LanguageTag> _burnt_subtitle_language;
 261 };
 262
 263
 264 #endif