Skip to content

Commit

Permalink
preparation for CMCDv2 - without breaking CMCDv1
Browse files Browse the repository at this point in the history
  • Loading branch information
@paulhiggs
paulhiggs committed Nov 5, 2024
1 parent c7bc813 commit f375117
Show file tree
Hide file tree
Showing 3 changed files with 121 additions and 40 deletions.
129 changes: 96 additions & 33 deletions CMCD.js
View file
Original file line number Diff line number Diff line change
@@ -1,71 +1,134 @@
/**
* CMCD.js
*
* Definitions related to CMCD
* Definitions and check related to CMCD
*
*/

import { APPLICATION } from "./error_list.js";
import { dvbi } from "./DVB-I_definitions.js";
import { CMCD_MODE_REQUEST, CMCD_MODE_RESPONSE, CMCD_MODE_INTERVAL } from "./DVB-I_definitions.js";
import { APPLICATION, WARNING } from "./error_list.js";
import { isIn } from "./utils.js";

export const CMCD_keys = {
encoded_bitrate: "br",
buffer_length: "bl",
buffer_starvation: "bs",
buffer_starvation_duration: "bsd",
cdn_id: "cdn",
content_id: "cid",
object_duration: "d",
deadline: "dl",
live_stream_latency: "ltc",
measured_throughput: "mtp",
next_object_request: "nor",
next_range_request: "nrr",
object_type: "ot",
playback_rate: "pr",
requested_maximum_throughput: "rtp",
response_code: "rc",
streaming_format: "sf",
session_id: "sid",
interstitial: "int",
state: "sta",
stream_type: "st",
startup: "su",
top_bitrate: "tb",
time_to_first_byte: "ttfb",
time_to_first_body_byte: "ttfbb",
time_to_last_byte: "ttlb",
timestamp: "ts",
top_encoded_bitrate: "tb",
lowest_encoded_bitrate: "lb",
top_aggregated_encoded_bitrate: "tab",
lowest_aggregated_encoded_bitrate: "lab",
request_url: "url",
playhead_position: "pp",
player_error_code: "ec",
media_start_delay: "msd",
cmcd_version: "v",
};

