Source: modalPlayback.js

  1. "use strict";
  2. // SPDX-License-Identifier: GPL-3.0-or-later
  3. // myMPD (c) 2018-2025 Juergen Mang <mail@jcgames.de>
  4. // https://github.com/jcorporation/mympd
  6. /** @module modalPlayback_js */
  8. /**
  9.  * Initialization function for the playback settings elements
  10.  * @returns {void}
  11.  */
  12. function initModalSettingsPlayback() {
  13.     // cache for the form field containers
  14.     const forms = {};
  15.     // create the fields
  16.     createForm(settingsPlaybackFields, 'modalPlayback', forms);
  17.     initElements(elGetById('modalPlayback'));
  19.     uiElements.modalPlaybackJukeboxCollapse = BSN.Collapse.getInstance(elGetById('modalPlaybackJukeboxCollapse'));
  21.     elGetById('modalPlaybackJukeboxModeGroup').addEventListener('mouseup', function() {
  22.         setTimeout(function() {
  23.             toggleJukeboxSettings();
  24.             checkConsume();
  25.         }, 100);
  26.     });
  28.     elGetById('modalPlaybackConsumeGroup').addEventListener('mouseup', function() {
  29.         setTimeout(function() {
  30.             checkConsume();
  31.         }, 100);
  32.     });
  34.     elGetById('modalPlaybackPresetsList').addEventListener('click', function(event) {
  35.         event.stopPropagation();
  36.         event.preventDefault();
  37.         if (event.target.nodeName === 'TD') {
  38.             if (event.target.parentNode.classList.contains('not-clickable') === false) {
  39.                 // @ts-ignore
  40.                 btnWaiting(event.target, true);
  41.                 applyPreset(getData(event.target.parentNode, 'name'));
  42.             }
  43.         }
  44.         else if (event.target.nodeName === 'A') {
  45.             deletePreset(event.target, getData(event.target.parentNode.parentNode, 'name'));
  46.         }
  47.     }, false);
  49.     elGetById('modalPlayback').addEventListener('show.bs.modal', function() {
  50.         getSettings(function(obj) {
  51.             if (parseSettings(obj) === true) {
  52.                 cleanupModalId('modalPlayback');
  53.                 populatePlaybackFrm();
  54.             }
  55.         });
  56.     });
  57. }
  59. /**
  60.  * Populates the presets lists
  61.  * @returns {void}
  62.  */
  63. function populateListPresets() {
  64.     const presetsEl = elGetById('modalPlaybackNameInput');
  65.     presetsEl.value = '';
  66.     setData(presetsEl, 'value', '');
  67.     elClear(presetsEl.filterResult);
  68.     const table = elGetById('modalPlaybackPresetsList');
  69.     const presetsList = table.querySelector('tbody');
  70.     elClear(presetsList);
  71.     for (const preset of settings.partition.presets) {
  72.         presetsEl.addFilterResultPlain(preset);
  73.         presetsList.appendChild(createPresetsListRow(preset));
  74.     }
  75.     if (settings.partition.presets.length === 0) {
  76.         presetsList.appendChild(emptyMsgEl(2, 'table'));
  77.     }
  78.     populatePresetDropdowns();
  79. }
  81. /**
  82.  * Toggles the mpd playback mode
  83.  * @param {string} option playback option to toggle
  84.  * @returns {void}
  85.  */
  86. //eslint-disable-next-line no-unused-vars
  87. function togglePlaymode(option) {
  88.     let value;
  89.     let title;
  90.     switch(option) {
  91.         case 'random':
  92.         case 'repeat':
  93.             if (settings.partition[option] === true) {
  94.                 value = false;
  95.                 title = 'Disable ' + option;
  96.             }
  97.             else {
  98.                 value = true;
  99.                 title = 'Enable ' + option;
  100.             }
  101.             break;
  102.         case 'consume':
  103.             if (settings.partition.consume === '0') {
  104.                 if (features.featConsumeOneshot === true) {
  105.                     value = 'oneshot';
  106.                     title = 'Enable consume oneshot';
  107.                 }
  108.                 else {
  109.                     value = '1';
  110.                     title = 'Enable consume mode';
  111.                 }
  112.             }
  113.             else if (settings.partition.consume === 'oneshot') {
  114.                 value = '1';
  115.                 title = 'Enable consume mode';
  116.             }
  117.             else if (settings.partition.consume === '1') {
  118.                 value = '0';
  119.                 title = 'Disable consume mode';
  120.             }
  121.             break;
  122.         case 'single':
  123.             if (settings.partition.single === '0') {
  124.                 value = 'oneshot';
  125.                 title = 'Enable single oneshot';
  126.             }
  127.             else if (settings.partition.single === 'oneshot') {
  128.                 value = '1';
  129.                 title = 'Enable single mode';
  130.             }
  131.             else if (settings.partition.single === '1') {
  132.                 value = '0';
  133.                 title = 'Disable single mode';
  134.             }
  135.             break;
  136.         default:
  137.             logError('Invalid playmode option: ' + option);
  138.     }
  139.     const params = {};
  140.     params[option] = value;
  141.     sendAPI('MYMPD_API_PLAYER_OPTIONS_SET', params, null, false);
  142.     showNotification(tn(title), 'queue', 'info');
  143. }
  145. /**
  146.  * Checks the state of the consume mode
  147.  * @returns {void}
  148.  */
  149. function checkConsume() {
  150.     const stateConsume = getBtnGroupValueId('modalPlaybackConsumeGroup');
  151.     const stateJukeboxMode = getBtnGroupValueId('modalPlaybackJukeboxModeGroup');
  152.     if (stateJukeboxMode !== 'off' &&
  153.         stateConsume !== '1')
  154.     {
  155.         elShowId('modalPlaybackConsumeWarn');
  156.     }
  157.     else {
  158.         elHideId('modalPlaybackConsumeWarn');
  159.     }
  160. }
  162. /**
  163.  * Toggle jukebox setting elements
  164.  * @returns {void}
  165.  */
  166. function toggleJukeboxSettings() {
  167.     const value = getBtnGroupValueId('modalPlaybackJukeboxModeGroup');
  168.     const songOnlyInputs = elGetById('modalPlaybackJukeboxCollapse').querySelectorAll('.jukeboxSongOnly');
  169.     if (value === 'album') {
  170.         elGetById('modalPlaybackJukeboxQueueLengthInput').value = '1';
  171.         toggleBtnChkId('modalPlaybackJukeboxIgnoreHatedInput', false);
  172.         elGetById('modalPlaybackJukeboxPlaylistInput').value = tn('Database');
  173.         setDataId('modalPlaybackJukeboxPlaylistInput', 'value', 'Database');
  174.         const select = elGetById('modalPlaybackJukeboxUniqTagInput');
  175.         elClear(select);
  176.         for (const tag of ['Album', tagAlbumArtist]) {
  177.             select.appendChild(
  178.                 elCreateTextTn('option', {"value": tag}, tag)
  179.             );
  180.         }
  181.         // hide rows that are not configurable in jukebox album mode
  182.         for (const input of songOnlyInputs) {
  183.             elHide(input.closest('.row'));
  184.         }
  185.     }
  186.     else if (value === 'song') {
  187.         addTagListSelect('modalPlaybackJukeboxUniqTagInput', 'tagListBrowse');
  188.         // show rows that are configurable in jukebox song mode only
  189.         for (const input of songOnlyInputs) {
  190.             elShow(input.closest('.row'));
  191.         }
  192.     }
  193.     if (value !== 'off') {
  194.         toggleBtnGroupValueId('modalPlaybackConsumeGroup', '1');
  195.         toggleBtnGroupValueId('modalPlaybackSingleGroup', '0');
  196.     }
  198.     if (features.featStickers === false) {
  199.         elShowId('modalPlaybackPlaybackStatisticsWarn');
  200.         elHide(elGetById('modalPlaybackJukeboxLastPlayedInput').closest('.row'));
  201.         elHide(elGetById('modalPlaybackJukeboxIgnoreHatedInput').closest('.row'));
  202.         toggleBtnChkId('modalPlaybackJukeboxIgnoreHatedInput', false);
  203.     }
  204.     else {
  205.         elHideId('modalPlaybackPlaybackStatisticsWarn');
  206.         elShow(elGetById('modalPlaybackJukeboxLastPlayedInput').closest('.row'));
  207.     }
  208. }
  210. /**
  211.  * Creates a row for the presets tables
  212.  * @param {string} preset preset name
  213.  * @returns {HTMLElement} the row
  214.  */
  215. function createPresetsListRow(preset) {
  216.     const row = elCreateNodes('tr', {"data-title-phrase": "Load preset", "title": tn("Load preset")}, [
  217.         elCreateText('td', {}, preset),
  218.         elCreateNode('td', {"data-col": "Action"},
  219.             elCreateText('a', {"class": ["mi", "color-darkgrey"], "href": "#", "data-title-phrase": "Delete", "phrase": tn('Delete')}, 'delete')
  220.         )
  221.     ]);
  222.     setData(row, 'name', preset);
  223.     return row;
  224. }
  226. /**
  227.  * Populates the playback settings modal
  228.  * @returns {void}
  229.  */
  230. function populatePlaybackFrm() {
  231.     jsonToForm(settings.partition, settingsPlaybackFields, 'modalPlayback');
  233.     toggleBtnGroupValueCollapse(elGetById('modalPlaybackJukeboxModeGroup'), 'modalPlaybackJukeboxCollapse', settings.partition.jukeboxMode);
  234.     toggleJukeboxSettings();
  235.     elGetById('modalPlaybackJukeboxUniqTagInput').value = settings.partition.jukeboxUniqTag;
  237.     populateListPresets();
  239.     if (settings.partition.mpdConnected === true) {
  240.         if (features.featPlaylists === true) {
  241.             filterPlaylistsSelect(0, 'modalPlaybackJukeboxPlaylistInput', '', settings.partition.jukeboxPlaylist);
  242.             setDataId('modalPlaybackJukeboxPlaylistInput', 'value', settings.partition.jukeboxPlaylist);
  243.         }
  244.         else {
  245.             elGetById('modalPlaybackJukeboxPlaylistInput').value = tn('Database');
  246.             setDataId('modalPlaybackJukeboxPlaylistInput', 'value', 'Database');
  247.         }
  248.         toggleBtnGroupValueId('modalPlaybackConsumeGroup', settings.partition.consume);
  249.         toggleBtnGroupValueId('modalPlaybackSingleGroup', settings.partition.single);
  250.         toggleBtnGroupValueId('modalPlaybackReplaygainGroup', settings.partition.replaygain);
  251.         if (features.featTags === false) {
  252.             elGetById('modalPlaybackJukeboxModeGroup').children[1].classList.add('rounded-end');
  253.         }
  254.         else {
  255.             elGetById('modalPlaybackJukeboxModeGroup').children[1].classList.remove('rounded-end');
  256.         }
  257.     }
  258.     checkConsume();
  259. }
  261. /**
  262.  * Saves the playback settings
  263.  * @param {Element} target triggering element
  264.  * @returns {void}
  265.  */
  266. //eslint-disable-next-line no-unused-vars
  267. function saveSettingsPlayback(target) {
  268.     cleanupModalId('modalPlayback');
  269.     const params = {};
  270.     if (formToJson('modalPlayback', params, settingsPlaybackFields) === true) {
  271.         params.jukeboxMode = getBtnGroupValueId('modalPlaybackJukeboxModeGroup');
  272.         params.consume = getBtnGroupValueId('modalPlaybackConsumeGroup');
  273.         params.single = getBtnGroupValueId('modalPlaybackSingleGroup');
  274.         params.replaygain = getBtnGroupValueId('modalPlaybackReplaygainGroup');
  275.         //set preset name to blank string if not defined, else it is not send to the api
  276.         params.name = getDataId('modalPlaybackNameInput', 'value');
  277.         if (params.name === undefined) {
  278.             params.name = '';
  279.         }
  280.         btnWaiting(target, true);
  281.         sendAPI("MYMPD_API_PLAYER_OPTIONS_SET", params, modalClose, true);
  282.     }
  283. }