Give an error if 2D content is set to 3D (#1565). Also run
[dcpomatic.git] / src / lib / video_decoder.cc
index 5dd078553659b21d3c09bcf8a030ea77e73ad783..de1df727f13838563484bb9d348835c1ba248c2f 100644 (file)
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 #include "video_decoder.h"
 #include "image.h"
-#include "content_video.h"
+#include "raw_image_proxy.h"
+#include "film.h"
+#include "log.h"
+#include "compose.hpp"
+#include <boost/foreach.hpp>
+#include <iostream>
 
 #include "i18n.h"
 
 using std::cout;
 using std::list;
+using std::max;
+using std::back_inserter;
 using boost::shared_ptr;
 using boost::optional;
 
-VideoDecoder::VideoDecoder (shared_ptr<const VideoContent> c)
-#ifdef DCPOMATIC_DEBUG
-       : test_gaps (0)
-       , _video_content (c)
-#else
-       : _video_content (c)
-#endif
-       , _same (false)
-{
-
-}
-
-list<ContentVideo>
-VideoDecoder::decoded_video (VideoFrame frame)
+VideoDecoder::VideoDecoder (Decoder* parent, shared_ptr<const Content> c)
+       : DecoderPart (parent)
+       , _content (c)
 {
-       list<ContentVideo> output;
-       
-       for (list<ContentVideo>::const_iterator i = _decoded_video.begin(); i != _decoded_video.end(); ++i) {
-               if (i->frame == frame) {
-                       output.push_back (*i);
-               }
-       }
 
-       return output;
 }
 
-/** Get all frames which exist in the content at a given frame index.
- *  @param frame Frame index.
- *  @param accurate true to try hard to return frames at the precise time that was requested, otherwise frames nearby may be returned.
- *  @return Frames; there may be none (if there is no video there), 1 for 2D or 2 for 3D.
+/** Called by decoder classes when they have a video frame ready.
+ *  @param frame Frame index within the content; this does not take into account 3D
+ *  so for 3D_ALTERNATE this value goes:
+ *     0: frame 0 left
+ *     1: frame 0 right
+ *     2: frame 1 left
+ *     3: frame 1 right
+ *  and so on.
  */
-list<ContentVideo>
-VideoDecoder::get_video (VideoFrame frame, bool accurate)
-{
-       /* At this stage, if we have get_video()ed before, _decoded_video will contain the last frame that this
-          method returned (and possibly a few more).  If the requested frame is not in _decoded_video and it is not the next
-          one after the end of _decoded_video we need to seek.
-       */
-          
-       if (_decoded_video.empty() || frame < _decoded_video.front().frame || frame > (_decoded_video.back().frame + 1)) {
-               seek (ContentTime::from_frames (frame, _video_content->video_frame_rate()), accurate);
-       }
-
-       list<ContentVideo> dec;
-
-       /* Now enough pass() calls should either:
-        *  (a) give us what we want, or
-        *  (b) give us something after what we want, indicating that we will never get what we want, or
-        *  (c) hit the end of the decoder.
-        */
-       if (accurate) {
-               /* We are being accurate, so we want the right frame.
-                * This could all be one statement but it's split up for clarity.
-                */
-               while (true) {
-                       if (!decoded_video(frame).empty ()) {
-                               /* We got what we want */
-                               break;
-                       }
-
-                       if (pass ()) {
-                               /* The decoder has nothing more for us */
-                               break;
-                       }
-
-                       if (!_decoded_video.empty() && _decoded_video.front().frame > frame) {
-                               /* We're never going to get the frame we want.  Perhaps the caller is asking
-                                * for a video frame before the content's video starts (if its audio
-                                * begins before its video, for example).
-                                */
-                               break;
-                       }
-               }
-
-               dec = decoded_video (frame);
-       } else {
-               /* Any frame will do: use the first one that comes out of pass() */
-               while (_decoded_video.empty() && !pass ()) {}
-               if (!_decoded_video.empty ()) {
-                       dec.push_back (_decoded_video.front ());
-               }
-       }
-
-       /* Clean up _decoded_video; keep the frame we are returning, but nothing before that */
-       while (!_decoded_video.empty() && _decoded_video.front().frame < dec.front().frame) {
-               _decoded_video.pop_front ();
-       }
-
-       return dec;
-}
-
-
-/** Called by subclasses when they have a video frame ready */
 void
-VideoDecoder::video (shared_ptr<const ImageProxy> image, VideoFrame frame)
+VideoDecoder::emit (shared_ptr<const Film> film, shared_ptr<const ImageProxy> image, Frame frame)
 {
-       /* We may receive the same frame index twice for 3D, and we need to know
-          when that happens.
-       */
-       _same = (!_decoded_video.empty() && frame == _decoded_video.back().frame);
-
-       /* Fill in gaps */
-       /* XXX: 3D */
-
-       while (!_decoded_video.empty () && (_decoded_video.back().frame + 1) < frame) {
-#ifdef DCPOMATIC_DEBUG
-               test_gaps++;
-#endif
-               _decoded_video.push_back (
-                       ContentVideo (
-                               _decoded_video.back().image,
-                               _decoded_video.back().eyes,
-                               _decoded_video.back().part,
-                               _decoded_video.back().frame + 1
-                               )
-                       );
+       if (ignore ()) {
+               return;
        }
-       
-       switch (_video_content->video_frame_type ()) {
+
+       switch (_content->video->frame_type ()) {
        case VIDEO_FRAME_TYPE_2D:
-               _decoded_video.push_back (ContentVideo (image, EYES_BOTH, PART_WHOLE, frame));
+               Data (ContentVideo (image, frame, EYES_BOTH, PART_WHOLE));
+               break;
+       case VIDEO_FRAME_TYPE_3D:
+       {
+               /* We should receive the same frame index twice for 3D; hence we know which
+                  frame this one is.
+               */
+               bool const same = (_last_emitted_frame && _last_emitted_frame.get() == frame);
+               if (!same && _last_emitted_eyes && *_last_emitted_eyes == EYES_LEFT) {
+                       /* We just got a new frame index but the last frame was left-eye; it looks like
+                          this content is not really 3D.
+                       */
+                       boost::throw_exception (
+                               DecodeError(
+                                       String::compose(
+                                               _("The content file %1 is set as 3D but does not appear to contain 3D images.  Please set it to 2D.  "
+                                                 "You can still make a 3D DCP from this content by ticking the 3D option in the DCP video tab."),
+                                               _content->path(0)
+                                               )
+                                       )
+                               );
+               }
+               Eyes const eyes = same ? EYES_RIGHT : EYES_LEFT;
+               Data (ContentVideo (image, frame, eyes, PART_WHOLE));
+               _last_emitted_frame = frame;
+               _last_emitted_eyes = eyes;
                break;
+       }
        case VIDEO_FRAME_TYPE_3D_ALTERNATE:
-               _decoded_video.push_back (ContentVideo (image, _same ? EYES_RIGHT : EYES_LEFT, PART_WHOLE, frame));
+               Data (ContentVideo (image, frame / 2, (frame % 2) ? EYES_RIGHT : EYES_LEFT, PART_WHOLE));
+               frame /= 2;
                break;
        case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
-               _decoded_video.push_back (ContentVideo (image, EYES_LEFT, PART_LEFT_HALF, frame));
-               _decoded_video.push_back (ContentVideo (image, EYES_RIGHT, PART_RIGHT_HALF, frame));
+               Data (ContentVideo (image, frame, EYES_LEFT, PART_LEFT_HALF));
+               Data (ContentVideo (image, frame, EYES_RIGHT, PART_RIGHT_HALF));
                break;
        case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
-               _decoded_video.push_back (ContentVideo (image, EYES_LEFT, PART_TOP_HALF, frame));
-               _decoded_video.push_back (ContentVideo (image, EYES_RIGHT, PART_BOTTOM_HALF, frame));
+               Data (ContentVideo (image, frame, EYES_LEFT, PART_TOP_HALF));
+               Data (ContentVideo (image, frame, EYES_RIGHT, PART_BOTTOM_HALF));
                break;
        case VIDEO_FRAME_TYPE_3D_LEFT:
-               _decoded_video.push_back (ContentVideo (image, EYES_LEFT, PART_WHOLE, frame));
+               Data (ContentVideo (image, frame, EYES_LEFT, PART_WHOLE));
                break;
        case VIDEO_FRAME_TYPE_3D_RIGHT:
-               _decoded_video.push_back (ContentVideo (image, EYES_RIGHT, PART_WHOLE, frame));
+               Data (ContentVideo (image, frame, EYES_RIGHT, PART_WHOLE));
                break;
        default:
-               assert (false);
+               DCPOMATIC_ASSERT (false);
        }
+
+       _position = ContentTime::from_frames (frame, _content->active_video_frame_rate(film));
 }
 
 void
-VideoDecoder::seek (ContentTime, bool)
+VideoDecoder::seek ()
 {
-       _decoded_video.clear ();
+       _position = ContentTime();
+       _last_emitted_frame.reset ();
+       _last_emitted_eyes.reset ();
 }
-