CommFile.xml is the top file in the ladder. It contains complete radio calls such as the AWACS declare call reply, the ATC approach guidance or the wingman reply call.
It is structured as follows:
First the comm id which is the root tree containing CommElement children. Each child will have either an EvalID or the FragID number.
The CommElement forms a response flow, each element contains words that are spoken in sequence.
EvalID is usually a pointer to a list of words that is evaluated by the code. For example evalID=“77” is a list of aircraft names and is evaluated by the code to point to the right aircraft, based on its CT number (more on this later). FragID is a variable pointing to a phrase that is spoken by several voices, each pointing to a wav file. FragID is described in FragFile.xml and points to a collection of tlkId entries. Each tlkID is the name of a wav file, that has the same phrase but spoken by a different voice. There are 12 distinct voices for pilots/AWACS and 2 voices for the ATC folk.
Let’s look at the following example from the CommFile.xml.
<Comm id="352" warp="0" priority="0" positionElement="-1" bullseye="0">
<CommElement index="0" evalId="15" />
<CommElement index="1" evalId="71" />
<CommElement index="2" evalId="86" />
<CommElement index="3" evalId="73" />
<CommElement index="4" evalId="116" />
<CommElement index="5" fragId="2698" />
<CommElement index="6" evalId="77" />
Comm id=“352” is an internal comm id. We don’t know what it is yet.
CommElement index=0 points to evalID"15". In the EvalFile.xml we look for the Eval id=“15”.
We found a long entry with many elements.
<Eval id="15">
<Element evalElem="0" fragId="519" />
<Element evalElem="1" fragId="522" />
<Element evalElem="2" fragId="532" />
<Element evalElem="3" fragId="1902" />
...
Let’s look the first few elements. FragID=“519” can be found in the FragFile.xml.
It looks like this.
<Frag id="519">
<Speaker voice="0" tlkId="6626" />
<Speaker voice="1" tlkId="6627" />
...
If we look for tlkId=“6626” in the unpacked tlk file, we find the 6626.wav file that says “falcon”. The other Speaker voice children point to consequent wav files that have the phrase “falcon” spoken by different BMS pilot voices.
Now let’s have a look the next child in the <Eval id=“15”>, which is fragId=“522”. It points us to 6668.wav which says “gamble”. OK, so we know now that the first child of the Comm id=“352” is a list of call signs.
Now let’s decipher the second child in the comm id, which is evalId=“71”.
In the EvalFile.xml we find
<Eval id="71">
<Element evalElem="1" fragId="1682" />
<Element evalElem="2" fragId="1683" />
<Element evalElem="3" fragId="1684" />
And in the FragFile.xml we find the first child as
<Frag id="1682">
<Speaker voice="0" tlkId="21548" />
<Speaker voice="1" tlkId="21549" />
<Speaker voice="2" tlkId="21550" />
tlkId=“21548” says “one one”. If we follow fragId=“1683” we get tlkId=“21562” that says “one two”. You can guess what fragId=“1684” will be, “one three”.
When we repeat all this for our comm id we get the following sequence
<Comm id="352" warp="0" priority="0" positionElement="-1" bullseye="0">
<CommElement index="0" evalId="15" /> # call sign
<CommElement index="1" evalId="71" /> # in-flight number
<CommElement index="2" evalId="86" /> # call sign
<CommElement index="3" evalId="73" /> # in-flight number
<CommElement index="4" evalId="116" /> # phrases "contact confirmed hostile", "contact ID'ed as bandit", ...
<CommElement index="5" fragId="2698" /> # phrase "ID'ed as"
<CommElement index="6" evalId="77" /> # aircraft type
Now we can figure out that this is an AWACS answer to a declare call.
What is interesting here is the child:
<CommElement index="6" evalId="77"
Because it points to a list of aircraft names. But how does BMS know which aircraft type to call? This question is important if you added a new aircraft to the theatre and want AWACS to ID it as one of the existing types. If it is a type that doesn’t exist in the BMS tlkID database, then you will have to additionally record a corresponding wav file and add it to the Falcon.tlk database.
We assume here that the aircraft type call does exist in the tlk database and we will take an example of a MiG-21 MF. Imagine you added a Polish Air force MiG-21 MF, gave it Polish skins and created a new CT number in the database which is CT=4414.
First let’s reverse engineer the existing MiG-21 MF call.
We can find which fragID contains the MiG-21 MF if we look into the F4Talk.csv file. This file contains strings which simply read what is spoken in the wav files. Those strings are displayed on the screen if you enable “Display Radio Subtitles” in the BMS Setup. The search for “MiG-21” points us to a line which starts with index 253. This is the fragID for a MiG-21 MF call. Mind you that there is a plural version of the call “MiG-21s” with a fragID of 1345.
FragFile.xml entry look like this
<Frag id="253">
<Speaker voice="0" tlkId="3172" />
<Speaker voice="1" tlkId="3173" />
...
If we now go to EvalFile.xml and look for the evalId=“77” entry that we know contains the aircraft types, we can find the MiG-21 MF fragID=253 in it.
<Eval id="77">
...
<Element evalElem="548" fragId="253" />
...
We see that MiG-21 MF has an internal BMS evalElem=“548”. Now here’s the trick. 548 is the MiG-21 MF CT number from the database multiplied by 2 (274*2=548). I can also tell you that the plural call “MiG-21s” will have an evalElem=“549”, which is one more than the singular call. This holds for any other aircraft. Take the CT number and multiply by two to get the id for a singular call and increment by one to get the id for a plural call.
Alright, let’s add our Polish MiG-21 MF with a CT=4414. The new entry in the EvalFile.xml will look like this.
<Eval id="77">
...
<Element evalElem="8828" fragId="253" />
<Element evalElem="8829" fragId="1345" />
The first line is for a singular call and the second for a plural call.
Let’s add another aircraft type to the declare call. This time we created a Polish Mi-24 with a CT=4447.
We look in the F4Talk.csv for a Mi-24 and Mi-24s entry and find the following lines
248,14,Mi-24,Mi-24
...
1340,12,Mi-24s,Mi-24s,Mi-24s,
So the singular call fragID is 248 and plural call fragID is 1340. The evalElem will be CT2=44472=8894. We know that 8895 will be the plural evalElem.
The new entry for a Polish Mi-24 will be
<Eval id="77">
...
<Element evalElem="8894" fragId="248" />
<Element evalElem="8895" fragId="1340" />