Merge pull request #3 from pyfar/develop

Release 2.1.2

Author: f-brinkmann

HISTORY.rst

@@ -1,12 +1,17 @@
 History
 =======
 
-V2.1.1 (2023-7-7)
------------------
+V2.1.2 (2023-7-7, AES69-2022, SOFA conventions 2.1)
+---------------------------------------------------
+* Add newly proposed AnnotatedEmitterAudio and AnnotatedReceiverAudio conventions
+* Add corresponding verification rules, verification data, and upgrade rules
+
+V2.1.1 (2023-7-7, AES69-2022, SOFA conventions 2.1)
+---------------------------------------------------
 * Following AES69-2022
 * Deprecated FreeFieldDirectivityTF_1.0
 * Added upgrade rules for FreeFieldDirectivityTF_1.0
 
-V2.1.0 (2022-12-16)
--------------------
+V2.1.0 (2022-12-16, AES69-2022, SOFA conventions 2.1)
+-----------------------------------------------------
 * First official release following AES69-2022

README.md

@@ -174,7 +174,7 @@ EXAMPLE: 'GLOBAL_DataType' (`key`) has "specific" dependencies and
 
 ##### General Dependencies
 
-General dependencies are simple. The contain an list that contains an arbitrary
+General dependencies are simple. They contain a list that contains an arbitrary
 number of variables and attributes (`sub_keys`), which must be contained in a
 SOFA object IF `key` is contained.
 EXAMPLE: 'ListenerView_Type' must be contained if 'ListenerView' is contained.

conventions/AnnotatedEmitterAudio_0.2.csv

@@ -0,0 +1,46 @@
+Name	Default	Flags	Dimensions	Type	Comment
+GLOBAL:Conventions	SOFA	rm		attribute
+GLOBAL:Version	2.1	rm		attribute
+GLOBAL:SOFAConventions	AnnotatedEmitterAudio	rm		attribute
+GLOBAL:SOFAConventionsVersion	0.2	rm		attribute
+GLOBAL:APIName		rm		attribute
+GLOBAL:APIVersion		rm		attribute
+GLOBAL:ApplicationName				attribute
+GLOBAL:ApplicationVersion				attribute
+GLOBAL:AuthorContact		m		attribute
+GLOBAL:Comment				attribute
+GLOBAL:DataType	Audio	rm		attribute
+GLOBAL:History				attribute
+GLOBAL:License	No license provided, ask the author for permission	m		attribute
+GLOBAL:Organization		m		attribute
+GLOBAL:References				attribute
+GLOBAL:RoomType	free field	m		attribute
+GLOBAL:Origin				attribute
+GLOBAL:DateCreated		m		attribute
+GLOBAL:DateModified		m		attribute
+GLOBAL:Title		m		attribute
+ListenerPosition	[0 0 0]	m	IC, MC	double	Position of the head. IC if not tracked, MC if tracked.
+ListenerPosition:Type	cartesian	m		attribute
+ListenerPosition:Units	metre	m		attribute
+ReceiverPosition	[0 0.09 0; 0 -0.09 0]	m	rC, rCM	double	Position of the ears. RC if not tracked, RCM if tracked.
+ReceiverPosition:Type	cartesian	m		attribute
+ReceiverPosition:Units	metre	m		attribute
+SourcePosition	[0 0 0]	m	IC, MC	double	Position of the virtual ensemble. IC if not tracked, MC if tracked.
+SourcePosition:Type	cartesian	m		attribute
+SourcePosition:Units	metre	m		attribute
+EmitterPosition	[0 0 0]	m	eC, eCM	double	Position of the virtual source(s). eC if not tracked, eCM if tracked.
+EmitterPosition:Type	cartesian	m		attribute
+EmitterPosition:Units	metre	m		attribute
+ListenerUp	[0 0 1]	m	IC, MC	double	Must be of the same dimensionality as ListenerView.
+ListenerView	[1 0 0]	m	IC, MC	double	Orientation of the head. IC if not tracked, MC if tracked.
+ListenerView:Type	cartesian	m		attribute
+ListenerView:Units	metre	m		attribute
+Data.Emitter	[0 0]	m	In, En	double	audio data at the emitter(s); n=number of audio samples
+Data.SamplingRate	44100	m	I	double
+Data.SamplingRate:Units	hertz	m		attribute
+M	0	m	m	double	Time stamp of the measurements in M, defines the size of M.
+M:LongName	time	m		attribute	Narrative name for M
+M:Units	second	m		attribute	Units used for M
+Response	{''}		I, C, S	string	the subject’s response
+Response:Type				attribute	type depends on the dimension
+Response:LongName				attribute	narrative description of the response type