apps/bookmark.c

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