Skip to content

RufaelDev/cmaf_storage

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 

Repository files navigation

Document name: CMAF Storage Format

Authors:

CMAF Storage Format

Common Media Application Track Format (CMAF) [CMAF] has been standardized by ISO/IEC as 23000-19:2018. It defines a segment and track format for streaming content to clients. Common Media Application Track formatted content can be consumed by both DASH and HLS clients. While much industry attention is on the streaming of CMAF content, CMAF can also be interpreted as a base format for storing large collections of content assets. This may especially benefit the content that is stored with the objective to stream it in a later stage to different device types.

This document explores the possibility of using a CMAF Track file-based content storage format for large asset collections. One of the key aspects to overcome with this format is the lack of explicit grouping of CMAF tracks and the absence of multiplexing in CMAF track files.

Example Workflows and Use Cases for the CMAF Storage Format

Example workflows and use cases using the CMAF storage format include:

  1. Storing large asset collections on disk or in the cloud
  2. Storing assets using a single CMAF source format
  3. On-the-fly packaging or manifest generation for stored CMAF content
  4. Sub-clipping and stitching of CMAF stored content
  5. Searching and identifying content stored on disk or in the cloud
  6. Fast and granular access to content stored on disk or in the cloud

In each of such workflows, a simple manifest can be created to identify the location of the source content and the grouping of tracks in CMAF constructs. Other tools could be used to read and process the CMAF content for delivery and annotate CMAF tracks with additional information like bitrate, language and grouping identifiers, if this information was not yet available in the track files.

The CMAF track file structure itself provides fast and granular access through its fragmented file structure and the segment index box (sidx).

CMAF Media Objects

A brief and high-level description of CMAF constructs is given. For more detailed definitions, refer to ISO/IEC as 23000-19:2018 clause 7.

CMAF Header: An ISOBMFF FiletypeBox and MovieBox. CMAF Header can be used as an initialization segment for a DASH representation. See [CMAF] 7.3.2.1.

CMAF Chunk: A MovieFragmentBox indexing media samples and MovieDataBox containing the media samples. See [CMAF] 7.3.3.2.

CMAF Fragment: One or more CMAF chunks, starting with an IDR or random-access sample. See [CMAF] 7.3.2.4.

CMAF Segment: One or more CMAF Fragments. See [CMAF] 7.3.3.1.

CMAF Track: A CMAF Header followed by one or more CMAF Fragments. 7.3.2.2.

CMAF Track file: CMAF Track stored as a file. See [CMAF] 7.3.3.3.

CMAF Switching Set: One or more CMAF Tracks that a client can switch between. The tracks fullfill the Switching Set constraints defined in CMAF. See [CMAF] 7.3.4.

CMAF Aligned Switching Set: One or more CMAF Switching Sets with aligned switching points, the same media type and the same original source content. The tracks fullfill the aligned Switching Set constraints defined in CMAF. See [CMAF] 7.3.4.4.

CMAF Selection Set: One or more Switching Sets all of the same media type, e.g., audio, video, or subtitles. Different Switching Sets in a Selection Set may use different codecs, languages or other aspects of a presentation. See [CMAF] 7.3.5.

CMAF Presentation: Combination of one or more CMAF Switching Sets, containing different types of media such as audio, video and subtitles.

Storing CMAF Media Objects and Late Binding

The main construct for storing content defined in CMAF is the CMAF track file. As CMAF track files are not multiplexed, storing content using CMAF would imply storing each media track in a separate file. CMAF is designed in a way that the manifest file can combine different CMAF resources such as CMAF track files (instead of the file format itself as in MP4 that can multiplex different tracks). Based on a single set of CMAF resources, different manifests can reference different combinations. Combining CMAF track files this way is referred to as late binding in CMAF.

CMAF Storage Format: Storage Using CMAF Track Files

The CMAF Storage format defines best practices for storing CMAF content on disk using CMAF track files.

