Merge branch 'sync-fixes' into staging

[dcpomatic.git] / src / lib / audio_decoder.h

diff --git a/src/lib/audio_decoder.h b/src/lib/audio_decoder.h
index 6e89f6144da605a16071439b63879971e70d1918..cfe94b5283dc48c06a83e516b526c789dae46861 100644 (file)
--- a/src/lib/audio_decoder.h
+++ b/src/lib/audio_decoder.h
@@ -17,6 +17,10 @@
 
 */
 
+/** @file src/lib/audio_decoder.h
+ *  @brief Parent class for audio decoders.
+ */
+
 #ifndef DVDOMATIC_AUDIO_DECODER_H
 #define DVDOMATIC_AUDIO_DECODER_H
 
@@ -24,24 +28,31 @@
 #include "stream.h"
 #include "decoder.h"
 
-class AudioDecoder : public AudioSource, public virtual Decoder
+/** @class AudioDecoder.
+ *  @brief Parent class for audio decoders.
+ */
+class AudioDecoder : public TimedAudioSource, public virtual Decoder
 {
 public:
-       AudioDecoder (boost::shared_ptr<Film>, boost::shared_ptr<const Options>, Job *);
+       AudioDecoder (boost::shared_ptr<Film>, DecodeOptions);
 
-       virtual void set_audio_stream (boost::optional<AudioStream>);
+       virtual void set_audio_stream (boost::shared_ptr<AudioStream>);
 
-       boost::optional<AudioStream> audio_stream () const {
+       /** @return Audio stream that we are using */
+       boost::shared_ptr<AudioStream> audio_stream () const {
                return _audio_stream;
        }
 
-       std::vector<AudioStream> audio_streams () const {
+       /** @return All available audio streams */
+       std::vector<boost::shared_ptr<AudioStream> > audio_streams () const {
                return _audio_streams;
        }
 
 protected:
-       boost::optional<AudioStream> _audio_stream;
-       std::vector<AudioStream> _audio_streams;
+       /** Audio stream that we are using */
+       boost::shared_ptr<AudioStream> _audio_stream;
+       /** All available audio streams */
+       std::vector<boost::shared_ptr<AudioStream> > _audio_streams;
 };
 
 #endif