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