Clean up subtitle classes a bit.
[dcpomatic.git] / src / lib / subtitle.h
1 /*
2     Copyright (C) 2012 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 <list>
21 #include <boost/shared_ptr.hpp>
22 #include "util.h"
23
24 struct AVSubtitle;
25 class Image;
26
27 class Subtitle
28 {
29 public:
30         Subtitle (Position p, boost::shared_ptr<Image> i);
31
32         void set_position (Position p) {
33                 _position = p;
34         }
35
36         Position position () const {
37                 return _position;
38         }
39         
40         boost::shared_ptr<Image> image () const {
41                 return _image;
42         }
43
44         Rectangle area () const;
45         
46 private:
47         Position _position;
48         boost::shared_ptr<Image> _image;
49 };
50
51 Rectangle
52 subtitle_transformed_area (
53         float target_x_scale, float target_y_scale,
54         Rectangle sub_area, int subtitle_offset, float subtitle_scale
55         );
56         
57 class TimedSubtitle
58 {
59 public:
60         TimedSubtitle (AVSubtitle const &);
61
62         bool displayed_at (double t) const;
63         
64         boost::shared_ptr<Subtitle> subtitle () const {
65                 return _subtitle;
66         }
67
68 private:
69         boost::shared_ptr<Subtitle> _subtitle;
70         
71         /** display from time in seconds from the start of the film */
72         double _from;
73         /** display to time in seconds from the start of the film */
74         double _to;
75 };