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.h"
  29 #include "audio_content.h"
  30 #include "content_audio.h"
  31
  32 class AudioBuffers;
  33 class Resampler;
  34
  35 /** @class AudioDecoder.
  36  *  @brief Parent class for audio decoders.
  37  */
  38 class AudioDecoder : public virtual Decoder
  39 {
  40 public:
  41         AudioDecoder (boost::shared_ptr<const AudioContent>);
  42
  43         boost::shared_ptr<const AudioContent> audio_content () const {
  44                 return _audio_content;
  45         }
  46
  47         /** Try to fetch some audio from a specific place in this content.
  48          *  @param frame Frame to start from.
  49          *  @param length Frames to get.
  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         boost::shared_ptr<ContentAudio> get_audio (AudioFrame time, AudioFrame length, bool accurate);
  54
  55 protected:
  56
  57         void seek (ContentTime time, bool accurate);
  58         void audio (boost::shared_ptr<const AudioBuffers>, ContentTime);
  59         void flush ();
  60
  61         boost::shared_ptr<const AudioContent> _audio_content;
  62         boost::shared_ptr<Resampler> _resampler;
  63         boost::optional<AudioFrame> _audio_position;
  64         /** Currently-available decoded audio data */
  65         ContentAudio _decoded_audio;
  66 };
  67
  68 #endif