src/lib/bitmap_text.h

   1 /*
   2     Copyright (C) 2014-2018 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_BITMAP_CAPTION_H
  22 #define DCPOMATIC_BITMAP_CAPTION_H
  23
  24 #include "rect.h"
  25 #include <libxml++/libxml++.h>
  26 #include <boost/shared_ptr.hpp>
  27
  28 class Image;
  29 class Socket;
  30
  31 class BitmapText
  32 {
  33 public:
  34         BitmapText (boost::shared_ptr<Image> i, dcpomatic::Rect<double> r)
  35                 : image (i)
  36                 , rectangle (r)
  37         {}
  38
  39         void transfer_xml (xmlpp::Node* node) const;
  40         void transfer_binary (boost::shared_ptr<Socket> socket) const;
  41
  42         boost::shared_ptr<Image> image;
  43         /** Area that the subtitle covers on its corresponding video, expressed in
  44          *  proportions of the image size; e.g. rectangle.x = 0.5 would mean that
  45          *  the rectangle starts half-way across the video.
  46          *
  47          *  This rectangle may or may not have had a TextContent's offsets and
  48          *  scale applied to it, depending on context.
  49          */
  50         dcpomatic::Rect<double> rectangle;
  51 };
  52
  53 extern bool operator== (BitmapText const & a, BitmapText const & b);
  54 extern bool operator!= (BitmapText const & a, BitmapText const & b);
  55
  56 #endif