Rename some methods.
[dcpomatic.git] / src / lib / audio_decoder.h
1 /*
2     Copyright (C) 2012-2016 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/lib/audio_decoder.h
21  *  @brief Parent class for audio decoders.
22  */
23
24 #ifndef DCPOMATIC_AUDIO_DECODER_H
25 #define DCPOMATIC_AUDIO_DECODER_H
26
27 #include "decoder.h"
28 #include "content_audio.h"
29 #include "audio_stream.h"
30 #include <boost/enable_shared_from_this.hpp>
31
32 class AudioBuffers;
33 class AudioContent;
34 class AudioDecoderStream;
35 class Log;
36
37 /** @class AudioDecoder.
38  *  @brief Parent class for audio decoders.
39  */
40 class AudioDecoder : public boost::enable_shared_from_this<AudioDecoder>
41 {
42 public:
43         AudioDecoder (Decoder* parent, boost::shared_ptr<const AudioContent>, bool fast, boost::shared_ptr<Log> log);
44
45         /** Try to fetch some audio from a specific place in this content.
46          *  @param frame Frame to start from (after resampling, if applicable)
47          *  @param length Frames to get (after resampling, if applicable)
48          *  @param accurate true to try hard to return frames from exactly `frame', false if we don't mind nearby frames.
49          *  @return Time-stamped audio data which may or may not be from the location (and of the length) requested.
50          */
51         ContentAudio get (AudioStreamPtr stream, Frame time, Frame length, bool accurate);
52
53         void set_ignore ();
54
55         bool fast () const {
56                 return _fast;
57         }
58
59         void give (AudioStreamPtr stream, boost::shared_ptr<const AudioBuffers>, ContentTime);
60         void flush ();
61         void seek (ContentTime t, bool accurate);
62
63 private:
64         /** An AudioDecoderStream object to manage each stream in _audio_content */
65         std::map<AudioStreamPtr, boost::shared_ptr<AudioDecoderStream> > _streams;
66         bool _ignore;
67         bool _fast;
68 };
69
70 #endif