src/lib/dcp_video.cc

   1 /*
   2     Copyright (C) 2012-2016 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 /** @file  src/dcp_video_frame.cc
  22  *  @brief A single frame of video destined for a DCP.
  23  *
  24  *  Given an Image and some settings, this class knows how to encode
  25  *  the image to J2K either on the local host or on a remote server.
  26  *
  27  *  Objects of this class are used for the queue that we keep
  28  *  of images that require encoding.
  29  */
  30
  31 #include "dcp_video.h"
  32 #include "config.h"
  33 #include "exceptions.h"
  34 #include "encode_server_description.h"
  35 #include "image.h"
  36 #include "log.h"
  37 #include "dcpomatic_log.h"
  38 #include "cross.h"
  39 #include "player_video.h"
  40 #include "compose.hpp"
  41 #include "warnings.h"
  42 #include <libcxml/cxml.h>
  43 #include <dcp/raw_convert.h>
  44 #include <dcp/openjpeg_image.h>
  45 #include <dcp/rgb_xyz.h>
  46 #include <dcp/j2k.h>
  47 DCPOMATIC_DISABLE_WARNINGS
  48 #include <libxml++/libxml++.h>
  49 DCPOMATIC_ENABLE_WARNINGS
  50 #include <boost/thread.hpp>
  51 #include <stdint.h>
  52 #include <iomanip>
  53 #include <iostream>
  54
  55 #include "i18n.h"
  56
  57 using std::string;
  58 using std::cout;
  59 using boost::shared_ptr;
  60 using dcp::Size;
  61 using dcp::Data;
  62 using dcp::raw_convert;
  63 #if BOOST_VERSION >= 106100
  64 using namespace boost::placeholders;
  65 #endif
  66 using namespace dcpomatic;
  67
  68
  69 #define DCI_COEFFICENT (48.0 / 52.37)
  70
  71 /** Construct a DCP video frame.
  72  *  @param frame Input frame.
  73  *  @param index Index of the frame within the DCP.
  74  *  @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
  75  */
  76 DCPVideo::DCPVideo (
  77         shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r
  78         )
  79         : _frame (frame)
  80         , _index (index)
  81         , _frames_per_second (dcp_fps)
  82         , _j2k_bandwidth (bw)
  83         , _resolution (r)
  84 {
  85
  86 }
  87
  88 DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node)
  89         : _frame (frame)
  90 {
  91         _index = node->number_child<int> ("Index");
  92         _frames_per_second = node->number_child<int> ("FramesPerSecond");
  93         _j2k_bandwidth = node->number_child<int> ("J2KBandwidth");
  94         _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or (RESOLUTION_2K));
  95 }
  96
  97 shared_ptr<dcp::OpenJPEGImage>
  98 DCPVideo::convert_to_xyz (shared_ptr<const PlayerVideo> frame, dcp::NoteHandler note)
  99 {
 100         shared_ptr<dcp::OpenJPEGImage> xyz;
 101
 102         shared_ptr<Image> image = frame->image (bind (&PlayerVideo::keep_xyz_or_rgb, _1), true, false);
 103         if (frame->colour_conversion()) {
 104                 xyz = dcp::rgb_to_xyz (
 105                         image->data()[0],
 106                         image->size(),
 107                         image->stride()[0],
 108                         frame->colour_conversion().get(),
 109                         note
 110                         );
 111         } else {
 112                 xyz.reset (new dcp::OpenJPEGImage (image->data()[0], image->size(), image->stride()[0]));
 113         }
 114
 115         return xyz;
 116 }
 117
 118
 119 void
 120 DCPVideo::add_metadata (xmlpp::Element* el) const
 121 {
 122         el->add_child("Index")->add_child_text (raw_convert<string> (_index));
 123         el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
 124         el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 125         el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
 126         _frame->add_metadata (el);
 127 }
 128
 129
 130 /** @return true if this DCPVideo is definitely the same as another;
 131  *  (apart from the frame index), false if it is probably not.
 132  */
 133 bool
 134 DCPVideo::same (shared_ptr<const DCPVideo> other) const
 135 {
 136         if (_frames_per_second != other->_frames_per_second ||
 137             _j2k_bandwidth != other->_j2k_bandwidth ||
 138             _resolution != other->_resolution) {
 139                 return false;
 140         }
 141
 142         return _frame->same (other->_frame);
 143 }