Move video frame rate ('prepared-for') into Content.
[dcpomatic.git] / src / lib / video_decoder.h
1 /*
2     Copyright (C) 2012-2016 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 /** @file  src/lib/video_decoder.h
21  *  @brief VideoDecoder class.
22  */
23
24 #ifndef DCPOMATIC_VIDEO_DECODER_H
25 #define DCPOMATIC_VIDEO_DECODER_H
26
27 #include "decoder.h"
28 #include "video_content.h"
29 #include "util.h"
30 #include "content_video.h"
31 #include <boost/signals2.hpp>
32 #include <boost/shared_ptr.hpp>
33
34 class VideoContent;
35 class ImageProxy;
36 class Image;
37 class Log;
38
39 /** @class VideoDecoder
40  *  @brief Parent for classes which decode video.
41  */
42 class VideoDecoder : public virtual Decoder
43 {
44 public:
45         VideoDecoder (boost::shared_ptr<const Content> c, boost::shared_ptr<Log> log);
46
47         std::list<ContentVideo> get_video (Frame frame, bool accurate);
48
49         void set_ignore_video ();
50
51 #ifdef DCPOMATIC_DEBUG
52         int test_gaps;
53 #endif
54
55 protected:
56         friend struct video_decoder_fill_test1;
57         friend struct video_decoder_fill_test2;
58         friend struct ffmpeg_pts_offset_test;
59         friend void ffmpeg_decoder_sequential_test_one (boost::filesystem::path file, float fps, int gaps, int video_length);
60
61         void seek (ContentTime time, bool accurate);
62         void video (boost::shared_ptr<const ImageProxy>, Frame frame);
63         std::list<ContentVideo> decoded_video (Frame frame);
64         void fill_one_eye (Frame from, Frame to, Eyes);
65         void fill_both_eyes (Frame from, Frame to, Eyes);
66
67         boost::shared_ptr<const Content> _video_content;
68         boost::shared_ptr<Log> _log;
69         std::list<ContentVideo> _decoded_video;
70         boost::shared_ptr<Image> _black_image;
71         boost::optional<ContentTime> _last_seek_time;
72         bool _last_seek_accurate;
73         /** true if this decoder should ignore all video; i.e. never produce any */
74         bool _ignore_video;
75         /** if set, this is a frame for which we got no data because the Decoder said
76          *  it has no more to give.
77          */
78         boost::optional<Frame> _no_data_frame;
79 };
80
81 #endif