Merge master.
[dcpomatic.git] / src / lib / player_video.h
1 /*
2     Copyright (C) 2013-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 <boost/shared_ptr.hpp>
21 #include "types.h"
22 #include "position.h"
23 #include "colour_conversion.h"
24 #include "position_image.h"
25
26 class Image;
27 class ImageProxy;
28 class Scaler;
29 class Socket;
30 class Log;
31 class EncodedData;
32
33 /** Everything needed to describe a video frame coming out of the player, but with the
34  *  bits still their raw form.  We may want to combine the bits on a remote machine,
35  *  or maybe not even bother to combine them at all.
36  */
37 class PlayerVideo
38 {
39 public:
40         PlayerVideo (boost::shared_ptr<const ImageProxy>, DCPTime, Crop, dcp::Size, dcp::Size, Scaler const *, Eyes, Part, ColourConversion);
41         PlayerVideo (boost::shared_ptr<cxml::Node>, boost::shared_ptr<Socket>, boost::shared_ptr<Log>);
42
43         void set_subtitle (PositionImage);
44         
45         boost::shared_ptr<Image> image (bool burn_subtitle) const;
46
47         void add_metadata (xmlpp::Node* node, bool send_subtitles) const;
48         void send_binary (boost::shared_ptr<Socket> socket, bool send_subtitles) const;
49
50         bool has_j2k () const;
51         boost::shared_ptr<EncodedData> j2k () const;
52
53         DCPTime time () const {
54                 return _time;
55         }
56
57         Eyes eyes () const {
58                 return _eyes;
59         }
60
61         ColourConversion colour_conversion () const {
62                 return _colour_conversion;
63         }
64
65 private:
66         boost::shared_ptr<const ImageProxy> _in;
67         DCPTime _time;
68         Crop _crop;
69         dcp::Size _inter_size;
70         dcp::Size _out_size;
71         Scaler const * _scaler;
72         Eyes _eyes;
73         Part _part;
74         ColourConversion _colour_conversion;
75         PositionImage _subtitle;
76 };