src/lib/audio_content.h

   1 /*
   2     Copyright (C) 2013-2016 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_content.h
  21  *  @brief AudioContent and AudioContentProperty classes.
  22  */
  23
  24 #ifndef DCPOMATIC_AUDIO_CONTENT_H
  25 #define DCPOMATIC_AUDIO_CONTENT_H
  26
  27 #include "content.h"
  28 #include "audio_stream.h"
  29 #include "audio_mapping.h"
  30
  31 /** @class AudioContentProperty
  32  *  @brief Names for properties of AudioContent.
  33  */
  34 class AudioContentProperty
  35 {
  36 public:
  37         static int const AUDIO_STREAMS;
  38         static int const AUDIO_GAIN;
  39         static int const AUDIO_DELAY;
  40         static int const AUDIO_VIDEO_FRAME_RATE;
  41 };
  42
  43 /** @class AudioContent
  44  *  @brief Parent class for content which may contain audio data.
  45  */
  46 class AudioContent : public virtual Content
  47 {
  48 public:
  49         AudioContent (boost::shared_ptr<const Film>);
  50         AudioContent (boost::shared_ptr<const Film>, DCPTime);
  51         AudioContent (boost::shared_ptr<const Film>, boost::filesystem::path);
  52         AudioContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr);
  53         AudioContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  54
  55         void as_xml (xmlpp::Node *) const;
  56         std::string technical_summary () const;
  57
  58         virtual std::vector<AudioStreamPtr> audio_streams () const = 0;
  59
  60         AudioMapping audio_mapping () const;
  61         void set_audio_mapping (AudioMapping);
  62         int resampled_audio_frame_rate () const;
  63         bool has_rate_above_48k () const;
  64         std::vector<std::string> audio_channel_names () const;
  65
  66         void set_audio_gain (double);
  67         void set_audio_delay (int);
  68
  69         double audio_gain () const {
  70                 boost::mutex::scoped_lock lm (_mutex);
  71                 return _audio_gain;
  72         }
  73
  74         int audio_delay () const {
  75                 boost::mutex::scoped_lock lm (_mutex);
  76                 return _audio_delay;
  77         }
  78
  79         double audio_video_frame_rate () const;
  80         void set_audio_video_frame_rate (double r);
  81
  82         std::string processing_description () const;
  83
  84 protected:
  85
  86         void add_properties (std::list<UserProperty> &) const;
  87
  88 private:
  89         /** Gain to apply to audio in dB */
  90         double _audio_gain;
  91         /** Delay to apply to audio (positive moves audio later) in milliseconds */
  92         int _audio_delay;
  93         boost::optional<double> _audio_video_frame_rate;
  94 };
  95
  96 #endif