C++11 tidying.
[dcpomatic.git] / src / lib / video_content.h
index 84b3d2268bbd2006ed376f3f504edc68b21d3e2a..c1e1dbeec5b05345f96730b56bd6871da6c4dead 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.
 
 
 */
 
+
 #ifndef DCPOMATIC_VIDEO_CONTENT_H
 #define DCPOMATIC_VIDEO_CONTENT_H
 
+
 #include "colour_conversion.h"
-#include "video_content_scale.h"
+#include "content_part.h"
 #include "dcpomatic_time.h"
-#include "user_property.h"
 #include "types.h"
-#include "content_part.h"
+#include "user_property.h"
+#include <dcp/language_tag.h>
 #include <boost/thread/mutex.hpp>
-#include <boost/weak_ptr.hpp>
-#include <boost/enable_shared_from_this.hpp>
+
 
 class VideoExaminer;
 class Ratio;
 class Film;
 class Content;
 
+
 class VideoContentProperty
 {
 public:
+       static int const USE;
        static int const SIZE;
        static int const FRAME_TYPE;
        static int const CROP;
@@ -46,18 +49,24 @@ public:
        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;
+       static int const BURNT_SUBTITLE_LANGUAGE;
 };
 
-class VideoContent : public ContentPart, public boost::enable_shared_from_this<VideoContent>
+
+class VideoContent : public ContentPart, public std::enable_shared_from_this<VideoContent>
 {
 public:
-       VideoContent (Content* parent);
-       VideoContent (Content* parent, std::vector<boost::shared_ptr<Content> >);
+       explicit VideoContent (Content* parent);
+       VideoContent (Content* parent, cxml::ConstNodePtr, int);
+       VideoContent (Content* parent, std::vector<std::shared_ptr<Content>>);
 
        void as_xml (xmlpp::Node *) const;
        std::string technical_summary () const;
        std::string identifier () const;
-       void take_settings_from (boost::shared_ptr<const VideoContent> c);
+       void take_settings_from (std::shared_ptr<const VideoContent> c);
 
        Frame length () const {
                boost::mutex::scoped_lock lm (_mutex);
@@ -66,7 +75,7 @@ public:
 
        Frame length_after_3d_combine () const {
                boost::mutex::scoped_lock lm (_mutex);
-               if (_frame_type == VIDEO_FRAME_TYPE_3D_ALTERNATE) {
+               if (_frame_type == VideoFrameType::THREE_D_ALTERNATE) {
                        return _length / 2;
                }
 
@@ -85,13 +94,20 @@ public:
        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);
 
        void set_fade_in (Frame);
        void set_fade_out (Frame);
 
+       void set_range (VideoRange);
+       void set_use (bool);
+
+       void set_burnt_subtitle_language (boost::optional<dcp::LanguageTag> language);
+
        VideoFrameType frame_type () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _frame_type;
@@ -122,12 +138,19 @@ 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;
        }
 
+
        boost::optional<ColourConversion> colour_conversion () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _colour_conversion;
@@ -153,25 +176,40 @@ public:
                return _fade_out;
        }
 
+       VideoRange range () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _range;
+       }
+
+       bool use () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _use;
+       }
+
+       boost::optional<dcp::LanguageTag> burnt_subtitle_language () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _burnt_subtitle_language;
+       }
+
+
+       /* 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);
 
-       boost::optional<double> fade (Frame) const;
-
-       void scale_and_crop_to_fit_width ();
-       void scale_and_crop_to_fit_height ();
+       boost::optional<double> fade (std::shared_ptr<const Film> film, Frame) const;
 
-       std::string processing_description () const;
+       std::string processing_description (std::shared_ptr<const Film> film);
 
        void set_length (Frame);
 
-       void take_from_examiner (boost::shared_ptr<VideoExaminer>);
+       void take_from_examiner (std::shared_ptr<VideoExaminer>);
        void add_properties (std::list<UserProperty> &) const;
 
-       void modify_position (DCPTime& pos) const;
-       void modify_trim_start (ContentTime& pos) const;
+       void modify_position (std::shared_ptr<const Film> film, dcpomatic::DCPTime& pos) const;
+       void modify_trim_start (dcpomatic::ContentTime& pos) const;
 
-       static boost::shared_ptr<VideoContent> from_xml (Content* parent, cxml::ConstNodePtr, int);
+       static std::shared_ptr<VideoContent> from_xml (Content* parent, cxml::ConstNodePtr, int);
 
 private:
 
@@ -179,21 +217,37 @@ private:
        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 ();
 
+       bool _use;
        Frame _length;
        boost::optional<ColourConversion> _colour_conversion;
        dcp::Size _size;
        VideoFrameType _frame_type;
        Crop _crop;
-       VideoContentScale _scale;
+       /** 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;
+       boost::optional<dcp::LanguageTag> _burnt_subtitle_language;
 };
 
+
 #endif