summaryrefslogtreecommitdiffstats
path: root/apps/bookmark.c
blob: f3c712240a51748da8d2a1a7ae5ecd33c290bcc8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 *
 * Copyright (C)2003 by Benjamin Metzler
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * 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 "config.h"
#include "action.h"
#include "audio.h"
#include "playlist.h"
#include "settings.h"
#include "tree.h"
#include "bookmark.h"
#include "system.h"
#include "icons.h"
#include "menu.h"
#include "lang.h"
#include "talk.h"
#include "misc.h"
#include "splash.h"
#include "yesno.h"
#include "list.h"
#include "plugin.h"
#include "file.h"
#include "pathfuncs.h"

/*#define LOGF_ENABLE*/
#include "logf.h"

#define MAX_BOOKMARKS 10
#define MAX_BOOKMARK_SIZE  350
#define RECENT_BOOKMARK_FILE ROCKBOX_DIR "/most-recent.bmark"

/* Used to buffer bookmarks while displaying the bookmark list. */
struct bookmark_list
{
    const char* filename;
    size_t buffer_size;
    int start;
    int count;
    int total_count;
    bool show_dont_resume;
    bool reload;
    bool show_playlist_name;
    char* items[];
};

/* flags for optional bookmark tokens */
#define BM_PITCH    0x01
#define BM_SPEED    0x02

/* bookmark values */
static struct resume_info{
    const struct mp3entry *id3;
    int  resume_index;
    unsigned long resume_offset;
    int  resume_seed;
    long resume_time;
    int  repeat_mode;
    bool shuffle;
    /* optional values */
    int  pitch;
    int  speed;
} resume_info;

/* Temp buffer used for reading, create_bookmark and filename creation */
#define TEMP_BUF_SIZE (MAX(MAX_BOOKMARK_SIZE, MAX_PATH + 1))
static char global_temp_buffer[TEMP_BUF_SIZE];

static const char* skip_token(const char* s)
{
    while (*s && *s != ';')
    {
        s++;
    }

    if (*s)
    {
        s++;
    }

    return s;
}

static const char* int_token(const char* s, int* dest)
{
    *dest = atoi(s);
    return skip_token(s);
}

static const char* long_token(const char* s, long* dest)
{
    *dest = atoi(s);    /* Should be atol, but we don't have it. */
    return skip_token(s);
}

/*-------------------------------------------------------------------------*/
/* Get the name of the playlist and the name of the track from a bookmark. */
/* Returns true iff both were extracted.                                   */
/*-------------------------------------------------------------------------*/
static bool bookmark_get_playlist_and_track(const char *bookmark,
                                            char **pl_start,
                                            char **pl_end,
                                            char **track)
{
    *pl_start = strchr(bookmark,'/');
    if (!(*pl_start))
        return false;
    *pl_end = strrchr(bookmark,';');
    *track = *pl_end + 1;
    return true;
}

/* ----------------------------------------------------------------------- */
/* This function takes a bookmark and parses it.  This function also       */
/* validates the bookmark.  Valid filenamebuf indicates whether            */
/* the filename tokens are to be extracted.                                */
/* Returns true on successful bookmark parse.                              */
/* ----------------------------------------------------------------------- */
static bool parse_bookmark(char *filenamebuf,
                           size_t filenamebufsz,
                           const char *bookmark,
                           const bool strip_dir)
{
    const char* s = bookmark;
    const char* end;

#define GET_INT_TOKEN(var)  s = int_token(s, &var)
#define GET_LONG_TOKEN(var)  s = long_token(s, &var)
#define GET_BOOL_TOKEN(var) var = (atoi(s)!=0); s = skip_token(s)

    /* if new format bookmark, extract the optional content flags,
       otherwise treat as an original format bookmark */
    int opt_flags = 0;
    bool new_format = (strchr(s, '>') == s);
    if (new_format)
    {
        s++;
        GET_INT_TOKEN(opt_flags);
    }

    /* extract all original bookmark tokens */
    GET_INT_TOKEN(resume_info.resume_index);
    GET_LONG_TOKEN(resume_info.resume_offset);
    GET_INT_TOKEN(resume_info.resume_seed);
    if (!new_format)    /* skip deprecated token */
        s = skip_token(s);
    GET_LONG_TOKEN(resume_info.resume_time);
    GET_INT_TOKEN(resume_info.repeat_mode);
    GET_BOOL_TOKEN(resume_info.shuffle);

    /* extract all optional bookmark tokens */
    if (opt_flags & BM_PITCH)
        GET_INT_TOKEN(resume_info.pitch);
    if (opt_flags & BM_SPEED)
        GET_INT_TOKEN(resume_info.speed);

    if (*s == 0)
    {
        return false;
    }

    end = strchr(s, ';');

    /* extract file names */
    if(filenamebuf)
    {
        size_t len = (end == NULL) ? strlen(s) : (size_t) (end - s);
        len = MIN(TEMP_BUF_SIZE - 1, len);
        strmemccpy(global_temp_buffer, s, len + 1);

        if (end != NULL)
        {
            end++;
            if (strip_dir)
            {
                s = strrchr(end, '/');
                if (s)
                {
                    end = s;
                    end++;
                }
            }
            strmemccpy(filenamebuf, end, filenamebufsz);
        }
     }

    return true;
}

