src/lib/font.h

   1 /*
   2     Copyright (C) 2014-2023 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
  22 #ifndef DCPOMATIC_FONT_H
  23 #define DCPOMATIC_FONT_H
  24
  25
  26 #include <dcp/array_data.h>
  27 #include <libcxml/cxml.h>
  28 #include <boost/optional.hpp>
  29 #include <boost/signals2.hpp>
  30 #include <boost/filesystem.hpp>
  31 #include <string>
  32
  33
  34 namespace dcpomatic {
  35
  36
  37 class Font
  38 {
  39 public:
  40         explicit Font (std::string id)
  41                 : _id (id) {}
  42
  43         explicit Font (cxml::NodePtr node);
  44
  45         Font (std::string id, boost::filesystem::path file)
  46                 : _id (id)
  47         {
  48                 _content.file = file;
  49         }
  50
  51         Font (std::string id, dcp::ArrayData data)
  52                 : _id (id)
  53         {
  54                 _content.data = data;
  55         }
  56
  57         Font(Font const& other);
  58         Font& operator=(Font const& other);
  59
  60         void as_xml (xmlpp::Node* node);
  61
  62         std::string id () const {
  63                 return _id;
  64         }
  65
  66         void set_id (std::string id) {
  67                 _id = id;
  68         }
  69
  70         boost::optional<boost::filesystem::path> file () const {
  71                 return _content.file;
  72         }
  73
  74         void set_file (boost::filesystem::path file) {
  75                 _content.file = file;
  76                 Changed ();
  77         }
  78
  79         /** @return the data set passed to the dcp::ArrayData constructor,
  80          *  otherwise the contents of _file, otherwise boost::none.
  81          */
  82         boost::optional<dcp::ArrayData> data() const;
  83
  84         /** The actual TTF/OTF font data, as either a filename or the raw data itself */
  85         struct Content
  86         {
  87                 boost::optional<dcp::ArrayData> data;
  88                 boost::optional<boost::filesystem::path> file;
  89         };
  90
  91         Content content() const {
  92                 return _content;
  93         }
  94
  95         boost::signals2::signal<void()> Changed;
  96
  97 private:
  98         /** Font ID, used to describe it in the subtitle content; could be either a
  99          *  font family name or an ID from some DCP font XML.
 100          */
 101         std::string _id;
 102         Content _content;
 103 };
 104
 105
 106 bool operator!= (Font const & a, Font const & b);
 107 bool operator== (Font const & a, Font const & b);
 108
 109
 110 }
 111
 112 #endif