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/thread/mutex.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
  37 {
  38 public:
  39         ActiveText () {}
  40
  41         ActiveText (ActiveText const&) = delete;
  42         ActiveText& operator= (ActiveText const&) = delete;
  43
  44         std::list<PlayerText> get_burnt (dcpomatic::DCPTimePeriod period, bool always_burn_captions) const;
  45         void clear_before (dcpomatic::DCPTime time);
  46         void clear ();
  47         void add_from (std::weak_ptr<const TextContent> content, PlayerText ps, dcpomatic::DCPTime from);
  48         std::pair<PlayerText, dcpomatic::DCPTime> add_to (std::weak_ptr<const TextContent> content, dcpomatic::DCPTime to);
  49         bool have (std::weak_ptr<const TextContent> content) const;
  50
  51 private:
  52         class Period
  53         {
  54         public:
  55                 Period () {}
  56
  57                 Period (PlayerText s, dcpomatic::DCPTime f)
  58                         : subs (s)
  59                         , from (f)
  60                 {}
  61
  62                 PlayerText subs;
  63                 dcpomatic::DCPTime from;
  64                 boost::optional<dcpomatic::DCPTime> to;
  65         };
  66
  67         typedef std::map<std::weak_ptr<const TextContent>, std::list<Period>, std::owner_less<std::weak_ptr<const TextContent>>> Map;
  68
  69         mutable boost::mutex _mutex;
  70         Map _data;
  71 };