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