src/subtitle_asset.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp 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     libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34 #ifndef LIBDCP_SUBTITLE_ASSET_H
  35 #define LIBDCP_SUBTITLE_ASSET_H
  36
  37 #include "asset.h"
  38 #include "dcp_time.h"
  39 #include "subtitle_string.h"
  40 #include "data.h"
  41 #include <libcxml/cxml.h>
  42 #include <boost/shared_array.hpp>
  43 #include <map>
  44
  45 namespace xmlpp {
  46         class Element;
  47 }
  48
  49 struct interop_dcp_font_test;
  50 struct smpte_dcp_font_test;
  51 struct pull_fonts_test1;
  52 struct pull_fonts_test2;
  53 struct pull_fonts_test3;
  54
  55 namespace dcp
  56 {
  57
  58 class SubtitleString;
  59 class FontNode;
  60 class TextNode;
  61 class SubtitleNode;
  62 class LoadFontNode;
  63
  64 namespace order {
  65         class Part;
  66         class Context;
  67 }
  68
  69 /** @class SubtitleAsset
  70  *  @brief A parent for classes representing a file containing subtitles.
  71  *
  72  *  This class holds a list of Subtitle objects which it can extract
  73  *  from the appropriate part of either an Interop or SMPTE XML file.
  74  *  Its subclasses InteropSubtitleAsset and SMPTESubtitleAsset handle the
  75  *  differences between the two types.
  76  */
  77 class SubtitleAsset : public Asset
  78 {
  79 public:
  80         SubtitleAsset ();
  81         explicit SubtitleAsset (boost::filesystem::path file);
  82
  83         bool equals (
  84                 boost::shared_ptr<const Asset>,
  85                 EqualityOptions,
  86                 NoteHandler note
  87                 ) const;
  88
  89         std::list<boost::shared_ptr<Subtitle> > subtitles_during (Time from, Time to, bool starting) const;
  90         std::list<boost::shared_ptr<Subtitle> > const & subtitles () const {
  91                 return _subtitles;
  92         }
  93
  94         virtual void add (boost::shared_ptr<Subtitle>);
  95         virtual void add_font (std::string id, boost::filesystem::path file) = 0;
  96         std::map<std::string, Data> fonts_with_load_ids () const;
  97
  98         virtual void write (boost::filesystem::path) const = 0;
  99         virtual std::string xml_as_string () const = 0;
 100
 101         Time latest_subtitle_out () const;
 102
 103         virtual std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const = 0;
 104
 105 protected:
 106         friend struct ::interop_dcp_font_test;
 107         friend struct ::smpte_dcp_font_test;
 108
 109         struct ParseState {
 110                 boost::optional<std::string> font_id;
 111                 boost::optional<int64_t> size;
 112                 boost::optional<float> aspect_adjust;
 113                 boost::optional<bool> italic;
 114                 boost::optional<bool> bold;
 115                 boost::optional<bool> underline;
 116                 boost::optional<Colour> colour;
 117                 boost::optional<Effect> effect;
 118                 boost::optional<Colour> effect_colour;
 119                 boost::optional<float> h_position;
 120                 boost::optional<HAlign> h_align;
 121                 boost::optional<float> v_position;
 122                 boost::optional<VAlign> v_align;
 123                 boost::optional<Direction> direction;
 124                 boost::optional<Time> in;
 125                 boost::optional<Time> out;
 126                 boost::optional<Time> fade_up_time;
 127                 boost::optional<Time> fade_down_time;
 128         };
 129
 130         void parse_subtitles (xmlpp::Element const * node, std::list<ParseState>& state, boost::optional<int> tcr, Standard standard);
 131         ParseState font_node_state (xmlpp::Element const * node, Standard standard) const;
 132         ParseState text_node_state (xmlpp::Element const * node) const;
 133         ParseState subtitle_node_state (xmlpp::Element const * node, boost::optional<int> tcr) const;
 134         Time fade_time (xmlpp::Element const * node, std::string name, boost::optional<int> tcr) const;
 135
 136         void subtitles_as_xml (xmlpp::Element* root, int time_code_rate, Standard standard) const;
 137
 138         /** All our subtitles, in no particular order */
 139         std::list<boost::shared_ptr<Subtitle> > _subtitles;
 140
 141         class Font
 142         {
 143         public:
 144                 Font (std::string load_id_, std::string uuid_, boost::filesystem::path file_)
 145                         : load_id (load_id_)
 146                         , uuid (uuid_)
 147                         , data (file_)
 148                         , file (file_)
 149                 {}
 150
 151                 Font (std::string load_id_, std::string uuid_, Data data_)
 152                         : load_id (load_id_)
 153                         , uuid (uuid_)
 154                         , data (data_)
 155                 {}
 156
 157                 std::string load_id;
 158                 std::string uuid;
 159                 Data data;
 160                 /** .ttf file that this data was last written to, if applicable */
 161                 mutable boost::optional<boost::filesystem::path> file;
 162         };
 163
 164         /** TTF font data that we need */
 165         std::list<Font> _fonts;
 166
 167 private:
 168         friend struct ::pull_fonts_test1;
 169         friend struct ::pull_fonts_test2;
 170         friend struct ::pull_fonts_test3;
 171
 172         void maybe_add_subtitle (std::string text, std::list<ParseState> const & parse_state);
 173
 174         static void pull_fonts (boost::shared_ptr<order::Part> part);
 175 };
 176
 177 }
 178
 179 #endif