Difference between revisions of "Audio Program (ICX-AlphaCom)"

Latest revision as of 21:57, 30 October 2024

The ICX-AlphaCom system supports distribution of Audio Programs. This feature is typically used for distribution of background music. Up to 70 Audio Program channels are supported.

Audio source can be:

An analog audio source, typically a radio, CD-player, alarm device connected to the TKIE-2 kit. The TKIE-2 kit is used as an interface between the analog audio source and the ICX-AlphaCom server. (See image to the right).
An audio stream from a PC (e.g. a local audio file or stream from an internet radio) directly to the ICX-AlphaCom server. One can use the application ffmpeg on the PC to generate the stream.

For Audio Program distribution in the previous generation servers AlphaCom XE, see here.

Using analog source and TKIE kit

When using the TKIE-2 kit, the analog audio signal is connected to the Auxiliary connector pin 8 and 9 of the TKIE kit. One TKIE kit is required for each Audio Program channel.

Audio Program distribution, using the TKIE kit as analog interface

First configure the TKIE kit to register to the ICX-AlphaCom.

In AlphaPro Users & Stations, select the TKIE and set the Class of Service = SuperUser, and disable Noise Reduction:

For the TKIE set the Class of Service = SuperUser, and disable Noise Reduction

In AlphaPro Users & Stations, select the TKIE and select the button "Events". Insert an event 13, when change to OFF with action: $DD L%1.dir L6801. This event is triggered when the TKIE comes up after a reset of TKIE or a reset of the server.

Event Handler: TKIE-2 dials 6801 after startup

In AlphaPro Directory & Features, scroll to the bottom of the directory list and check if directory number 6801 with feature number 118 already exists.

If not, press Insert and create a new directory number with feature 118 - Program Source. Set ID = 1 (this specifies the program channel 1).

The example below shows how to add directory number 6801 with feature number 118.

A device dialing 6801 will become the source for Audio Program 1 (ID = Program channel)

If multiple Audio Program channels are to be added, one must add 6802 - feature 118 and ID = 2, 6803 - feature 118 and ID = 3, etc.

Log in to the web interface of the TKIE. Verify that audio from line in is enabled, and that AGC is disabled:

Line In enabled and AGC off

Finally, one have to reboot either the TKIE kit or the ICX-AlphaCom for all settings to take effect.

Now you should be able to listen to Audio Program channel 1 by dialing 801 on an intercom station.

For remote setup and other Audio Program related functions, see Audio Program features.

Audio Program distribution, streaming from a PC using ffmpeg

Streaming audio from a PC

Configure the IP Dummy Station

The PC is streaming audio to an IP Dummy station using the ffmpeg program. The IP Dummy Station is configured as the "Source" for an Audio Program channel. One IP Dummy Station is required for each Audio Program channel.

The IP Dummy Station requires an IP Station License

In AlphaPro Users & Stations, "General" tab, select a free user and configure as described below (Directory Number and Display Text are just examples):

Set the Class of Service = SuperUser

In AlphaPro Users & Stations, "Station Type" tab, enable the "IP Dummy Station" flag:

Set the "IP Dummy Station" flag

In AlphaPro Users & Stations select the IP Dummy and select the button "Events". Insert an event 13, when change to OFF. This event is triggered when the ICX-AlphaCom starts up.

Event Handler: IP Dummy dials 6801 after startup

Action:

$VAC L%1.dir U8 '10.9.8.189' W4002 W4004
$DD L%1.dir L6801

The first line will define UDP port 4004 as the receiving port for the Audio Stream. (Port 4002 is defined as the sending port, but is not used in this case):

U8 = Use G.722 codec
10.9.8.189 = The IP Address of the PC
4004 = UDP port for receiving audio

The second line tells the IP Dummy to dial 6801, and by that become the source for Audio Program 1.

In AlphaPro Directory & Features, scroll to the bottom of the directory list and check if directory number 6801 with feature number 118 already exists.

If not, press Insert and create a new directory number with feature 118 - Program Source. Set ID = 1 (this specifies the program channel 1).

The example below shows how to add directory number 6801 with feature number 118.

A device dialing 6801 will become the source for Audio Program 1 (ID = Program channel)

If multiple Audio Program channels are to be added, one have to use multiple IP Dummy Stations, and create 6802 - feature 118 and ID = 2, 6803 - feature 118 and ID = 3, etc.

