src/lib/playlist.cc

   1 /*
   2     Copyright (C) 2013-2016 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 "playlist.h"
  21 #include "sndfile_content.h"
  22 #include "sndfile_decoder.h"
  23 #include "video_content.h"
  24 #include "ffmpeg_decoder.h"
  25 #include "ffmpeg_content.h"
  26 #include "image_decoder.h"
  27 #include "content_factory.h"
  28 #include "dcp_content.h"
  29 #include "job.h"
  30 #include "config.h"
  31 #include "util.h"
  32 #include "md5_digester.h"
  33 #include <libcxml/cxml.h>
  34 #include <libxml++/libxml++.h>
  35 #include <boost/shared_ptr.hpp>
  36 #include <boost/foreach.hpp>
  37 #include <iostream>
  38
  39 #include "i18n.h"
  40
  41 using std::list;
  42 using std::cout;
  43 using std::vector;
  44 using std::min;
  45 using std::max;
  46 using std::string;
  47 using std::pair;
  48 using boost::optional;
  49 using boost::shared_ptr;
  50 using boost::weak_ptr;
  51 using boost::dynamic_pointer_cast;
  52
  53 Playlist::Playlist ()
  54         : _sequence (true)
  55         , _sequencing (false)
  56 {
  57
  58 }
  59
  60 Playlist::~Playlist ()
  61 {
  62         _content.clear ();
  63         reconnect ();
  64 }
  65
  66 void
  67 Playlist::content_changed (weak_ptr<Content> content, int property, bool frequent)
  68 {
  69         if (property == ContentProperty::LENGTH || property == VideoContentProperty::VIDEO_FRAME_TYPE) {
  70                 /* Don't respond to position changes here, as:
  71                    - sequencing after earlier/later changes is handled by move_earlier/move_later
  72                    - any other position changes will be timeline drags which should not result in content
  73                    being sequenced.
  74                 */
  75                 maybe_sequence ();
  76         }
  77
  78         if (
  79                 property == ContentProperty::POSITION ||
  80                 property == ContentProperty::LENGTH ||
  81                 property == ContentProperty::TRIM_START ||
  82                 property == ContentProperty::TRIM_END) {
  83
  84                 ContentList old = _content;
  85                 sort (_content.begin(), _content.end(), ContentSorter ());
  86                 if (_content != old) {
  87                         OrderChanged ();
  88                 }
  89         }
  90
  91         ContentChanged (content, property, frequent);
  92 }
  93
  94 void
  95 Playlist::maybe_sequence ()
  96 {
  97         if (!_sequence || _sequencing) {
  98                 return;
  99         }
 100
 101         _sequencing = true;
 102
 103         /* Video */
 104
 105         DCPTime next_left;
 106         DCPTime next_right;
 107         BOOST_FOREACH (shared_ptr<Content> i, _content) {
 108                 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (i);
 109                 if (!vc) {
 110                         continue;
 111                 }
 112
 113                 if (vc->video_frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
 114                         vc->set_position (next_right);
 115                         next_right = vc->end();
 116                 } else {
 117                         vc->set_position (next_left);
 118                         next_left = vc->end();
 119                 }
 120         }
 121
 122         /* Subtitles */
 123
 124         DCPTime next;
 125         BOOST_FOREACH (shared_ptr<Content> i, _content) {
 126                 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (i);
 127                 if (!sc) {
 128                         continue;
 129                 }
 130
 131                 sc->set_position (next);
 132                 next = sc->end();
 133         }
 134
 135
 136         /* This won't change order, so it does not need a sort */
 137
 138         _sequencing = false;
 139 }
 140
 141 string
 142 Playlist::video_identifier () const
 143 {
 144         string t;
 145
 146         BOOST_FOREACH (shared_ptr<const Content> i, _content) {
 147                 shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (i);
 148                 shared_ptr<const SubtitleContent> sc = dynamic_pointer_cast<const SubtitleContent> (i);
 149                 if (vc) {
 150                         t += vc->identifier ();
 151                 } else if (sc && sc->burn_subtitles ()) {
 152                         t += sc->identifier ();
 153                 }
 154         }
 155
 156         MD5Digester digester;
 157         digester.add (t.c_str(), t.length());
 158         return digester.get ();
 159 }
 160
 161 /** @param node <Playlist> node */
 162 void
 163 Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
 164 {
 165         BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Content")) {
 166                 _content.push_back (content_factory (film, i, version, notes));
 167         }
 168
 169         /* This shouldn't be necessary but better safe than sorry (there could be old files) */
 170         sort (_content.begin(), _content.end(), ContentSorter ());
 171
 172         reconnect ();
 173 }
 174
 175 /** @param node <Playlist> node */
 176 void
 177 Playlist::as_xml (xmlpp::Node* node)
 178 {
 179         BOOST_FOREACH (shared_ptr<Content> i, _content) {
 180                 i->as_xml (node->add_child ("Content"));
 181         }
 182 }
 183
 184 void
 185 Playlist::add (shared_ptr<Content> c)
 186 {
 187         _content.push_back (c);
 188         sort (_content.begin(), _content.end(), ContentSorter ());
 189         reconnect ();
 190         Changed ();
 191 }
 192
 193 void
 194 Playlist::remove (shared_ptr<Content> c)
 195 {
 196         ContentList::iterator i = _content.begin ();
 197         while (i != _content.end() && *i != c) {
 198                 ++i;
 199         }
 200
 201         if (i != _content.end ()) {
 202                 _content.erase (i);
 203                 Changed ();
 204         }
 205
 206         /* This won't change order, so it does not need a sort */
 207 }
 208
 209 void
 210 Playlist::remove (ContentList c)
 211 {
 212         BOOST_FOREACH (shared_ptr<Content> i, c) {
 213                 ContentList::iterator j = _content.begin ();
 214                 while (j != _content.end() && *j != i) {
 215                         ++j;
 216                 }
 217
 218                 if (j != _content.end ()) {
 219                         _content.erase (j);
 220                 }
 221         }
 222
 223         /* This won't change order, so it does not need a sort */
 224
 225         Changed ();
 226 }
 227
 228 class FrameRateCandidate
 229 {
 230 public:
 231         FrameRateCandidate (float source_, int dcp_)
 232                 : source (source_)
 233                 , dcp (dcp_)
 234         {}
 235
 236         float source;
 237         int dcp;
 238 };
 239
 240 int
 241 Playlist::best_dcp_frame_rate () const
 242 {
 243         list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
 244
 245         /* Work out what rates we could manage, including those achieved by using skip / repeat */
 246         list<FrameRateCandidate> candidates;
 247
 248         /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
 249         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 250                 candidates.push_back (FrameRateCandidate (*i, *i));
 251         }
 252
 253         /* Then the skip/repeat ones */
 254         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 255                 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
 256                 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
 257         }
 258
 259         /* Pick the best one */
 260         float error = std::numeric_limits<float>::max ();
 261         optional<FrameRateCandidate> best;
 262         list<FrameRateCandidate>::iterator i = candidates.begin();
 263         while (i != candidates.end()) {
 264
 265                 float this_error = 0;
 266                 BOOST_FOREACH (shared_ptr<Content> j, _content) {
 267                         shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (j);
 268                         if (!vc || !vc->has_own_video_frame_rate()) {
 269                                 continue;
 270                         }
 271
 272                         /* Best error for this content; we could use the content as-is or double its rate */
 273                         float best_error = min (
 274                                 float (fabs (i->source - vc->video_frame_rate ())),
 275                                 float (fabs (i->source - vc->video_frame_rate () * 2))
 276                                 );
 277
 278                         /* Use the largest difference between DCP and source as the "error" */
 279                         this_error = max (this_error, best_error);
 280                 }
 281
 282                 if (this_error < error) {
 283                         error = this_error;
 284                         best = *i;
 285                 }
 286
 287                 ++i;
 288         }
 289
 290         if (!best) {
 291                 return 24;
 292         }
 293
 294         return best->dcp;
 295 }
 296
 297 /** @return length of the playlist from time 0 to the last thing on the playlist */
 298 DCPTime
 299 Playlist::length () const
 300 {
 301         DCPTime len;
 302         BOOST_FOREACH (shared_ptr<const Content> i, _content) {
 303                 len = max (len, i->end());
 304         }
 305
 306         return len;
 307 }
 308
 309 /** @return position of the first thing on the playlist, if it's not empty */
 310 optional<DCPTime>
 311 Playlist::start () const
 312 {
 313         if (_content.empty ()) {
 314                 return optional<DCPTime> ();
 315         }
 316
 317         DCPTime start = DCPTime::max ();
 318         BOOST_FOREACH (shared_ptr<Content> i, _content) {
 319                 start = min (start, i->position ());
 320         }
 321
 322         return start;
 323 }
 324
 325 void
 326 Playlist::reconnect ()
 327 {
 328         for (list<boost::signals2::connection>::iterator i = _content_connections.begin(); i != _content_connections.end(); ++i) {
 329                 i->disconnect ();
 330         }
 331
 332         _content_connections.clear ();
 333
 334         BOOST_FOREACH (shared_ptr<Content> i, _content) {
 335                 _content_connections.push_back (i->Changed.connect (bind (&Playlist::content_changed, this, _1, _2, _3)));
 336         }
 337 }
 338
 339 DCPTime
 340 Playlist::video_end () const
 341 {
 342         DCPTime end;
 343         BOOST_FOREACH (shared_ptr<Content> i, _content) {
 344                 if (dynamic_pointer_cast<const VideoContent> (i)) {
 345                         end = max (end, i->end ());
 346                 }
 347         }
 348
 349         return end;
 350 }
 351
 352 DCPTime
 353 Playlist::subtitle_end () const
 354 {
 355         DCPTime end;
 356         BOOST_FOREACH (shared_ptr<Content> i, _content) {
 357                 if (dynamic_pointer_cast<const SubtitleContent> (i)) {
 358                         end = max (end, i->end ());
 359                 }
 360         }
 361
 362         return end;
 363 }
 364
 365 FrameRateChange
 366 Playlist::active_frame_rate_change (DCPTime t, int dcp_video_frame_rate) const
 367 {
 368         for (ContentList::const_reverse_iterator i = _content.rbegin(); i != _content.rend(); ++i) {
 369                 shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (*i);
 370                 if (!vc) {
 371                         continue;
 372                 }
 373
 374                 if (vc->position() <= t) {
 375                         /* This is the first piece of content (going backwards...) that starts before t,
 376                            so it's the active one.
 377                         */
 378                         return FrameRateChange (vc->video_frame_rate(), dcp_video_frame_rate);
 379                 }
 380         }
 381
 382         return FrameRateChange (dcp_video_frame_rate, dcp_video_frame_rate);
 383 }
 384
 385 void
 386 Playlist::set_sequence (bool s)
 387 {
 388         _sequence = s;
 389 }
 390
 391 bool
 392 ContentSorter::operator() (shared_ptr<Content> a, shared_ptr<Content> b)
 393 {
 394         if (a->position() != b->position()) {
 395                 return a->position() < b->position();
 396         }
 397
 398         /* Put video before audio if they start at the same time */
 399         if (dynamic_pointer_cast<VideoContent>(a) && !dynamic_pointer_cast<VideoContent>(b)) {
 400                 return true;
 401         } else if (!dynamic_pointer_cast<VideoContent>(a) && dynamic_pointer_cast<VideoContent>(b)) {
 402                 return false;
 403         }
 404
 405         /* Last resort */
 406         return a->digest() < b->digest();
 407 }
 408
 409 /** @return content in ascending order of position */
 410 ContentList
 411 Playlist::content () const
 412 {
 413         return _content;
 414 }
 415
 416 void
 417 Playlist::repeat (ContentList c, int n)
 418 {
 419         pair<DCPTime, DCPTime> range (DCPTime::max (), DCPTime ());
 420         BOOST_FOREACH (shared_ptr<Content> i, c) {
 421                 range.first = min (range.first, i->position ());
 422                 range.second = max (range.second, i->position ());
 423                 range.first = min (range.first, i->end ());
 424                 range.second = max (range.second, i->end ());
 425         }
 426
 427         DCPTime pos = range.second;
 428         for (int i = 0; i < n; ++i) {
 429                 BOOST_FOREACH (shared_ptr<Content> j, c) {
 430                         shared_ptr<Content> copy = j->clone ();
 431                         copy->set_position (pos + copy->position() - range.first);
 432                         _content.push_back (copy);
 433                 }
 434                 pos += range.second - range.first;
 435         }
 436
 437         sort (_content.begin(), _content.end(), ContentSorter ());
 438
 439         reconnect ();
 440         Changed ();
 441 }
 442
 443 void
 444 Playlist::move_earlier (shared_ptr<Content> c)
 445 {
 446         ContentList::iterator previous = _content.end ();
 447         ContentList::iterator i = _content.begin();
 448         while (i != _content.end() && *i != c) {
 449                 previous = i;
 450                 ++i;
 451         }
 452
 453         DCPOMATIC_ASSERT (i != _content.end ());
 454         if (previous == _content.end ()) {
 455                 return;
 456         }
 457
 458         shared_ptr<Content> previous_c = *previous;
 459
 460         DCPTime const p = previous_c->position ();
 461         previous_c->set_position (p + c->length_after_trim ());
 462         c->set_position (p);
 463 }
 464
 465 void
 466 Playlist::move_later (shared_ptr<Content> c)
 467 {
 468         ContentList::iterator i = _content.begin();
 469         while (i != _content.end() && *i != c) {
 470                 ++i;
 471         }
 472
 473         DCPOMATIC_ASSERT (i != _content.end ());
 474
 475         ContentList::iterator next = i;
 476         ++next;
 477
 478         if (next == _content.end ()) {
 479                 return;
 480         }
 481
 482         shared_ptr<Content> next_c = *next;
 483
 484         next_c->set_position (c->position ());
 485         c->set_position (c->position() + next_c->length_after_trim ());
 486 }
 487
 488 int64_t
 489 Playlist::required_disk_space (int j2k_bandwidth, int audio_channels, int audio_frame_rate) const
 490 {
 491         int64_t video = uint64_t (j2k_bandwidth / 8) * length().seconds ();
 492         int64_t audio = uint64_t (audio_channels * audio_frame_rate * 3) * length().seconds ();
 493
 494         BOOST_FOREACH (shared_ptr<Content> i, _content) {
 495                 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
 496                 if (d) {
 497                         if (d->reference_video()) {
 498                                 video -= uint64_t (j2k_bandwidth / 8) * d->length_after_trim().seconds();
 499                         }
 500                         if (d->reference_audio()) {
 501                                 audio -= uint64_t (audio_channels * audio_frame_rate * 3) * d->length_after_trim().seconds();
 502                         }
 503                 }
 504         }
 505
 506         /* Add on 64k for bits and pieces (metadata, subs etc) */
 507         return video + audio + 65536;
 508 }