Make sure we use limited ("video") range data when exporting.
[dcpomatic.git] / src / lib / butler.h
1 /*
2     Copyright (C) 2016-2017 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 "video_ring_buffers.h"
22 #include "audio_ring_buffers.h"
23 #include "text_ring_buffers.h"
24 #include "audio_mapping.h"
25 #include "exception_store.h"
26 #include <boost/shared_ptr.hpp>
27 #include <boost/weak_ptr.hpp>
28 #include <boost/thread.hpp>
29 #include <boost/thread/condition.hpp>
30 #include <boost/signals2.hpp>
31 #include <boost/asio.hpp>
32
33 class Player;
34 class PlayerVideo;
35
36 class Butler : public ExceptionStore, public boost::noncopyable
37 {
38 public:
39         Butler (
40                 boost::shared_ptr<Player> player,
41                 AudioMapping map,
42                 int audio_channels,
43                 boost::function<AVPixelFormat (AVPixelFormat)> pixel_format,
44                 VideoRange video_range,
45                 bool aligned,
46                 bool fast
47                 );
48
49         ~Butler ();
50
51         void seek (dcpomatic::DCPTime position, bool accurate);
52
53         class Error {
54         public:
55                 enum Code{
56                         NONE,
57                         AGAIN,
58                         DIED,
59                         FINISHED
60                 };
61
62                 Error()
63                         : code (NONE)
64                 {}
65
66                 Code code;
67                 std::string message;
68
69                 std::string summary () const;
70         };
71
72         std::pair<boost::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> get_video (bool blocking, Error* e = 0);
73         boost::optional<dcpomatic::DCPTime> get_audio (float* out, Frame frames);
74         boost::optional<TextRingBuffers::Data> get_closed_caption ();
75
76         void disable_audio ();
77
78         std::pair<size_t, std::string> memory_used () const;
79
80 private:
81         void thread ();
82         void video (boost::shared_ptr<PlayerVideo> video, dcpomatic::DCPTime time);
83         void audio (boost::shared_ptr<AudioBuffers> audio, dcpomatic::DCPTime time, int frame_rate);
84         void text (PlayerText pt, TextType type, boost::optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period);
85         bool should_run () const;
86         void prepare (boost::weak_ptr<PlayerVideo> video);
87         void player_change (ChangeType type);
88         void seek_unlocked (dcpomatic::DCPTime position, bool accurate);
89
90         boost::shared_ptr<Player> _player;
91         boost::thread _thread;
92
93         VideoRingBuffers _video;
94         AudioRingBuffers _audio;
95         TextRingBuffers _closed_caption;
96
97         boost::thread_group _prepare_pool;
98         boost::asio::io_service _prepare_service;
99         boost::shared_ptr<boost::asio::io_service::work> _prepare_work;
100
101         /** mutex to protect _pending_seek_position, _pending_seek_accurate, _finished, _died, _stop_thread */
102         boost::mutex _mutex;
103         boost::condition _summon;
104         boost::condition _arrived;
105         boost::optional<dcpomatic::DCPTime> _pending_seek_position;
106         bool _pending_seek_accurate;
107         int _suspended;
108         bool _finished;
109         bool _died;
110         std::string _died_message;
111         bool _stop_thread;
112
113         AudioMapping _audio_mapping;
114         int _audio_channels;
115
116         bool _disable_audio;
117
118         boost::function<AVPixelFormat (AVPixelFormat)> _pixel_format;
119         VideoRange _video_range;
120         bool _aligned;
121         bool _fast;
122
123         /** If we are waiting to be refilled following a seek, this is the time we were
124             seeking to.
125         */
126         boost::optional<dcpomatic::DCPTime> _awaiting;
127
128         boost::signals2::scoped_connection _player_video_connection;
129         boost::signals2::scoped_connection _player_audio_connection;
130         boost::signals2::scoped_connection _player_text_connection;
131         boost::signals2::scoped_connection _player_change_connection;
132 };