Another macOS std::list boost::thread SNAFU.
[dcpomatic.git] / src / lib / player_video.cc
index 018f04737acec4df8a050b086aff84be1fbe5659..75479136f0682bea3be97bf9e1debc8bf4bb390b 100644 (file)
@@ -1,48 +1,62 @@
 /*
-    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 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/>.
 
 */
 
 #include "player_video.h"
+#include "content.h"
+#include "video_content.h"
 #include "image.h"
 #include "image_proxy.h"
 #include "j2k_image_proxy.h"
 #include "film.h"
-#include "raw_convert.h"
+#include <dcp/raw_convert.h>
+extern "C" {
+#include <libavutil/pixfmt.h>
+}
+#include <libxml++/libxml++.h>
+#include <iostream>
 
 using std::string;
 using std::cout;
+using std::pair;
 using boost::shared_ptr;
+using boost::weak_ptr;
 using boost::dynamic_pointer_cast;
 using boost::optional;
+using boost::function;
+using dcp::Data;
+using dcp::raw_convert;
 
 PlayerVideo::PlayerVideo (
        shared_ptr<const ImageProxy> in,
-       DCPTime time,
        Crop crop,
        boost::optional<double> fade,
        dcp::Size inter_size,
        dcp::Size out_size,
        Eyes eyes,
        Part part,
-       optional<ColourConversion> colour_conversion
+       optional<ColourConversion> colour_conversion,
+       VideoRange video_range,
+       weak_ptr<Content> content,
+       optional<Frame> video_frame
        )
        : _in (in)
-       , _time (time)
        , _crop (crop)
        , _fade (fade)
        , _inter_size (inter_size)
