1 // Copyright (c) 2012 The WebM project authors. All Rights Reserved.
3 // Use of this source code is governed by a BSD-style license
4 // that can be found in the LICENSE file in the root of the source
5 // tree. An additional intellectual property rights grant can be found
6 // in the file PATENTS. All contributing project authors may
7 // be found in the AUTHORS file in the root of the source tree.
18 const int E_FILE_FORMAT_INVALID = -2;
19 const int E_BUFFER_NOT_FULL = -3;
23 virtual int Read(long long pos, long len, unsigned char* buf) = 0;
24 virtual int Length(long long* total, long long* available) = 0;
27 virtual ~IMkvReader();
30 long long GetUIntLength(IMkvReader*, long long, long&);
31 long long ReadUInt(IMkvReader*, long long, long&);
32 long long UnserializeUInt(IMkvReader*, long long pos, long long size);
34 long UnserializeFloat(IMkvReader*, long long pos, long long size, double&);
35 long UnserializeInt(IMkvReader*, long long pos, long len, long long& result);
37 long UnserializeString(IMkvReader*, long long pos, long long size, char*& str);
39 long ParseElementHeader(IMkvReader* pReader,
40 long long& pos, // consume id and size fields
41 long long stop, // if you know size of element's parent
42 long long& id, long long& size);
44 bool Match(IMkvReader*, long long&, unsigned long, long long&);
45 bool Match(IMkvReader*, long long&, unsigned long, unsigned char*&, size_t&);
47 void GetVersion(int& major, int& minor, int& build, int& revision);
53 long long m_readVersion;
54 long long m_maxIdLength;
55 long long m_maxSizeLength;
57 long long m_docTypeVersion;
58 long long m_docTypeReadVersion;
60 long long Parse(IMkvReader*, long long&);
70 Block& operator=(const Block&);
73 const long long m_start;
74 const long long m_size;
76 Block(long long start, long long size, long long discard_padding);
79 long Parse(const Cluster*);
81 long long GetTrackNumber() const;
82 long long GetTimeCode(const Cluster*) const; // absolute, but not scaled
83 long long GetTime(const Cluster*) const; // absolute, and scaled (ns)
86 bool IsInvisible() const;
88 enum Lacing { kLacingNone, kLacingXiph, kLacingFixed, kLacingEbml };
89 Lacing GetLacing() const;
91 int GetFrameCount() const; // to index frames: [0, count)
94 long long pos; // absolute offset
97 long Read(IMkvReader*, unsigned char*) const;
100 const Frame& GetFrame(int frame_index) const;
102 long long GetDiscardPadding() const;
105 long long m_track; // Track::Number()
106 short m_timecode; // relative to cluster
107 unsigned char m_flags;
113 const long long m_discard_padding;
117 BlockEntry(const BlockEntry&);
118 BlockEntry& operator=(const BlockEntry&);
121 BlockEntry(Cluster*, long index);
124 virtual ~BlockEntry();
127 const Cluster* GetCluster() const;
128 long GetIndex() const;
129 virtual const Block* GetBlock() const = 0;
131 enum Kind { kBlockEOS, kBlockSimple, kBlockGroup };
132 virtual Kind GetKind() const = 0;
135 Cluster* const m_pCluster;
139 class SimpleBlock : public BlockEntry {
140 SimpleBlock(const SimpleBlock&);
141 SimpleBlock& operator=(const SimpleBlock&);
144 SimpleBlock(Cluster*, long index, long long start, long long size);
147 Kind GetKind() const;
148 const Block* GetBlock() const;
154 class BlockGroup : public BlockEntry {
155 BlockGroup(const BlockGroup&);
156 BlockGroup& operator=(const BlockGroup&);
159 BlockGroup(Cluster*, long index,
160 long long block_start, // absolute pos of block's payload
161 long long block_size, // size of block's payload
162 long long prev, long long next, long long duration,
163 long long discard_padding);
167 Kind GetKind() const;
168 const Block* GetBlock() const;
170 long long GetPrevTimeCode() const; // relative to block's time
171 long long GetNextTimeCode() const; // as above
172 long long GetDurationTimeCode() const;
176 const long long m_prev;
177 const long long m_next;
178 const long long m_duration;
181 ///////////////////////////////////////////////////////////////
182 // ContentEncoding element
183 // Elements used to describe if the track data has been encrypted or
184 // compressed with zlib or header stripping.
185 class ContentEncoding {
192 // ContentCompression element names
193 struct ContentCompression {
194 ContentCompression();
195 ~ContentCompression();
197 unsigned long long algo;
198 unsigned char* settings;
199 long long settings_len;
202 // ContentEncAESSettings element names
203 struct ContentEncAESSettings {
204 ContentEncAESSettings() : cipher_mode(kCTR) {}
205 ~ContentEncAESSettings() {}
207 unsigned long long cipher_mode;
210 // ContentEncryption element names
211 struct ContentEncryption {
213 ~ContentEncryption();
215 unsigned long long algo;
216 unsigned char* key_id;
217 long long key_id_len;
218 unsigned char* signature;
219 long long signature_len;
220 unsigned char* sig_key_id;
221 long long sig_key_id_len;
222 unsigned long long sig_algo;
223 unsigned long long sig_hash_algo;
225 ContentEncAESSettings aes_settings;
228 // Returns ContentCompression represented by |idx|. Returns NULL if |idx|
230 const ContentCompression* GetCompressionByIndex(unsigned long idx) const;
232 // Returns number of ContentCompression elements in this ContentEncoding
234 unsigned long GetCompressionCount() const;
236 // Parses the ContentCompression element from |pReader|. |start| is the
237 // starting offset of the ContentCompression payload. |size| is the size in
238 // bytes of the ContentCompression payload. |compression| is where the parsed
239 // values will be stored.
240 long ParseCompressionEntry(long long start, long long size,
242 ContentCompression* compression);
244 // Returns ContentEncryption represented by |idx|. Returns NULL if |idx|
246 const ContentEncryption* GetEncryptionByIndex(unsigned long idx) const;
248 // Returns number of ContentEncryption elements in this ContentEncoding
250 unsigned long GetEncryptionCount() const;
252 // Parses the ContentEncAESSettings element from |pReader|. |start| is the
253 // starting offset of the ContentEncAESSettings payload. |size| is the
254 // size in bytes of the ContentEncAESSettings payload. |encryption| is
255 // where the parsed values will be stored.
256 long ParseContentEncAESSettingsEntry(long long start, long long size,
258 ContentEncAESSettings* aes);
260 // Parses the ContentEncoding element from |pReader|. |start| is the
261 // starting offset of the ContentEncoding payload. |size| is the size in
262 // bytes of the ContentEncoding payload. Returns true on success.
263 long ParseContentEncodingEntry(long long start, long long size,
264 IMkvReader* pReader);
266 // Parses the ContentEncryption element from |pReader|. |start| is the
267 // starting offset of the ContentEncryption payload. |size| is the size in
268 // bytes of the ContentEncryption payload. |encryption| is where the parsed
269 // values will be stored.
270 long ParseEncryptionEntry(long long start, long long size,
271 IMkvReader* pReader, ContentEncryption* encryption);
273 unsigned long long encoding_order() const { return encoding_order_; }
274 unsigned long long encoding_scope() const { return encoding_scope_; }
275 unsigned long long encoding_type() const { return encoding_type_; }
278 // Member variables for list of ContentCompression elements.
279 ContentCompression** compression_entries_;
280 ContentCompression** compression_entries_end_;
282 // Member variables for list of ContentEncryption elements.
283 ContentEncryption** encryption_entries_;
284 ContentEncryption** encryption_entries_end_;
286 // ContentEncoding element names
287 unsigned long long encoding_order_;
288 unsigned long long encoding_scope_;
289 unsigned long long encoding_type_;
291 // LIBWEBM_DISALLOW_COPY_AND_ASSIGN(ContentEncoding);
292 ContentEncoding(const ContentEncoding&);
293 ContentEncoding& operator=(const ContentEncoding&);
298 Track& operator=(const Track&);
302 static long Create(Segment*, const Info&, long long element_start,
303 long long element_size, Track*&);
305 enum Type { kVideo = 1, kAudio = 2, kSubtitle = 0x11, kMetadata = 0x21 };
307 Segment* const m_pSegment;
308 const long long m_element_start;
309 const long long m_element_size;
312 long GetType() const;
313 long GetNumber() const;
314 unsigned long long GetUid() const;
315 const char* GetNameAsUTF8() const;
316 const char* GetLanguage() const;
317 const char* GetCodecNameAsUTF8() const;
318 const char* GetCodecId() const;
319 const unsigned char* GetCodecPrivate(size_t&) const;
320 bool GetLacing() const;
321 unsigned long long GetDefaultDuration() const;
322 unsigned long long GetCodecDelay() const;
323 unsigned long long GetSeekPreRoll() const;
325 const BlockEntry* GetEOS() const;
336 int Copy(Info&) const;
340 unsigned long long uid;
341 unsigned long long defaultDuration;
342 unsigned long long codecDelay;
343 unsigned long long seekPreRoll;
347 char* codecNameAsUTF8;
348 unsigned char* codecPrivate;
349 size_t codecPrivateSize;
355 Info& operator=(const Info&);
356 int CopyStr(char* Info::*str, Info&) const;
359 long GetFirst(const BlockEntry*&) const;
360 long GetNext(const BlockEntry* pCurr, const BlockEntry*& pNext) const;
361 virtual bool VetEntry(const BlockEntry*) const;
362 virtual long Seek(long long time_ns, const BlockEntry*&) const;
364 const ContentEncoding* GetContentEncodingByIndex(unsigned long idx) const;
365 unsigned long GetContentEncodingCount() const;
367 long ParseContentEncodingsEntry(long long start, long long size);
370 Track(Segment*, long long element_start, long long element_size);
374 class EOSBlock : public BlockEntry {
378 Kind GetKind() const;
379 const Block* GetBlock() const;
385 ContentEncoding** content_encoding_entries_;
386 ContentEncoding** content_encoding_entries_end_;
389 class VideoTrack : public Track {
390 VideoTrack(const VideoTrack&);
391 VideoTrack& operator=(const VideoTrack&);
393 VideoTrack(Segment*, long long element_start, long long element_size);
396 static long Parse(Segment*, const Info&, long long element_start,
397 long long element_size, VideoTrack*&);
399 long long GetWidth() const;
400 long long GetHeight() const;
401 long long GetDisplayWidth() const;
402 long long GetDisplayHeight() const;
403 long long GetDisplayUnit() const;
404 long long GetStereoMode() const;
405 double GetFrameRate() const;
407 bool VetEntry(const BlockEntry*) const;
408 long Seek(long long time_ns, const BlockEntry*&) const;
413 long long m_display_width;
414 long long m_display_height;
415 long long m_display_unit;
416 long long m_stereo_mode;
421 class AudioTrack : public Track {
422 AudioTrack(const AudioTrack&);
423 AudioTrack& operator=(const AudioTrack&);
425 AudioTrack(Segment*, long long element_start, long long element_size);
428 static long Parse(Segment*, const Info&, long long element_start,
429 long long element_size, AudioTrack*&);
431 double GetSamplingRate() const;
432 long long GetChannels() const;
433 long long GetBitDepth() const;
437 long long m_channels;
438 long long m_bitDepth;
442 Tracks(const Tracks&);
443 Tracks& operator=(const Tracks&);
446 Segment* const m_pSegment;
447 const long long m_start;
448 const long long m_size;
449 const long long m_element_start;
450 const long long m_element_size;
452 Tracks(Segment*, long long start, long long size, long long element_start,
453 long long element_size);
459 unsigned long GetTracksCount() const;
461 const Track* GetTrackByNumber(long tn) const;
462 const Track* GetTrackByIndex(unsigned long idx) const;
465 Track** m_trackEntries;
466 Track** m_trackEntriesEnd;
468 long ParseTrackEntry(long long payload_start, long long payload_size,
469 long long element_start, long long element_size,
474 Chapters(const Chapters&);
475 Chapters& operator=(const Chapters&);
478 Segment* const m_pSegment;
479 const long long m_start;
480 const long long m_size;
481 const long long m_element_start;
482 const long long m_element_size;
484 Chapters(Segment*, long long payload_start, long long payload_size,
485 long long element_start, long long element_size);
497 Display(const Display&);
499 Display& operator=(const Display&);
502 const char* GetString() const;
503 const char* GetLanguage() const;
504 const char* GetCountry() const;
508 void ShallowCopy(Display&) const;
510 long Parse(IMkvReader*, long long pos, long long size);
518 friend class Edition;
522 Atom& operator=(const Atom&);
525 unsigned long long GetUID() const;
526 const char* GetStringUID() const;
528 long long GetStartTimecode() const;
529 long long GetStopTimecode() const;
531 long long GetStartTime(const Chapters*) const;
532 long long GetStopTime(const Chapters*) const;
534 int GetDisplayCount() const;
535 const Display* GetDisplay(int index) const;
539 void ShallowCopy(Atom&) const;
541 long Parse(IMkvReader*, long long pos, long long size);
542 static long long GetTime(const Chapters*, long long timecode);
544 long ParseDisplay(IMkvReader*, long long pos, long long size);
545 bool ExpandDisplaysArray();
548 unsigned long long m_uid;
549 long long m_start_timecode;
550 long long m_stop_timecode;
554 int m_displays_count;
558 friend class Chapters;
560 Edition(const Edition&);
562 Edition& operator=(const Edition&);
565 int GetAtomCount() const;
566 const Atom* GetAtom(int index) const;
570 void ShallowCopy(Edition&) const;
572 long Parse(IMkvReader*, long long pos, long long size);
574 long ParseAtom(IMkvReader*, long long pos, long long size);
575 bool ExpandAtomsArray();
582 int GetEditionCount() const;
583 const Edition* GetEdition(int index) const;
586 long ParseEdition(long long pos, long long size);
587 bool ExpandEditionsArray();
591 int m_editions_count;
596 Tags& operator=(const Tags&);
599 Segment* const m_pSegment;
600 const long long m_start;
601 const long long m_size;
602 const long long m_element_start;
603 const long long m_element_size;
605 Tags(Segment*, long long payload_start, long long payload_size,
606 long long element_start, long long element_size);
618 SimpleTag(const SimpleTag&);
620 SimpleTag& operator=(const SimpleTag&);
623 const char* GetTagName() const;
624 const char* GetTagString() const;
628 void ShallowCopy(SimpleTag&) const;
630 long Parse(IMkvReader*, long long pos, long long size);
641 Tag& operator=(const Tag&);
644 int GetSimpleTagCount() const;
645 const SimpleTag* GetSimpleTag(int index) const;
649 void ShallowCopy(Tag&) const;
651 long Parse(IMkvReader*, long long pos, long long size);
653 long ParseSimpleTag(IMkvReader*, long long pos, long long size);
654 bool ExpandSimpleTagsArray();
656 SimpleTag* m_simple_tags;
657 int m_simple_tags_size;
658 int m_simple_tags_count;
661 int GetTagCount() const;
662 const Tag* GetTag(int index) const;
665 long ParseTag(long long pos, long long size);
666 bool ExpandTagsArray();
674 SegmentInfo(const SegmentInfo&);
675 SegmentInfo& operator=(const SegmentInfo&);
678 Segment* const m_pSegment;
679 const long long m_start;
680 const long long m_size;
681 const long long m_element_start;
682 const long long m_element_size;
684 SegmentInfo(Segment*, long long start, long long size,
685 long long element_start, long long element_size);
691 long long GetTimeCodeScale() const;
692 long long GetDuration() const; // scaled
693 const char* GetMuxingAppAsUTF8() const;
694 const char* GetWritingAppAsUTF8() const;
695 const char* GetTitleAsUTF8() const;
698 long long m_timecodeScale;
700 char* m_pMuxingAppAsUTF8;
701 char* m_pWritingAppAsUTF8;
702 char* m_pTitleAsUTF8;
706 SeekHead(const SeekHead&);
707 SeekHead& operator=(const SeekHead&);
710 Segment* const m_pSegment;
711 const long long m_start;
712 const long long m_size;
713 const long long m_element_start;
714 const long long m_element_size;
716 SeekHead(Segment*, long long start, long long size, long long element_start,
717 long long element_size);
724 // the SeekHead entry payload
728 // absolute pos of SeekEntry ID
729 long long element_start;
731 // SeekEntry ID size + size size + payload
732 long long element_size;
735 int GetCount() const;
736 const Entry* GetEntry(int idx) const;
739 // absolute pos of Void ID
740 long long element_start;
742 // ID size + size size + payload size
743 long long element_size;
746 int GetVoidElementCount() const;
747 const VoidElement* GetVoidElement(int idx) const;
753 VoidElement* m_void_elements;
754 int m_void_element_count;
756 static bool ParseEntry(IMkvReader*,
757 long long pos, // payload
758 long long size, Entry*);
765 CuePoint(long, long long);
768 CuePoint(const CuePoint&);
769 CuePoint& operator=(const CuePoint&);
772 long long m_element_start;
773 long long m_element_size;
775 bool Load(IMkvReader*);
777 long long GetTimeCode() const; // absolute but unscaled
778 long long GetTime(const Segment*) const; // absolute and scaled (ns units)
780 struct TrackPosition {
782 long long m_pos; // of cluster
784 // codec_state //defaults to 0
785 // reference = clusters containing req'd referenced blocks
786 // reftime = timecode of the referenced block
788 bool Parse(IMkvReader*, long long, long long);
791 const TrackPosition* Find(const Track*) const;
795 long long m_timecode;
796 TrackPosition* m_track_positions;
797 size_t m_track_positions_count;
801 friend class Segment;
803 Cues(Segment*, long long start, long long size, long long element_start,
804 long long element_size);
808 Cues& operator=(const Cues&);
811 Segment* const m_pSegment;
812 const long long m_start;
813 const long long m_size;
814 const long long m_element_start;
815 const long long m_element_size;
817 bool Find( // lower bound of time_ns
818 long long time_ns, const Track*, const CuePoint*&,
819 const CuePoint::TrackPosition*&) const;
821 const CuePoint* GetFirst() const;
822 const CuePoint* GetLast() const;
823 const CuePoint* GetNext(const CuePoint*) const;
825 const BlockEntry* GetBlock(const CuePoint*,
826 const CuePoint::TrackPosition*) const;
828 bool LoadCuePoint() const;
829 long GetCount() const; // loaded only
830 // long GetTotal() const; //loaded + preloaded
831 bool DoneParsing() const;
835 void PreloadCuePoint(long&, long long) const;
837 mutable CuePoint** m_cue_points;
838 mutable long m_count;
839 mutable long m_preload_count;
840 mutable long long m_pos;
844 friend class Segment;
846 Cluster(const Cluster&);
847 Cluster& operator=(const Cluster&);
850 Segment* const m_pSegment;
853 static Cluster* Create(Segment*,
854 long index, // index in segment
855 long long off); // offset relative to segment
856 // long long element_size);
858 Cluster(); // EndOfStream
863 long long GetTimeCode() const; // absolute, but not scaled
864 long long GetTime() const; // absolute, and scaled (nanosecond units)
865 long long GetFirstTime() const; // time (ns) of first (earliest) block
866 long long GetLastTime() const; // time (ns) of last (latest) block
868 long GetFirst(const BlockEntry*&) const;
869 long GetLast(const BlockEntry*&) const;
870 long GetNext(const BlockEntry* curr, const BlockEntry*& next) const;
872 const BlockEntry* GetEntry(const Track*, long long ns = -1) const;
873 const BlockEntry* GetEntry(const CuePoint&,
874 const CuePoint::TrackPosition&) const;
875 // const BlockEntry* GetMaxKey(const VideoTrack*) const;
877 // static bool HasBlockEntries(const Segment*, long long);
879 static long HasBlockEntries(const Segment*, long long idoff, long long& pos,
882 long GetEntryCount() const;
884 long Load(long long& pos, long& size) const;
886 long Parse(long long& pos, long& size) const;
887 long GetEntry(long index, const mkvparser::BlockEntry*&) const;
890 Cluster(Segment*, long index, long long element_start);
891 // long long element_size);
894 const long long m_element_start;
895 long long GetPosition() const; // offset relative to segment
897 long GetIndex() const;
898 long long GetElementSize() const;
899 // long long GetPayloadSize() const;
901 // long long Unparsed() const;
905 mutable long long m_pos;
906 // mutable long long m_size;
907 mutable long long m_element_size;
908 mutable long long m_timecode;
909 mutable BlockEntry** m_entries;
910 mutable long m_entries_size;
911 mutable long m_entries_count;
913 long ParseSimpleBlock(long long, long long&, long&);
914 long ParseBlockGroup(long long, long long&, long&);
916 long CreateBlock(long long id, long long pos, long long size,
917 long long discard_padding);
918 long CreateBlockGroup(long long start_offset, long long size,
919 long long discard_padding);
920 long CreateSimpleBlock(long long, long long);
926 friend class VideoTrack;
928 Segment(const Segment&);
929 Segment& operator=(const Segment&);
932 Segment(IMkvReader*, long long elem_start,
933 // long long elem_size,
934 long long pos, long long size);
937 IMkvReader* const m_pReader;
938 const long long m_element_start;
939 // const long long m_element_size;
940 const long long m_start; // posn of segment payload
941 const long long m_size; // size of segment payload
942 Cluster m_eos; // TODO: make private?
944 static long long CreateInstance(IMkvReader*, long long, Segment*&);
947 long Load(); // loads headers and all clusters
949 // for incremental loading
950 // long long Unparsed() const;
951 bool DoneParsing() const;
952 long long ParseHeaders(); // stops when first cluster is found
953 // long FindNextCluster(long long& pos, long& size) const;
954 long LoadCluster(long long& pos, long& size); // load one cluster
957 long ParseNext(const Cluster* pCurr, const Cluster*& pNext, long long& pos,
960 const SeekHead* GetSeekHead() const;
961 const Tracks* GetTracks() const;
962 const SegmentInfo* GetInfo() const;
963 const Cues* GetCues() const;
964 const Chapters* GetChapters() const;
965 const Tags* GetTags() const;
967 long long GetDuration() const;
969 unsigned long GetCount() const;
970 const Cluster* GetFirst() const;
971 const Cluster* GetLast() const;
972 const Cluster* GetNext(const Cluster*);
974 const Cluster* FindCluster(long long time_nanoseconds) const;
975 // const BlockEntry* Seek(long long time_nanoseconds, const Track*) const;
977 const Cluster* FindOrPreloadCluster(long long pos);
979 long ParseCues(long long cues_off, // offset relative to start of segment
980 long long& parse_pos, long& parse_len);
983 long long m_pos; // absolute file posn; what has been consumed so far
984 Cluster* m_pUnknownSize;
986 SeekHead* m_pSeekHead;
987 SegmentInfo* m_pInfo;
990 Chapters* m_pChapters;
992 Cluster** m_clusters;
993 long m_clusterCount; // number of entries for which m_index >= 0
994 long m_clusterPreloadCount; // number of entries for which m_index < 0
995 long m_clusterSize; // array size
997 long DoLoadCluster(long long&, long&);
998 long DoLoadClusterUnknownSize(long long&, long&);
999 long DoParseNext(const Cluster*&, long long&, long&);
1001 void AppendCluster(Cluster*);
1002 void PreloadCluster(Cluster*, ptrdiff_t);
1004 // void ParseSeekHead(long long pos, long long size);
1005 // void ParseSeekEntry(long long pos, long long size);
1006 // void ParseCues(long long);
1008 const BlockEntry* GetBlock(const CuePoint&, const CuePoint::TrackPosition&);
1011 } // end namespace mkvparser
1013 inline long mkvparser::Segment::LoadCluster() {
1017 return LoadCluster(pos, size);
1020 #endif // MKVPARSER_HPP