Some basics of AudioMapping.
[dcpomatic.git] / src / lib / ffmpeg_content.cc
1 /* -*- c-basic-offset: 8; default-tab-width: 8; -*- */
2
3 /*
4     Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
5
6     This program 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     This program 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 this program; if not, write to the Free Software
18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19
20 */
21
22 #include <libcxml/cxml.h>
23 #include "ffmpeg_content.h"
24 #include "ffmpeg_decoder.h"
25 #include "compose.hpp"
26 #include "job.h"
27 #include "util.h"
28 #include "log.h"
29
30 #include "i18n.h"
31
32 using std::string;
33 using std::stringstream;
34 using std::vector;
35 using std::list;
36 using std::cout;
37 using boost::shared_ptr;
38 using boost::lexical_cast;
39
40 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
41 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
42 int const FFmpegContentProperty::AUDIO_STREAMS = 102;
43 int const FFmpegContentProperty::AUDIO_STREAM = 103;
44
45 FFmpegContent::FFmpegContent (boost::filesystem::path f)
46         : Content (f)
47         , VideoContent (f)
48         , AudioContent (f)
49 {
50
51 }
52
53 FFmpegContent::FFmpegContent (shared_ptr<const cxml::Node> node)
54         : Content (node)
55         , VideoContent (node)
56         , AudioContent (node)
57 {
58         list<shared_ptr<cxml::Node> > c = node->node_children ("SubtitleStream");
59         for (list<shared_ptr<cxml::Node> >::const_iterator i = c.begin(); i != c.end(); ++i) {
60                 _subtitle_streams.push_back (FFmpegSubtitleStream (*i));
61                 if ((*i)->optional_number_child<int> ("Selected")) {
62                         _subtitle_stream = _subtitle_streams.back ();
63                 }
64         }
65
66         c = node->node_children ("AudioStream");
67         for (list<shared_ptr<cxml::Node> >::const_iterator i = c.begin(); i != c.end(); ++i) {
68                 _audio_streams.push_back (FFmpegAudioStream (*i));
69                 if ((*i)->optional_number_child<int> ("Selected")) {
70                         _audio_stream = _audio_streams.back ();
71                 }
72         }
73 }
74
75 FFmpegContent::FFmpegContent (FFmpegContent const & o)
76         : Content (o)
77         , VideoContent (o)
78         , AudioContent (o)
79         , _subtitle_streams (o._subtitle_streams)
80         , _subtitle_stream (o._subtitle_stream)
81         , _audio_streams (o._audio_streams)
82         , _audio_stream (o._audio_stream)
83 {
84
85 }
86
87 void
88 FFmpegContent::as_xml (xmlpp::Node* node) const
89 {
90         node->add_child("Type")->add_child_text ("FFmpeg");
91         Content::as_xml (node);
92         VideoContent::as_xml (node);
93         AudioContent::as_xml (node);
94
95         boost::mutex::scoped_lock lm (_mutex);
96
97         for (vector<FFmpegSubtitleStream>::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
98                 xmlpp::Node* t = node->add_child("SubtitleStream");
99                 if (_subtitle_stream && *i == _subtitle_stream.get()) {
100                         t->add_child("Selected")->add_child_text("1");
101                 }
102                 i->as_xml (t);
103         }
104
105         for (vector<FFmpegAudioStream>::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
106                 xmlpp::Node* t = node->add_child("AudioStream");
107                 if (_audio_stream && *i == _audio_stream.get()) {
108                         t->add_child("Selected")->add_child_text("1");
109                 }
110                 i->as_xml (t);
111         }
112 }
113
114 void
115 FFmpegContent::examine (shared_ptr<Film> film, shared_ptr<Job> job, bool quick)
116 {
117         job->set_progress_unknown ();
118
119         Content::examine (film, job, quick);
120
121         shared_ptr<FFmpegDecoder> decoder (new FFmpegDecoder (film, shared_from_this (), true, false, false));
122
123         ContentVideoFrame video_length = 0;
124         if (quick) {
125                 video_length = decoder->video_length ();
126                 film->log()->log (String::compose ("Video length obtained from header as %1 frames", decoder->video_length ()));
127         } else {
128                 while (!decoder->pass ()) {
129                         /* keep going */
130                 }
131
132                 video_length = decoder->video_frame ();
133                 film->log()->log (String::compose ("Video length examined as %1 frames", decoder->video_frame ()));
134         }
135
136         {
137                 boost::mutex::scoped_lock lm (_mutex);
138
139                 _video_length = video_length;
140
141                 _subtitle_streams = decoder->subtitle_streams ();
142                 if (!_subtitle_streams.empty ()) {
143                         _subtitle_stream = _subtitle_streams.front ();
144                 }
145                 
146                 _audio_streams = decoder->audio_streams ();
147                 if (!_audio_streams.empty ()) {
148                         _audio_stream = _audio_streams.front ();
149                 }
150         }
151
152         take_from_video_decoder (decoder);
153
154         signal_changed (VideoContentProperty::VIDEO_LENGTH);
155         signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
156         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
157         signal_changed (FFmpegContentProperty::AUDIO_STREAMS);
158         signal_changed (FFmpegContentProperty::AUDIO_STREAM);
159         signal_changed (AudioContentProperty::AUDIO_CHANNELS);
160 }
161
162 string
163 FFmpegContent::summary () const
164 {
165         return String::compose (_("Movie: %1"), file().filename().string());
166 }
167
168 string
169 FFmpegContent::information () const
170 {
171         if (video_length() == 0 || video_frame_rate() == 0) {
172                 return "";
173         }
174         
175         stringstream s;
176         
177         s << String::compose (_("%1 frames; %2 frames per second"), video_length(), video_frame_rate()) << "\n";
178         s << VideoContent::information ();
179
180         return s.str ();
181 }
182
183 void
184 FFmpegContent::set_subtitle_stream (FFmpegSubtitleStream s)
185 {
186         {
187                 boost::mutex::scoped_lock lm (_mutex);
188                 _subtitle_stream = s;
189         }
190
191         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
192 }
193
194 void
195 FFmpegContent::set_audio_stream (FFmpegAudioStream s)
196 {
197         {
198                 boost::mutex::scoped_lock lm (_mutex);
199                 _audio_stream = s;
200         }
201
202         signal_changed (FFmpegContentProperty::AUDIO_STREAM);
203 }
204
205 ContentAudioFrame
206 FFmpegContent::audio_length () const
207 {
208         if (!_audio_stream) {
209                 return 0;
210         }
211         
212         return video_frames_to_audio_frames (_video_length, content_audio_frame_rate(), video_frame_rate());
213 }
214
215 int
216 FFmpegContent::audio_channels () const
217 {
218         if (!_audio_stream) {
219                 return 0;
220         }
221
222         return _audio_stream->channels;
223 }
224
225 int
226 FFmpegContent::content_audio_frame_rate () const
227 {
228         if (!_audio_stream) {
229                 return 0;
230         }
231
232         return _audio_stream->frame_rate;
233 }
234
235 int
236 FFmpegContent::output_audio_frame_rate (shared_ptr<const Film> film) const
237 {
238         /* Resample to a DCI-approved sample rate */
239         double t = dcp_audio_frame_rate (content_audio_frame_rate ());
240
241         FrameRateConversion frc (video_frame_rate(), film->dcp_video_frame_rate());
242
243         /* Compensate if the DCP is being run at a different frame rate
244            to the source; that is, if the video is run such that it will
245            look different in the DCP compared to the source (slower or faster).
246            skip/repeat doesn't come into effect here.
247         */
248
249         if (frc.change_speed) {
250                 t *= video_frame_rate() * frc.factor() / film->dcp_video_frame_rate();
251         }
252
253         return rint (t);
254 }
255
256 bool
257 operator== (FFmpegSubtitleStream const & a, FFmpegSubtitleStream const & b)
258 {
259         return a.id == b.id;
260 }
261
262 bool
263 operator== (FFmpegAudioStream const & a, FFmpegAudioStream const & b)
264 {
265         return a.id == b.id;
266 }
267
268 FFmpegAudioStream::FFmpegAudioStream (shared_ptr<const cxml::Node> node)
269         : mapping (node->node_child ("Mapping"))
270 {
271         name = node->string_child ("Name");
272         id = node->number_child<int> ("Id");
273         frame_rate = node->number_child<int> ("FrameRate");
274         channels = node->number_child<int64_t> ("Channels");
275 }
276
277 void
278 FFmpegAudioStream::as_xml (xmlpp::Node* root) const
279 {
280         root->add_child("Name")->add_child_text (name);
281         root->add_child("Id")->add_child_text (lexical_cast<string> (id));
282         root->add_child("FrameRate")->add_child_text (lexical_cast<string> (frame_rate));
283         root->add_child("Channels")->add_child_text (lexical_cast<string> (channels));
284         mapping.as_xml (root->add_child("Mapping"));
285 }
286
287 /** Construct a SubtitleStream from a value returned from to_string().
288  *  @param t String returned from to_string().
289  *  @param v State file version.
290  */
291 FFmpegSubtitleStream::FFmpegSubtitleStream (shared_ptr<const cxml::Node> node)
292 {
293         name = node->string_child ("Name");
294         id = node->number_child<int> ("Id");
295 }
296
297 void
298 FFmpegSubtitleStream::as_xml (xmlpp::Node* root) const
299 {
300         root->add_child("Name")->add_child_text (name);
301         root->add_child("Id")->add_child_text (lexical_cast<string> (id));
302 }
303
304 shared_ptr<Content>
305 FFmpegContent::clone () const
306 {
307         return shared_ptr<Content> (new FFmpegContent (*this));
308 }
309
310 Time
311 FFmpegContent::length (shared_ptr<const Film> film) const
312 {
313         FrameRateConversion frc (video_frame_rate (), film->dcp_video_frame_rate ());
314         return video_length() * frc.factor() * TIME_HZ / film->dcp_video_frame_rate ();
315 }
316
317 AudioMapping
318 FFmpegContent::audio_mapping () const
319 {
320         if (!_audio_stream) {
321                 return AudioMapping ();
322         }
323         
324         return _audio_stream->mapping;
325 }