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_part.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 STREAMS;
  38         static int const GAIN;
  39         static int const DELAY;
  40 };
  41
  42 class AudioContent : public ContentPart
  43 {
  44 public:
  45         AudioContent (Content* parent, boost::shared_ptr<const Film>);
  46         AudioContent (Content* parent, boost::shared_ptr<const Film>, cxml::ConstNodePtr);
  47         AudioContent (Content* parent, boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  48
  49         void as_xml (xmlpp::Node *) const;
  50         std::string technical_summary () const;
  51
  52         AudioMapping mapping () const;
  53         void set_mapping (AudioMapping);
  54         int resampled_frame_rate () const;
  55         bool has_rate_above_48k () const;
  56         std::vector<std::string> channel_names () const;
  57
  58         void set_gain (double);
  59         void set_delay (int);
  60
  61         double gain () const {
  62                 boost::mutex::scoped_lock lm (_mutex);
  63                 return _gain;
  64         }
  65
  66         int delay () const {
  67                 boost::mutex::scoped_lock lm (_mutex);
  68                 return _delay;
  69         }
  70
  71         std::string processing_description () const;
  72
  73         std::vector<AudioStreamPtr> streams () const {
  74                 boost::mutex::scoped_lock lm (_mutex);
  75                 return _streams;
  76         }
  77
  78         void add_stream (AudioStreamPtr stream);
  79         void set_stream (AudioStreamPtr stream);
  80         void set_streams (std::vector<AudioStreamPtr> streams);
  81         AudioStreamPtr stream () const;
  82
  83         void add_properties (std::list<UserProperty> &) const;
  84
  85 private:
  86
  87         /** Gain to apply to audio in dB */
  88         double _gain;
  89         /** Delay to apply to audio (positive moves audio later) in milliseconds */
  90         int _delay;
  91         std::vector<AudioStreamPtr> _streams;
  92 };
  93
  94 #endif