src/lib/image_content.cc

   1 /*
   2     Copyright (C) 2013-2018 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 #include "compose.hpp"
  23 #include "exceptions.h"
  24 #include "film.h"
  25 #include "frame_rate_change.h"
  26 #include "image_content.h"
  27 #include "image_examiner.h"
  28 #include "image_filename_sorter.h"
  29 #include "job.h"
  30 #include "video_content.h"
  31 #include <libcxml/cxml.h>
  32 #include <libxml++/libxml++.h>
  33 #include <iostream>
  34
  35 #include "i18n.h"
  36
  37
  38 using std::cout;
  39 using std::list;
  40 using std::make_shared;
  41 using std::shared_ptr;
  42 using std::string;
  43 using std::vector;
  44 using namespace dcpomatic;
  45
  46
  47 ImageContent::ImageContent (boost::filesystem::path p)
  48 {
  49         video = make_shared<VideoContent>(this);
  50
  51         if (boost::filesystem::is_regular_file (p) && valid_image_file (p)) {
  52                 add_path (p);
  53         } else {
  54                 _path_to_scan = p;
  55         }
  56
  57         set_default_colour_conversion ();
  58 }
  59
  60
  61 ImageContent::ImageContent (cxml::ConstNodePtr node, int version)
  62         : Content (node)
  63 {
  64         video = VideoContent::from_xml (this, node, version, VideoRange::FULL);
  65 }
  66
  67
  68 string
  69 ImageContent::summary () const
  70 {
  71         string s = path_summary () + " ";
  72         /* Get the string() here so that the name does not have quotes around it */
  73         if (still ()) {
  74                 s += _("[still]");
  75         } else {
  76                 s += _("[moving images]");
  77         }
  78
  79         return s;
  80 }
  81
  82
  83 string
  84 ImageContent::technical_summary () const
  85 {
  86         string s = Content::technical_summary() + " - "
  87                 + video->technical_summary() + " - ";
  88
  89         if (still ()) {
  90                 s += _("still");
  91         } else {
  92                 s += _("moving");
  93         }
  94
  95         return s;
  96 }
  97
  98
  99 void
 100 ImageContent::as_xml (xmlpp::Node* node, bool with_paths) const
 101 {
 102         node->add_child("Type")->add_child_text ("Image");
 103         Content::as_xml (node, with_paths);
 104
 105         if (video) {
 106                 video->as_xml (node);
 107         }
 108 }
 109
 110
 111 void
 112 ImageContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
 113 {
 114         if (_path_to_scan) {
 115                 job->sub (_("Scanning image files"));
 116                 vector<boost::filesystem::path> paths;
 117                 int n = 0;
 118                 for (auto i: boost::filesystem::directory_iterator(*_path_to_scan)) {
 119                         if (boost::filesystem::is_regular_file(i.path()) && valid_image_file (i.path())) {
 120                                 paths.push_back (i.path());
 121                         }
 122                         ++n;
 123                         if ((n % 1000) == 0) {
 124                                 job->set_progress_unknown ();
 125                         }
 126                 }
 127
 128                 if (paths.empty()) {
 129                         throw FileError (_("No valid image files were found in the folder."), *_path_to_scan);
 130                 }
 131
 132                 sort (paths.begin(), paths.end(), ImageFilenameSorter());
 133                 set_paths (paths);
 134         }
 135
 136         Content::examine (film, job);
 137
 138         auto examiner = make_shared<ImageExaminer>(film, shared_from_this(), job);
 139         video->take_from_examiner (examiner);
 140         set_default_colour_conversion ();
 141 }
 142
 143
 144 DCPTime
 145 ImageContent::full_length (shared_ptr<const Film> film) const
 146 {
 147         FrameRateChange const frc (film, shared_from_this());
 148         return DCPTime::from_frames (llrint(video->length_after_3d_combine() * frc.factor()), film->video_frame_rate());
 149 }
 150
 151
 152 DCPTime
 153 ImageContent::approximate_length () const
 154 {
 155         return DCPTime::from_frames (video->length_after_3d_combine(), 24);
 156 }
 157
 158
 159 string
 160 ImageContent::identifier () const
 161 {
 162         char buffer[256];
 163         snprintf (buffer, sizeof(buffer), "%s_%s_%" PRId64, Content::identifier().c_str(), video->identifier().c_str(), video->length());
 164         return buffer;
 165 }
 166
 167
 168 bool
 169 ImageContent::still () const
 170 {
 171         return number_of_paths() == 1;
 172 }
 173
 174
 175 void
 176 ImageContent::set_default_colour_conversion ()
 177 {
 178         for (auto i: paths()) {
 179                 if (valid_j2k_file (i)) {
 180                         /* We default to no colour conversion if we have JPEG2000 files */
 181                         video->unset_colour_conversion ();
 182                         return;
 183                 }
 184         }
 185
 186         bool const s = still ();
 187
 188         boost::mutex::scoped_lock lm (_mutex);
 189
 190         if (s) {
 191                 video->set_colour_conversion (PresetColourConversion::from_id ("srgb").conversion);
 192         } else {
 193                 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
 194         }
 195 }
 196
 197
 198 void
 199 ImageContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
 200 {
 201         Content::add_properties (film, p);
 202         video->add_properties (p);
 203 }