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