src/lib/audio_decoder.h

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