X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Freel_asset.h;h=e928cb18542694a5bc7f7989be86f04a533e971f;hb=474aeac068c193bc429d2c1f417290b2b8cd1810;hp=118f10a126bc50ccc98bce98337c00db4fa78f57;hpb=fe99eae4b95c5fcf2f3730efad4a18d0cb5c29bc;p=libdcp.git diff --git a/src/reel_asset.h b/src/reel_asset.h index 118f10a1..e928cb18 100644 --- a/src/reel_asset.h +++ b/src/reel_asset.h @@ -1,98 +1,163 @@ /* - Copyright (C) 2014 Carl Hetherington + Copyright (C) 2014-2021 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. */ + +/** @file src/reel_asset.h + * @brief ReelAsset class + */ + + #ifndef LIBDCP_REEL_ASSET_H #define LIBDCP_REEL_ASSET_H + #include "object.h" #include "util.h" #include "ref.h" -#include +#include + namespace cxml { class Node; } + namespace xmlpp { class Node; } + namespace dcp { + class Asset; + /** @class ReelAsset * @brief An entry in a <Reel> which refers to a use of a piece of content. * * This class encapsulates the XML that exists in a <Reel> to say * that a piece of content is used in this reel. It does not - * describe the content itself (but links to a Content object which does). + * describe the content itself (but links to an Asset object which does). */ class ReelAsset : public Object { public: - ReelAsset (); - ReelAsset (boost::shared_ptr asset, Fraction edit_rate, int64_t intrinsic_duration, int64_t entry_point); - ReelAsset (boost::shared_ptr); + /** Construct a ReelAsset + * @param id ID of this ReelAsset (which is that of the MXF, if there is one) + * @param edit_rate Edit rate for the asset + * @param intrinsic_duration Intrinsic duration of this asset + * @param entry_point Entry point to use in that asset + */ + ReelAsset (std::string id, Fraction edit_rate, int64_t intrinsic_duration, boost::optional entry_point); + + explicit ReelAsset (std::shared_ptr); + + virtual xmlpp::Node* write_to_cpl (xmlpp::Node* node, Standard standard) const; + + virtual bool encryptable () const { + return false; + } + + Fraction edit_rate () const { + return _edit_rate; + } - virtual void write_to_cpl (xmlpp::Node* node, Standard standard) const; - virtual bool equals (boost::shared_ptr, EqualityOptions, NoteHandler) const; + int64_t intrinsic_duration () const { + return _intrinsic_duration; + } + + void set_entry_point (int64_t e) { + _entry_point = e; + } - /** @return a Ref to our actual asset */ - Ref& asset_ref () { - return _asset_ref; + void unset_entry_point () { + _entry_point = boost::none; } - int64_t entry_point () const { + boost::optional entry_point () const { return _entry_point; } - int64_t duration () const { + void set_duration (int64_t d) { + _duration = d; + } + + boost::optional duration () const { return _duration; } + /** @return , or - if is not present */ + int64_t actual_duration () const; + + boost::optional annotation_text () const { + return _annotation_text; + } + + void set_annotation_text (std::string at) { + _annotation_text = at; + } + + void unset_annotation_text () { + _annotation_text = boost::none; + } + + bool asset_equals(std::shared_ptr, EqualityOptions const&, NoteHandler) const; + protected: + /** @return the node name that this asset uses in the CPL's <Reel> node * e.g. MainPicture, MainSound etc. */ - virtual std::string cpl_node_name () const = 0; + virtual std::string cpl_node_name (Standard) const = 0; - /** @return Any attribute that should be used on the asset's node in the - * CPL. - */ + /** @return Any attribute that should be used on the asset's node in the CPL */ virtual std::pair cpl_node_attribute (Standard) const; - /** Reference to the asset (MXF or XML file) that this reel entry - * applies to. - */ - Ref _asset_ref; + /** @return Any namespace that should be used on the asset's node in the CPL */ + virtual std::pair cpl_node_namespace () const; + + int64_t _intrinsic_duration = 0; ///< The <IntrinsicDuration> from the reel's entry for this asset + boost::optional _duration; ///< The <Duration> from the reel's entry for this asset, if present private: - - std::string _annotation_text; ///< The <AnnotationText> from the reel's entry for this asset - Fraction _edit_rate; ///< The <EditRate> from the reel's entry for this asset - int64_t _intrinsic_duration; ///< The <IntrinsicDuration> from the reel's entry for this asset - int64_t _entry_point; ///< The <EntryPoint> from the reel's entry for this asset - int64_t _duration; ///< The <Duration> from the reel's entry for this asset - std::string _hash; ///< The <Hash> from the reel's entry for this asset + boost::optional _annotation_text; ///< The <AnnotationText> from the reel's entry for this asset + Fraction _edit_rate; ///< The <EditRate> from the reel's entry for this asset + boost::optional _entry_point; ///< The <EntryPoint> from the reel's entry for this asset }; + } + #endif