Skip to content

Draft for Audio Support #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
moritzstaffel wants to merge 15 commits into
base: next
Choose a base branch
from
+291 −2
Open

Draft for Audio Support #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
8d43ff4
Speaker Geometry
moritzstaffel Feb 11, 2024
a4ab9d0
Create proposal.md
moritzstaffel Feb 11, 2024
7f6335d
Update proposal.md
moritzstaffel Apr 5, 2024
4bc35bd
Merge branch 'next' into audio-proposal
moritzstaffel Apr 17, 2024
8aa14bc
Add Properties of Speaker
moritzstaffel Apr 18, 2024
6196614
Add listenting plane
moritzstaffel Apr 18, 2024
5e70ae3
Update proposal.md
moritzstaffel Apr 18, 2024
3c2362f
Update proposal.md
moritzstaffel Apr 18, 2024
167cdc2
Update proposal.md
moritzstaffel Apr 18, 2024
3bb7fc4
Update the proposal based on latest feedback/comments
petrvanekrobe May 12, 2026
6d19ab3
Add initial Amplifier specification
petrvanekrobe May 12, 2026
729f0a6
Define ListeningPlane node and its attributes
klinzey May 14, 2026
a22f2d9
Revise speaker and MaxSPL attributes in gdtf-spec
klinzey May 14, 2026
9db2c0f
Define Speaker node with attributes and children
klinzey May 14, 2026
0f0e268
Adjusting attributes and their definitions, adding some todo items
petrvanekrobe May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 41 additions & 2 deletions gdtf-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1214,6 +1214,7 @@ of geometry collect are specified in [table 34](#user-content-table-34 ).
| [Structure](#user-content-geometry-type-structure ) | Any | Geometry that describes the internal framing of an object (like members). |
| [Support](#user-content-geometry-type-support ) | Any | Geometry that describes a support like a base plate or a hoist. |
| [Magnet](#user-content-geometry-type-magnet ) | Any | Geometry that describes a point where other geometries should be attached. |
| [Speaker](#user-content-geometry-type-audio ) | Any | Geometry that describes a audio source. |


</div>
Expand Down Expand Up @@ -1783,11 +1784,49 @@ defined XML attributes of a magnet geometry are specified in
| Model | [Name](#user-content-attrtype-name ) | Link to the corresponding model. |
| Position | [Matrix](#user-content-attrtype-matrix ) | Relative position of geometry; Default value: Identity Matrix |

The magnet geometry has the same children types as the geometry
collect (see [table 34](#user-content-table-34 )).

### Geometry Type Speaker

This type of geometry is used to describe a speaker in a audio device. (XML node `<Speaker>`). The currently
defined XML attributes of a speaker geometry are specified in
[table 55](#user-content-table-XX ).


<div id="table-XX">

#### Table XX. *Speaker Attributes*

| XML Attribute Name | Value Type | Description |
|----|----|----|
| Name | [Name](#user-content-attrtype-name ) | The unique name of the geometry. |
| Model | [Name](#user-content-attrtype-name ) | Link to the corresponding model. |
| Position | [Matrix](#user-content-attrtype-matrix ) | Relative position of geometry; Default value: Identity Matrix |
| LinkedConsumer | [Node](#user-content-attrtype-node ) | Name of the Wire Geometry that this speaker is connected to. Need to an consumer type. |
| Impedance | [Float](#user-content-attrtype-float ) | Nominal impedance of the speaker, Ohms. |
| VerticalCoverageUp | [Float](#user-content-attrtype-float ) | Vertical Coverage of the sound angle ?? (todo: define the axis) direction. (Degrees) Note that this values are defined in the Global Coordinate System of the GDTF. |
| VerticalCoverageDown | [Float](#user-content-attrtype-float ) | Vertical Coverage of the sound angle ?? (todo: define the axis) direction. (Degrees) Note that this values are defined in the Global Coordinate System of the GDTF. |
| HorizontalCoverageLeft | [Float](#user-content-attrtype-float ) | Horizontal Coverage of the sound angle ?? (todo: define the axis) direction. (Degrees) Note that this values are defined in the Global Coordinate System of the GDTF. |
| HorizontalCoverageRight | [Float](#user-content-attrtype-float ) | Horizontal Coverage of the sound angle ?? (todo: define the axis) direction. (Degrees) Note that this values are defined in the Global Coordinate System of the GDTF. |
| SoundAngleRotationMax | | [Float](#user-content-attrtype-float ) |Maximum rotation of the sound dispersion around the speaker axis ?? which axis |
| FrequencyRangeMin | [Float](#user-content-attrtype-float ) | Minimal frequency of the speaker at the -6 dB mark. |
| FrequencyRangeMax | [Float](#user-content-attrtype-float ) | Maximal frequency of the speaker at the -6 dB mark. |
| MaxSPL | [Float](#user-content-attrtype-float ) | Maximum sound pressure level measured at 1 meter from the speaker. The value is interpreted together with the SPL format attributes below. |

#### Table XX. *MaxSPL Attributes*
| XML Attribute Name | Value Type | Description |
|----|----|----|
|ExcitationSignal | [String](#user-content-attrtype-string) | Pink noise, IEC60268, EIA426B, AES75 (enums?)|
|FrequencyWeighting | [String](#user-content-attrtype-string) | None, A-Weighting, C-Weighting (enums?)|
|Unit | [String](#user-content-attrtype-string) | DBZ, dB, DBSPL, dBA, dBC (enums?)|
|UnitMark | [String](#user-content-attrtype-string) | Leq, Laeq, LCeq, F, S |
|TimeWeighting | [String](#user-content-attrtype-string) | Fast, Slow, Leq, Peak, (enums?)|

</div>

The magnet geometry has the same children types as the geometry
collect (see [table 34](#user-content-table-34 )).
TODO: Define default orientation of the speaker. Clarify if the values are for one speaker object ("speaker") or for the whole "speaker box". (Needed for MVR linking to the SoundAngleRotationMax and for the LinkedConsumer )


## DMX Mode Collect

Expand Down
91 changes: 91 additions & 0 deletions mvr-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,7 @@ The child list (Table 18) contains a list of the following nodes:
| [Truss](#node-definition-truss) | A definition of a truss. |
| [VideoScreen](#node-definition-videoscreen) | A definition of a video screen. |
| [Projector](#node-definition-projector) | A definition of a projector. |
| [ListeningPlane](#node-definition-listeningplane) | A definition of a audio listening plane. |


## Node Definition for Parametric Objects
Expand Down Expand Up @@ -800,6 +801,96 @@ EXAMPLE An example of a node definition is shown below:
</Projections>
</Projector>
```
## Node Definition: ListeningPlane

This node defines a listening plane object. The defined ListeningPlane Node Attributes are specified in Table XX.

Node name: `ListeningPlane`

##### Table XX — *ListeningPlane Node Attributes*

| Attribute Name | Attribute Value Type | Default Value when Optional | Description |
| -------------- | --------------------------------------- | --------------------------- | ------------------------------------ |
| uuid | [UUID](#user-content-attrtype-uuid) | Not Optional | The unique identifier of the object. |
| name | [String](#user-content-attrtype-string) | Empty | The name of the object. |


The child list (Table XX) contains a list of one of the following nodes:

##### Table XX — *ListeningPlane Node Childs*

| Child Node | Allowed Count | Value Type | Description |
| ------------------------------------------------- | ------------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| [Matrix](#node-definition-matrix) | 0 or 1 | | The location of the object inside the parent coordinate system. |
| [Classing](#node-definition-class) | 0 or 1 | [UUID](#user-content-attrtype-uuid) | The Class the object belongs to. |
| [Geometries](#node-definition-geometries) | 1 | | A default placeholder geometry representing the listening plane in case there are no listening plane results. Clarify.|
| [GridSpacingX] | 0 or 1 |[Float](#user-content-attrtype-float) | Spacking of the measurement grid in the X direction in mm. |
| [GridSpacingY] | 0 or 1 |[Float](#user-content-attrtype-float) | Spacking of the measurement grid in the Y direction in mm. |
| [ListeningPlaneResults] | Any | Node | Results of a calculation. |

#### Node Definition: ListeningPlaneResults

This node defines a ListeningPlaneResults.

Node name: `ListeningPlaneResults`

The child list (Table XX) contains a list of the following nodes:

##### Table XX — *ListeningPlaneResults Node Childs*

| Child Node | Description |
| ------------------------------------------------- | ------------------------------------------------ |
| [Frequency](#user-content-attrtype-float) | Reports the frequency of the calculated results in Hz. |
| [Geometries](#node-definition-geometries) | A list of geometrical representation objects that are part of the listening plane at the specified frequency. |
| [Classing](#node-definition-class) | The Class this frequency geometry belongs to. |
| AmplitudeValues | A list of measurement points and amplitude values.|

##### Table XX — *AmplitudeValues Node Attributes*

| Attribute Name | Attribute Value Type | Default Value when Optional | Description |
| -------------- | ------------------------------------- | --------------------------- | ---------------------------------- |
| Point | [Vector3](#user-content-attrtype-vector3) | | The cordinate of the measurement. |
| Amplitude | [Float](#user-content-attrtype-float) | | Amplitude of the measurement |
| Units | [String](#user-content-attrtype-string) | | Measurement unit. DBZ, dB, DBSPL, dBA, dBC|
| Color | [CIE Color](#user-content-attrtype-ciecolor) | | Color used represent the amplitude value a the point.|


EXAMPLE An example of a node definition is shown below:
```xml
<ListeningPlane name="Listening Plane 1" uuid="BEF95EB8-98AC-4217-B10D-FB4B83381399">
<Matrix>{0.158127,-0.987419,0.000000}{0.987419,0.158127,0.000000}{0.000000,0.000000,1.000000}{6020.939200,2838.588955,4978.134459}</Matrix>
</ListeningPlane>
```

## Node Definition: Speaker

This node defines a Speaker object. The defined Speaker Node Attributes are specified in Table XX.

Node name: `Speaker`

##### Table XX — *Speaker Node Attributes*

| Attribute Name | Attribute Value Type | Default Value when Optional | Description |
| -------------- | --------------------------------------- | --------------------------- | ------------------------------------ |
| uuid | [UUID](#user-content-attrtype-uuid) | Not Optional | The unique identifier of the object. |
| name | [String](#user-content-attrtype-string) | Empty | The name of the object. |

The child list (Table XX) contains a list of one of the following nodes:

##### Table XX — *Speaker Node Childs*

| Child Node | Allowed Count | Value Type | Description |
| ------------------------------------------------- | ------------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| [Matrix](#node-definition-matrix) | 0 or 1 | | The location of the object inside the parent coordinate system. |
| [Classing](#node-definition-class) | 0 or 1 | [UUID](#user-content-attrtype-uuid) | The Class the object belongs to. |
| GDTFSpec | 0 or 1 | [FileName](#user-content-attrtype-filename) | The name of the file containing the GDTF information for this object, conforming to the DIN SPEC 15800. |
| [Addresses](#node-definition-addresses) | 0 or 1 | | The container for DMX Addresses for this object. |
| [Alignments](#node-definition-alignments) | 0 or 1 | | The container for Alignments for this object. |
| [CustomCommands](#node-definition-customcommands) | 0 or 1 | | The container for custom command for this object. |
| [Overwrites](#node-definition-overwrites) | 0 or 1 | | The container for overwrites for this object. |
| [Connections](#node-definition-connections) | 0 or 1 | | The container for connections for this object. |
| [ChildList](#node-definition-childlist) | 0 or 1 | | A list of graphic objects that are part of the layer. |
| [Rotation] (#node-definition-float) | 0 or 1 | | Rotation of the internal sound source. |


## Other Node Definition
Expand Down
Loading
Loading