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