add HDR Vivid

Author: paulhiggs

README.md

@@ -14,6 +14,7 @@ supports
 * AVS3 video and audio
 * AVS2 audio
 * LCEVC - refer to ISO/IEC 14496-15:2022 Amd.1
+* HDR Vivid - refer to T/UWA 005-2.1
 
 ## Installation
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "codec-string",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "decode the codecs= string in a media mime type",
   "type": "module",
   "engines": {

package.json

@@ -0,0 +1,68 @@
+/**
+ * @copyright: Copyright (c) 2024
+ * @author: Paul Higgs
+ * @file: decode-uwa.js
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+ * THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+// see clause 9.2 of T/UWA 005-2.1
+
+const DEBUGGING = false;
+
+import { warning, error, normal } from './decode.js';
+import { DVBclassification } from './dvb-mapping.js';
+import { simpleHTML } from './formatters.js';
+import { expressions } from './regular_expressions.js';
+
+export function decodeUWA(val) {
+
+	if (!expressions.CUVV.regex.test(val)) 
+		return [error('Regex mismatch!'), error(`${val.substring(0,4)}.${expressions.CUVV.format_suffix}`), error(expressions.CUVV.description)];
+
+	const parts = val.split('.');
+
+	// the following tests should not fail as the format is checked with the regular expression
+	if (parts.length != 2) return [error('invalid format')];
+
+	const coding_params = { type: 'video', codec: parts[0] }, res = [];
+
+	for (let i=0; i<parts[1].length; i++) {
+		if (parts[1][i] == '1') {
+			res.push(normal(`HDR Vivid version ${parts[1].length-i} is present`));
+		}
+	}
+	if (res.length == 0)
+		res.push(warning('No HDR Vivid versions present'));
+
+	const dvb = DVBclassification(coding_params);
+	if (dvb.length != 0) res.push({ dvb_term: dvb });
+
+	return res;
+}
+
+const outputHTML = (label, messages) => simpleHTML(label, messages, DEBUGGING);
+
+export function registerUWA(addHandler) {
+	addHandler('cuvv', 'HDR Vivid', decodeUWA, outputHTML);
+}

src/decode-uwa.js

@@ -10,6 +10,7 @@ import { registerMisc } from './decode-misc.js';
 import { registerMPEG } from './decode-mpeg.js';
 import { registerMPEGH } from './decode-mpegH.js';
 import { registerText } from './decode-text.js';
+import { registerUWA } from './decode-uwa.js';
 import { registerVC1 } from './decode-vc1.js';
 import { registerVP9 } from './decode-vp9.js';
 import { registerVVC } from './decode-vvc.js';
@@ -51,6 +52,7 @@ const registerFactories = [
 	registerMPEG,
 	registerMPEGH,
 	registerText,
+	registerUWA,
 	registerVC1,
 	registerVP9,
 	registerVVC,

src/handler.js

@@ -9,6 +9,7 @@ const { decodeLCEVC } = require('./decode-lcevc.js');
 const { decodeMPEG2video, decodeMPEG2audio, decodeMPEG1video, decodeMPEG1audio, decodeMPEG4video, decodeMPEG4audio } = require('./decode-mpeg.js');
 const { decodeMPEGH } = require('./decode-mpegH.js');
 const { decodeSTPP } = require('./decode-text.js');
+const { decodeUWA } = require('./decode-uwa.js');
 const { decodeVP9 } = require('./decode-vp9.js');
 const { decodeVVC } = require('./decode-vvc.js');
 const { decode } = require('./decode.js');
@@ -35,6 +36,7 @@ module.exports = {
 	decodeMPEG4audio,
 	decodeMPEGH,
 	decodeSTPP,
+	decodeUWA,
 	decodeVP9,
 	decodeVVC,
 	decode,

src/index.cjs

@@ -9,6 +9,7 @@ export { decodeLCEVC } from './decode-lcevc.js';
 export { decodeMPEG2video, decodeMPEG2audio, decodeMPEG1video, decodeMPEG1audio, decodeMPEG4video, decodeMPEG4audio } from './decode-mpeg.js';
 export { decodeMPEGH } from './decode-mpegH.js';
 export { decodeSTPP } from './decode-text.js';
+export { decodeUWA } from './decode-uwa.js';
 export { decodeVP9 } from './decode-vp9.js';
 export { decodeVVC } from './decode-vvc.js';
 export { decode } from './decode.js';

src/index.js

@@ -67,5 +67,10 @@ export const expressions = {
 		regex: /mhm(1|2)\.0x[a-fA-F\d]{2}/,
 		format: '(mhm1 or mhm2).0xLL',
 		description: 'LL is 2 hexadecimal digits'
+	},
+	CUVV: {
+		regex: /cuvv.[01]+/,
+		format: 'cuvv.<verison_bits>',
+		description: '<version_bits> indicates the versions of HDR Vivid in the bitstream'
 	}
 };