src/lib/player_video.h

   1 /*
   2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_PLAYER_VIDEO_H
  22 #define DCPOMATIC_PLAYER_VIDEO_H
  23
  24 #include "types.h"
  25 #include "position.h"
  26 #include "dcpomatic_time.h"
  27 #include "colour_conversion.h"
  28 #include "position_image.h"
  29 extern "C" {
  30 #include <libavutil/pixfmt.h>
  31 }
  32 #include <boost/shared_ptr.hpp>
  33 #include <boost/weak_ptr.hpp>
  34
  35 class Image;
  36 class ImageProxy;
  37 class Film;
  38 class Socket;
  39
  40 /** Everything needed to describe a video frame coming out of the player, but with the
  41  *  bits still their raw form.  We may want to combine the bits on a remote machine,
  42  *  or maybe not even bother to combine them at all.
  43  */
  44 class PlayerVideo
  45 {
  46 public:
  47         PlayerVideo (
  48                 boost::shared_ptr<const ImageProxy>,
  49                 Crop,
  50                 boost::optional<double>,
  51                 dcp::Size,
  52                 dcp::Size,
  53                 Eyes,
  54                 Part,
  55                 boost::optional<ColourConversion>,
  56                 boost::weak_ptr<Content>,
  57                 boost::optional<Frame>
  58                 );
  59
  60         PlayerVideo (boost::shared_ptr<cxml::Node>, boost::shared_ptr<Socket>);
  61
  62         boost::shared_ptr<PlayerVideo> shallow_copy () const;
  63
  64         void set_text (PositionImage);
  65
  66         void prepare (boost::function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast);
  67         boost::shared_ptr<Image> image (boost::function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const;
  68
  69         static AVPixelFormat force (AVPixelFormat, AVPixelFormat);
  70         static AVPixelFormat keep_xyz_or_rgb (AVPixelFormat);
  71
  72         void add_metadata (xmlpp::Node* node) const;
  73         void send_binary (boost::shared_ptr<Socket> socket) const;
  74
  75         bool reset_metadata (boost::shared_ptr<const Film> film, dcp::Size video_container_size, dcp::Size film_frame_size);
  76
  77         bool has_j2k () const;
  78         dcp::Data j2k () const;
  79
  80         Eyes eyes () const {
  81                 return _eyes;
  82         }
  83
  84         void set_eyes (Eyes e) {
  85                 _eyes = e;
  86         }
  87
  88         boost::optional<ColourConversion> colour_conversion () const {
  89                 return _colour_conversion;
  90         }
  91
  92         /** @return Position of the content within the overall image once it has been scaled up */
  93         Position<int> inter_position () const;
  94
  95         /** @return Size of the content within the overall image once it has been scaled up */
  96         dcp::Size inter_size () const {
  97                 return _inter_size;
  98         }
  99
 100         bool same (boost::shared_ptr<const PlayerVideo> other) const;
 101
 102         size_t memory_used () const;
 103
 104         boost::weak_ptr<Content> content () const {
 105                 return _content;
 106         }
 107
 108 private:
 109         void make_image (boost::function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const;
 110
 111         boost::shared_ptr<const ImageProxy> _in;
 112         Crop _crop;
 113         boost::optional<double> _fade;
 114         dcp::Size _inter_size;
 115         dcp::Size _out_size;
 116         Eyes _eyes;
 117         Part _part;
 118         boost::optional<ColourConversion> _colour_conversion;
 119         boost::optional<PositionImage> _text;
 120         /** Content that we came from.  This is so that reset_metadata() can work, and also
 121          *  for variant:swaroop's non-skippable ads.
 122          */
 123         boost::weak_ptr<Content> _content;
 124         /** Video frame that we came from.  Again, this is for reset_metadata() */
 125         boost::optional<Frame> _video_frame;
 126
 127         mutable boost::mutex _mutex;
 128         mutable boost::shared_ptr<Image> _image;
 129 };
 130
 131 #endif