Add fade in/out option to the content audio tab (#1026).
[dcpomatic.git] / src / lib / audio_content.h
index 83a5e327e87c02c0da9f98d987269bd858e72f6d..ba998a5ad5f62e414008c0474a56b226849ab142 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
+
 /** @file  src/lib/audio_content.h
  *  @brief AudioContent and AudioContentProperty classes.
  */
 
+
 #ifndef DCPOMATIC_AUDIO_CONTENT_H
 #define DCPOMATIC_AUDIO_CONTENT_H
 
+
 #include "content_part.h"
 #include "audio_stream.h"
 #include "audio_mapping.h"
 
+
 /** @class AudioContentProperty
  *  @brief Names for properties of AudioContent.
  */
@@ -38,13 +42,17 @@ public:
        static int const STREAMS;
        static int const GAIN;
        static int const DELAY;
+       static int const FADE_IN;
+       static int const FADE_OUT;
 };
 
+
 class AudioContent : public ContentPart
 {
 public:
        explicit AudioContent (Content* parent);
-       AudioContent (Content* parent, std::vector<std::shared_ptr<Content> >);
+       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;
@@ -55,7 +63,9 @@ public:
        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 {
@@ -68,6 +78,19 @@ public:
                return _delay;
        }
 
+       dcpomatic::ContentTime fade_in () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _fade_in;
+       }
+
+       dcpomatic::ContentTime fade_out () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _fade_out;
+       }
+
+       void set_fade_in (dcpomatic::ContentTime time);
+       void set_fade_out (dcpomatic::ContentTime time);
+
        std::string processing_description (std::shared_ptr<const Film> film) const;
 
        std::vector<AudioStreamPtr> streams () const {
@@ -85,16 +108,23 @@ public:
        void modify_position (std::shared_ptr<const Film> film, dcpomatic::DCPTime& pos) const;
        void modify_trim_start (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:
 
-       AudioContent (Content* parent, cxml::ConstNodePtr);
-
        /** Gain to apply to audio in dB */
-       double _gain;
+       double _gain = 0;
        /** Delay to apply to audio (positive moves audio later) in milliseconds */
-       int _delay;
+       int _delay = 0;
+       dcpomatic::ContentTime _fade_in;
+       dcpomatic::ContentTime _fade_out;
        std::vector<AudioStreamPtr> _streams;
 };