src/lib/audio_ring_buffers.h

   1 /*
   2     Copyright (C) 2016-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_AUDIO_RING_BUFFERS_H
  23 #define DCPOMATIC_AUDIO_RING_BUFFERS_H
  24
  25
  26 #include "audio_buffers.h"
  27 #include "types.h"
  28 #include "dcpomatic_time.h"
  29 #include <boost/thread.hpp>
  30 #include <list>
  31
  32
  33 class AudioRingBuffers
  34 {
  35 public:
  36         AudioRingBuffers ();
  37
  38         AudioRingBuffers (AudioBuffers const&) = delete;
  39         AudioRingBuffers& operator= (AudioBuffers const&) = delete;
  40
  41         void put (std::shared_ptr<const AudioBuffers> data, dcpomatic::DCPTime time, int frame_rate);
  42         boost::optional<dcpomatic::DCPTime> get (float* out, int channels, int frames);
  43         boost::optional<dcpomatic::DCPTime> peek () const;
  44
  45         void clear ();
  46         /** @return number of frames currently available */
  47         Frame size () const;
  48
  49 private:
  50         mutable boost::mutex _mutex;
  51         std::list<std::pair<std::shared_ptr<const AudioBuffers>, dcpomatic::DCPTime> > _buffers;
  52         int _used_in_head = 0;
  53 };
  54
  55
  56 #endif