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