src/lib/active_subtitles.cc

   1 /*
   2     Copyright (C) 2017 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 #include "active_subtitles.h"
  22 #include "piece.h"
  23 #include "subtitle_content.h"
  24 #include <boost/shared_ptr.hpp>
  25 #include <boost/weak_ptr.hpp>
  26
  27 using std::list;
  28 using std::pair;
  29 using std::make_pair;
  30 using boost::weak_ptr;
  31 using boost::shared_ptr;
  32
  33 /** Get the subtitles that should be burnt into a frame at a given time.
  34  *  @param time Frame time.
  35  *  @param always_burn_subtitles Always burn subtitles even if their content is not set to burn.
  36  */
  37 list<PlayerSubtitles>
  38 ActiveSubtitles::get_burnt (DCPTime time, bool always_burn_subtitles) const
  39 {
  40         list<PlayerSubtitles> ps;
  41
  42         for (Map::const_iterator i = _data.begin(); i != _data.end(); ++i) {
  43
  44                 shared_ptr<Piece> piece = i->first.lock ();
  45                 if (!piece) {
  46                         continue;
  47                 }
  48
  49                 if (!piece->content->subtitle->use() || (!always_burn_subtitles && !piece->content->subtitle->burn())) {
  50                         /* Not burning this piece */
  51                         continue;
  52                 }
  53
  54                 BOOST_FOREACH (Period j, i->second) {
  55                         if (j.from <= time && (!j.to || j.to.get() > time)) {
  56                                 ps.push_back (j.subs);
  57                         }
  58                 }
  59         }
  60
  61         return ps;
  62 }
  63
  64 /** Remove subtitles that finish before a given time from our list.
  65  *  @param time Time to remove before.
  66  */
  67 void
  68 ActiveSubtitles::clear_before (DCPTime time)
  69 {
  70         Map updated;
  71         for (Map::const_iterator i = _data.begin(); i != _data.end(); ++i) {
  72                 list<Period> as;
  73                 BOOST_FOREACH (Period j, i->second) {
  74                         if (!j.to || j.to.get() >= time) {
  75                                 as.push_back (j);
  76                         }
  77                 }
  78                 if (!as.empty ()) {
  79                         updated[i->first] = as;
  80                 }
  81         }
  82         _data = updated;
  83 }
  84
  85 /** Add a new subtitle with a from time.
  86  *  @param piece Piece that the subtitle is from.
  87  *  @param ps Subtitles.
  88  *  @param from From time for these subtitles.
  89  */
  90 void
  91 ActiveSubtitles::add_from (weak_ptr<Piece> piece, PlayerSubtitles ps, DCPTime from)
  92 {
  93         if (_data.find(piece) == _data.end()) {
  94                 _data[piece] = list<Period>();
  95         }
  96         _data[piece].push_back (Period (ps, from));
  97 }
  98
  99 /** Add the to time for the last subtitle added from a piece.
 100  *  @param piece Piece that the subtitle is from.
 101  *  @param to To time for the last subtitle submitted to add_from for this piece.
 102  *  @return Return the corresponding subtitles and their from time.
 103  */
 104 pair<PlayerSubtitles, DCPTime>
 105 ActiveSubtitles::add_to (weak_ptr<Piece> piece, DCPTime to)
 106 {
 107         DCPOMATIC_ASSERT (_data.find(piece) != _data.end());
 108
 109         _data[piece].back().to = to;
 110
 111         BOOST_FOREACH (SubtitleString& i, _data[piece].back().subs.text) {
 112                 i.set_out (dcp::Time(to.seconds(), 1000));
 113         }
 114
 115         return make_pair (_data[piece].back().subs, _data[piece].back().from);
 116 }
 117
 118 /** @param piece A piece.
 119  *  @return true if we have any active subtitles from this piece.
 120  */
 121 bool
 122 ActiveSubtitles::have (weak_ptr<Piece> piece) const
 123 {
 124         Map::const_iterator i = _data.find(piece);
 125         if (i == _data.end()) {
 126                 return false;
 127         }
 128
 129         return !i->second.empty();
 130 }
 131
 132 void
 133 ActiveSubtitles::clear ()
 134 {
 135         _data.clear ();
 136 }