src/smpte_subtitle_asset.h

   1 /*
   2     Copyright (C) 2012-2015 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 #include "subtitle_asset.h"
  21 #include "local_time.h"
  22 #include "mxf.h"
  23 #include <boost/filesystem.hpp>
  24
  25 namespace dcp {
  26
  27 class SMPTELoadFontNode;
  28
  29 class SMPTESubtitleAsset : public SubtitleAsset, public MXF
  30 {
  31 public:
  32         /** @param file File name
  33          *  @param mxf true if `file' is a MXF, or false if it is an XML file.
  34          */
  35         SMPTESubtitleAsset (boost::filesystem::path file, bool mxf = true);
  36
  37         bool equals (
  38                 boost::shared_ptr<const Asset>,
  39                 EqualityOptions,
  40                 NoteHandler note
  41                 ) const;
  42
  43         std::list<boost::shared_ptr<LoadFontNode> > load_font_nodes () const;
  44
  45         Glib::ustring xml_as_string () const;
  46         void write (boost::filesystem::path path) const;
  47
  48         /** @return language, if one was specified */
  49         boost::optional<std::string> language () const {
  50                 return _language;
  51         }
  52
  53         static bool valid_mxf (boost::filesystem::path);
  54
  55 protected:
  56
  57         std::string pkl_type (Standard) const {
  58                 return "application/mxf";
  59         }
  60
  61 private:
  62         std::string _content_title_text;
  63         boost::optional<std::string> _annotation_text;
  64         LocalTime _issue_date;
  65         boost::optional<int> _reel_number;
  66         boost::optional<std::string> _language;
  67         Fraction _edit_rate;
  68         int _time_code_rate;
  69         boost::optional<Time> _start_time;
  70
  71         std::list<boost::shared_ptr<SMPTELoadFontNode> > _load_font_nodes;
  72 };
  73
  74 }