ADM-OSC Draft v0.5

All messages can be part of a preset. The preset can be enumerated by adding /preset/n before any of the messages below.

Object messages

dynamic

osc address		type	units	min	max	default	description	example	status
/adm/obj/n	/azim	float	degrees	-180.	180.	-	azimuth “theta - θ” of sound location. -90 is on the Right, 0 is in front.	/adm/obj/4/azim -22.5	stable v0.4
	/elev	float	degrees	-90.	90.	-	elevation “phi - ɸ” of sound location	/adm/obj/4/elev 12.7	stable v0.4
	/dist	float	normalized	0.0	1.0	1.0	distance “r” from origin	/adm/obj/4/dist 0.9	stable v0.4
	/aed	list	see above				compact format enables synchronicity of position changes and also less network traffic	/adm/obj/4/aed -22.5 12.7 0.9	stable v0.4
	/widthDeg	float	degrees	0.0	180.0	0.0	horizontal extent in degrees. See also /w	/adm/obj/3/widthDeg 45.2	in progress
	/x	float	normalized	-1.0	1.0	0.0	left/right dimension. -1 is left	/adm/obj/4/x -0.9	stable v0.4
	/y	float	normalized	-1.0	1.0	0.0	front/back dimension	/adm/obj/4/y 0.15	stable v0.4
	/z	float	normalized	-1.0	1.0	0.0	top/bottom dimension	/adm/obj/4/z 0.7	stable v0.4
	/xyz	list	see above				compact format enables synchronicity of position changes and also less network traffic	/adm/obj/4/xyz -0.9 0.15 0.7	stable v0.4
	/w	float	normalized	0.0	1.0	0.0	horizontal extent in normalized units	/adm/obj/3/w 0.2	in progress
	/gain	float	linear	0.		1.0	Apply a gain to the audio in the object.	/adm/obj/3/gain 0.707	stable v0.4

static

osc address		type	units	default	description	example	status
/adm/config/obj/n	/chan	int		1	ADM:ADM mapped to the wavefile chna data chunk. S-ADM: mapped to the listed elements and attributes.	/adm/obj/4/azim -22.5	proposed v0.5
	/cartesian	int	0/1	0	If the flag is set to 1, Cartesian coordinates are used. Otherwise spherical coordinates are used.	/adm/config/obj/1/cartesian 0	stable v0.4
	/name	symbol		'Content_n'	audioContentName, where ‘n’ is the object index value		proposed v0.5
	/lang	symbol	ISO 639-1?		Used for local language labeling	/adm/config/obj/3/lang FR	proposed v0.5
	/type	symbol		'O'	dialog content kind	/adm/config/obj/3/type AO	proposed v0.5
	/gain	float	dB	0.0	Depending upon the template being used, gain is mapped to either an individual audio channel or a higher-level object (which could reference a number of audio channels)	/adm/config/obj/3/gain -6.0	proposed v0.5
	/absdistance	float	meters		Distance signified by a normalized value of 1	/adm/config/obj/1/absdistance 21.3	proposed v0.5
	/refdistance	float	normalized	1.0	Distance where dimensionless rendering is replaced with with physics-based rendering.	/adm/config/obj/1/refdistance 0.2	proposed v0.5

Object type to ADM dialogue content

type	dialogue	attribute	attribute value	notes
O	2	nonDialogueContentKind	0	Undefined
D	1	dialogueContentKind	1	Dialogue
AD	1	dialogueContentKind	4	Audio description
SS	1	dialogueContentKind	3	SpokenSubtitle
VO	1	dialogueContentKind	2	Voiceover

virtualization

osc address		type	units	min	max	default	description	example	status
/adm/config/obj/n/virt	/bypass	int	true/false	0	1	1	Specifies whether the object should be virtualised using a headphone virtualiser or not (1=render to stereo, 0=render with headphone virtualiser)		proposed v0.5
	/drr	float	decibels	-130.0	130.0	130.0	Direct to Reverberant Ratio in dB.		proposed v0.5
	/hlock	int	true/false	0	1	1.0	Indicates if the perceived location of the audio element is locked to the head (1) or not (0)		proposed v0.5

---

Bed messages (static)

osc address		type	units	min	max	default	description	example	status
/adm/config/bed/n	/chan	int		1		1	Start channel of bed	/adm/config/bed/1/chan 1	proposed v0.5
	/name	symbol				'Bed_n'	Where ‘n’ is the bed index value	/adm/prog/2/bed/1/name "name"	proposed v0.5
	/layout	int				3	Value corresponds to the lower 8 bits of a common definition audioPackFormat.	/adm/prog/2/bed/1/layout	proposed v0.5
	/gain	float	dB			0.0		/adm/config/bed/1/gain -3.2	proposed v0.5

Bed layout values

audioPackFormat	value
2.0	2
3.0	10
5.0	12
5.1	3
5.1.2	19
5.1.4	5
7.1.4	23

---

Template messages (static)

osc address		type	units	description	example	status
/adm/config/template	/name	symbol		The template applies to all metadata compositions in the current preset path	/adm/prog/2/template/name "English AD"	proposed v0.5
	/version	symbol	x.x.x		/adm/prog/2/template/version 3.2.1	proposed v0.5
	/level	int			/adm/prog/2/template/format 23	proposed v0.5

General and Programme /config

osc address			type	units	default	description	example	status
/adm/config/template	/version		symbol	x.x.x		The specification version that the ADM-OSC is compliant with	/adm/config/version 0.5.0	proposed v0.5
	/dprst		int		1	Shorthand mode specifies base preset	/adm/config/dprst 1	proposed v0.5
	/dprog		int		1	Shorthand mode specifies base programme	/adm/config/dprog 1	proposed v0.5
/adm/prog/n/config	/name		symbol		'Programme_n'	Where n is the programme index value	/adm/prog/3/config/name 'Programme_3	proposed v0.5
	/lang		symbol	ISO 639-1?	'und'	audioProgrammeLanguage	/adm/prog/3/config/lang FR	proposed v0.5
	/label/n	/name	symbol		'und'	Used for local language labeling	/adm/prog/3/config/label/2/name	proposed v0.5
		/lang	symbol	ISO 639-1?	'und'	audioProgrammeLabel	/adm/prog/3/config/label/3/lang FR	proposed v0.5