src/lib/video_content.cc

   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 #include <iomanip>
  21 #include <libcxml/cxml.h>
  22 #include <libdcp/colour_matrix.h>
  23 #include "video_content.h"
  24 #include "video_examiner.h"
  25 #include "ratio.h"
  26 #include "compose.hpp"
  27 #include "config.h"
  28 #include "colour_conversion.h"
  29
  30 #include "i18n.h"
  31
  32 int const VideoContentProperty::VIDEO_SIZE        = 0;
  33 int const VideoContentProperty::VIDEO_FRAME_RATE  = 1;
  34 int const VideoContentProperty::VIDEO_FRAME_TYPE  = 2;
  35 int const VideoContentProperty::VIDEO_CROP        = 3;
  36 int const VideoContentProperty::VIDEO_RATIO       = 4;
  37 int const VideoContentProperty::COLOUR_CONVERSION = 5;
  38
  39 using std::string;
  40 using std::stringstream;
  41 using std::setprecision;
  42 using std::cout;
  43 using boost::shared_ptr;
  44 using boost::lexical_cast;
  45 using boost::optional;
  46
  47 VideoContent::VideoContent (shared_ptr<const Film> f, Time s, VideoContent::Frame len)
  48         : Content (f, s)
  49         , _video_length (len)
  50         , _video_frame_rate (0)
  51         , _video_frame_type (VIDEO_FRAME_TYPE_2D)
  52         , _ratio (Ratio::from_id ("185"))
  53 {
  54         setup_default_colour_conversion ();
  55 }
  56
  57 VideoContent::VideoContent (shared_ptr<const Film> f, boost::filesystem::path p)
  58         : Content (f, p)
  59         , _video_length (0)
  60         , _video_frame_rate (0)
  61         , _video_frame_type (VIDEO_FRAME_TYPE_2D)
  62         , _ratio (Ratio::from_id ("185"))
  63 {
  64         setup_default_colour_conversion ();
  65 }
  66
  67 VideoContent::VideoContent (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node)
  68         : Content (f, node)
  69         , _ratio (0)
  70 {
  71         _video_length = node->number_child<VideoContent::Frame> ("VideoLength");
  72         _video_size.width = node->number_child<int> ("VideoWidth");
  73         _video_size.height = node->number_child<int> ("VideoHeight");
  74         _video_frame_rate = node->number_child<float> ("VideoFrameRate");
  75         _video_frame_type = static_cast<VideoFrameType> (node->number_child<int> ("VideoFrameType"));
  76         _crop.left = node->number_child<int> ("LeftCrop");
  77         _crop.right = node->number_child<int> ("RightCrop");
  78         _crop.top = node->number_child<int> ("TopCrop");
  79         _crop.bottom = node->number_child<int> ("BottomCrop");
  80         optional<string> r = node->optional_string_child ("Ratio");
  81         if (r) {
  82                 _ratio = Ratio::from_id (r.get ());
  83         }
  84         _colour_conversion = ColourConversion (node->node_child ("ColourConversion"));
  85 }
  86
  87 void
  88 VideoContent::as_xml (xmlpp::Node* node) const
  89 {
  90         boost::mutex::scoped_lock lm (_mutex);
  91         node->add_child("VideoLength")->add_child_text (lexical_cast<string> (_video_length));
  92         node->add_child("VideoWidth")->add_child_text (lexical_cast<string> (_video_size.width));
  93         node->add_child("VideoHeight")->add_child_text (lexical_cast<string> (_video_size.height));
  94         node->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
  95         node->add_child("VideoFrameType")->add_child_text (lexical_cast<string> (static_cast<int> (_video_frame_type)));
  96         node->add_child("LeftCrop")->add_child_text (boost::lexical_cast<string> (_crop.left));
  97         node->add_child("RightCrop")->add_child_text (boost::lexical_cast<string> (_crop.right));
  98         node->add_child("TopCrop")->add_child_text (boost::lexical_cast<string> (_crop.top));
  99         node->add_child("BottomCrop")->add_child_text (boost::lexical_cast<string> (_crop.bottom));
 100         if (_ratio) {
 101                 node->add_child("Ratio")->add_child_text (_ratio->id ());
 102         }
 103         _colour_conversion.as_xml (node->add_child("ColourConversion"));
 104 }
 105
 106 void
 107 VideoContent::setup_default_colour_conversion ()
 108 {
 109         _colour_conversion = PresetColourConversion (_("sRGB"), 2.4, true, libdcp::colour_matrix::srgb_to_xyz, 2.6).conversion;
 110 }
 111
 112 void
 113 VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> d)
 114 {
 115         /* These examiner calls could call other content methods which take a lock on the mutex */
 116         libdcp::Size const vs = d->video_size ();
 117         float const vfr = d->video_frame_rate ();
 118
 119         {
 120                 boost::mutex::scoped_lock lm (_mutex);
 121                 _video_size = vs;
 122                 _video_frame_rate = vfr;
 123         }
 124
 125         signal_changed (VideoContentProperty::VIDEO_SIZE);
 126         signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
 127 }
 128
 129
 130 string
 131 VideoContent::information () const
 132 {
 133         if (video_size().width == 0 || video_size().height == 0) {
 134                 return "";
 135         }
 136
 137         stringstream s;
 138
 139         s << String::compose (
 140                 _("%1x%2 pixels (%3:1)"),
 141                 video_size().width,
 142                 video_size().height,
 143                 setprecision (3), video_size().ratio ()
 144                 );
 145
 146         return s.str ();
 147 }
 148
 149 void
 150 VideoContent::set_left_crop (int c)
 151 {
 152         {
 153                 boost::mutex::scoped_lock lm (_mutex);
 154
 155                 if (_crop.left == c) {
 156                         return;
 157                 }
 158
 159                 _crop.left = c;
 160         }
 161
 162         signal_changed (VideoContentProperty::VIDEO_CROP);
 163 }
 164
 165 void
 166 VideoContent::set_right_crop (int c)
 167 {
 168         {
 169                 boost::mutex::scoped_lock lm (_mutex);
 170                 if (_crop.right == c) {
 171                         return;
 172                 }
 173
 174                 _crop.right = c;
 175         }
 176
 177         signal_changed (VideoContentProperty::VIDEO_CROP);
 178 }
 179
 180 void
 181 VideoContent::set_top_crop (int c)
 182 {
 183         {
 184                 boost::mutex::scoped_lock lm (_mutex);
 185                 if (_crop.top == c) {
 186                         return;
 187                 }
 188
 189                 _crop.top = c;
 190         }
 191
 192         signal_changed (VideoContentProperty::VIDEO_CROP);
 193 }
 194
 195 void
 196 VideoContent::set_bottom_crop (int c)
 197 {
 198         {
 199                 boost::mutex::scoped_lock lm (_mutex);
 200                 if (_crop.bottom == c) {
 201                         return;
 202                 }
 203
 204                 _crop.bottom = c;
 205         }
 206
 207         signal_changed (VideoContentProperty::VIDEO_CROP);
 208 }
 209
 210 void
 211 VideoContent::set_ratio (Ratio const * r)
 212 {
 213         {
 214                 boost::mutex::scoped_lock lm (_mutex);
 215                 if (_ratio == r) {
 216                         return;
 217                 }
 218
 219                 _ratio = r;
 220         }
 221
 222         signal_changed (VideoContentProperty::VIDEO_RATIO);
 223 }
 224
 225 /** @return string which includes everything about how this content looks */
 226 string
 227 VideoContent::identifier () const
 228 {
 229         stringstream s;
 230         s << Content::identifier()
 231           << "_" << crop().left
 232           << "_" << crop().right
 233           << "_" << crop().top
 234           << "_" << crop().bottom
 235           << "_" << colour_conversion().identifier ();
 236
 237         if (ratio()) {
 238                 s << "_" << ratio()->id ();
 239         }
 240
 241         return s.str ();
 242 }
 243
 244 void
 245 VideoContent::set_video_frame_type (VideoFrameType t)
 246 {
 247         {
 248                 boost::mutex::scoped_lock lm (_mutex);
 249                 _video_frame_type = t;
 250         }
 251
 252         signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE);
 253 }
 254
 255 string
 256 VideoContent::technical_summary () const
 257 {
 258         return String::compose ("video: length %1, size %2x%3, rate %4", video_length(), video_size().width, video_size().height, video_frame_rate());
 259 }
 260
 261 libdcp::Size
 262 VideoContent::video_size_after_3d_split () const
 263 {
 264         libdcp::Size const s = video_size ();
 265         switch (video_frame_type ()) {
 266         case VIDEO_FRAME_TYPE_2D:
 267                 return s;
 268         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 269                 return libdcp::Size (s.width / 2, s.height);
 270         }
 271
 272         assert (false);
 273 }
 274
 275 void
 276 VideoContent::set_colour_conversion (ColourConversion c)
 277 {
 278         {
 279                 boost::mutex::scoped_lock lm (_mutex);
 280                 _colour_conversion = c;
 281         }
 282
 283         signal_changed (VideoContentProperty::COLOUR_CONVERSION);
 284 }
 285
 286 /** @return Video size after 3D split and crop */
 287 libdcp::Size
 288 VideoContent::video_size_after_crop () const
 289 {
 290         return crop().apply (video_size_after_3d_split ());
 291 }