X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fpicture_asset.h;h=cc1be9f0360cfb234d9e980339ff042b3ecdf8d8;hb=1fcc2d967b50d0a09a6f4cc2ab47d3d2206911a4;hp=8536bacc9f6005e0eeb7a36eeff9773f7bad2cc5;hpb=59617eb2230e47b59882c4f9ca6092ce05f53cf1;p=libdcp.git diff --git a/src/picture_asset.h b/src/picture_asset.h index 8536bacc..cc1be9f0 100644 --- a/src/picture_asset.h +++ b/src/picture_asset.h @@ -1,234 +1,139 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2014 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + libdcp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - + along with libdcp. If not, see . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ #ifndef LIBDCP_PICTURE_ASSET_H #define LIBDCP_PICTURE_ASSET_H /** @file src/picture_asset.h - * @brief An asset made up of JPEG2000 files + * @brief PictureAsset class. */ -#include -#include "mxf_asset.h" +#include "mxf.h" #include "util.h" #include "metadata.h" -namespace libdcp +namespace ASDCP { + namespace JP2K { + struct PictureDescriptor; + } +} + +namespace dcp { -class MonoPictureFrame; -class StereoPictureFrame; +class MonoPictureFrame; +class StereoPictureFrame; +class PictureAssetWriter; -/** @brief An asset made up of JPEG2000 files */ -class PictureAsset : public MXFAsset +/** @class PictureAsset + * @brief An asset made up of JPEG2000 data. + */ +class PictureAsset : public Asset, public MXF { public: - /** Construct a PictureAsset. - * This class will not write anything to disk in this constructor, but subclasses may. - * - * @param directory Directory where MXF file is. - * @param mxf_name Name of MXF file. - */ - PictureAsset (std::string directory, std::string mxf_name); - - /** Construct a PictureAsset. - * This class will not write anything to disk in this constructor, but subclasses may. - * - * @param directory Directory where MXF file is. - * @param mxf_name Name of MXF file. - * @param progress Signal to use to inform of progres, or 0. - * @param fps Video Frames per second. - * @param intrinsic_duration Duration of all the frames in the asset. - * @param size Size of video frame images in pixels. - */ - PictureAsset (std::string directory, std::string mxf_name, boost::signals2::signal* progress, int fps, int intrinsic_duration, Size size); - - /** Write details of this asset to a CPL XML node. - * @param node Node. - */ - void write_to_cpl (xmlpp::Node* node) const; + explicit PictureAsset (boost::filesystem::path file); + explicit PictureAsset (Fraction edit_rate, Standard standard); - bool equals (boost::shared_ptr other, EqualityOptions opt, boost::function note) const; + virtual boost::shared_ptr start_write ( + boost::filesystem::path file, + bool overwrite + ) = 0; Size size () const { return _size; } -protected: + void set_size (Size s) { + _size = s; + } - bool frame_buffer_equals ( - int frame, EqualityOptions opt, boost::function note, - uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B - ) const; + Fraction frame_rate () const { + return _frame_rate; + } - /** picture size in pixels */ - Size _size; -}; + void set_frame_rate (Fraction r) { + _frame_rate = r; + } -class MonoPictureAsset; + Fraction screen_aspect_ratio () const { + return _screen_aspect_ratio; + } -struct FrameInfo -{ - FrameInfo (uint64_t o, uint64_t s, std::string h) - : offset (o) - , size (s) - , hash (h) - {} - - FrameInfo (std::istream& s); - - void write (std::ostream& s); - - uint64_t offset; - uint64_t size; - std::string hash; -}; + void set_screen_aspect_ratio (Fraction r) { + _screen_aspect_ratio = r; + } -/** A helper class for writing to MonoPictureAssets progressively (i.e. writing frame-by-frame, - * rather than giving libdcp all the frames in one go). - * - * Objects of this class can only be created with MonoPictureAsset::start_write(). - * - * Frames can be written to the MonoPictureAsset by calling write() with a JPEG2000 image - * (a verbatim .j2 file). finalize() must be called after the last frame has been written. - * The action of finalize() can't be done in MonoPictureAssetWriter's destructor as it may - * throw an exception. - */ -class MonoPictureAssetWriter -{ -public: - FrameInfo write (uint8_t* data, int size); - void fake_write (int size); - void finalize (); + Fraction edit_rate () const { + return _edit_rate; + } -private: - friend class MonoPictureAsset; - - MonoPictureAssetWriter (MonoPictureAsset *, bool, MXFMetadata const &); - void start (uint8_t *, int); - - /* no copy construction */ - MonoPictureAssetWriter (MonoPictureAssetWriter const &); - MonoPictureAssetWriter& operator= (MonoPictureAssetWriter const &); - - /* do this with an opaque pointer so we don't have to include - ASDCP headers - */ - - struct ASDCPState; - boost::shared_ptr _state; - - MonoPictureAsset* _asset; - /** Number of picture frames written to the asset so far */ - int _frames_written; - bool _started; - /** true if finalize() has been called */ - bool _finalized; - bool _overwrite; - MXFMetadata _metadata; -}; + int64_t intrinsic_duration () const { + return _intrinsic_duration; + } -/** A 2D (monoscopic) picture asset */ -class MonoPictureAsset : public PictureAsset -{ -public: - /** Construct a MonoPictureAsset, generating the MXF from the JPEG2000 files. - * This may take some time; progress is indicated by emission of the Progress signal. - * - * @param files Pathnames of JPEG2000 files, in frame order. - * @param directory Directory in which to create MXF file. - * @param mxf_name Name of MXF file to create. - * @param progress Signal to inform of progress. - * @param fps Video frames per second. - * @param intrinsic_duration Length of the whole asset in frames. - * @param size Size of images in pixels. - */ - MonoPictureAsset ( - std::vector const & files, - std::string directory, - std::string mxf_name, - boost::signals2::signal* progress, - int fps, - int intrinsic_duration, - Size size, - MXFMetadata const & metadata = MXFMetadata () - ); - - /** Construct a MonoPictureAsset, generating the MXF from the JPEG2000 files. - * This may take some time; progress is indicated by emission of the Progress signal. - * - * @param get_path Functor which returns a JPEG2000 file path for a given frame (frames counted from 0). - * @param directory Directory in which to create MXF file. - * @param mxf_name Name of MXF file to create. - * @param progress Signal to inform of progress. - * @param fps Video frames per second. - * @param intrinsic_duration Length of the whole asset in frames. - * @param size Size of images in pixels. - */ - MonoPictureAsset ( - boost::function get_path, - std::string directory, - std::string mxf_name, - boost::signals2::signal* progress, - int fps, - int intrinsic_duration, - Size size, - MXFMetadata const & metadata = MXFMetadata () - ); - - /** Construct a MonoPictureAsset, reading the MXF from disk. - * @param directory Directory that the MXF is in. - * @param mxf_name The filename of the MXF within `directory'. - */ - MonoPictureAsset (std::string directory, std::string mxf_name); - - /** Construct a MonoPictureAsset for progressive writing using - * start_write() and a MonoPictureAssetWriter. - * - * @param directory Directory to put the MXF in. - * @param mxf_name Filename of the MXF within this directory. - * @param fps Video frames per second. - * @param size Size in pixels that the picture frames will be. - */ - MonoPictureAsset (std::string directory, std::string mxf_name, int fps, Size size); + static std::string static_pkl_type (Standard standard); + +protected: + friend class MonoPictureAssetWriter; + friend class StereoPictureAssetWriter; - /** Start a progressive write to a MonoPictureAsset */ - boost::shared_ptr start_write (bool, MXFMetadata const & metadata = MXFMetadata ()); + bool frame_buffer_equals ( + int frame, EqualityOptions opt, NoteHandler note, + uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B + ) const; + + bool descriptor_equals ( + ASDCP::JP2K::PictureDescriptor const & a, + ASDCP::JP2K::PictureDescriptor const & b, + NoteHandler note + ) const; + + void read_picture_descriptor (ASDCP::JP2K::PictureDescriptor const &); - boost::shared_ptr get_frame (int n) const; - bool equals (boost::shared_ptr other, EqualityOptions opt, boost::function note) const; + Fraction _edit_rate; + /** The total length of this content in video frames. The amount of + * content presented may be less than this. + */ + int64_t _intrinsic_duration; + /** picture size in pixels */ + Size _size; + Fraction _frame_rate; + Fraction _screen_aspect_ratio; private: - std::string path_from_list (int f, std::vector const & files) const; - void construct (boost::function, MXFMetadata const &); + std::string pkl_type (Standard standard) const; }; -/** A 3D (stereoscopic) picture asset */ -class StereoPictureAsset : public PictureAsset -{ -public: - StereoPictureAsset (std::string directory, std::string mxf_name, int fps, int intrinsic_duration); - - boost::shared_ptr get_frame (int n) const; - bool equals (boost::shared_ptr other, EqualityOptions opt, boost::function note) const; -}; - }