src/picture_asset.h

   1 /*
   2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp 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     libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34 #ifndef LIBDCP_PICTURE_ASSET_H
  35 #define LIBDCP_PICTURE_ASSET_H
  36
  37 /** @file  src/picture_asset.h
  38  *  @brief PictureAsset class.
  39  */
  40
  41 #include "mxf.h"
  42 #include "util.h"
  43 #include "metadata.h"
  44
  45 namespace ASDCP {
  46         namespace JP2K {
  47                 struct PictureDescriptor;
  48         }
  49 }
  50
  51 namespace dcp
  52 {
  53
  54 class MonoPictureFrame;
  55 class StereoPictureFrame;
  56 class PictureAssetWriter;
  57
  58 /** @class PictureAsset
  59  *  @brief An asset made up of JPEG2000 data.
  60  */
  61 class PictureAsset : public Asset, public MXF
  62 {
  63 public:
  64         explicit PictureAsset (boost::filesystem::path file);
  65         explicit PictureAsset (Fraction edit_rate, Standard standard);
  66
  67         virtual std::shared_ptr<PictureAssetWriter> start_write (
  68                 boost::filesystem::path file,
  69                 bool overwrite
  70                 ) = 0;
  71
  72         Size size () const {
  73                 return _size;
  74         }
  75
  76         void set_size (Size s) {
  77                 _size = s;
  78         }
  79
  80         Fraction frame_rate () const {
  81                 return _frame_rate;
  82         }
  83
  84         void set_frame_rate (Fraction r) {
  85                 _frame_rate = r;
  86         }
  87
  88         Fraction screen_aspect_ratio () const {
  89                 return _screen_aspect_ratio;
  90         }
  91
  92         void set_screen_aspect_ratio (Fraction r) {
  93                 _screen_aspect_ratio = r;
  94         }
  95
  96         Fraction edit_rate () const {
  97                 return _edit_rate;
  98         }
  99
 100         int64_t intrinsic_duration () const {
 101                 return _intrinsic_duration;
 102         }
 103
 104         static std::string static_pkl_type (Standard standard);
 105
 106 protected:
 107         friend class MonoPictureAssetWriter;
 108         friend class StereoPictureAssetWriter;
 109
 110         bool frame_buffer_equals (
 111                 int frame, EqualityOptions opt, NoteHandler note,
 112                 uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B
 113                 ) const;
 114
 115         bool descriptor_equals (
 116                 ASDCP::JP2K::PictureDescriptor const & a,
 117                 ASDCP::JP2K::PictureDescriptor const & b,
 118                 NoteHandler note
 119                 ) const;
 120
 121         void read_picture_descriptor (ASDCP::JP2K::PictureDescriptor const &);
 122
 123         Fraction _edit_rate;
 124         /** The total length of this content in video frames.  The amount of
 125          *  content presented may be less than this.
 126          */
 127         int64_t _intrinsic_duration;
 128         /** picture size in pixels */
 129         Size _size;
 130         Fraction _frame_rate;
 131         Fraction _screen_aspect_ratio;
 132
 133 private:
 134         std::string pkl_type (Standard standard) const;
 135 };
 136
 137
 138 }
 139
 140 #endif