src/lib/content_factory.cc

   1 /*
   2     Copyright (C) 2013-2016 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 /** @file  src/lib/content_factory.cc
  21  *  @brief Methods to create content objects.
  22  */
  23
  24 #include "ffmpeg_content.h"
  25 #include "audio_content.h"
  26 #include "image_content.h"
  27 #include "text_subtitle_content.h"
  28 #include "dcp_content.h"
  29 #include "dcp_subtitle_content.h"
  30 #include "util.h"
  31 #include "ffmpeg_audio_stream.h"
  32 #include "film.h"
  33 #include "log_entry.h"
  34 #include "log.h"
  35 #include "compose.hpp"
  36 #include <libcxml/cxml.h>
  37 #include <dcp/smpte_subtitle_asset.h>
  38 #include <boost/algorithm/string.hpp>
  39
  40 using std::string;
  41 using std::list;
  42 using boost::shared_ptr;
  43
  44 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  45
  46 /** Create a Content object from an XML node.
  47  *  @param film Film that the content will be in.
  48  *  @param node XML description.
  49  *  @param version XML state version.
  50  *  @param notes A list to which is added descriptions of any non-critial warnings / messages.
  51  *  @return Content object, or 0 if no content was recognised in the XML.
  52  */
  53 shared_ptr<Content>
  54 content_factory (shared_ptr<const Film> film, cxml::NodePtr node, int version, list<string>& notes)
  55 {
  56         string const type = node->string_child ("Type");
  57
  58         boost::shared_ptr<Content> content;
  59
  60         if (type == "FFmpeg") {
  61                 /* SndfileContent is now handled by the FFmpeg code rather than by
  62                    separate libsndfile-based code.
  63                 */
  64                 content.reset (new FFmpegContent (film, node, version, notes));
  65         } else if (type == "Image") {
  66                 content.reset (new ImageContent (film, node, version));
  67         } else if (type == "Sndfile") {
  68                 /* SndfileContent is now handled by the FFmpeg code rather than by
  69                    separate libsndfile-based code.
  70                 */
  71                 content.reset (new FFmpegContent (film, node, version, notes));
  72
  73                 content->audio->set_stream (
  74                         AudioStreamPtr (
  75                                 new FFmpegAudioStream (
  76                                         "Stream", 0,
  77                                         node->number_child<int> ("AudioFrameRate"),
  78                                         node->number_child<Frame> ("AudioLength"),
  79                                         AudioMapping (node->node_child ("AudioMapping"), version)
  80                                         )
  81                                 )
  82                         );
  83
  84         } else if (type == "SubRip" || type == "TextSubtitle") {
  85                 content.reset (new TextSubtitleContent (film, node, version));
  86         } else if (type == "DCP") {
  87                 content.reset (new DCPContent (film, node, version));
  88         } else if (type == "DCPSubtitle") {
  89                 content.reset (new DCPSubtitleContent (film, node, version));
  90         }
  91
  92         return content;
  93 }
  94
  95 /** Create a Content object from a file or directory.
  96  *  @param film Film that the content will be in.
  97  *  @param path File or directory.
  98  *  @return Content object.
  99  */
 100 shared_ptr<Content>
 101 content_factory (shared_ptr<const Film> film, boost::filesystem::path path)
 102 {
 103         shared_ptr<Content> content;
 104
 105         if (boost::filesystem::is_directory (path)) {
 106
 107                 LOG_GENERAL ("Look in directory %1", path);
 108
 109                 if (boost::filesystem::is_empty (path)) {
 110                         return shared_ptr<Content> ();
 111                 }
 112
 113                 /* Guess if this is a DCP or a set of images: read the first ten filenames and if they
 114                    are all valid image files we assume it is a set of images.
 115                 */
 116
 117                 bool is_dcp = false;
 118                 int read = 0;
 119                 for (boost::filesystem::directory_iterator i(path); i != boost::filesystem::directory_iterator() && read < 10; ++i) {
 120
 121                         LOG_GENERAL ("Checking file %1", i->path());
 122
 123                         if (boost::starts_with (i->path().leaf().string(), "._") || i->path().leaf().string() == ".DS_Store") {
 124                                 /* We ignore these files */
 125                                 LOG_GENERAL ("Ignored %1 (starts with {._}, or .DS_Store)", i->path());
 126                                 continue;
 127                         }
 128
 129                         if (!boost::filesystem::is_regular_file(i->path())) {
 130                                 /* Ignore things which aren't files (probably directories) */
 131                                 LOG_GENERAL ("Ignored %1 (not a regular file)", i->path());
 132                                 continue;
 133                         }
 134
 135                         if (!valid_image_file (i->path())) {
 136                                 /* We have a normal file which isn't an image; assume we are looking
 137                                    at a DCP.
 138                                 */
 139                                 LOG_GENERAL ("It's a DCP because of %1", i->path());
 140                                 is_dcp = true;
 141                         }
 142
 143                         ++read;
 144                 }
 145
 146                 if (is_dcp) {
 147                         content.reset (new DCPContent (film, path));
 148                 } else {
 149                         content.reset (new ImageContent (film, path));
 150                 }
 151
 152         } else {
 153
 154                 string ext = path.extension().string ();
 155                 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 156
 157                 if (valid_image_file (path)) {
 158                         content.reset (new ImageContent (film, path));
 159                 } else if (ext == ".srt" || ext == ".ssa") {
 160                         content.reset (new TextSubtitleContent (film, path));
 161                 } else if (ext == ".xml") {
 162                         content.reset (new DCPSubtitleContent (film, path));
 163                 } else if (ext == ".mxf" && dcp::SMPTESubtitleAsset::valid_mxf (path)) {
 164                         content.reset (new DCPSubtitleContent (film, path));
 165                 }
 166
 167                 if (!content) {
 168                         content.reset (new FFmpegContent (film, path));
 169                 }
 170         }
 171
 172         return content;
 173 }