libdcp
Public Member Functions | Static Public Member Functions | Private Attributes | Friends | List of all members
dcp::AtmosAsset Class Reference

An asset of Dolby ATMOS sound data. More...

#include <atmos_asset.h>

Inheritance diagram for dcp::AtmosAsset:
dcp::Asset dcp::MXF dcp::Object

Public Member Functions

 AtmosAsset (Fraction edit_rate, int first_frame, int max_channel_count, int max_object_count, int atmos_version)
 
 AtmosAsset (boost::filesystem::path file)
 
std::shared_ptr< AtmosAssetWriterstart_write (boost::filesystem::path file)
 
std::shared_ptr< AtmosAssetReaderstart_read () const
 
std::string pkl_type (Standard s) const override
 
Fraction edit_rate () const
 
int64_t intrinsic_duration () const
 
int first_frame () const
 
int max_channel_count () const
 
int max_object_count () const
 
std::string atmos_id () const
 
int atmos_version () 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)
 

Private Attributes

Fraction _edit_rate
 
int64_t _intrinsic_duration = 0
 
int _first_frame = 0
 
int _max_channel_count = 0
 
int _max_object_count = 0
 
std::string _atmos_id
 
int _atmos_version = 0
 

Friends

class AtmosAssetWriter
 

Additional Inherited Members

- 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
 
- 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)
 
- 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
 

Detailed Description

An asset of Dolby ATMOS sound data.

Definition at line 58 of file atmos_asset.h.

Member Function Documentation

◆ first_frame()

int dcp::AtmosAsset::first_frame ( ) const
inline
Returns
frame number of the frame to align with the FFOA of the picture track

Definition at line 81 of file atmos_asset.h.

◆ max_channel_count()

int dcp::AtmosAsset::max_channel_count ( ) const
inline
Returns
maximum number of channels in bitstream

Definition at line 86 of file atmos_asset.h.

◆ max_object_count()

int dcp::AtmosAsset::max_object_count ( ) const
inline
Returns
maximum number of objects in bitstream

Definition at line 91 of file atmos_asset.h.

◆ pkl_type()

std::string dcp::AtmosAsset::pkl_type ( Standard  standard) const
inlineoverridevirtual
Returns
type string for PKLs for this asset

Implements dcp::Asset.

Definition at line 68 of file atmos_asset.h.


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