Firstly, the next section adds additional constraints on CMAF boxes and fields for efficient self-contained storage.

Table 1 and Table 2 present example guidelines for storing CMAF presentations using file naming and directory naming, respectively.

A simple manifest for storing CMAF content is defined, following the organization structure of CMAF presentations.

In addition, annotation of CMAF tracks with metadata may be needed to make it easy to identify the switching set, selection set or source content that a CMAF track belongs to without using a manifest.

CMAF Storage Format: Constraints on Optional Boxes and Fields

The CMAF track files have optional boxes and fields. For archiving, usage of these boxes is recommended in the following ways:

sidx: Recommended. Editor's note: Should this rather be Required?

prft: Optional. Editor's note: This does not add much compared to other times in the track file about when the media was created.

emsg: Recommended. Consider specific schemes of emsg for inserting metadata or information about the program. emsg will be duplicated across switching sets. Some emsg may contain program information, metadata or splice point information. Alternatively, emsg information could be filtered out and stored in a separate track.

styp: Optional. styp may be stored in case this benefits one's streaming workflow. This box is optional in CMAF and can be used to identify CMAF media object types such as a chunk, fragment, or random access chunk.

kind: Optional box to signal the role of the track, for example an MPEG DAH role urn:mpeg:dash:role:2011 or a W3C HTML5 role. It is recommended to use the kind box in udta to signal track role as defined in [CMAF] 7.5.3.

btrt: This box can be put in the sample entry (stsd) to store the bitrate of the track (both average and maximum). This information is useful to store as it can be used later in manifests for example.

elng: Extended language tag may be used to signal the language of the CMAF track.

mdhd: This box should be used to signal the language of the CMAF track.

sinf: Optional box to signal the encryption scheme and default encryption by containing schm box, and a schi box containing track encryption box (tenc). Proposal: Store CMAF unencrypted, and use storage or transport-level encryption instead (This may not be possible for certain content assets due to contractual requirements). Only use common encryption for streaming. Proposal: sinf box shall not be present.

elst: Optional. Edit lists are allowed in CMAF. They can be used to offset the composition times of all samples in the track. Editors note: CMAF track files need to start at presentation time 0 according to the spec, this seems arbitrary especially when archiving live content. Would it make sense to create this offset using an editlist or should one ignore this requirement and instead assume common timeline origin instead ?

CMAF Storage Using Track Files in a Directory and Filename Structure

The CMAF storage format stores all content as CMAF track files on disk or in the cloud. The combination of these CMAF tracks should conform to be a CMAF presentation. Table 1 illustrates a possible file storage structure for the storage format. Instead of naming based on the directory structure, identification could be embedded in the filenames as well as shown in Table 2.

Table 1: storage format using directory structuring

Root folder
       CMAF_presentation_id_1                     // The Batman movie
              CMAF_selection_set_id_1             // audio
                      CMAF_switching_set_id_1     // aac encoded audio 
                                      audio-aac-64k.cmfa
                                      audio-aac-128k.cmfa
                       CMAF_switching_set_id_2    // he-aac encoded audio
                                      audio-he-aac-64k.cmfa 
               CMAF_selection_set_id_2            // video 
                       CMAF_switching_set_id_3    // avc encoded video
                                      video-avc-400k.cmfv
                                      video-avc-800k.cmfv
                                      video-avc-1200k.cmfv
                       CMAF_switching_set_id_4    // hevc encoded video
                                      video-hevc-1200k.cmfv
                                      video-hevc-1600k.cmfv
               CMAF_selection_set_id_3            // subtitles
                       CMAF_switching_set_id_5    // webvtt English 
                                      timed-text-wvtt-en.cmft
                       CMAF_switching_set_id_6    // webvtt French
                                      timed-text-wvtt-fr.cmft
......

In Table 2, the presentation id (presid), switching set id (swsid) and selection set id (ssid) are implicitly coded in the filenames instead of the directory structure. In addition, the representation numbers are added in the filename as well.

