libdcp
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
dcp::PictureAsset Class Referenceabstract

An asset made up of JPEG2000 data. More...

#include <picture_asset.h>

Inheritance diagram for dcp::PictureAsset:
dcp::Asset dcp::MXF dcp::Object dcp::MonoPictureAsset dcp::StereoPictureAsset

Public Member Functions

 PictureAsset (boost::filesystem::path file)
 
 PictureAsset (Fraction edit_rate, Standard standard)
 
virtual std::shared_ptr< PictureAssetWriterstart_write (boost::filesystem::path file, bool overwrite)=0
 
Size size () const
 
void set_size (Size s)
 
Fraction frame_rate () const
 
void set_frame_rate (Fraction r)
 
Fraction screen_aspect_ratio () const
 
void set_screen_aspect_ratio (Fraction r)
 
Fraction edit_rate () const
 
int64_t intrinsic_duration () const
 
- Public Member Functions inherited from dcp::Asset
 Asset ()
 
 Asset (boost::filesystem::path file)
 
 Asset (std::string id, boost::filesystem::path file)
 
virtual bool equals (std::shared_ptr< const Asset > other, EqualityOptions opt, NoteHandler note) const
 
virtual void write_to_assetmap (xmlpp::Node *node, boost::filesystem::path root) const
 
virtual void add_to_pkl (std::shared_ptr< PKL > pkl, boost::filesystem::path root) const
 
boost::optional< boost::filesystem::path > file () const
 
void set_file (boost::filesystem::path file) const
 
std::string hash (boost::function< void(float)> progress={}) const
 
void set_hash (std::string hash)
 
- Public Member Functions inherited from dcp::Object
 Object ()
 
 Object (std::string id)
 
 Object (Object const &)=delete
 
Objectoperator= (Object const &)=delete
 
std::string id () const
 
- Public Member Functions inherited from dcp::MXF
 MXF (Standard standard)
 
bool encrypted () const
 
void set_key_id (std::string i)
 
boost::optional< std::string > key_id () const
 
virtual void set_key (Key)
 
boost::optional< Keykey () const
 
void set_context_id (std::string id)
 
std::string context_id () const
 
void set_metadata (MXFMetadata m)
 
MXFMetadata metadata () const
 
Standard standard () const
 

Static Public Member Functions

static std::string static_pkl_type (Standard standard)
 

Protected Member Functions

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 &)
 
- Protected Member Functions inherited from dcp::MXF
std::string read_writer_info (ASDCP::WriterInfo const &)
 
void fill_writer_info (ASDCP::WriterInfo *w, std::string id) const
 

Protected Attributes

Fraction _edit_rate
 
int64_t _intrinsic_duration = 0
 
Size _size
 
Fraction _frame_rate
 
Fraction _screen_aspect_ratio
 
- Protected Attributes inherited from dcp::Asset
boost::optional< boost::filesystem::path > _file
 
- Protected Attributes inherited from dcp::Object
std::string _id
 
- Protected Attributes inherited from dcp::MXF
boost::optional< std::string > _key_id
 
boost::optional< Key_key
 
std::string _context_id
 
MXFMetadata _metadata
 
boost::optional< Standard > _standard
 

Private Member Functions

std::string pkl_type (Standard standard) const override
 

Friends

class MonoPictureAssetWriter
 
class StereoPictureAssetWriter
 

Additional Inherited Members

- Static Protected Member Functions inherited from dcp::Asset
static void write_file_to_assetmap (xmlpp::Node *node, boost::filesystem::path root, boost::filesystem::path file, std::string id)
 

Detailed Description

An asset made up of JPEG2000 data.

Definition at line 67 of file picture_asset.h.

Constructor & Destructor Documentation

◆ PictureAsset() [1/2]

PictureAsset::PictureAsset ( boost::filesystem::path  file)
explicit

Load a PictureAsset from a file

Definition at line 66 of file picture_asset.cc.

◆ PictureAsset() [2/2]

PictureAsset::PictureAsset ( Fraction  edit_rate,
Standard  standard 
)
explicit

Create a new PictureAsset with a given edit rate and standard

Definition at line 74 of file picture_asset.cc.

Member Function Documentation

◆ pkl_type()

string PictureAsset::pkl_type ( Standard  standard) const
overrideprivatevirtual
Returns
type string for PKLs for this asset

Implements dcp::Asset.

Definition at line 228 of file picture_asset.cc.

Member Data Documentation

◆ _intrinsic_duration

int64_t dcp::PictureAsset::_intrinsic_duration = 0
protected

The total length of this content in video frames. The amount of content presented may be less than this.

Definition at line 136 of file picture_asset.h.

◆ _size

Size dcp::PictureAsset::_size
protected

picture size in pixels

Definition at line 138 of file picture_asset.h.


The documentation for this class was generated from the following files: