Basics of multiple captions per content so that DCPContent can
[dcpomatic.git] / src / lib / dcp_examiner.cc
1 /*
2     Copyright (C) 2014 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_examiner.h"
22 #include "dcp_content.h"
23 #include "exceptions.h"
24 #include "image.h"
25 #include "config.h"
26 #include <dcp/dcp.h>
27 #include <dcp/decrypted_kdm.h>
28 #include <dcp/cpl.h>
29 #include <dcp/reel.h>
30 #include <dcp/reel_picture_asset.h>
31 #include <dcp/reel_sound_asset.h>
32 #include <dcp/mono_picture_asset.h>
33 #include <dcp/mono_picture_asset_reader.h>
34 #include <dcp/mono_picture_frame.h>
35 #include <dcp/stereo_picture_asset.h>
36 #include <dcp/stereo_picture_asset_reader.h>
37 #include <dcp/stereo_picture_frame.h>
38 #include <dcp/sound_asset.h>
39 #include <dcp/sound_asset_reader.h>
40 #include <dcp/subtitle_asset.h>
41 #include <dcp/reel_subtitle_asset.h>
42 #include <dcp/reel_closed_caption_asset.h>
43 #include <dcp/sound_asset.h>
44 #include <boost/foreach.hpp>
45 #include <iostream>
46
47 #include "i18n.h"
48
49 using std::list;
50 using std::cout;
51 using std::runtime_error;
52 using boost::shared_ptr;
53 using boost::dynamic_pointer_cast;
54
55 DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content)
56         : DCP (content)
57         , _video_length (0)
58         , _audio_length (0)
59         , _has_video (false)
60         , _has_audio (false)
61         , _captions (0)
62         , _encrypted (false)
63         , _needs_assets (false)
64         , _kdm_valid (false)
65         , _three_d (false)
66 {
67         shared_ptr<dcp::CPL> cpl;
68
69         if (content->cpl ()) {
70                 /* Use the CPL that the content was using before */
71                 BOOST_FOREACH (shared_ptr<dcp::CPL> i, cpls()) {
72                         if (i->id() == content->cpl().get()) {
73                                 cpl = i;
74                         }
75                 }
76         } else {
77                 /* Choose the CPL with the fewest unsatisfied references */
78
79                 int least_unsatisfied = INT_MAX;
80
81                 BOOST_FOREACH (shared_ptr<dcp::CPL> i, cpls()) {
82                         int unsatisfied = 0;
83                         BOOST_FOREACH (shared_ptr<dcp::Reel> j, i->reels()) {
84                                 if (j->main_picture() && !j->main_picture()->asset_ref().resolved()) {
85                                         ++unsatisfied;
86                                 }
87                                 if (j->main_sound() && !j->main_sound()->asset_ref().resolved()) {
88                                         ++unsatisfied;
89                                 }
90                                 if (j->main_subtitle() && !j->main_subtitle()->asset_ref().resolved()) {
91                                         ++unsatisfied;
92                                 }
93                         }
94
95                         if (unsatisfied < least_unsatisfied) {
96                                 least_unsatisfied = unsatisfied;
97                                 cpl = i;
98                         }
99                 }
100         }
101
102         if (!cpl) {
103                 throw DCPError ("No CPLs found in DCP");
104         }
105
106         _cpl = cpl->id ();
107         _name = cpl->content_title_text ();
108
109         BOOST_FOREACH (shared_ptr<dcp::Reel> i, cpl->reels()) {
110
111                 if (i->main_picture ()) {
112                         if (!i->main_picture()->asset_ref().resolved()) {
113                                 /* We are missing this asset so we can't continue; examination will be repeated later */
114                                 _needs_assets = true;
115                                 return;
116                         }
117
118                         dcp::Fraction const frac = i->main_picture()->edit_rate ();
119                         float const fr = float(frac.numerator) / frac.denominator;
120                         if (!_video_frame_rate) {
121                                 _video_frame_rate = fr;
122                         } else if (_video_frame_rate.get() != fr) {
123                                 throw DCPError (_("Mismatched frame rates in DCP"));
124                         }
125
126                         _has_video = true;
127                         shared_ptr<dcp::PictureAsset> asset = i->main_picture()->asset ();
128                         if (!_video_size) {
129                                 _video_size = asset->size ();
130                         } else if (_video_size.get() != asset->size ()) {
131                                 throw DCPError (_("Mismatched video sizes in DCP"));
132                         }
133
134                         _video_length += i->main_picture()->duration();
135                 }
136
137                 if (i->main_sound ()) {
138                         if (!i->main_sound()->asset_ref().resolved()) {
139                                 /* We are missing this asset so we can't continue; examination will be repeated later */
140                                 _needs_assets = true;
141                                 return;
142                         }
143
144                         _has_audio = true;
145                         shared_ptr<dcp::SoundAsset> asset = i->main_sound()->asset ();
146
147                         if (!_audio_channels) {
148                                 _audio_channels = asset->channels ();
149                         } else if (_audio_channels.get() != asset->channels ()) {
150                                 throw DCPError (_("Mismatched audio channel counts in DCP"));
151                         }
152
153                         if (!_audio_frame_rate) {
154                                 _audio_frame_rate = asset->sampling_rate ();
155                         } else if (_audio_frame_rate.get() != asset->sampling_rate ()) {
156                                 throw DCPError (_("Mismatched audio sample rates in DCP"));
157                         }
158
159                         _audio_length += i->main_sound()->duration();
160                 }
161
162                 if (i->main_subtitle ()) {
163                         if (!i->main_subtitle()->asset_ref().resolved()) {
164                                 /* We are missing this asset so we can't continue; examination will be repeated later */
165                                 _needs_assets = true;
166                                 return;
167                         }
168
169                         ++_captions;
170                 }
171
172                 if (i->closed_caption ()) {
173                         if (!i->closed_caption()->asset_ref().resolved()) {
174                                 /* We are missing this asset so we can't continue; examination will be repeated later */
175                                 _needs_assets = true;
176                                 return;
177                         }
178
179                         ++_captions;
180                 }
181
182                 if (i->main_picture()) {
183                         _reel_lengths.push_back (i->main_picture()->duration());
184                 } else if (i->main_sound()) {
185                         _reel_lengths.push_back (i->main_sound()->duration());
186                 } else if (i->main_subtitle()) {
187                         _reel_lengths.push_back (i->main_subtitle()->duration());
188                 } else if (i->closed_caption()) {
189                         _reel_lengths.push_back (i->closed_caption()->duration());
190                 }
191         }
192
193         _encrypted = cpl->encrypted ();
194         _kdm_valid = true;
195
196         /* Check that we can read the first picture, sound and subtitle frames of each reel */
197         try {
198                 BOOST_FOREACH (shared_ptr<dcp::Reel> i, cpl->reels()) {
199                         shared_ptr<dcp::PictureAsset> pic = i->main_picture()->asset ();
200                         shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (pic);
201                         shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (pic);
202
203                         if (mono) {
204                                 mono->start_read()->get_frame(0)->xyz_image ();
205                         } else {
206                                 stereo->start_read()->get_frame(0)->xyz_image (dcp::EYE_LEFT);
207                         }
208
209                         if (i->main_sound()) {
210                                 shared_ptr<dcp::SoundAsset> sound = i->main_sound()->asset ();
211                                 i->main_sound()->asset()->start_read()->get_frame(0);
212                         }
213
214                         if (i->main_subtitle()) {
215                                 i->main_subtitle()->asset()->subtitles ();
216                         }
217                 }
218         } catch (dcp::DCPReadError& e) {
219                 _kdm_valid = false;
220         } catch (dcp::MiscError& e) {
221                 _kdm_valid = false;
222         }
223
224         DCPOMATIC_ASSERT (cpl->standard ());
225         _standard = cpl->standard().get();
226         _three_d = !cpl->reels().empty() && cpl->reels().front()->main_picture() &&
227                 dynamic_pointer_cast<dcp::StereoPictureAsset> (cpl->reels().front()->main_picture()->asset());
228
229         _cpl = cpl->id ();
230 }