@@ -50,13 +64,15 @@ PlayerVideo::PlayerVideo (
        , _eyes (eyes)
        , _part (part)
        , _colour_conversion (colour_conversion)
+       , _video_range (video_range)
+       , _content (content)
+       , _video_frame (video_frame)
 {
 
 }
 
 PlayerVideo::PlayerVideo (shared_ptr<cxml::Node> node, shared_ptr<Socket> socket)
 {
-       _time = DCPTime (node->number_child<DCPTime::Type> ("Time"));
        _crop = Crop (node);
        _fade = node->optional_number_child<double> ("Fade");
 
@@ -64,6 +80,7 @@ PlayerVideo::PlayerVideo (shared_ptr<cxml::Node> node, shared_ptr<Socket> socket
        _out_size = dcp::Size (node->number_child<int> ("OutWidth"), node->number_child<int> ("OutHeight"));
        _eyes = (Eyes) node->number_child<int> ("Eyes");
        _part = (Part) node->number_child<int> ("Part");
+       _video_range = (VideoRange) node->number_child<int>("VideoRange");
 
        /* Assume that the ColourConversion uses the current state version */
        _colour_conversion = ColourConversion::from_xml (node, Film::current_state_version);
@@ -73,25 +90,51 @@ PlayerVideo::PlayerVideo (shared_ptr<cxml::Node> node, shared_ptr<Socket> socket
        if (node->optional_number_child<int> ("SubtitleX")) {
 
                shared_ptr<Image> image (
-                       new Image (PIX_FMT_RGBA, dcp::Size (node->number_child<int> ("SubtitleWidth"), node->number_child<int> ("SubtitleHeight")), true)
+                       new Image (AV_PIX_FMT_BGRA, dcp::Size (node->number_child<int> ("SubtitleWidth"), node->number_child<int> ("SubtitleHeight")), true)
                        );
 
                image->read_from_socket (socket);
 
-               _subtitle = PositionImage (image, Position<int> (node->number_child<int> ("SubtitleX"), node->number_child<int> ("SubtitleY")));
+               _text = PositionImage (image, Position<int> (node->number_child<int> ("SubtitleX"), node->number_child<int> ("SubtitleY")));
        }
 }
 
 void
-PlayerVideo::set_subtitle (PositionImage image)
+PlayerVideo::set_text (PositionImage image)
 {
-       _subtitle = image;
+       _text = image;
 }
 
 shared_ptr<Image>
-PlayerVideo::image (AVPixelFormat pixel_format, dcp::NoteHandler note) const
+PlayerVideo::image (function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const
+{
+       /* XXX: this assumes that image() and prepare() are only ever called with the same parameters (except crop, inter size, out size, fade) */
+
+       boost::mutex::scoped_lock lm (_mutex);
+       if (!_image || _crop != _image_crop || _inter_size != _image_inter_size || _out_size != _image_out_size || _fade != _image_fade) {
+               make_image (pixel_format, aligned, fast);
+       }
+       return _image;
+}
+
+/** Create an image for this frame.  A lock must be held on _mutex.
+ *  @param pixel_format Function which is called to decide what pixel format the output image should be;
+ *  it is passed the pixel format of the input image from the ImageProxy, and should return the desired
+ *  output pixel format.  Two functions force and keep_xyz_or_rgb are provided for use here.
+ *  @param aligned true if the output image should be aligned to 32-byte boundaries.
+ *  @param fast true to be fast at the expense of quality.
+ */
+void
+PlayerVideo::make_image (function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const
 {
-       shared_ptr<Image> im = _in->image (optional<dcp::NoteHandler> (note));
+       _image_crop = _crop;
+       _image_inter_size = _inter_size;
+       _image_out_size = _out_size;
+       _image_fade = _fade;
+
+       pair<shared_ptr<Image>, int> prox = _in->image (_inter_size);
+       shared_ptr<Image> im = prox.first;
+       int const reduce = prox.second;
 
        Crop total_crop = _crop;
        switch (_part) {
@@ -111,28 +154,36 @@ PlayerVideo::image (AVPixelFormat pixel_format, dcp::NoteHandler note) const
                break;
        }
 
+       if (reduce > 0) {
+               /* Scale the crop down to account for the scaling that has already happened in ImageProxy::image */
+               int const r = pow(2, reduce);
+               total_crop.left /= r;
+               total_crop.right /= r;
+               total_crop.top /= r;
+               total_crop.bottom /= r;
+       }
+
        dcp::YUVToRGB yuv_to_rgb = dcp::YUV_TO_RGB_REC601;
        if (_colour_conversion) {
                yuv_to_rgb = _colour_conversion.get().yuv_to_rgb();
        }
 
-       shared_ptr<Image> out = im->crop_scale_window (total_crop, _inter_size, _out_size, yuv_to_rgb, pixel_format, true);
+       _image = im->crop_scale_window (
+               total_crop, _inter_size, _out_size, yuv_to_rgb, _video_range, pixel_format (im->pixel_format()), aligned, fast
+               );
 
-       if (_subtitle) {
-               out->alpha_blend (_subtitle->image, _subtitle->position);
+       if (_text) {
+               _image->alpha_blend (Image::ensure_aligned (_text->image), _text->position);
        }
 
        if (_fade) {
-               out->fade (_fade.get ());
+               _image->fade (_fade.get ());
        }
-
-       return out;
 }
 
 void
 PlayerVideo::add_metadata (xmlpp::Node* node) const
 {
-       node->add_child("Time")->add_child_text (raw_convert<string> (_time.get ()));
        _crop.as_xml (node);
        if (_fade) {
                node->add_child("Fade")->add_child_text (raw_convert<string> (_fade.get ()));
@@ -142,16 +193,17 @@ PlayerVideo::add_metadata (xmlpp::Node* node) const
        node->add_child("InterHeight")->add_child_text (raw_convert<string> (_inter_size.height));
        node->add_child("OutWidth")->add_child_text (raw_convert<string> (_out_size.width));
        node->add_child("OutHeight")->add_child_text (raw_convert<string> (_out_size.height));
-       node->add_child("Eyes")->add_child_text (raw_convert<string> (_eyes));
-       node->add_child("Part")->add_child_text (raw_convert<string> (_part));
+       node->add_child("Eyes")->add_child_text (raw_convert<string> (static_cast<int> (_eyes)));
+       node->add_child("Part")->add_child_text (raw_convert<string> (static_cast<int> (_part)));
+       node->add_child("VideoRange")->add_child_text(raw_convert<string>(static_cast<int>(_video_range)));
        if (_colour_conversion) {
                _colour_conversion.get().as_xml (node);
        }
-       if (_subtitle) {
-               node->add_child ("SubtitleWidth")->add_child_text (raw_convert<string> (_subtitle->image->size().width));
-               node->add_child ("SubtitleHeight")->add_child_text (raw_convert<string> (_subtitle->image->size().height));
-               node->add_child ("SubtitleX")->add_child_text (raw_convert<string> (_subtitle->position.x));
-               node->add_child ("SubtitleY")->add_child_text (raw_convert<string> (_subtitle->position.y));
+       if (_text) {
+               node->add_child ("SubtitleWidth")->add_child_text (raw_convert<string> (_text->image->size().width));
+               node->add_child ("SubtitleHeight")->add_child_text (raw_convert<string> (_text->image->size().height));
+               node->add_child ("SubtitleX")->add_child_text (raw_convert<string> (_text->position.x));
+               node->add_child ("SubtitleY")->add_child_text (raw_convert<string> (_text->position.y));
        }
 }
 
@@ -159,8 +211,8 @@ void
 PlayerVideo::send_binary (shared_ptr<Socket> socket) const
 {
        _in->send_binary (socket);
-       if (_subtitle) {
-               _subtitle->image->write_to_socket (socket);
+       if (_text) {
+               _text->image->write_to_socket (socket);
        }
 }
 
@@ -174,7 +226,7 @@ PlayerVideo::has_j2k () const
                return false;
        }
 
-       return _crop == Crop () && _inter_size == j2k->size() && !_subtitle && !_fade;
+       return _crop == Crop () && _out_size == j2k->size() && !_text && !_fade && !_colour_conversion;
 }
 
 Data
@@ -191,29 +243,28 @@ PlayerVideo::inter_position () const
        return Position<int> ((_out_size.width - _inter_size.width) / 2, (_out_size.height - _inter_size.height) / 2);
 }
 
-/** @return true if this PlayerVideo is definitely the same as another
- * (apart from _time), false if it is probably not
- */
+/** @return true if this PlayerVideo is definitely the same as another, false if it is probably not */
 bool
 PlayerVideo::same (shared_ptr<const PlayerVideo> other) const
 {
        if (_crop != other->_crop ||
-           _fade.get_value_or(0) != other->_fade.get_value_or(0) ||
+           _fade != other->_fade ||
            _inter_size != other->_inter_size ||
            _out_size != other->_out_size ||
            _eyes != other->_eyes ||
            _part != other->_part ||
-           _colour_conversion != other->_colour_conversion) {
+           _colour_conversion != other->_colour_conversion ||
+           _video_range != other->_video_range) {
                return false;
        }
 
-       if ((!_subtitle && other->_subtitle) || (_subtitle && !other->_subtitle)) {
-               /* One has a subtitle and the other doesn't */
+       if ((!_text && other->_text) || (_text && !other->_text)) {
+               /* One has a text and the other doesn't */
                return false;
        }
 
-       if (_subtitle && other->_subtitle && !_subtitle->same (other->_subtitle.get ())) {
-               /* They both have subtitles but they are different */
+       if (_text && other->_text && !_text->same (other->_text.get ())) {
+               /* They both have texts but they are different */
                return false;
        }
 
@@ -221,3 +272,73 @@ PlayerVideo::same (shared_ptr<const PlayerVideo> other) const
 
        return _in->same (other->_in);
 }
+
+AVPixelFormat
+PlayerVideo::force (AVPixelFormat, AVPixelFormat force_to)
+{
+       return force_to;
+}
+
+AVPixelFormat
+PlayerVideo::keep_xyz_or_rgb (AVPixelFormat p)
+{
+       return p == AV_PIX_FMT_XYZ12LE ? AV_PIX_FMT_XYZ12LE : AV_PIX_FMT_RGB48LE;
+}
+
+void
+PlayerVideo::prepare (function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast)
+{
+       _in->prepare (_inter_size);
+       boost::mutex::scoped_lock lm (_mutex);
+       if (!_image) {
+               make_image (pixel_format, aligned, fast);
+       }
+}
+
+size_t
+PlayerVideo::memory_used () const
+{
+       return _in->memory_used();
+}
+
+/** @return Shallow copy of this; _in and _text are shared between the original and the copy */
+shared_ptr<PlayerVideo>
+PlayerVideo::shallow_copy () const
+{
+       return shared_ptr<PlayerVideo>(
+               new PlayerVideo(
+                       _in,
+                       _crop,
+                       _fade,
+                       _inter_size,
+                       _out_size,
+                       _eyes,
+                       _part,
+                       _colour_conversion,
+                       _video_range,
+                       _content,
+                       _video_frame
+                       )
+               );
+}
+
+/** Re-read crop, fade, inter/out size, colour conversion and video range from our content.
+ *  @return true if this was possible, false if not.
+ */
+bool
+PlayerVideo::reset_metadata (shared_ptr<const Film> film, dcp::Size video_container_size, dcp::Size film_frame_size)
+{
+       shared_ptr<Content> content = _content.lock();
+       if (!content || !_video_frame) {
+               return false;
+       }
+
+       _crop = content->video->crop();
+       _fade = content->video->fade(film, _video_frame.get());
+       _inter_size = content->video->scale().size(content->video, video_container_size, film_frame_size);
+       _out_size = video_container_size;
+       _colour_conversion = content->video->colour_conversion();
+       _video_range = content->video->range();
+
+       return true;
+}