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 ServerDescription;
  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 (boost::shared_ptr<Socket> socket);
  52         void write (boost::shared_ptr<const Options>, int);
  53
  54         /** @return data */
  55         uint8_t* data () const {
  56                 return _data;
  57         }
  58
  59         /** @return data size, in bytes */
  60         int size () const {
  61                 return _size;
  62         }
  63
  64 protected:
  65         uint8_t* _data; ///< data
  66         int _size;      ///< data size in bytes
  67 };
  68
  69 /** @class LocallyEncodedData
  70  *  @brief EncodedData that was encoded locally; this class
  71  *  just keeps a pointer to the data, but does no memory
  72  *  management.
  73  */
  74 class LocallyEncodedData : public EncodedData
  75 {
  76 public:
  77         /** @param d Data (which will not be freed by this class)
  78          *  @param s Size of data, in bytes.
  79          */
  80         LocallyEncodedData (uint8_t* d, int s)
  81                 : EncodedData (d, s)
  82         {}
  83 };
  84
  85 /** @class RemotelyEncodedData
  86  *  @brief EncodedData that is being read from a remote server;
  87  *  this class allocates and manages memory for the data.
  88  */
  89 class RemotelyEncodedData : public EncodedData
  90 {
  91 public:
  92         RemotelyEncodedData (int s);
  93         ~RemotelyEncodedData ();
  94 };
  95
  96 /** @class DCPVideoFrame
  97  *  @brief A single frame of video destined for a DCP.
  98  *
  99  *  Given an Image and some settings, this class knows how to encode
 100  *  the image to J2K either on the local host or on a remote server.
 101  *
 102  *  Objects of this class are used for the queue that we keep
 103  *  of images that require encoding.
 104  */
 105 class DCPVideoFrame
 106 {
 107 public:
 108         DCPVideoFrame (boost::shared_ptr<Image>, Size, int, Scaler const *, int, float, std::string, int, int, Log *);
 109         virtual ~DCPVideoFrame ();
 110
 111         boost::shared_ptr<EncodedData> encode_locally ();
 112         boost::shared_ptr<EncodedData> encode_remotely (ServerDescription const *);
 113
 114         int frame () const {
 115                 return _frame;
 116         }
 117
 118 private:
 119         void create_openjpeg_container ();
 120         void write_encoded (boost::shared_ptr<const Options>, uint8_t *, int);
 121
 122         boost::shared_ptr<Image> _input; ///< the input image
 123         Size _out_size;                  ///< the required size of the output, in pixels
 124         int _padding;
 125         Scaler const * _scaler;          ///< scaler to use
 126         int _frame;                      ///< frame index within the Film
 127         int _frames_per_second;          ///< Frames per second that we will use for the DCP (rounded)
 128         std::string _post_process;       ///< FFmpeg post-processing string to use
 129         int _colour_lut_index;           ///< Colour look-up table to use (see Config::colour_lut_index ())
 130         int _j2k_bandwidth;              ///< J2K bandwidth to use (see Config::j2k_bandwidth ())
 131
 132         Log* _log; ///< log
 133
 134         opj_image_cmptparm_t _cmptparm[3]; ///< libopenjpeg's opj_image_cmptparm_t
 135         opj_image* _image;                 ///< libopenjpeg's image container
 136         opj_cparameters_t* _parameters;    ///< libopenjpeg's parameters
 137         opj_cinfo_t* _cinfo;               ///< libopenjpeg's opj_cinfo_t
 138         opj_cio_t* _cio;                   ///< libopenjpeg's opj_cio_t
 139 };