Added Benjamin Metzlers bookmarking feature (patch #669440)

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@4227 a1c6a512-1295-4272-9138-f99709370657

1 files changed, 1105 insertions, 0 deletions

diff --git a/apps/bookmark.c b/apps/bookmark.c
new file mode 100644
index 0000000000..b557e88fb2
--- /dev/null
+++ b/apps/bookmark.c
@@ -0,0 +1,1105 @@
+ /***************************************************************************
+ *             __________               __   ___.
+ *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
+ *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
+ *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
+ *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
+ *                     \/            \/     \/    \/            \/
+ *
+ * Copyright (C) 2003 by Benjamin Metzler
+ *
+ * All files in this archive are subject to the GNU General Public License.
+ * See the file COPYING in the source tree root for full license agreement.
+ *
+ * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
+ * KIND, either express or implied.
+ *
+ ****************************************************************************/
+
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stdbool.h>
+
+#include "applimits.h"
+#include "lcd.h"
+#include "button.h"
+#include "usb.h"
+#include "mpeg.h"
+#include "wps.h"
+#include "settings.h"
+#include "bookmark.h"
+#include "dir.h"
+#include "status.h"
+#include "system.h"
+#include "errno.h"
+#include "icons.h"
+#include "atoi.h"
+#include "string.h"
+#include "menu.h"
+#include "lang.h"
+#include "screens.h"
+#include "status.h"
+#include "debug.h"
+#include "kernel.h"
+
+#define MAX_BOOKMARK_SIZE  350
+#define RECENT_BOOKMARK_FILE ROCKBOX_DIR "/most-recent.bmark"
+
+static bool  add_bookmark(char* bookmark_file_name, char* bookmark);
+static bool  bookmark_load_menu(void);
+static bool  check_bookmark(char* bookmark);
+static char* create_bookmark(void);
+static bool  delete_bookmark(char* bookmark_file_name, int bookmark_id);
+static void  display_bookmark(char* bookmark,
+                              int bookmark_id, 
+                              int bookmark_count);
+static bool  generate_bookmark_file_name(char *in,
+                                         char *out,
+                                         unsigned int max_length);
+static char* get_bookmark(char* bookmark_file, int bookmark_count);
+static bool  parse_bookmark(char *bookmark,
+                            int *resume_index,
+                            int *resume_offset,
+                            int *resume_seed,
+                            int *resume_first_index,
+                            char* resume_file,
+                            unsigned int resume_file_size,
+                            int* ms,
+                            int * repeat_mode,
+                            bool *shuffle,
+                            char* file_name,
+                            unsigned int max_file_name_size);
+static char* select_bookmark(char* bookmark_file_name);
+static bool  system_check(void);
+static bool  write_bookmark(bool create_bookmark_file);
+static int   get_bookmark_count(char* bookmark_file_name);
+
+static char global_temp_buffer[MAX_PATH+1];
+static char global_bookmark_file_name[MAX_PATH];
+static char global_read_buffer[MAX_BOOKMARK_SIZE];
+static char global_bookmark[MAX_BOOKMARK_SIZE];
+
+/* ----------------------------------------------------------------------- */
+/* Displays the bookmark menu options for the user to decide.  This is an  */
+/* interface function.                                                     */
+/* ----------------------------------------------------------------------- */
+bool bookmark_menu(void)
+{
+    int m;
+    bool result;
+
+    struct menu_items items[] = {
+        { str(LANG_BOOKMARK_MENU_CREATE), bookmark_create_menu},
+        { str(LANG_BOOKMARK_MENU_LIST), bookmark_load_menu},
+        { str(LANG_BOOKMARK_MENU_RECENT_BOOKMARKS), bookmark_mrb_load},
+    };
+
+    m=menu_init( items, sizeof items / sizeof(struct menu_items) );
+
+#ifdef HAVE_LCD_CHARCELLS
+    status_set_param(true);
+#endif
+    result = menu_run(m);
+#ifdef HAVE_LCD_CHARCELLS
+    status_set_param(false);
+#endif
+    menu_exit(m);
+
+    settings_save();
+
+    return result;
+}
+
+/* ----------------------------------------------------------------------- */
+/* This is the interface function from the main menu.                      */
+/* ----------------------------------------------------------------------- */
+bool bookmark_create_menu(void)
+{
+    write_bookmark(true);
+    return false;
+}
+
+/* ----------------------------------------------------------------------- */
+/* This function acts as the load interface from the main menu             */
+/* This function determines the bookmark file name and then loads that file*/
+/* for the user.  The user can then select a bookmark to load.             */
+/* If no file/directory is currently playing, the menu item does not work. */
+/* ----------------------------------------------------------------------- */
+static bool bookmark_load_menu(void)
+{
+    bool success = true;
+    int  offset;
+    int  seed;
+    int  index;
+    char* bookmark;
+
+    if(!system_check())
+        return false;
+    else
+    {
+        char* name = playlist_get_name(global_temp_buffer,
+                                       sizeof(global_temp_buffer));
+        if (generate_bookmark_file_name(name,
+                                        global_bookmark_file_name,
+                                        sizeof(global_bookmark_file_name)))
+        {
+            bookmark = select_bookmark(global_bookmark_file_name);
+            if (!bookmark)
+                return false;  /* User exited without selecting a bookmark */
+
+            success = parse_bookmark(bookmark,
+                                     &index,
+                                     &offset,
+                                     &seed,
+                                     NULL,
+                                     global_temp_buffer,
+                                     sizeof(global_temp_buffer),
+                                     NULL,
+                                     &global_settings.repeat_mode,
+                                     &global_settings.playlist_shuffle,
+                                     NULL, 0);
+        }
+        else
+        {
+            /* something bad happened while creating bookmark name*/
+            success = false;
+        }
+
+        if (success)
+            bookmark_play(global_temp_buffer, index, offset, seed);
+    }
+
+    return success;
+}
+
+/* ----------------------------------------------------------------------- */
+/* Gives the user a list of the Most Recent Bookmarks.  This is an         */
+/* interface function                                                      */
+/* ----------------------------------------------------------------------- */
+bool bookmark_mrb_load()
+{
+    bool success = true;
+    int  offset;
+    int  seed;
+    int  index;
+    char* bookmark;
+
+    bookmark = select_bookmark(RECENT_BOOKMARK_FILE);
+    if (!bookmark)
+        return false;  /* User exited without selecting a bookmark */
+
+    success = parse_bookmark(bookmark,
+                             &index,
+                             &offset,
+                             &seed,
+                             NULL,
+                             global_temp_buffer,
+                             sizeof(global_temp_buffer),
+                             NULL,
+                             &global_settings.repeat_mode,
+                             &global_settings.playlist_shuffle,
+                             NULL, 0);
+
+    if (success)
+        bookmark_play(global_temp_buffer, index, offset, seed);
+
+    return success;
+}
+
+
+/* ----------------------------------------------------------------------- */
+/* This function handles an autobookmark creation.  This is an interface   */
+/* function.                                                               */
+/* ----------------------------------------------------------------------- */
+bool bookmark_autobookmark(void)
+{
+    /* prompts the user as to create a bookmark */
+    bool done = false;
+    int  key = 0;
+
+    if (!system_check())
+        return false;
+
+    mpeg_pause();    /* first pause playback */
+    switch (global_settings.autocreatebookmark)
+    {
+        case BOOKMARK_YES:
+            return write_bookmark(true);
+
+        case BOOKMARK_NO:
+            return false;
+
+        case BOOKMARK_RECENT_ONLY_YES:
+            return write_bookmark(false);
+    }
+
+    /* Prompting user to confirm bookmark creation */
+    lcd_clear_display();
+#ifdef HAVE_LCD_BITMAP
+    lcd_puts(0,0, str(LANG_AUTO_BOOKMARK_QUERY));
+    lcd_puts(0,1, str(LANG_CONFIRM_WITH_PLAY_RECORDER));
+    lcd_puts(0,2, str(LANG_CANCEL_WITH_ANY_RECORDER));
+#else
+    status_draw(false);
+    lcd_puts(0,0, str(LANG_AUTO_BOOKMARK_QUERY));
+    lcd_puts(0,1,str(LANG_RESUME_CONFIRM_PLAYER));
+#endif
+    lcd_update();
+
+    while (!done)
+    {
+        /* Wait for a key to be pushed */
+        key = button_get(true);
+        switch (key)
+        {
+            case BUTTON_DOWN | BUTTON_REL:
+            case BUTTON_ON | BUTTON_REL:
+#ifdef HAVE_RECORDER_KEYPAD
+            case BUTTON_OFF | BUTTON_REL:
+            case BUTTON_RIGHT | BUTTON_REL:
+            case BUTTON_UP | BUTTON_REL:
+#endif
+            case BUTTON_LEFT | BUTTON_REL:
+                done = true;
+                break;
+
+            case BUTTON_PLAY | BUTTON_REL:
+                if (global_settings.autocreatebookmark ==
+                    BOOKMARK_RECENT_ONLY_ASK)
+                    write_bookmark(false);
+                else
+                    write_bookmark(true);
+                done = true;
+                break;
+
+            case SYS_USB_CONNECTED:
+                usb_screen();
+#ifdef HAVE_LCD_CHARCELLS
+                status_set_param(true);
+#endif
+                return false;
+        }
+    }
+    return true;
+}
+
+/* ----------------------------------------------------------------------- */
+/* This function takes the current current resume information and writes   */
+/* that to the beginning of the bookmark file.                             */
+/* This file will contain N number of bookmarks in the following format:   */
+/* resume_index*resume_offset*resume_seed*resume_first_index*              */
+/* resume_file*milliseconds*MP3 Title*                                     */
+/* ------------------------------------------------------------------------*/
+static bool write_bookmark(bool create_bookmark_file)
+{
+    bool   success=false;
+    char*  bookmark;
+
+    if (!system_check())
+       return false; /* something didn't happen correctly, do nothing */
+
+    bookmark = create_bookmark();
+    if (!bookmark)
+       return false; /* something didn't happen correctly, do nothing */
+
+    if (global_settings.usemrb)
+        success = add_bookmark(RECENT_BOOKMARK_FILE, bookmark);
+
+
+    /* writing the bookmark */
+    if (create_bookmark_file)
+    {
+        char* name = playlist_get_name(global_temp_buffer,
+                                       sizeof(global_temp_buffer));
+        if (generate_bookmark_file_name(name,
+                                        global_bookmark_file_name,
+                                        sizeof(global_bookmark_file_name)))
+        {
+            success = add_bookmark(global_bookmark_file_name, bookmark);
+        }
+    }
+
+    if (success)
+        splash(HZ, true, str(LANG_BOOKMARK_CREATE_SUCCESS));
+    else
+        splash(HZ, true, str(LANG_BOOKMARK_CREATE_FAILURE));
+
+    return true;
+}
+
+/* ----------------------------------------------------------------------- */
+/* This function adds a bookmark to a file.                                */
+/* ------------------------------------------------------------------------*/
+static bool add_bookmark(char* bookmark_file_name, char* bookmark)
+{
+    int    temp_bookmark_file = 0;
+    int    bookmark_file = 0;
+    int    bookmark_count = 0;
+    char*  playlist = NULL;
+    char*  cp;
+    int    len = 0;
+    bool   unique = false;
+
+    /* Opening up a temp bookmark file */
+    snprintf(global_temp_buffer, sizeof(global_temp_buffer),
+             "%s.tmp", bookmark_file_name);
+    temp_bookmark_file = open(global_temp_buffer,
+                              O_WRONLY | O_CREAT | O_TRUNC);
+    if (temp_bookmark_file < 0)
+        return false; /* can't open the temp file */
+
+    if (!strcmp(bookmark_file_name,RECENT_BOOKMARK_FILE) &&
+        (global_settings.usemrb == BOOKMARK_UNIQUE_ONLY))
+    {
+        playlist = strchr(bookmark,'/');
+        cp = strrchr(bookmark,';');
+        len = cp - playlist;
+        unique = true;
+    }
+
+    /* Writing the new bookmark to the begining of the temp file */
+    write(temp_bookmark_file, bookmark, strlen(bookmark));
+    write(temp_bookmark_file, "\n", 1);
+
+    /* Reading in the previous bookmarks and writing them to the temp file */
+    bookmark_file = open(bookmark_file_name, O_RDONLY);
+    if (bookmark_file >= 0)
+    {
+        while (read_line(bookmark_file, global_read_buffer,
+                         sizeof(global_read_buffer)))
+        {
+            if (unique)
+            {
+                cp=strchr(global_read_buffer,'/');
+                if (check_bookmark(global_read_buffer) &&
+                    strncmp(playlist,cp,len))
+                {
+                    bookmark_count++;
+                    write(temp_bookmark_file, global_read_buffer,
+                          strlen(global_read_buffer));
+                    write(temp_bookmark_file, "\n", 1);
+                }
+            }
+            else
+            {
+                if (check_bookmark(global_read_buffer))
+                {
+                    bookmark_count++;
+                    write(temp_bookmark_file, global_read_buffer,
+                          strlen(global_read_buffer));
+                    write(temp_bookmark_file, "\n", 1);
+                }
+            }
+        }
+        close(bookmark_file);
+    }
+    close(temp_bookmark_file);
+
+    remove(bookmark_file_name);
+    rename(global_temp_buffer, bookmark_file_name);
+
+    return true;
+}
+
+
+/* ----------------------------------------------------------------------- */
+/* This function takes the system resume data and formats it into a valid  */
+/* bookmark.                                                               */
+/* ----------------------------------------------------------------------- */
+static char* create_bookmark()
+{
+    int resume_index = 0;
+    char *file;
+
+    /* grab the currently playing track */
+    struct mp3entry *id3 = mpeg_current_track();
+    if(!id3)
+        return NULL;
+
+    /* Get some basic resume information */
+    /* queue_resume and queue_resume_index are not used and can be ignored.*/
+    playlist_get_resume_info(&resume_index);
+
+    /* Get the currently playing file minus the path */
+    /* This is used when displaying the available bookmarks */
+    file = strrchr(id3->path,'/');
+    if(NULL == file)
+        return NULL;
+
+    /* create the bookmark */
+    snprintf(global_bookmark, sizeof(global_bookmark),
+             "%d;%d;%d;%d;%d;%d;%d;%s;%s",
+             resume_index,
+             id3->offset,
+             playlist_get_seed(),
+             0,
+             id3->elapsed,
+             global_settings.repeat_mode,
+             global_settings.playlist_shuffle,
+             playlist_get_name(global_temp_buffer,sizeof(global_temp_buffer)),
+             file+1);
+
+    /* checking to see if the bookmark is valid */
+    if (check_bookmark(global_bookmark))
+        return global_bookmark;
+    else
+        return NULL;
+}
+
+static bool check_bookmark(char* bookmark)
+{
+    return parse_bookmark(bookmark,
+                          NULL,NULL,NULL, NULL,
+                          NULL,0,NULL,NULL,
+                          NULL, NULL, 0);
+}
+
+/* ----------------------------------------------------------------------- */
+/* This function will determine if an autoload is necessary.  This is an   */
+/* interface function.                                                     */
+/* ------------------------------------------------------------------------*/
+bool bookmark_autoload(char* file)
+{
+    int  key;
+    int  fd;
+    bool done = false;
+
+    if(global_settings.autoloadbookmark == BOOKMARK_NO)
+        return false;
+
+    /*Checking to see if a bookmark file exists.*/
+    if(!generate_bookmark_file_name(file,
+                                   global_bookmark_file_name,
+                                   sizeof(global_bookmark_file_name)))
+    {
+        return false;
+    }
+
+    fd = open(global_bookmark_file_name, O_RDONLY);
+    if(fd<0)
+        return false;
+    if(-1 == lseek(fd, 0, SEEK_END))
+    {
+        close(fd);
+        return false;
+    }
+    close(fd);
+
+    if(global_settings.autoloadbookmark == BOOKMARK_YES)
+    {
+        return bookmark_load(global_bookmark_file_name, true);
+    }
+    else
+    {
+        while (button_get(false)); /* clear button queue */
+        /* Prompting user to confirm bookmark load */
+        lcd_clear_display();
+#ifdef HAVE_LCD_BITMAP
+        lcd_puts_scroll(0,0, str(LANG_BOOKMARK_AUTOLOAD_QUERY));
+        lcd_puts(0,1, str(LANG_CONFIRM_WITH_PLAY_RECORDER));
+        lcd_puts(0,2, str(LANG_BOOKMARK_SELECT_LIST_BOOKMARKS));
+        lcd_puts(0,3, str(LANG_CANCEL_WITH_ANY_RECORDER));
+#else
+        status_draw(false);
+        lcd_puts_scroll(0,0, str(LANG_BOOKMARK_AUTOLOAD_QUERY));
+        lcd_puts(0,1,str(LANG_RESUME_CONFIRM_PLAYER));
+#endif
+        lcd_update();
+
+        sleep(100);
+
+        while(!done)
+        {
+            /* Wait for a key to be pushed */
+            while (button_get(false)); /* clear button queue */
+            key = button_get(true);
+            switch(key)
+            {
+                default:
+                    return false;
+#ifdef HAVE_LCD_BITMAP
+                case BUTTON_DOWN:
+                    return bookmark_load(global_bookmark_file_name, false);
+#endif
+                case BUTTON_PLAY:
+                    return bookmark_load(global_bookmark_file_name, true);
+                case SYS_USB_CONNECTED:
+                    status_set_playmode(STATUS_STOP);
+                    usb_screen();
+#ifdef HAVE_LCD_CHARCELLS
+                    status_set_param(true);
+#endif
+                    return true;
+            }
+        }
+        return true;
+    }
+}
+
+/* ----------------------------------------------------------------------- */
+/* This function loads the bookmark information into the resume memory.    */
+/* This is an interface function.                                          */
+/* ------------------------------------------------------------------------*/
+bool bookmark_load(char* file, bool autoload)
+{
+    int  fd;
+    bool success = true;
+    int  offset;
+    int  seed;
+    int  index;
+    char* bookmark = NULL;;
+
+    if(autoload)
+    {
+        fd = open(file, O_RDONLY);
+        if(fd >= 0)
+        {
+            if(read_line(fd, global_read_buffer, sizeof(global_read_buffer)))
+                bookmark=global_read_buffer;
+            close(fd);
+        }
+    }
+    else
+    {
+        /* This is not an auto-load, so list the bookmarks */
+        bookmark=select_bookmark(file);
+        if(!bookmark)
+            return true;  /* User exited without selecting a bookmark */
+    }
+
+    if(bookmark)
+    {
+        success = parse_bookmark(bookmark,
+                                &index,
+                                &offset,
+                                &seed,
+                                NULL,
+                                global_temp_buffer,
+                                sizeof(global_temp_buffer),
+                                NULL,
+                                &global_settings.repeat_mode,
+                                &global_settings.playlist_shuffle,
+                                NULL, 0);
+
+    }
+
+    if(success)
+        bookmark_play(global_temp_buffer,index,offset,seed);
+
+    return success;
+}
+
+
+static int get_bookmark_count(char* bookmark_file_name)
+{
+    int read_count = 0;
+    int file = open(bookmark_file_name, O_RDONLY);
+
+    if(file < 0)
+        return -1;
+
+    /* Get the requested bookmark */
+    while(read_line(file, global_read_buffer, sizeof(global_read_buffer)))
+    {
+        if(check_bookmark(global_read_buffer))
+            read_count++;
+    }
+    
+    close(file);
+    return read_count;
+ 
+    
+}
+
+
+/* ----------------------------------------------------------------------- */
+/* This displays a the bookmarks in a file and allows the user to          */
+/* select one to play.                                                     */
+/* ------------------------------------------------------------------------*/
+static char* select_bookmark(char* bookmark_file_name)
+{
+    int bookmark_id = 0;
+    bool delete_this_bookmark = true;
+    int  key = 0;
+    char* bookmark;
+    int bookmark_count = 0;
+
+    while(true)
+    {
+        /* Handles the case where the user wants to go below the 0th bookmark */
+        if(bookmark_id < 0)
+            bookmark_id = 0;
+
+        if(delete_this_bookmark)
+        {
+            bookmark_count = get_bookmark_count(bookmark_file_name);
+            delete_this_bookmark = false;
+        }
+        
+        bookmark = get_bookmark(bookmark_file_name, bookmark_id);
+
+        if (!bookmark)
+        {
+            /* if there were no bookmarks in the file, delete the file and exit. */
+            if(bookmark_id == 0)
+            {
+                splash(HZ, true, str(LANG_BOOKMARK_LOAD_EMPTY));
+                remove(bookmark_file_name);
+                while (button_get(false)); /* clear button queue */
+                return NULL;
+            }
+            else
+            {
+               bookmark_id--;
+            }
+        }
+        else
+        {
+            display_bookmark(bookmark, bookmark_id, bookmark_count);
+        }
+
+        /* waiting for the user to click a button */
+        while (button_get(false)); /* clear button queue */
+        key = button_get(true);
+        switch(key)
+        {
+            case BUTTON_PLAY:
+                /* User wants to use this bookmark */
+                return bookmark;
+
+            case BUTTON_ON | BUTTON_PLAY:
+                /* User wants to delete this bookmark */
+                delete_this_bookmark = true;
+                break;
+
+            case SYS_USB_CONNECTED:
+                usb_screen();
+#ifdef HAVE_LCD_CHARCELLS
+                status_set_param(true);
+#endif
+                return NULL;
+#ifdef HAVE_RECORDER_KEYPAD
+            case BUTTON_UP:
+                bookmark_id--;
+                break;
+
+            case BUTTON_DOWN:
+                bookmark_id++;
+                break;
+
+            case BUTTON_LEFT:
+            case BUTTON_OFF:
+                return NULL;
+#else
+            case BUTTON_LEFT:
+                bookmark_id--;
+                break;
+
+            case BUTTON_RIGHT:
+                bookmark_id++;
+                break;
+
+            case BUTTON_STOP:
+                return NULL;
+#endif
+        }
+
+        if (delete_this_bookmark)
+        {
+           delete_bookmark(bookmark_file_name, bookmark_id);
+           bookmark_id--;
+        }
+    }
+
+    return NULL;
+}
+
+
+/* ----------------------------------------------------------------------- */
+/* This function takes a location in a bookmark file and deletes that      */
+/* bookmark.                                                               */
+/* ------------------------------------------------------------------------*/
+static bool delete_bookmark(char* bookmark_file_name, int bookmark_id)
+{
+    int temp_bookmark_file = 0;
+    int bookmark_file = 0;
+    int bookmark_count = 0;
+
+    /* Opening up a temp bookmark file */
+    snprintf(global_temp_buffer, sizeof(global_temp_buffer),
+             "%s.tmp", bookmark_file_name);
+    temp_bookmark_file = open(global_temp_buffer,
+                              O_WRONLY | O_CREAT | O_TRUNC);
+    bookmark_file = open(bookmark_file_name, O_RDONLY);
+
+    if (temp_bookmark_file < 0 || bookmark_file < 0)
+        return false; /* can't open one of the files */
+
+    /* Reading in the previous bookmarks and writing them to the temp file */
+    while (read_line(bookmark_file, global_read_buffer,
+                     sizeof(global_read_buffer)))
+    {
+        if (check_bookmark(global_read_buffer))
+        {
+            if (bookmark_id != bookmark_count)
+            {
+                write(temp_bookmark_file, global_read_buffer,
+                      strlen(global_read_buffer));
+                write(temp_bookmark_file, "\n", 1);
+            }
+            bookmark_count++;
+        }
+    }
+
+    close(bookmark_file);
+    close(temp_bookmark_file);
+
+    remove(bookmark_file_name);
+    rename(global_temp_buffer, bookmark_file_name);
+
+    return true;
+}
+
+/* ----------------------------------------------------------------------- */
+/* This function parses a bookmark and displays it for the user.           */
+/* ------------------------------------------------------------------------*/
+static void display_bookmark(char* bookmark,
+                             int bookmark_id,
+                             int bookmark_count)
+{
+    int  resume_index = 0;
+    int  ms = 0;
+    int  repeat_mode = 0;
+    bool playlist_shuffle = false;
+    char MP3_file_name[45];
+    int  len;
+    char *dot;
+
+    /* getting the index and the time into the file */
+    parse_bookmark(bookmark,
+                   &resume_index, NULL, NULL, NULL, NULL, 0,
+                   &ms, &repeat_mode, &playlist_shuffle,
+                   MP3_file_name, sizeof(MP3_file_name));
+
+    lcd_clear_display();
+    lcd_stop_scroll();
+
+#ifdef HAVE_LCD_BITMAP
+    /* bookmark shuffle and repeat states*/
+    switch (repeat_mode)
+    {
+        case REPEAT_ONE:
+            statusbar_icon_play_mode(Icon_RepeatOne);
+            break;
+
+        case REPEAT_ALL:
+            statusbar_icon_play_mode(Icon_Repeat);
+            break;
+    }
+    if(playlist_shuffle)
+        statusbar_icon_shuffle();
+
+    /* File Name */
+    len=strlen(MP3_file_name);
+    if (len>3)
+      dot=strrchr(MP3_file_name + len - 4, '.');
+    else
+      dot=NULL;
+    if (dot)
+        *dot='\0';
+    lcd_puts_scroll(0, 0, MP3_file_name);
+    if (dot)
+        *dot='.';
+
+    /* bookmark number */
+    snprintf(global_temp_buffer, sizeof(global_temp_buffer), "%s: %2d/%2d",
+             str(LANG_BOOKMARK_SELECT_BOOKMARK_TEXT),
+             bookmark_id + 1, bookmark_count);
+    lcd_puts_scroll(0, 1, global_temp_buffer);
+
+    /* bookmark resume index */
+    snprintf(global_temp_buffer, sizeof(global_temp_buffer), "%s: %2d",
+             str(LANG_BOOKMARK_SELECT_INDEX_TEXT), resume_index+1);
+    lcd_puts_scroll(0, 2, global_temp_buffer);
+
+    /* elapsed time*/
+    snprintf(global_temp_buffer, sizeof(global_temp_buffer), "%s: %d:%02d",
+             str(LANG_BOOKMARK_SELECT_TIME_TEXT),
+             ms / 60000,
+             ms % 60000 / 1000);
+    lcd_puts_scroll(0, 3, global_temp_buffer);
+
+    /* commands */
+    lcd_puts_scroll(0, 4, str(LANG_BOOKMARK_SELECT_PLAY));
+    lcd_puts_scroll(0, 5, str(LANG_BOOKMARK_SELECT_EXIT));
+    lcd_puts_scroll(0, 6, str(LANG_BOOKMARK_SELECT_DELETE));
+#else
+    len=strlen(MP3_file_name);
+    if (len>3)
+      dot=strrchr(MP3_file_name+len-4,'.');
+    else
+      dot=NULL;
+    if (dot)
+        *dot='\0';
+    snprintf(global_temp_buffer, sizeof(global_temp_buffer),
+             "%2d, %d:%02d, %s,",
+             (bookmark_count+1),
+             ms / 60000,
+             ms % 60000 / 1000,
+             MP3_file_name);
+    status_draw(false);
+    lcd_puts_scroll(0,0,global_temp_buffer);
+    lcd_puts(0,1,str(LANG_RESUME_CONFIRM_PLAYER));
+    if (dot)
+        *dot='.';
+#endif
+    lcd_update();
+}
+
+/* ----------------------------------------------------------------------- */
+/* This function retrieves a given bookmark from a file.                   */
+/* If the bookmark requested is beyond the number of bookmarks available   */
+/* in the file, it will return the last one.                               */
+/* It also returns the index number of the bookmark in the file            */
+/* ------------------------------------------------------------------------*/
+static char* get_bookmark(char* bookmark_file, int bookmark_count)
+{
+    int read_count = -1;
+    int result = 0;
+    int file = open(bookmark_file, O_RDONLY);
+
+    if (file < 0)
+        return NULL;
+
+    /* Get the requested bookmark */
+    while (read_count < bookmark_count)
+    {
+        /*Reading in a single bookmark */
+        result = read_line(file,
+                           global_read_buffer,
+                           sizeof(global_read_buffer));
+
+        /* Reading past the last bookmark in the file
+           causes the loop to stop */
+        if (result <= 0)
+            break;
+
+        read_count++;
+    }
+
+    close(file);
+    if (read_count == bookmark_count)
+        return global_read_buffer;
+    else
+        return NULL;
+}
+
+/* ----------------------------------------------------------------------- */
+/* This function takes a bookmark and parses it.  This function also       */
+/* validates the bookmark.  Passing in NULL for an output variable         */
+/* indicates that value is not requested.                                  */
+/* ----------------------------------------------------------------------- */
+static bool parse_bookmark(char *bookmark,
+                           int *resume_index,
+                           int *resume_offset,
+                           int *resume_seed,
+                           int *resume_first_index,
+                           char* resume_file,
+                           unsigned int resume_file_size,
+                           int* ms,
+                           int * repeat_mode, bool *shuffle,
+                           char* file_name,
+                           unsigned int max_file_name_size)
+{
+    /* First check to see if a valid line was passed in. */
+    int  bookmark_len                = strlen(bookmark);
+    int  local_resume_index          = 0;
+    int  local_resume_offset         = 0;
+    int  local_resume_seed           = 0;
+    int  local_resume_first_index    = 0;
+    int  local_mS                    = 0;
+    int  local_shuffle               = 0;
+    int  local_repeat_mode           = 0;
+    char* local_resume_file          = NULL;
+    char* local_file_name            = NULL;
+    char* field;
+    char* end;
+    static char bookmarkcopy[MAX_BOOKMARK_SIZE];
+
+    /* Don't do anything if the bookmark length is 0 */
+    if (bookmark_len <= 0)
+        return false;
+
+    /* Making a dup of the bookmark to use with strtok_r */
+    strncpy(bookmarkcopy, bookmark, sizeof(bookmarkcopy));
+    bookmarkcopy[sizeof(bookmarkcopy) - 1] = 0;
+
+    /* resume_index */
+    if ((field = strtok_r(bookmarkcopy, ";", &end)))
+        local_resume_index = atoi(field);
+    else
+        return false;
+
+    /* resume_offset */
+    if ((field = strtok_r(NULL, ";", &end)))
+        local_resume_offset = atoi(field);
+    else
+        return false;
+
+    /* resume_seed */
+    if ((field = strtok_r(NULL, ";", &end)))
+        local_resume_seed = atoi(field);
+    else
+        return false;
+
+    /* resume_first_index */
+    if ((field = strtok_r(NULL, ";", &end)))
+        local_resume_first_index = atoi(field);
+    else
+        return false;
+
+    /* Milliseconds into MP3.  Used for the bookmark select menu */
+    if ((field = strtok_r(NULL, ";", &end)))
+        local_mS = atoi(field);
+    else
+        return false;
+
+    /* repeat_mode */
+    if ((field = strtok_r(NULL, ";", &end)))
+        local_repeat_mode = atoi(field);
+    else
+        return false;
+
+    /* shuffle mode */
+    if ((field = strtok_r(NULL, ";", &end)))
+        local_shuffle = atoi(field);
+    else
+        return false;
+
+    /* resume_file & file_name (for the bookmark select menu)*/
+    if (end)
+    {
+        local_resume_file = strtok_r(NULL, ";", &end);
+        if (local_resume_file[strlen(local_resume_file) - 1] == '/')
+            local_resume_file[strlen(local_resume_file) - 1] = '\0';
+
+        if (end)
+            local_file_name = strtok_r(NULL, ";", &end);
+    }
+    else
+        return false;
+
+    /* Only return the values the calling function wants */
+    if (resume_index)
+        *resume_index = local_resume_index;
+
+    if (resume_offset)
+        *resume_offset = local_resume_offset;
+
+    if (resume_seed)
+        *resume_seed = local_resume_seed;
+
+    if (resume_first_index)
+        *resume_first_index = local_resume_first_index;
+
+    if (resume_file && local_resume_file)
+    {
+        strncpy(resume_file, local_resume_file,
+                MIN(strlen(local_resume_file), resume_file_size-1));
+        resume_file[MIN(strlen(local_resume_file), resume_file_size-1)]=0;
+    }
+
+    if (ms)
+        *ms = local_mS;
+
+    if (shuffle)
+        *shuffle = local_shuffle;
+
+    if (repeat_mode)
+        *repeat_mode = local_repeat_mode;
+
+    if (file_name && local_file_name)
+    {
+        strncpy(file_name, local_file_name,
+                MIN(strlen(local_file_name),max_file_name_size-1));
+        file_name[MIN(strlen(local_file_name),max_file_name_size-1)]=0;
+    }
+
+    return true;
+}
+
+/* ----------------------------------------------------------------------- */
+/* This function is used by multiple functions and is used to generate a   */
+/* bookmark named based off of the input.                                  */
+/* Changing this function could result in how the bookmarks are stored.    */
+/* it would be here that the centralized/decentralized bookmark code       */
+/* could be placed.                                                        */
+/* ----------------------------------------------------------------------- */
+static bool generate_bookmark_file_name(char *in, char *out,
+                                        unsigned int max_length)
+{
+    char* cp;
+
+    if (!in || !out || max_length <= 0)
+        return false;
+
+    if (max_length < strlen(in)+6)
+        return false;
+
+    /* if this is a root dir MP3, rename the boomark file root_dir.bmark */
+    /* otherwise, name it based on the in variable */
+    cp = in;
+
+    cp = in + strlen(in) - 1;
+    if (*cp == '/')
+        *cp = 0;
+
+    cp = in;
+    if (*cp == '/')
+        cp++;
+
+    if (strlen(in) > 0)
+        snprintf(out, max_length, "/%s.%s", cp, "bmark");
+    else
+        snprintf(out, max_length, "/root_dir.%s", "bmark");
+
+    return true;
+}
+
+/* ----------------------------------------------------------------------- */
+/* Checks the current state of the system and returns if it is in a        */
+/* bookmarkable state.                                                     */
+/* ----------------------------------------------------------------------- */
+/* Inputs:                                                                 */
+/* ----------------------------------------------------------------------- */
+/* Outputs:                                                                */
+/* return bool:  Indicates if the system was in a bookmarkable state       */
+/* ----------------------------------------------------------------------- */
+static bool system_check(void)
+{
+    int resume_index = 0;
+    struct mp3entry *id3 = mpeg_current_track();
+
+    if (!id3)
+    {
+        /* no track playing */
+        return false; 
+    }
+
+    /* Checking to see if playing a queued track */
+    if (playlist_get_resume_info(&resume_index) == -1)
+    {
+        /* something bad happened while getting the queue information */
+        return false;
+    }
+    else if (playlist_modified())
+    {
+        /* can't bookmark while in the queue */
+        return false;
+    }
+
+    return true;
+}
+