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