Rearrange Player subtitle handling a bit.
[dcpomatic.git] / src / lib / image_subtitle.h
1 /*
2     Copyright (C) 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 class Image;
21
22 class ImageSubtitle
23 {
24 public:
25         ImageSubtitle (boost::shared_ptr<Image> i, dcpomatic::Rect<double> r)
26                 : image (i)
27                 , rectangle (r)
28         {}
29         
30         boost::shared_ptr<Image> image;
31         /** Area that the subtitle covers on its corresponding video, expressed in
32          *  proportions of the image size; e.g. rectangle.x = 0.5 would mean that
33          *  the rectangle starts half-way across the video.
34          *
35          *  This rectangle may or may not have had a SubtitleContent's offsets and
36          *  scale applied to it, depending on context.
37          */
38         dcpomatic::Rect<double> rectangle;
39 };