src/lib/audio_content.h

   1 /*
   2     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file  src/lib/audio_content.h
  22  *  @brief AudioContent and AudioContentProperty classes.
  23  */
  24
  25 #ifndef DCPOMATIC_AUDIO_CONTENT_H
  26 #define DCPOMATIC_AUDIO_CONTENT_H
  27
  28 #include "content_part.h"
  29 #include "audio_stream.h"
  30 #include "audio_mapping.h"
  31
  32 /** @class AudioContentProperty
  33  *  @brief Names for properties of AudioContent.
  34  */
  35 class AudioContentProperty
  36 {
  37 public:
  38         static int const STREAMS;
  39         static int const GAIN;
  40         static int const DELAY;
  41 };
  42
  43 class AudioContent : public ContentPart
  44 {
  45 public:
  46         AudioContent (Content* parent);
  47         AudioContent (Content* parent, 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         static boost::shared_ptr<AudioContent> from_xml (Content* parent, cxml::ConstNodePtr);
  86
  87 private:
  88
  89         AudioContent (Content* parent, cxml::ConstNodePtr);
  90
  91         /** Gain to apply to audio in dB */
  92         double _gain;
  93         /** Delay to apply to audio (positive moves audio later) in milliseconds */
  94         int _delay;
  95         std::vector<AudioStreamPtr> _streams;
  96 };
  97
  98 #endif