Filters settings

The UDP ports used for audio streaming must be added and applied to the ICX-AlphaCom firewall; Filters

Define and Open the relevant UDP ports in the ICX-AlphaCom Filter settings. Here: UDP ports 4002 - 4004.

Finally, one have to reboot the ICX-AlphaCom for all settings to take effect.

PC setup

Download and install FFMPEG on the PC: https://www.ffmpeg.org/download.html
From Windows command line, enter:

ffmpeg.exe -re -i "C:\Programmer\ffmpeg\media\06 Paradise by the Dashboard Light.mp3" -ac 1 -acodec g722 -ar 16000 -filter:a volume=-6dB -f rtp rtp://10.9.8.20:4004

"C:\Programmer\ffmpeg\media\06 Paradise by the Dashboard Light.mp3" = audio source. This could be e.g. the url of an internet radio.
10.9.8.20 = IP Address of the ICX-AlphaCom
4004 = The UDP port used by the IP Dummy Station
-filter:a volume=-6dB = Sets the volume

Now you should be able to listen to Audio Program channel 1 by dialing 801 on an intercom station.

Audio Program features

Audio Program selection

To listen to an audio program, dial the program number (default 801 - 806). The audio program is switched off by pressing the C-key or by dialing 800.

When lifting the handset the dialing tone is normally heard, replacing any program. To listen to the program with the handset off, simply hold the M-key down while lifting the receiver, and the dialing tone is not turned on.

Active audio programs are automatically restored after server reset.

Audio Program Step

You can step through a list of available programs by dialing 790 on your station. Program off (800) is always included in the list. There are two alternative program step sequences.

The sequences after autoload

The number of programs in each sequence is programmable from AlphaPro, Audio Programs > General Settings. This sequence setting is valid for the entire system.
Each station can choose between sequence 1 or 2. By default all stations are assigned to sequence 1, this can be changed in Users & Stations → User Preferences.

Program step codes:

Audio Program Priority

During conversation the audio program is by default temporarily disconnected. This can be changed per audio program by the flag "Program over Conversation" in the Audio Program menu in AlphaPro. When the flag is set, the audio from the audio program will be mixed with the audio from the conversation.

During group calls the audio program and the group call audio is by default mixed. This can be controlled from AlphaPro by the flag "Mute Program During Group Call" in Exchange & System → System → Calls and Options. When the flag is set the audio program is temporarily disconnected during the group call. This is a global flag which applies to the whole system.

Each audio program channel has a "Volume/Handset override" flag, located in the Audio Program menu in AlphaPro. When set the Volume & handset override feature is activated for display stations if the program is activated by remote set-up to Group. This can be used when distributing alarm messages via the audio program channel.

Remote set-up of Audio Program

Audio Program can remotely be turned on from a station:

Audio program to another station: 74 + subscriber number + program number. E.g. 74 + 101 + 805
Audio program to a group (SuperUser only): 75 + group number + program number. E.g. 75 + 86 + 805

Use code 800 to turn the audio program off.

Audio Program can also be set up from RCI or Event Handler using the following commands:

PRS - Program to Station
PRG - Program to Group
$PROG - Program to station or group

Other audio program related commands and macros:

$TPROG - Temporarily turn ON/OFF program distribution to a station
%prog - Read active program

Events related to Audio Program

The event 01 - Audio, subevent 32 is triggered when the audio program is on.

Example: Activating RCO1 to control an amplifier when physical number 4 listens to an Audio Program

