Disc Control menu refactor

Author: sonninnos

command.c

@@ -2369,17 +2369,6 @@ bool command_event_disk_control_append_image(
       autosave_deinit();
 #endif
 
-   /* TODO/FIXME: Need to figure out what to do with subsystems case. */
-   if (path_is_empty(RARCH_PATH_SUBSYSTEM))
-   {
-      /* Update paths for our new image.
-       * If we actually use append_image, we assume that we
-       * started out in a single disk case, and that this way
-       * of doing it makes the most sense. */
-      path_set(RARCH_PATH_NAMES, path);
-      runloop_path_fill_names();
-   }
-
    command_event(CMD_EVENT_AUTOSAVE_INIT, NULL);
 
    return true;

disk_control_interface.c

@@ -342,25 +342,19 @@ bool disk_control_set_eject_state(
    size_t _len;
 
    if (!disk_control || !disk_control->cb.set_eject_state)
-      return false;
+      return err;
 
    /* Set eject state */
    if (disk_control->cb.set_eject_state(eject))
-      _len  = strlcpy(
-            msg,
-            eject
-            ? msg_hash_to_str(MSG_DISK_EJECTED)
-            : msg_hash_to_str(MSG_DISK_CLOSED),
-              sizeof(msg));
+      _len = strlcpy(msg,
+            eject ? msg_hash_to_str(MSG_DISK_EJECTED) : msg_hash_to_str(MSG_DISK_CLOSED),
+            sizeof(msg));
    else
    {
       err  = true;
-      _len = strlcpy(
-            msg,
-            eject
-            ? msg_hash_to_str(MSG_VIRTUAL_DISK_TRAY_EJECT)
-            : msg_hash_to_str(MSG_VIRTUAL_DISK_TRAY_CLOSE),
-              sizeof(msg));
+      _len = strlcpy(msg,
+            eject ? msg_hash_to_str(MSG_VIRTUAL_DISK_TRAY_EJECT) : msg_hash_to_str(MSG_VIRTUAL_DISK_TRAY_CLOSE),
+            sizeof(msg));
    }
 
    if (_len > 0)
@@ -398,9 +392,9 @@ bool disk_control_set_eject_state(
 /**
  * disk_control_set_index:
  *
- * Sets currently selected disk index
- *
- * NOTE: Will fail if disk is not currently ejected
+ * Sets currently selected disk index.
+ * Does silent eject and delayed insert with
+ * 'runloop_st->pending_disk_control_insert' if tray is closed.
  **/
 bool disk_control_set_index(
       disk_control_interface_t *disk_control,
@@ -414,17 +408,26 @@ bool disk_control_set_index(
 
    msg[0] = '\0';
 
-   if (!disk_control)
-      return false;
+   if (     !disk_control
+         || !disk_control->cb.get_eject_state
+         || !disk_control->cb.get_num_images
+         || !disk_control->cb.get_image_index
+         || !disk_control->cb.set_image_index)
+      return err;
 
-   if (   !disk_control->cb.get_eject_state
-       || !disk_control->cb.get_num_images
-       || !disk_control->cb.set_image_index)
-      return false;
+   /* Do nothing if the desired disc is already in */
+   if (disk_control->cb.get_image_index() == index)
+      return !err;
 
-   /* Ensure that disk is currently ejected */
+   /* Do delayed disk insert if changing while not ejected */
    if (!disk_control->cb.get_eject_state())
-      return false;
+   {
+      runloop_state_t *runloop_st = runloop_state_get_ptr();
+
+      if (     runloop_st
+            && disk_control_set_eject_state(disk_control, true, false))
+         runloop_st->pending_disk_control_insert = 100;
+   }
 
    /* Get current number of disk images */
    num_images = disk_control->cb.get_num_images();
@@ -466,7 +469,6 @@ bool disk_control_set_index(
           && disk_control->cb.get_image_path)
       {
          char new_image_path[PATH_MAX_LENGTH] = {0};
-         /* Get current image index + path */
          unsigned new_image_index = disk_control->cb.get_image_index();
          bool image_path_valid    = disk_control->cb.get_image_path(
                new_image_index, new_image_path, sizeof(new_image_path));
@@ -618,22 +620,22 @@ bool disk_control_append_image(
 
    if ((new_index = disk_control->cb.get_num_images()) < 1)
       goto error;
-   new_index--;
 
+   new_index--;
    info.path = image_path;
-   if (!disk_control->cb.replace_image_index(new_index, &info))
-      goto error;
 
-   /* Set new index */
-   if (!disk_control_set_index(disk_control, new_index, false))
+   if (!disk_control->cb.replace_image_index(new_index, &info))
       goto error;
 
-   /* If tray was initially closed, insert disk
-    * (i.e. leave system in the state we found it) */
+   /* If tray was initially closed, insert disk */
    if (   !initial_disk_ejected
        && !disk_control_set_eject_state(disk_control, false, false))
       goto error;
 
+   /* Set new index */
+   if (!disk_control_set_index(disk_control, new_index, false))
+      goto error;
+
    /* Display log */
    _len        = strlcpy(msg, msg_hash_to_str(MSG_APPENDED_DISK), sizeof(msg) - 3);
    msg[  _len] = ':';
@@ -658,11 +660,7 @@ bool disk_control_append_image(
     * NOTE: If this fails then it's game over -
     * just display the error notification and
     * hope for the best... */
-   if (!disk_control->cb.get_eject_state())
-      disk_control_set_eject_state(disk_control, true, false);
    disk_control_set_index(disk_control, initial_index, false);
-   if (!initial_disk_ejected)
-      disk_control_set_eject_state(disk_control, false, false);
 
    _len        = strlcpy(msg,
          msg_hash_to_str(MSG_FAILED_TO_APPEND_DISK), sizeof(msg) - 3);
@@ -672,7 +670,7 @@ bool disk_control_append_image(
    _len += strlcpy(msg + _len, image_filename, sizeof(msg) - _len);
 
    runloop_msg_queue_push(msg, _len, 2, 180, true, NULL,
-         MESSAGE_QUEUE_ICON_DEFAULT, MESSAGE_QUEUE_CATEGORY_WARNING);
+         MESSAGE_QUEUE_ICON_DEFAULT, MESSAGE_QUEUE_CATEGORY_ERROR);
 
    return false;
 }

intl/msg_hash_us.h

@@ -4050,15 +4050,15 @@ MSG_HASH(
    )
 MSG_HASH(
    MENU_ENUM_SUBLABEL_INPUT_META_DISK_NEXT,
-   "Increments the currently selected disc index. Virtual disc tray must be open."
+   "Increments the currently selected disc index and does delayed insert if virtual disc tray is closed."
    )
 MSG_HASH(
    MENU_ENUM_LABEL_VALUE_INPUT_META_DISK_PREV,
    "Previous Disc"
    )
 MSG_HASH(
    MENU_ENUM_SUBLABEL_INPUT_META_DISK_PREV,
-   "Decrements the currently selected disc index. Virtual disc tray must be open."
+   "Decrements the currently selected disc index and does delayed insert if virtual disc tray is closed."
    )
 
 MSG_HASH(
@@ -10084,41 +10084,42 @@ MSG_HASH(
 
 /* Quick Menu > Disc Control */
 
+MSG_HASH(
+   MENU_ENUM_LABEL_VALUE_DISK_INDEX,
+   "Current Disc Index"
+   )
+MSG_HASH(
+   MENU_ENUM_SUBLABEL_DISK_INDEX,
+   "Choose current disc from list of available images. Virtual disc tray can stay closed."
+   )
 MSG_HASH(
    MENU_ENUM_LABEL_VALUE_DISK_TRAY_EJECT,
    "Eject Disc"
    )
 MSG_HASH(
    MENU_ENUM_SUBLABEL_DISK_TRAY_EJECT,
-   "Open virtual disc tray and remove currently loaded disc. If 'Pause Content When Menu Is Active' is enabled, some cores may not register changes unless content is resumed for a few seconds after each disc control action."
+   "Open virtual disc tray."
    )
 MSG_HASH(
    MENU_ENUM_LABEL_VALUE_DISK_TRAY_INSERT,
    "Insert Disc"
    )
 MSG_HASH(
    MENU_ENUM_SUBLABEL_DISK_TRAY_INSERT,
-   "Insert disc corresponding to 'Current Disc Index' and close virtual disc tray. If 'Pause Content When Menu Is Active' is enabled, some cores may not register changes unless content is resumed for a few seconds after each disc control action."
+   "Close virtual disc tray."
    )
 MSG_HASH(
    MENU_ENUM_LABEL_VALUE_DISK_IMAGE_APPEND,
    "Load New Disc"
    )
 MSG_HASH(
    MENU_ENUM_SUBLABEL_DISK_IMAGE_APPEND,
-   "Eject current disc, select a new disc from the filesystem then insert it and close the virtual disc tray.\nNOTE: This is a legacy feature. It is instead recommended to load multi-disc titles via M3U playlists, which allow disc selection using the 'Eject/Insert Disc' and 'Current Disc Index' options."
+   "Select a new disc from the filesystem and append it in the index list.\nNOTE: This is a legacy feature. It is instead recommended to use M3U playlists for multi-disc titles."
    )
+/* deprecated */
 MSG_HASH(
    MENU_ENUM_SUBLABEL_DISK_IMAGE_APPEND_TRAY_OPEN,
-   "Select a new disc from the filesystem and insert it without closing the virtual disc tray.\nNOTE: This is a legacy feature. It is instead recommended to load multi-disc titles via M3U playlists, which allow disc selection using the 'Current Disc Index' option."
-   )
-MSG_HASH(
-   MENU_ENUM_LABEL_VALUE_DISK_INDEX,
-   "Current Disc Index"
-   )
-MSG_HASH(
-   MENU_ENUM_SUBLABEL_DISK_INDEX,
-   "Choose current disc from list of available images. Disc will be loaded when 'Insert Disc' is selected."
+   ""
    )
 
 /* Quick Menu > Shaders */

menu/cbs/menu_cbs_ok.c

@@ -7518,16 +7518,33 @@ static int action_ok_push_dropdown_item_manual_content_scan_core_name(
 static int action_ok_push_dropdown_item_disk_index(const char *path,
       const char *label, unsigned type, size_t idx, size_t entry_idx)
 {
-   struct menu_state *menu_st = menu_state_get_ptr();
-   unsigned disk_index        = (unsigned)idx;
+   unsigned disk_index           = (unsigned)idx;
+   rarch_system_info_t *sys_info = &runloop_state_get_ptr()->system;
+   settings_t *settings          = config_get_ptr();
+   bool menu_insert_disk_resume  = settings->bools.menu_insert_disk_resume;
+   bool disk_ejected             = false;
+
+   if (!settings || !sys_info)
+      return -1;
+
+#ifdef HAVE_AUDIOMIXER
+   if (settings->bools.audio_enable_menu && settings->bools.audio_enable_menu_ok)
+      audio_driver_mixer_play_menu_sound(AUDIO_MIXER_SYSTEM_SLOT_OK);
+#endif
+
+   /* Get disk eject state *before* toggling drive status */
+   if (sys_info)
+      disk_ejected = disk_control_get_eject_state(&sys_info->disk_control);
 
    command_event(CMD_EVENT_DISK_INDEX, &disk_index);
 
-   /* When choosing a disk, menu selection should
-    * automatically be reset to the 'insert disk'
-    * option */
-   menu_entries_pop_stack(NULL, 0, 1);
-   menu_st->selection_ptr = 0;
+   /* If disk is now inserted and user has enabled
+    * 'menu_insert_disk_resume', resume running content */
+   if (!disk_ejected && menu_insert_disk_resume)
+      generic_action_ok_command(CMD_EVENT_RESUME);
+
+   /* In all cases, return to the disk options menu */
+   menu_entries_flush_stack(msg_hash_to_str(MENU_ENUM_LABEL_DISK_OPTIONS), 0);
 
    return 0;
 }
@@ -8208,52 +8225,30 @@ static int action_ok_input_description_kbd_dropdown_box_list(
 static int action_ok_disk_cycle_tray_status(const char *path,
       const char *label, unsigned type, size_t idx, size_t entry_idx)
 {
-   bool disk_ejected              = false;
-   bool print_log                 = false;
-   struct menu_state *menu_st     = menu_state_get_ptr();
-   rarch_system_info_t *sys_info  = &runloop_state_get_ptr()->system;
-   settings_t *settings           = config_get_ptr();
-#ifdef HAVE_AUDIOMIXER
-   bool audio_enable_menu         = settings->bools.audio_enable_menu;
-   bool audio_enable_menu_ok      = settings->bools.audio_enable_menu_ok;
-#endif
-   bool menu_insert_disk_resume   = settings->bools.menu_insert_disk_resume;
+   rarch_system_info_t *sys_info = &runloop_state_get_ptr()->system;
+   settings_t *settings          = config_get_ptr();
+   bool menu_insert_disk_resume  = settings->bools.menu_insert_disk_resume;
+   bool verbosity                = false;
 
-   if (!settings)
+   if (!settings || !sys_info)
       return -1;
 
 #ifdef HAVE_AUDIOMIXER
-   if (audio_enable_menu && audio_enable_menu_ok)
+   if (settings->bools.audio_enable_menu && settings->bools.audio_enable_menu_ok)
       audio_driver_mixer_play_menu_sound(AUDIO_MIXER_SYSTEM_SLOT_OK);
 #endif
 
-   /* Get disk eject state *before* toggling drive status */
-   if (sys_info)
-      disk_ejected = disk_control_get_eject_state(&sys_info->disk_control);
-
    /* Only want to display a notification if we are
     * going to resume content immediately after
     * inserting a disk (i.e. if quick menu remains
     * open, there is sufficient visual feedback
     * without a notification) */
-   print_log = menu_insert_disk_resume && disk_ejected;
+   verbosity = menu_insert_disk_resume;
 
-   if (!command_event(CMD_EVENT_DISK_EJECT_TOGGLE, &print_log))
+   if (!command_event(CMD_EVENT_DISK_EJECT_TOGGLE, &verbosity))
       return -1;
 
-   /* If we reach this point, then tray toggle
-    * was successful */
-   disk_ejected = !disk_ejected;
-
-   /* If disk is now ejected, menu selection should
-    * automatically increment to the 'current disk
-    * index' option */
-   if (disk_ejected)
-      menu_st->selection_ptr = 1;
-
-   /* If disk is now inserted and user has enabled
-    * 'menu_insert_disk_resume', resume running content */
-   if (!disk_ejected && menu_insert_disk_resume)
+   if (menu_insert_disk_resume)
       generic_action_ok_command(CMD_EVENT_RESUME);
 
    return 0;
@@ -8265,19 +8260,15 @@ static int action_ok_disk_image_append(const char *path,
    rarch_system_info_t *sys_info = &runloop_state_get_ptr()->system;
    struct menu_state *menu_st    = menu_state_get_ptr();
    menu_handle_t *menu           = menu_st->driver_data;
-   const char *menu_path         = NULL;
    settings_t *settings          = config_get_ptr();
-#ifdef HAVE_AUDIOMIXER
-   bool audio_enable_menu        = settings->bools.audio_enable_menu;
-   bool audio_enable_menu_ok     = settings->bools.audio_enable_menu_ok;
-#endif
    bool menu_insert_disk_resume  = settings->bools.menu_insert_disk_resume;
+   const char *menu_path         = NULL;
 
-   if (!menu)
+   if (!menu || !settings || !sys_info)
       return -1;
 
 #ifdef HAVE_AUDIOMIXER
-   if (audio_enable_menu && audio_enable_menu_ok)
+   if (settings->bools.audio_enable_menu && settings->bools.audio_enable_menu_ok)
       audio_driver_mixer_play_menu_sound(AUDIO_MIXER_SYSTEM_SLOT_OK);
 #endif
 
@@ -8288,9 +8279,9 @@ static int action_ok_disk_image_append(const char *path,
    if (!string_is_empty(menu_path))
    {
       char image_path[PATH_MAX_LENGTH];
-      bool is_dir = (entry_idx == FILE_TYPE_USE_DIRECTORY
-            && string_is_equal(label,
-                     msg_hash_to_str(MENU_ENUM_LABEL_USE_THIS_DIRECTORY)));
+      bool is_dir = entry_idx == FILE_TYPE_USE_DIRECTORY
+            && string_is_equal(label, msg_hash_to_str(MENU_ENUM_LABEL_USE_THIS_DIRECTORY));
+
       if (is_dir)
       {
          size_t past_slash;
@@ -8304,22 +8295,17 @@ static int action_ok_disk_image_append(const char *path,
                menu_path, path, sizeof(image_path));
       else
          strlcpy(image_path, menu_path, sizeof(image_path));
+
       /* Append image */
       command_event(CMD_EVENT_DISK_APPEND_IMAGE, image_path);
    }
 
+   if (menu_insert_disk_resume && !disk_control_get_eject_state(&sys_info->disk_control))
+      generic_action_ok_command(CMD_EVENT_RESUME);
+
    /* In all cases, return to the disk options menu */
    menu_entries_flush_stack(msg_hash_to_str(MENU_ENUM_LABEL_DISK_OPTIONS), 0);
 
-   /* > If disk tray is open, reset menu selection to
-    *   the 'insert disk' option
-    * > If disk try is closed and user has enabled
-    *   'menu_insert_disk_resume', resume running content */
-   if (sys_info && disk_control_get_eject_state(&sys_info->disk_control))
-      menu_st->selection_ptr = 0;
-   else if (menu_insert_disk_resume)
-      generic_action_ok_command(CMD_EVENT_RESUME);
-
    return 0;
 }