+/*
+ 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/>.
+
+*/
+
+#include "active_captions.h"
+#include "piece.h"
+#include "text_content.h"
+#include <boost/shared_ptr.hpp>
+#include <boost/weak_ptr.hpp>
+
+using std::list;
+using std::pair;
+using std::make_pair;
+using boost::weak_ptr;
+using boost::shared_ptr;
+using boost::optional;
+
+/** Get the subtitles that should be burnt into a given period.
+ * @param period Period of interest.
+ * @param always_burn_subtitles Always burn subtitles even if their content is not set to burn.
+ */
+list<PlayerCaption>
+ActiveCaptions::get_burnt (DCPTimePeriod period, bool always_burn_subtitles) const
+{
+ list<PlayerCaption> ps;
+
+ for (Map::const_iterator i = _data.begin(); i != _data.end(); ++i) {
+
+ shared_ptr<Piece> piece = i->first.lock ();
+ if (!piece) {
+ continue;
+ }
+
+ if (!piece->content->subtitle->use() || (!always_burn_subtitles && !piece->content->subtitle->burn())) {
+ /* Not burning this piece */
+ continue;
+ }
+
+ BOOST_FOREACH (Period j, i->second) {
+ DCPTimePeriod test (j.from, j.to.get_value_or(DCPTime::max()));
+ optional<DCPTimePeriod> overlap = period.overlap (test);
+ if (overlap && overlap->duration() > DCPTime(period.duration().get() / 2)) {
+ ps.push_back (j.subs);
+ }
+ }
+ }
+
+ return ps;
+}
+
+/** Remove subtitles that finish before a given time from our list.
+ * @param time Time to remove before.
+ */
+void
+ActiveCaptions::clear_before (DCPTime time)
+{
+ Map updated;
+ for (Map::const_iterator i = _data.begin(); i != _data.end(); ++i) {
+ list<Period> as;
+ BOOST_FOREACH (Period j, i->second) {
+ if (!j.to || j.to.get() >= time) {
+ as.push_back (j);
+ }
+ }
+ if (!as.empty ()) {
+ updated[i->first] = as;
+ }
+ }
+ _data = updated;
+}
+
+/** Add a new subtitle with a from time.
+ * @param piece Piece that the subtitle is from.
+ * @param ps Subtitles.
+ * @param from From time for these subtitles.
+ */
+void
+ActiveCaptions::add_from (weak_ptr<Piece> piece, PlayerCaption ps, DCPTime from)
+{
+ if (_data.find(piece) == _data.end()) {
+ _data[piece] = list<Period>();
+ }
+ _data[piece].push_back (Period (ps, from));
+}
+
+/** Add the to time for the last subtitle added from a piece.
+ * @param piece Piece that the subtitle is from.
+ * @param to To time for the last subtitle submitted to add_from for this piece.
+ * @return Return the corresponding subtitles and their from time.
+ */
+pair<PlayerCaption, DCPTime>
+ActiveCaptions::add_to (weak_ptr<Piece> piece, DCPTime to)
+{
+ DCPOMATIC_ASSERT (_data.find(piece) != _data.end());
+
+ _data[piece].back().to = to;
+
+ BOOST_FOREACH (TextCaption& i, _data[piece].back().subs.text) {
+ i.set_out (dcp::Time(to.seconds(), 1000));
+ }
+
+ return make_pair (_data[piece].back().subs, _data[piece].back().from);
+}
+
+/** @param piece A piece.
+ * @return true if we have any active subtitles from this piece.
+ */
+bool
+ActiveCaptions::have (weak_ptr<Piece> piece) const
+{
+ Map::const_iterator i = _data.find(piece);
+ if (i == _data.end()) {
+ return false;
+ }
+
+ return !i->second.empty();
+}
+
+void
+ActiveCaptions::clear ()
+{
+ _data.clear ();
+}