/* ------------------------------------------------------------------------- */
/* This function takes a filename and appends .tmp. This function also opens */
/* the resulting file based on oflags, filename will be in buf on return     */
/* Returns file descriptor                                                   */
/* --------------------------------------------------------------------------*/
static int open_temp_bookmark(char *buf,
                              size_t bufsz,
                              int oflags,
                              const char* filename)
{
    /* Opening up a temp bookmark file */
    int fd  = open_pathfmt(buf, bufsz, oflags, "/%s.tmp", filename);
#ifdef LOGF_ENABLE
    if (oflags & O_PATH)
        logf("tempfile path %s", buf);
    else
        logf("opening tempfile %s", buf);
#endif
    return fd;
    
}

/* ----------------------------------------------------------------------- */
/* This function adds a bookmark to a file.                                */
/* Returns true on successful bookmark add.                                */
/* ------------------------------------------------------------------------*/
static bool add_bookmark(const char* bookmark_file_name,
                         const char* bookmark,
                         bool most_recent)
{
    char fnamebuf[MAX_PATH];
    int  temp_bookmark_file = 0;
    int  bookmark_file = 0;
    int  bookmark_count = 0;
    char *pl_start = NULL, *bm_pl_start;
    char *pl_end = NULL, *bm_pl_end;
    int  pl_len = 0, bm_pl_len;
    char *track = NULL, *bm_track;
    bool comp_playlist = false;
    bool comp_track = false;
    bool equal;

    /* Opening up a temp bookmark file */
    temp_bookmark_file = open_temp_bookmark(fnamebuf,
                                            sizeof(fnamebuf),
                                            O_WRONLY | O_CREAT | O_TRUNC,
                                            bookmark_file_name);

    if (temp_bookmark_file < 0 || !bookmark)
        return false; /* can't open the temp file or no bookmark */

    if (most_recent && ((global_settings.usemrb == BOOKMARK_ONE_PER_PLAYLIST)
                      || (global_settings.usemrb == BOOKMARK_ONE_PER_TRACK)))
    {
        if (bookmark_get_playlist_and_track(bookmark, &pl_start, &pl_end, &track))
        {
            comp_playlist = true;
            pl_len = pl_end - pl_start;
            if (global_settings.usemrb == BOOKMARK_ONE_PER_TRACK)
                comp_track = true;
        }
    }
    logf("adding bookmark to %s [%s]", fnamebuf, bookmark);
    /* Writing the new bookmark to the begining of the temp file */
    write(temp_bookmark_file, bookmark, strlen(bookmark));
    write(temp_bookmark_file, "\n", 1);
    bookmark_count++;

    /* Reading in the previous bookmarks and writing them to the temp file */
    logf("opening old bookmark %s", bookmark_file_name);
    bookmark_file = open(bookmark_file_name, O_RDONLY);
    if (bookmark_file >= 0)
    {
        while (read_line(bookmark_file, global_temp_buffer,
                         sizeof(global_temp_buffer)) > 0)
        {
            /* The MRB has a max of MAX_BOOKMARKS in it */
            /* This keeps it from getting too large */
            if (most_recent && (bookmark_count >= MAX_BOOKMARKS))
                break;

            if (!parse_bookmark(NULL, 0, global_temp_buffer, false))
                break;

            equal = false;
            if (comp_playlist)
            {
                if (bookmark_get_playlist_and_track(global_temp_buffer,
                                           &bm_pl_start, &bm_pl_end, &bm_track))
                {
                    bm_pl_len = bm_pl_end - bm_pl_start;
                    equal = (pl_len == bm_pl_len) &&
                            !strncmp(pl_start, bm_pl_start, pl_len);

                    if (equal && comp_track)
                        equal = !strcmp(track, bm_track);
                }
            }
            if (!equal)
            {
                bookmark_count++;
                /*logf("copying old bookmark [%s]", global_temp_buffer);*/
                write(temp_bookmark_file, global_temp_buffer,
                      strlen(global_temp_buffer));
                write(temp_bookmark_file, "\n", 1);
            }
        }
        close(bookmark_file);
    }
    close(temp_bookmark_file);

    /* only retrieve the path*/
    open_temp_bookmark(fnamebuf,
                       sizeof(fnamebuf),
                       O_PATH,
                       bookmark_file_name);
    remove(bookmark_file_name);
    rename(fnamebuf, bookmark_file_name);

    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.                                                        */
/* Returns true if the file name is generated, false if it was too long    */
/* ----------------------------------------------------------------------- */
static bool generate_bookmark_file_name(char *filenamebuf,
                                        size_t filenamebufsz,
                                        const char *bmarknamein,
                                        size_t bmarknamelen)
{
    /* if this is a root dir MP3, rename the bookmark file root_dir.bmark */
    /* otherwise, name it based on the bmarknamein variable */
    if (!strcmp("/", bmarknamein))
        strmemccpy(filenamebuf, "/root_dir.bmark", filenamebufsz);
    else
    {
        size_t len = strlcpy(filenamebuf, bmarknamein,
                             MIN(filenamebufsz, bmarknamelen));
        if(len >= filenamebufsz)
            return false;
#ifdef HAVE_MULTIVOLUME
        /* The "root" of an extra volume need special handling too. */
        const char *filename;
        path_strip_volume(filenamebuf, &filename, true);
        bool volume_root = *filename == '\0';
#endif
        if(filenamebuf[len-1] == '/') {
            filenamebuf[len-1] = '\0';
            len--;
        }

        const char *name = ".bmark";
#ifdef HAVE_MULTIVOLUME
        if (volume_root)
            name = "/volume_dir.bmark";
#endif
        len = strlcat(filenamebuf, name, filenamebufsz);

        if(len >= filenamebufsz)
            return false;
    }
    logf ("generated name '%s' from '%.*s'",
          filenamebuf, (int)bmarknamelen, bmarknamein);
    return true;
}

/* GCC 7 and up complain about the snprintf in create_bookmark() when
   compiled with -D_FORTIFY_SOURCE or -Wformat-truncation
   This is a false positive, so disable it here only */
/* SHOULD NO LONGER BE NEEDED --Bilgus 11-2022 */
#if 0 /* __GNUC__ >= 7 */
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wformat-truncation"
#endif
/* ----------------------------------------------------------------------- */
/* This function takes the system resume data and formats it into a valid  */
/* bookmark.                                                               */
/* playlist name and  name len are passed back through the name/namelen    */
/* Return is not NULL on successful bookmark format.                      */
/* ----------------------------------------------------------------------- */
static char* create_bookmark(char **name, size_t *namelen)
{
    const char *file;
    char *buf = global_temp_buffer;
    size_t bufsz = sizeof(global_temp_buffer);

    if(!resume_info.id3)
        return NULL;

    size_t bmsz =   snprintf(buf, bufsz,
                             /* new optional bookmark token descriptors should
                                be inserted just after ';"' in this line... */
#if defined(HAVE_PITCHCONTROL)
                             ">%d;%d;%ld;%d;%ld;%d;%d;%ld;%ld;",
#else
                             ">%d;%d;%ld;%d;%ld;%d;%d;",
#endif
                             /* ... their flags should go here ... */
#if defined(HAVE_PITCHCONTROL)
                             BM_PITCH | BM_SPEED,
#else
                             0,
#endif
                             resume_info.resume_index,
                             resume_info.id3->offset,
                             resume_info.resume_seed,
                             resume_info.id3->elapsed,
                             resume_info.repeat_mode,
                             resume_info.shuffle,
                             /* ...and their values should go here */
#if defined(HAVE_PITCHCONTROL)
                             (long)resume_info.pitch,
                             (long)resume_info.speed
#endif
                    ); /*sprintf*/
/* mandatory tokens */
    if (bmsz >= bufsz) /* include NULL*/
        return NULL;
    buf += bmsz;
    bufsz -= bmsz;

    /* create the bookmark */
    playlist_get_name(NULL, buf, bmsz);
    bmsz = strlen(buf);

    if (bmsz == 0 || (bmsz + 1) >= bufsz) /* include the separator & NULL*/
        return NULL;

    *name = buf;     /* return the playlist name through the *pointer */
    *namelen = bmsz; /* return the name length through the pointer */

    /* Get the currently playing file minus the path */
    /* This is used when displaying the available bookmarks */
    file = strrchr(resume_info.id3->path,'/');
    if(NULL == file)
        return NULL;

    if (buf[bmsz - 1] != '/')
        file = resume_info.id3->path;
    else file++;

    buf += bmsz;
    bufsz -= (bmsz + 1);
    buf[0] = ';';
    buf[1] = '\0';

    strlcat(buf, file, bufsz);

    logf("%s [%s]", __func__, global_temp_buffer);
    /* checking to see if the bookmark is valid */
    if (parse_bookmark(NULL, 0, global_temp_buffer, false))
        return global_temp_buffer;
    else
        return NULL;
}
#if 0/* __GNUC__ >= 7*/
#pragma GCC diagnostic pop /* -Wformat-truncation */
#endif

/* ----------------------------------------------------------------------- */
/* 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*                                     */
/* Returns true on successful bookmark write.                              */
/* Returns false if any part of the bookmarking process fails.  It is      */
/* possible that a bookmark is successfully added to the most recent       */
/* bookmark list but fails to be added to the bookmark file or vice versa. */
/* ------------------------------------------------------------------------*/
static bool write_bookmark(bool create_bookmark_file)
{
    char bm_filename[MAX_PATH];
    bool ret=true;

    char *name = NULL;
    size_t namelen = 0;
    char* bm;

    if (bookmark_is_bookmarkable_state())
    {
        /* Get some basic resume information */
        playlist_get_resume_info(&(resume_info.resume_index));
        resume_info.resume_seed = playlist_get_seed(NULL);
        resume_info.id3 = audio_current_track();
        resume_info.repeat_mode = global_settings.repeat_mode;
        resume_info.shuffle = global_settings.playlist_shuffle;
#if defined(HAVE_PITCHCONTROL)
        resume_info.pitch = sound_get_pitch();
        resume_info.speed = dsp_get_timestretch();
#endif
        /* writing the most recent bookmark */
        if (global_settings.usemrb)
        {
            /* since we use the same buffer bookmark needs created each time */
            bm = create_bookmark(&name, &namelen);
            ret = add_bookmark(RECENT_BOOKMARK_FILE, bm, true);
        }

        /* writing the directory bookmark */
        if (create_bookmark_file)
        {
            bm = create_bookmark(&name, &namelen);
            if (generate_bookmark_file_name(bm_filename,
                                            sizeof(bm_filename), name, namelen))
            {
                ret &= add_bookmark(bm_filename, bm, false);
            }
            else
            {
                ret = false; /* generating bookmark file failed */
            }
        }
    }
    else
        ret = false;

    splash(HZ, ret ? ID2P(LANG_BOOKMARK_CREATE_SUCCESS)
           : ID2P(LANG_BOOKMARK_CREATE_FAILURE));

    return ret;
}

static int get_bookmark_count(const char* bookmark_file_name)
{
    int read_count = 0;
    int file = open(bookmark_file_name, O_RDONLY);

    if(file < 0)
        return -1;

    while(read_line(file, global_temp_buffer, sizeof(global_temp_buffer)) > 0)
    {
        read_count++;
    }

    close(file);
    return read_count;
}

static int buffer_bookmarks(struct bookmark_list* bookmarks, int first_line)
{
    char* dest = ((char*) bookmarks) + bookmarks->buffer_size - 1;
    int read_count = 0;
    int file = open(bookmarks->filename, O_RDONLY);

    if (file < 0)
    {
        return -1;
    }

    if ((first_line != 0) && ((size_t) filesize(file) < bookmarks->buffer_size
            - sizeof(*bookmarks) - (sizeof(char*) * bookmarks->total_count)))
    {
        /* Entire file fits in buffer */
        first_line = 0;
    }

    bookmarks->start = first_line;
    bookmarks->count = 0;
    bookmarks->reload = false;

    while(read_line(file, global_temp_buffer, sizeof(global_temp_buffer)) > 0)
    {
        read_count++;

        if (read_count >= first_line)
        {
            dest -= strlen(global_temp_buffer) + 1;

            if (dest < ((char*) bookmarks) + sizeof(*bookmarks)
                + (sizeof(char*) * (bookmarks->count + 1)))
            {
                break;
            }

            strcpy(dest, global_temp_buffer);
            bookmarks->items[bookmarks->count] = dest;
            bookmarks->count++;
        }
    }

    close(file);
    return bookmarks->start + bookmarks->count;
}

static const char* get_bookmark_info(int list_index,
                                     void* data,
                                     char *buffer,
                                     size_t buffer_len)
{
    char fnamebuf[MAX_PATH];
    struct bookmark_list* bookmarks = (struct bookmark_list*) data;
    int     index = list_index / 2;

    if (bookmarks->show_dont_resume)
    {
        if (index == 0)
        {
            return list_index % 2 == 0
                ? (char*) str(LANG_BOOKMARK_DONT_RESUME) : " ";
        }

        index--;
    }

    if (bookmarks->reload || (index >= bookmarks->start + bookmarks->count)
        || (index < bookmarks->start))
    {
        int read_index = index;

        /* Using count as a guide on how far to move could possibly fail
         * sometimes. Use byte count if that is a problem?
         */

        if (read_index != 0)
        {
            /* Move count * 3 / 4 items in the direction the user is moving,
             * but don't go too close to the end.
             */
            int offset = bookmarks->count;
            int max = bookmarks->total_count - (bookmarks->count / 2);

            if (read_index < bookmarks->start)
            {
                offset *= 3;
            }

            read_index = index - offset / 4;

            if (read_index > max)
            {
                read_index = max;
            }

            if (read_index < 0)
            {
                read_index = 0;
            }
        }

        if (buffer_bookmarks(bookmarks, read_index) <= index)
        {
            return "";
        }
    }

    if (!parse_bookmark(fnamebuf, sizeof(fnamebuf),
                        bookmarks->items[index - bookmarks->start], true))
    {
        return list_index % 2 == 0 ? (char*) str(LANG_BOOKMARK_INVALID) : " ";
    }

    if (list_index % 2 == 0)
    {
        char *name;
        char *format;
        int len = strlen(global_temp_buffer);

        if (bookmarks->show_playlist_name && len > 0)
        {
            name = global_temp_buffer;
            len--;

            if (name[len] != '/')
            {
                strrsplt(name, '.');
            }
            else if (len > 1)
            {
                name[len] = '\0';
            }

            if (len > 1)
            {
                name = strrsplt(name, '/');
            }

            format = "%s : %s";
        }
        else
        {
            name = fnamebuf;
            format = "%s";
        }

        strrsplt(fnamebuf, '.');
        snprintf(buffer, buffer_len, format, name, fnamebuf);
        return buffer;
    }
    else
    {
        char time_buf[32];

        format_time(time_buf, sizeof(time_buf), resume_info.resume_time);
        snprintf(buffer, buffer_len, "%s, %d%s", time_buf,
                 resume_info.resume_index + 1,
                 resume_info.shuffle ? (char*) str(LANG_BOOKMARK_SHUFFLE) : "");
        return buffer;
    }
}

/* ----------------------------------------------------------------------- */
/* This function parses a bookmark, says the voice UI part of it.          */
/* ------------------------------------------------------------------------*/
static void say_bookmark(const char* bookmark,
                         int bookmark_id,
                         bool show_playlist_name)
{
    char fnamebuf[MAX_PATH];
    if (!parse_bookmark(fnamebuf, sizeof(fnamebuf), bookmark, false))
    {
        talk_id(LANG_BOOKMARK_INVALID, false);
        return;
    }

    talk_number(bookmark_id + 1, false);

    bool is_dir = (global_temp_buffer[0]
              && global_temp_buffer[strlen(global_temp_buffer)-1] == '/');

    /* HWCODEC cannot enqueue voice file entries and .talk thumbnails
       together, because there is no guarantee that the same mp3
       parameters are used. */
    if(show_playlist_name)
    {   /* It's useful to know which playlist this is */
        if(is_dir)
            talk_dir_or_spell(global_temp_buffer,
                              TALK_IDARRAY(VOICE_DIR), true);
        else talk_file_or_spell(NULL, global_temp_buffer,
                                TALK_IDARRAY(LANG_PLAYLIST), true);
    }

    if(resume_info.shuffle)
        talk_id(LANG_SHUFFLE, true);

    talk_id(VOICE_BOOKMARK_SELECT_INDEX_TEXT, true);
    talk_number(resume_info.resume_index + 1, true);
    talk_id(LANG_TIME, true);
    talk_value(resume_info.resume_time / 1000, UNIT_TIME, true);

    /* Track filename */
    if(!is_dir)
        global_temp_buffer[0] = 0;
    talk_file_or_spell(global_temp_buffer, fnamebuf,
                       TALK_IDARRAY(VOICE_FILE), true);
}

static int bookmark_list_voice_cb(int list_index, void* data)
{
    struct bookmark_list* bookmarks = (struct bookmark_list*) data;
    int index = list_index / 2;

    if (bookmarks->show_dont_resume)
    {
        if (index == 0)
            return talk_id(LANG_BOOKMARK_DONT_RESUME, false);
        index--;
    }
    say_bookmark(bookmarks->items[index - bookmarks->start], index,
                 bookmarks->show_playlist_name);
    return 0;
}

/* ----------------------------------------------------------------------- */
/* This function takes a location in a bookmark file and deletes that      */
/* bookmark.                                                               */
/* Returns true on successful bookmark deletion.                           */
/* ------------------------------------------------------------------------*/
static bool delete_bookmark(const 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 */
    temp_bookmark_file = open_temp_bookmark(global_temp_buffer,
                                            sizeof(global_temp_buffer),
                                            O_WRONLY | O_CREAT | O_TRUNC,
                                            bookmark_file_name);

    if (temp_bookmark_file < 0)
        return false; /* can't open the temp file */

    /* 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_temp_buffer,
                         sizeof(global_temp_buffer)) > 0)
        {
            if (bookmark_id != bookmark_count)
            {
                write(temp_bookmark_file, global_temp_buffer,
                      strlen(global_temp_buffer));
                write(temp_bookmark_file, "\n", 1);
            }
            bookmark_count++;
        }
        close(bookmark_file);
    }
    close(temp_bookmark_file);

    /* only retrieve the path*/
    open_temp_bookmark(global_temp_buffer,
                       sizeof(global_temp_buffer),
                       O_PATH,
                       bookmark_file_name);

    remove(bookmark_file_name);
    rename(global_temp_buffer, bookmark_file_name);

    return true;
}

/* ----------------------------------------------------------------------- */
/* This displays the bookmarks in a file and allows the user to            */
/* select one to play.                                                     */
/* *selected_bookmark contains a non NULL value on successful bookmark     */
/* selection.                                                              */
/* Returns BOOKMARK_SUCCESS on successful bookmark selection, BOOKMARK_FAIL*/
/* if no selection was made and BOOKMARK_USB_CONNECTED if the selection    */
/* menu is forced to exit due to a USB connection.                         */
/* ------------------------------------------------------------------------*/
static int select_bookmark(const char* bookmark_file_name,
                           bool show_dont_resume,
                           char** selected_bookmark)
{
    struct bookmark_list* bookmarks;
    struct gui_synclist list;
    int item = 0;
    int action;
    size_t size;
    bool exit = false;
    bool refresh = true;
    int ret = BOOKMARK_FAIL;

    bookmarks = plugin_get_buffer(&size);
    bookmarks->buffer_size = size;
    bookmarks->show_dont_resume = show_dont_resume;
    bookmarks->filename = bookmark_file_name;
    bookmarks->start = 0;
    bookmarks->show_playlist_name
        = (strcmp(bookmark_file_name, RECENT_BOOKMARK_FILE) == 0);

    gui_synclist_init(&list, &get_bookmark_info,
                      (void*) bookmarks, false, 2, NULL);

    if(global_settings.talk_menu)
        gui_synclist_set_voice_callback(&list, bookmark_list_voice_cb);
    gui_synclist_set_title(&list, str(LANG_BOOKMARK_SELECT_BOOKMARK),
        Icon_Bookmark);

    while (!exit)
    {

        if (refresh)
        {
            int count = get_bookmark_count(bookmark_file_name);
            bookmarks->total_count = count;

            if (bookmarks->total_count < 1)
            {
                /* No more bookmarks, delete file and exit */
                splash(HZ, ID2P(LANG_BOOKMARK_LOAD_EMPTY));
                remove(bookmark_file_name);
                *selected_bookmark = NULL;
                return BOOKMARK_FAIL;
            }

            if (bookmarks->show_dont_resume)
            {
                count++;
                item++;
            }

            gui_synclist_set_nb_items(&list, count * 2);

            if (item >= count)
            {
                /* Selected item has been deleted */
                item = count - 1;
                gui_synclist_select_item(&list, item * 2);
            }

            buffer_bookmarks(bookmarks, bookmarks->start);
            gui_synclist_draw(&list);
            cond_talk_ids_fq(VOICE_EXT_BMARK);
            gui_synclist_speak_item(&list);
            refresh = false;
        }

        list_do_action(CONTEXT_BOOKMARKSCREEN, HZ / 2, &list, &action);
        item = gui_synclist_get_sel_pos(&list) / 2;

        if (bookmarks->show_dont_resume)
        {
            item--;
        }

        if (action == ACTION_STD_CONTEXT)
        {
            MENUITEM_STRINGLIST(menu_items, ID2P(LANG_BOOKMARK_CONTEXT_MENU),
                NULL, ID2P(LANG_BOOKMARK_CONTEXT_RESUME),
                ID2P(LANG_BOOKMARK_CONTEXT_DELETE));
            static const int menu_actions[] =
            {
                ACTION_STD_OK, ACTION_BMS_DELETE
            };
            int selection = do_menu(&menu_items, NULL, NULL, false);

            refresh = true;

            if (selection >= 0 && selection <=
                (int) (sizeof(menu_actions) / sizeof(menu_actions[0])))
            {
                action = menu_actions[selection];
            }
        }

        switch (action)
        {
        case ACTION_STD_OK:
            if (item >= 0)
            {
                talk_shutup();
                *selected_bookmark = bookmarks->items[item - bookmarks->start];
                return BOOKMARK_SUCCESS;
            }
            exit = true;
            ret = BOOKMARK_SUCCESS;
            break;

        case ACTION_TREE_WPS:
        case ACTION_STD_CANCEL:
            exit = true;
            break;

        case ACTION_BMS_DELETE:
            if (item >= 0)
            {
                if (confirm_delete_yesno("") == YESNO_YES)
                {
                    delete_bookmark(bookmark_file_name, item);
                    bookmarks->reload = true;
                }
                refresh = true;
            }
            break;

        default:
            if (default_event_handler(action) == SYS_USB_CONNECTED)
            {
                ret = BOOKMARK_USB_CONNECTED;
                exit = true;
            }

            break;
        }
    }

    talk_shutup();
    *selected_bookmark = NULL;
    return ret;
}

/* ----------------------------------------------------------------------- */
/* This function parses a bookmark and then plays it.                      */
/* Returns true on successful bookmark play.                               */
/* ------------------------------------------------------------------------*/
static bool play_bookmark(const char* bookmark)
{
    char fnamebuf[MAX_PATH];
#if defined(HAVE_PITCHCONTROL)
    /* preset pitch and speed to 100% in case bookmark doesn't have info */
    resume_info.pitch = sound_get_pitch();
    resume_info.speed = dsp_get_timestretch();
#endif

    if (parse_bookmark(fnamebuf, sizeof(fnamebuf), bookmark, true))
    {
        global_settings.repeat_mode = resume_info.repeat_mode;
        global_settings.playlist_shuffle = resume_info.shuffle;
#if defined(HAVE_PITCHCONTROL)
        sound_set_pitch(resume_info.pitch);
        dsp_set_timestretch(resume_info.speed);
#endif
        if (!warn_on_pl_erase())
            return false;
        return bookmark_play(global_temp_buffer, resume_info.resume_index,
                             resume_info.resume_time, resume_info.resume_offset,
                             resume_info.resume_seed, fnamebuf);
    }

    return false;
}

/*-------------------------------------------------------------------------*/
/* PUBLIC INTERFACE -------------------------------------------------------*/
/*-------------------------------------------------------------------------*/


/* ----------------------------------------------------------------------- */
/* This is an interface function from the context menu.                    */
/* Returns true on successful bookmark creation.                           */
/* ----------------------------------------------------------------------- */
bool bookmark_create_menu(void)
{
    return write_bookmark(true);
}
/* ----------------------------------------------------------------------- */
/* This function acts as the load interface from the context menu.         */
/* This function determines the bookmark file name and then loads that file*/
/* for the user.  The user can then select or delete previous bookmarks.   */
/* This function returns BOOKMARK_SUCCESS on the selection of a track to   */
/* resume, BOOKMARK_FAIL if the menu is exited without a selection and     */
/* BOOKMARK_USB_CONNECTED if the menu is forced to exit due to a USB       */
/* connection.                                                             */
/* ----------------------------------------------------------------------- */
int bookmark_load_menu(void)
{
    char bm_filename[MAX_PATH];
    char* bookmark;
    int ret = BOOKMARK_FAIL;

    push_current_activity(ACTIVITY_BOOKMARKSLIST);

    char* name = playlist_get_name(NULL, global_temp_buffer,
                                       sizeof(global_temp_buffer));
    if (generate_bookmark_file_name(bm_filename, sizeof(bm_filename), name, -1))
    {
        ret = select_bookmark(bm_filename, false, &bookmark);
        if (bookmark != NULL)
        {
            ret = play_bookmark(bookmark) ? BOOKMARK_SUCCESS : BOOKMARK_FAIL;
        }
    }

    pop_current_activity();
    return ret;
}

/* ----------------------------------------------------------------------- */
/* Gives the user a list of the Most Recent Bookmarks.  This is an         */
/* interface function                                                      */
/* Returns true on the successful selection of a recent bookmark.          */
/* ----------------------------------------------------------------------- */
bool bookmark_mrb_load()
{
    char* bookmark;
    bool ret = false;

    push_current_activity(ACTIVITY_BOOKMARKSLIST);
    select_bookmark(RECENT_BOOKMARK_FILE, false, &bookmark);
    if (bookmark != NULL)
    {
        ret = play_bookmark(bookmark);
    }

    pop_current_activity();
    return ret;
}

/* ----------------------------------------------------------------------- */
/* This function handles an autobookmark creation.  This is an interface   */
/* function.                                                               */
/* Returns true on successful bookmark creation.                           */
/* ----------------------------------------------------------------------- */
bool bookmark_autobookmark(bool prompt_ok)
{
    bool update;

    if (!bookmark_is_bookmarkable_state())
        return false;

    audio_pause();    /* first pause playback */
    update = (global_settings.autoupdatebookmark && bookmark_exists());

    if (update)
        return write_bookmark(true);

    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);
    }
    const char *lines[]={ID2P(LANG_AUTO_BOOKMARK_QUERY)};
    const struct text_message message={lines, 1};

    if(prompt_ok && gui_syncyesno_run(&message, NULL, NULL)==YESNO_YES)
    {
        if (global_settings.autocreatebookmark == BOOKMARK_RECENT_ONLY_ASK)
            return write_bookmark(false);
        else
            return write_bookmark(true);
    }
    return false;
}