const all_reporting_modes = [CMCD_MODE_REQUEST, CMCD_MODE_RESPONSE, CMCD_MODE_INTERVAL];
const CMCDv1_keys = [
CMCD_keys.encoded_bitrate,
CMCD_keys.buffer_length,
CMCD_keys.buffer_starvation,
CMCD_keys.content_id,
CMCD_keys.object_duration,
CMCD_keys.deadline,
CMCD_keys.measured_throughput,
CMCD_keys.next_object_request,
CMCD_keys.next_range_request,
CMCD_keys.object_type,
CMCD_keys.playback_rate,
CMCD_keys.requested_maximum_throughput,
CMCD_keys.streaming_format,
CMCD_keys.session_id,
CMCD_keys.stream_type,
CMCD_keys.startup,
CMCD_keys.top_bitrate,
CMCD_keys.cmcd_version,
{ key: CMCD_keys.encoded_bitrate, allow_modes: all_reporting_modes },
{ key: CMCD_keys.buffer_length, allow_modes: all_reporting_modes },
{ key: CMCD_keys.buffer_starvation, allow_modes: all_reporting_modes },
{ key: CMCD_keys.content_id, allow_modes: all_reporting_modes },
{ key: CMCD_keys.object_duration, allow_modes: [CMCD_MODE_REQUEST, CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.deadline, allow_modes: [CMCD_MODE_REQUEST, CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.measured_throughput, allow_modes: all_reporting_modes },
{ key: CMCD_keys.next_object_request, allow_modes: [CMCD_MODE_REQUEST, CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.next_range_request, allow_modes: [CMCD_MODE_REQUEST, CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.object_type, allow_modes: [CMCD_MODE_REQUEST, CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.playback_rate, allow_modes: all_reporting_modes },
{ key: CMCD_keys.requested_maximum_throughput, allow_modes: [CMCD_MODE_REQUEST, CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.streaming_format, allow_modes: all_reporting_modes },
{ key: CMCD_keys.session_id, allow_modes: all_reporting_modes },
{ key: CMCD_keys.stream_type, allow_modes: all_reporting_modes },
{ key: CMCD_keys.startup, allow_modes: [CMCD_MODE_REQUEST, CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.top_encoded_bitrate, allow_modes: all_reporting_modes },
{ key: CMCD_keys.cmcd_version, allow_modes: all_reporting_modes },
];

const CMCDv2_keys = CMCDv1_keys.concat([
{ key: CMCD_keys.buffer_starvation_duration, allow_modes: [CMCD_MODE_REQUEST, CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.cdn_id, allow_modes: all_reporting_modes },
{ ley: CMCD_keys.live_stream_latency, allow_modes: all_reporting_modes },
{ key: CMCD_keys.response_code, allow_modes: [CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.interstitial, allow_modes: [] },
{ key: CMCD_keys.state, allow_modes: all_reporting_modes },
{ key: CMCD_keys.time_to_first_byte, allow_modes: [CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.time_to_first_body_byte, allow_modes: [CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.time_to_last_byte, allow_modes: [CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.timestamp, allow_modes: all_reporting_modes },
{ key: CMCD_keys.lowest_encoded_bitrate, allow_modes: all_reporting_modes },
{ key: CMCD_keys.top_aggregated_encoded_bitrate, allow_modes: all_reporting_modes },
{ key: CMCD_keys.lowest_aggregated_encoded_bitrate, allow_modes: all_reporting_modes },
{ key: CMCD_keys.request_url, allow_modes: [CMCD_MODE_RESPONSE] },
{ key: CMCD_keys.playhead_position, allow_modes: all_reporting_modes },
{ key: CMCD_keys.player_error_code, allow_modes: all_reporting_modes },
{ key: CMCD_keys.media_start_delay, allow_modes: all_reporting_modes },
]);

const isCustomKey = (key) => key.includes("-");
const reportingMode = (mode) => (mode.includes(":") ? mode.substring(mode.lastIndexOf(":") + 1) : "***");

export function checkCMCDkeys(keysAttr, errs, errCode) {
if (!keysAttr) {
errs.addError({ type: APPLICATION, code: `${errCode}-00`, message: "checkCMCDkeys() called with extn=null" });
export function checkCMCDkeys(CMCD, errs, errCode) {
if (!CMCD) {
errs.addError({ type: APPLICATION, code: `${errCode}-00`, message: "checkCMCDkeys() called with CMCD=null" });
return;
}
const keys = keysAttr.value().split(" ");
keys.forEach((key) => {
if (!isIn(CMCDv1_keys, key)) {
if (!isCustomKey(key))
const keys = CMCD.attr(dvbi.a_enabledKeys)?.value().split(" ");
const reporting_mode = CMCD.attr(dvbi.a_reportingMode).value();
if (keys) {
keys.forEach((key) => {
const reserved_key = CMCDv1_keys.find((e) => e.key == key);
if (reserved_key) {
if (!isIn(reserved_key.allow_modes, reporting_mode))
errs.addError({
code: `${errCode}-01`,
message: `${key.quote()} is not allowed for the specified reporting mode (${reportingMode(reporting_mode)})`,
fragment: CMCD,
});
} else if (isCustomKey(key))
errs.addError({
type: WARNING,
code: `${errCode}-02`,
message: `custom CMCD key ${key.quote()} in use`,
fragment: CMCD,
});
else
errs.addError({
code: `${errCode}-01`,
message: `${key.quote()} is not a reserved key or the correct format for a custom key`,
fragment: keysAttr.node(),
code: `${errCode}-03`,
message: `${key.quote()} is not a reserved CMCDv1 key or the correct format for a custom key`,
fragment: CMCD,
});
}
});
});
}
if (reporting_mode == CMCD_MODE_INTERVAL && !isIn(keys, CMCD_keys.timestamp))
errs.addError({
code: `${errCode}-04`,
message: `the key ${CMCD_keys.timestamp.quote()} is required to be specified for ${reportingMode(reporting_mode)} reporting`,
fragment: CMCD,
});
}
10 changes: 10 additions & 0 deletions DVB-I_definitions.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,14 @@ const HbbTVStandardPrefix = "urn:hbbtv:appinformation:standardversion:hbbtv";
const HbbTVFeaturePrefix = "urn:hbbtv:appinformation:optionalfeature:hbbtv";
const CTAStandardPrefix = "urn:cta:wave:appinformation:standardversion";

const CMCDterm = `${DVB_metadata}:cmcd`;
export const CMCD_MODE_REQUEST = `${CMCDterm}:delivery:request`,
CMCD_MODE_RESPONSE = `${CMCDterm}:delivery:response`,
CMCD_MODE_INTERVAL = `${CMCDterm}:delivery:interval`;

export const CMCD_METHOD_HTTP_HEADER = `${CMCDterm}:delivery:customHTTPHeader`,
CMCD_METHOD_QUERY_ARGUMENT = `${CMCDterm}:delivery:queryArguments`;

export const dvbi = {
A177_Namespace: `${DVB_metadata}:servicediscovery:2019`,
A177r1_Namespace: `${DVB_metadata}:servicediscovery:2020`,
Expand Down Expand Up @@ -236,6 +244,8 @@ export const dvbi = {
a_region: "region",
a_regionID: "regionID",
a_regulatorListFlag: "regulatorListFlag",
a_reportingMethod: "reportingMethod",
a_reportingMode: "reportingMode",
a_responseStatus: "responseStatus",
a_rtcp_bandwidth: "rtcp-bandwidth",
a_rtcp_mux: "rtcp-mux",
Expand Down
22 changes: 15 additions & 7 deletions sl_check.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1498,20 +1498,28 @@ export default class ServiceListCheck {
}

// <DASHDeliveryParameters><CMCD> -- !! EXPERIMENTAL
const CMCDinit = DASHDeliveryParameters.get(xPath(props.prefix, dvbi.e_CMCD), props.schema);
if (CMCDinit) {
console.log("have CMCD");
const enabledKeys = CMCDinit.attr(dvbi.a_enabledKeys);
let cc = 0,
CMCDelem;
while ((CMCDelem = DASHDeliveryParameters.get(xPath(props.prefix, dvbi.e_CMCD, ++cc), props.schema)) != null) {
const enabledKeys = CMCDelem.attr(dvbi.a_enabledKeys);
if (enabledKeys) {
const keys = enabledKeys.value().split(" ");
if (isIn(keys, CMCD_keys.content_id) && !CMCDinit.attr(dvbi.a_contentId))
if (!CMCDelem.attr(dvbi.a_contentId) && isIn(keys, CMCD_keys.content_id))
errs.addError({
code: "SI175",
message: `${dvbi.a_contentId.attribute()} must be specified when ${dvbi.a_enabledKeys.attribute()} contains '${CMCD_keys.content_id}'`,
fragment: CMCDinit,
fragment: CMCDelem,
key: "CMCD",
});
checkCMCDkeys(enabledKeys, errs, "SL176");
else if (CMCDelem.attr(dvbi.a_contentId) && !isIn(keys, CMCD_keys.content_id))
errs.addError({
type: WARNING,
code: "SI176",
message: `${dvbi.a_contentId.attribute()} is specified by key '${CMCD_keys.content_id}' not requested for reporting`,
fragment: CMCDelem,
key: "CMCD",
});
checkCMCDkeys(CMCDelem, errs, "SL177");
}
}

Expand Down

0 comments on commit f375117

Please sign in to comment.