Extract common code out into kdm_for_screen()
[dcpomatic.git] / src / lib / shuffler.cc
1 /*
2     Copyright (C) 2018-2020 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 "shuffler.h"
22 #include "content_video.h"
23 #include "dcpomatic_assert.h"
24 #include "dcpomatic_log.h"
25 #include <boost/foreach.hpp>
26 #include <string>
27 #include <iostream>
28
29 using std::make_pair;
30 using std::string;
31 using boost::weak_ptr;
32 using boost::shared_ptr;
33 using boost::optional;
34
35 int const Shuffler::_max_size = 64;
36
37 struct Comparator
38 {
39         bool operator()(Shuffler::Store const & a, Shuffler::Store const & b) {
40                 if (a.second.frame != b.second.frame) {
41                         return a.second.frame < b.second.frame;
42                 }
43                 return a.second.eyes < b.second.eyes;
44         }
45 };
46
47 void
48 Shuffler::video (weak_ptr<Piece> weak_piece, ContentVideo video)
49 {
50         LOG_DEBUG_THREED ("Shuffler::video frame=%1 eyes=%2 part=%3", video.frame, static_cast<int>(video.eyes), static_cast<int>(video.part));
51
52         if (video.eyes != EYES_LEFT && video.eyes != EYES_RIGHT) {
53                 /* Pass through anything that we don't care about */
54                 Video (weak_piece, video);
55                 return;
56         }
57
58         shared_ptr<Piece> piece = weak_piece.lock ();
59         DCPOMATIC_ASSERT (piece);
60
61         if (!_last && video.eyes == EYES_LEFT) {
62                 LOG_DEBUG_THREED_NC ("Shuffler first after clear");
63                 /* We haven't seen anything since the last clear() and we have some eyes-left so assume everything is OK */
64                 Video (weak_piece, video);
65                 _last = video;
66                 return;
67         }
68
69         _store.push_back (make_pair (weak_piece, video));
70         _store.sort (Comparator());
71
72         while (true) {
73
74                 bool const store_front_in_sequence =
75                         !_store.empty() &&
76                         _last &&
77                         (
78                                 (_store.front().second.frame == _last->frame       && _store.front().second.eyes == EYES_RIGHT && _last->eyes == EYES_LEFT) ||
79                                 (_store.front().second.frame >= (_last->frame + 1) && _store.front().second.eyes == EYES_LEFT  && _last->eyes == EYES_RIGHT)
80                                 );
81
82                 if (!store_front_in_sequence) {
83                         string const store = _store.empty() ? "store empty" : String::compose("store front frame=%1 eyes=%2", _store.front().second.frame, static_cast<int>(_store.front().second.eyes));
84                         string const last = _last ? String::compose("last frame=%1 eyes=%2", _last->frame, static_cast<int>(_last->eyes)) : "no last";
85                         LOG_DEBUG_THREED("Shuffler not in sequence: %1 %2", store, last);
86                 }
87
88                 if (!store_front_in_sequence && _store.size() <= _max_size) {
89                         /* store_front_in_sequence means everything is ok; otherwise if the store is getting too big just
90                            start emitting things as best we can.  This can easily happen if, for example, there is only content
91                            for one eye in some part of the timeline.
92                         */
93                         break;
94                 }
95
96                 if (_store.size() > _max_size) {
97                         LOG_WARNING ("Shuffler is full after receiving frame %1; 3D sync may be incorrect.", video.frame);
98                 }
99
100                 LOG_DEBUG_THREED("Shuffler emits frame=%1 eyes=%2 store=%3", _store.front().second.frame, static_cast<int>(_store.front().second.eyes), _store.size());
101                 Video (_store.front().first, _store.front().second);
102                 _last = _store.front().second;
103                 _store.pop_front ();
104         }
105 }
106
107 void
108 Shuffler::clear ()
109 {
110         LOG_DEBUG_THREED_NC ("Shuffler::clear");
111         _store.clear ();
112         _last = optional<ContentVideo>();
113 }
114
115 void
116 Shuffler::flush ()
117 {
118         BOOST_FOREACH (Store i, _store) {
119                 Video (i.first, i.second);
120         }
121 }