src/lib/text_ring_buffers.h

   1 /*
   2     Copyright (C) 2018-2021 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
  22 #ifndef DCPOMATIC_TEXT_RING_BUFFERS_H
  23 #define DCPOMATIC_TEXT_RING_BUFFERS_H
  24
  25
  26 #include "dcp_text_track.h"
  27 #include "player_text.h"
  28 #include <boost/thread.hpp>
  29 #include <utility>
  30
  31
  32 class TextRingBuffers
  33 {
  34 public:
  35         void put (PlayerText text, DCPTextTrack track, dcpomatic::DCPTimePeriod period);
  36
  37         struct Data {
  38                 Data (PlayerText text_, DCPTextTrack track_, dcpomatic::DCPTimePeriod period_)
  39                         : text (text_)
  40                         , track (track_)
  41                         , period (period_)
  42                 {}
  43
  44                 PlayerText text;
  45                 DCPTextTrack track;
  46                 dcpomatic::DCPTimePeriod period;
  47         };
  48
  49         boost::optional<Data> get ();
  50         void clear ();
  51
  52 private:
  53         boost::mutex _mutex;
  54
  55         std::list<Data> _data;
  56 };
  57
  58
  59 #endif