shaka-packager/packager/media/formats/mp4/box_definitions.h

769 lines
18 KiB
C++

// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef MEDIA_FORMATS_MP4_BOX_DEFINITIONS_H_
#define MEDIA_FORMATS_MP4_BOX_DEFINITIONS_H_
#include <vector>
#include "packager/media/base/decrypt_config.h"
#include "packager/media/formats/mp4/aac_audio_specific_config.h"
#include "packager/media/formats/mp4/box.h"
#include "packager/media/formats/mp4/es_descriptor.h"
#include "packager/media/formats/mp4/fourccs.h"
namespace edash_packager {
namespace media {
class BufferReader;
namespace mp4 {
enum TrackType {
kInvalid = 0,
kVideo,
kAudio,
kHint,
kText,
};
class BoxBuffer;
#define DECLARE_BOX_METHODS(T) \
public: \
T(); \
~T() override; \
FourCC BoxType() const override; \
\
private: \
bool ReadWriteInternal(BoxBuffer* buffer) override; \
uint32_t ComputeSizeInternal() override; \
\
public:
struct FileType : Box {
DECLARE_BOX_METHODS(FileType);
FourCC major_brand;
uint32_t minor_version;
std::vector<FourCC> compatible_brands;
};
struct SegmentType : FileType {
FourCC BoxType() const override;
};
struct ProtectionSystemSpecificHeader : FullBox {
DECLARE_BOX_METHODS(ProtectionSystemSpecificHeader);
std::vector<uint8_t> system_id;
std::vector<uint8_t> data;
std::vector<uint8_t> raw_box;
};
struct SampleAuxiliaryInformationOffset : FullBox {
DECLARE_BOX_METHODS(SampleAuxiliaryInformationOffset);
std::vector<uint64_t> offsets;
};
struct SampleAuxiliaryInformationSize : FullBox {
DECLARE_BOX_METHODS(SampleAuxiliaryInformationSize);
uint8_t default_sample_info_size;
uint32_t sample_count;
std::vector<uint8_t> sample_info_sizes;
};
struct SampleEncryptionEntry {
SampleEncryptionEntry();
~SampleEncryptionEntry();
/// Read/Write SampleEncryptionEntry.
/// @param iv_size specifies the size of initialization vector.
/// @param has_subsamples indicates whether this sample encryption entry
/// constains subsamples.
/// @param buffer points to the box buffer for reading or writing.
/// @return true on success, false otherwise.
bool ReadWrite(uint8_t iv_size,
bool has_subsamples,
BoxBuffer* buffer);
/// Parse SampleEncryptionEntry from buffer.
/// @param iv_size specifies the size of initialization vector.
/// @param has_subsamples indicates whether this sample encryption entry
/// constains subsamples.
/// @param reader points to the buffer reader. Cannot be NULL.
/// @return true on success, false otherwise.
bool ParseFromBuffer(uint8_t iv_size,
bool has_subsamples,
BufferReader* reader);
/// @return The size of the structure in bytes when it is stored.
uint32_t ComputeSize() const;
/// @return The accumulated size of subsamples. Returns 0 if there is no
/// subsamples.
uint32_t GetTotalSizeOfSubsamples() const;
std::vector<uint8_t> initialization_vector;
std::vector<SubsampleEntry> subsamples;
};
struct SampleEncryption : FullBox {
enum SampleEncryptionFlags {
kUseSubsampleEncryption = 2,
};
DECLARE_BOX_METHODS(SampleEncryption);
/// Parse from @a sample_encryption_data.
/// @param iv_size specifies the size of initialization vector.
/// @param[out] sample_encryption_entries receives parsed sample encryption
/// entries.
/// @return true on success, false otherwise.
bool ParseFromSampleEncryptionData(
size_t iv_size,
std::vector<SampleEncryptionEntry>* sample_encryption_entries) const;
/// We may not know @a iv_size before reading this box. In this case, we will
/// store sample encryption data for parsing later when @a iv_size is known.
std::vector<uint8_t> sample_encryption_data;
size_t iv_size;
std::vector<SampleEncryptionEntry> sample_encryption_entries;
};
struct OriginalFormat : Box {
DECLARE_BOX_METHODS(OriginalFormat);
FourCC format;
};
struct SchemeType : FullBox {
DECLARE_BOX_METHODS(SchemeType);
FourCC type;
uint32_t version;
};
struct TrackEncryption : FullBox {
DECLARE_BOX_METHODS(TrackEncryption);
// Note: this definition is specific to the CENC protection type.
bool is_encrypted;
uint8_t default_iv_size;
std::vector<uint8_t> default_kid;
};
struct SchemeInfo : Box {
DECLARE_BOX_METHODS(SchemeInfo);
TrackEncryption track_encryption;
};
struct ProtectionSchemeInfo : Box {
DECLARE_BOX_METHODS(ProtectionSchemeInfo);
OriginalFormat format;
SchemeType type;
SchemeInfo info;
};
struct MovieHeader : FullBox {
DECLARE_BOX_METHODS(MovieHeader);
uint64_t creation_time;
uint64_t modification_time;
uint32_t timescale;
uint64_t duration;
int32_t rate;
int16_t volume;
uint32_t next_track_id;
};
struct TrackHeader : FullBox {
enum TrackHeaderFlags {
kTrackEnabled = 0x000001,
kTrackInMovie = 0x000002,
kTrackInPreview = 0x000004,
};
DECLARE_BOX_METHODS(TrackHeader);
uint64_t creation_time;
uint64_t modification_time;
uint32_t track_id;
uint64_t duration;
int16_t layer;
int16_t alternate_group;
int16_t volume;
// width and height specify the track's visual presentation size as
// fixed-point 16.16 values.
uint32_t width;
uint32_t height;
};
struct EditListEntry {
uint64_t segment_duration;
int64_t media_time;
int16_t media_rate_integer;
int16_t media_rate_fraction;
};
struct EditList : FullBox {
DECLARE_BOX_METHODS(EditList);
std::vector<EditListEntry> edits;
};
struct Edit : Box {
DECLARE_BOX_METHODS(Edit);
EditList list;
};
struct HandlerReference : FullBox {
DECLARE_BOX_METHODS(HandlerReference);
FourCC handler_type;
};
struct Language {
bool ReadWrite(BoxBuffer* buffer);
uint32_t ComputeSize() const;
std::string code;
};
/// Implemented per http://id3.org/id3v2.4.0-frames.
struct PrivFrame {
bool ReadWrite(BoxBuffer* buffer);
uint32_t ComputeSize() const;
std::string owner;
std::string value;
};
/// Implemented per http://mp4ra.org/specs.html#id3v2 and
/// http://id3.org/id3v2.4.0-structure.
struct ID3v2 : FullBox {
DECLARE_BOX_METHODS(ID3v2);
Language language;
/// We only support PrivateFrame in ID3. Other frames are ignored.
PrivFrame private_frame;
};
struct Metadata : FullBox {
DECLARE_BOX_METHODS(Metadata);
HandlerReference handler;
ID3v2 id3v2;
};
struct CodecConfigurationRecord : Box {
DECLARE_BOX_METHODS(CodecConfigurationRecord);
FourCC box_type;
// Contains full codec configuration record, including possible extension
// boxes.
std::vector<uint8_t> data;
};
struct PixelAspectRatio : Box {
DECLARE_BOX_METHODS(PixelAspectRatio);
uint32_t h_spacing;
uint32_t v_spacing;
};
struct VideoSampleEntry : Box {
DECLARE_BOX_METHODS(VideoSampleEntry);
// Returns actual format of this sample entry.
FourCC GetActualFormat() const {
return format == FOURCC_ENCV ? sinf.format.format : format;
}
FourCC format;
uint16_t data_reference_index;
uint16_t width;
uint16_t height;
PixelAspectRatio pixel_aspect;
ProtectionSchemeInfo sinf;
CodecConfigurationRecord codec_config_record;
};
struct ElementaryStreamDescriptor : FullBox {
DECLARE_BOX_METHODS(ElementaryStreamDescriptor);
AACAudioSpecificConfig aac_audio_specific_config;
ESDescriptor es_descriptor;
};
struct DTSSpecific : Box {
DECLARE_BOX_METHODS(DTSSpecific);
uint32_t sampling_frequency;
uint32_t max_bitrate;
uint32_t avg_bitrate;
uint8_t pcm_sample_depth;
std::vector<uint8_t> extra_data;
};
struct AudioSampleEntry : Box {
DECLARE_BOX_METHODS(AudioSampleEntry);
// Returns actual format of this sample entry.
FourCC GetActualFormat() const {
return format == FOURCC_ENCA ? sinf.format.format : format;
}
FourCC format;
uint16_t data_reference_index;
uint16_t channelcount;
uint16_t samplesize;
uint32_t samplerate;
ProtectionSchemeInfo sinf;
ElementaryStreamDescriptor esds;
DTSSpecific ddts;
};
struct WebVTTConfigurationBox : Box {
DECLARE_BOX_METHODS(WebVTTConfigurationBox);
std::string config;
};
struct WebVTTSourceLabelBox : Box {
DECLARE_BOX_METHODS(WebVTTSourceLabelBox);
std::string source_label;
};
struct WVTTSampleEntry : Box {
DECLARE_BOX_METHODS(WVTTSampleEntry);
uint16_t data_reference_index;
WebVTTConfigurationBox config;
WebVTTSourceLabelBox label;
// Optional MPEG4BitRateBox.
};
struct SampleDescription : FullBox {
DECLARE_BOX_METHODS(SampleDescription);
TrackType type;
// TODO(kqyang): Clean up the code to have one single member, e.g. by creating
// SampleEntry struct, std::vector<SampleEntry> sample_entries.
std::vector<VideoSampleEntry> video_entries;
std::vector<AudioSampleEntry> audio_entries;
std::vector<WVTTSampleEntry> wvtt_entries;
};
struct DecodingTime {
uint32_t sample_count;
uint32_t sample_delta;
};
// stts.
struct DecodingTimeToSample : FullBox {
DECLARE_BOX_METHODS(DecodingTimeToSample);
std::vector<DecodingTime> decoding_time;
};
struct CompositionOffset {
uint32_t sample_count;
// If version == 0, sample_offset is uint32_t;
// If version == 1, sample_offset is int32_t.
// Use int64_t so both can be supported properly.
int64_t sample_offset;
};
// ctts. Optional.
struct CompositionTimeToSample : FullBox {
DECLARE_BOX_METHODS(CompositionTimeToSample);
std::vector<CompositionOffset> composition_offset;
};
struct ChunkInfo {
uint32_t first_chunk;
uint32_t samples_per_chunk;
uint32_t sample_description_index;
};
// stsc.
struct SampleToChunk : FullBox {
DECLARE_BOX_METHODS(SampleToChunk);
std::vector<ChunkInfo> chunk_info;
};
// stsz.
struct SampleSize : FullBox {
DECLARE_BOX_METHODS(SampleSize);
uint32_t sample_size;
uint32_t sample_count;
std::vector<uint32_t> sizes;
};
// stz2.
struct CompactSampleSize : FullBox {
DECLARE_BOX_METHODS(CompactSampleSize);
uint8_t field_size;
std::vector<uint32_t> sizes;
};
// co64.
struct ChunkLargeOffset : FullBox {
DECLARE_BOX_METHODS(ChunkLargeOffset);
std::vector<uint64_t> offsets;
};
// stco.
struct ChunkOffset : ChunkLargeOffset {
DECLARE_BOX_METHODS(ChunkOffset);
};
// stss. Optional.
struct SyncSample : FullBox {
DECLARE_BOX_METHODS(SyncSample);
std::vector<uint32_t> sample_number;
};
struct SampleTable : Box {
DECLARE_BOX_METHODS(SampleTable);
SampleDescription description;
DecodingTimeToSample decoding_time_to_sample;
CompositionTimeToSample composition_time_to_sample;
SampleToChunk sample_to_chunk;
// Either SampleSize or CompactSampleSize must present. Store in SampleSize.
SampleSize sample_size;
// Either ChunkOffset or ChunkLargeOffset must present. Store in
// ChunkLargeOffset.
ChunkLargeOffset chunk_large_offset;
SyncSample sync_sample;
};
struct MediaHeader : FullBox {
DECLARE_BOX_METHODS(MediaHeader);
uint64_t creation_time;
uint64_t modification_time;
uint32_t timescale;
uint64_t duration;
Language language;
};
struct VideoMediaHeader : FullBox {
DECLARE_BOX_METHODS(VideoMediaHeader);
uint16_t graphicsmode;
uint16_t opcolor_red;
uint16_t opcolor_green;
uint16_t opcolor_blue;
};
struct SoundMediaHeader : FullBox {
DECLARE_BOX_METHODS(SoundMediaHeader);
uint16_t balance;
};
struct SubtitleMediaHeader : FullBox {
DECLARE_BOX_METHODS(SubtitleMediaHeader);
};
struct DataEntryUrl : FullBox {
DECLARE_BOX_METHODS(DataEntryUrl);
std::vector<uint8_t> location;
};
struct DataReference : FullBox {
DECLARE_BOX_METHODS(DataReference);
// data entry can be either url or urn box. Fix to url box for now.
std::vector<DataEntryUrl> data_entry;
};
struct DataInformation : Box {
DECLARE_BOX_METHODS(DataInformation);
DataReference dref;
};
struct MediaInformation : Box {
DECLARE_BOX_METHODS(MediaInformation);
DataInformation dinf;
SampleTable sample_table;
// Exactly one specific meida header shall be present, vmhd, smhd, hmhd, nmhd.
VideoMediaHeader vmhd;
SoundMediaHeader smhd;
SubtitleMediaHeader sthd;
};
struct Media : Box {
DECLARE_BOX_METHODS(Media);
MediaHeader header;
HandlerReference handler;
MediaInformation information;
};
struct Track : Box {
DECLARE_BOX_METHODS(Track);
TrackHeader header;
Media media;
Edit edit;
SampleEncryption sample_encryption;
};
struct MovieExtendsHeader : FullBox {
DECLARE_BOX_METHODS(MovieExtendsHeader);
uint64_t fragment_duration;
};
struct TrackExtends : FullBox {
DECLARE_BOX_METHODS(TrackExtends);
uint32_t track_id;
uint32_t default_sample_description_index;
uint32_t default_sample_duration;
uint32_t default_sample_size;
uint32_t default_sample_flags;
};
struct MovieExtends : Box {
DECLARE_BOX_METHODS(MovieExtends);
MovieExtendsHeader header;
std::vector<TrackExtends> tracks;
};
struct Movie : Box {
DECLARE_BOX_METHODS(Movie);
MovieHeader header;
Metadata metadata; // Used to hold version information.
MovieExtends extends;
std::vector<Track> tracks;
std::vector<ProtectionSystemSpecificHeader> pssh;
};
struct TrackFragmentDecodeTime : FullBox {
DECLARE_BOX_METHODS(TrackFragmentDecodeTime);
uint64_t decode_time;
};
struct MovieFragmentHeader : FullBox {
DECLARE_BOX_METHODS(MovieFragmentHeader);
uint32_t sequence_number;
};
struct TrackFragmentHeader : FullBox {
enum TrackFragmentFlagsMasks {
kBaseDataOffsetPresentMask = 0x000001,
kSampleDescriptionIndexPresentMask = 0x000002,
kDefaultSampleDurationPresentMask = 0x000008,
kDefaultSampleSizePresentMask = 0x000010,
kDefaultSampleFlagsPresentMask = 0x000020,
kDurationIsEmptyMask = 0x010000,
kDefaultBaseIsMoofMask = 0x020000,
};
enum SampleFlagsMasks {
kReservedMask = 0xFC000000,
kSampleDependsOnMask = 0x03000000,
kSampleIsDependedOnMask = 0x00C00000,
kSampleHasRedundancyMask = 0x00300000,
kSamplePaddingValueMask = 0x000E0000,
kNonKeySampleMask = 0x00010000,
kSampleDegradationPriorityMask = 0x0000FFFF,
};
DECLARE_BOX_METHODS(TrackFragmentHeader);
uint32_t track_id;
uint32_t sample_description_index;
uint32_t default_sample_duration;
uint32_t default_sample_size;
uint32_t default_sample_flags;
};
struct TrackFragmentRun : FullBox {
enum TrackFragmentFlagsMasks {
kDataOffsetPresentMask = 0x000001,
kFirstSampleFlagsPresentMask = 0x000004,
kSampleDurationPresentMask = 0x000100,
kSampleSizePresentMask = 0x000200,
kSampleFlagsPresentMask = 0x000400,
kSampleCompTimeOffsetsPresentMask = 0x000800,
};
DECLARE_BOX_METHODS(TrackFragmentRun);
uint32_t sample_count;
uint32_t data_offset;
std::vector<uint32_t> sample_flags;
std::vector<uint32_t> sample_sizes;
std::vector<uint32_t> sample_durations;
std::vector<int64_t> sample_composition_time_offsets;
};
struct SampleToGroupEntry {
enum GroupDescriptionIndexBase {
kTrackGroupDescriptionIndexBase = 0,
kTrackFragmentGroupDescriptionIndexBase = 0x10000,
};
uint32_t sample_count;
uint32_t group_description_index;
};
struct SampleToGroup : FullBox {
DECLARE_BOX_METHODS(SampleToGroup);
uint32_t grouping_type;
uint32_t grouping_type_parameter; // Version 1 only.
std::vector<SampleToGroupEntry> entries;
};
struct CencSampleEncryptionInfoEntry {
CencSampleEncryptionInfoEntry();
~CencSampleEncryptionInfoEntry();
bool is_encrypted;
uint8_t iv_size;
std::vector<uint8_t> key_id;
};
struct SampleGroupDescription : FullBox {
DECLARE_BOX_METHODS(SampleGroupDescription);
uint32_t grouping_type;
std::vector<CencSampleEncryptionInfoEntry> entries;
};
struct TrackFragment : Box {
DECLARE_BOX_METHODS(TrackFragment);
TrackFragmentHeader header;
std::vector<TrackFragmentRun> runs;
bool decode_time_absent;
TrackFragmentDecodeTime decode_time;
SampleToGroup sample_to_group;
SampleGroupDescription sample_group_description;
SampleAuxiliaryInformationSize auxiliary_size;
SampleAuxiliaryInformationOffset auxiliary_offset;
SampleEncryption sample_encryption;
};
struct MovieFragment : Box {
DECLARE_BOX_METHODS(MovieFragment);
MovieFragmentHeader header;
std::vector<TrackFragment> tracks;
std::vector<ProtectionSystemSpecificHeader> pssh;
};
struct SegmentReference {
enum SAPType {
TypeUnknown = 0,
Type1 = 1, // T(ept) = T(dec) = T(sap) = T(ptf)
Type2 = 2, // T(ept) = T(dec) = T(sap) < T(ptf)
Type3 = 3, // T(ept) < T(dec) = T(sap) <= T(ptf)
Type4 = 4, // T(ept) <= T(ptf) < T(dec) = T(sap)
Type5 = 5, // T(ept) = T(dec) < T(sap)
Type6 = 6, // T(ept) < T(dec) < T(sap)
};
bool reference_type;
uint32_t referenced_size;
uint32_t subsegment_duration;
bool starts_with_sap;
SAPType sap_type;
uint32_t sap_delta_time;
// We add this field to keep track of earliest_presentation_time in this
// subsegment. It is not part of SegmentReference.
uint64_t earliest_presentation_time;
};
struct SegmentIndex : FullBox {
DECLARE_BOX_METHODS(SegmentIndex);
uint32_t reference_id;
uint32_t timescale;
uint64_t earliest_presentation_time;
uint64_t first_offset;
std::vector<SegmentReference> references;
};
// The actual data is parsed and written separately.
struct MediaData : Box {
DECLARE_BOX_METHODS(MediaData);
uint32_t data_size;
};
struct CueSourceIDBox : Box {
DECLARE_BOX_METHODS(CueSourceIDBox);
int32_t source_id;
};
struct CueTimeBox : Box {
DECLARE_BOX_METHODS(CueTimeBox);
std::string cue_current_time;
};
struct CueIDBox : Box {
DECLARE_BOX_METHODS(CueIDBox);
std::string cue_id;
};
struct CueSettingsBox : Box {
DECLARE_BOX_METHODS(CueSettingsBox);
std::string settings;
};
struct CuePayloadBox : Box {
DECLARE_BOX_METHODS(CuePayloadBox);
std::string cue_text;
};
struct VTTEmptyCueBox : Box {
DECLARE_BOX_METHODS(VTTEmptyCueBox);
};
struct VTTAdditionalTextBox : Box {
DECLARE_BOX_METHODS(VTTAdditionalTextBox);
std::string cue_additional_text;
};
struct VTTCueBox : Box {
DECLARE_BOX_METHODS(VTTCueBox);
CueSourceIDBox cue_source_id;
CueIDBox cue_id;
CueTimeBox cue_time;
CueSettingsBox cue_settings;
CuePayloadBox cue_payload;
};
#undef DECLARE_BOX
} // namespace mp4
} // namespace media
} // namespace edash_packager
#endif // MEDIA_FORMATS_MP4_BOX_DEFINITIONS_H_