diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/lib/audio_content.h | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/src/lib/audio_content.h b/src/lib/audio_content.h index b9ca997a7..60d53b343 100644 --- a/src/lib/audio_content.h +++ b/src/lib/audio_content.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2013 Carl Hetherington <cth@carlh.net> + Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net> 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,8 +58,11 @@ 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; + /** @return the length of the audio in the content */ virtual ContentTime audio_length () const = 0; + /** @return the frame rate of the content */ virtual int content_audio_frame_rate () const = 0; virtual int output_audio_frame_rate () const = 0; virtual AudioMapping audio_mapping () const = 0; |