summaryrefslogtreecommitdiffstats
path: root/apps/playlist.c
blob: b5db084f9bf34b4131de6562f7524288b5033f9d (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
/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 * $Id$
 *
 * Copyright (C) 2002 by wavey@wavey.org
 *
 * 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 "playlist.h"
#include "file.h"
#include "sprintf.h"
#include "debug.h"
#include "mpeg.h"
#include "lcd.h"
#include "kernel.h"
#include "settings.h"
#include "status.h"
#include "applimits.h"
#include "screens.h"
#include "buffer.h"
#ifdef HAVE_LCD_BITMAP
#include "icons.h"
#include "widgets.h"
#endif

#include "lang.h"

static struct playlist_info playlist;

#define QUEUE_FILE ROCKBOX_DIR "/.queue_file"

static unsigned char *playlist_buffer;

static int playlist_end_pos = 0;

static char now_playing[MAX_PATH+1];

void playlist_init(void)
{
    playlist.fd = -1;
    playlist.max_playlist_size = global_settings.max_files_in_playlist;
    playlist.indices = buffer_alloc(playlist.max_playlist_size);
    playlist.buffer_size =
        AVERAGE_FILENAME_LENGTH * global_settings.max_files_in_dir;
    playlist_buffer = buffer_alloc(playlist.buffer_size);
}

/*
 * remove any files and indices associated with the playlist
 */
static void empty_playlist(bool queue_resume)
{
    int fd;

    playlist.filename[0] = '\0';
    if(-1 != playlist.fd)
        /* If there is an already open playlist, close it. */
        close(playlist.fd);
    playlist.fd = -1;
    playlist.index = 0;
    playlist.queue_index = 0;
    playlist.last_queue_index = 0;
    playlist.amount = 0;
    playlist.num_queued = 0;
    playlist.start_queue = 0;

    if (!queue_resume)
    {
        /* start with fresh queue file when starting new playlist */
        remove(QUEUE_FILE);
        fd = creat(QUEUE_FILE, 0);
        if (fd > 0)
            close(fd);
    }
}

/* update queue list after resume */
static void add_indices_to_queuelist(int seek)
{
    int nread;
    int fd = -1;
    int i = seek;
    int count = 0;
    bool store_index;
    char buf[MAX_PATH];

    unsigned char *p = buf;

    fd = open(QUEUE_FILE, O_RDONLY);
    if(fd < 0)
        return;

    nread = lseek(fd, seek, SEEK_SET);
    if (nread < 0)
        return;

    store_index = true;

    while(1)
    {
        nread = read(fd, buf, MAX_PATH);
        if(nread <= 0)
            break;

        p = buf;
        
        for(count=0; count < nread; count++,p++) {           
            if(*p == '\n')
                store_index = true;
            else if(store_index) 
            {
                store_index = false;
                
                playlist.queue_indices[playlist.last_queue_index] = i+count;
                playlist.last_queue_index =
                    (playlist.last_queue_index + 1) % MAX_QUEUED_FILES;
                playlist.num_queued++;
            }
        }
        
        i += count;
    }
}

static int get_next_index(int steps, bool *queue)
{
    int current_index = playlist.index;
    int next_index    = -1;

    if (global_settings.repeat_mode == REPEAT_ONE)
    {
        /* this is needed for repeat one to work with queue mode */
        steps = 0;
    }
    else if (steps >= 0)
    {
        /* Queue index starts from 0 which needs to be accounted for.  Also,
           after resume, this handles case where we want to begin with
           playlist */
        steps -= playlist.start_queue;
    }

    if (steps >= 0 && playlist.num_queued > 0 &&
        playlist.num_queued - steps > 0)
        *queue = true;
    else
    {
        *queue = false;
        if (playlist.num_queued)
        {
            if (steps >= 0)
            {
                /* skip the queued tracks */
                steps -= (playlist.num_queued - 1);
            }
            else if (!playlist.start_queue)
            {
                /* previous from queue list needs to go to current track in
                   playlist */
                steps += 1;
            }
        }
    }

    switch (global_settings.repeat_mode)
    {
        case REPEAT_OFF:
            if (*queue)
                next_index = (playlist.queue_index+steps) % MAX_QUEUED_FILES;
            else
            {
                if (current_index < playlist.first_index)
                    current_index += playlist.amount;
                current_index -= playlist.first_index;
                
                next_index = current_index+steps;
                if ((next_index < 0) || (next_index >= playlist.amount))
                    next_index = -1;
                else
                    next_index = (next_index+playlist.first_index) %
                        playlist.amount;
            }
            break;

        case REPEAT_ONE:
            /* if we are still in playlist when repeat one is set, don't go to
               queue list */
            if (*queue && !playlist.start_queue)
                next_index = playlist.queue_index;
            else
            {
                next_index = current_index;
                *queue = false;
            }
            break;

        case REPEAT_ALL:
        default:
            if (*queue)
                next_index = (playlist.queue_index+steps) % MAX_QUEUED_FILES;
            else
            {
                next_index = (current_index+steps) % playlist.amount;
                while (next_index < 0)
                    next_index += playlist.amount;
            }
            break;
    }

    return next_index;
}

int playlist_amount(void)
{
    return playlist.amount + playlist.num_queued;
}

int playlist_first_index(void)
{
    return playlist.first_index;
}

/* Get resume info for current playing song.  If return value is -1 then
   settings shouldn't be saved (eg. when playing queued song and save queue
   disabled) */
int playlist_get_resume_info(int *resume_index, int *queue_resume,
                             int *queue_resume_index)
{
    int result = 0;

    *resume_index = playlist.index;

    if (playlist.num_queued > 0)
    {
        if (global_settings.save_queue_resume)
        {
            *queue_resume_index =
                playlist.queue_indices[playlist.queue_index];
            /* have we started playing the queue list yet? */
            if (playlist.start_queue)
                *queue_resume = QUEUE_BEGIN_PLAYLIST;
            else
                *queue_resume = QUEUE_BEGIN_QUEUE;
        }
        else if (!playlist.start_queue)
        {
            *queue_resume = QUEUE_OFF;
            result = -1;
        }
    }
    else
        *queue_resume = QUEUE_OFF;

    return result;
}

char *playlist_name(char *buf, int buf_size)
{
    char *sep;

    snprintf(buf, buf_size, "%s", playlist.filename+playlist.dirlen);

    if (0 == buf[0])
        return NULL;

    /* Remove extension */
    sep = strrchr(buf, '.');
    if (NULL != sep)
        *sep = 0;
    
    return buf;
}

void playlist_clear(void)
{
    playlist_end_pos = 0;
    playlist_buffer[0] = 0;
}

int playlist_add(char *filename)
{
    int len = strlen(filename);

    if(len+2 > playlist.buffer_size - playlist_end_pos)
        return -1;

    strcpy(&playlist_buffer[playlist_end_pos], filename);
    playlist_end_pos += len;
    playlist_buffer[playlist_end_pos++] = '\n';
    playlist_buffer[playlist_end_pos] = '\0';
    return 0;
}

/* Add track to queue file */
int queue_add(char *filename)
{
    int fd, seek, result;
    int len = strlen(filename);

    if(playlist.num_queued >= MAX_QUEUED_FILES)
        return -1;

    fd = open(QUEUE_FILE, O_WRONLY);
    if (fd < 0)
        return -1;

    seek = lseek(fd, 0, SEEK_END);
    if (seek < 0)
    {
        close(fd);
        return -1;
    }

    /* save the file name with a trailing \n. QUEUE_FILE can be used as a 
       playlist if desired */
    filename[len] = '\n';
    result = write(fd, filename, len+1);
    if (result < 0)
    {
        close(fd);
        return -1;
    }
    filename[len] = '\0';

    close(fd);

    if (playlist.num_queued <= 0)
        playlist.start_queue = 1;

    playlist.queue_indices[playlist.last_queue_index] = seek;
    playlist.last_queue_index =
        (playlist.last_queue_index + 1) % MAX_QUEUED_FILES;
    playlist.num_queued++;

    /* the play order has changed */
    mpeg_flush_and_reload_tracks();

    return playlist.num_queued;
}

int playlist_next(int steps)
{
    bool queue;
    int index = get_next_index(steps, &queue);

    if (queue)
    {
        /* queue_diff accounts for bad songs in queue list */
        int queue_diff = index - playlist.queue_index;
        if (queue_diff < 0)
            queue_diff += MAX_QUEUED_FILES;

        playlist.num_queued -= queue_diff;
        playlist.queue_index = index;
        playlist.start_queue = 0;
    }
    else
    {
        playlist.index = index;
        if (playlist.num_queued > 0 && !playlist.start_queue)
        {
            if (steps >= 0)
            {
                /* done with queue list */
                playlist.queue_index = playlist.last_queue_index;
                playlist.num_queued = 0;
            }
            else
            {
                /* user requested previous.  however, don't forget about queue
                   list */
                playlist.start_queue = 1;
            }
        }
    }

    return index;
}

/* Returns false if 'steps' is out of bounds, else true */
bool playlist_check(int steps)
{
    bool queue;
    int index = get_next_index(steps, &queue);
    return (index >= 0);
}

char* playlist_peek(int steps)
{
    int seek;
    int max;
    int i;
    int fd;
    char *buf;
    char dir_buf[MAX_PATH+1];
    char *dir_end;
    int index;
    bool queue;

    index = get_next_index(steps, &queue);
    if (index < 0)
        return NULL;

    if (queue)
    {
        seek = playlist.queue_indices[index];
        fd = open(QUEUE_FILE, O_RDONLY);
        if(-1 != fd)
        {
            buf = dir_buf;
            lseek(fd, seek, SEEK_SET);
            max = read(fd, buf, MAX_PATH);
            close(fd);
        }
        else
            return NULL;
    }
    else
    {
        seek = playlist.indices[index];
        
        if(playlist.in_ram)
        {
            buf = playlist_buffer + seek;
            max = playlist_end_pos - seek;
        }
        else
        {
            if(-1 == playlist.fd)
                playlist.fd = open(playlist.filename, O_RDONLY);

            if(-1 != playlist.fd)
            {
                buf = playlist_buffer;
                lseek(playlist.fd, seek, SEEK_SET);
                max = read(playlist.fd, buf, MAX_PATH);
            }
            else
                return NULL;
        }
    }

    /* Zero-terminate the file name */
    seek=0;
    while((buf[seek] != '\n') &&
          (buf[seek] != '\r') &&
          (seek < max))
        seek++;

    /* Now work back killing white space */
    while((buf[seek-1] == ' ') || 
          (buf[seek-1] == '\t'))
        seek--;

    buf[seek]=0;
      
    /* replace backslashes with forward slashes */
    for ( i=0; i<seek; i++ )
        if ( buf[i] == '\\' )
            buf[i] = '/';

    if('/' == buf[0]) {
        strcpy(now_playing, &buf[0]);
    }
    else {
        strncpy(dir_buf, playlist.filename, playlist.dirlen-1);
        dir_buf[playlist.dirlen-1] = 0;

        /* handle dos style drive letter */
        if ( ':' == buf[1] ) {
            strcpy(now_playing, &buf[2]);
        }
        else if ( '.' == buf[0] && '.' == buf[1] && '/' == buf[2] ) {
            /* handle relative paths */
            seek=3;
            while(buf[seek] == '.' &&
                  buf[seek+1] == '.' &&
                  buf[seek+2] == '/')
                seek += 3;
            for (i=0; i<seek/3; i++) {
                dir_end = strrchr(dir_buf, '/');
                if (dir_end)
                    *dir_end = '\0';
                else
                    break;
            }
            snprintf(now_playing, MAX_PATH+1, "%s/%s", dir_buf, &buf[seek]);
        }
        else if ( '.' == buf[0] && '/' == buf[1] ) {
            snprintf(now_playing, MAX_PATH+1, "%s/%s", dir_buf, &buf[2]);
        }
        else {
            snprintf(now_playing, MAX_PATH+1, "%s/%s", dir_buf, buf);
        }
    }

    buf = now_playing;

    /* remove bogus dirs from beginning of path
       (workaround for buggy playlist creation tools) */
    if(!playlist.in_ram)
    {
        while (buf)
        {
            fd = open(buf, O_RDONLY);
            if (fd >= 0)
            {
                close(fd);
                break;
            }
            
            buf = strchr(buf+1, '/');
        }
    }
    
    if (!buf)
    {
        /* Even though this is an invalid file, we still need to pass a file
           name to the caller because NULL is used to indicate end of 
           playlist */
        return now_playing;
    }

    return buf;
}

/*
 * This function is called to start playback of a given playlist.  This
 * playlist may be stored in RAM (when using full-dir playback).
 *
 * Return: the new index (possibly different due to shuffle)
 */
int play_list(char *dir,         /* "current directory" */
              char *file,        /* playlist */
              int start_index,   /* index in the playlist */
              bool shuffled_index, /* if TRUE the specified index is for the
                                       playlist AFTER the shuffle */
              int start_offset,  /* offset in the file */
              int random_seed,   /* used for shuffling */
              int first_index,   /* first index of playlist */
              int queue_resume, /* resume queue list? */
              int queue_resume_index ) /* queue list seek pos */
{
    char *sep="";
    int dirlen;
    empty_playlist(queue_resume);

    playlist.index = start_index;
    playlist.first_index = first_index;

#ifdef HAVE_LCD_BITMAP
    if(global_settings.statusbar)
        lcd_setmargins(0, STATUSBAR_HEIGHT);
    else
        lcd_setmargins(0, 0);
#endif

    /* If file is NULL, the list is in RAM */
    if(file) {
        splash(0, 0, true, str(LANG_PLAYLIST_LOAD));
        playlist.in_ram = false;
    } else {
        /* Assign a dummy filename */
        file = "";
        playlist.in_ram = true;
    }

    dirlen = strlen(dir);

    /* If the dir does not end in trailing slash, we use a separator.
       Otherwise we don't. */
    if('/' != dir[dirlen-1]) {
        sep="/";
        dirlen++;
    }
    
    playlist.dirlen = dirlen;

    snprintf(playlist.filename, sizeof(playlist.filename),
             "%s%s%s", 
             dir, sep, file);

    /* add track indices to playlist data structure */
    add_indices_to_playlist();
    
    if(global_settings.playlist_shuffle) {
        if(!playlist.in_ram) {
            splash(0, 0, true, str(LANG_PLAYLIST_SHUFFLE));
            randomise_playlist( random_seed );
        }
        else {
            int i;

            /* store the seek position before the shuffle */
            int seek_pos = playlist.indices[start_index];

            /* now shuffle around the indices */
            randomise_playlist( random_seed );

            if(!shuffled_index && global_settings.play_selected) {
                /* The given index was for the unshuffled list, so we need
                   to figure out the index AFTER the shuffle has been made.
                   We scan for the seek position we remmber from before. */

                for(i=0; i< playlist.amount; i++) {
                    if(seek_pos == playlist.indices[i]) {
                        /* here's the start song! yiepee! */
                        playlist.index = i;
                        playlist.first_index = i;
                        break; /* now stop searching */
                    }
                }
                /* if we for any reason wouldn't find the index again, it
                   won't set the index again and we should start at index 0
                   instead */
            }
        }
    }

    if (queue_resume)
    {
        /* update the queue indices */
        add_indices_to_queuelist(queue_resume_index);

        if (queue_resume == QUEUE_BEGIN_PLAYLIST)
        {
            /* begin with current playlist index */
            playlist.start_queue = 1;
            playlist.index++; /* so we begin at the correct track */
        }
    }

    /* also make the first song get playing */
    mpeg_play(start_offset);

    return playlist.index;
}

/*
 * calculate track offsets within a playlist file
 */
void add_indices_to_playlist(void)
{
    int nread;
    int i = 0;
    int count = 0;
    unsigned char* buffer = playlist_buffer;
    int buflen = playlist.buffer_size;
    bool store_index;
    unsigned char *p;

    if(!playlist.in_ram) {
        if(-1 == playlist.fd)
            playlist.fd = open(playlist.filename, O_RDONLY);
        if(-1 == playlist.fd)
            return; /* failure */
        
#ifndef SIMULATOR
        /* use mp3 buffer for maximum load speed */
        buflen = (mp3end - mp3buf);
        buffer = mp3buf;
#endif
    }

    store_index = true;

    mpeg_stop();
    
    while(1)
    {
        if(playlist.in_ram) {
            nread = playlist_end_pos;
        } else {
            nread = read(playlist.fd, buffer, buflen);
            /* Terminate on EOF */
            if(nread <= 0)
                break;
        }
        
        p = buffer;

        for(count=0; count < nread; count++,p++) {

            /* Are we on a new line? */
            if((*p == '\n') || (*p == '\r'))
            {
                store_index = true;
            } 
            else if(store_index) 
            {
                store_index = false;

                if(playlist.in_ram || (*p != '#'))
                {
                    /* Store a new entry */
                    playlist.indices[ playlist.amount ] = i+count;
                    playlist.amount++;
                    if ( playlist.amount >= playlist.max_playlist_size ) {
                        lcd_clear_display();
                        lcd_puts(0,0,str(LANG_PLAYINDICES_PLAYLIST));
                        lcd_puts(0,1,str(LANG_PLAYINDICES_BUFFER));
                        lcd_update();
                        sleep(HZ*2);
                        lcd_clear_display();

                        return;
                    }
                }
            }
        }

        i+= count;

        if(playlist.in_ram)
            break;
    }
}

/*
 * randomly rearrange the array of indices for the playlist
 */
void randomise_playlist( unsigned int seed )
{
    int count;
    int candidate;
    int store;
    
    /* seed with the given seed */
    srand( seed );

    /* randomise entire indices list */
    for(count = playlist.amount - 1; count >= 0; count--)
    {
        /* the rand is from 0 to RAND_MAX, so adjust to our value range */
        candidate = rand() % (count + 1);

        /* now swap the values at the 'count' and 'candidate' positions */
        store = playlist.indices[candidate];
        playlist.indices[candidate] = playlist.indices[count];
        playlist.indices[count] = store;
    }

    mpeg_flush_and_reload_tracks();
}

static int compare(const void* p1, const void* p2)
{
    int* e1 = (int*) p1;
    int* e2 = (int*) p2;

    return *e1 - *e2;
}

/*
 * Sort the array of indices for the playlist. If start_current is true then
 * set the index to the new index of the current song.
 */
void sort_playlist(bool start_current)
{
    int i;
    int current = playlist.indices[playlist.index];

    if (playlist.amount > 0)
    {
        qsort(playlist.indices, playlist.amount, sizeof(playlist.indices[0]), compare);
    }

    if (start_current)
    {
        /* Set the index to the current song */
        for (i=0; i<playlist.amount; i++)
        {
            if (playlist.indices[i] == current)
            {
                playlist.index = i;
                break;
            }
        }
    }

    mpeg_flush_and_reload_tracks();
}