More accurate calculation of export video pts; may fix #1663.
[dcpomatic.git] / src / lib / dcp_subtitle_content.cc
1 /*
2     Copyright (C) 2014-2018 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 "font.h"
22 #include "dcp_subtitle_content.h"
23 #include "film.h"
24 #include "text_content.h"
25 #include <dcp/raw_convert.h>
26 #include <dcp/interop_subtitle_asset.h>
27 #include <dcp/smpte_subtitle_asset.h>
28 #include <dcp/interop_load_font_node.h>
29 #include <libxml++/libxml++.h>
30 #include <boost/foreach.hpp>
31
32 #include "i18n.h"
33
34 using std::string;
35 using std::list;
36 using boost::shared_ptr;
37 using boost::dynamic_pointer_cast;
38 using dcp::raw_convert;
39 using namespace dcpomatic;
40
41 DCPSubtitleContent::DCPSubtitleContent (boost::filesystem::path path)
42         : Content (path)
43 {
44         text.push_back (shared_ptr<TextContent> (new TextContent (this, TEXT_OPEN_SUBTITLE, TEXT_OPEN_SUBTITLE)));
45 }
46
47 DCPSubtitleContent::DCPSubtitleContent (cxml::ConstNodePtr node, int version)
48         : Content (node)
49         , _length (node->number_child<ContentTime::Type> ("Length"))
50 {
51         text = TextContent::from_xml (this, node, version);
52 }
53
54 void
55 DCPSubtitleContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
56 {
57         Content::examine (film, job);
58
59         shared_ptr<dcp::SubtitleAsset> sc = load (path (0));
60
61         shared_ptr<dcp::InteropSubtitleAsset> iop = dynamic_pointer_cast<dcp::InteropSubtitleAsset> (sc);
62         shared_ptr<dcp::SMPTESubtitleAsset> smpte = dynamic_pointer_cast<dcp::SMPTESubtitleAsset> (sc);
63         if (smpte) {
64                 set_video_frame_rate (smpte->edit_rate().numerator);
65         }
66
67         boost::mutex::scoped_lock lm (_mutex);
68
69         /* Default to turning these subtitles on */
70         only_text()->set_use (true);
71
72         if (iop) {
73                 only_text()->set_language (iop->language ());
74         } else if (smpte) {
75                 only_text()->set_language (smpte->language().get_value_or (""));
76         }
77
78         _length = ContentTime::from_seconds (sc->latest_subtitle_out().as_seconds ());
79
80         BOOST_FOREACH (shared_ptr<dcp::LoadFontNode> i, sc->load_font_nodes ()) {
81                 only_text()->add_font (shared_ptr<Font> (new Font (i->id)));
82         }
83 }
84
85 DCPTime
86 DCPSubtitleContent::full_length (shared_ptr<const Film> film) const
87 {
88         FrameRateChange const frc (film, shared_from_this());
89         return DCPTime (_length, frc);
90 }
91
92 DCPTime
93 DCPSubtitleContent::approximate_length () const
94 {
95         return DCPTime (_length, FrameRateChange());
96 }
97
98 string
99 DCPSubtitleContent::summary () const
100 {
101         return path_summary() + " " + _("[subtitles]");
102 }
103
104 string
105 DCPSubtitleContent::technical_summary () const
106 {
107         return Content::technical_summary() + " - " + _("DCP XML subtitles");
108 }
109
110 void
111 DCPSubtitleContent::as_xml (xmlpp::Node* node, bool with_paths) const
112 {
113         node->add_child("Type")->add_child_text ("DCPSubtitle");
114         Content::as_xml (node, with_paths);
115
116         if (only_text()) {
117                 only_text()->as_xml (node);
118         }
119
120         node->add_child("Length")->add_child_text (raw_convert<string> (_length.get ()));
121 }