Table 2: storage format using naming convention

Root folder
       CMAF_presentation_id_1                                    // The Batman movie
             presid1_ssid1_swsid1_rep0_audio-aac-64k.cmfa        // aac audio
             presid1_ssid1_swsid1_rep1_audio-aac-128k.cmfa
             presid1_ssid1_swsid2_rep0_audio-he-aac-64k.cmfa     // he-aac audio
             presid1_ssid2_swsid3_rep0_video-avc-400k.cmfv       // video avc
             presid1_ssid2_swsid3_rep1_video-avc-800k.cmfv
             presid1_ssid2_swsid3_rep2_video-avc-1200k.cmfv
             presid1_ssid2_swsid4_rep0_video-hevc-1200k.cmfv     // video hevc
             presid1_ssid2_swsid4_rep1_video-hevc-1600k.cmfv     // video hevc
             presid1_ssid3_swsid5_rep0_timed-text-wvtt-en.cmft   // webvtt English 
             presid1_ssid3_swsid6_rep0_timed-text-wvtt-fr.cmft   // webvtt French                      
......

Editor's note: Would it make sense to be able to annotate the track files themselves, allowing the filename/directory structure to be generated based on internal track file annotation?

CMAF Storage Using an XML Schema for CMAF Content

A possible XML schema for storing the CMAF stored files based on the CMAF hierarchy is as follows:

Table 3: storage format example XML naming scheme

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="urn:cmaf:storage:2019" targetNamespace="urn:cmaf:storage:2019">
	<xs:annotation>
		<xs:appinfo>CMAF Content Storage Description</xs:appinfo>
		<xs:documentation xml:lang="en">
        This Schema defines a simple description of CMAF stored content by grouping track files
        </xs:documentation>
	</xs:annotation>
    <!-- CMAF stored content -->
	<xs:element name="CMAFStorage" type="CMAFStorageType"/>
	<xs:element name="Presentation" type="PresentationType"/>
	<xs:element name="SelectionSet" type="SelectionSetType"/>
	<xs:element name="SwitchingSetType" type="SwitchingSetType"/>
	<xs:element name="TrackFile" type="TrackFileType"/>
  
	<!-- CMAF XML storage type -->
	<xs:complexType name="CMAFStorageType">
		<xs:sequence>
			<xs:element name="Presentation" type="PresentationType" maxOccurs="unbounded"/>
		</xs:sequence>
	</xs:complexType>
	<!-- Presentation -->
	<xs:complexType name="PresentationType">
		<xs:sequence>
			<xs:element name="SelectionSet" type="SelectionSetType" maxOccurs="unbounded"/>
		</xs:sequence>
	</xs:complexType>
	<!-- SelectionSet -->
	<xs:complexType name="SelectionSetType">
		<xs:sequence>
			<xs:element name="SwitchingSet" type="SwitchingSetType" maxOccurs="unbounded"/>
		</xs:sequence>
	</xs:complexType>
	<!-- SwitchingSet -->
	<xs:complexType name="SwitchingSetType">
		<xs:sequence>
			<xs:element name="TrackFile" type="TrackFileType" maxOccurs="unbounded"/>
		</xs:sequence>
	</xs:complexType>
	<!-- Track File -->
	<xs:simpleType name="TrackFileType">
		<xs:restriction base="xs:string">
			<!-- insert characters allowed for file name and location-->
		</xs:restriction>
	</xs:simpleType>
</xs:schema>

The example given in Table 2 could be described as:

Table 4: example XML representation of CMAF stored content in Table 2

