2 Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
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.
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.
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.
20 /** @file src/lib/content_factory.cc
21 * @brief Methods to create content objects.
24 #include "ffmpeg_content.h"
25 #include "audio_content.h"
26 #include "image_content.h"
27 #include "atmos_mxf_content.h"
28 #include "text_subtitle_content.h"
29 #include "dcp_content.h"
30 #include "dcp_subtitle_content.h"
32 #include "ffmpeg_audio_stream.h"
33 #include "video_mxf_content.h"
35 #include "log_entry.h"
37 #include "compose.hpp"
38 #include <libcxml/cxml.h>
39 #include <dcp/smpte_subtitle_asset.h>
40 #include <boost/algorithm/string.hpp>
44 using boost::shared_ptr;
46 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
48 /** Create a Content object from an XML node.
49 * @param film Film that the content will be in.
50 * @param node XML description.
51 * @param version XML state version.
52 * @param notes A list to which is added descriptions of any non-critial warnings / messages.
53 * @return Content object, or 0 if no content was recognised in the XML.
56 content_factory (shared_ptr<const Film> film, cxml::NodePtr node, int version, list<string>& notes)
58 string const type = node->string_child ("Type");
60 boost::shared_ptr<Content> content;
62 if (type == "FFmpeg") {
63 /* SndfileContent is now handled by the FFmpeg code rather than by
64 separate libsndfile-based code.
66 content.reset (new FFmpegContent (film, node, version, notes));
67 } else if (type == "Image") {
68 content.reset (new ImageContent (film, node, version));
69 } else if (type == "Sndfile") {
70 /* SndfileContent is now handled by the FFmpeg code rather than by
71 separate libsndfile-based code.
73 content.reset (new FFmpegContent (film, node, version, notes));
75 content->audio->set_stream (
77 new FFmpegAudioStream (
79 node->number_child<int> ("AudioFrameRate"),
80 node->number_child<Frame> ("AudioLength"),
81 AudioMapping (node->node_child ("AudioMapping"), version)
86 } else if (type == "SubRip" || type == "TextSubtitle") {
87 content.reset (new TextSubtitleContent (film, node, version));
88 } else if (type == "DCP") {
89 content.reset (new DCPContent (film, node, version));
90 } else if (type == "DCPSubtitle") {
91 content.reset (new DCPSubtitleContent (film, node, version));
92 } else if (type == "VideoMXF") {
93 content.reset (new VideoMXFContent (film, node, version));
94 } else if (type == "AtmosMXF") {
95 content.reset (new AtmosMXFContent (film, node, version));
101 /** Create a Content object from a file or directory.
102 * @param film Film that the content will be in.
103 * @param path File or directory.
104 * @return Content object.
107 content_factory (shared_ptr<const Film> film, boost::filesystem::path path)
109 shared_ptr<Content> content;
111 if (boost::filesystem::is_directory (path)) {
113 LOG_GENERAL ("Look in directory %1", path);
115 if (boost::filesystem::is_empty (path)) {
116 return shared_ptr<Content> ();
119 /* Guess if this is a DCP or a set of images: read the first ten filenames and if they
120 are all valid image files we assume it is a set of images.
125 for (boost::filesystem::directory_iterator i(path); i != boost::filesystem::directory_iterator() && read < 10; ++i) {
127 LOG_GENERAL ("Checking file %1", i->path());
129 if (boost::starts_with (i->path().leaf().string(), "._") || i->path().leaf().string() == ".DS_Store") {
130 /* We ignore these files */
131 LOG_GENERAL ("Ignored %1 (starts with {._}, or .DS_Store)", i->path());
135 if (!boost::filesystem::is_regular_file(i->path())) {
136 /* Ignore things which aren't files (probably directories) */
137 LOG_GENERAL ("Ignored %1 (not a regular file)", i->path());
141 if (!valid_image_file (i->path())) {
142 /* We have a normal file which isn't an image; assume we are looking
145 LOG_GENERAL ("It's a DCP because of %1", i->path());
153 content.reset (new DCPContent (film, path));
155 content.reset (new ImageContent (film, path));
160 string ext = path.extension().string ();
161 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
163 if (valid_image_file (path)) {
164 content.reset (new ImageContent (film, path));
165 } else if (ext == ".srt" || ext == ".ssa") {
166 content.reset (new TextSubtitleContent (film, path));
167 } else if (ext == ".xml") {
168 content.reset (new DCPSubtitleContent (film, path));
169 } else if (ext == ".mxf" && dcp::SMPTESubtitleAsset::valid_mxf (path)) {
170 content.reset (new DCPSubtitleContent (film, path));
171 } else if (ext == ".mxf" && VideoMXFContent::valid_mxf (path)) {
172 content.reset (new VideoMXFContent (film, path));
173 } else if (ext == ".mxf" && AtmosMXFContent::valid_mxf (path)) {
174 content.reset (new AtmosMXFContent (film, path));
178 content.reset (new FFmpegContent (film, path));