/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
- 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 <http://www.gnu.org/licenses/>.
+
+ 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 data
+ * @brief PictureAsset class.
*/
-#include <openjpeg.h>
-#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 MonoPictureFrame;
class StereoPictureFrame;
class PictureAssetWriter;
-/** @brief An asset made up of JPEG2000 data */
-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 Total number of frames in the asset.
- * @param size Size of video frame images in pixels.
- */
- PictureAsset (
- std::string directory,
- std::string mxf_name,
- boost::signals2::signal<void (float)>* progress,
- int fps,
- int intrinsic_duration,
- bool encrypted,
- Size
- );
-
- /** Start a progressive write to this asset.
- * @param overwrite true to overwrite an existing MXF file; in this mode, writing can be resumed to a partially-written MXF; false if the
- * MXF file does not exist.
- * @param metadata MXF metadata to use.
- */
- virtual boost::shared_ptr<PictureAssetWriter> start_write (bool overwrite, bool interop, MXFMetadata const & metadata = MXFMetadata ()) = 0;
-
- bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
+ explicit PictureAsset (boost::filesystem::path file);
+ explicit PictureAsset (Fraction edit_rate, Standard standard);
+
+ virtual std::shared_ptr<PictureAssetWriter> start_write (
+ boost::filesystem::path file,
+ bool overwrite
+ ) = 0;
Size size () const {
return _size;
}
- void write_to_cpl (xmlpp::Node *, bool) const;
+ void set_size (Size s) {
+ _size = s;
+ }
-protected:
+ Fraction frame_rate () const {
+ return _frame_rate;
+ }
- bool frame_buffer_equals (
- int frame, EqualityOptions opt, boost::function<void (NoteType, std::string)> note,
- uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B
- ) const;
+ void set_frame_rate (Fraction r) {
+ _frame_rate = r;
+ }
- /** picture size in pixels */
- Size _size;
+ Fraction screen_aspect_ratio () const {
+ return _screen_aspect_ratio;
+ }
-private:
- std::string key_type () const;
- virtual int edit_rate_factor () const = 0;
-};
+ void set_screen_aspect_ratio (Fraction r) {
+ _screen_aspect_ratio = r;
+ }
-/** 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 Total number of frames in the asset.
- * @param size Size of images in pixels.
- * @param encrypted true if asset should be encrypted.
- */
- MonoPictureAsset (
- std::vector<std::string> const & files,
- std::string directory,
- std::string mxf_name,
- boost::signals2::signal<void (float)>* progress,
- int fps,
- int intrinsic_duration,
- bool encrypted,
- Size size,
- bool interop,
- 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 Total number of frames in the asset.
- * @param size Size of images in pixels.
- * @param encrypted true if asset should be encrypted.
- */
- MonoPictureAsset (
- boost::function<std::string (int)> get_path,
- std::string directory,
- std::string mxf_name,
- boost::signals2::signal<void (float)>* progress,
- int fps,
- int intrinsic_duration,
- bool encrypted,
- Size size,
- bool interop,
- 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);
+ Fraction edit_rate () const {
+ return _edit_rate;
+ }
- /** Start a progressive write to a MonoPictureAsset */
- boost::shared_ptr<PictureAssetWriter> start_write (bool, bool, MXFMetadata const & metadata = MXFMetadata ());
+ int64_t intrinsic_duration () const {
+ return _intrinsic_duration;
+ }
- boost::shared_ptr<const MonoPictureFrame> get_frame (int n) const;
- bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
+ static std::string static_pkl_type (Standard standard);
-private:
- std::string path_from_list (int f, std::vector<std::string> const & files) const;
- void construct (boost::function<std::string (int)>, bool, MXFMetadata const &);
- std::string cpl_node_name () const;
- int edit_rate_factor () const;
-};
+protected:
+ friend class MonoPictureAssetWriter;
+ friend class StereoPictureAssetWriter;
-/** A 3D (stereoscopic) picture asset */
-class StereoPictureAsset : public PictureAsset
-{
-public:
- StereoPictureAsset (std::string directory, std::string mxf_name, int fps, int intrinsic_duration);
-
- /** Construct a StereoPictureAsset for progressive writing using
- * start_write() and a StereoPictureAssetWriter.
- *
- * @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.
- */
- StereoPictureAsset (std::string directory, std::string mxf_name, int fps, Size size);
+ 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;
- /** Start a progressive write to a StereoPictureAsset */
- boost::shared_ptr<PictureAssetWriter> start_write (bool, bool, MXFMetadata const & metadata = MXFMetadata ());
+ bool descriptor_equals (
+ ASDCP::JP2K::PictureDescriptor const & a,
+ ASDCP::JP2K::PictureDescriptor const & b,
+ NoteHandler note
+ ) const;
- boost::shared_ptr<const StereoPictureFrame> get_frame (int n) const;
- bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
+ void read_picture_descriptor (ASDCP::JP2K::PictureDescriptor 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 cpl_node_name () const;
- std::string cpl_node_namespace (bool) const;
- int edit_rate_factor () const;
+ std::string pkl_type (Standard standard) const;
};
-
+
}