src/lib/content_factory.cc

   1 /*
   2     Copyright (C) 2013-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/lib/content_factory.cc
  22  *  @brief Methods to create content objects.
  23  */
  24
  25 #include "ffmpeg_content.h"
  26 #include "audio_content.h"
  27 #include "image_content.h"
  28 #include "atmos_mxf_content.h"
  29 #include "text_subtitle_content.h"
  30 #include "dcp_content.h"
  31 #include "dcp_subtitle_content.h"
  32 #include "util.h"
  33 #include "ffmpeg_audio_stream.h"
  34 #include "video_mxf_content.h"
  35 #include "film.h"
  36 #include "log_entry.h"
  37 #include "log.h"
  38 #include "compose.hpp"
  39 #include <libcxml/cxml.h>
  40 #include <dcp/smpte_subtitle_asset.h>
  41 #include <boost/algorithm/string.hpp>
  42
  43 #include "i18n.h"
  44
  45 using std::string;
  46 using std::list;
  47 using boost::shared_ptr;
  48 using boost::optional;
  49
  50 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  51
  52 /** Create a Content object from an XML node.
  53  *  @param film Film that the content will be in.
  54  *  @param node XML description.
  55  *  @param version XML state version.
  56  *  @param notes A list to which is added descriptions of any non-critial warnings / messages.
  57  *  @return Content object, or 0 if no content was recognised in the XML.
  58  */
  59 shared_ptr<Content>
  60 content_factory (shared_ptr<const Film> film, cxml::NodePtr node, int version, list<string>& notes)
  61 {
  62         string const type = node->string_child ("Type");
  63
  64         boost::shared_ptr<Content> content;
  65
  66         if (type == "FFmpeg") {
  67                 /* SndfileContent is now handled by the FFmpeg code rather than by
  68                    separate libsndfile-based code.
  69                 */
  70                 content.reset (new FFmpegContent (film, node, version, notes));
  71         } else if (type == "Image") {
  72                 content.reset (new ImageContent (film, node, version));
  73         } else if (type == "Sndfile") {
  74                 /* SndfileContent is now handled by the FFmpeg code rather than by
  75                    separate libsndfile-based code.
  76                 */
  77                 content.reset (new FFmpegContent (film, node, version, notes));
  78
  79                 content->audio->set_stream (
  80                         AudioStreamPtr (
  81                                 new FFmpegAudioStream (
  82                                         "Stream", 0,
  83                                         node->number_child<int> ("AudioFrameRate"),
  84                                         node->number_child<Frame> ("AudioLength"),
  85                                         AudioMapping (node->node_child ("AudioMapping"), version)
  86                                         )
  87                                 )
  88                         );
  89
  90         } else if (type == "SubRip" || type == "TextSubtitle") {
  91                 content.reset (new TextSubtitleContent (film, node, version));
  92         } else if (type == "DCP") {
  93                 content.reset (new DCPContent (film, node, version));
  94         } else if (type == "DCPSubtitle") {
  95                 content.reset (new DCPSubtitleContent (film, node, version));
  96         } else if (type == "VideoMXF") {
  97                 content.reset (new VideoMXFContent (film, node, version));
  98         } else if (type == "AtmosMXF") {
  99                 content.reset (new AtmosMXFContent (film, node, version));
 100         }
 101
 102         /* See if this content should be nudged to start on a video frame */
 103         DCPTime const old_pos = content->position();
 104         content->set_position(old_pos);
 105         if (old_pos != content->position()) {
 106                 string note = _("Your project contains video content that was not aligned to a frame boundary.");
 107                 note += "  ";
 108                 if (old_pos < content->position()) {
 109                         note += String::compose(
 110                                 _("The file %1 has been moved %2 milliseconds later."),
 111                                 content->path_summary(), DCPTime(content->position() - old_pos).seconds() * 1000
 112                                 );
 113                 } else {
 114                         note += String::compose(
 115                                 _("The file %1 has been moved %2 milliseconds earlier."),
 116                                 content->path_summary(), DCPTime(content->position() - old_pos).seconds() * 1000
 117                                 );
 118                 }
 119                 notes.push_back (note);
 120         }
 121
 122         return content;
 123 }
 124
 125 /** Create some Content objects from a file or directory.
 126  *  @param film Film that the content will be in.
 127  *  @param path File or directory.
 128  *  @return Content objects.
 129  */
 130 list<shared_ptr<Content> >
 131 content_factory (shared_ptr<const Film> film, boost::filesystem::path path)
 132 {
 133         list<shared_ptr<Content> > content;
 134
 135         if (boost::filesystem::is_directory (path)) {
 136
 137                 LOG_GENERAL ("Look in directory %1", path);
 138
 139                 if (boost::filesystem::is_empty (path)) {
 140                         return content;
 141                 }
 142
 143                 /* See if this is a set of images or a set of sound files */
 144
 145                 int image_files = 0;
 146                 int sound_files = 0;
 147                 int read = 0;
 148                 for (boost::filesystem::directory_iterator i(path); i != boost::filesystem::directory_iterator() && read < 10; ++i) {
 149
 150                         LOG_GENERAL ("Checking file %1", i->path());
 151
 152                         if (boost::starts_with (i->path().leaf().string(), ".")) {
 153                                 /* We ignore hidden files */
 154                                 LOG_GENERAL ("Ignored %1 (starts with .)", i->path());
 155                                 continue;
 156                         }
 157
 158                         if (!boost::filesystem::is_regular_file(i->path())) {
 159                                 /* Ignore things which aren't files (probably directories) */
 160                                 LOG_GENERAL ("Ignored %1 (not a regular file)", i->path());
 161                                 continue;
 162                         }
 163
 164                         if (valid_image_file (i->path ())) {
 165                                 ++image_files;
 166                         }
 167
 168                         if (valid_sound_file (i->path ())) {
 169                                 ++sound_files;
 170                         }
 171
 172                         ++read;
 173                 }
 174
 175                 if (image_files > 0 && sound_files == 0)  {
 176                         content.push_back (shared_ptr<Content> (new ImageContent (film, path)));
 177                 } else if (image_files == 0 && sound_files > 0) {
 178                         for (boost::filesystem::directory_iterator i(path); i != boost::filesystem::directory_iterator(); ++i) {
 179                                 content.push_back (shared_ptr<FFmpegContent> (new FFmpegContent (film, i->path())));
 180                         }
 181                 }
 182
 183         } else {
 184
 185                 shared_ptr<Content> single;
 186
 187                 string ext = path.extension().string ();
 188                 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 189
 190                 if (valid_image_file (path)) {
 191                         single.reset (new ImageContent (film, path));
 192                 } else if (ext == ".srt" || ext == ".ssa" || ext == ".ass") {
 193                         single.reset (new TextSubtitleContent (film, path));
 194                 } else if (ext == ".xml") {
 195                         cxml::Document doc;
 196                         doc.read_file (path);
 197                         if (doc.root_name() == "DCinemaSecurityMessage") {
 198                                 throw KDMAsContentError ();
 199                         }
 200                         single.reset (new DCPSubtitleContent (film, path));
 201                 } else if (ext == ".mxf" && dcp::SMPTESubtitleAsset::valid_mxf (path)) {
 202                         single.reset (new DCPSubtitleContent (film, path));
 203                 } else if (ext == ".mxf" && VideoMXFContent::valid_mxf (path)) {
 204                         single.reset (new VideoMXFContent (film, path));
 205                 } else if (ext == ".mxf" && AtmosMXFContent::valid_mxf (path)) {
 206                         single.reset (new AtmosMXFContent (film, path));
 207                 }
 208
 209                 if (!single) {
 210                         single.reset (new FFmpegContent (film, path));
 211                 }
 212
 213                 content.push_back (single);
 214         }
 215
 216         return content;
 217 }