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