X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Faudio_content.h;h=1ceb01f780edd20cb91fc4849527e9d27df64d5a;hb=8102046b2f29e0c7b234c29bf204b056cb30e64f;hp=9bf53e0ab4d044ac379c6f45decd7d00ba4f932f;hpb=d0d584a7dde6de383302615634fdee17e9724fe8;p=dcpomatic.git diff --git a/src/lib/audio_content.h b/src/lib/audio_content.h index 9bf53e0ab..1ceb01f78 100644 --- a/src/lib/audio_content.h +++ b/src/lib/audio_content.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2013 Carl Hetherington + Copyright (C) 2013-2014 Carl Hetherington This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -17,6 +17,10 @@ */ +/** @file src/lib/audio_content.h + * @brief AudioContent and AudioContentProperty classes. + */ + #ifndef DCPOMATIC_AUDIO_CONTENT_H #define DCPOMATIC_AUDIO_CONTENT_H @@ -38,27 +42,35 @@ public: static int const AUDIO_MAPPING; }; +/** @class AudioContent + * @brief Parent class for content which may contain audio data. + */ class AudioContent : public virtual Content { public: typedef int64_t Frame; - AudioContent (boost::shared_ptr, Time); + AudioContent (boost::shared_ptr, DCPTime); AudioContent (boost::shared_ptr, boost::filesystem::path); - AudioContent (boost::shared_ptr, boost::shared_ptr); - AudioContent (AudioContent const &); + AudioContent (boost::shared_ptr, cxml::ConstNodePtr); + AudioContent (boost::shared_ptr, std::vector >); void as_xml (xmlpp::Node *) const; - - virtual int audio_channels () const = 0; - virtual AudioContent::Frame audio_length () const = 0; - virtual int content_audio_frame_rate () const = 0; - virtual int output_audio_frame_rate () const = 0; + std::string technical_summary () const; + + /** @return number of audio channels in the content */ + virtual int audio_channels () const = 0; + /** @return the length of the audio in the content */ + virtual ContentTime audio_length () const = 0; + /** @return the frame rate of the content */ + virtual int audio_frame_rate () const = 0; virtual AudioMapping audio_mapping () const = 0; - virtual void set_audio_mapping (AudioMapping) = 0; + virtual void set_audio_mapping (AudioMapping); + virtual boost::filesystem::path audio_analysis_path () const; + + int resampled_audio_frame_rate () const; - void analyse_audio (boost::function); - boost::filesystem::path audio_analysis_path () const; + boost::signals2::connection analyse_audio (boost::function); void set_audio_gain (float); void set_audio_delay (int);