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 #include "types.h"
  22 #include "position.h"
  23 #include "dcpomatic_time.h"
  24 #include "colour_conversion.h"
  25 #include "position_image.h"
  26 extern "C" {
  27 #include <libavutil/pixfmt.h>
  28 }
  29 #include <boost/shared_ptr.hpp>
  30
  31 class Image;
  32 class ImageProxy;
  33 class Socket;
  34
  35 /** Everything needed to describe a video frame coming out of the player, but with the
  36  *  bits still their raw form.  We may want to combine the bits on a remote machine,
  37  *  or maybe not even bother to combine them at all.
  38  */
  39 class PlayerVideo
  40 {
  41 public:
  42         PlayerVideo (
  43                 boost::shared_ptr<const ImageProxy>,
  44                 DCPTime,
  45                 Crop,
  46                 boost::optional<double>,
  47                 dcp::Size,
  48                 dcp::Size,
  49                 Eyes,
  50                 Part,
  51                 boost::optional<ColourConversion>
  52                 );
  53
  54         PlayerVideo (boost::shared_ptr<cxml::Node>, boost::shared_ptr<Socket>);
  55
  56         void set_subtitle (PositionImage);
  57
  58         boost::shared_ptr<Image> image (dcp::NoteHandler note, boost::function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const;
  59
  60         static AVPixelFormat always_rgb (AVPixelFormat);
  61         static AVPixelFormat keep_xyz_or_rgb (AVPixelFormat);
  62
  63         void add_metadata (xmlpp::Node* node) const;
  64         void send_binary (boost::shared_ptr<Socket> socket) const;
  65
  66         bool has_j2k () const;
  67         dcp::Data j2k () const;
  68
  69         DCPTime time () const {
  70                 return _time;
  71         }
  72
  73         Eyes eyes () const {
  74                 return _eyes;
  75         }
  76
  77         boost::optional<ColourConversion> colour_conversion () const {
  78                 return _colour_conversion;
  79         }
  80
  81         /** @return Position of the content within the overall image once it has been scaled up */
  82         Position<int> inter_position () const;
  83
  84         /** @return Size of the content within the overall image once it has been scaled up */
  85         dcp::Size inter_size () const {
  86                 return _inter_size;
  87         }
  88
  89         bool same (boost::shared_ptr<const PlayerVideo> other) const;
  90
  91 private:
  92         boost::shared_ptr<const ImageProxy> _in;
  93         DCPTime _time;
  94         Crop _crop;
  95         boost::optional<double> _fade;
  96         dcp::Size _inter_size;
  97         dcp::Size _out_size;
  98         Eyes _eyes;
  99         Part _part;
 100         boost::optional<ColourConversion> _colour_conversion;
 101         boost::optional<PositionImage> _subtitle;
 102 };