src/lib/audio_decoder.h

   1 /*
   2     Copyright (C) 2012-2014 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
  36 /** @class AudioDecoder.
  37  *  @brief Parent class for audio decoders.
  38  */
  39 class AudioDecoder : public virtual Decoder, public boost::enable_shared_from_this<AudioDecoder>
  40 {
  41 public:
  42         AudioDecoder (boost::shared_ptr<const AudioContent>, bool fast);
  43
  44         boost::shared_ptr<const AudioContent> audio_content () const {
  45                 return _audio_content;
  46         }
  47
  48         /** Try to fetch some audio from a specific place in this content.
  49          *  @param frame Frame to start from (after resampling, if applicable)
  50          *  @param length Frames to get (after resampling, if applicable)
  51          *  @param accurate true to try hard to return frames from exactly `frame', false if we don't mind nearby frames.
  52          *  @return Time-stamped audio data which may or may not be from the location (and of the length) requested.
  53          */
  54         ContentAudio get_audio (AudioStreamPtr stream, Frame time, Frame length, bool accurate);
  55
  56         void set_ignore_audio ();
  57
  58         bool fast () const {
  59                 return _fast;
  60         }
  61
  62 protected:
  63         void audio (AudioStreamPtr stream, boost::shared_ptr<const AudioBuffers>, ContentTime);
  64         void flush ();
  65         void seek (ContentTime t, bool accurate);
  66
  67 private:
  68         boost::shared_ptr<const AudioContent> _audio_content;
  69         /** An AudioDecoderStream object to manage each stream in _audio_content */
  70         std::map<AudioStreamPtr, boost::shared_ptr<AudioDecoderStream> > _streams;
  71         bool _ignore_audio;
  72         bool _fast;
  73 };
  74
  75 #endif