src/lib/dcp_video.h

   1 /*
   2     Copyright (C) 2012-2016 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 "encode_server_description.h"
  23 #include <libcxml/cxml.h>
  24 #include <dcp/array_data.h>
  25
  26 /** @file  src/dcp_video_frame.h
  27  *  @brief A single frame of video destined for a DCP.
  28  */
  29
  30 class Log;
  31 class PlayerVideo;
  32
  33 /** @class DCPVideo
  34  *  @brief A single frame of video destined for a DCP.
  35  *
  36  *  Given an Image and some settings, this class knows how to encode
  37  *  the image to J2K either on the local host or on a remote server.
  38  *
  39  *  Objects of this class are used for the queue that we keep
  40  *  of images that require encoding.
  41  */
  42 class DCPVideo
  43 {
  44 public:
  45         DCPVideo (std::shared_ptr<const PlayerVideo>, int index, int dcp_fps, int bandwidth, Resolution r);
  46         DCPVideo (std::shared_ptr<const PlayerVideo>, cxml::ConstNodePtr);
  47
  48         DCPVideo (DCPVideo const&) = default;
  49         DCPVideo& operator= (DCPVideo const&) = default;
  50
  51         std::shared_ptr<const PlayerVideo> frame() const {
  52                 return _frame;
  53         }
  54
  55         int index () const {
  56                 return _index;
  57         }
  58
  59         int frames_per_second() const {
  60                 return _frames_per_second;
  61         }
  62
  63         int j2k_bandwidth() const {
  64                 return _j2k_bandwidth;
  65         }
  66
  67         Resolution resolution() const {
  68                 return _resolution;
  69         }
  70
  71         Eyes eyes () const;
  72
  73         bool same (std::shared_ptr<const DCPVideo> other) const;
  74
  75 private:
  76         std::shared_ptr<const PlayerVideo> _frame;
  77         int _index;                      ///< frame index within the DCP's intrinsic duration
  78         int _frames_per_second;          ///< Frames per second that we will use for the DCP
  79         int _j2k_bandwidth;              ///< J2K bandwidth to use
  80         Resolution _resolution;          ///< Resolution (2K or 4K)
  81 };