src/lib/active_text.h

   1 /*
   2     Copyright (C) 2017-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 /** @file  src/lib/active_captions.h
  22  *  @brief ActiveText class.
  23  */
  24
  25 #include "dcpomatic_time.h"
  26 #include "player_text.h"
  27 #include <boost/noncopyable.hpp>
  28 #include <list>
  29 #include <map>
  30
  31 class TextContent;
  32
  33 /** @class ActiveText
  34  *  @brief A class to maintain information on active subtitles for Player.
  35  */
  36 class ActiveText : public boost::noncopyable
  37 {
  38 public:
  39         std::list<PlayerText> get (DCPTimePeriod period) const;
  40         std::list<PlayerText> get_burnt (DCPTimePeriod period, bool always_burn_captions) const;
  41         void clear_before (DCPTime time);
  42         void clear ();
  43         void add_from (boost::weak_ptr<const TextContent> content, PlayerText ps, DCPTime from);
  44         std::pair<PlayerText, DCPTime> add_to (boost::weak_ptr<const TextContent> content, DCPTime to);
  45         bool have (boost::weak_ptr<const TextContent> content) const;
  46
  47 private:
  48         class Period
  49         {
  50         public:
  51                 Period () {}
  52
  53                 Period (PlayerText s, DCPTime f)
  54                         : subs (s)
  55                         , from (f)
  56                 {}
  57
  58                 PlayerText subs;
  59                 DCPTime from;
  60                 boost::optional<DCPTime> to;
  61         };
  62
  63         typedef std::map<boost::weak_ptr<const TextContent>, std::list<Period> > Map;
  64
  65         void add (DCPTimePeriod period, std::list<PlayerText>& pc, std::list<Period> p) const;
  66
  67         Map _data;
  68 };