/* ----------------------------------------------------------------------- */
/* This function will determine if an autoload is necessary.  This is an   */
/* interface function.                                                     */
/* Returns                                                                 */
/* BOOKMARK_DO_RESUME    on bookmark load or bookmark selection.           */
/* BOOKMARK_DONT_RESUME  if we're not going to resume                      */
/* BOOKMARK_CANCEL       if user canceled                                  */
/* ------------------------------------------------------------------------*/
int bookmark_autoload(const char* file)
{
    char bm_filename[MAX_PATH];
    char* bookmark;

    if(global_settings.autoloadbookmark == BOOKMARK_NO)
        return BOOKMARK_DONT_RESUME;

    /*Checking to see if a bookmark file exists.*/
    if(!generate_bookmark_file_name(bm_filename, sizeof(bm_filename), file, -1))
    {
        return BOOKMARK_DONT_RESUME;
    }

    if(!file_exists(bm_filename))
        return BOOKMARK_DONT_RESUME;

    if(global_settings.autoloadbookmark == BOOKMARK_YES)
    {
        return (bookmark_load(bm_filename, true)
                ? BOOKMARK_DO_RESUME : BOOKMARK_DONT_RESUME);
    }
    else
    {
        int ret = select_bookmark(bm_filename, true, &bookmark);

        if (bookmark != NULL)
        {
            if (!play_bookmark(bookmark))
            {
                /* Selected bookmark not found. */
                splash(HZ*2, ID2P(LANG_NOTHING_TO_RESUME));
            }

            /* Act as if autoload was done even if it failed, since the
             * user did make an active selection.
             */
            return BOOKMARK_DO_RESUME;
        }

        return ret != (BOOKMARK_SUCCESS ? BOOKMARK_CANCEL : BOOKMARK_DONT_RESUME);
    }
}

