diff --git a/config/sample.engine-core.docker.ini b/config/sample.engine-core.docker.ini index cc5e0ea7af04dea21b18c7f168b1057b3260b49b..a6ad9f4e7cd8cbc7f76a9352c63852ea0604ee93 100644 --- a/config/sample.engine-core.docker.ini +++ b/config/sample.engine-core.docker.ini @@ -1,9 +1,10 @@ -############################################## -# Engine-Core Configuration # -############################################## -# Note: Paths are relative to the 'src' folder +################################################################################################## +# Engine Core Configuration # +################################################################################################## + [general] +################################################################################################## # Engine ID ; engine_id="1" # File Socket to control engine-core by engine @@ -21,6 +22,11 @@ audio_playlist_folder="/var/audio/playlist" [fallback] +################################################################################################## +# Fallback audio played in scenarios where all other channels are silent. Fallback channels are +# activated using a silence detector. You can use a fallback folder or playlist to feed audio +# into the fallback player. +# # A folder holding music for Station Fallbacks (optional) fallback_music_folder="/var/audio/fallback" # Fallback Show Settings @@ -41,57 +47,84 @@ fallback_music_folder="/var/audio/fallback" ; fallback_threshold="-80." -[soundcard] -# Choose your weapon: "alsa" (1 input/output), "pulseaudio" (multi input/output) or "jack" (multi input/output) +[audio] +################################################################################################## +# Sound Server +# +# Choose your weapon: "alsa" (1 input/output), "pulseaudio" (multi input/output) +# or "jack" (multi input/output) soundsystem="alsa" -# With 'alsa' you have to write the devicenames like 'default' to use the system default or 'hw:0' to use the 1st audio device directly. -# With Pulse Audio and Jack => an non empty value means it is used -# Devices with empty string are ignored and not used -; input_device_0="" -; input_device_1="" -# Same same, but different + +################################################################################################## +# Input / Output +# +# With 'alsa' you have to write the device names like 'default' to use the system default +# or 'hw:0' to use the 1st audio device directly. With Pulse Audio and Jack => an non empty value +# means it is used. Devices with empty string are ignored and not used +# output_device_0="default" ; output_device_1="" -# FRAME SETTINGS +; input_device_0="" +; input_device_1="" + +################################################################################################## +# Frame Settings # # Sample rate in Hz ; frame_audio_sample_rate="44100" -# Frame Size ("frame.audio.size") is provided by ALSA and is specific to your Audio Device. Needs to be manually obtained and set correctly. + +# Frame Size ("frame.audio.size") is provided by ALSA and is specific to your Audio Device. Needs +# to be manually obtained and set correctly. ; frame_audio_size="1764" ; frame_audio_size="7056" -# Tentative frame duration in seconds, defaults to "0.04" (Float). This setting is used as a hint for the duration, -# when frame_audio_size is not provided. It's required for getting things in sync, but it's actually tricky to set correctly. + +# Tentative frame duration in seconds, defaults to "0.04" (Float). This setting is used as a hint +# for the duration, when frame_audio_size is not provided. It's required for getting things in +# sync, but it's actually tricky to set correctly. ; frame_duration="" -# ADVANCED ALSA SETTINGS - Defaults are recommended; you might need to tweak these values if you're +################################################################################################## +# Advanced ALSA Settings +# +# Defaults are recommended, but you might need to tweak these values if you're # hearing jitter, cracklings or other artifacts or having generally bad latency - +# # Buffered audio is quite simple to setup but has some latency; Unbuffered provides low latency but # requires a valid frame size. ; alsa_buffered_input="true" ; alsa_buffered_output="true" - +# # Set to 0 to use the ALSA default. If using hardware directly (hw:0) start with 8192. Higher values # give higher latency and lower CPU usage. ; alsa_buffer="8192" - +# # Only used for buffered ALSA I/O, and affects latency. Probably not wanted for live audio. # Defaults to "1". ; alsa_buffer_length="10" - +# # Set to 0 or leave empty to use the ALSA default. ; alsa_periods="" +################################################################################################## +# ReplayGain Track Gain Normalization +# +# Audio files are automatically normalized as soon ReplayGain metadata is provided. If your audio +# files do not provide such metadata, it's possible to compute it on the fly for all files +# automatically. Keep in mind this is a computation costly task. +;enable_replaygain_resolver=true + [stream] -# Repeat this section for additional outgoing streams -# Like "stream_1", "stream_2" and so on. +################################################################################################## +# Icecast output +# +# Repeat this section for additional outgoing streams, like "stream_1", "stream_2" and so on. # Enabled: (y)es or (n)o ; stream_0="n" # Possible values: flac, mp3, ogg, opus -# (depending on which liquidsoap plugins you've installed) +# (depending on the installed Liquidsoap) ; stream_0_encoding="ogg" ; stream_0_bitrate="128" # Stereo (2) or Mono (any other value) @@ -99,11 +132,11 @@ output_device_0="default" # Icecast host details ; stream_0_host="localhost" ; stream_0_port="8888" -; stream_0_mountpoint="aura-test-0.ogg" +; stream_0_mountpoint="aura-radio.ogg" ; stream_0_user="source" ; stream_0_password="source" -; stream_0_url="http://www.fro.at" +; stream_0_url="https://aura.radio" # Stream Metadata -; stream_0_name="AURA Test Stream 0" -; stream_0_genre="mixed" -; stream_0_description="Test Stream 0" +; stream_0_name="AURA Radio" +; stream_0_genre="music" +; stream_0_description="Music from the community radio software suite" diff --git a/config/sample.engine-core.ini b/config/sample.engine-core.ini index 700918758574040fe4158ca921327ffe4376ae28..721a792c7a04ae868221e21023ff0930779a7968 100644 --- a/config/sample.engine-core.ini +++ b/config/sample.engine-core.ini @@ -1,9 +1,10 @@ -############################################## -# Engine-Core Configuration # -############################################## -# Note: Paths are relative to the 'src' folder +################################################################################################## +# Engine Core Configuration # +################################################################################################## + [general] +################################################################################################## # Engine ID ; engine_id="1" # File Socket to control engine-core by engine @@ -21,6 +22,11 @@ api_url_playlog="http://127.0.0.1:8008/api/v1/playlog" [fallback] +################################################################################################## +# Fallback audio played in scenarios where all other channels are silent. Fallback channels are +# activated using a silence detector. You can use a fallback folder or playlist to feed audio +# into the fallback player. +# # A folder holding music for Station Fallbacks (optional) ; fallback_music_folder="../audio/fallback" # Fallback Show Settings @@ -41,57 +47,84 @@ api_url_playlog="http://127.0.0.1:8008/api/v1/playlog" ; fallback_threshold="-80." -[soundcard] -# Choose your weapon: "alsa" (1 input/output), "pulseaudio" (multi input/output) or "jack" (multi input/output) +[audio] +################################################################################################## +# Sound Server +# +# Choose your weapon: "alsa" (1 input/output), "pulseaudio" (multi input/output) +# or "jack" (multi input/output) soundsystem="alsa" -# With 'alsa' you have to write the devicenames like 'default' to use the system default or 'hw:0' to use the 1st audio device directly. -# With Pulse Audio and Jack => an non empty value means it is used -# Devices with empty string are ignored and not used -; input_device_0="" -; input_device_1="" -# Same same, but different + +################################################################################################## +# Input / Output +# +# With 'alsa' you have to write the device names like 'default' to use the system default +# or 'hw:0' to use the 1st audio device directly. With Pulse Audio and Jack => an non empty value +# means it is used. Devices with empty string are ignored and not used +# output_device_0="default" ; output_device_1="" -# FRAME SETTINGS +; input_device_0="" +; input_device_1="" + +################################################################################################## +# Frame Settings # # Sample rate in Hz ; frame_audio_sample_rate="44100" -# Frame Size ("frame.audio.size") is provided by ALSA and is specific to your Audio Device. Needs to be manually obtained and set correctly. + +# Frame Size ("frame.audio.size") is provided by ALSA and is specific to your Audio Device. Needs +# to be manually obtained and set correctly. ; frame_audio_size="1764" ; frame_audio_size="7056" -# Tentative frame duration in seconds, defaults to "0.04" (Float). This setting is used as a hint for the duration, -# when frame_audio_size is not provided. It's required for getting things in sync, but it's actually tricky to set correctly. + +# Tentative frame duration in seconds, defaults to "0.04" (Float). This setting is used as a hint +# for the duration, when frame_audio_size is not provided. It's required for getting things in +# sync, but it's actually tricky to set correctly. ; frame_duration="" -# ADVANCED ALSA SETTINGS - Defaults are recommended; you might need to tweak these values if you're +################################################################################################## +# Advanced ALSA Settings +# +# Defaults are recommended, but you might need to tweak these values if you're # hearing jitter, cracklings or other artifacts or having generally bad latency - +# # Buffered audio is quite simple to setup but has some latency; Unbuffered provides low latency but # requires a valid frame size. ; alsa_buffered_input="true" ; alsa_buffered_output="true" - +# # Set to 0 to use the ALSA default. If using hardware directly (hw:0) start with 8192. Higher values # give higher latency and lower CPU usage. ; alsa_buffer="8192" - +# # Only used for buffered ALSA I/O, and affects latency. Probably not wanted for live audio. # Defaults to "1". ; alsa_buffer_length="10" - +# # Set to 0 or leave empty to use the ALSA default. ; alsa_periods="" +################################################################################################## +# ReplayGain Track Gain Normalization +# +# Audio files are automatically normalized as soon ReplayGain metadata is provided. If your audio +# files do not provide such metadata, it's possible to compute it on the fly for all files +# automatically. Keep in mind this is a computation costly task. +;enable_replaygain_resolver=true + [stream] -# Repeat this section for additional outgoing streams -# Like "stream_1", "stream_2" and so on. +################################################################################################## +# Icecast output +# +# Repeat this section for additional outgoing streams, like "stream_1", "stream_2" and so on. # Enabled: (y)es or (n)o ; stream_0="n" # Possible values: flac, mp3, ogg, opus -# (depending on which liquidsoap plugins you've installed) +# (depending on the installed Liquidsoap) ; stream_0_encoding="ogg" ; stream_0_bitrate="128" # Stereo (2) or Mono (any other value) @@ -99,11 +132,11 @@ output_device_0="default" # Icecast host details ; stream_0_host="localhost" ; stream_0_port="8888" -; stream_0_mountpoint="aura-test-0.ogg" +; stream_0_mountpoint="aura-radio.ogg" ; stream_0_user="source" ; stream_0_password="source" -; stream_0_url="http://www.fro.at" +; stream_0_url="https://aura.radio" # Stream Metadata -; stream_0_name="AURA Test Stream 0" -; stream_0_genre="mixed" -; stream_0_description="Test Stream 0" +; stream_0_name="AURA Radio" +; stream_0_genre="music" +; stream_0_description="Music from the community radio software suite"