Basics of subtitle split.
[dcpomatic.git] / src / lib / dcp_subtitle_content.cc
1 /*
2     Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
3
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.
8
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.
13
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.
17
18 */
19
20 #include "font.h"
21 #include "dcp_subtitle_content.h"
22 #include "raw_convert.h"
23 #include "film.h"
24 #include "subtitle_content.h"
25 #include <dcp/interop_subtitle_asset.h>
26 #include <dcp/smpte_subtitle_asset.h>
27 #include <dcp/interop_load_font_node.h>
28 #include <libxml++/libxml++.h>
29 #include <boost/foreach.hpp>
30
31 #include "i18n.h"
32
33 using std::string;
34 using std::list;
35 using boost::shared_ptr;
36 using boost::dynamic_pointer_cast;
37
38 DCPSubtitleContent::DCPSubtitleContent (shared_ptr<const Film> film, boost::filesystem::path path)
39         : Content (film, path)
40 {
41         subtitle.reset (new SubtitleContent (this, film));
42 }
43
44 DCPSubtitleContent::DCPSubtitleContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
45         : Content (film, node)
46         , _length (node->number_child<ContentTime::Type> ("Length"))
47         , _frame_rate (node->optional_number_child<int>("SubtitleFrameRate"))
48 {
49         subtitle.reset (new SubtitleContent (this, film, node, version));
50 }
51
52 void
53 DCPSubtitleContent::examine (shared_ptr<Job> job)
54 {
55         Content::examine (job);
56
57         shared_ptr<dcp::SubtitleAsset> sc = load (path (0));
58
59         /* Default to turning these subtitles on */
60         subtitle->set_use_subtitles (true);
61
62         boost::mutex::scoped_lock lm (_mutex);
63
64         shared_ptr<dcp::InteropSubtitleAsset> iop = dynamic_pointer_cast<dcp::InteropSubtitleAsset> (sc);
65         if (iop) {
66                 subtitle->set_subtitle_language (iop->language ());
67         }
68         shared_ptr<dcp::SMPTESubtitleAsset> smpte = dynamic_pointer_cast<dcp::SMPTESubtitleAsset> (sc);
69         if (smpte) {
70                 subtitle->set_subtitle_language (smpte->language().get_value_or (""));
71                 _frame_rate = smpte->edit_rate().numerator;
72         }
73
74         _length = ContentTime::from_seconds (sc->latest_subtitle_out().as_seconds ());
75
76         BOOST_FOREACH (shared_ptr<dcp::LoadFontNode> i, sc->load_font_nodes ()) {
77                 subtitle->add_font (shared_ptr<Font> (new Font (i->id)));
78         }
79 }
80
81 DCPTime
82 DCPSubtitleContent::full_length () const
83 {
84         FrameRateChange const frc (subtitle_video_frame_rate(), film()->video_frame_rate());
85         return DCPTime (_length, frc);
86 }
87
88 string
89 DCPSubtitleContent::summary () const
90 {
91         return path_summary() + " " + _("[subtitles]");
92 }
93
94 string
95 DCPSubtitleContent::technical_summary () const
96 {
97         return Content::technical_summary() + " - " + _("DCP XML subtitles");
98 }
99
100 void
101 DCPSubtitleContent::as_xml (xmlpp::Node* node) const
102 {
103         node->add_child("Type")->add_child_text ("DCPSubtitle");
104         Content::as_xml (node);
105         subtitle->as_xml (node);
106         node->add_child("Length")->add_child_text (raw_convert<string> (_length.get ()));
107 }
108
109 void
110 DCPSubtitleContent::set_subtitle_video_frame_rate (int r)
111 {
112         {
113                 boost::mutex::scoped_lock lm (_mutex);
114                 _frame_rate = r;
115         }
116
117         signal_changed (SubtitleContentProperty::SUBTITLE_VIDEO_FRAME_RATE);
118 }
119
120 double
121 DCPSubtitleContent::subtitle_video_frame_rate () const
122 {
123         {
124                 boost::mutex::scoped_lock lm (_mutex);
125                 if (_frame_rate) {
126                         return _frame_rate.get ();
127                 }
128         }
129
130         /* No frame rate specified, so assume this content has been
131            prepared for any concurrent video content.
132         */
133         return film()->active_frame_rate_change(position()).source;
134 }