Remove all use of stringstream in an attempt to fix
[dcpomatic.git] / src / lib / dcp_content.cc
1 /*
2     Copyright (C) 2014-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 #include "dcp_content.h"
22 #include "video_content.h"
23 #include "audio_content.h"
24 #include "dcp_examiner.h"
25 #include "job.h"
26 #include "film.h"
27 #include "config.h"
28 #include "overlaps.h"
29 #include "compose.hpp"
30 #include "dcp_decoder.h"
31 #include "subtitle_content.h"
32 #include <dcp/dcp.h>
33 #include <dcp/exceptions.h>
34 #include <dcp/reel_picture_asset.h>
35 #include <dcp/reel.h>
36 #include <libxml++/libxml++.h>
37 #include <boost/foreach.hpp>
38 #include <iterator>
39 #include <iostream>
40
41 #include "i18n.h"
42
43 using std::string;
44 using std::cout;
45 using std::distance;
46 using std::pair;
47 using std::vector;
48 using std::list;
49 using boost::shared_ptr;
50 using boost::scoped_ptr;
51 using boost::optional;
52 using boost::function;
53
54 int const DCPContentProperty::CAN_BE_PLAYED      = 600;
55 int const DCPContentProperty::REFERENCE_VIDEO    = 601;
56 int const DCPContentProperty::REFERENCE_AUDIO    = 602;
57 int const DCPContentProperty::REFERENCE_SUBTITLE = 603;
58
59 DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
60         : Content (film)
61         , _encrypted (false)
62         , _kdm_valid (false)
63         , _reference_video (false)
64         , _reference_audio (false)
65         , _reference_subtitle (false)
66         , _three_d (false)
67 {
68         video.reset (new VideoContent (this));
69         audio.reset (new AudioContent (this));
70
71         read_directory (p);
72         set_default_colour_conversion ();
73 }
74
75 DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
76         : Content (film, node)
77 {
78         video = VideoContent::from_xml (this, node, version);
79         audio = AudioContent::from_xml (this, node, version);
80         subtitle = SubtitleContent::from_xml (this, node, version);
81
82         audio->set_stream (
83                 AudioStreamPtr (
84                         new AudioStream (
85                                 node->number_child<int> ("AudioFrameRate"),
86                                 node->number_child<Frame> ("AudioLength"),
87                                 AudioMapping (node->node_child ("AudioMapping"), version)
88                                 )
89                         )
90                 );
91
92         _name = node->string_child ("Name");
93
94         _encrypted = node->bool_child ("Encrypted");
95         if (node->optional_node_child ("KDM")) {
96                 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
97         }
98         _kdm_valid = node->bool_child ("KDMValid");
99         _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
100         _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
101         _reference_subtitle = node->optional_bool_child ("ReferenceSubtitle").get_value_or (false);
102         if (node->optional_string_child("Standard")) {
103                 string const s = node->optional_string_child("Standard").get();
104                 if (s == "Interop") {
105                         _standard = dcp::INTEROP;
106                 } else if (s == "SMPTE") {
107                         _standard = dcp::SMPTE;
108                 } else {
109                         DCPOMATIC_ASSERT (false);
110                 }
111         }
112         _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
113 }
114
115 void
116 DCPContent::read_directory (boost::filesystem::path p)
117 {
118         for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
119                 if (boost::filesystem::is_regular_file (i->path ())) {
120                         _paths.push_back (i->path ());
121                 } else if (boost::filesystem::is_directory (i->path ())) {
122                         read_directory (i->path ());
123                 }
124         }
125 }
126
127 void
128 DCPContent::examine (shared_ptr<Job> job)
129 {
130         bool const could_be_played = can_be_played ();
131
132         job->set_progress_unknown ();
133         Content::examine (job);
134
135         shared_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this ()));
136         video->take_from_examiner (examiner);
137         set_default_colour_conversion ();
138
139         {
140                 boost::mutex::scoped_lock lm (_mutex);
141
142                 AudioStreamPtr as (new AudioStream (examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels()));
143                 audio->set_stream (as);
144                 AudioMapping m = as->mapping ();
145                 film()->make_audio_mapping_default (m);
146                 as->set_mapping (m);
147         }
148
149         signal_changed (AudioContentProperty::STREAMS);
150
151         {
152                 boost::mutex::scoped_lock lm (_mutex);
153                 _name = examiner->name ();
154                 if (examiner->has_subtitles ()) {
155                         subtitle.reset (new SubtitleContent (this));
156                 }
157                 _encrypted = examiner->encrypted ();
158                 _kdm_valid = examiner->kdm_valid ();
159                 _standard = examiner->standard ();
160                 _three_d = examiner->three_d ();
161         }
162
163         if (could_be_played != can_be_played ()) {
164                 signal_changed (DCPContentProperty::CAN_BE_PLAYED);
165         }
166
167         video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
168 }
169
170 string
171 DCPContent::summary () const
172 {
173         boost::mutex::scoped_lock lm (_mutex);
174         return String::compose (_("%1 [DCP]"), _name);
175 }
176
177 string
178 DCPContent::technical_summary () const
179 {
180         return Content::technical_summary() + " - "
181                 + video->technical_summary() + " - "
182                 + audio->technical_summary() + " - ";
183 }
184
185 void
186 DCPContent::as_xml (xmlpp::Node* node) const
187 {
188         node->add_child("Type")->add_child_text ("DCP");
189
190         Content::as_xml (node);
191
192         if (video) {
193                 video->as_xml (node);
194         }
195
196         if (audio) {
197                 audio->as_xml (node);
198                 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
199                 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
200                 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
201         }
202
203         if (subtitle) {
204                 subtitle->as_xml (node);
205         }
206
207         boost::mutex::scoped_lock lm (_mutex);
208         node->add_child("Name")->add_child_text (_name);
209         node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
210         if (_kdm) {
211                 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
212         }
213         node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
214         node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
215         node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
216         node->add_child("ReferenceSubtitle")->add_child_text (_reference_subtitle ? "1" : "0");
217         if (_standard) {
218                 switch (_standard.get ()) {
219                 case dcp::INTEROP:
220                         node->add_child("Standard")->add_child_text ("Interop");
221                         break;
222                 case dcp::SMPTE:
223                         node->add_child("Standard")->add_child_text ("SMPTE");
224                         break;
225                 default:
226                         DCPOMATIC_ASSERT (false);
227                 }
228         }
229         node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
230 }
231
232 DCPTime
233 DCPContent::full_length () const
234 {
235         FrameRateChange const frc (active_video_frame_rate (), film()->video_frame_rate ());
236         return DCPTime::from_frames (llrint (video->length () * frc.factor ()), film()->video_frame_rate ());
237 }
238
239 string
240 DCPContent::identifier () const
241 {
242         string s = Content::identifier() + "_" + video->identifier() + "_";
243         if (subtitle) {
244                 s += subtitle->identifier () + " ";
245         }
246
247         s += string (_reference_video ? "1" : "0") + string (_reference_subtitle ? "1" : "0");
248         return s;
249 }
250
251 void
252 DCPContent::add_kdm (dcp::EncryptedKDM k)
253 {
254         _kdm = k;
255 }
256
257 bool
258 DCPContent::can_be_played () const
259 {
260         boost::mutex::scoped_lock lm (_mutex);
261         return !_encrypted || _kdm_valid;
262 }
263
264 boost::filesystem::path
265 DCPContent::directory () const
266 {
267         optional<size_t> smallest;
268         boost::filesystem::path dir;
269         for (size_t i = 0; i < number_of_paths(); ++i) {
270                 boost::filesystem::path const p = path (i).parent_path ();
271                 size_t const d = distance (p.begin(), p.end());
272                 if (!smallest || d < smallest.get ()) {
273                         dir = p;
274                 }
275         }
276
277         return dir;
278 }
279
280 void
281 DCPContent::add_properties (list<UserProperty>& p) const
282 {
283         Content::add_properties (p);
284         video->add_properties (p);
285         audio->add_properties (p);
286 }
287
288 void
289 DCPContent::set_default_colour_conversion ()
290 {
291         /* Default to no colour conversion for DCPs */
292         video->unset_colour_conversion ();
293 }
294
295 void
296 DCPContent::set_reference_video (bool r)
297 {
298         {
299                 boost::mutex::scoped_lock lm (_mutex);
300                 _reference_video = r;
301         }
302
303         signal_changed (DCPContentProperty::REFERENCE_VIDEO);
304 }
305
306 void
307 DCPContent::set_reference_audio (bool r)
308 {
309         {
310                 boost::mutex::scoped_lock lm (_mutex);
311                 _reference_audio = r;
312         }
313
314         signal_changed (DCPContentProperty::REFERENCE_AUDIO);
315 }
316
317 void
318 DCPContent::set_reference_subtitle (bool r)
319 {
320         {
321                 boost::mutex::scoped_lock lm (_mutex);
322                 _reference_subtitle = r;
323         }
324
325         signal_changed (DCPContentProperty::REFERENCE_SUBTITLE);
326 }
327
328 list<DCPTimePeriod>
329 DCPContent::reels () const
330 {
331         list<DCPTimePeriod> p;
332         scoped_ptr<DCPDecoder> decoder;
333         try {
334                 decoder.reset (new DCPDecoder (shared_from_this(), film()->log()));
335         } catch (...) {
336                 /* Could not load the DCP; guess reels */
337                 list<DCPTimePeriod> p;
338                 p.push_back (DCPTimePeriod (position(), end()));
339                 return p;
340         }
341
342         DCPTime from = position ();
343         BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
344                 DCPTime const to = from + DCPTime::from_frames (i->main_picture()->duration(), film()->video_frame_rate());
345                 p.push_back (DCPTimePeriod (from, to));
346                 from = to;
347         }
348
349         return p;
350 }
351
352 list<DCPTime>
353 DCPContent::reel_split_points () const
354 {
355         list<DCPTime> s;
356         BOOST_FOREACH (DCPTimePeriod i, reels()) {
357                 s.push_back (i.from);
358         }
359         return s;
360 }
361
362 bool
363 DCPContent::can_reference (function<shared_ptr<ContentPart> (shared_ptr<const Content>)> part, string overlapping, list<string>& why_not) const
364 {
365         /* We must be using the same standard as the film */
366         if (_standard) {
367                 if (_standard.get() == dcp::INTEROP && !film()->interop()) {
368                         why_not.push_back (_("The film is set to SMPTE and this DCP is Interop."));
369                         return false;
370                 } else if (_standard.get() == dcp::SMPTE && film()->interop()) {
371                         why_not.push_back (_("The film is set to Interop and this DCP is SMPTE."));
372                         return false;
373                 }
374         }
375
376         list<DCPTimePeriod> const fr = film()->reels ();
377         /* fr must contain reels().  It can also contain other reels, but it must at
378            least contain reels().
379         */
380         BOOST_FOREACH (DCPTimePeriod i, reels()) {
381                 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
382                         why_not.push_back (_("Reel lengths in the film differ from those in the DCP; set the reel mode to 'split by video content'."));
383                         return false;
384                 }
385         }
386
387         ContentList a = overlaps (film()->content(), part, position(), end());
388         if (a.size() != 1 || a.front().get() != this) {
389                 why_not.push_back (overlapping);
390                 return false;
391         }
392
393         return true;
394 }
395
396 bool
397 DCPContent::can_reference_video (list<string>& why_not) const
398 {
399         return can_reference (bind (&Content::video, _1), _("There is other video content overlapping this DCP; remove it."), why_not);
400 }
401
402 bool
403 DCPContent::can_reference_audio (list<string>& why_not) const
404 {
405         DCPDecoder decoder (shared_from_this(), film()->log());
406         BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder.reels()) {
407                 if (!i->main_sound()) {
408                         why_not.push_back (_("The DCP does not have sound in all reels."));
409                         return false;
410                 }
411         }
412
413         return can_reference (bind (&Content::audio, _1),   _("There is other audio content overlapping this DCP; remove it."), why_not);
414 }
415
416 bool
417 DCPContent::can_reference_subtitle (list<string>& why_not) const
418 {
419         DCPDecoder decoder (shared_from_this(), film()->log());
420         BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder.reels()) {
421                 if (!i->main_subtitle()) {
422                         why_not.push_back (_("The DCP does not have subtitles in all reels."));
423                         return false;
424                 }
425         }
426
427         return can_reference (bind (&Content::subtitle, _1), _("There is other subtitle content overlapping this DCP; remove it."), why_not);
428 }