More automated renaming.

[dcpomatic.git] / src / lib / active_text.h

diff --git a/src/lib/active_text.h b/src/lib/active_text.h
new file mode 100644 (file)
index 0000000..10ce30f
--- /dev/null
+++ b/src/lib/active_text.h
@@ -0,0 +1,68 @@
+/*
+    Copyright (C) 2017-2018 Carl Hetherington <cth@carlh.net>
+
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    DCP-o-matic is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+/** @file  src/lib/active_captions.h
+ *  @brief ActiveText class.
+ */
+
+#include "dcpomatic_time.h"
+#include "player_text.h"
+#include <boost/noncopyable.hpp>
+#include <list>
+#include <map>
+
+class TextContent;
+
+/** @class ActiveText
+ *  @brief A class to maintain information on active subtitles for Player.
+ */
+class ActiveText : public boost::noncopyable
+{
+public:
+       std::list<PlayerText> get (DCPTimePeriod period) const;
+       std::list<PlayerText> get_burnt (DCPTimePeriod period, bool always_burn_captions) const;
+       void clear_before (DCPTime time);
+       void clear ();
+       void add_from (boost::weak_ptr<const TextContent> content, PlayerText ps, DCPTime from);
+       std::pair<PlayerText, DCPTime> add_to (boost::weak_ptr<const TextContent> content, DCPTime to);
+       bool have (boost::weak_ptr<const TextContent> content) const;
+
+private:
+       class Period
+       {
+       public:
+               Period () {}
+
+               Period (PlayerText s, DCPTime f)
+                       : subs (s)
+                       , from (f)
+               {}
+
+               PlayerText subs;
+               DCPTime from;
+               boost::optional<DCPTime> to;
+       };
+
+       typedef std::map<boost::weak_ptr<const TextContent>, std::list<Period> > Map;
+
+       void add (DCPTimePeriod period, std::list<PlayerText>& pc, std::list<Period> p) const;
+
+       Map _data;
+};