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