src/lib/text_type.h

   1 /*
   2     Copyright (C) 2013-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 #ifndef DCPOMATIC_TEXT_TYPE_H
  23 #define DCPOMATIC_TEXT_TYPE_H
  24
  25
  26 #include <string>
  27
  28
  29 /** Type of captions.
  30  *
  31  *  The generally accepted definitions seem to be:
  32  *  - subtitles: text for an audience who doesn't speak the film's language
  33  *  - captions:  text for a hearing-impaired audience
  34  *  - open:      on-screen
  35  *  - closed:    only visible by some audience members
  36  *
  37  *  At the moment DoM supports open subtitles and closed captions.
  38  *
  39  *  There is some use of the word `subtitle' in the code which may mean
  40  *  caption in some contexts.
  41  */
  42 enum class TextType
  43 {
  44         UNKNOWN,
  45         OPEN_SUBTITLE,
  46         CLOSED_CAPTION,
  47         COUNT
  48 };
  49
  50 extern std::string text_type_to_string(TextType t);
  51 extern std::string text_type_to_name(TextType t);
  52 extern TextType string_to_text_type(std::string s);
  53
  54
  55 #endif
  56