src/interop_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 /** @file  src/interop_subtitle_asset.h
  35  *  @brief InteropSubtitleAsset class.
  36  */
  37
  38 #include "subtitle_asset.h"
  39 #include <boost/filesystem.hpp>
  40
  41 namespace dcp {
  42
  43 class InteropLoadFontNode;
  44
  45 /** @class InteropSubtitleAsset
  46  *  @brief A set of subtitles to be read and/or written in the Inter-Op format.
  47  *
  48  *  Inter-Op subtitles are sometimes known as CineCanvas.
  49  */
  50 class InteropSubtitleAsset : public SubtitleAsset
  51 {
  52 public:
  53         InteropSubtitleAsset ();
  54         explicit InteropSubtitleAsset (boost::filesystem::path file);
  55
  56         bool equals (
  57                 boost::shared_ptr<const Asset>,
  58                 EqualityOptions,
  59                 NoteHandler note
  60                 ) const;
  61
  62         std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
  63
  64         void add_font (std::string load_id, boost::filesystem::path file);
  65
  66         std::string xml_as_string () const;
  67         void write (boost::filesystem::path path) const;
  68         void resolve_fonts (std::list<boost::shared_ptr<Asset> > assets);
  69         void add_font_assets (std::list<boost::shared_ptr<Asset> >& assets);
  70
  71         /** Set the reel number or sub-element identifier
  72          *  of these subtitles.
  73          *  @param n New reel number.
  74          */
  75         void set_reel_number (std::string n) {
  76                 _reel_number = n;
  77         }
  78
  79         /** Set the language tag of these subtitles.
  80          *  @param l New language.
  81          */
  82         void set_language (std::string l) {
  83                 _language = l;
  84         }
  85
  86         /** @return title of the movie that the subtitles are for */
  87         void set_movie_title (std::string m) {
  88                 _movie_title = m;
  89         }
  90
  91         /** @return reel number or sub-element of a programme that
  92          *  these subtitles refer to.
  93          */
  94         std::string reel_number () const {
  95                 return _reel_number;
  96         }
  97
  98         /** @return language used in the subtitles */
  99         std::string language () const {
 100                 return _language;
 101         }
 102
 103         /** @return movie title that these subtitles are for */
 104         std::string movie_title () const {
 105                 return _movie_title;
 106         }
 107
 108 protected:
 109
 110         std::string pkl_type (Standard) const {
 111                 return "text/xml;asdcpKind=Subtitle";
 112         }
 113
 114 private:
 115         std::string _reel_number;
 116         std::string _language;
 117         std::string _movie_title;
 118         std::list<boost::shared_ptr<InteropLoadFontNode> > _load_font_nodes;
 119 };
 120
 121 }