src/lib/playlist.cc

   1 /*
   2     Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <libcxml/cxml.h>
  21 #include <boost/shared_ptr.hpp>
  22 #include "playlist.h"
  23 #include "sndfile_content.h"
  24 #include "sndfile_decoder.h"
  25 #include "video_content.h"
  26 #include "ffmpeg_decoder.h"
  27 #include "ffmpeg_content.h"
  28 #include "image_decoder.h"
  29 #include "content_factory.h"
  30 #include "job.h"
  31 #include "config.h"
  32 #include "util.h"
  33 #include "md5_digester.h"
  34
  35 #include "i18n.h"
  36
  37 using std::list;
  38 using std::cout;
  39 using std::vector;
  40 using std::min;
  41 using std::max;
  42 using std::string;
  43 using std::stringstream;
  44 using std::pair;
  45 using boost::optional;
  46 using boost::shared_ptr;
  47 using boost::weak_ptr;
  48 using boost::dynamic_pointer_cast;
  49
  50 Playlist::Playlist ()
  51         : _sequence_video (true)
  52         , _sequencing_video (false)
  53 {
  54
  55 }
  56
  57 Playlist::~Playlist ()
  58 {
  59         _content.clear ();
  60         reconnect ();
  61 }
  62
  63 void
  64 Playlist::content_changed (weak_ptr<Content> content, int property, bool frequent)
  65 {
  66         if (property == ContentProperty::LENGTH || property == VideoContentProperty::VIDEO_FRAME_TYPE) {
  67                 maybe_sequence_video ();
  68         }
  69
  70         ContentChanged (content, property, frequent);
  71 }
  72
  73 void
  74 Playlist::maybe_sequence_video ()
  75 {
  76         if (!_sequence_video || _sequencing_video) {
  77                 return;
  78         }
  79
  80         _sequencing_video = true;
  81
  82         ContentList cl = _content;
  83         Time next_left = 0;
  84         Time next_right = 0;
  85         for (ContentList::iterator i = _content.begin(); i != _content.end(); ++i) {
  86                 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
  87                 if (!vc) {
  88                         continue;
  89                 }
  90
  91                 if (vc->video_frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
  92                         vc->set_position (next_right);
  93                         next_right = vc->end() + 1;
  94                 } else {
  95                         vc->set_position (next_left);
  96                         next_left = vc->end() + 1;
  97                 }
  98         }
  99
 100         /* This won't change order, so it does not need a sort */
 101
 102         _sequencing_video = false;
 103 }
 104
 105 string
 106 Playlist::video_identifier () const
 107 {
 108         string t;
 109
 110         for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
 111                 shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (*i);
 112                 if (vc) {
 113                         t += vc->identifier ();
 114                 }
 115         }
 116
 117         MD5Digester digester;
 118         digester.add (t.c_str(), t.length());
 119         return digester.get ();
 120 }
 121
 122 /** @param node <Playlist> node */
 123 void
 124 Playlist::set_from_xml (shared_ptr<const Film> film, shared_ptr<const cxml::Node> node, int version, list<string>& notes)
 125 {
 126         list<cxml::NodePtr> c = node->node_children ("Content");
 127         for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
 128                 _content.push_back (content_factory (film, *i, version, notes));
 129         }
 130
 131         sort (_content.begin(), _content.end(), ContentSorter ());
 132
 133         reconnect ();
 134 }
 135
 136 /** @param node <Playlist> node */
 137 void
 138 Playlist::as_xml (xmlpp::Node* node)
 139 {
 140         for (ContentList::iterator i = _content.begin(); i != _content.end(); ++i) {
 141                 (*i)->as_xml (node->add_child ("Content"));
 142         }
 143 }
 144
 145 void
 146 Playlist::add (shared_ptr<Content> c)
 147 {
 148         _content.push_back (c);
 149         sort (_content.begin(), _content.end(), ContentSorter ());
 150         reconnect ();
 151         Changed ();
 152 }
 153
 154 void
 155 Playlist::remove (shared_ptr<Content> c)
 156 {
 157         ContentList::iterator i = _content.begin ();
 158         while (i != _content.end() && *i != c) {
 159                 ++i;
 160         }
 161
 162         if (i != _content.end ()) {
 163                 _content.erase (i);
 164                 Changed ();
 165         }
 166
 167         /* This won't change order, so it does not need a sort */
 168 }
 169
 170 void
 171 Playlist::remove (ContentList c)
 172 {
 173         for (ContentList::iterator i = c.begin(); i != c.end(); ++i) {
 174                 ContentList::iterator j = _content.begin ();
 175                 while (j != _content.end() && *j != *i) {
 176                         ++j;
 177                 }
 178
 179                 if (j != _content.end ()) {
 180                         _content.erase (j);
 181                 }
 182         }
 183
 184         /* This won't change order, so it does not need a sort */
 185
 186         Changed ();
 187 }
 188
 189 bool
 190 Playlist::has_subtitles () const
 191 {
 192         for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
 193                 shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (*i);
 194                 if (fc && !fc->subtitle_streams().empty()) {
 195                         return true;
 196                 }
 197         }
 198
 199         return false;
 200 }
 201
 202 class FrameRateCandidate
 203 {
 204 public:
 205         FrameRateCandidate (float source_, int dcp_)
 206                 : source (source_)
 207                 , dcp (dcp_)
 208         {}
 209
 210         float source;
 211         int dcp;
 212 };
 213
 214 int
 215 Playlist::best_dcp_frame_rate () const
 216 {
 217         list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
 218
 219         /* Work out what rates we could manage, including those achieved by using skip / repeat. */
 220         list<FrameRateCandidate> candidates;
 221
 222         /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
 223         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 224                 candidates.push_back (FrameRateCandidate (*i, *i));
 225         }
 226
 227         /* Then the skip/repeat ones */
 228         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 229                 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
 230                 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
 231         }
 232
 233         /* Pick the best one */
 234         float error = std::numeric_limits<float>::max ();
 235         optional<FrameRateCandidate> best;
 236         list<FrameRateCandidate>::iterator i = candidates.begin();
 237         while (i != candidates.end()) {
 238
 239                 float this_error = 0;
 240                 for (ContentList::const_iterator j = _content.begin(); j != _content.end(); ++j) {
 241                         shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*j);
 242                         if (!vc) {
 243                                 continue;
 244                         }
 245
 246                         /* Use the largest difference between DCP and source as the "error" */
 247                         this_error = max (this_error, float (fabs (i->source - vc->video_frame_rate ())));
 248                 }
 249
 250                 if (this_error < error) {
 251                         error = this_error;
 252                         best = *i;
 253                 }
 254
 255                 ++i;
 256         }
 257
 258         if (!best) {
 259                 return 24;
 260         }
 261
 262         return best->dcp;
 263 }
 264
 265 Time
 266 Playlist::length () const
 267 {
 268         Time len = 0;
 269         for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
 270                 len = max (len, (*i)->end() + 1);
 271         }
 272
 273         return len;
 274 }
 275
 276 void
 277 Playlist::reconnect ()
 278 {
 279         for (list<boost::signals2::connection>::iterator i = _content_connections.begin(); i != _content_connections.end(); ++i) {
 280                 i->disconnect ();
 281         }
 282
 283         _content_connections.clear ();
 284
 285         for (ContentList::iterator i = _content.begin(); i != _content.end(); ++i) {
 286                 _content_connections.push_back ((*i)->Changed.connect (bind (&Playlist::content_changed, this, _1, _2, _3)));
 287         }
 288 }
 289
 290 Time
 291 Playlist::video_end () const
 292 {
 293         Time end = 0;
 294         for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
 295                 if (dynamic_pointer_cast<const VideoContent> (*i)) {
 296                         end = max (end, (*i)->end ());
 297                 }
 298         }
 299
 300         return end;
 301 }
 302
 303 void
 304 Playlist::set_sequence_video (bool s)
 305 {
 306         _sequence_video = s;
 307 }
 308
 309 bool
 310 ContentSorter::operator() (shared_ptr<Content> a, shared_ptr<Content> b)
 311 {
 312         return a->position() < b->position();
 313 }
 314
 315 /** @return content in an undefined order */
 316 ContentList
 317 Playlist::content () const
 318 {
 319         return _content;
 320 }
 321
 322 void
 323 Playlist::repeat (ContentList c, int n)
 324 {
 325         pair<Time, Time> range (TIME_MAX, 0);
 326         for (ContentList::iterator i = c.begin(); i != c.end(); ++i) {
 327                 range.first = min (range.first, (*i)->position ());
 328                 range.second = max (range.second, (*i)->position ());
 329                 range.first = min (range.first, (*i)->end ());
 330                 range.second = max (range.second, (*i)->end ());
 331         }
 332
 333         Time pos = range.second;
 334         for (int i = 0; i < n; ++i) {
 335                 for (ContentList::iterator i = c.begin(); i != c.end(); ++i) {
 336                         shared_ptr<Content> copy = (*i)->clone ();
 337                         copy->set_position (pos + copy->position() - range.first);
 338                         _content.push_back (copy);
 339                 }
 340                 pos += range.second - range.first;
 341         }
 342
 343         sort (_content.begin(), _content.end(), ContentSorter ());
 344
 345         reconnect ();
 346         Changed ();
 347 }
 348
 349 void
 350 Playlist::move_earlier (shared_ptr<Content> c)
 351 {
 352         sort (_content.begin(), _content.end(), ContentSorter ());
 353
 354         ContentList::iterator previous = _content.end ();
 355         ContentList::iterator i = _content.begin();
 356         while (i != _content.end() && *i != c) {
 357                 previous = i;
 358                 ++i;
 359         }
 360
 361         assert (i != _content.end ());
 362         if (previous == _content.end ()) {
 363                 return;
 364         }
 365
 366         Time const p = (*previous)->position ();
 367         (*previous)->set_position (p + c->length_after_trim ());
 368         c->set_position (p);
 369         sort (_content.begin(), _content.end(), ContentSorter ());
 370
 371         Changed ();
 372 }
 373
 374 void
 375 Playlist::move_later (shared_ptr<Content> c)
 376 {
 377         sort (_content.begin(), _content.end(), ContentSorter ());
 378
 379         ContentList::iterator i = _content.begin();
 380         while (i != _content.end() && *i != c) {
 381                 ++i;
 382         }
 383
 384         assert (i != _content.end ());
 385
 386         ContentList::iterator next = i;
 387         ++next;
 388
 389         if (next == _content.end ()) {
 390                 return;
 391         }
 392
 393         Time const p = (*next)->position ();
 394         (*next)->set_position (c->position ());
 395         c->set_position (p + c->length_after_trim ());
 396         sort (_content.begin(), _content.end(), ContentSorter ());
 397
 398         Changed ();
 399 }