2 Copyright (C) 2013-2014 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 "image_content.h"
26 #include "sndfile_content.h"
27 #include "text_subtitle_content.h"
28 #include "dcp_content.h"
29 #include "dcp_subtitle_content.h"
32 #include "log_entry.h"
34 #include "compose.hpp"
35 #include <libcxml/cxml.h>
36 #include <dcp/smpte_subtitle_asset.h>
37 #include <boost/algorithm/string.hpp>
41 using boost::shared_ptr;
43 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
45 /** Create a Content object from an XML node.
46 * @param film Film that the content will be in.
47 * @param node XML description.
48 * @param version XML state version.
49 * @param notes A list to which is added descriptions of any non-critial warnings / messages.
50 * @return Content object, or 0 if no content was recognised in the XML.
53 content_factory (shared_ptr<const Film> film, cxml::NodePtr node, int version, list<string>& notes)
55 string const type = node->string_child ("Type");
57 boost::shared_ptr<Content> content;
59 if (type == "FFmpeg") {
60 content.reset (new FFmpegContent (film, node, version, notes));
61 } else if (type == "Image") {
62 content.reset (new ImageContent (film, node, version));
63 } else if (type == "Sndfile") {
64 content.reset (new SndfileContent (film, node, version));
65 } else if (type == "SubRip" || type == "TextSubtitle") {
66 content.reset (new TextSubtitleContent (film, node, version));
67 } else if (type == "DCP") {
68 content.reset (new DCPContent (film, node, version));
69 } else if (type == "DCPSubtitle") {
70 content.reset (new DCPSubtitleContent (film, node, version));
76 /** Create a Content object from a file or directory.
77 * @param film Film that the content will be in.
78 * @param path File or directory.
79 * @return Content object.
82 content_factory (shared_ptr<const Film> film, boost::filesystem::path path)
84 shared_ptr<Content> content;
86 if (boost::filesystem::is_directory (path)) {
88 LOG_GENERAL ("Look in directory %1", path);
90 if (boost::filesystem::is_empty (path)) {
91 return shared_ptr<Content> ();
94 /* Guess if this is a DCP or a set of images: read the first ten filenames and if they
95 are all valid image files we assume it is a set of images.
100 for (boost::filesystem::directory_iterator i(path); i != boost::filesystem::directory_iterator() && read < 10; ++i) {
102 LOG_GENERAL ("Checking file %1", i->path());
104 if (boost::starts_with (i->path().leaf().string(), "._") || i->path().leaf().string() == ".DS_Store") {
105 /* We ignore these files */
106 LOG_GENERAL ("Ignored %1 (starts with {._}, or .DS_Store)", i->path());
110 if (!boost::filesystem::is_regular_file(i->path())) {
111 /* Ignore things which aren't files (probably directories) */
112 LOG_GENERAL ("Ignored %1 (not a regular file)", i->path());
116 if (!valid_image_file (i->path())) {
117 /* We have a normal file which isn't an image; assume we are looking
120 LOG_GENERAL ("It's a DCP because of %1", i->path());
128 content.reset (new DCPContent (film, path));
130 content.reset (new ImageContent (film, path));
135 string ext = path.extension().string ();
136 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
138 if (valid_image_file (path)) {
139 content.reset (new ImageContent (film, path));
140 } else if (SndfileContent::valid_file (path)) {
141 content.reset (new SndfileContent (film, path));
142 } else if (ext == ".srt" || ext == ".ssa") {
143 content.reset (new TextSubtitleContent (film, path));
144 } else if (ext == ".xml") {
145 content.reset (new DCPSubtitleContent (film, path));
146 } else if (ext == ".mxf" && dcp::SMPTESubtitleAsset::valid_mxf (path)) {
147 content.reset (new DCPSubtitleContent (film, path));
151 content.reset (new FFmpegContent (film, path));