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 /** @file  src/subtitle.cc
  21  *  @brief Representations of subtitles.
  22  */
  23
  24 #include "subtitle.h"
  25 #include "image.h"
  26 #include "exceptions.h"
  27
  28 using namespace std;
  29 using namespace boost;
  30 using libdcp::Size;
  31
  32 /** Construct a TimedSubtitle.  This is a subtitle image, position,
  33  *  and a range of time over which it should be shown.
  34  *  @param sub AVSubtitle to read.
  35  */
  36 TimedSubtitle::TimedSubtitle (AVSubtitle const & sub)
  37 {
  38         assert (sub.rects > 0);
  39
  40         /* Subtitle PTS in seconds (within the source, not taking into account any of the
  41            source that we may have chopped off for the DCP)
  42         */
  43         double const packet_time = static_cast<double> (sub.pts) / AV_TIME_BASE;
  44
  45         /* hence start time for this sub */
  46         _from = packet_time + (double (sub.start_display_time) / 1e3);
  47         _to = packet_time + (double (sub.end_display_time) / 1e3);
  48
  49         if (sub.num_rects > 1) {
  50                 throw DecodeError ("multi-part subtitles not yet supported");
  51         }
  52
  53         AVSubtitleRect const * rect = sub.rects[0];
  54
  55         if (rect->type != SUBTITLE_BITMAP) {
  56                 throw DecodeError ("non-bitmap subtitles not yet supported");
  57         }
  58
  59         shared_ptr<Image> image (new SimpleImage (PIX_FMT_RGBA, libdcp::Size (rect->w, rect->h), true));
  60
  61         /* Start of the first line in the subtitle */
  62         uint8_t* sub_p = rect->pict.data[0];
  63         /* sub_p looks up into a RGB palette which is here */
  64         uint32_t const * palette = (uint32_t *) rect->pict.data[1];
  65         /* Start of the output data */
  66         uint32_t* out_p = (uint32_t *) image->data()[0];
  67
  68         for (int y = 0; y < rect->h; ++y) {
  69                 uint8_t* sub_line_p = sub_p;
  70                 uint32_t* out_line_p = out_p;
  71                 for (int x = 0; x < rect->w; ++x) {
  72                         *out_line_p++ = palette[*sub_line_p++];
  73                 }
  74                 sub_p += rect->pict.linesize[0];
  75                 out_p += image->stride()[0] / sizeof (uint32_t);
  76         }
  77
  78         _subtitle.reset (new Subtitle (Position (rect->x, rect->y), image));
  79 }
  80
  81 /** @param t Time in seconds from the start of the source */
  82 bool
  83 TimedSubtitle::displayed_at (double t) const
  84 {
  85         return t >= _from && t <= _to;
  86 }
  87
  88 /** Construct a subtitle, which is an image and a position.
  89  *  @param p Position within the (uncropped) source frame.
  90  *  @param i Image of the subtitle (should be RGBA).
  91  */
  92 Subtitle::Subtitle (Position p, shared_ptr<Image> i)
  93         : _position (p)
  94         , _image (i)
  95 {
  96
  97 }
  98
  99 /** Given the area of a subtitle, work out the area it should
 100  *  take up when its video frame is scaled up, and it is optionally
 101  *  itself scaled and offset.
 102  *  @param target_x_scale the x scaling of the video frame that the subtitle is in.
 103  *  @param target_y_scale the y scaling of the video frame that the subtitle is in.
 104  *  @param sub_area The area of the subtitle within the original source.
 105  *  @param subtitle_offset y offset to apply to the subtitle position (+ve is down)
 106  *  in the coordinate space of the source.
 107  *  @param subtitle_scale scaling factor to apply to the subtitle image.
 108  */
 109 Rect
 110 subtitle_transformed_area (
 111         float target_x_scale, float target_y_scale,
 112         Rect sub_area, int subtitle_offset, float subtitle_scale
 113         )
 114 {
 115         Rect tx;
 116
 117         sub_area.y += subtitle_offset;
 118
 119         /* We will scale the subtitle by the same amount as the video frame, and also by the additional
 120            subtitle_scale
 121         */
 122         tx.width = sub_area.width * target_x_scale * subtitle_scale;
 123         tx.height = sub_area.height * target_y_scale * subtitle_scale;
 124
 125         /* Then we need a corrective translation, consisting of two parts:
 126          *
 127          * 1.  that which is the result of the scaling of the subtitle by target_x_scale and target_y_scale; this will be
 128          *     sub_area.x * target_x_scale and sub_area.y * target_y_scale.
 129          *
 130          * 2.  that to shift the origin of the scale by subtitle_scale to the centre of the subtitle; this will be
 131          *     (width_before_subtitle_scale * (1 - subtitle_scale) / 2) and
 132          *     (height_before_subtitle_scale * (1 - subtitle_scale) / 2).
 133          *
 134          * Combining these two translations gives these expressions.
 135          */
 136
 137         tx.x = target_x_scale * (sub_area.x + (sub_area.width * (1 - subtitle_scale) / 2));
 138         tx.y = target_y_scale * (sub_area.y + (sub_area.height * (1 - subtitle_scale) / 2));
 139
 140         return tx;
 141 }
 142
 143 /** @return area that this subtitle takes up, in the original uncropped source's coordinate space */
 144 Rect
 145 Subtitle::area () const
 146 {
 147         return Rect (_position.x, _position.y, _image->size().width, _image->size().height);
 148 }