src/lib/subtitle_encoder.h

   1 /*
   2     Copyright (C) 2019-2021 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 #include "dcp_text_track.h"
  23 #include "dcpomatic_time.h"
  24 #include "encoder.h"
  25 #include "player_text.h"
  26
  27
  28 namespace dcp {
  29         class SubtitleAsset;
  30 }
  31
  32
  33 class Film;
  34
  35
  36 /** @class SubtitleEncoder.
  37  *  @brief An `encoder' which extracts a film's subtitles to DCP XML format.
  38  */
  39 class SubtitleEncoder : public Encoder
  40 {
  41 public:
  42         SubtitleEncoder (std::shared_ptr<const Film> film, std::shared_ptr<Job> job, boost::filesystem::path output, std::string initial_name, bool split_reels, bool include_font);
  43
  44         void go () override;
  45
  46         /** @return the number of frames that are done */
  47         Frame frames_done () const override;
  48
  49         bool finishing () const override {
  50                 return false;
  51         }
  52
  53 private:
  54         void text (PlayerText subs, TextType type, boost::optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period);
  55
  56         std::vector<std::pair<std::shared_ptr<dcp::SubtitleAsset>, boost::filesystem::path>> _assets;
  57         std::vector<dcpomatic::DCPTimePeriod> _reels;
  58         bool _split_reels;
  59         bool _include_font;
  60         int _reel_index;
  61         boost::optional<dcpomatic::DCPTime> _last;
  62         dcpomatic::DCPTime _length;
  63         dcp::ArrayData _default_font;
  64 };