src/lib/string_text_file.h

   1 /*
   2     Copyright (C) 2014-2018 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 #ifndef DCPOMATIC_TEXT_CAPTION_FILE_H
  22 #define DCPOMATIC_TEXT_CAPTION_FILE_H
  23
  24 #include "dcpomatic_time.h"
  25 #include <sub/subtitle.h>
  26 #include <boost/shared_ptr.hpp>
  27 #include <vector>
  28
  29 class StringTextFileContent;
  30 class plain_text_time_test;
  31 class plain_text_coordinate_test;
  32 class plain_text_content_test;
  33 class plain_text_parse_test;
  34
  35 /** @class StringTextFile
  36  *  @brief Base for StringTextFile decoder and examiner.
  37  *
  38  *  In fact this is sufficient for the examiner, so it's used as-is rather than deriving
  39  *  a pointless StringTextFileExaminer.
  40  */
  41 class StringTextFile
  42 {
  43 public:
  44         explicit StringTextFile (boost::shared_ptr<const StringTextFileContent>);
  45
  46         boost::optional<dcpomatic::ContentTime> first () const;
  47         dcpomatic::ContentTime length () const;
  48
  49 protected:
  50         std::vector<sub::Subtitle> _subtitles;
  51 };
  52
  53 #endif