src/lib/dcp_video_frame.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3     Taken from code Copyright (C) 2010-2011 Terrence Meiczinger
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #include <openjpeg.h>
  22 #include "util.h"
  23
  24 /** @file  src/dcp_video_frame.h
  25  *  @brief A single frame of video destined for a DCP.
  26  */
  27
  28 class FilmState;
  29 class Options;
  30 class Server;
  31 class Scaler;
  32 class Image;
  33 class Log;
  34
  35 /** @class EncodedData
  36  *  @brief Container for J2K-encoded data.
  37  */
  38 class EncodedData
  39 {
  40 public:
  41         /** @param d Data (will not be freed by this class, but may be by subclasses)
  42          *  @param s Size of data, in bytes.
  43          */
  44         EncodedData (uint8_t* d, int s)
  45                 : _data (d)
  46                 , _size (s)
  47         {}
  48
  49         virtual ~EncodedData () {}
  50
  51         void send (int);
  52         void write (boost::shared_ptr<const Options>, int);
  53
  54 #ifdef DEBUG_HASH
  55         void hash (std::string) const;
  56 #endif
  57
  58         /** @return data */
  59         uint8_t* data () const {
  60                 return _data;
  61         }
  62
  63         /** @return data size, in bytes */
  64         int size () const {
  65                 return _size;
  66         }
  67
  68 protected:
  69         uint8_t* _data; ///< data
  70         int _size;      ///< data size in bytes
  71 };
  72
  73 /** @class LocallyEncodedData
  74  *  @brief EncodedData that was encoded locally; this class
  75  *  just keeps a pointer to the data, but does no memory
  76  *  management.
  77  */
  78 class LocallyEncodedData : public EncodedData
  79 {
  80 public:
  81         /** @param d Data (which will not be freed by this class)
  82          *  @param s Size of data, in bytes.
  83          */
  84         LocallyEncodedData (uint8_t* d, int s)
  85                 : EncodedData (d, s)
  86         {}
  87 };
  88
  89 /** @class RemotelyEncodedData
  90  *  @brief EncodedData that is being read from a remote server;
  91  *  this class allocates and manages memory for the data.
  92  */
  93 class RemotelyEncodedData : public EncodedData
  94 {
  95 public:
  96         RemotelyEncodedData (int s);
  97         ~RemotelyEncodedData ();
  98 };
  99
 100 /** @class DCPVideoFrame
 101  *  @brief A single frame of video destined for a DCP.
 102  *
 103  *  Given an Image and some settings, this class knows how to encode
 104  *  the image to J2K either on the local host or on a remote server.
 105  *
 106  *  Objects of this class are used for the queue that we keep
 107  *  of images that require encoding.
 108  */
 109 class DCPVideoFrame
 110 {
 111 public:
 112         DCPVideoFrame (boost::shared_ptr<Image>, Size, int, Scaler const *, int, float, std::string, int, int, Log *);
 113         virtual ~DCPVideoFrame ();
 114
 115         boost::shared_ptr<EncodedData> encode_locally ();
 116         boost::shared_ptr<EncodedData> encode_remotely (Server const *);
 117
 118         int frame () const {
 119                 return _frame;
 120         }
 121
 122 private:
 123         void create_openjpeg_container ();
 124         void write_encoded (boost::shared_ptr<const Options>, uint8_t *, int);
 125
 126         boost::shared_ptr<Image> _input; ///< the input image
 127         Size _out_size;                  ///< the required size of the output, in pixels
 128         int _padding;
 129         Scaler const * _scaler;          ///< scaler to use
 130         int _frame;                      ///< frame index within the Film
 131         int _frames_per_second;          ///< Frames per second that we will use for the DCP (rounded)
 132         std::string _post_process;       ///< FFmpeg post-processing string to use
 133         int _colour_lut_index;           ///< Colour look-up table to use (see Config::colour_lut_index ())
 134         int _j2k_bandwidth;              ///< J2K bandwidth to use (see Config::j2k_bandwidth ())
 135
 136         Log* _log; ///< log
 137
 138         opj_image_cmptparm_t _cmptparm[3]; ///< libopenjpeg's opj_image_cmptparm_t
 139         opj_image* _image;                 ///< libopenjpeg's image container
 140         opj_cparameters_t* _parameters;    ///< libopenjpeg's parameters
 141         opj_cinfo_t* _cinfo;               ///< libopenjpeg's opj_cinfo_t
 142         opj_cio_t* _cio;                   ///< libopenjpeg's opj_cio_t
 143 };