X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Faudio_content.h;h=09f90b85c256c7f4327938d838a29e414219d6cc;hb=cfdd68eb5fb0ef8423e860103ad4e5510994f1da;hp=0b2ee2e461fe6b001d98509b6481efb61a214657;hpb=e8c1880a2b9a40eb11ee259feee3edd799139a43;p=dcpomatic.git diff --git a/src/lib/audio_content.h b/src/lib/audio_content.h index 0b2ee2e46..09f90b85c 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,6 +42,9 @@ public: static int const AUDIO_MAPPING; }; +/** @class AudioContent + * @brief Parent class for content which may contain audio data. + */ class AudioContent : public virtual Content { public: @@ -51,15 +58,19 @@ public: void as_xml (xmlpp::Node *) const; std::string technical_summary () const; + /** @return number of audio channels in the content */ virtual int audio_channels () const = 0; - virtual AudioFrame audio_length () const = 0; - virtual int content_audio_frame_rate () const = 0; - virtual int output_audio_frame_rate () 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; boost::signals2::connection analyse_audio (boost::function); - boost::filesystem::path audio_analysis_path () const; void set_audio_gain (float); void set_audio_delay (int); @@ -74,8 +85,6 @@ public: return _audio_delay; } - Frame time_to_content_audio_frames (DCPTime, DCPTime) const; - private: /** Gain to apply to audio in dB */ float _audio_gain;