apps/onplay.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 Björn Stenberg
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21 #include <errno.h>
  22 #include <stdio.h>
  23 #include <string.h>
  24 #include <stdlib.h>
  25 #include <stdbool.h>
  26
  27 #include "debug.h"
  28 #include "lcd.h"
  29 #include "dir.h"
  30 #include "file.h"
  31 #include "audio.h"
  32 #include "menu.h"
  33 #include "lang.h"
  34 #include "playlist.h"
  35 #include "button.h"
  36 #include "kernel.h"
  37 #include "keyboard.h"
  38 #include "mp3data.h"
  39 #include "metadata.h"
  40 #include "screens.h"
  41 #include "tree.h"
  42 #include "settings.h"
  43 #include "playlist_viewer.h"
  44 #include "talk.h"
  45 #include "onplay.h"
  46 #include "filetypes.h"
  47 #include "plugin.h"
  48 #include "bookmark.h"
  49 #include "action.h"
  50 #include "splash.h"
  51 #include "yesno.h"
  52 #include "menus/exported_menus.h"
  53 #ifdef HAVE_LCD_BITMAP
  54 #include "icons.h"
  55 #endif
  56 #include "sound_menu.h"
  57 #include "playlist_menu.h"
  58 #include "playlist_catalog.h"
  59 #ifdef HAVE_TAGCACHE
  60 #include "tagtree.h"
  61 #endif
  62 #include "cuesheet.h"
  63 #include "statusbar-skinned.h"
  64 #include "pitchscreen.h"
  65 #include "viewport.h"
  66
  67 static int context;
  68 static char* selected_file = NULL;
  69 static int selected_file_attr = 0;
  70 static int onplay_result = ONPLAY_OK;
  71 static char clipboard_selection[MAX_PATH];
  72 static int clipboard_selection_attr = 0;
  73 static bool clipboard_is_copy = false;
  74
  75 /* redefine MAKE_MENU so the MENU_EXITAFTERTHISMENU flag can be added easily */
  76 #define MAKE_ONPLAYMENU( name, str, callback, icon, ... )               \
  77     static const struct menu_item_ex *name##_[]  = {__VA_ARGS__};       \
  78     static const struct menu_callback_with_desc name##__ = {callback,str,icon};\
  79     static const struct menu_item_ex name =                             \
  80         {MT_MENU|MENU_HAS_DESC|MENU_EXITAFTERTHISMENU|                  \
  81          MENU_ITEM_COUNT(sizeof( name##_)/sizeof(*name##_)),            \
  82             { (void*)name##_},{.callback_and_desc = & name##__}};
  83
  84 /* ----------------------------------------------------------------------- */
  85 /* Displays the bookmark menu options for the user to decide.  This is an  */
  86 /* interface function.                                                     */
  87 /* ----------------------------------------------------------------------- */
  88
  89 static int bookmark_menu_callback(int action,
  90                                   const struct menu_item_ex *this_item);
  91 MENUITEM_FUNCTION(bookmark_create_menu_item, 0,
  92                   ID2P(LANG_BOOKMARK_MENU_CREATE),
  93                   bookmark_create_menu, NULL, NULL, Icon_Bookmark);
  94 MENUITEM_FUNCTION(bookmark_load_menu_item, 0,
  95                   ID2P(LANG_BOOKMARK_MENU_LIST),
  96                   bookmark_load_menu, NULL,
  97                   bookmark_menu_callback, Icon_Bookmark);
  98 MAKE_ONPLAYMENU(bookmark_menu, ID2P(LANG_BOOKMARK_MENU),
  99                 bookmark_menu_callback, Icon_Bookmark,
 100                 &bookmark_create_menu_item, &bookmark_load_menu_item);
 101 static int bookmark_menu_callback(int action,
 102                                   const struct menu_item_ex *this_item)
 103 {
 104     switch (action)
 105     {
 106         case ACTION_REQUEST_MENUITEM:
 107             if (this_item == &bookmark_load_menu_item)
 108             {
 109                 if (bookmark_exist() == 0)
 110                     return ACTION_EXIT_MENUITEM;
 111             }
 112             /* hide the bookmark menu if there is no playback */
 113             else if ((audio_status() & AUDIO_STATUS_PLAY) == 0)
 114                 return ACTION_EXIT_MENUITEM;
 115             break;
 116 #ifdef HAVE_LCD_CHARCELLS
 117         case ACTION_ENTER_MENUITEM:
 118             status_set_param(true);
 119             break;
 120 #endif
 121         case ACTION_EXIT_MENUITEM:
 122 #ifdef HAVE_LCD_CHARCELLS
 123             status_set_param(false);
 124 #endif
 125             settings_save();
 126             break;
 127     }
 128     return action;
 129 }
 130
 131 /* CONTEXT_WPS playlist options */
 132 static bool shuffle_playlist(void)
 133 {
 134     playlist_sort(NULL, true);
 135     playlist_randomise(NULL, current_tick, true);
 136
 137     return false;
 138 }
 139 static bool save_playlist(void)
 140 {
 141     save_playlist_screen(NULL);
 142     return false;
 143 }
 144
 145 extern struct menu_item_ex view_cur_playlist; /* from playlist_menu.c */
 146 MENUITEM_FUNCTION(search_playlist_item, 0, ID2P(LANG_SEARCH_IN_PLAYLIST),
 147                   search_playlist, NULL, NULL, Icon_Playlist);
 148 MENUITEM_FUNCTION(playlist_save_item, 0, ID2P(LANG_SAVE_DYNAMIC_PLAYLIST),
 149                   save_playlist, NULL, NULL, Icon_Playlist);
 150 MENUITEM_FUNCTION(reshuffle_item, 0, ID2P(LANG_SHUFFLE_PLAYLIST),
 151                   shuffle_playlist, NULL, NULL, Icon_Playlist);
 152 MAKE_ONPLAYMENU( wps_playlist_menu, ID2P(LANG_PLAYLIST),
 153                  NULL, Icon_Playlist,
 154                  &view_cur_playlist, &search_playlist_item,
 155                  &playlist_save_item, &reshuffle_item
 156                );
 157
 158 /* CONTEXT_[TREE|ID3DB] playlist options */
 159 static bool add_to_playlist(int position, bool queue)
 160 {
 161     bool new_playlist = !(audio_status() & AUDIO_STATUS_PLAY);
 162     const char *lines[] = {
 163         ID2P(LANG_RECURSE_DIRECTORY_QUESTION),
 164         selected_file
 165     };
 166     const struct text_message message={lines, 2};
 167
 168     splash(0, ID2P(LANG_WAIT));
 169
 170     if (new_playlist)
 171         playlist_create(NULL, NULL);
 172
 173     /* always set seed before inserting shuffled */
 174     if (position == PLAYLIST_INSERT_SHUFFLED ||
 175         position == PLAYLIST_INSERT_LAST_SHUFFLED)
 176     {
 177         srand(current_tick);
 178         if (position == PLAYLIST_INSERT_LAST_SHUFFLED)
 179             playlist_set_last_shuffled_start();
 180     }
 181
 182 #ifdef HAVE_TAGCACHE
 183     if (context == CONTEXT_ID3DB)
 184     {
 185         tagtree_insert_selection_playlist(position, queue);
 186     }
 187     else
 188 #endif
 189     {
 190         if ((selected_file_attr & FILE_ATTR_MASK) == FILE_ATTR_AUDIO)
 191             playlist_insert_track(NULL, selected_file, position, queue, true);
 192         else if (selected_file_attr & ATTR_DIRECTORY)
 193         {
 194             bool recurse = false;
 195
 196             if (global_settings.recursive_dir_insert != RECURSE_ASK)
 197                 recurse = (bool)global_settings.recursive_dir_insert;
 198             else
 199             {
 200                 /* Ask if user wants to recurse directory */
 201                 recurse = (gui_syncyesno_run(&message, NULL, NULL)==YESNO_YES);
 202             }
 203
 204             playlist_insert_directory(NULL, selected_file, position, queue,
 205                                       recurse);
 206         }
 207         else if ((selected_file_attr & FILE_ATTR_MASK) == FILE_ATTR_M3U)
 208             playlist_insert_playlist(NULL, selected_file, position, queue);
 209     }
 210
 211     if (new_playlist && (playlist_amount() > 0))
 212     {
 213         /* nothing is currently playing so begin playing what we just
 214            inserted */
 215         if (global_settings.playlist_shuffle)
 216             playlist_shuffle(current_tick, -1);
 217         playlist_start(0,0);
 218         onplay_result = ONPLAY_START_PLAY;
 219     }
 220
 221     return false;
 222 }
 223
 224 static bool view_playlist(void)
 225 {
 226     bool was_playing = audio_status() & AUDIO_STATUS_PLAY;
 227     bool result;
 228
 229     result = playlist_viewer_ex(selected_file);
 230
 231     if (!was_playing && (audio_status() & AUDIO_STATUS_PLAY) &&
 232         onplay_result == ONPLAY_OK)
 233         /* playlist was started from viewer */
 234         onplay_result = ONPLAY_START_PLAY;
 235
 236     return result;
 237 }
 238
 239 static int playlist_insert_func(void *param)
 240 {
 241     if (((intptr_t)param == PLAYLIST_REPLACE) && !warn_on_pl_erase())
 242         return 0;
 243     add_to_playlist((intptr_t)param, false);
 244     return 0;
 245 }
 246
 247 static int playlist_queue_func(void *param)
 248 {
 249     add_to_playlist((intptr_t)param, true);
 250     return 0;
 251 }
 252
 253 static int treeplaylist_wplayback_callback(int action,
 254                                         const struct menu_item_ex* this_item)
 255 {
 256     (void)this_item;
 257     switch (action)
 258     {
 259         case ACTION_REQUEST_MENUITEM:
 260             if (audio_status() & AUDIO_STATUS_PLAY)
 261                 return action;
 262             else
 263                 return ACTION_EXIT_MENUITEM;
 264             break;
 265     }
 266     return action;
 267 }
 268
 269 static int treeplaylist_callback(int action,
 270                                  const struct menu_item_ex *this_item);
 271
 272 /* insert items */
 273 MENUITEM_FUNCTION(i_pl_item, MENU_FUNC_USEPARAM, ID2P(LANG_INSERT),
 274                   playlist_insert_func, (intptr_t*)PLAYLIST_INSERT,
 275                   NULL, Icon_Playlist);
 276 MENUITEM_FUNCTION(i_first_pl_item, MENU_FUNC_USEPARAM, ID2P(LANG_INSERT_FIRST),
 277                   playlist_insert_func, (intptr_t*)PLAYLIST_INSERT_FIRST,
 278                   treeplaylist_wplayback_callback, Icon_Playlist);
 279 MENUITEM_FUNCTION(i_last_pl_item, MENU_FUNC_USEPARAM, ID2P(LANG_INSERT_LAST),
 280                   playlist_insert_func, (intptr_t*)PLAYLIST_INSERT_LAST,
 281                   treeplaylist_wplayback_callback, Icon_Playlist);
 282 MENUITEM_FUNCTION(i_shuf_pl_item, MENU_FUNC_USEPARAM,
 283                   ID2P(LANG_INSERT_SHUFFLED), playlist_insert_func,
 284                   (intptr_t*)PLAYLIST_INSERT_SHUFFLED,
 285                   treeplaylist_callback, Icon_Playlist);
 286 MENUITEM_FUNCTION(i_last_shuf_pl_item, MENU_FUNC_USEPARAM,
 287                   ID2P(LANG_INSERT_LAST_SHUFFLED), playlist_insert_func,
 288                   (intptr_t*)PLAYLIST_INSERT_LAST_SHUFFLED,
 289                   treeplaylist_callback, Icon_Playlist);
 290 /* queue items */
 291 MENUITEM_FUNCTION(q_pl_item, MENU_FUNC_USEPARAM, ID2P(LANG_QUEUE),
 292                   playlist_queue_func, (intptr_t*)PLAYLIST_INSERT,
 293                   treeplaylist_wplayback_callback, Icon_Playlist);
 294 MENUITEM_FUNCTION(q_first_pl_item, MENU_FUNC_USEPARAM, ID2P(LANG_QUEUE_FIRST),
 295                   playlist_queue_func, (intptr_t*)PLAYLIST_INSERT_FIRST,
 296                   treeplaylist_wplayback_callback, Icon_Playlist);
 297 MENUITEM_FUNCTION(q_last_pl_item, MENU_FUNC_USEPARAM, ID2P(LANG_QUEUE_LAST),
 298                   playlist_queue_func, (intptr_t*)PLAYLIST_INSERT_LAST,
 299                   treeplaylist_wplayback_callback, Icon_Playlist);
 300 MENUITEM_FUNCTION(q_shuf_pl_item, MENU_FUNC_USEPARAM,
 301                   ID2P(LANG_QUEUE_SHUFFLED), playlist_queue_func,
 302                   (intptr_t*)PLAYLIST_INSERT_SHUFFLED,
 303                   treeplaylist_wplayback_callback, Icon_Playlist);
 304 MENUITEM_FUNCTION(q_last_shuf_pl_item, MENU_FUNC_USEPARAM,
 305                   ID2P(LANG_QUEUE_LAST_SHUFFLED), playlist_queue_func,
 306                   (intptr_t*)PLAYLIST_INSERT_LAST_SHUFFLED,
 307                   treeplaylist_callback, Icon_Playlist);
 308 /* replace playlist */
 309 MENUITEM_FUNCTION(replace_pl_item, MENU_FUNC_USEPARAM, ID2P(LANG_REPLACE),
 310                   playlist_insert_func, (intptr_t*)PLAYLIST_REPLACE,
 311                   treeplaylist_wplayback_callback, Icon_Playlist);
 312
 313 /* others */
 314 MENUITEM_FUNCTION(view_playlist_item, 0, ID2P(LANG_VIEW),
 315                   view_playlist, NULL,
 316                   treeplaylist_callback, Icon_Playlist);
 317
 318 MAKE_ONPLAYMENU( tree_playlist_menu, ID2P(LANG_PLAYLIST),
 319                  treeplaylist_callback, Icon_Playlist,
 320
 321                  /* view */
 322                  &view_playlist_item,
 323
 324                  /* insert */
 325                  &i_pl_item, &i_first_pl_item, &i_last_pl_item,
 326                  &i_shuf_pl_item, &i_last_shuf_pl_item,
 327                  /* queue */
 328
 329                  &q_pl_item, &q_first_pl_item, &q_last_pl_item,
 330                  &q_shuf_pl_item, &q_last_shuf_pl_item,
 331
 332                  /* replace */
 333                  &replace_pl_item
 334                );
 335 static int treeplaylist_callback(int action,
 336                                  const struct menu_item_ex *this_item)
 337 {
 338     switch (action)
 339     {
 340         case ACTION_REQUEST_MENUITEM:
 341             if (this_item == &tree_playlist_menu)
 342             {
 343                 if (((selected_file_attr & FILE_ATTR_MASK) ==
 344                         FILE_ATTR_AUDIO) ||
 345                     ((selected_file_attr & FILE_ATTR_MASK) == FILE_ATTR_M3U)||
 346                      (selected_file_attr & ATTR_DIRECTORY))
 347                 {
 348                     return action;
 349                 }
 350             }
 351             else if (this_item == &view_playlist_item)
 352             {
 353                 if ((selected_file_attr & FILE_ATTR_MASK) == FILE_ATTR_M3U &&
 354                         context == CONTEXT_TREE)
 355                 {
 356                     return action;
 357                 }
 358             }
 359             else if (this_item == &i_shuf_pl_item)
 360             {
 361                 if ((audio_status() & AUDIO_STATUS_PLAY) ||
 362                     (selected_file_attr & ATTR_DIRECTORY) ||
 363                     ((selected_file_attr & FILE_ATTR_MASK) == FILE_ATTR_M3U))
 364                 {
 365                     return action;
 366                 }
 367             }
 368             else if (this_item == &i_last_shuf_pl_item ||
 369                      this_item == &q_last_shuf_pl_item)
 370             {
 371                 if ((playlist_amount() > 0) &&
 372                     (audio_status() & AUDIO_STATUS_PLAY) &&
 373                     ((selected_file_attr & ATTR_DIRECTORY) ||
 374                     ((selected_file_attr & FILE_ATTR_MASK) == FILE_ATTR_M3U)))
 375                 {
 376                     return action;
 377                 }
 378             }
 379             return ACTION_EXIT_MENUITEM;
 380             break;
 381     }
 382     return action;
 383 }
 384
 385
 386 /* playlist catalog options */
 387 static bool cat_add_to_a_playlist(void)
 388 {
 389     return catalog_add_to_a_playlist(selected_file, selected_file_attr,
 390                                      false, NULL);
 391 }
 392
 393 static bool cat_add_to_a_new_playlist(void)
 394 {
 395     return catalog_add_to_a_playlist(selected_file, selected_file_attr,
 396                                      true, NULL);
 397 }
 398
 399 static int cat_playlist_callback(int action,
 400                                  const struct menu_item_ex *this_item);
 401 MENUITEM_FUNCTION(cat_view_lists, 0, ID2P(LANG_CATALOG_VIEW),
 402                   catalog_view_playlists, 0,
 403                   cat_playlist_callback, Icon_Playlist);
 404 MENUITEM_FUNCTION(cat_add_to_list, 0, ID2P(LANG_CATALOG_ADD_TO),
 405                   cat_add_to_a_playlist, 0, NULL, Icon_Playlist);
 406 MENUITEM_FUNCTION(cat_add_to_new, 0, ID2P(LANG_CATALOG_ADD_TO_NEW),
 407                   cat_add_to_a_new_playlist, 0, NULL, Icon_Playlist);
 408 MAKE_ONPLAYMENU(cat_playlist_menu, ID2P(LANG_CATALOG),
 409                 cat_playlist_callback, Icon_Playlist,
 410                 &cat_view_lists, &cat_add_to_list, &cat_add_to_new);
 411
 412 static int cat_playlist_callback(int action,
 413                                  const struct menu_item_ex *this_item)
 414 {
 415     if (!selected_file ||
 416         (((selected_file_attr & FILE_ATTR_MASK) != FILE_ATTR_AUDIO) &&
 417          ((selected_file_attr & FILE_ATTR_MASK) != FILE_ATTR_M3U) &&
 418          ((selected_file_attr & ATTR_DIRECTORY) == 0)))
 419     {
 420         return ACTION_EXIT_MENUITEM;
 421     }
 422 #ifdef HAVE_TAGCACHE
 423     if (context == CONTEXT_ID3DB &&
 424         ((selected_file_attr & FILE_ATTR_MASK) != FILE_ATTR_AUDIO))
 425     {
 426         return ACTION_EXIT_MENUITEM;
 427     }
 428 #endif
 429
 430     switch (action)
 431     {
 432         case ACTION_REQUEST_MENUITEM:
 433             if (this_item == &cat_view_lists)
 434             {
 435                 return action;
 436             }
 437             else if ((audio_status() & AUDIO_STATUS_PLAY) ||
 438                      context != CONTEXT_WPS)
 439             {
 440                 return action;
 441             }
 442             else
 443                 return ACTION_EXIT_MENUITEM;
 444             break;
 445     }
 446     return action;
 447 }
 448
 449 #ifdef HAVE_LCD_BITMAP
 450 static void draw_slider(void)
 451 {
 452     int i;
 453     FOR_NB_SCREENS(i)
 454     {
 455         struct viewport vp;
 456         int slider_height = 2*screens[i].getcharheight();
 457         viewport_set_defaults(&vp, i);
 458         screens[i].set_viewport(&vp);
 459         show_busy_slider(&screens[i], 1, vp.height - slider_height,
 460                          vp.width-2, slider_height-1);
 461         screens[i].update_viewport();
 462         screens[i].set_viewport(NULL);
 463     }
 464 }
 465 #else
 466 #define draw_slider()
 467 #endif
 468
 469 /* helper function to remove a non-empty directory */
 470 static int remove_dir(char* dirname, int len)
 471 {
 472     int result = 0;
 473     DIR* dir;
 474     int dirlen = strlen(dirname);
 475
 476     dir = opendir(dirname);
 477     if (!dir)
 478         return -1; /* open error */
 479
 480     while(true)
 481     {
 482         struct dirent* entry;
 483         /* walk through the directory content */
 484         entry = readdir(dir);
 485         if (!entry)
 486             break;
 487
 488         dirname[dirlen] ='\0';
 489         /* inform the user which dir we're deleting */
 490         splash(0, dirname);
 491
 492         /* append name to current directory */
 493         snprintf(dirname+dirlen, len-dirlen, "/%s", entry->d_name);
 494         if (entry->attribute & ATTR_DIRECTORY)
 495         {   /* remove a subdirectory */
 496             if (!strcmp((char *)entry->d_name, ".") ||
 497                 !strcmp((char *)entry->d_name, ".."))
 498                 continue; /* skip these */
 499
 500             result = remove_dir(dirname, len); /* recursion */
 501             if (result)
 502                 break; /* or better continue, delete what we can? */
 503         }
 504         else
 505         {   /* remove a file */
 506             draw_slider();
 507             result = remove(dirname);
 508         }
 509         if(ACTION_STD_CANCEL == get_action(CONTEXT_STD,TIMEOUT_NOBLOCK))
 510         {
 511             splash(HZ, ID2P(LANG_CANCEL));
 512             result = -1;
 513             break;
 514         }
 515     }
 516     closedir(dir);
 517
 518     if (!result)
 519     {   /* remove the now empty directory */
 520         dirname[dirlen] = '\0'; /* terminate to original length */
 521
 522         result = rmdir(dirname);
 523     }
 524
 525     return result;
 526 }
 527
 528
 529 /* share code for file and directory deletion, saves space */
 530 static bool delete_file_dir(void)
 531 {
 532     char file_to_delete[MAX_PATH];
 533     strcpy(file_to_delete, selected_file);
 534
 535     const char *lines[]={
 536         ID2P(LANG_REALLY_DELETE),
 537         file_to_delete
 538     };
 539     const char *yes_lines[]={
 540         ID2P(LANG_DELETING),
 541         file_to_delete
 542     };
 543
 544     const struct text_message message={lines, 2};
 545     const struct text_message yes_message={yes_lines, 2};
 546
 547     if(gui_syncyesno_run(&message, &yes_message, NULL)!=YESNO_YES)
 548         return false;
 549
 550     splash(0, str(LANG_DELETING));
 551
 552     int res;
 553     if (selected_file_attr & ATTR_DIRECTORY) /* true if directory */
 554     {
 555         char pathname[MAX_PATH]; /* space to go deep */
 556         cpu_boost(true);
 557         strlcpy(pathname, file_to_delete, sizeof(pathname));
 558         res = remove_dir(pathname, sizeof(pathname));
 559         cpu_boost(false);
 560     }
 561     else
 562         res = remove(file_to_delete);
 563
 564     if (!res)
 565         onplay_result = ONPLAY_RELOAD_DIR;
 566
 567     return (res == 0);
 568 }
 569
 570 static bool rename_file(void)
 571 {
 572     char newname[MAX_PATH];
 573     char* ptr = strrchr(selected_file, '/') + 1;
 574     int pathlen = (ptr - selected_file);
 575     strlcpy(newname, selected_file, sizeof(newname));
 576     if (!kbd_input(newname + pathlen, (sizeof newname)-pathlen)) {
 577         if (!strlen(newname + pathlen) ||
 578             (rename(selected_file, newname) < 0)) {
 579             cond_talk_ids_fq(LANG_RENAME, LANG_FAILED);
 580             splashf(HZ*2, "%s %s", str(LANG_RENAME), str(LANG_FAILED));
 581         }
 582         else
 583             onplay_result = ONPLAY_RELOAD_DIR;
 584     }
 585
 586     return false;
 587 }
 588
 589 static bool create_dir(void)
 590 {
 591     char dirname[MAX_PATH];
 592     char *cwd;
 593     int rc;
 594     int pathlen;
 595
 596     cwd = getcwd(NULL, 0);
 597     memset(dirname, 0, sizeof dirname);
 598
 599     snprintf(dirname, sizeof dirname, "%s/", cwd[1] ? cwd : "");
 600
 601     pathlen = strlen(dirname);
 602     rc = kbd_input(dirname + pathlen, (sizeof dirname)-pathlen);
 603     if (rc < 0)
 604         return false;
 605
 606     rc = mkdir(dirname);
 607     if (rc < 0) {
 608         cond_talk_ids_fq(LANG_CREATE_DIR, LANG_FAILED);
 609         splashf(HZ, (unsigned char *)"%s %s", str(LANG_CREATE_DIR),
 610                                               str(LANG_FAILED));
 611     } else {
 612         onplay_result = ONPLAY_RELOAD_DIR;
 613     }
 614
 615     return true;
 616 }
 617
 618 /* Store the current selection in the clipboard */
 619 static bool clipboard_clip(bool copy)
 620 {
 621     clipboard_selection[0] = 0;
 622     strlcpy(clipboard_selection, selected_file, sizeof(clipboard_selection));
 623     clipboard_selection_attr = selected_file_attr;
 624     clipboard_is_copy = copy;
 625
 626     return true;
 627 }
 628
 629 static bool clipboard_cut(void)
 630 {
 631     return clipboard_clip(false);
 632 }
 633
 634 static bool clipboard_copy(void)
 635 {
 636     return clipboard_clip(true);
 637 }
 638
 639 /* Paste a file to a new directory. Will overwrite always. */
 640 static bool clipboard_pastefile(const char *src, const char *target, bool copy)
 641 {
 642     int src_fd, target_fd;
 643     size_t buffersize;
 644     ssize_t size, bytesread, byteswritten;
 645     char *buffer;
 646     bool result = false;
 647
 648     if (copy) {
 649         /* See if we can get the plugin buffer for the file copy buffer */
 650         buffer = (char *) plugin_get_buffer(&buffersize);
 651         if (buffer == NULL || buffersize < 512) {
 652             /* Not large enough, try for a disk sector worth of stack
 653                instead */
 654             buffersize = 512;
 655             buffer = (char *) __builtin_alloca(buffersize);
 656         }
 657
 658         if (buffer == NULL) {
 659             return false;
 660         }
 661
 662         buffersize &= ~0x1ff;  /* Round buffer size to multiple of sector
 663                                   size */
 664
 665         src_fd = open(src, O_RDONLY);
 666
 667         if (src_fd >= 0) {
 668             target_fd = creat(target, 0666);
 669
 670             if (target_fd >= 0) {
 671                 result = true;
 672
 673                 size = filesize(src_fd);
 674
 675                 if (size == -1) {
 676                     result = false;
 677                 }
 678
 679                 while(size > 0) {
 680                     bytesread = read(src_fd, buffer, buffersize);
 681
 682                     if (bytesread == -1) {
 683                         result = false;
 684                         break;
 685                     }
 686
 687                     size -= bytesread;
 688
 689                     while(bytesread > 0) {
 690                         byteswritten = write(target_fd, buffer, bytesread);
 691
 692                         if (byteswritten < 0) {
 693                             result = false;
 694                             size = 0;
 695                             break;
 696                         }
 697
 698                         bytesread -= byteswritten;
 699                         draw_slider();
 700                     }
 701                 }
 702
 703                 close(target_fd);
 704
 705                 /* Copy failed. Cleanup. */
 706                 if (!result) {
 707                     remove(target);
 708                 }
 709             }
 710
 711             close(src_fd);
 712         }
 713     } else {
 714         result = rename(src, target) == 0;
 715 #ifdef HAVE_MULTIVOLUME
 716         if (!result) {
 717             if (errno == EXDEV) {
 718                 /* Failed because cross volume rename doesn't work. Copy
 719                    instead */
 720                 result = clipboard_pastefile(src, target, true);
 721
 722                 if (result) {
 723                     result = remove(src) == 0;
 724                 }
 725             }
 726         }
 727 #endif
 728     }
 729
 730     return result;
 731 }
 732
 733 /* Paste a directory to a new location. Designed to be called by
 734    clipboard_paste */
 735 static bool clipboard_pastedirectory(char *src, int srclen, char *target,
 736                                      int targetlen, bool copy)
 737 {
 738     DIR *srcdir;
 739     int srcdirlen = strlen(src);
 740     int targetdirlen = strlen(target);
 741     bool result = true;
 742
 743     if (!file_exists(target)) {
 744         if (!copy) {
 745             /* Just move the directory */
 746             result = rename(src, target) == 0;
 747
 748 #ifdef HAVE_MULTIVOLUME
 749             if (!result && errno == EXDEV) {
 750                 /* Try a copy as we're going across devices */
 751                 result = clipboard_pastedirectory(src, srclen, target,
 752                     targetlen, true);
 753
 754                 /* If it worked, remove the source directory */
 755                 if (result) {
 756                     remove_dir(src, srclen);
 757                 }
 758             }
 759 #endif
 760             return result;
 761         } else {
 762             /* Make a directory to copy things to */
 763             result = mkdir(target) == 0;
 764         }
 765     }
 766
 767     /* Check if something went wrong already */
 768     if (!result) {
 769         return result;
 770     }
 771
 772     srcdir = opendir(src);
 773     if (!srcdir) {
 774         return false;
 775     }
 776
 777     /* This loop will exit as soon as there's a problem */
 778     while(result)
 779     {
 780         struct dirent* entry;
 781         /* walk through the directory content */
 782         entry = readdir(srcdir);
 783         if (!entry)
 784             break;
 785
 786         /* append name to current directory */
 787         snprintf(src+srcdirlen, srclen-srcdirlen, "/%s", entry->d_name);
 788         snprintf(target+targetdirlen, targetlen-targetdirlen, "/%s",
 789             entry->d_name);
 790
 791         DEBUGF("Copy %s to %s\n", src, target);
 792
 793         if (entry->attribute & ATTR_DIRECTORY)
 794         {   /* copy/move a subdirectory */
 795             if (!strcmp((char *)entry->d_name, ".") ||
 796                 !strcmp((char *)entry->d_name, ".."))
 797                 continue; /* skip these */
 798
 799             result = clipboard_pastedirectory(src, srclen, target, targetlen,
 800                 copy); /* recursion */
 801         }
 802         else
 803         {   /* copy/move a file */
 804             draw_slider();
 805             result = clipboard_pastefile(src, target, copy);
 806         }
 807     }
 808
 809     closedir(srcdir);
 810
 811     if (result) {
 812         src[srcdirlen] = '\0'; /* terminate to original length */
 813         target[targetdirlen] = '\0'; /* terminate to original length */
 814     }
 815
 816     return result;
 817 }
 818
 819 /* Paste the clipboard to the current directory */
 820 static bool clipboard_paste(void)
 821 {
 822     char target[MAX_PATH];
 823     char *cwd, *nameptr;
 824     bool success;
 825
 826     static const char *lines[]={ID2P(LANG_REALLY_OVERWRITE)};
 827     static const struct text_message message={lines, 1};
 828
 829     /* Get the name of the current directory */
 830     cwd = getcwd(NULL, 0);
 831
 832     /* Figure out the name of the selection */
 833     nameptr = strrchr(clipboard_selection, '/');
 834
 835     /* Final target is current directory plus name of selection  */
 836     snprintf(target, sizeof(target), "%s%s", cwd[1] ? cwd : "", nameptr);
 837
 838     /* If the target existed but they choose not to overwite, exit */
 839     if (file_exists(target) &&
 840         (gui_syncyesno_run(&message, NULL, NULL) == YESNO_NO)) {
 841         return false;
 842     }
 843
 844     if (clipboard_is_copy) {
 845         splash(0, ID2P(LANG_COPYING));
 846     }
 847     else
 848     {
 849         splash(0, ID2P(LANG_MOVING));
 850     }
 851
 852     /* Now figure out what we're doing */
 853     cpu_boost(true);
 854     if (clipboard_selection_attr & ATTR_DIRECTORY) {
 855         /* Recursion. Set up external stack */
 856         char srcpath[MAX_PATH];
 857         char targetpath[MAX_PATH];
 858         if (!strncmp(clipboard_selection, target, strlen(clipboard_selection)))
 859         {
 860             /* Do not allow the user to paste a directory into a dir they are
 861                copying */
 862             success = 0;
 863         }
 864         else
 865         {
 866             strlcpy(srcpath, clipboard_selection, sizeof(srcpath));
 867             strlcpy(targetpath, target, sizeof(targetpath));
 868
 869             success = clipboard_pastedirectory(srcpath, sizeof(srcpath),
 870                              target, sizeof(targetpath), clipboard_is_copy);
 871
 872             if (success && !clipboard_is_copy)
 873             {
 874                 strlcpy(srcpath, clipboard_selection, sizeof(srcpath));
 875                 remove_dir(srcpath, sizeof(srcpath));
 876             }
 877         }
 878     } else {
 879         success = clipboard_pastefile(clipboard_selection, target,
 880             clipboard_is_copy);
 881     }
 882     cpu_boost(false);
 883
 884     /* Did it work? */
 885     if (success) {
 886         /* Reset everything */
 887         clipboard_selection[0] = 0;
 888         clipboard_selection_attr = 0;
 889         clipboard_is_copy = false;
 890
 891         /* Force reload of the current directory */
 892         onplay_result = ONPLAY_RELOAD_DIR;
 893     } else {
 894         cond_talk_ids_fq(LANG_PASTE, LANG_FAILED);
 895         splashf(HZ, (unsigned char *)"%s %s", str(LANG_PASTE),
 896                                               str(LANG_FAILED));
 897     }
 898
 899     return true;
 900 }
 901
 902 #ifdef HAVE_TAGCACHE
 903 static int set_rating_inline(void)
 904 {
 905     struct mp3entry* id3 = audio_current_track();
 906     if (id3 && id3->tagcache_idx && global_settings.runtimedb)
 907     {
 908         set_int_ex(str(LANG_MENU_SET_RATING), "", UNIT_INT, (void*)(&id3->rating),
 909                    NULL, 1, 0, 10, NULL, NULL);
 910         tagcache_update_numeric(id3->tagcache_idx-1, tag_rating, id3->rating);
 911     }
 912     else
 913         splash(HZ*2, ID2P(LANG_ID3_NO_INFO));
 914     return 0;
 915 }
 916 static int ratingitem_callback(int action,const struct menu_item_ex *this_item)
 917 {
 918     (void)this_item;
 919     switch (action)
 920     {
 921         case ACTION_REQUEST_MENUITEM:
 922             if (!selected_file || !global_settings.runtimedb ||
 923                 !tagcache_is_usable())
 924                 return ACTION_EXIT_MENUITEM;
 925             break;
 926     }
 927     return action;
 928 }
 929 MENUITEM_FUNCTION(rating_item, 0, ID2P(LANG_MENU_SET_RATING),
 930                   set_rating_inline, NULL,
 931                   ratingitem_callback, Icon_Questionmark);
 932 #endif
 933 #ifdef HAVE_PICTUREFLOW_INTEGRATION
 934 MENUITEM_RETURNVALUE(pictureflow_item, ID2P(LANG_ONPLAY_PICTUREFLOW),
 935                   GO_TO_PICTUREFLOW, NULL, Icon_NOICON);
 936 #endif
 937
 938 static bool view_cue(void)
 939 {
 940     struct mp3entry* id3 = audio_current_track();
 941     if(id3 && id3->cuesheet)
 942     {
 943         browse_cuesheet(id3->cuesheet);
 944     }
 945     return false;
 946 }
 947 static int view_cue_item_callback(int action,
 948                                   const struct menu_item_ex *this_item)
 949 {
 950     (void)this_item;
 951     struct mp3entry* id3 = audio_current_track();
 952     switch (action)
 953     {
 954         case ACTION_REQUEST_MENUITEM:
 955             if (!selected_file
 956                 || !id3 || !id3->cuesheet)
 957                 return ACTION_EXIT_MENUITEM;
 958             break;
 959     }
 960     return action;
 961 }
 962 MENUITEM_FUNCTION(view_cue_item, 0, ID2P(LANG_BROWSE_CUESHEET),
 963                   view_cue, NULL, view_cue_item_callback, Icon_NOICON);
 964
 965 /* CONTEXT_WPS items */
 966 MENUITEM_FUNCTION(browse_id3_item, 0, ID2P(LANG_MENU_SHOW_ID3_INFO),
 967                   browse_id3, NULL, NULL, Icon_NOICON);
 968 #ifdef HAVE_PITCHSCREEN
 969 MENUITEM_FUNCTION(pitch_screen_item, 0, ID2P(LANG_PITCH),
 970                   gui_syncpitchscreen_run, NULL, NULL, Icon_Audio);
 971 #endif
 972
 973 /* CONTEXT_[TREE|ID3DB] items */
 974 static int clipboard_callback(int action,const struct menu_item_ex *this_item);
 975 MENUITEM_FUNCTION(rename_file_item, 0, ID2P(LANG_RENAME),
 976                   rename_file, NULL, clipboard_callback, Icon_NOICON);
 977 MENUITEM_FUNCTION(clipboard_cut_item, 0, ID2P(LANG_CUT),
 978                   clipboard_cut, NULL, clipboard_callback, Icon_NOICON);
 979 MENUITEM_FUNCTION(clipboard_copy_item, 0, ID2P(LANG_COPY),
 980                   clipboard_copy, NULL, clipboard_callback, Icon_NOICON);
 981 MENUITEM_FUNCTION(clipboard_paste_item, 0, ID2P(LANG_PASTE),
 982                   clipboard_paste, NULL, clipboard_callback, Icon_NOICON);
 983 MENUITEM_FUNCTION(delete_file_item, 0, ID2P(LANG_DELETE),
 984                   delete_file_dir, NULL, clipboard_callback, Icon_NOICON);
 985 MENUITEM_FUNCTION(delete_dir_item, 0, ID2P(LANG_DELETE_DIR),
 986                   delete_file_dir, NULL, clipboard_callback, Icon_NOICON);
 987 MENUITEM_FUNCTION(create_dir_item, 0, ID2P(LANG_CREATE_DIR),
 988                   create_dir, NULL, clipboard_callback, Icon_NOICON);
 989
 990 /* other items */
 991 static bool list_viewers(void)
 992 {
 993     int ret = filetype_list_viewers(selected_file);
 994     if (ret == PLUGIN_USB_CONNECTED)
 995         onplay_result = ONPLAY_RELOAD_DIR;
 996     return false;
 997 }
 998
 999 static bool onplay_load_plugin(void *param)
1000 {
1001     int ret = filetype_load_plugin((const char*)param, selected_file);
1002     if (ret == PLUGIN_USB_CONNECTED)
1003         onplay_result = ONPLAY_RELOAD_DIR;
1004     return false;
1005 }
1006
1007 MENUITEM_FUNCTION(list_viewers_item, 0, ID2P(LANG_ONPLAY_OPEN_WITH),
1008                   list_viewers, NULL, clipboard_callback, Icon_NOICON);
1009 MENUITEM_FUNCTION(properties_item, MENU_FUNC_USEPARAM, ID2P(LANG_PROPERTIES),
1010                   onplay_load_plugin, (void *)"properties",
1011                   clipboard_callback, Icon_NOICON);
1012 MENUITEM_FUNCTION(add_to_faves_item, MENU_FUNC_USEPARAM, ID2P(LANG_ADD_TO_FAVES),
1013                   onplay_load_plugin, (void *)"shortcuts_append",
1014                   clipboard_callback, Icon_NOICON);
1015
1016 #if LCD_DEPTH > 1
1017 static bool set_backdrop(void)
1018 {
1019     /* load the image */
1020     if(sb_set_backdrop(SCREEN_MAIN, selected_file)) {
1021         splash(HZ, str(LANG_BACKDROP_LOADED));
1022         set_file(selected_file, (char *)global_settings.backdrop_file,
1023             MAX_FILENAME);
1024         return true;
1025     } else {
1026         splash(HZ, str(LANG_BACKDROP_FAILED));
1027         return false;
1028     }
1029     return true;
1030 }
1031 MENUITEM_FUNCTION(set_backdrop_item, 0, ID2P(LANG_SET_AS_BACKDROP),
1032                   set_backdrop, NULL, clipboard_callback, Icon_NOICON);
1033 #endif
1034 #ifdef HAVE_RECORDING
1035 static bool set_recdir(void)
1036 {
1037     strlcpy(global_settings.rec_directory, selected_file, MAX_FILENAME+1);
1038     settings_save();
1039     return false;
1040 }
1041 MENUITEM_FUNCTION(set_recdir_item, 0, ID2P(LANG_SET_AS_REC_DIR),
1042                   set_recdir, NULL, clipboard_callback, Icon_Recording);
1043 #endif
1044
1045 static int clipboard_callback(int action,const struct menu_item_ex *this_item)
1046 {
1047     switch (action)
1048     {
1049         case ACTION_REQUEST_MENUITEM:
1050 #ifdef HAVE_MULTIVOLUME
1051             if ((selected_file_attr & FAT_ATTR_VOLUME) &&
1052                 (this_item == &rename_file_item ||
1053                  this_item == &delete_dir_item ||
1054                  this_item == &clipboard_cut_item) )
1055                 return ACTION_EXIT_MENUITEM;
1056             /* no rename+delete for volumes */
1057             if ((selected_file_attr & ATTR_VOLUME) &&
1058                  (this_item == &delete_file_item ||
1059                   this_item == &list_viewers_item))
1060                 return ACTION_EXIT_MENUITEM;
1061 #endif
1062 #ifdef HAVE_TAGCACHE
1063             if (context == CONTEXT_ID3DB)
1064             {
1065                 if (((selected_file_attr & FILE_ATTR_MASK) ==
1066                         FILE_ATTR_AUDIO) &&
1067                     this_item == &properties_item)
1068                     return action;
1069                 return ACTION_EXIT_MENUITEM;
1070             }
1071 #endif
1072             if (this_item == &clipboard_paste_item)
1073             {  /* visible if there is something to paste */
1074                 return (clipboard_selection[0] != 0) ?
1075                                     action : ACTION_EXIT_MENUITEM;
1076             }
1077             else if (this_item == &create_dir_item)
1078             {
1079                 /* always visible */
1080                 return action;
1081             }
1082             else if (selected_file)
1083             {
1084                 /* requires an actual file */
1085                 if (this_item == &rename_file_item ||
1086                     this_item == &clipboard_cut_item ||
1087                     this_item == &clipboard_copy_item ||
1088                     this_item == &properties_item ||
1089                     this_item == &add_to_faves_item)
1090                 {
1091                     return action;
1092                 }
1093                 else if ((selected_file_attr & ATTR_DIRECTORY))
1094                 {
1095                     /* only for directories */
1096                     if (this_item == &delete_dir_item
1097 #ifdef HAVE_RECORDING
1098                      || this_item == &set_recdir_item
1099 #endif
1100                         )
1101                         return action;
1102                 }
1103                 else if (this_item == &delete_file_item ||
1104                          this_item == &list_viewers_item)
1105                 {
1106                     /* only for files */
1107                     return action;
1108                 }
1109 #if LCD_DEPTH > 1
1110                 else if (this_item == &set_backdrop_item)
1111                 {
1112                     char *suffix = strrchr(selected_file, '.');
1113                     if (suffix)
1114                     {
1115                         if (strcasecmp(suffix, ".bmp") == 0)
1116                         {
1117                             return action;
1118                         }
1119                     }
1120                 }
1121 #endif
1122             }
1123             return ACTION_EXIT_MENUITEM;
1124             break;
1125     }
1126     return action;
1127 }
1128
1129 static int onplaymenu_callback(int action,const struct menu_item_ex *this_item);
1130 /* used when onplay() is called in the CONTEXT_WPS context */
1131 MAKE_ONPLAYMENU( wps_onplay_menu, ID2P(LANG_ONPLAY_MENU_TITLE),
1132            onplaymenu_callback, Icon_Audio,
1133            &wps_playlist_menu, &cat_playlist_menu,
1134            &sound_settings, &playback_settings,
1135 #ifdef HAVE_TAGCACHE
1136            &rating_item,
1137 #endif
1138            &bookmark_menu,
1139 #ifdef HAVE_PICTUREFLOW_INTEGRATION
1140            &pictureflow_item,
1141 #endif
1142            &browse_id3_item, &list_viewers_item,
1143            &delete_file_item, &view_cue_item,
1144 #ifdef HAVE_PITCHSCREEN
1145            &pitch_screen_item,
1146 #endif
1147          );
1148 /* used when onplay() is not called in the CONTEXT_WPS context */
1149 MAKE_ONPLAYMENU( tree_onplay_menu, ID2P(LANG_ONPLAY_MENU_TITLE),
1150            onplaymenu_callback, Icon_file_view_menu,
1151            &tree_playlist_menu, &cat_playlist_menu,
1152            &rename_file_item, &clipboard_cut_item, &clipboard_copy_item,
1153            &clipboard_paste_item, &delete_file_item, &delete_dir_item,
1154 #if LCD_DEPTH > 1
1155            &set_backdrop_item,
1156 #endif
1157            &list_viewers_item, &create_dir_item, &properties_item,
1158 #ifdef HAVE_RECORDING
1159            &set_recdir_item,
1160 #endif
1161            &add_to_faves_item,
1162          );
1163 static int onplaymenu_callback(int action,const struct menu_item_ex *this_item)
1164 {
1165     switch (action)
1166     {
1167         case ACTION_TREE_STOP:
1168             if (this_item == &wps_onplay_menu)
1169             {
1170                 list_stop_handler();
1171                 return ACTION_STD_CANCEL;
1172             }
1173             break;
1174         case ACTION_EXIT_MENUITEM:
1175             return ACTION_EXIT_AFTER_THIS_MENUITEM;
1176             break;
1177     }
1178     return action;
1179 }
1180
1181 #ifdef HAVE_HOTKEY
1182 /* direct function calls, no need for menu callbacks */
1183 static bool delete_item(void)
1184 {
1185 #ifdef HAVE_MULTIVOLUME
1186     /* no delete for volumes */
1187     if ((selected_file_attr & FAT_ATTR_VOLUME) ||
1188         (selected_file_attr & ATTR_VOLUME))
1189         return false;
1190 #endif
1191     return delete_file_dir();
1192 }
1193
1194 static bool open_with(void)
1195 {
1196     /* only open files */
1197     if (selected_file_attr & ATTR_DIRECTORY)
1198         return false;
1199 #ifdef HAVE_MULTIVOLUME
1200     if (selected_file_attr & ATTR_VOLUME)
1201         return false;
1202 #endif
1203     return list_viewers();
1204 }
1205
1206 static int playlist_insert_shuffled(void)
1207 {
1208     if ((audio_status() & AUDIO_STATUS_PLAY) ||
1209         (selected_file_attr & ATTR_DIRECTORY) ||
1210         ((selected_file_attr & FILE_ATTR_MASK) == FILE_ATTR_M3U))
1211     {
1212         playlist_insert_func((intptr_t*)PLAYLIST_INSERT_SHUFFLED);
1213         return ONPLAY_START_PLAY;
1214     }
1215
1216     return ONPLAY_RELOAD_DIR;
1217 }
1218
1219 struct hotkey_assignment {
1220     int action;             /* hotkey_action */
1221     int lang_id;            /* Language ID */
1222     struct menu_func func;  /* Function to run if this entry is selected */
1223     int return_code;        /* What to return after the function is run  */
1224 };
1225
1226 #define HOTKEY_FUNC(func, param) {{(void *)func}, param}
1227
1228 /* Any desired hotkey functions go here, in the enum in onplay.h,
1229    and in the settings menu in settings_list.c.  The order here
1230    is not important. */
1231 static struct hotkey_assignment hotkey_items[] = {
1232     { HOTKEY_VIEW_PLAYLIST,     LANG_VIEW_DYNAMIC_PLAYLIST,
1233             HOTKEY_FUNC(NULL, NULL),
1234             ONPLAY_PLAYLIST },
1235     { HOTKEY_SHOW_TRACK_INFO,   LANG_MENU_SHOW_ID3_INFO,
1236             HOTKEY_FUNC(browse_id3, NULL),
1237             ONPLAY_RELOAD_DIR },
1238 #ifdef HAVE_PITCHSCREEN
1239     { HOTKEY_PITCHSCREEN,       LANG_PITCH,
1240             HOTKEY_FUNC(gui_syncpitchscreen_run, NULL),
1241             ONPLAY_RELOAD_DIR },
1242 #endif
1243     { HOTKEY_OPEN_WITH,         LANG_ONPLAY_OPEN_WITH,
1244             HOTKEY_FUNC(open_with, NULL),
1245             ONPLAY_RELOAD_DIR },
1246     { HOTKEY_DELETE,            LANG_DELETE,
1247             HOTKEY_FUNC(delete_item, NULL),
1248             ONPLAY_RELOAD_DIR },
1249     { HOTKEY_INSERT,            LANG_INSERT,
1250             HOTKEY_FUNC(playlist_insert_func, (intptr_t*)PLAYLIST_INSERT),
1251             ONPLAY_START_PLAY },
1252     { HOTKEY_INSERT_SHUFFLED,   LANG_INSERT_SHUFFLED,
1253             HOTKEY_FUNC(playlist_insert_shuffled, NULL),
1254             ONPLAY_OK },
1255 #ifdef HAVE_PICTUREFLOW_INTEGRATION
1256     { HOTKEY_PICTUREFLOW, LANG_ONPLAY_PICTUREFLOW,
1257             HOTKEY_FUNC(NULL, NULL),
1258             ONPLAY_PICTUREFLOW },
1259 #endif
1260 };
1261
1262 /* Return the language ID for this action */
1263 int get_hotkey_lang_id(int action)
1264 {
1265     int i = ARRAYLEN(hotkey_items);
1266     while (i--)
1267     {
1268         if (hotkey_items[i].action == action)
1269             return hotkey_items[i].lang_id;
1270     }
1271
1272     return LANG_OFF;
1273 }
1274
1275 /* Execute the hotkey function, if listed */
1276 static int execute_hotkey(bool is_wps)
1277 {
1278     int i = ARRAYLEN(hotkey_items);
1279     struct hotkey_assignment *this_item;
1280     const int action = (is_wps ? global_settings.hotkey_wps :
1281         global_settings.hotkey_tree);
1282
1283     /* search assignment struct for a match for the hotkey setting */
1284     while (i--)
1285     {
1286         this_item = &hotkey_items[i];
1287         if (this_item->action == action)
1288         {
1289             /* run the associated function (with optional param), if any */
1290             const struct menu_func func = this_item->func;
1291             int func_return = ONPLAY_RELOAD_DIR;
1292             if (func.function != NULL)
1293             {
1294                 if (func.param != NULL)
1295                     func_return = (*func.function_w_param)(func.param);
1296                 else
1297                     func_return = (*func.function)();
1298             }
1299             /* return with the associated code */
1300             const int return_code = this_item->return_code;
1301             /* ONPLAY_OK here means to use the function return code */
1302             if (return_code == ONPLAY_OK)
1303                 return func_return;
1304             return return_code;
1305         }
1306     }
1307
1308     /* no valid hotkey set, ignore hotkey */
1309     return ONPLAY_RELOAD_DIR;
1310 }
1311 #endif /* HOTKEY */
1312
1313 int onplay(char* file, int attr, int from, bool hotkey)
1314 {
1315     const struct menu_item_ex *menu;
1316     onplay_result = ONPLAY_OK;
1317     context = from;
1318     selected_file = file;
1319     selected_file_attr = attr;
1320     int menu_selection;
1321 #ifdef HAVE_HOTKEY
1322     if (hotkey)
1323         return execute_hotkey(context == CONTEXT_WPS);
1324 #else
1325     (void)hotkey;
1326 #endif
1327     if (context == CONTEXT_WPS)
1328         menu = &wps_onplay_menu;
1329     else
1330         menu = &tree_onplay_menu;
1331     menu_selection = do_menu(menu, NULL, NULL, false);
1332
1333     switch (menu_selection)
1334     {
1335         case GO_TO_WPS:
1336             return ONPLAY_START_PLAY;
1337         case GO_TO_ROOT:
1338         case GO_TO_MAINMENU:
1339             return ONPLAY_MAINMENU;
1340         case GO_TO_PLAYLIST_VIEWER:
1341             return ONPLAY_PLAYLIST;
1342 #ifdef HAVE_PICTUREFLOW_INTEGRATION
1343         case GO_TO_PICTUREFLOW:
1344             return ONPLAY_PICTUREFLOW;
1345 #endif
1346         default:
1347             return onplay_result;
1348     }
1349 }