Merge master.
[dcpomatic.git] / src / lib / video_decoder.cc
1 /*
2     Copyright (C) 2012-2014 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 "video_decoder.h"
21 #include "image.h"
22 #include "content_video.h"
23
24 #include "i18n.h"
25
26 using std::cout;
27 using std::list;
28 using boost::shared_ptr;
29 using boost::optional;
30
31 VideoDecoder::VideoDecoder (shared_ptr<const VideoContent> c)
32 #ifdef DCPOMATIC_DEBUG
33         : test_gaps (0)
34         , _video_content (c)
35 #else
36         : _video_content (c)
37 #endif
38 {
39
40 }
41
42 list<ContentVideo>
43 VideoDecoder::decoded_video (VideoFrame frame)
44 {
45         list<ContentVideo> output;
46         
47         for (list<ContentVideo>::const_iterator i = _decoded_video.begin(); i != _decoded_video.end(); ++i) {
48                 if (i->frame == frame) {
49                         output.push_back (*i);
50                 }
51         }
52
53         return output;
54 }
55
56 /** Get all frames which exist in the content at a given frame index.
57  *  @param frame Frame index.
58  *  @param accurate true to try hard to return frames at the precise time that was requested, otherwise frames nearby may be returned.
59  *  @return Frames; there may be none (if there is no video there), 1 for 2D or 2 for 3D.
60  */
61 list<ContentVideo>
62 VideoDecoder::get_video (VideoFrame frame, bool accurate)
63 {
64         if (_decoded_video.empty() || (frame < _decoded_video.front().frame || frame > (_decoded_video.back().frame + 1))) {
65                 /* Either we have no decoded data, or what we do have is a long way from what we want: seek */
66                 seek (ContentTime::from_frames (frame, _video_content->video_frame_rate()), accurate);
67         }
68
69         list<ContentVideo> dec;
70
71         /* Now enough pass() calls should either:
72          *  (a) give us what we want, or
73          *  (b) hit the end of the decoder.
74          */
75         if (accurate) {
76                 /* We are being accurate, so we want the right frame.
77                  * This could all be one statement but it's split up for clarity.
78                  */
79                 while (true) {
80                         if (!decoded_video(frame).empty ()) {
81                                 /* We got what we want */
82                                 break;
83                         }
84
85                         if (pass ()) {
86                                 /* The decoder has nothing more for us */
87                                 break;
88                         }
89
90                         if (!_decoded_video.empty() && _decoded_video.front().frame > frame) {
91                                 /* We're never going to get the frame we want.  Perhaps the caller is asking
92                                  * for a video frame before the content's video starts (if its audio
93                                  * begins before its video, for example).
94                                  */
95                                 break;
96                         }
97                 }
98
99                 dec = decoded_video (frame);
100         } else {
101                 /* Any frame will do: use the first one that comes out of pass() */
102                 while (_decoded_video.empty() && !pass ()) {}
103                 if (!_decoded_video.empty ()) {
104                         dec.push_back (_decoded_video.front ());
105                 }
106         }
107
108         /* Clean up decoded_video */
109         while (!_decoded_video.empty() && _decoded_video.front().frame < (frame - 1)) {
110                 _decoded_video.pop_front ();
111         }
112
113         return dec;
114 }
115
116
117 /** Called by subclasses when they have a video frame ready */
118 void
119 VideoDecoder::video (shared_ptr<const ImageProxy> image, VideoFrame frame)
120 {
121         /* We should not receive the same thing twice */
122         assert (_decoded_video.empty() || frame != _decoded_video.back().frame);
123
124         /* Fill in gaps */
125         /* XXX: 3D */
126
127         while (!_decoded_video.empty () && (_decoded_video.back().frame + 1) < frame) {
128 #ifdef DCPOMATIC_DEBUG
129                 test_gaps++;
130 #endif
131                 _decoded_video.push_back (
132                         ContentVideo (
133                                 _decoded_video.back().image,
134                                 _decoded_video.back().eyes,
135                                 _decoded_video.back().part,
136                                 _decoded_video.back().frame + 1
137                                 )
138                         );
139         }
140         
141         switch (_video_content->video_frame_type ()) {
142         case VIDEO_FRAME_TYPE_2D:
143                 _decoded_video.push_back (ContentVideo (image, EYES_BOTH, PART_WHOLE, frame));
144                 break;
145         case VIDEO_FRAME_TYPE_3D_ALTERNATE:
146                 _decoded_video.push_back (ContentVideo (image, (frame % 2) ? EYES_RIGHT : EYES_LEFT, PART_WHOLE, frame));
147                 break;
148         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
149                 _decoded_video.push_back (ContentVideo (image, EYES_LEFT, PART_LEFT_HALF, frame));
150                 _decoded_video.push_back (ContentVideo (image, EYES_RIGHT, PART_RIGHT_HALF, frame));
151                 break;
152         case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
153                 _decoded_video.push_back (ContentVideo (image, EYES_LEFT, PART_TOP_HALF, frame));
154                 _decoded_video.push_back (ContentVideo (image, EYES_RIGHT, PART_BOTTOM_HALF, frame));
155                 break;
156         case VIDEO_FRAME_TYPE_3D_LEFT:
157                 _decoded_video.push_back (ContentVideo (image, EYES_LEFT, PART_WHOLE, frame));
158                 break;
159         case VIDEO_FRAME_TYPE_3D_RIGHT:
160                 _decoded_video.push_back (ContentVideo (image, EYES_RIGHT, PART_WHOLE, frame));
161                 break;
162         default:
163                 assert (false);
164         }
165 }
166
167 void
168 VideoDecoder::seek (ContentTime, bool)
169 {
170         _decoded_video.clear ();
171 }
172