AzuraCast/config/forms/station.php

732 lines
30 KiB
PHP

<?php
use App\Entity\Interfaces\StationMountInterface;
use App\Entity\Station;
use App\Entity\StationBackendConfiguration;
use App\Entity\StationFrontendConfiguration;
use App\Radio\Adapters;
/**
* @var Adapters $adapters
* @var array<string,string> $countries
*/
$frontends = $adapters->listFrontendAdapters(true);
$frontend_types = [];
foreach ($frontends as $adapter_nickname => $adapter_info) {
$frontend_types[$adapter_nickname] = $adapter_info['name'];
}
$backends = $adapters->listBackendAdapters(true);
$backend_types = [];
foreach ($backends as $adapter_nickname => $adapter_info) {
$backend_types[$adapter_nickname] = $adapter_info['name'];
}
$tzSelect = [
'UTC' => [
'UTC' => 'UTC',
],
];
foreach (
DateTimeZone::listIdentifiers(
(DateTimeZone::ALL ^ DateTimeZone::ANTARCTICA ^ DateTimeZone::UTC)
) as $tzIdentifier
) {
$tz = new DateTimeZone($tzIdentifier);
$tzRegion = substr($tzIdentifier, 0, strpos($tzIdentifier, '/')) ?: $tzIdentifier;
$tzSubregion = str_replace([$tzRegion . '/', '_'], ['', ' '], $tzIdentifier) ?: $tzRegion;
$offset = $tz->getOffset(new DateTime);
$offsetPrefix = $offset < 0 ? '-' : '+';
$offsetFormatted = gmdate(($offset % 60 === 0) ? 'G' : 'G:i', abs($offset));
$prettyOffset = ($offset === 0) ? 'UTC' : 'UTC' . $offsetPrefix . $offsetFormatted;
if ($tzSubregion !== $tzRegion) {
$tzSubregion .= ' (' . $prettyOffset . ')';
}
$tzSelect[$tzRegion][$tzIdentifier] = $tzSubregion;
}
return [
'method' => 'post',
'enctype' => 'multipart/form-data',
'tabs' => [
'profile' => __('Station Profile'),
'frontend' => __('Broadcasting'),
'backend' => __('AutoDJ'),
'admin' => __('Administration'),
],
'groups' => [
'profile' => [
'tab' => 'profile',
'use_grid' => true,
'elements' => [
'name' => [
'text',
[
'label' => __('Name'),
'required' => true,
'form_group_class' => 'col-sm-12',
],
],
'description' => [
'textarea',
[
'label' => __('Description'),
'form_group_class' => 'col-sm-12',
],
],
'genre' => [
'text',
[
'label' => __('Genre'),
'form_group_class' => 'col-md-6',
],
],
'url' => [
'text',
[
'label' => __('Web Site URL'),
'description' => __(
'Note: This should be the public-facing homepage of the radio station, not the AzuraCast URL. It will be included in broadcast details.'
),
'form_group_class' => 'col-md-6',
],
],
'timezone' => [
'select',
[
'label' => __('Time Zone'),
'description' => __(
'Scheduled playlists and other timed items will be controlled by this time zone.'
),
'options' => $tzSelect,
'default' => 'UTC',
'form_group_class' => 'col-sm-12',
],
],
'enable_public_page' => [
'toggle',
[
'label' => __('Enable Public Page'),
'description' => __('Show the station in public pages and general API results.'),
'selected_text' => __('Yes'),
'deselected_text' => __('No'),
'default' => true,
'form_group_class' => 'col-sm-6',
],
],
'enable_on_demand' => [
'toggle',
[
'label' => __('Enable On-Demand Streaming'),
'description' => __(
'If enabled, music from playlists with on-demand streaming enabled will be available to stream and download via a specialized public page.'
),
'selected_text' => __('Yes'),
'deselected_text' => __('No'),
'default' => false,
'form_group_class' => 'col-sm-6',
],
],
'default_album_art_url' => [
'text',
[
'label' => __('Default Album Art URL'),
'description' => __(
'If a song has no album art, this URL will be listed instead. Leave blank to use the standard placeholder art.'
),
'form_group_class' => 'col-md-6',
],
],
'enable_on_demand_download' => [
'toggle',
[
'label' => __('Enable Downloads on On-Demand Page'),
'description' => __(
'If enabled, music from playlists with on-demand streaming enabled will be available to stream and download via a specialized public page.'
),
'selected_text' => __('Yes'),
'deselected_text' => __('No'),
'default' => true,
'form_group_class' => 'col-sm-6',
],
],
'short_name' => [
'text',
[
'label' => __('URL Stub'),
'label_class' => 'advanced',
'description' => __(
'Optionally specify a short URL-friendly name, such as <code>my_station_name</code>, that will be used in this station\'s URLs. Leave this field blank to automatically create one based on the station name.'
),
'form_group_class' => 'col-md-6',
],
],
'api_history_items' => [
'select',
[
'label' => __('Number of Recently Played Songs'),
'label_class' => 'advanced',
'description' => __(
'Customize the number of songs that will appear in the "Song History" section for this station and in all public APIs.'
),
'choices' => [
0 => __('Disabled'),
1 => '1',
5 => '5',
10 => '10',
15 => '15',
],
'default' => Station::DEFAULT_API_HISTORY_ITEMS,
'form_group_class' => 'col-md-6',
],
],
],
],
'select_frontend_type' => [
'tab' => 'frontend',
'elements' => [
'frontend_type' => [
'radio',
[
'label' => __('Broadcasting Service'),
'description' => __('This software delivers your broadcast to the listening audience.'),
'options' => $frontend_types,
'default' => Adapters::DEFAULT_FRONTEND,
],
],
],
],
'frontend_local' => [
'use_grid' => true,
'class' => 'frontend_fieldset',
'tab' => 'frontend',
'elements' => [
StationFrontendConfiguration::SOURCE_PASSWORD => [
'text',
[
'label' => __('Customize Source Password'),
'description' => __('Leave blank to automatically generate a new password.'),
'belongsTo' => 'frontend_config',
'form_group_class' => 'col-md-6',
],
],
StationFrontendConfiguration::ADMIN_PASSWORD => [
'text',
[
'label' => __('Customize Administrator Password'),
'description' => __('Leave blank to automatically generate a new password.'),
'belongsTo' => 'frontend_config',
'form_group_class' => 'col-md-6',
],
],
StationFrontendConfiguration::PORT => [
'text',
[
'label' => __('Customize Broadcasting Port'),
'label_class' => 'advanced',
'description' => __(
'No other program can be using this port. Leave blank to automatically assign a port.'
),
'belongsTo' => 'frontend_config',
'form_group_class' => 'col-md-6',
],
],
StationFrontendConfiguration::MAX_LISTENERS => [
'text',
[
'label' => __('Maximum Listeners'),
'label_class' => 'advanced',
'description' => __(
'Maximum number of total listeners across all streams. Leave blank to use the default (250).'
),
'belongsTo' => 'frontend_config',
'form_group_class' => 'col-md-6',
],
],
StationFrontendConfiguration::CUSTOM_CONFIGURATION => [
'textarea',
[
'label' => __('Custom Configuration'),
'label_class' => 'advanced',
'belongsTo' => 'frontend_config',
'class' => 'text-preformatted',
'description' => __(
'This code will be included in the frontend configuration. You can use either JSON {"new_key": "new_value"} format or XML &lt;new_key&gt;new_value&lt;/new_key&gt;.'
).__(
'For SHOUTcast Premium users, you can use custom configuration in this format: <code>{ "licenceid": "YOUR_LICENSE_ID", "userid": "YOUR_USER_ID" }</code>'
),
'form_group_class' => 'col-sm-7',
],
],
StationFrontendConfiguration::BANNED_IPS => [
'textarea',
[
'label' => __('Banned IP Addresses'),
'label_class' => 'advanced',
'belongsTo' => 'frontend_config',
'class' => 'text-preformatted',
'description' => __('List one IP address or group (in CIDR format) per line.'),
'form_group_class' => 'col-sm-5',
],
],
StationFrontendConfiguration::BANNED_COUNTRIES => [
'multiselect',
[
'label' => __('Banned Countries'),
'label_class' => 'advanced',
'belongsTo' => 'frontend_config',
'description' => __('Select the countries that are not allowed to connect to the streams.'),
'form_group_class' => 'col-sm-7',
'options' => $countries,
],
],
StationFrontendConfiguration::ALLOWED_IPS => [
'textarea',
[
'label' => __('Allowed IP Addresses'),
'label_class' => 'advanced',
'belongsTo' => 'frontend_config',
'class' => 'text-preformatted',
'description' => __('List one IP address or group (in CIDR format) per line to explicitly allow them to connect even when their country is banned.'),
'form_group_class' => 'col-sm-5',
],
],
],
],
'select_backend_type' => [
'tab' => 'backend',
'elements' => [
'backend_type' => [
'radio',
[
'label' => __('AutoDJ Service'),
'description' => __(
'This software shuffles from playlists of music constantly and plays when no other radio source is available.'
),
'options' => $backend_types,
'default' => Adapters::DEFAULT_BACKEND,
],
],
],
],
'backend_liquidsoap' => [
'use_grid' => true,
'class' => 'backend_fieldset',
'tab' => 'backend',
'elements' => [
StationBackendConfiguration::CROSSFADE_TYPE => [
'radio',
[
'label' => __('Crossfade Method'),
'belongsTo' => 'backend_config',
'description' => __(
'Choose a method to use when transitioning from one song to another. Smart Mode considers the volume of the two tracks when fading for a smoother effect, but requires more CPU resources.'
),
'choices' => [
StationBackendConfiguration::CROSSFADE_SMART => __('Smart Mode'),
StationBackendConfiguration::CROSSFADE_NORMAL => __('Normal Mode'),
StationBackendConfiguration::CROSSFADE_DISABLED => __('Disable Crossfading'),
],
'default' => StationBackendConfiguration::CROSSFADE_NORMAL,
'form_group_class' => 'col-md-8',
],
],
'crossfade' => [
'number',
[
'label' => __('Crossfade Duration (Seconds)'),
'belongsTo' => 'backend_config',
'description' => __('Number of seconds to overlap songs.'),
'default' => 2,
'min' => '0.0',
'max' => '30.0',
'step' => '0.1',
'form_group_class' => 'col-md-4',
],
],
StationBackendConfiguration::USE_NORMALIZER => [
'toggle',
[
'label' => __('Apply Compression and Normalization'),
'belongsTo' => 'backend_config',
'description' => __(
'Compress and normalize your station\'s audio, producing a more uniform and "full" sound.'
),
'selected_text' => __('Yes'),
'deselected_text' => __('No'),
'default' => false,
'form_group_class' => 'col-sm-12',
],
],
'enable_requests' => [
'toggle',
[
'label' => __('Allow Song Requests'),
'description' => __(
'Enable listeners to request a song for play on your station. Only songs that are already in your playlists are requestable.'
),
'selected_text' => __('Yes'),
'deselected_text' => __('No'),
'default' => false,
'form_group_class' => 'col-sm-12',
],
],
'request_delay' => [
'number',
[
'label' => __('Request Minimum Delay (Minutes)'),
'description' => __(
'If requests are enabled, this specifies the minimum delay (in minutes) between a request being submitted and being played. If set to zero, a minor delay of 15 seconds will remain for rate limits (Request flood prevention).<br><b>Important:</b> Some stream licensing rules require a minimum delay for requests (in the US, this is currently 60 minutes). Check your local regulations for more information.'
),
'default' => Station::DEFAULT_REQUEST_DELAY,
'min' => '0',
'max' => '1440',
'form_group_class' => 'col-md-6',
],
],
'request_threshold' => [
'number',
[
'label' => __('Request Last Played Threshold (Minutes)'),
'description' => __(
'If requests are enabled, this specifies the minimum time (in minutes) between a song playing on the radio and being available to request again. Set to 0 for no threshold.'
),
'default' => Station::DEFAULT_REQUEST_THRESHOLD,
'min' => '0',
'max' => '1440',
'form_group_class' => 'col-md-6',
],
],
'enable_streamers' => [
'toggle',
[
'label' => __('Allow Streamers / DJs'),
'description' => __(
'If enabled, streamers (or DJs) will be able to connect directly to your stream and broadcast live music that interrupts the AutoDJ stream.'
),
'selected_text' => __('Yes'),
'deselected_text' => __('No'),
'default' => false,
'form_group_class' => 'col-md-12',
],
],
StationBackendConfiguration::RECORD_STREAMS => [
'toggle',
[
'label' => __('Record Live Broadcasts'),
'description' => __(
'If enabled, AzuraCast will automatically record any live broadcasts made to this station to per-broadcast recordings.'
),
'selected_text' => __('Yes'),
'deselected_text' => __('No'),
'default' => false,
'belongsTo' => 'backend_config',
'form_group_class' => 'col-md-4',
],
],
StationBackendConfiguration::RECORD_STREAMS_FORMAT => [
'radio',
[
'label' => __('Live Broadcast Recording Format'),
'choices' => [
StationMountInterface::FORMAT_MP3 => 'MP3',
StationMountInterface::FORMAT_OGG => 'OGG Vorbis',
StationMountInterface::FORMAT_OPUS => 'OGG Opus',
StationMountInterface::FORMAT_AAC => 'AAC+ (MPEG4 HE-AAC v2)',
],
'default' => StationMountInterface::FORMAT_MP3,
'belongsTo' => 'backend_config',
'form_group_class' => 'col-md-4',
],
],
'record_streams_bitrate' => [
'radio',
[
'label' => __('Live Broadcast Recording Bitrate (kbps)'),
'choices' => [
32 => '32',
48 => '48',
64 => '64',
96 => '96',
128 => '128',
192 => '192',
256 => '256',
320 => '320',
],
'default' => 128,
'belongsTo' => 'backend_config',
'form_group_class' => 'col-md-4',
],
],
'disconnect_deactivate_streamer' => [
'number',
[
'label' => __('Deactivate Streamer on Disconnect (Seconds)'),
'description' => __(
'Number of seconds to deactivate station streamer on manual disconnect. Set to 0 to disable deactivation completely.'
),
'default' => 0,
'min' => '0',
'step' => '1',
'form_group_class' => 'col-md-4',
],
],
StationBackendConfiguration::DJ_PORT => [
'text',
[
'label' => __('Customize DJ/Streamer Port'),
'label_class' => 'advanced',
'description' => __(
'No other program can be using this port. Leave blank to automatically assign a port.<br><b>Note:</b> The port after this one (n+1) will automatically be used for legacy connections.'
),
'belongsTo' => 'backend_config',
'form_group_class' => 'col-md-6',
],
],
StationBackendConfiguration::TELNET_PORT => [
'text',
[
'label' => __('Customize Internal Request Processing Port'),
'label_class' => 'advanced',
'description' => __(
'This port is not used by any external process. Only modify this port if the assigned port is in use. Leave blank to automatically assign a port.'
),
'belongsTo' => 'backend_config',
'form_group_class' => 'col-md-6',
],
],
'dj_buffer' => [
'number',
[
'label' => __('DJ/Streamer Buffer Time (Seconds)'),
'description' => __(
'The number of seconds of signal to store in case of interruption. Set to the lowest value that your DJs can use without stream interruptions.'
),
'default' => 5,
'min' => 0,
'max' => 60,
'step' => 1,
'belongsTo' => 'backend_config',
'form_group_class' => 'col-md-6',
],
],
StationBackendConfiguration::DJ_MOUNT_POINT => [
'text',
[
'label' => __('Customize DJ/Streamer Mount Point'),
'label_class' => 'advanced',
'description' => __(
'If your streaming software requires a specific mount point path, specify it here. Otherwise, use the default.'
),
'belongsTo' => 'backend_config',
'default' => '/',
'form_group_class' => 'col-md-6',
],
],
StationBackendConfiguration::USE_REPLAYGAIN => [
'toggle',
[
'label' => __('Use Replaygain Metadata'),
'label_class' => 'advanced',
'belongsTo' => 'backend_config',
'description' => __(
'Instruct Liquidsoap to use any replaygain metadata associated with a song to control its volume level.'
),
'selected_text' => __('Yes'),
'deselected_text' => __('No'),
'default' => false,
'form_group_class' => 'col-md-6',
],
],
StationBackendConfiguration::AUTODJ_QUEUE_LENGTH => [
'number',
[
'label' => __('AutoDJ Queue Length'),
'description' => __(
'If using AzuraCast\'s AutoDJ, this determines how many songs in advance the AutoDJ will automatically fill the queue.'
),
'default' => StationBackendConfiguration::DEFAULT_QUEUE_LENGTH,
'min' => 1,
'max' => 25,
'belongsTo' => 'backend_config',
'form_group_class' => 'col-md-6',
],
],
StationBackendConfiguration::USE_MANUAL_AUTODJ => [
'toggle',
[
'label' => __('Manual AutoDJ Mode'),
'label_class' => 'advanced',
'description' => __(
'This mode disables AzuraCast\'s AutoDJ management, using Liquidsoap itself to manage song playback. "Next Song" and some other features will not be available.'
),
'selected_text' => __('Yes'),
'deselected_text' => __('No'),
'default' => false,
'belongsTo' => 'backend_config',
'form_group_class' => 'col-md-6',
],
],
StationBackendConfiguration::CHARSET => [
'radio',
[
'label' => __('Character Set Encoding'),
'label_class' => 'advanced',
'description' => __(
'For most cases, use the default UTF-8 encoding. The older ISO-8859-1 encoding can be used if accepting connections from SHOUTcast 1 DJs or using other legacy software.'
),
'belongsTo' => 'backend_config',
'default' => 'UTF-8',
'choices' => [
'UTF-8' => 'UTF-8',
'ISO-8859-1' => 'ISO-8859-1',
],
'form_group_class' => 'col-md-6',
],
],
StationBackendConfiguration::DUPLICATE_PREVENTION_TIME_RANGE => [
'number',
[
'label' => __('Duplicate Prevention Time Range (Minutes)'),
'description' => __(
'This specifies the time range (in minutes) of the song history that the duplicate song prevention algorithm should take into account.'
),
'belongsTo' => 'backend_config',
'default' => StationBackendConfiguration::DEFAULT_DUPLICATE_PREVENTION_TIME_RANGE,
'min' => '0',
'max' => '1440',
'form_group_class' => 'col-md-6',
],
],
],
],
'admin' => [
'use_grid' => true,
'tab' => 'admin',
'elements' => [
'media_storage_location_id' => [
'select',
[
'label' => __('Media Storage Location'),
'choices' => [],
'form_group_class' => 'col-md-6',
],
],
'recordings_storage_location_id' => [
'select',
[
'label' => __('Live Recordings Storage Location'),
'choices' => [],
'form_group_class' => 'col-md-6',
],
],
'podcasts_storage_location_id' => [
'select',
[
'label' => __('Podcasts Storage Location'),
'choices' => [],
'form_group_class' => 'col-md-6',
],
],
'is_enabled' => [
'toggle',
[
'label' => __('Enable Broadcasting'),
'description' => __('If disabled, the station will not broadcast or shuffle its AutoDJ.'),
'selected_text' => __('Yes'),
'deselected_text' => __('No'),
'default' => true,
'form_group_class' => 'col-md-6',
],
],
'radio_base_dir' => [
'text',
[
'label' => __('Base Station Directory'),
'label_class' => 'advanced',
'description' => __(
'The parent directory where station playlist and configuration files are stored. Leave blank to use default directory.'
),
'form_group_class' => 'col-md-6',
],
],
],
],
'submit_grp' => [
'elements' => [
'submit' => [
'submit',
[
'type' => 'submit',
'label' => __('Save Changes'),
'class' => 'btn btn-lg btn-primary',
],
],
],
],
],
];