std::shared_ptr
[dcpomatic.git] / src / lib / video_content.h
index 7d9cb4f8f0298eccb5a307b37612b5ab8e6e95be..e5bbb5bab066bdcb495700c12aa4faf2cb90151f 100644 (file)
 /*
-    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2020 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/>.
 
 */
 
 #ifndef DCPOMATIC_VIDEO_CONTENT_H
 #define DCPOMATIC_VIDEO_CONTENT_H
 
-#include "content.h"
 #include "colour_conversion.h"
+#include "dcpomatic_time.h"
+#include "user_property.h"
+#include "types.h"
+#include "content_part.h"
+#include <boost/thread/mutex.hpp>
 
 class VideoExaminer;
 class Ratio;
+class Film;
+class Content;
 
 class VideoContentProperty
 {
 public:
-       static int const VIDEO_SIZE;
-       static int const VIDEO_FRAME_RATE;
-       static int const VIDEO_FRAME_TYPE;
-       static int const VIDEO_CROP;
-       static int const VIDEO_SCALE;
+       static int const USE;
+       static int const SIZE;
+       static int const FRAME_TYPE;
+       static int const CROP;
+       static int const SCALE;
        static int const COLOUR_CONVERSION;
+       static int const FADE_IN;
+       static int const FADE_OUT;
+       static int const RANGE;
+       static int const CUSTOM_RATIO;
+       static int const CUSTOM_SIZE;
 };
 
-class VideoContentScale
-{
-public:
-       VideoContentScale ();
-       VideoContentScale (Ratio const *);
-       VideoContentScale (bool);
-       VideoContentScale (cxml::NodePtr);
-
-       dcp::Size size (boost::shared_ptr<const VideoContent>, dcp::Size, dcp::Size) const;
-       std::string id () const;
-       std::string name () const;
-       void as_xml (xmlpp::Node *) const;
-
-       Ratio const * ratio () const {
-               return _ratio;
-       }
-
-       bool scale () const {
-               return _scale;
-       }
-
-       static void setup_scales ();
-       static std::vector<VideoContentScale> all () {
-               return _scales;
-       }
-
-private:
-       /** a ratio to stretch the content to, or 0 for no stretch */
-       Ratio const * _ratio;
-       /** true if we want to scale the content */
-       bool _scale;
-
-       static std::vector<VideoContentScale> _scales;
-};
-
-bool operator== (VideoContentScale const & a, VideoContentScale const & b);
-bool operator!= (VideoContentScale const & a, VideoContentScale const & b);
-
-class VideoContent : public virtual Content
+class VideoContent : public ContentPart, public std::enable_shared_from_this<VideoContent>
 {
 public:
-       typedef int Frame;
-
-       VideoContent (boost::shared_ptr<const Film>);
-       VideoContent (boost::shared_ptr<const Film>, DCPTime, ContentTime);
-       VideoContent (boost::shared_ptr<const Film>, boost::filesystem::path);
-       VideoContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int);
-       VideoContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
+       explicit VideoContent (Content* parent);
+       VideoContent (Content* parent, std::vector<std::shared_ptr<Content> >);
 
        void as_xml (xmlpp::Node *) const;
        std::string technical_summary () const;
-       virtual std::string information () const;
-       virtual std::string identifier () const;
+       std::string identifier () const;
+       void take_settings_from (std::shared_ptr<const VideoContent> c);
 
