Skip to content

Commit f1e45bd

Browse files
authored
DOC: mention ASDF v0.4 (#365)
1 parent 5cfeddc commit f1e45bd

File tree

2 files changed

+33
-11
lines changed

2 files changed

+33
-11
lines changed

doc/manual/building-from-source.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,14 @@ If you want to generate the ``man`` pages
7575
Dependencies
7676
------------
7777

78+
To enable support for the newest `ASDF version 0.4`__,
79+
the `C-bindings of the asdf-rust library`__ have to be installed
80+
before compiling the SSR.
81+
82+
__ https://AudioSceneDescriptionFormat.readthedocs.io/
83+
__ https://github.com/AudioSceneDescriptionFormat/asdf-rust#building-the-c-api
84+
85+
7886
Linux
7987
^^^^^
8088

doc/manual/general.rst

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Audio Scenes
144144
Format
145145
~~~~~~
146146

147-
The SSR can open ``.asd`` files (refer to the section :ref:`asdf`) as well as
147+
The SSR can open ``.asd`` files -- refer to the section :ref:`asdf` -- as well as
148148
normal audio files. If an audio file is opened, SSR creates an
149149
individual virtual sound source for each channel which the audio file
150150
contains. If a two-channel audio file is opened, the resulting virtual
@@ -169,7 +169,7 @@ Coordinate System
169169

170170
The coordinate system used in the SSR.
171171
In ASDF :math:`\alpha` and :math:`\alpha'` are referred to as azimuth
172-
(refer to the section :ref:`asdf`).
172+
-- refer to the section :ref:`asdf`.
173173

174174
Fig. :ref:`1.1 (a) <coordinate_system>` depicts the
175175
global coordinate system used in the SSR. Virtual sound sources as well
@@ -213,13 +213,27 @@ Sec. :ref:`Head-Tracking <head_tracking>`.
213213
Audio Scene Description Format (ASDF)
214214
-------------------------------------
215215

216-
Besides pure audio files, SSR can also read the current development
217-
version of the *Audio Scene Description Format (ASDF)* [Geier2008b]_. Note,
218-
however,
219-
that so far we have only implemented descriptions of static features.
220-
That means in the current state it is not possible to describe
221-
e.g. movements of a virtual sound source.
222-
See https://github.com/SoundScapeRenderer/ssr/pull/155 for latest developments.
216+
Besides pure audio files, SSR can also read the
217+
*Audio Scene Description Format (ASDF)*
218+
Currently, two versions of the ASDF are supported.
219+
220+
There is a legacy version of the ASDF [Geier2008b]_,
221+
which has been supported since the beginning,
222+
but which can only describe static scenes.
223+
Recently, support for a new version 0.4
224+
of the format was added,
225+
which allows creating scenes with moving sound sources.
226+
Detailed documentation is available at
227+
https://AudioSceneDescriptionFormat.readthedocs.io/.
228+
229+
The XML syntax between the two versions is not compatible.
230+
The new version is only used when version ``0.4`` is specified like this:
231+
232+
.. code-block:: xml
233+
234+
<asdf version="0.4">
235+
236+
The rest of this section describes the legacy version of the ASDF.
223237

224238
As you can see in the example
225239
audio scene below, an audio file can be assigned to each virtual sound
@@ -234,8 +248,8 @@ compared to reading all channels from individual files**.
234248
Format zur Beschreibung von virtuellen 3D-Audioszenen. In 34rd German
235249
Annual Conference on Acoustics (DAGA), Dresden, Germany, March 2008.
236250
237-
Syntax
238-
~~~~~~
251+
Legacy Syntax
252+
~~~~~~~~~~~~~
239253

240254
The format syntax is quite self-explanatory. See the examples below.
241255
Note that the paths to the audio files can be either absolute (not

0 commit comments

Comments
 (0)