Comment; fix up UI for subtitle scaling.
[dcpomatic.git] / src / lib / subtitle.cc
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 "subtitle.h"
21 #include "image.h"
22 #include "exceptions.h"
23 #include "film_state.h"
24
25 using namespace std;
26 using namespace boost;
27
28 Subtitle::Subtitle (AVSubtitle const & sub)
29 {
30         /* subtitle PTS in seconds */
31         float const packet_time = (sub.pts / AV_TIME_BASE) + float (sub.pts % AV_TIME_BASE) / 1e6;
32         
33         /* hence start time for this sub */
34         _from = packet_time + (double (sub.start_display_time) / 1e3);
35         _to = packet_time + (double (sub.end_display_time) / 1e3);
36
37         for (unsigned int i = 0; i < sub.num_rects; ++i) {
38                 _images.push_back (shared_ptr<SubtitleImage> (new SubtitleImage (sub.rects[i])));
39         }
40 }
41
42 /** @param t Time in seconds from the start of the film */
43 bool
44 Subtitle::displayed_at (double t)
45 {
46         return t >= _from && t <= _to;
47 }
48
49 SubtitleImage::SubtitleImage (AVSubtitleRect const * rect)
50         : _position (rect->x, rect->y)
51         , _image (new SimpleImage (PIX_FMT_RGBA, Size (rect->w, rect->h)))
52 {
53         if (rect->type != SUBTITLE_BITMAP) {
54                 throw DecodeError ("non-bitmap subtitles not yet supported");
55         }
56
57         /* Start of the first line in the subtitle */
58         uint8_t* sub_p = rect->pict.data[0];
59         /* sub_p looks up into a RGB palette which is here */
60         uint32_t const * palette = (uint32_t *) rect->pict.data[1];
61         /* Start of the output data */
62         uint32_t* out_p = (uint32_t *) _image->data()[0];
63         
64         for (int y = 0; y < rect->h; ++y) {
65                 uint8_t* sub_line_p = sub_p;
66                 for (int x = 0; x < rect->w; ++x) {
67                         *out_p++ = palette[*sub_line_p++];
68                 }
69                 sub_p += rect->pict.linesize[0];
70         }
71 }
72
73 SubtitleTransform
74 subtitle_transform (
75         int target_base_width, int target_base_height,
76         float target_x_scale, float target_y_scale,
77         Position sub_pos, int sub_width, int sub_height,
78         shared_ptr<FilmState> fs
79         )
80 {
81         SubtitleTransform tx;
82
83         /* The area of the original subtitle, in the coordinate space of the source video frame */
84         Rectangle sub_area (sub_pos.x, sub_pos.y + fs->subtitle_offset, sub_width, sub_height);
85
86         /* The cropped area of the source video frame, in the same coordinate space */
87         Rectangle cropped_target_area (
88                 fs->crop.left,
89                 fs->crop.top,
90                 target_base_width - (fs->crop.left + fs->crop.right),
91                 target_base_height - (fs->crop.top + fs->crop.bottom)
92                 );
93
94         /* Hence the area of the cropped subtitle, in the same coordinate space */
95         Rectangle cropped_sub_area = sub_area.intersection (cropped_target_area);
96
97         /* The crop that should be applied to the subtitle, in its coordinate space */
98         tx.crop.x = cropped_sub_area.x - sub_area.x;
99         tx.crop.y = cropped_sub_area.y - sub_area.y;
100         tx.crop.w = cropped_sub_area.w;
101         tx.crop.h = cropped_sub_area.h;
102
103         /* We will scale the subtitle by the same amount as the video frame, and also by the additional
104            subtitle_scale
105         */
106         tx.transformed.w = cropped_sub_area.w * target_x_scale * fs->subtitle_scale;
107         tx.transformed.h = cropped_sub_area.h * target_y_scale * fs->subtitle_scale;
108
109         /* Then we need a corrective translation, consisting of two parts:
110          *
111          * 1.  that which is the result of the scaling of the subtitle by target_x_scale and target_y_scale; this will be
112          *     (sub_area.x - fs->crop_left) * target_x_scale and (sub_area.y - fs->crop_top) * target_y_scale.
113          *
114          * 2.  that to shift the origin of the scale by fs->subtitle_scale to the centre of the subtitle; this will be
115          *     (width_before_subtitle_scale * (1 - fs->subtitle_scale) / 2) and
116          *     (height_before_subtitle_scale * (1 - fs->subtitle_scale) / 2).
117          *
118          * Combining these two translations gives these expressions.
119          */
120         
121         tx.transformed.x = target_x_scale * ((sub_area.x - fs->crop.left) + (cropped_sub_area.w * (1 - fs->subtitle_scale) / 2));
122         tx.transformed.y = target_y_scale * ((sub_area.y - fs->crop.top) + (cropped_sub_area.h * (1 - fs->subtitle_scale) / 2));
123
124         return tx;
125 }