src/picture_asset.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/picture_asset.h
  21  *  @brief An asset made up of JPEG2000 files
  22  */
  23
  24 #include <openjpeg.h>
  25 #include "mxf_asset.h"
  26
  27 namespace libdcp
  28 {
  29
  30 class MonoPictureFrame;
  31 class StereoPictureFrame;
  32
  33 /** @brief An asset made up of JPEG2000 files */
  34 class PictureAsset : public MXFAsset
  35 {
  36 public:
  37         PictureAsset (std::string directory, std::string mxf_name, sigc::signal1<void, float>* progress, int fps, int entry_point, int length);
  38
  39         /** Write details of this asset to a CPL stream.
  40          *  @param s Stream.
  41          */
  42         void write_to_cpl (std::ostream& s) const;
  43
  44         std::list<std::string> equals (boost::shared_ptr<const Asset> other, EqualityOptions opt) const;
  45
  46         int width () const {
  47                 return _width;
  48         }
  49
  50         int height () const {
  51                 return _height;
  52         }
  53
  54 protected:
  55         /** picture width in pixels */
  56         int _width;
  57         /** picture height in pixels */
  58         int _height;
  59 };
  60
  61 /** A 2D (monoscopic) picture asset */
  62 class MonoPictureAsset : public PictureAsset
  63 {
  64 public:
  65         /** Construct a PictureAsset, generating the MXF from the JPEG2000 files.
  66          *  This may take some time; progress is indicated by emission of the Progress signal.
  67          *  @param files Pathnames of JPEG2000 files, in frame order.
  68          *  @param directory Directory in which to create MXF file.
  69          *  @param mxf_name Name of MXF file to create.
  70          *  @param progress Signal to inform of progress.
  71          *  @param fps Frames per second.
  72          *  @param length Length in frames.
  73          *  @param width Width of images in pixels.
  74          *  @param height Height of images in pixels.
  75          */
  76         MonoPictureAsset (
  77                 std::vector<std::string> const & files,
  78                 std::string directory,
  79                 std::string mxf_name,
  80                 sigc::signal1<void, float>* progress,
  81                 int fps,
  82                 int length,
  83                 int width,
  84                 int height
  85                 );
  86
  87         /** Construct a PictureAsset, generating the MXF from the JPEG2000 files.
  88          *  This may take some time; progress is indicated by emission of the Progress signal.
  89          *  @param get_path Functor which returns a JPEG2000 file path for a given frame (frames counted from 0).
  90          *  @param directory Directory in which to create MXF file.
  91          *  @param mxf_name Name of MXF file to create.
  92          *  @param progress Signal to inform of progress.
  93          *  @param fps Frames per second.
  94          *  @param length Length in frames.
  95          *  @param width Width of images in pixels.
  96          *  @param height Height of images in pixels.
  97          */
  98         MonoPictureAsset (
  99                 sigc::slot<std::string, int> get_path,
 100                 std::string directory,
 101                 std::string mxf_name,
 102                 sigc::signal1<void, float>* progress,
 103                 int fps,
 104                 int length,
 105                 int width,
 106                 int height
 107                 );
 108
 109         MonoPictureAsset (std::string directory, std::string mxf_name, int fps, int entry_point, int length);
 110
 111         boost::shared_ptr<const MonoPictureFrame> get_frame (int n) const;
 112
 113 private:
 114         std::string path_from_list (int f, std::vector<std::string> const & files) const;
 115         void construct (sigc::slot<std::string, int>);
 116 };
 117
 118 /** A 3D (stereoscopic) picture asset */
 119 class StereoPictureAsset : public PictureAsset
 120 {
 121 public:
 122         StereoPictureAsset (std::string directory, std::string mxf_name, int fps, int entry_point, int length);
 123
 124         boost::shared_ptr<const StereoPictureFrame> get_frame (int n) const;
 125 };
 126
 127
 128 }