apps/bookmark.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  *
   9  * Copyright (C)2003 by Benjamin Metzler
  10  *
  11  * All files in this archive are subject to the GNU General Public License.
  12  * See the file COPYING in the source tree root for full license agreement.
  13  *
  14  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  15  * KIND, either express or implied.
  16  *
  17  ****************************************************************************/
  18
  19 #include <stdio.h>
  20 #include <stdlib.h>
  21 #include <string.h>
  22 #include <stdbool.h>
  23
  24 #include "applimits.h"
  25 #include "lcd.h"
  26 #include "action.h"
  27 #include "usb.h"
  28 #include "audio.h"
  29 #include "playlist.h"
  30 #include "settings.h"
  31 #include "tree.h"
  32 #include "bookmark.h"
  33 #include "dir.h"
  34 #include "status.h"
  35 #include "system.h"
  36 #include "errno.h"
  37 #include "icons.h"
  38 #include "atoi.h"
  39 #include "string.h"
  40 #include "menu.h"
  41 #include "lang.h"
  42 #include "screens.h"
  43 #include "status.h"
  44 #include "debug.h"
  45 #include "kernel.h"
  46 #include "sprintf.h"
  47 #include "talk.h"
  48 #include "misc.h"
  49 #include "abrepeat.h"
  50 #include "splash.h"
  51 #include "yesno.h"
  52 #include "list.h"
  53 #include "plugin.h"
  54
  55 #if (LCD_DEPTH > 1) || (defined(HAVE_LCD_REMOTE) && (LCD_REMOTE_DEPTH > 1))
  56 #include "backdrop.h"
  57 #endif
  58
  59 #define MAX_BOOKMARKS 10
  60 #define MAX_BOOKMARK_SIZE  350
  61 #define RECENT_BOOKMARK_FILE ROCKBOX_DIR "/most-recent.bmark"
  62
  63 /* Used to buffer bookmarks while displaying the bookmark list. */
  64 struct bookmark_list
  65 {
  66     const char* filename;
  67     size_t buffer_size;
  68     int start;
  69     int count;
  70     int total_count;
  71     bool show_dont_resume;
  72     bool reload;
  73     char* items[];
  74 };
  75
  76 static bool  add_bookmark(const char* bookmark_file_name, const char* bookmark,
  77                           bool most_recent);
  78 static bool  check_bookmark(const char* bookmark);
  79 static char* create_bookmark(void);
  80 static bool  delete_bookmark(const char* bookmark_file_name, int bookmark_id);
  81 static void  say_bookmark(const char* bookmark,
  82                           int bookmark_id);
  83 static bool play_bookmark(const char* bookmark);
  84 static bool  generate_bookmark_file_name(const char *in);
  85 static const char* skip_token(const char* s);
  86 static const char* int_token(const char* s, int* dest);
  87 static const char* long_token(const char* s, long* dest);
  88 static const char* bool_token(const char* s, bool* dest);
  89 static bool  parse_bookmark(const char *bookmark,
  90                             int *resume_index,
  91                             int *resume_offset,
  92                             int *resume_seed,
  93                             int *resume_first_index,
  94                             char* resume_file,
  95                             unsigned int resume_file_size,
  96                             long* ms,
  97                             int * repeat_mode,
  98                             bool *shuffle,
  99                             char* file_name);
 100 static int buffer_bookmarks(struct bookmark_list* bookmarks, int first_line);
 101 static char* get_bookmark_info(int list_index, void* data, char *buffer);
 102 static char* select_bookmark(const char* bookmark_file_name, bool show_dont_resume);
 103 static bool  system_check(void);
 104 static bool  write_bookmark(bool create_bookmark_file);
 105 static int   get_bookmark_count(const char* bookmark_file_name);
 106
 107 static char global_temp_buffer[MAX_PATH+1];
 108 /* File name created by generate_bookmark_file_name */
 109 static char global_bookmark_file_name[MAX_PATH];
 110 static char global_read_buffer[MAX_BOOKMARK_SIZE];
 111 /* Bookmark created by create_bookmark*/
 112 static char global_bookmark[MAX_BOOKMARK_SIZE];
 113 /* Filename from parsed bookmark (can be made local where needed) */
 114 static char global_filename[MAX_PATH];
 115
 116 /* ----------------------------------------------------------------------- */
 117 /* This is the interface function from the main menu.                      */
 118 /* ----------------------------------------------------------------------- */
 119 bool bookmark_create_menu(void)
 120 {
 121     write_bookmark(true);
 122     return false;
 123 }
 124
 125 /* ----------------------------------------------------------------------- */
 126 /* This function acts as the load interface from the main menu             */
 127 /* This function determines the bookmark file name and then loads that file*/
 128 /* for the user.  The user can then select a bookmark to load.             */
 129 /* If no file/directory is currently playing, the menu item does not work. */
 130 /* ----------------------------------------------------------------------- */
 131 bool bookmark_load_menu(void)
 132 {
 133     if (system_check())
 134     {
 135         char* name = playlist_get_name(NULL, global_temp_buffer,
 136                                        sizeof(global_temp_buffer));
 137         if (generate_bookmark_file_name(name))
 138         {
 139             char* bookmark = select_bookmark(global_bookmark_file_name, false);
 140
 141             if (bookmark != NULL)
 142             {
 143                 return play_bookmark(bookmark);
 144             }
 145         }
 146     }
 147
 148     return false;
 149 }
 150
 151 /* ----------------------------------------------------------------------- */
 152 /* Gives the user a list of the Most Recent Bookmarks.  This is an         */
 153 /* interface function                                                      */
 154 /* ----------------------------------------------------------------------- */
 155 bool bookmark_mrb_load()
 156 {
 157     char* bookmark = select_bookmark(RECENT_BOOKMARK_FILE, false);
 158
 159     if (bookmark != NULL)
 160     {
 161         return play_bookmark(bookmark);
 162     }
 163
 164     return false;
 165 }
 166
 167 /* ----------------------------------------------------------------------- */
 168 /* This function handles an autobookmark creation.  This is an interface   */
 169 /* function.                                                               */
 170 /* ----------------------------------------------------------------------- */
 171 bool bookmark_autobookmark(void)
 172 {
 173     if (!system_check())
 174         return false;
 175
 176     audio_pause();    /* first pause playback */
 177     switch (global_settings.autocreatebookmark)
 178     {
 179         case BOOKMARK_YES:
 180             return write_bookmark(true);
 181
 182         case BOOKMARK_NO:
 183             return false;
 184
 185         case BOOKMARK_RECENT_ONLY_YES:
 186             return write_bookmark(false);
 187     }
 188 #ifdef HAVE_LCD_BITMAP
 189     unsigned char *lines[]={str(LANG_AUTO_BOOKMARK_QUERY)};
 190     struct text_message message={(char **)lines, 1};
 191 #else
 192     unsigned char *lines[]={str(LANG_AUTO_BOOKMARK_QUERY),
 193                             str(LANG_RESUME_CONFIRM_PLAYER)};
 194     struct text_message message={(char **)lines, 2};
 195 #endif
 196 #if LCD_DEPTH > 1
 197     show_main_backdrop(); /* switch to main backdrop as we may come from wps */
 198 #endif
 199 #if defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1
 200     show_remote_main_backdrop();
 201 #endif
 202     gui_syncstatusbar_draw(&statusbars, false);
 203     if(gui_syncyesno_run(&message, NULL, NULL)==YESNO_YES)
 204     {
 205         if (global_settings.autocreatebookmark == BOOKMARK_RECENT_ONLY_ASK)
 206             return write_bookmark(false);
 207         else
 208             return write_bookmark(true);
 209     }
 210     return false;
 211 }
 212
 213 /* ----------------------------------------------------------------------- */
 214 /* This function takes the current current resume information and writes   */
 215 /* that to the beginning of the bookmark file.                             */
 216 /* This file will contain N number of bookmarks in the following format:   */
 217 /* resume_index*resume_offset*resume_seed*resume_first_index*              */
 218 /* resume_file*milliseconds*MP3 Title*                                     */
 219 /* ------------------------------------------------------------------------*/
 220 static bool write_bookmark(bool create_bookmark_file)
 221 {
 222     bool   success=false;
 223     char*  bookmark;
 224
 225     if (!system_check())
 226        return false; /* something didn't happen correctly, do nothing */
 227
 228     bookmark = create_bookmark();
 229     if (!bookmark)
 230        return false; /* something didn't happen correctly, do nothing */
 231
 232     if (global_settings.usemrb)
 233         success = add_bookmark(RECENT_BOOKMARK_FILE, bookmark, true);
 234
 235
 236     /* writing the bookmark */
 237     if (create_bookmark_file)
 238     {
 239         char* name = playlist_get_name(NULL, global_temp_buffer,
 240                                        sizeof(global_temp_buffer));
 241         if (generate_bookmark_file_name(name))
 242         {
 243             success = add_bookmark(global_bookmark_file_name, bookmark, false);
 244         }
 245     }
 246
 247     gui_syncsplash(HZ, str(success ? LANG_BOOKMARK_CREATE_SUCCESS
 248         : LANG_BOOKMARK_CREATE_FAILURE));
 249
 250     return true;
 251 }
 252
 253 /* ----------------------------------------------------------------------- */
 254 /* This function adds a bookmark to a file.                                */
 255 /* ------------------------------------------------------------------------*/
 256 static bool add_bookmark(const char* bookmark_file_name, const char* bookmark,
 257                          bool most_recent)
 258 {
 259     int    temp_bookmark_file = 0;
 260     int    bookmark_file = 0;
 261     int    bookmark_count = 0;
 262     char*  playlist = NULL;
 263     char*  cp;
 264     char*  tmp;
 265     int    len = 0;
 266     bool   unique = false;
 267
 268     /* Opening up a temp bookmark file */
 269     snprintf(global_temp_buffer, sizeof(global_temp_buffer),
 270              "%s.tmp", bookmark_file_name);
 271     temp_bookmark_file = open(global_temp_buffer,
 272                               O_WRONLY | O_CREAT | O_TRUNC);
 273     if (temp_bookmark_file < 0)
 274         return false; /* can't open the temp file */
 275
 276     if (most_recent && (global_settings.usemrb == BOOKMARK_UNIQUE_ONLY))
 277     {
 278         playlist = strchr(bookmark,'/');
 279         cp = strrchr(bookmark,';');
 280         len = cp - playlist;
 281         unique = true;
 282     }
 283
 284     /* Writing the new bookmark to the begining of the temp file */
 285     write(temp_bookmark_file, bookmark, strlen(bookmark));
 286     write(temp_bookmark_file, "\n", 1);
 287     bookmark_count++;
 288
 289     /* Reading in the previous bookmarks and writing them to the temp file */
 290     bookmark_file = open(bookmark_file_name, O_RDONLY);
 291     if (bookmark_file >= 0)
 292     {
 293         while (read_line(bookmark_file, global_read_buffer,
 294                          sizeof(global_read_buffer)) > 0)
 295         {
 296             /* The MRB has a max of MAX_BOOKMARKS in it */
 297             /* This keeps it from getting too large */
 298             if (most_recent && (bookmark_count >= MAX_BOOKMARKS))
 299                 break;
 300
 301             cp  = strchr(global_read_buffer,'/');
 302             tmp = strrchr(global_read_buffer,';');
 303             if (check_bookmark(global_read_buffer) &&
 304                (!unique || len != tmp -cp || strncmp(playlist,cp,len)))
 305             {
 306                 bookmark_count++;
 307                 write(temp_bookmark_file, global_read_buffer,
 308                       strlen(global_read_buffer));
 309                 write(temp_bookmark_file, "\n", 1);
 310             }
 311         }
 312         close(bookmark_file);
 313     }
 314     close(temp_bookmark_file);
 315
 316     remove(bookmark_file_name);
 317     rename(global_temp_buffer, bookmark_file_name);
 318
 319     return true;
 320 }
 321
 322
 323 /* ----------------------------------------------------------------------- */
 324 /* This function takes the system resume data and formats it into a valid  */
 325 /* bookmark.                                                               */
 326 /* ----------------------------------------------------------------------- */
 327 static char* create_bookmark()
 328 {
 329     int resume_index = 0;
 330     char *file;
 331
 332     /* grab the currently playing track */
 333     struct mp3entry *id3 = audio_current_track();
 334     if(!id3)
 335         return NULL;
 336
 337     /* Get some basic resume information */
 338     /* queue_resume and queue_resume_index are not used and can be ignored.*/
 339     playlist_get_resume_info(&resume_index);
 340
 341     /* Get the currently playing file minus the path */
 342     /* This is used when displaying the available bookmarks */
 343     file = strrchr(id3->path,'/');
 344     if(NULL == file)
 345         return NULL;
 346
 347     /* create the bookmark */
 348     snprintf(global_bookmark, sizeof(global_bookmark),
 349              "%d;%ld;%d;%d;%ld;%d;%d;%s;%s",
 350              resume_index,
 351              id3->offset,
 352              playlist_get_seed(NULL),
 353              0,
 354              id3->elapsed,
 355              global_settings.repeat_mode,
 356              global_settings.playlist_shuffle,
 357              playlist_get_name(NULL, global_temp_buffer,
 358                 sizeof(global_temp_buffer)),
 359              file+1);
 360
 361     /* checking to see if the bookmark is valid */
 362     if (check_bookmark(global_bookmark))
 363         return global_bookmark;
 364     else
 365         return NULL;
 366 }
 367
 368 static bool check_bookmark(const char* bookmark)
 369 {
 370     return parse_bookmark(bookmark,
 371                           NULL,NULL,NULL, NULL,
 372                           NULL,0,NULL,NULL,
 373                           NULL, NULL);
 374 }
 375
 376 /* ----------------------------------------------------------------------- */
 377 /* This function will determine if an autoload is necessary.  This is an   */
 378 /* interface function.                                                     */
 379 /* ------------------------------------------------------------------------*/
 380 bool bookmark_autoload(const char* file)
 381 {
 382     int  fd;
 383
 384     if(global_settings.autoloadbookmark == BOOKMARK_NO)
 385         return false;
 386
 387     /*Checking to see if a bookmark file exists.*/
 388     if(!generate_bookmark_file_name(file))
 389     {
 390         return false;
 391     }
 392     fd = open(global_bookmark_file_name, O_RDONLY);
 393     if(fd<0)
 394         return false;
 395     close(fd);
 396     if(global_settings.autoloadbookmark == BOOKMARK_YES)
 397     {
 398         return bookmark_load(global_bookmark_file_name, true);
 399     }
 400     else
 401     {
 402         char* bookmark = select_bookmark(global_bookmark_file_name, true);
 403
 404         if (bookmark)
 405         {
 406             return bookmark_load(global_bookmark_file_name, true);
 407         }
 408
 409         return false;
 410     }
 411 }
 412
 413 /* ----------------------------------------------------------------------- */
 414 /* This function loads the bookmark information into the resume memory.    */
 415 /* This is an interface function.                                          */
 416 /* ------------------------------------------------------------------------*/
 417 bool bookmark_load(const char* file, bool autoload)
 418 {
 419     int  fd;
 420     char* bookmark = NULL;;
 421
 422     if(autoload)
 423     {
 424         fd = open(file, O_RDONLY);
 425         if(fd >= 0)
 426         {
 427             if(read_line(fd, global_read_buffer, sizeof(global_read_buffer)) > 0)
 428                 bookmark=global_read_buffer;
 429             close(fd);
 430         }
 431     }
 432     else
 433     {
 434         /* This is not an auto-load, so list the bookmarks */
 435         bookmark = select_bookmark(file, false);
 436     }
 437
 438     if (bookmark != NULL)
 439     {
 440         return play_bookmark(bookmark);
 441     }
 442
 443     return true;
 444 }
 445
 446
 447 static int get_bookmark_count(const char* bookmark_file_name)
 448 {
 449     int read_count = 0;
 450     int file = open(bookmark_file_name, O_RDONLY);
 451
 452     if(file < 0)
 453         return -1;
 454
 455     /* Get the requested bookmark */
 456     while(read_line(file, global_read_buffer, sizeof(global_read_buffer)) > 0)
 457     {
 458         read_count++;
 459     }
 460
 461     close(file);
 462     return read_count;
 463 }
 464
 465 static int buffer_bookmarks(struct bookmark_list* bookmarks, int first_line)
 466 {
 467     char* dest = ((char*) bookmarks) + bookmarks->buffer_size - 1;
 468     int read_count = 0;
 469     int file = open(bookmarks->filename, O_RDONLY);
 470
 471     if (file < 0)
 472     {
 473         return -1;
 474     }
 475
 476     if ((first_line != 0) && ((size_t) filesize(file) < bookmarks->buffer_size
 477             - sizeof(*bookmarks) - (sizeof(char*) * bookmarks->total_count)))
 478     {
 479         /* Entire file fits in buffer */
 480         first_line = 0;
 481     }
 482
 483     bookmarks->start = first_line;
 484     bookmarks->count = 0;
 485     bookmarks->reload = false;
 486
 487     while(read_line(file, global_read_buffer, sizeof(global_read_buffer)) > 0)
 488     {
 489         read_count++;
 490
 491         if (read_count >= first_line)
 492         {
 493             dest -= strlen(global_read_buffer) + 1;
 494
 495             if (dest < ((char*) bookmarks) + sizeof(*bookmarks)
 496                 + (sizeof(char*) * (bookmarks->count + 1)))
 497             {
 498                 break;
 499             }
 500
 501             strcpy(dest, global_read_buffer);
 502             bookmarks->items[bookmarks->count] = dest;
 503             bookmarks->count++;
 504         }
 505     }
 506
 507     close(file);
 508     return bookmarks->start + bookmarks->count;
 509 }
 510
 511 static char* get_bookmark_info(int list_index, void* data, char *buffer)
 512 {
 513     struct bookmark_list* bookmarks = (struct bookmark_list*) data;
 514     int     index = list_index / 2;
 515     int     resume_index = 0;
 516     long    resume_time = 0;
 517     bool    shuffle = false;
 518
 519     if (bookmarks->show_dont_resume)
 520     {
 521         if (index == 0)
 522         {
 523             return list_index % 2 == 0
 524                 ? (char*) str(LANG_BOOKMARK_DONT_RESUME) : " ";
 525         }
 526
 527         index--;
 528     }
 529
 530     if (bookmarks->reload || (index >= bookmarks->start + bookmarks->count)
 531         || (index < bookmarks->start))
 532     {
 533         int read_index = index;
 534
 535         /* Using count as a guide on how far to move could possibly fail
 536          * sometimes. Use byte count if that is a problem?
 537          */
 538
 539         if (read_index != 0)
 540         {
 541             /* Move count * 3 / 4 items in the direction the user is moving,
 542              * but don't go too close to the end.
 543              */
 544             int offset = bookmarks->count;
 545             int max = bookmarks->total_count - (bookmarks->count / 2);
 546
 547             if (read_index < bookmarks->start)
 548             {
 549                 offset *= 3;
 550             }
 551
 552             read_index = index - offset / 4;
 553
 554             if (read_index > max)
 555             {
 556                 read_index = max;
 557             }
 558
 559             if (read_index < 0)
 560             {
 561                 read_index = 0;
 562             }
 563         }
 564
 565         if (buffer_bookmarks(bookmarks, read_index) <= index)
 566         {
 567             return "";
 568         }
 569     }
 570
 571     if (!parse_bookmark(bookmarks->items[index - bookmarks->start],
 572         &resume_index, NULL, NULL, NULL, NULL, 0, &resume_time, NULL,
 573         &shuffle, global_filename))
 574     {
 575         return list_index % 2 == 0 ? (char*) str(LANG_BOOKMARK_INVALID) : " ";
 576     }
 577
 578     if (list_index % 2 == 0)
 579     {
 580         char* dot = strrchr(global_filename, '.');
 581
 582         if (dot)
 583         {
 584             *dot = '\0';
 585         }
 586
 587         return global_filename;
 588     }
 589     else
 590     {
 591         char time_buf[32];
 592
 593         format_time(time_buf, sizeof(time_buf), resume_time);
 594         snprintf(buffer, MAX_PATH, "%s, %d%s", time_buf, resume_index + 1,
 595             shuffle ? (char*) str(LANG_BOOKMARK_SHUFFLE) : "");
 596         return buffer;
 597     }
 598 }
 599
 600 /* ----------------------------------------------------------------------- */
 601 /* This displays a the bookmarks in a file and allows the user to          */
 602 /* select one to play.                                                     */
 603 /* ------------------------------------------------------------------------*/
 604 static char* select_bookmark(const char* bookmark_file_name, bool show_dont_resume)
 605 {
 606     struct bookmark_list* bookmarks;
 607     struct gui_synclist list;
 608     int last_item = -2;
 609     int item = 0;
 610     int action;
 611     size_t size;
 612     bool exit = false;
 613     bool refresh = true;
 614
 615     bookmarks = plugin_get_buffer(&size);
 616     bookmarks->buffer_size = size;
 617     bookmarks->show_dont_resume = show_dont_resume;
 618     bookmarks->filename = bookmark_file_name;
 619     bookmarks->start = 0;
 620     gui_synclist_init(&list, &get_bookmark_info, (void*) bookmarks, false, 2);
 621     gui_synclist_set_title(&list, str(LANG_BOOKMARK_SELECT_BOOKMARK),
 622         Icon_Bookmark);
 623     gui_syncstatusbar_draw(&statusbars, true);
 624
 625     while (!exit)
 626     {
 627         gui_syncstatusbar_draw(&statusbars, false);
 628
 629         if (refresh)
 630         {
 631             int count = get_bookmark_count(bookmark_file_name);
 632             bookmarks->total_count = count;
 633
 634             if (bookmarks->total_count < 1)
 635             {
 636                 /* No more bookmarks, delete file and exit */
 637                 gui_syncsplash(HZ, str(LANG_BOOKMARK_LOAD_EMPTY));
 638                 remove(bookmark_file_name);
 639                 return NULL;
 640             }
 641
 642             if (bookmarks->show_dont_resume)
 643             {
 644                 count++;
 645                 item++;
 646             }
 647
 648             gui_synclist_set_nb_items(&list, count * 2);
 649
 650             if (item >= count)
 651             {
 652                 /* Selected item has been deleted */
 653                 item = count - 1;
 654                 gui_synclist_select_item(&list, item * 2);
 655             }
 656
 657             buffer_bookmarks(bookmarks, bookmarks->start);
 658             gui_synclist_draw(&list);
 659             refresh = false;
 660         }
 661
 662         action = get_action(CONTEXT_BOOKMARKSCREEN, HZ / 2);
 663         gui_synclist_do_button(&list, action, LIST_WRAP_UNLESS_HELD);
 664         item = gui_synclist_get_sel_pos(&list) / 2;
 665
 666         if (bookmarks->show_dont_resume)
 667         {
 668             item--;
 669         }
 670
 671         if (item != last_item && talk_menus_enabled())
 672         {
 673             last_item = item;
 674
 675             if (item == -1)
 676             {
 677                 talk_id(LANG_BOOKMARK_DONT_RESUME, true);
 678             }
 679             else
 680             {
 681                 say_bookmark(bookmarks->items[item - bookmarks->start], item);
 682             }
 683         }
 684
 685         if (action == ACTION_STD_CONTEXT)
 686         {
 687             MENUITEM_STRINGLIST(menu_items, ID2P(LANG_BOOKMARK_CONTEXT_MENU),
 688                 NULL, ID2P(LANG_BOOKMARK_CONTEXT_RESUME),
 689                 ID2P(LANG_BOOKMARK_CONTEXT_DELETE));
 690             static const int menu_actions[] =
 691             {
 692                 ACTION_STD_OK, ACTION_BMS_DELETE
 693             };
 694             int selection = do_menu(&menu_items, NULL);
 695
 696             refresh = true;
 697
 698             if (selection >= 0 && selection <=
 699                 (int) (sizeof(menu_actions) / sizeof(menu_actions[0])))
 700             {
 701                 action = menu_actions[selection];
 702             }
 703         }
 704
 705         switch (action)
 706         {
 707         case ACTION_STD_OK:
 708             if (item >= 0)
 709             {
 710                 return bookmarks->items[item - bookmarks->start];
 711             }
 712
 713             /* Else fall through */
 714
 715         case ACTION_TREE_WPS:
 716         case ACTION_STD_CANCEL:
 717             exit = true;
 718             break;
 719
 720         case ACTION_BMS_DELETE:
 721             if (item >= 0)
 722             {
 723                 delete_bookmark(bookmark_file_name, item);
 724                 bookmarks->reload = true;
 725                 refresh = true;
 726                 last_item = -2;
 727             }
 728             break;
 729
 730         default:
 731             if (default_event_handler(action) == SYS_USB_CONNECTED)
 732             {
 733                 exit = true;
 734             }
 735
 736             break;
 737         }
 738     }
 739
 740     return NULL;
 741 }
 742
 743 /* ----------------------------------------------------------------------- */
 744 /* This function takes a location in a bookmark file and deletes that      */
 745 /* bookmark.                                                               */
 746 /* ------------------------------------------------------------------------*/
 747 static bool delete_bookmark(const char* bookmark_file_name, int bookmark_id)
 748 {
 749     int temp_bookmark_file = 0;
 750     int bookmark_file = 0;
 751     int bookmark_count = 0;
 752
 753     /* Opening up a temp bookmark file */
 754     snprintf(global_temp_buffer, sizeof(global_temp_buffer),
 755              "%s.tmp", bookmark_file_name);
 756     temp_bookmark_file = open(global_temp_buffer,
 757                               O_WRONLY | O_CREAT | O_TRUNC);
 758
 759     if (temp_bookmark_file < 0)
 760         return false; /* can't open the temp file */
 761
 762     /* Reading in the previous bookmarks and writing them to the temp file */
 763     bookmark_file = open(bookmark_file_name, O_RDONLY);
 764     if (bookmark_file >= 0)
 765     {
 766         while (read_line(bookmark_file, global_read_buffer,
 767                          sizeof(global_read_buffer)) > 0)
 768         {
 769             if (bookmark_id != bookmark_count)
 770             {
 771                 write(temp_bookmark_file, global_read_buffer,
 772                       strlen(global_read_buffer));
 773                 write(temp_bookmark_file, "\n", 1);
 774             }
 775             bookmark_count++;
 776         }
 777         close(bookmark_file);
 778     }
 779     close(temp_bookmark_file);
 780
 781     remove(bookmark_file_name);
 782     rename(global_temp_buffer, bookmark_file_name);
 783
 784     return true;
 785 }
 786
 787 /* ----------------------------------------------------------------------- */
 788 /* This function parses a bookmark, says the voice UI part of it.          */
 789 /* ------------------------------------------------------------------------*/
 790 static void say_bookmark(const char* bookmark,
 791                          int bookmark_id)
 792 {
 793     int resume_index;
 794     long ms;
 795     char dir[MAX_PATH];
 796     bool enqueue = false; /* only the first voice is not queued */
 797
 798     if (!parse_bookmark(bookmark, &resume_index, NULL, NULL, NULL,
 799         dir, sizeof(dir), &ms, NULL, NULL, NULL))
 800     {
 801         talk_id(LANG_BOOKMARK_INVALID, true);
 802         return;
 803     }
 804
 805 /* disabled, because transition between talkbox and voice UI clip is not nice */
 806 #if 0
 807     if (global_settings.talk_dir >= 3)
 808     {   /* "talkbox" enabled */
 809         char* last = strrchr(dir, '/');
 810         if (last)
 811         {   /* compose filename for talkbox */
 812             strncpy(last + 1, dir_thumbnail_name, sizeof(dir)-(last-dir)-1);
 813             talk_file(dir, enqueue);
 814             enqueue = true;
 815         }
 816     }
 817 #endif
 818     talk_id(VOICE_EXT_BMARK, enqueue);
 819     talk_number(bookmark_id + 1, true);
 820     talk_id(VOICE_BOOKMARK_SELECT_INDEX_TEXT, true);
 821     talk_number(resume_index + 1, true);
 822     talk_id(VOICE_BOOKMARK_SELECT_TIME_TEXT, true);
 823     if (ms / 60000)
 824         talk_value(ms / 60000, UNIT_MIN, true);
 825     talk_value((ms % 60000) / 1000, UNIT_SEC, true);
 826 }
 827
 828 /* ----------------------------------------------------------------------- */
 829 /* This function parses a bookmark and then plays it.                      */
 830 /* ------------------------------------------------------------------------*/
 831 static bool play_bookmark(const char* bookmark)
 832 {
 833     int index;
 834     int offset;
 835     int seed;
 836
 837     if (parse_bookmark(bookmark,
 838                        &index,
 839                        &offset,
 840                        &seed,
 841                        NULL,
 842                        global_temp_buffer,
 843                        sizeof(global_temp_buffer),
 844                        NULL,
 845                        &global_settings.repeat_mode,
 846                        &global_settings.playlist_shuffle,
 847                        global_filename))
 848     {
 849         bookmark_play(global_temp_buffer, index, offset, seed,
 850             global_filename);
 851         return true;
 852     }
 853
 854     return false;
 855 }
 856
 857 static const char* skip_token(const char* s)
 858 {
 859     while (*s && *s != ';')
 860     {
 861         s++;
 862     }
 863
 864     if (*s)
 865     {
 866         s++;
 867     }
 868
 869     return s;
 870 }
 871
 872 static const char* int_token(const char* s, int* dest)
 873 {
 874     if (dest != NULL)
 875     {
 876         *dest = atoi(s);
 877     }
 878
 879     return skip_token(s);
 880 }
 881
 882 static const char* long_token(const char* s, long* dest)
 883 {
 884     if (dest != NULL)
 885     {
 886         *dest = atoi(s);    /* Should be atol, but we don't have it. */
 887     }
 888
 889     return skip_token(s);
 890 }
 891
 892 static const char* bool_token(const char* s, bool* dest)
 893 {
 894     if (dest != NULL)
 895     {
 896         *dest = atoi(s) != 0;
 897     }
 898
 899     return skip_token(s);
 900 }
 901
 902 /* ----------------------------------------------------------------------- */
 903 /* This function takes a bookmark and parses it.  This function also       */
 904 /* validates the bookmark.  Passing in NULL for an output variable         */
 905 /* indicates that value is not requested.                                  */
 906 /* ----------------------------------------------------------------------- */
 907 static bool parse_bookmark(const char *bookmark,
 908                            int *resume_index,
 909                            int *resume_offset,
 910                            int *resume_seed,
 911                            int *resume_first_index,
 912                            char* resume_file,
 913                            unsigned int resume_file_size,
 914                            long* ms,
 915                            int * repeat_mode, bool *shuffle,
 916                            char* file_name)
 917 {
 918     const char* s = bookmark;
 919     const char* end;
 920
 921     s = int_token(s,  resume_index);
 922     s = int_token(s,  resume_offset);
 923     s = int_token(s,  resume_seed);
 924     s = int_token(s,  resume_first_index);
 925     s = long_token(s, ms);
 926     s = int_token(s,  repeat_mode);
 927     s = bool_token(s, shuffle);
 928
 929     if (*s == 0)
 930     {
 931         return false;
 932     }
 933
 934     end = strchr(s, ';');
 935
 936     if (resume_file != NULL)
 937     {
 938         size_t len = (end == NULL) ? strlen(s) : (size_t) (end - s);
 939
 940         len = MIN(resume_file_size - 1, len);
 941         strncpy(resume_file, s, len);
 942         resume_file[len] = 0;
 943     }
 944
 945     if (end != NULL && file_name != NULL)
 946     {
 947         end++;
 948         strncpy(file_name, end, MAX_PATH - 1);
 949         file_name[MAX_PATH - 1] = 0;
 950     }
 951
 952     return true;
 953 }
 954
 955 /* ----------------------------------------------------------------------- */
 956 /* This function is used by multiple functions and is used to generate a   */
 957 /* bookmark named based off of the input.                                  */
 958 /* Changing this function could result in how the bookmarks are stored.    */
 959 /* it would be here that the centralized/decentralized bookmark code       */
 960 /* could be placed.                                                        */
 961 /* ----------------------------------------------------------------------- */
 962 static bool generate_bookmark_file_name(const char *in)
 963 {
 964     int len = strlen(in);
 965
 966     /* if this is a root dir MP3, rename the bookmark file root_dir.bmark */
 967     /* otherwise, name it based on the in variable */
 968     if (!strcmp("/", in))
 969         strcpy(global_bookmark_file_name, "/root_dir.bmark");
 970     else
 971     {
 972         strcpy(global_bookmark_file_name, in);
 973         if(global_bookmark_file_name[len-1] == '/')
 974             len--;
 975         strcpy(&global_bookmark_file_name[len], ".bmark");
 976     }
 977
 978     return true;
 979 }
 980
 981 /* ----------------------------------------------------------------------- */
 982 /* Returns true if a bookmark file exists for the current playlist         */
 983 /* ----------------------------------------------------------------------- */
 984 bool bookmark_exist(void)
 985 {
 986     bool exist=false;
 987
 988     if(system_check())
 989     {
 990         char* name = playlist_get_name(NULL, global_temp_buffer,
 991                                        sizeof(global_temp_buffer));
 992         if (generate_bookmark_file_name(name))
 993         {
 994             int fd=open(global_bookmark_file_name, O_RDONLY);
 995             if (fd >=0)
 996             {
 997                 close(fd);
 998                 exist=true;
 999             }
1000         }
1001     }
1002
1003     return exist;
1004 }
1005
1006 /* ----------------------------------------------------------------------- */
1007 /* Checks the current state of the system and returns if it is in a        */
1008 /* bookmarkable state.                                                     */
1009 /* ----------------------------------------------------------------------- */
1010 /* Inputs:                                                                 */
1011 /* ----------------------------------------------------------------------- */
1012 /* Outputs:                                                                */
1013 /* return bool:  Indicates if the system was in a bookmarkable state       */
1014 /* ----------------------------------------------------------------------- */
1015 static bool system_check(void)
1016 {
1017     int resume_index = 0;
1018     struct mp3entry *id3 = audio_current_track();
1019
1020     if (!id3)
1021     {
1022         /* no track playing */
1023         return false;
1024     }
1025
1026     /* Checking to see if playing a queued track */
1027     if (playlist_get_resume_info(&resume_index) == -1)
1028     {
1029         /* something bad happened while getting the queue information */
1030         return false;
1031     }
1032     else if (playlist_modified(NULL))
1033     {
1034         /* can't bookmark while in the queue */
1035         return false;
1036     }
1037
1038     return true;
1039 }
1040