@@ Line 1: / Line 1: @@
-== Selecting a Program ==
+{{I}}
-The AlphaCom system is prepared for distribution of audio programs. There must be an external audio source as input to each program, a radio, a cassette player, a CD-player or other sound input.
+The ICX-AlphaCom system supports distribution of '''Audio Programs'''. This feature is typically used for distribution of background music. Up to 70 Audio Program channels are supported.
-A number of audio programs are available,  depending on the system configuration. By default 6 programs are available. Using the additional Program Distribution Boards (AGA) gives the possibility to distribute another 16 programs. Two such boards can be installed in the exchange, so the maximum number of available programs in the system is 38.
+Audio source can be:
+* An analog audio source, typically a radio, CD-player, alarm device connected to the [[TKIE-2|TKIE-2 kit]]. The TKIE-2 kit is used as an interface between the analog audio source and the ICX-AlphaCom server. (See image to the right).
+* An audio stream from a PC (e.g. a local audio file or stream from an internet radio) directly to the ICX-AlphaCom server. One can use the application ffmpeg on the PC to generate the stream.
-To select a program, dial the program number (default 801 - 806, 8101 - 8132). The program is temporarily disconnected by outgoing and incoming calls, but remains on during Group Calls and All Calls.
+For Audio Program distribution in the previous generation servers AlphaCom XE, see [[Audio Program (AlphaCom XE)|here]].
-When you lift the handset, the dialing tone is normally heard, replacing any program. If you wish to listen to the program with the handset off, simply hold the M-key down while you lift the receiver, and the dialing tone is not turned on.
+== Using analog source and TKIE kit ==
+When using the [[TKIE-2|TKIE-2 kit]], the analog audio signal is connected to the [[Turbine_Extended_series_board_connectors|Auxiliary connector pin 8 and 9]] of the TKIE kit. One TKIE kit is required for each Audio Program channel.
+[[Image:Audio Program ICX.PNG|thumb|600px|Audio Program distribution, using the TKIE kit as analog interface]]
+First [[Getting_Started_(ICX-AlphaCom)#Configuration_of_the_Intercom_station|configure the TKIE kit to register to the ICX-AlphaCom]].
-=== Additional Information ===
+In AlphaPro [[Users & Stations (AlphaPro)|Users & Stations]], select the TKIE and set the Class of Service = SuperUser, and disable Noise Reduction:
-* Each Program Distribution Board installed reduces the maximum number of subscribers in the system by 6.
+[[File:TKIE ProgFeed2.PNG|thumb|left|500px|For the TKIE set the Class of Service = '''SuperUser''', and disable '''Noise Reduction''']]
-* APF boards were earlier used for program distribution. They have been replaced by AGA boards.
+<br style="clear:both;" />
-* Priority Programs are not turned off during calls. (programmable per program).
-* It is possible to distribute an AlphaCom conference as a program.
-== Switching On a Program ==
+In AlphaPro [[Users & Stations (AlphaPro)|Users & Stations]], select the TKIE and select the button "'''Events'''".
-To switch off a program, press the C-key or dial 800.
+'''Insert''' an event 13, when change to OFF with action: $DD L%1.dir L6801. This event is triggered when the TKIE comes up after a reset of TKIE or a reset of the server.
-== Stepping Through Available Programs ==
-You can step through a list of available programs by dialing 790 on your station. Program off (800) is always included in the list. There are two alternative program step sequences: 3 or 6 programs.
-The sequences are after autoload :
+[[File:TKIE ProgFeed3.PNG|thumb|left|500px|Event Handler: TKIE-2 dials 6801 after startup]]
-* Program 1, 2, 3, 4, 5, 6 and off.
+<br style="clear:both;" />
-* Program 1, 2, 3 and off.
-When you are listening to a program you have the following options:
-* 790 - step up
-* 791 - step down
-* 792 - restore last
-=== Additional Information ===
+In AlphaPro [[Directory & Features (AlphaPro)|Directory & Features]], scroll to the bottom of the directory list and check if directory number 6801 with feature number 118 already exists.
-* The number of programs in each sequence is programmable. The sequence setting is valid for the entire system.
-* Each station can choose between sequence 1 or 2.
-=== Software ===
+If not, press '''Insert''' and create a new directory number with feature 118 - [[Program_Source|Program Source]]. Set ID = 1 (this specifies the program channel 1).
-* AMC 06.00 - step down and restore last.
-== Program Priority ==
+The example below shows how to add directory number 6801 with feature number 118.
-Program can be given 4 different priority levels affecting the program in the following way:
-{|
+[[File:TKIE Add6801.PNG|thumb|left|500px|A device dialing 6801 will become the source for Audio Program 1 (ID = Program channel)]]
-|+
+<br style="clear:both;" />
-|-
-|* low
-|the program is turned off during conversation.
+If multiple Audio Program channels are to be added, one must add 6802 - feature 118 and ID = 2, 6803 - feature 118 and ID = 3, etc.
-|-
-|* medium and high
-|the program remains on during conversations.
+Log in to the web interface of the TKIE. Verify that audio from line in is enabled, and that AGC is disabled:
-|-
-|* alarm
+[[File:TKIE ProgFeed.PNG|thumb|left|500px|Line In enabled and AGC off]]
-|activates the handset & volume override for InterGuard stations if the program is activated by remote set-up to Group. This is used to distribute an alarm message as a program.
+<br style="clear:both;" />
-|}
+Finally, one have to reboot either the TKIE kit or the ICX-AlphaCom for all settings to take effect.
+Now you should be able to listen to Audio Program channel 1 by dialing 801 on an intercom station.
+For remote setup and other Audio Program related functions, see [[Audio_Program#Audio_Program_features|Audio Program features]].
+[[Image:AudioProg Dummy Streaming.PNG|thumb|600px|Audio Program distribution, streaming from a PC using ffmpeg]]
+== Streaming audio from a PC ==
+=== Configure the IP Dummy Station ===
+The PC is streaming audio to an [[IP_Dummy_Station|IP Dummy station]] using the ffmpeg program. The IP Dummy Station is configured as the "Source" for an Audio Program channel. One IP Dummy Station is required for each Audio Program channel.
+{{obs|The IP Dummy Station requires an IP Station License}}
+In AlphaPro [[Users & Stations (AlphaPro)|Users & Stations]], "General" tab, select a free user and configure as described below (Directory Number and Display Text are just examples):
+[[File:AudioProg Dummy P1.PNG|thumb|left|500px|Set the Class of Service = '''SuperUser''']]
+<br style="clear:both;" />
+In AlphaPro [[Users & Stations (AlphaPro)|Users & Stations]], "Station Type" tab, enable the "IP Dummy Station" flag:
+[[File:AudioProg Dummy flag.PNG|thumb|left|500px|Set the "IP Dummy Station" flag]]
+<br style="clear:both;" />
+In AlphaPro [[Users & Stations (AlphaPro)|Users & Stations]] select the IP Dummy and select the button "'''Events'''".
+'''Insert''' an event 13, when change to OFF. This event is triggered when the ICX-AlphaCom starts up.
+[[File:AudioProg Dummy Event.PNG|thumb|left|500px|Event Handler: IP Dummy dials 6801 after startup]]
+<br style="clear:both;" />
+Action:
+ $VAC L%1.dir U8 '10.9.8.189' W4002 W4004
+ $DD L%1.dir L6801
+The first line will define UDP port 4004 as the receiving port for the Audio Stream. (Port 4002 is defined as the sending port, but is not used in this case):
+* U8 = Use G.722 codec
+* 10.9.8.189 = The IP Address of the PC
+* 4004 = UDP port for receiving audio
+The second line tells the IP Dummy to dial 6801, and by that become the source for Audio Program 1.
+In AlphaPro [[Directory & Features (AlphaPro)|Directory & Features]], scroll to the bottom of the directory list and check if directory number 6801 with feature number 118 already exists.
+If not, press '''Insert''' and create a new directory number with feature 118 - [[Program_Source|Program Source]]. Set ID = 1 (this specifies the program channel 1).
+The example below shows how to add directory number 6801 with feature number 118.
+[[File:TKIE Add6801.PNG|thumb|left|500px|A device dialing 6801 will become the source for Audio Program 1 (ID = Program channel)]]
+<br style="clear:both;" />
+If multiple Audio Program channels are to be added, one have to use multiple IP Dummy Stations, and create 6802 - feature 118 and ID = 2, 6803 - feature 118 and ID = 3, etc.
+=== Filters settings===
+The UDP ports used for audio streaming must be added and applied to the ICX-AlphaCom firewall; [[ICX_Web#Filters|Filters]]
+[[File:AudioProg Dummy Firewall.PNG|thumb|left|500px|Define and Open the relevant UDP ports in the ICX-AlphaCom Filter settings. Here: UDP ports 4002 - 4004.]]
+<br style="clear:both;" />
+Finally, one have to reboot the ICX-AlphaCom for all settings to take effect.
+=== PC setup ===
+* Download and install FFMPEG on the PC: https://www.ffmpeg.org/download.html
+* From Windows command line, enter:
+{{Code|ffmpeg.exe -re -i "C:\Programmer\ffmpeg\media\06 Paradise by the Dashboard Light.mp3" -ac 1 -acodec g722 -ar 16000 -filter:a volume<nowiki>=</nowiki>-6dB -f rtp rtp://10.9.8.20:4004}}
+* '''"C:\Programmer\ffmpeg\media\06 Paradise by the Dashboard Light.mp3"''' = audio source. This could be e.g. the url of an internet radio.
+* '''10.9.8.20''' = IP Address of the ICX-AlphaCom
+* '''4004''' = The UDP port used by the IP Dummy Station
+* '''-filter:a volume=-6dB''' = Sets the volume
+Now you should be able to listen to Audio Program channel 1 by dialing 801 on an intercom station.
+=== Related articles ===
+* [[HD audio for background music distribution]]
+* [[Stream audio from 3rd party]]
+* [[IP Dummy Station]]
+== Audio Program features==
+=== Audio Program selection ===
+To listen to an audio program, dial the program number (default 801 - 806). The audio program is switched off by pressing the C-key or by dialing 800.
+When lifting the handset the dialing tone is normally heard, replacing any program. To listen to the program with the handset off, simply hold the M-key down while lifting the receiver, and the dialing tone is not turned on.
+Active audio programs are automatically restored after server reset.
+=== Audio Program Step ===
+You can step through a list of available programs by dialing 790 on your station. Program off (800) is always included in the list. There are two alternative program step sequences.
+[[File:AudioProgram GeneralSettings.PNG|thumb|left|500px|The sequences after [[autoload]]]]
+<br style="clear:both;" />
+* The number of programs in each sequence is programmable from AlphaPro, '''Audio Programs''' > '''General Settings'''. This sequence setting is valid for the entire system.
+* Each station can choose between sequence 1 or 2. By default all stations are assigned to sequence 1, this can be changed in '''Users & Stations''' &rarr; '''User Preferences'''.
+[[File:AudioProgram SequenceSelection.png|thumb|left|500px]]
+<br style="clear:both;" />
+Program step codes:
+* [[Audio program step feature|790 - step up]]
+* [[Audio program step feature|791 - step down]]
+* [[Toggle Program on/off feature|792 - Toggle between current program and off]]
+=== Audio Program Priority ===
+* '''During conversation''' the audio program is by default temporarily disconnected. This can be changed per audio program by the flag "Program over Conversation" in the '''Audio Program''' menu in AlphaPro. When the flag is set, the audio from the audio program will be mixed with the audio from the conversation.
+[[File:AudioProgram DuringConversation.png|thumb|left|500px]]
+<br style="clear:both;" />
+* '''During group calls''' the audio program and the group call audio is by default mixed. This can be controlled from AlphaPro by the flag "Mute Program During Group Call" in '''Exchange & System''' &rarr; '''System''' &rarr; '''Calls and Options'''. When the flag is set the audio program is temporarily disconnected during the group call. This is a global flag which applies to the whole system.
+[[File:AudioProgram MuteDuringGroupCalls.png|thumb|left|500px]]
+<br style="clear:both;" />
+* Each audio program channel has a "Volume/Handset override" flag, located in the '''Audio Program''' menu in AlphaPro. When set the [[Volume & handset override]] feature is activated for display stations if the program is activated by ''remote set-up to Group''. This can be used when distributing alarm messages via the audio program channel.
+[[File:AudioProgram VolumeHandsetOverride.PNG|thumb|left|500px|]]
+<br style="clear:both;" />
+=== Remote set-up of Audio Program ===
+Audio Program can remotely be turned on from a station:
+* Audio program to another station: 74 + subscriber number + program number. E.g. 74 + 101 + 805
+* Audio program to a group ([[SuperUser]] only): 75 + group number + program number.  E.g. 75 + 86 + 805
+Use code 800 to turn the audio program off.
+Audio Program can also be set up from [[RCI]] or [[Event Handler]] using the following commands:
+* [[PRS]] - Program to Station
+* [[PRG]] - Program to Group
+* $[[PROGRAM|PROG]] - Program to station or group
+Other audio program related commands and macros:
+* [[TEMP PROG|$TPROG]] - Temporarily turn ON/OFF program distribution to a station
+* [[%prog]] - Read active program
+=== Events related to Audio Program ===
+The event [[Audio_%28Event_Type%29#Audio_Program.2FAlarm_Distribution_.28sub-event_32.29|01 - Audio, subevent 32]] is triggered when the audio program is on.
+[[File:Event1 32.PNG|thumb|left|500px|Example: Activating RCO1 to control an amplifier when physical number 4 listens to an Audio Program]]
+<br style="clear:both;" />
+[[Category: ICX-AlphaCom features]]