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