Some comments and a few small cleanups.
[dcpomatic.git] / src / lib / audio_merger.h
1 /*
2     Copyright (C) 2013-2017 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 /** @file  src/audio_merger.h
21  *  @brief AudioMerger class.
22  */
23
24 #include "audio_buffers.h"
25 #include "dcpomatic_time.h"
26 #include "util.h"
27
28 /** @class AudioMerger.
29  *  @brief A class that can merge audio data from many sources.
30  */
31 class AudioMerger
32 {
33 public:
34         AudioMerger (int frame_rate);
35
36         std::list<std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> > pull (DCPTime time);
37         void push (boost::shared_ptr<const AudioBuffers> audio, DCPTime time);
38
39 private:
40         Frame frames (DCPTime t) const;
41
42         class Buffer
43         {
44         public:
45                 /** @param c Channels
46                  *  @param f Frames
47                  *  @param t Time
48                  *  @param r Frame rate.
49                  */
50                 Buffer (int c, int32_t f, DCPTime t, int r)
51                         : audio (new AudioBuffers (c, f))
52                         , time (t)
53                         , frame_rate (r)
54                 {}
55
56                 Buffer (boost::shared_ptr<AudioBuffers> a, DCPTime t, int r)
57                         : audio (a)
58                         , time (t)
59                         , frame_rate (r)
60                 {}
61
62                 boost::shared_ptr<AudioBuffers> audio;
63                 DCPTime time;
64                 int frame_rate;
65
66                 DCPTimePeriod period () const {
67                         return DCPTimePeriod (time, time + DCPTime::from_frames (audio->frames(), frame_rate));
68                 }
69         };
70
71         class BufferComparator
72         {
73         public:
74                 bool operator() (AudioMerger::Buffer const & a, AudioMerger::Buffer const & b)
75                 {
76                         return a.time < b.time;
77                 }
78         };
79
80         std::list<Buffer> _buffers;
81         DCPTime _last_pull;
82         int _frame_rate;
83 };