Intercom improvements (IDI-Systems#585)

* Accent implementation. Volume of racks controlled by intercom

* Fixes

* First testing

* Fixes

* Fixes

* Include before Header

* Cpp

* Intercom PTT and Intercom Broadcast PTT keys. Cpp cleanup

* Improved handling of new PTT

* TabsToSpaces

* Minor improvements and formatting

* Add accent documentation

* IntercomSpeaking type

* Fixed IntercomPTT

* Documentation and code formatting

* Remove merge files

* Working Intercom PTT

* Fix accent

* Brackets

* Finished accent feature

* Requested changes

* Tabs!

* Factor wording

* oops

* Fix merge conflicts

* German translation

Co-Authored-By: TheMagnetar <[email protected]>

* German Translation

Co-Authored-By: TheMagnetar <[email protected]>

* Suggested changes + spanish translations

Author: TheMagnetar

addons/api/fnc_getRadioVolume.sqf

@@ -7,7 +7,7 @@
  * 0: Radio ID <STRING>
  *
  * Return Value:
- * Volume value between 0 and 1 <NUMBER>
+ * Volume value between 0 and 1, -1 if error <NUMBER>
  *
  * Example:
  * ["ACRE_PRC148_ID_1"] call acre_api_fnc_getRadioVolume
@@ -17,4 +17,8 @@
 
 params ["_radioId"];
 
+if (isNil "_radioId") exitWith { -1 };
+
+if (!([_radioId] call EFUNC(sys_data,isRadioInitialized))) exitWith { -1 };
+
 [_radioId] call EFUNC(sys_radio,getRadioVolume);

addons/api/fnc_isSpeaking.sqf

@@ -20,7 +20,4 @@ params [
 ];
 
 
-if (_unit in EGVAR(sys_core,speakers)) exitWith {
-    true
-};
-false
+_unit in EGVAR(sys_core,speakers)

addons/sys_core/fnc_processRadioSpeaker.sqf

@@ -72,6 +72,7 @@ if !(_okRadios isEqualTo []) then {
 
 
             private _radioVolume = [_receivingRadioid, "getVolume"] call EFUNC(sys_data,dataEvent);
+            _radioVolume = [_x, _radioVolume] call EFUNC(sys_intercom,modifyRadioVolume);
             _radioVolume = _radioVolume * GVAR(globalVolume);
             // acre_player sideChat format["rv: %1", _radioVolume];
             private _isLoudspeaker = [_receivingRadioid, "isExternalAudio"] call EFUNC(sys_data,dataEvent);

addons/sys_intercom/XEH_PREP.hpp

@@ -14,13 +14,16 @@ PREP(intercomListVolumeActions);
 PREP(intercomPFH);
 PREP(isIntercomAvailable);
 PREP(isInIntercom);
+PREP(modifyRadioVolume);
 PREP(noApiFunction);
 PREP(seatSwitched);
+PREP(handleAccent);
 PREP(handleBroadcasting);
 PREP(handleLimitedConnection);
 PREP(handleIntercomActivation);
 PREP(setStationConfiguration);
 PREP(setStationUnit);
+PREP(updateIntercomUse);
 
 // Infantry Phone
 PREP(checkInfantryPhoneAvailability);

addons/sys_intercom/XEH_postInit.sqf

@@ -10,35 +10,20 @@ if (!isClass (configFile >> "CfgPatches" >> "ace_interact_menu")) exitWith {};
 
 if (!hasInterface) exitWith {};
 
-// CBA Keybindings
-//["ACRE2", "IntercomPTTKey",  [(localize LSTRING(intercomPttKey)), (localize LSTRING(intercomPttKey_description))], { [PTT_ACTION] call FUNC(handlePttKeyPress) }, { [PTT_ACTION] call FUNC(handlePttKeyPressUp) }, [52, [true, false, false]]] call cba_fnc_addKeybind;
-//["ACRE2", "IntercomBroadcastKey",  [(localize LSTRING(intercomBroadcastKey)), (localize LSTRING(intercomBroadcastKey_description))], { [BROADCAST_ACTION] call FUNC(handlePttKeyPress) }, { [BROADCAST_ACTION] call FUNC(handlePttKeyPressUp) }, [52, [false, true, false]]] call cba_fnc_addKeybind;
 [
     "ACRE2",
     "IntercomPTTKey",
     [(localize LSTRING(intercomPttKey)), (localize LSTRING(intercomPttKey_description))],
-    "",
-    {
-        if(!GVAR(intercomPttKey)) then {
-            [PTT_ACTION] call FUNC(handlePttKeyPress);
-        } else {
-            [PTT_ACTION] call FUNC(handlePttKeyPressUp);
-        };
-    }
+    {[ACTION_INTERCOM_PTT] call FUNC(handlePttKeyPress)},
+    {[ACTION_INTERCOM_PTT] call FUNC(handlePttKeyPressUp)}
 ] call cba_fnc_addKeybind;
 
 [
     "ACRE2",
     "IntercomBroadcastKey",
     [(localize LSTRING(intercomBroadcastKey)), (localize LSTRING(intercomBroadcastKey_description))],
-    "",
-    {
-        if(!GVAR(broadcastKey)) then {
-            [BROADCAST_ACTION] call FUNC(handlePttKeyPress);
-        } else {
-            [BROADCAST_ACTION] call FUNC(handlePttKeyPressUp);
-        };
-    }
+    {[ACTION_BROADCAST] call FUNC(handlePttKeyPress)},
+    {[ACTION_BROADCAST] call FUNC(handlePttKeyPressUp)}
 ] call cba_fnc_addKeybind;
 
 ["ACRE2", "PreviousIntercom", (localize LSTRING(previousIntercom)), "", { [-1, true] call FUNC(switchIntercomFast) }, [51, [true, false, false]]] call cba_fnc_addKeybind;

addons/sys_intercom/XEH_preInit.sqf

@@ -15,6 +15,7 @@ if (hasInterface) then {
     // Todo: Change to key down/up
     GVAR(broadcastKey) = false;
     GVAR(intercomPttKey) = false;
+    GVAR(intercomUse) = [];
 };
 
 ADDON = true;

addons/sys_intercom/fnc_configIntercom.sqf

@@ -26,6 +26,7 @@ private _intercomMasterStation = [];
 private _numLimitedPositions = [];
 private _intercomConnectByDefault = [];
 private _broadcasting = [];
+private _accent = [];
 
 {
     private _name = toLower (configName _x);
@@ -110,10 +111,12 @@ private _broadcasting = [];
     _intercomConnectByDefault pushBack _connectedByDefault;
     _intercomMasterStation pushBack _masterStationPositions;
     _broadcasting pushBack [false, objNull];
+    _accent pushBack false;
 } forEach _intercoms;
 
 [_vehicle, _intercomPositions, _intercomExceptions, _intercomLimitedPositions, _intercomConnectByDefault, _intercomMasterStation] call FUNC(configIntercomStations);
 
 _vehicle setVariable [QGVAR(intercomNames), _intercomNames];
 _vehicle setVariable [QGVAR(numLimitedPositions), _numLimitedPositions];
 _vehicle setVariable [QGVAR(broadcasting), _broadcasting];
+_vehicle setVariable [QGVAR(accent), _accent];

addons/sys_intercom/fnc_enterVehicle.sqf

@@ -43,7 +43,6 @@ if (_unit != _vehicle) then {
 
     // Reset variables
     _unit setVariable [QGVAR(intercomVehicle), objNull];
-    _unit setVariable [QGVAR(intercomPTT), false, true];
     _unit setVariable [QGVAR(role), ""];
     ACRE_PLAYER_INTERCOM = [];
 };

addons/sys_intercom/fnc_handleAccent.sqf

@@ -0,0 +1,35 @@
+#include "script_component.hpp"
+/*
+ * Author: ACRE2Team
+ * Handles setting up accent in the master station.
+ *
+ * Arguments:
+ * 0: Vehicle with intercom <OBJECT>
+ * 2: Intercom network <NUMBER>
+ * 3: Accent active <BOOL>
+ *
+ * Return Value:
+ * None
+ *
+ * Example:
+ * [(vehicle acre_player), "intercom1", true] call acre_sys_intercom_fnc_handleAccent
+ *
+ * Public: No
+ */
+
+params ["_vehicle", "_intercomNetwork", "_accentActive"];
+
+private _accentConfig = _vehicle getVariable [QGVAR(accent), []];
+private _changes = false;
+
+{
+    if (_intercomNetwork == _forEachIndex || {_intercomNetwork == ALL_INTERCOMS}) then {
+        _accentConfig set [_forEachIndex, _accentActive];
+        _changes = true;
+    };
+} forEach (_vehicle getVariable [QGVAR(intercomNames), []]);
+
+// Only broadcast if changes have been made
+if (_changes) then {
+    _vehicle setVariable [QGVAR(accent), _accentConfig, true];
+};

addons/sys_intercom/fnc_handleBroadcasting.sqf

@@ -21,6 +21,8 @@
 params ["_vehicle", "_unit", "_intercomNetwork", "_isBroadcasting"];
 
 private _broadcastConfig = _vehicle getVariable [QGVAR(broadcasting), []];
+GVAR(broadcastKey) = _isBroadcasting;
+
 private _changes = false;
 {
     private _canBroadcast = [_vehicle, _unit, _forEachIndex, INTERCOM_STATIONSTATUS_MASTERSTATION] call FUNC(getStationConfiguration);
@@ -34,8 +36,16 @@ private _changes = false;
     };
 } forEach (_vehicle getVariable [QGVAR(intercomNames), []]);
 
-// Only broadcast if changes have been made
+// Only broadcast if changes have been made.
+// TODO: Remove synchronisation once intercom system has been converted to components and unique IDs.
+//       It will help in reduce the bandwith, since information will be exchanged through the TS plugin.
 if (_changes) then {
     [_vehicle, _unit] call FUNC(updateVehicleInfoText);
     _vehicle setVariable [QGVAR(broadcasting), _broadcastConfig, true];
+
+    if (_isBroadcasting) then {
+        ["startIntercomSpeaking", ""] call EFUNC(sys_rpc,callRemoteProcedure);
+    } else {
+        ["stopIntercomSpeaking", ""] call EFUNC(sys_rpc,callRemoteProcedure);
+    };
 };

addons/sys_intercom/fnc_handleIntercomActivation.sqf

@@ -18,4 +18,13 @@
 
 params ["_unit", "_voiceActivation"];
 
+// TODO: Remove synchronisation once intercom system has been converted to components and unique IDs.
+//       It will help in reduce the bandwith, since information will be exchanged through the TS plugin.
 _unit setVariable [QGVAR(intercomPTT), _voiceActivation, true];
+GVAR(intercomPttKey) = _voiceActivation;
+
+if (_voiceActivation) then {
+    ["startIntercomSpeaking", ""] call EFUNC(sys_rpc,callRemoteProcedure);
+} else {
+    ["stopIntercomSpeaking", ""] call EFUNC(sys_rpc,callRemoteProcedure);
+};

addons/sys_intercom/fnc_handlePttKeyPress.sqf

@@ -24,8 +24,8 @@ private _vehicle = vehicle acre_player;
 if (_vehicle ==  acre_player) exitWith { true };
 
 switch (_action) do {
-    case 0 : { GVAR(intercomPttKey) = true; [acre_player, true] call FUNC(handleIntercomActivation); };
-    case 1 : { GVAR(broadcastKey) = true; [_vehicle, acre_player, ALL_INTERCOMS, true] call FUNC(handleBroadcasting); };
+    case ACTION_INTERCOM_PTT: {[acre_player, true] call FUNC(handleIntercomActivation); };
+    case ACTION_BROADCAST: {[_vehicle, acre_player, ALL_INTERCOMS, true] call FUNC(handleBroadcasting); };
 };
 
 [_vehicle, acre_player] call FUNC(updateVehicleInfoText);

addons/sys_intercom/fnc_handlePttKeyPressUp.sqf

@@ -24,8 +24,8 @@ private _vehicle = vehicle acre_player;
 if (_vehicle ==  acre_player) exitWith { true };
 
 switch (_action) do {
-    case 0 : { GVAR(intercomPttKey) = false; [acre_player, false] call FUNC(handleIntercomActivation); };
-    case 1 : { GVAR(broadcastKey) = false; [_vehicle, acre_player, ALL_INTERCOMS, false] call FUNC(handleBroadcasting); };
+    case ACTION_INTERCOM_PTT: {[acre_player, false] call FUNC(handleIntercomActivation);};
+    case ACTION_BROADCAST: {[_vehicle, acre_player, ALL_INTERCOMS, false] call FUNC(handleBroadcasting);};
 };
 
 [_vehicle, acre_player] call FUNC(updateVehicleInfoText);

addons/sys_intercom/fnc_handlePttKeyPressUpPFH.sqf

@@ -0,0 +1,36 @@
+#include "script_component.hpp"
+/*
+ * Author: ACRE2Team
+ * Handles multi push-to-talk keybind press (to be ran within PFH).
+ *
+ * Arguments:
+ * 0: Arguments array <ARRAY>
+ *  0: Broadcasting radio unique ID <STRING>
+ *  1: Multi-PTT-Key pressed <BOOL>
+ * 1: PerFrameHandler ID <NUMBER> (unused)
+ *
+ * Return Value:
+ * Handled <BOOL>
+ *
+ * Example:
+ * [] call acre_sys_core_fnc_handleMultiPttKeyPressUpPFH
+ *
+ * Public: No
+ */
+
+params ["_args", ""];
+_args params ["_broadcastRadio", "_keyPressed"];
+
+if (_keyPressed) then {
+    [GVAR(delayReleasePTT_Handle)] call CBA_fnc_removePerFrameHandler;
+    GVAR(delayReleasePTT_Handle) = nil;
+
+    if (GVAR(pttKeyDown)) then {
+        [_broadcastRadio, "handlePTTUp"] call EFUNC(sys_data,transEvent);
+        ["stopIntercomSpeaking", ""] call EFUNC(sys_rpc,callRemoteProcedure);
+        GVAR(pttKeyDown) = false;
+    };
+} else {
+    _args set [1, true];
+    _this set [0, _args];
+};

addons/sys_intercom/fnc_intercomListChildrenActions.sqf

@@ -94,6 +94,14 @@ if ([_target, acre_player, _intercomNetwork, INTERCOM_STATIONSTATUS_HASINTERCOMA
                 _action = [QGVAR(acre_startBroadcast), localize LSTRING(startBroadcast), "", {[_target, _player, _this select 2, true] call FUNC(handleBroadcasting)}, {true}, {}, _intercomNetwork] call ace_interact_menu_fnc_createAction;
             };
             _actions pushBack [_action, [], _target];
+
+            private _accentActive = (_target getVariable [QGVAR(accent), [false]]) select _intercomNetwork;
+            if (_accentActive) then {
+                _action = [QGVAR(deactivateAccent), localize LSTRING(deactivateAccent), "", {[_target, _this select 2, false] call FUNC(handleAccent)}, {true}, {}, _intercomNetwork] call ace_interact_menu_fnc_createAction;
+            } else {
+                _action = [QGVAR(activateAccent), localize LSTRING(activateAccent), "", {[_target, _this select 2, true] call FUNC(handleAccent)}, {true}, {}, _intercomNetwork] call ace_interact_menu_fnc_createAction;
+            };
+            _actions pushBack [_action, [], _target];
         };
 
         _action = [

addons/sys_intercom/fnc_intercomPFH.sqf

@@ -89,3 +89,5 @@ for "_i" from 0 to ((count _intercoms) - 1) do {
 
     ACRE_PLAYER_INTERCOM set [_i, _intercomUnits];
 };
+
+[_vehicle, ACRE_PLAYER_INTERCOM, _intercoms] call FUNC(updateIntercomUse);

addons/sys_intercom/fnc_modifyRadioVolume.sqf

@@ -0,0 +1,62 @@
+#include "script_component.hpp"
+/*
+ * Author: ACRE2Team
+ * Gets the local radio volume affected by intercom.
+ *
+ * Arguments:
+ * 0: Radio ID <STRING>
+ * 1: Volume <NUMBER>
+ * 2: Vehicle <OBJECT> (default: objNull)
+ * 3: Rack ID <STRING> (default: "")
+ *
+ * Return Value:
+ * Radio volume affected by intercom <NUMBER>
+ *
+ * Example:
+ * ["acre_prc152_id_1", 0.8] call acre_sys_intercom_fnc_modifyRadioVolume
+ *
+ * Public: No
+ */
+
+params ["_radioId", "_volume", ["_vehicle", objNull], ["_rackId", ""]];
+
+if (!(_radioId in ACRE_ACCESSIBLE_RACK_RADIOS) && {!(_radioId in ACRE_HEARABLE_RACK_RADIOS)}) exitWith {_volume};
+
+if (_rackId isEqualTo "") then {
+    _rackId = [_radioId] call EFUNC(sys_rack,getRackFromRadio);
+};
+
+if (_rackId == "") exitWith {_volume};
+
+if (isNull _vehicle) then {
+    _vehicle = [_rackId] call EFUNC(sys_rack,getVehicleFromRack);
+};
+
+private _accentConfig = _vehicle getVariable [QGVAR(accent), [false]];
+private _connectedIntercoms = [_rackId] call EFUNC(sys_rack,getWiredIntercoms);
+if (_connectedIntercoms isEqualTo []) exitWith {_volume};
+
+private _modifiedVolume = 0;
+{
+    _x params ["_intercomName", "_intercomInUse"];
+    private _connected = ([_vehicle, acre_player, _forEachIndex, INTERCOM_STATIONSTATUS_CONNECTION] call FUNC(getStationConfiguration)) > 0;
+    if ((_intercomName in _connectedIntercoms) && {_connected}) then {
+        private _intercomVolume = [_vehicle, acre_player, _forEachIndex, INTERCOM_STATIONSTATUS_VOLUME] call FUNC(getStationConfiguration);
+        private _tempVolume = _intercomVolume;
+        if (_intercomInUse && {_accentConfig select _forEachIndex}) then {
+            _tempVolume = _intercomVolume * INTERCOM_ACCENT_VOLUME_FACTOR; // Reduce volume by 20% if intercom is active and there is an incomming radio transmission
+            if (_tempVolume < MINIMUM_INTERCOM_ACCENT_VOLUME) then {
+                _tempVolume = MINIMUM_INTERCOM_ACCENT_VOLUME;
+            };
+        };
+
+        // Always return the highest intercome outcome
+        if (_tempVolume > _modifiedVolume) then {
+            _modifiedVolume = _tempVolume;
+        };
+    };
+} forEach GVAR(intercomUse);
+
+if (_modifiedVolume > 0) exitWith {_modifiedVolume};
+
+_volume

addons/sys_intercom/fnc_seatSwitched.sqf

@@ -21,6 +21,16 @@ params ["_vehicle", "_unit"];
 private _intercomNames = _vehicle getVariable [QGVAR(intercomNames), []];
 private _oldSeat = _unit getVariable [QGVAR(role), ""];
 
+// If unit is transmitting through intercom, stop the transmittion during the seat switch
+if (GVAR(intercomPTT)) then {
+    [ACTION_INTERCOM_PTT] call FUNC(handlePttKeyPressUp);
+};
+
+// Same for broadcast messages
+if (GVAR(broadcastKey)) then {
+    [ACTION_BROADCAST] call FUNC(handlePttKeyPressUp);
+};
+
 {
     if (_oldSeat != "") then {
         private _connectionStatus = [_vehicle, _unit, _forEachIndex, INTERCOM_STATIONSTATUS_CONNECTION, _oldSeat] call FUNC(getStationConfiguration);

addons/sys_intercom/fnc_updateIntercomUse.sqf

@@ -0,0 +1,28 @@
+#include "script_component.hpp"
+/*
+ * Author: ACRE2Team
+ * Checks if intercoms are in use. Used by intercom accent.
+ *
+ * Arguments:
+ * 0: Vehicle <OBJECT>
+ * 1: Units connected to intercom <ARRAY>
+ * 2: Intercom identifiers <ARRAY>
+ *
+ * Return Value:
+ * None
+ *
+ * Example:
+ * [cursorTarget] call acre_sys_intercom_fnc_updateIntercomUse
+ *
+ * Public: No
+ */
+
+params ["_vehicle", "_intercoms", "_intercomNames"];
+
+private _intercomNames = _vehicle getVariable [QGVAR(intercomNames), []];
+
+{
+    private _name = (_intercomNames select _forEachIndex) select 0;
+    private _inUse = (_x findIf {_x in EGVAR(sys_core,speakers)}) != -1;
+    GVAR(intercomUse) set [_forEachIndex, [_name, _inUse]];
+} forEach _intercoms;