/* ----------------------------------------------------------------------- */
/* This function loads the bookmark information into the resume memory.    */
/* This is an interface function.                                          */
/* Returns true on successful bookmark load.                               */
/* ------------------------------------------------------------------------*/
bool bookmark_load(const char* file, bool autoload)
{
    int  fd;
    char* bookmark = NULL;

    if(autoload)
    {
        fd = open(file, O_RDONLY);
        if(fd >= 0)
        {
            if(read_line(fd, global_temp_buffer, sizeof(global_temp_buffer)) > 0)
                bookmark=global_temp_buffer;
            close(fd);
        }
    }
    else
    {
        /* This is not an auto-load, so list the bookmarks */
        select_bookmark(file, false, &bookmark);
    }

    if (bookmark != NULL)
    {
        if (!play_bookmark(bookmark))
        {
            /* Selected bookmark not found. */
            if (!autoload)
            {
                splash(HZ*2, ID2P(LANG_NOTHING_TO_RESUME));
            }

            return false;
        }
    }

    return true;
}

/* ----------------------------------------------------------------------- */
/* Returns true if a bookmark file exists for the current playlist.        */
/* This is an interface function.                                          */
/* ----------------------------------------------------------------------- */
bool bookmark_exists(void)
{
    char bm_filename[MAX_PATH];
    bool exist=false;

    char* name = playlist_get_name(NULL, global_temp_buffer,
                                   sizeof(global_temp_buffer));
    if (generate_bookmark_file_name(bm_filename, sizeof(bm_filename), name, -1))
    {
        exist = file_exists(bm_filename);
    }
    return exist;
}

/* ----------------------------------------------------------------------- */
/* Checks the current state of the system and returns true if it is in a   */
/* bookmarkable state.                                                     */
/* This is an interface funtion.                                           */
/* ----------------------------------------------------------------------- */
bool bookmark_is_bookmarkable_state(void)
{
    int resume_index = 0;

    if (!(audio_status() && audio_current_track()) ||
        /* no track playing */
       (playlist_get_resume_info(&resume_index) == -1) ||
        /* invalid queue info */
       (playlist_modified(NULL)))
        /* can't bookmark while in the queue */
    {
        return false;
    }

    return true;
}