Updated cs_CZ translation from Tomáš Begeni.
[dcpomatic.git] / src / lib / audio_content.h
index 2c324a3a4966e0dad899c10f24f3f99115317420..084871c8ba8bb6e6da951e0faa885fa6f9532596 100644 (file)
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
+
+/** @file  src/lib/audio_content.h
+ *  @brief AudioContent and AudioContentProperty classes.
+ */
+
+
 #ifndef DCPOMATIC_AUDIO_CONTENT_H
 #define DCPOMATIC_AUDIO_CONTENT_H
 
-#include "content.h"
+
 #include "audio_mapping.h"
+#include "audio_stream.h"
+#include "content_part.h"
+#include "named_channel.h"
 
-namespace cxml {
-       class Node;
-}
 
+/** @class AudioContentProperty
+ *  @brief Names for properties of AudioContent.
+ */
 class AudioContentProperty
 {
 public:
-       static int const AUDIO_CHANNELS;
-       static int const AUDIO_LENGTH;
-       static int const AUDIO_FRAME_RATE;
-       static int const AUDIO_GAIN;
-       static int const AUDIO_DELAY;
-       static int const AUDIO_MAPPING;
+       static int const STREAMS;
+       static int const GAIN;
+       static int const DELAY;
+       static int const FADE_IN;
+       static int const FADE_OUT;
+       static int const USE_SAME_FADES_AS_VIDEO;
 };
 
-class AudioContent : public virtual Content
+
+class AudioContent : public ContentPart
 {
 public:
-       typedef int64_t Frame;
-       
-       AudioContent (boost::shared_ptr<const Film>, Time);
-       AudioContent (boost::shared_ptr<const Film>, boost::filesystem::path);
-       AudioContent (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
-       AudioContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
+       explicit AudioContent (Content* parent);
+       AudioContent (Content* parent, std::vector<std::shared_ptr<Content>>);
+       AudioContent (Content* parent, cxml::ConstNodePtr);
 
        void as_xml (xmlpp::Node *) const;
        std::string technical_summary () const;
+       void take_settings_from (std::shared_ptr<const AudioContent> c);
+
+       AudioMapping mapping () const;
+       void set_mapping (AudioMapping);
+       int resampled_frame_rate (std::shared_ptr<const Film> film) const;
+       std::vector<NamedChannel> channel_names () const;
+
+       /** Set gain in dB */
+       void set_gain (double);
+       /** Set delay in milliseconds (positive moves audio later) */
+       void set_delay (int);
+
+       double gain () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _gain;
+       }
 
-       virtual int audio_channels () const = 0;
-       virtual AudioContent::Frame audio_length () const = 0;
-       virtual int content_audio_frame_rate () const = 0;
-       virtual AudioMapping audio_mapping () const = 0;
-       virtual void set_audio_mapping (AudioMapping) = 0;
-       virtual boost::filesystem::path audio_analysis_path () const;
-
-       int output_audio_frame_rate () const;
-       
-       boost::signals2::connection analyse_audio (boost::function<void()>);
-
-       void set_audio_gain (double);
-       void set_audio_delay (int);
-       
-       double audio_gain () const {
+       int delay () const {
                boost::mutex::scoped_lock lm (_mutex);
-               return _audio_gain;
+               return _delay;
        }
 
-       int audio_delay () const {
+       dcpomatic::ContentTime fade_in () const;
+       dcpomatic::ContentTime fade_out () const;
+
+       void set_fade_in (dcpomatic::ContentTime time);
+       void set_fade_out (dcpomatic::ContentTime time);
+       void set_use_same_fades_as_video (bool s);
+
+       std::string processing_description (std::shared_ptr<const Film> film) const;
+
+       std::vector<AudioStreamPtr> streams () const {
                boost::mutex::scoped_lock lm (_mutex);
-               return _audio_delay;
+               return _streams;
        }
 
+       void add_stream (AudioStreamPtr stream);
+       void set_stream (AudioStreamPtr stream);
+       AudioStreamPtr stream () const;
+
+       void add_properties (std::shared_ptr<const Film> film, std::list<UserProperty> &) const;
+
+       void modify_position (std::shared_ptr<const Film> film, dcpomatic::DCPTime& pos) const;
+       void modify_trim_start(std::shared_ptr<const Film> film, dcpomatic::ContentTime& pos) const;
+
+       /** @param frame frame within the whole (untrimmed) content.
+        *  @param frame_rate The frame rate of the audio (it may have been resampled).
+        *  @return a fade coefficient for @ref length samples starting at an offset @frame within
+        *  the content, or an empty vector if the given section has no fade.
+        */
+       std::vector<float> fade (AudioStreamPtr stream, Frame frame, Frame length, int frame_rate) const;
+
+       static std::shared_ptr<AudioContent> from_xml (Content* parent, cxml::ConstNodePtr, int version);
+
 private:
+
        /** Gain to apply to audio in dB */
-       double _audio_gain;
+       double _gain = 0;
        /** Delay to apply to audio (positive moves audio later) in milliseconds */
-       int _audio_delay;
+       int _delay = 0;
+       dcpomatic::ContentTime _fade_in;
+       dcpomatic::ContentTime _fade_out;
+       bool _use_same_fades_as_video = false;
+       std::vector<AudioStreamPtr> _streams;
 };
 
 #endif