832837d9422a59fe1a2cbd063f953ab740dd4a30
[dcpomatic.git] / src / lib / video_ring_buffers.h
1 /*
2     Copyright (C) 2016-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 "dcpomatic_time.h"
22 #include "player_video.h"
23 #include "types.h"
24 #include <boost/noncopyable.hpp>
25 #include <boost/thread/mutex.hpp>
26 #include <utility>
27
28
29 class Film;
30 class PlayerVideo;
31
32
33 class VideoRingBuffers : public boost::noncopyable
34 {
35 public:
36         void put (std::shared_ptr<PlayerVideo> frame, dcpomatic::DCPTime time);
37         std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> get ();
38
39         void clear ();
40         Frame size () const;
41         bool empty () const;
42
43         void reset_metadata (std::shared_ptr<const Film> film, dcp::Size player_video_container_size);
44
45         std::pair<size_t, std::string> memory_used () const;
46
47 private:
48         mutable boost::mutex _mutex;
49         std::list<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> > _data;
50 };