Rename PlayerImage to PlayerVideoFrame and give it its own file.
[dcpomatic.git] / src / lib / player_video_frame.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
24 class Image;
25 class Scaler;
26
27 /** Everything needed to describe a video frame coming out of the player, but with the
28  *  bits still their raw form.  We may want to combine the bits on a remote machine,
29  *  or maybe not even bother to combine them at all.
30  */
31 class PlayerVideoFrame
32 {
33 public:
34         PlayerVideoFrame (boost::shared_ptr<const Image>, Crop, libdcp::Size, libdcp::Size, Scaler const *);
35
36         void set_subtitle (boost::shared_ptr<const Image>, Position<int>);
37         
38         boost::shared_ptr<Image> image ();
39
40 private:
41         boost::shared_ptr<const Image> _in;
42         Crop _crop;
43         libdcp::Size _inter_size;
44         libdcp::Size _out_size;
45         Scaler const * _scaler;
46         boost::shared_ptr<const Image> _subtitle_image;
47         Position<int> _subtitle_position;
48 };