-       ContentTime video_length () const {
+       Frame length () const {
                boost::mutex::scoped_lock lm (_mutex);
-               return _video_length;
+               return _length;
        }
 
-       ContentTime video_length_after_3d_combine () const {
+       Frame length_after_3d_combine () const {
                boost::mutex::scoped_lock lm (_mutex);
-               if (_video_frame_type == VIDEO_FRAME_TYPE_3D_ALTERNATE) {
-                       return ContentTime (_video_length.get() / 2);
+               if (_frame_type == VIDEO_FRAME_TYPE_3D_ALTERNATE) {
+                       return _length / 2;
                }
-               
-               return _video_length;
-       }
 
-       dcp::Size video_size () const {
-               boost::mutex::scoped_lock lm (_mutex);
-               return _video_size;
+               return _length;
        }
-       
-       float video_frame_rate () const {
+
+       dcp::Size size () const {
                boost::mutex::scoped_lock lm (_mutex);
-               return _video_frame_rate;
+               return _size;
        }
 
-       void set_video_frame_type (VideoFrameType);
-       void set_video_frame_rate (float);
+       void set_frame_type (VideoFrameType);
 
        void set_left_crop (int);
        void set_right_crop (int);
        void set_top_crop (int);
        void set_bottom_crop (int);
 
-       void set_scale (VideoContentScale);
+       void set_custom_ratio (boost::optional<float> ratio);
+       void set_custom_size (boost::optional<dcp::Size> size);
+
+       void unset_colour_conversion ();
        void set_colour_conversion (ColourConversion);
-       
-       VideoFrameType video_frame_type () const {
+
+       void set_fade_in (Frame);
+       void set_fade_out (Frame);
+
+       void set_range (VideoRange);
+       void set_use (bool);
+
+       VideoFrameType frame_type () const {
                boost::mutex::scoped_lock lm (_mutex);
-               return _video_frame_type;
+               return _frame_type;
        }
 
        Crop crop () const {
@@ -156,44 +128,109 @@ public:
                return _crop.bottom;
        }
 
-       /** @return Description of how to scale this content (if indeed it should be scaled) */
-       VideoContentScale scale () const {
+
+       boost::optional<float> custom_ratio () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _custom_ratio;
+       }
+
+
+       boost::optional<dcp::Size> custom_size () const {
                boost::mutex::scoped_lock lm (_mutex);
-               return _scale;
+               return _custom_size;
        }
 
-       ColourConversion colour_conversion () const {
+
+       boost::optional<ColourConversion> colour_conversion () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _colour_conversion;
        }
 
-       dcp::Size video_size_after_3d_split () const;
-       dcp::Size video_size_after_crop () const;
+       boost::optional<double> sample_aspect_ratio () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _sample_aspect_ratio;
+       }
+
+       bool yuv () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _yuv;
+       }
+
+       Frame fade_in () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _fade_in;
+       }
+
+       Frame fade_out () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _fade_out;
+       }
 
-       ContentTime dcp_time_to_content_time (DCPTime) const;
+       VideoRange range () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _range;
+       }
+
+       bool use () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _use;
+       }
 
-       void scale_and_crop_to_fit_width ();
-       void scale_and_crop_to_fit_height ();
+       /* XXX: names for these? */
+       dcp::Size size_after_3d_split () const;
+       dcp::Size size_after_crop () const;
+       dcp::Size scaled_size (dcp::Size container_size);
 
-protected:
-       void take_from_video_examiner (boost::shared_ptr<VideoExaminer>);
+       boost::optional<double> fade (std::shared_ptr<const Film> film, Frame) const;
 
-       ContentTime _video_length;
-       float _video_frame_rate;
+       std::string processing_description (std::shared_ptr<const Film> film);
+
+       void set_length (Frame);
+
+       void take_from_examiner (std::shared_ptr<VideoExaminer>);
+       void add_properties (std::list<UserProperty> &) const;
+
+       void modify_position (std::shared_ptr<const Film> film, dcpomatic::DCPTime& pos) const;
+       void modify_trim_start (dcpomatic::ContentTime& pos) const;
+
+       static std::shared_ptr<VideoContent> from_xml (Content* parent, cxml::ConstNodePtr, int);
 
 private:
-       friend class ffmpeg_pts_offset_test;
-       friend class best_dcp_frame_rate_test_single;
-       friend class best_dcp_frame_rate_test_double;
-       friend class audio_sampling_rate_test;
 
+       friend struct ffmpeg_pts_offset_test;
+       friend struct best_dcp_frame_rate_test_single;
+       friend struct best_dcp_frame_rate_test_double;
+       friend struct audio_sampling_rate_test;
+       friend struct scaled_size_test1;
+       friend struct scaled_size_test2;
+       friend struct scaled_size_legacy_test;
+
+       VideoContent (Content* parent, cxml::ConstNodePtr, int);
        void setup_default_colour_conversion ();
-       
-       dcp::Size _video_size;
-       VideoFrameType _video_frame_type;
+
+       bool _use;
+       Frame _length;
+       boost::optional<ColourConversion> _colour_conversion;
+       dcp::Size _size;
+       VideoFrameType _frame_type;
        Crop _crop;
-       VideoContentScale _scale;
-       ColourConversion _colour_conversion;
+       /** ratio to scale cropped image to (or none to guess); i.e. if set, scale to _custom_ratio:1 */
+       boost::optional<float> _custom_ratio;
+       /** size to scale cropped image to; only used if _custom_ratio is none */
+       boost::optional<dcp::Size> _custom_size;
+       /** ratio obtained from an older metadata file; will be used to set up
+        *  _custom_{ratio,size} (or not, if not required) on the first call to
+        *  scaled_size()
+        */
+       boost::optional<float> _legacy_ratio;
+       /** Sample aspect ratio obtained from the content file's header, if there is one */
+       boost::optional<double> _sample_aspect_ratio;
+       bool _yuv;
+       /** fade in time in content frames */
+       Frame _fade_in;
+       /** fade out time in content frames */
+       Frame _fade_out;
+       VideoRange _range;
 };
 
 #endif