DCPVideoFrame -> DCPVideo and PlayerVideoFrame -> PlayerVideo.
[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
32 /** Everything needed to describe a video frame coming out of the player, but with the
33  *  bits still their raw form.  We may want to combine the bits on a remote machine,
34  *  or maybe not even bother to combine them at all.
35  */
36 class PlayerVideo
37 {
38 public:
39         PlayerVideo (boost::shared_ptr<const ImageProxy>, Crop, dcp::Size, dcp::Size, Scaler const *, Eyes, Part, ColourConversion);
40         PlayerVideo (boost::shared_ptr<cxml::Node>, boost::shared_ptr<Socket>, boost::shared_ptr<Log>);
41
42         void set_subtitle (PositionImage);
43         
44         boost::shared_ptr<Image> image () const;
45
46         void add_metadata (xmlpp::Node* node) const;
47         void send_binary (boost::shared_ptr<Socket> socket) const;
48
49         Eyes eyes () const {
50                 return _eyes;
51         }
52
53         ColourConversion colour_conversion () const {
54                 return _colour_conversion;
55         }
56
57 private:
58         boost::shared_ptr<const ImageProxy> _in;
59         Crop _crop;
60         dcp::Size _inter_size;
61         dcp::Size _out_size;
62         Scaler const * _scaler;
63         Eyes _eyes;
64         Part _part;
65         ColourConversion _colour_conversion;
66         PositionImage _subtitle;
67 };