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