<pre>
<?xml version="1.0" encoding="utf-8"?>
<CMAFStorage
	     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	     xmlns="urn:cmaf:storage:2019">
	<Presentation>
		<SelectionSet>
			<SwitchingSet>
				<TrackFile>
					presid1_ssid1_swsid1_rep0_audio-aac-64k.cmfa
				</TrackFile>
				<TrackFile>
					presid1_ssid1_swsid1_rep0_audio-aac-128k.cmfa
				</TrackFile>
			</SwitchingSet>
			<SwitchingSet>
				<TrackFile>
					presid1_ssid1_swsid2_rep0_audio-he-aac-64k.cmfa
				</TrackFile>
			</SwitchingSet>
		</SelectionSet>
		<SelectionSet> 
			<SwitchingSet>
				<TrackFile>
					presid1_ssid2_swsid3_rep0_video-avc-400k.cmfv
				</TrackFile>
				<TrackFile>
					presid1_ssid2_swsid3_rep0_video-avc-800k.cmfv
				</TrackFile>
				<TrackFile>
					presid1_ssid2_swsid3_rep0_video-avc-1200k.cmfv
				</TrackFile>
			</SwitchingSet>
			<SwitchingSet>
				<TrackFile>
					presid1_ssid2_swsid4_rep0_video-hevc-1200k.cmfv
				</TrackFile>
				<TrackFile>
					presid1_ssid2_swsid4_rep0_video-hevc-1600k.cmfv
				</TrackFile>
			</SwitchingSet>
		</SelectionSet>
		<SelectionSet>
			<SwitchingSet>
				<TrackFile>
					presid1_ssid3_swsid5_rep0_timed-text-wvtt-en.cmft 
				</TrackFile>
			</SwitchingSet>
			<SwitchingSet>
				<TrackFile>
					presid1_ssid3_swsid5_rep0_timed-text-wvtt-fr.cmft 
				</TrackFile>
			</SwitchingSet>
		</SelectionSet>
	</Presentation>
</CMAFStorage>

Editor's note: This schema could be expanded to carry additional information about the presentation, for example, the identifiers.

Additional Questions and Answers Regarding CMAF Track Storage Format in General

How can one identify CMAF switching sets from tracks in the CMAF Tracks?

CMAF defines switching set constraints, 7.3.4 Table 11, if tracks are representing the same content, one could identify switching sets implicitly based on the CMAF track format constraints. Tracks with the same source content and same codec fulfilling the switching set constraints can be implicitly derived as being part of the same switching set. CMAF storage format may define additional (in-band or out-of-band) signalling to identify switchingset grouping of track files. It is better to use the switching set definition from the original author instead of based on technical features, as to preserve the original author's intent. This feature is aimed to be supported by this storage format to make the track grouping explicit.

How can one identify selection sets and/or aligned switching sets from CMAF Tracks ?

CMAF defines requirements 7.3.4.4 for aligned switching sets, but these are harder to use for detecting and identifying them, as it is not clear if it makes sense for different media types. Selection set may be the default for different switching sets with the same media type (different language subtitles, different video codecs, different audio codecs). The CMAF storage format may define additional signalling to identify aligned switching set grouping of track files and selection set grouping of track files.

How can one identify if CMAF tracks are based on the same source content ?

Due to storing tracks in separate files, it can be unclear if tracks are based on identical source content. Typically, the file name could give an identification of the source content. CMAF storage format may define additional content identifiers to be used in track files. Such identifiers could be used to detect the source of the content, or at least assert if it is the same for different tracks.

How can CMAF stored content be delivered ?

A manifest is needed to deliver the content. One way to produce the manifest is to use a DASH/HLS packager tool. Based on the CMAF storage format, additional tools may be developed for generating manifests from the source content. For example, HLS and DASH manifests could be generated automatically for a stored CMAF presentation. Alternatively, annotated CMAF tracks can be posted to a publishing point, such as using CMAF ingest by posting individual CMAF fragments [CMAF ingest].

[CMAF] ISO/IEC 23000-19:2018 Information technology — Multimedia application format (MPEG-A) — Part 19: Common media application format (CMAF) for segmented media

[CMAF Ingest] DASH-IF Live ingest protocol https://dashif-documents.azurewebsites.net/Ingest/master/DASH-IF-Ingest.html

About

defines a cmaf based media asset storage format

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published