Merge master.
[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 #ifndef DCPOMATIC_IMAGE_SUBTITLE_H
21 #define DCPOMATIC_IMAGE_SUBTITLE_H
22
23 #include "rect.h"
24
25 class Image;
26
27 class ImageSubtitle
28 {
29 public:
30         ImageSubtitle (boost::shared_ptr<Image> i, dcpomatic::Rect<double> r)
31                 : image (i)
32                 , rectangle (r)
33         {}
34         
35         boost::shared_ptr<Image> image;
36         /** Area that the subtitle covers on its corresponding video, expressed in
37          *  proportions of the image size; e.g. rectangle.x = 0.5 would mean that
38          *  the rectangle starts half-way across the video.
39          *
40          *  This rectangle may or may not have had a SubtitleContent's offsets and
41          *  scale applied to it, depending on context.
42          */
43         dcpomatic::Rect<double> rectangle;
44 };
45
46 #endif