src/lib/audio_content.h

   1 /*
   2     Copyright (C) 2013-2021 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
  22 /** @file  src/lib/audio_content.h
  23  *  @brief AudioContent and AudioContentProperty classes.
  24  */
  25
  26
  27 #ifndef DCPOMATIC_AUDIO_CONTENT_H
  28 #define DCPOMATIC_AUDIO_CONTENT_H
  29
  30
  31 #include "content_part.h"
  32 #include "audio_stream.h"
  33 #include "audio_mapping.h"
  34
  35
  36 /** @class AudioContentProperty
  37  *  @brief Names for properties of AudioContent.
  38  */
  39 class AudioContentProperty
  40 {
  41 public:
  42         static int const STREAMS;
  43         static int const GAIN;
  44         static int const DELAY;
  45 };
  46
  47
  48 class AudioContent : public ContentPart
  49 {
  50 public:
  51         explicit AudioContent (Content* parent);
  52         AudioContent (Content* parent, std::vector<std::shared_ptr<Content>>);
  53         AudioContent (Content* parent, cxml::ConstNodePtr);
  54
  55         void as_xml (xmlpp::Node *) const;
  56         std::string technical_summary () const;
  57         void take_settings_from (std::shared_ptr<const AudioContent> c);
  58
  59         AudioMapping mapping () const;
  60         void set_mapping (AudioMapping);
  61         int resampled_frame_rate (std::shared_ptr<const Film> film) const;
  62         std::vector<NamedChannel> channel_names () const;
  63
  64         /** Set gain in dB.
  65          *  @param double g New gain in dB.
  66          */
  67         void set_gain (double g);
  68         void set_delay (int);
  69
  70         double gain () const {
  71                 boost::mutex::scoped_lock lm (_mutex);
  72                 return _gain;
  73         }
  74
  75         int delay () const {
  76                 boost::mutex::scoped_lock lm (_mutex);
  77                 return _delay;
  78         }
  79
  80         std::string processing_description (std::shared_ptr<const Film> film) const;
  81
  82         std::vector<AudioStreamPtr> streams () const {
  83                 boost::mutex::scoped_lock lm (_mutex);
  84                 return _streams;
  85         }
  86
  87         void add_stream (AudioStreamPtr stream);
  88         void set_stream (AudioStreamPtr stream);
  89         void set_streams (std::vector<AudioStreamPtr> streams);
  90         AudioStreamPtr stream () const;
  91
  92         void add_properties (std::shared_ptr<const Film> film, std::list<UserProperty> &) const;
  93
  94         void modify_position (std::shared_ptr<const Film> film, dcpomatic::DCPTime& pos) const;
  95         void modify_trim_start (dcpomatic::ContentTime& pos) const;
  96
  97         static std::shared_ptr<AudioContent> from_xml (Content* parent, cxml::ConstNodePtr, int version);
  98
  99 private:
 100
 101         /** Gain to apply to audio in dB */
 102         double _gain = 0;
 103         /** Delay to apply to audio (positive moves audio later) in milliseconds */
 104         int _delay = 0;
 105         std::vector<AudioStreamPtr> _streams;
 106 };
 107
 108 #endif