Revert "Simplify codec_request_buffer_callback()"
[Rockbox.git] / apps / playlist_viewer.c
blob7769e683d5d747fe86cbdf71b5a0c9ee992ca413
1 /***************************************************************************
3 * __________ __ ___.
4 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
5 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
6 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
7 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
8 * \/ \/ \/ \/ \/
9 * $Id$
11 * Copyright (C) 2003 Hardeep Sidhu
13 * All files in this archive are subject to the GNU General Public License.
14 * See the file COPYING in the source tree root for full license agreement.
16 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
17 * KIND, either express or implied.
19 ****************************************************************************/
21 * Kevin Ferrare 2005/10/16
22 * multi-screen support, rewrote a lot of code
24 #include <string.h>
25 #include <sprintf.h>
26 #include "playlist.h"
27 #include "audio.h"
28 #include "screens.h"
29 #include "status.h"
30 #include "settings.h"
31 #include "icons.h"
32 #include "menu.h"
33 #include "plugin.h"
34 #include "keyboard.h"
35 #include "filetypes.h"
36 #include "onplay.h"
37 #include "talk.h"
38 #include "misc.h"
39 #include "action.h"
40 #include "debug.h"
41 #include "backlight.h"
43 #include "lang.h"
45 #include "playlist_viewer.h"
46 #include "playlist_catalog.h"
47 #include "icon.h"
48 #include "list.h"
49 #include "statusbar.h"
50 #include "splash.h"
51 #include "playlist_menu.h"
52 #include "action.h"
54 /* Maximum number of tracks we can have loaded at one time */
55 #define MAX_PLAYLIST_ENTRIES 200
57 /* The number of items between the selected one and the end/start of
58 * the buffer under which the buffer must reload */
59 #define MIN_BUFFER_MARGIN (screens[0].nb_lines+1)
61 /* Information about a specific track */
62 struct playlist_entry {
63 char *name; /* Formatted track name */
64 int index; /* Playlist index */
65 int display_index; /* Display index */
66 bool queued; /* Is track queued? */
67 bool skipped; /* Is track marked as bad? */
70 enum direction
72 FORWARD,
73 BACKWARD
76 struct playlist_buffer
78 char *name_buffer; /* Buffer used to store track names */
79 int buffer_size; /* Size of name buffer */
81 int first_index; /* Real index of first track loaded inside
82 the buffer */
84 enum direction direction; /* Direction of the buffer (if the buffer
85 was loaded BACKWARD, the last track in
86 the buffer has a real index < to the
87 real index of the the first track)*/
89 struct playlist_entry tracks[MAX_PLAYLIST_ENTRIES];
90 int num_loaded; /* Number of track entries loaded in buffer */
93 /* Global playlist viewer settings */
94 struct playlist_viewer {
95 struct playlist_info* playlist; /* playlist being viewed */
96 int num_tracks; /* Number of tracks in playlist */
97 int current_playing_track; /* Index of current playing track */
98 int selected_track; /* The selected track, relative (first is 0)*/
99 int move_track; /* Playlist index of track to move or -1 */
100 struct playlist_buffer buffer;
103 static struct playlist_viewer viewer;
105 /* Used when viewing playlists on disk */
106 static struct playlist_info temp_playlist;
108 static void playlist_buffer_init(struct playlist_buffer *pb, char *names_buffer,
109 int names_buffer_size);
110 static void playlist_buffer_load_entries(struct playlist_buffer * pb, int index,
111 enum direction direction);
112 static int playlist_entry_load(struct playlist_entry *entry, int index,
113 char* name_buffer, int remaining_size);
115 static struct playlist_entry * playlist_buffer_get_track(struct playlist_buffer *pb,
116 int index);
118 static bool playlist_viewer_init(struct playlist_viewer * viewer,
119 char* filename, bool reload);
121 static void format_name(char* dest, const char* src);
122 static void format_line(const struct playlist_entry* track, char* str,
123 int len);
125 static bool update_playlist(bool force);
126 static int onplay_menu(int index);
127 static bool viewer_menu(void);
128 static int save_playlist_func(void);
130 static void playlist_buffer_init(struct playlist_buffer *pb, char *names_buffer,
131 int names_buffer_size)
133 pb->name_buffer=names_buffer;
134 pb->buffer_size=names_buffer_size;
135 pb->first_index=0;
136 pb->num_loaded=0;
140 * Loads the entries following 'index' in the playlist buffer
142 static void playlist_buffer_load_entries(struct playlist_buffer *pb, int index,
143 enum direction direction)
145 int num_entries = viewer.num_tracks;
146 char* p = pb->name_buffer;
147 int remaining = pb->buffer_size;
148 int i;
150 pb->first_index = index;
151 if (num_entries > MAX_PLAYLIST_ENTRIES)
152 num_entries = MAX_PLAYLIST_ENTRIES;
154 for(i=0; i<num_entries; i++)
156 int len = playlist_entry_load(&(pb->tracks[i]), index, p, remaining);
157 if (len < 0)
159 /* Out of name buffer space */
160 num_entries = i;
161 break;
164 p += len;
165 remaining -= len;
167 if(direction==FORWARD)
168 index++;
169 else
170 index--;
171 index+=viewer.num_tracks;
172 index%=viewer.num_tracks;
174 pb->direction=direction;
175 pb->num_loaded = i;
178 static void playlist_buffer_load_entries_screen(struct playlist_buffer * pb,
179 enum direction direction)
181 if(direction==FORWARD)
183 int min_start=viewer.selected_track-2*screens[0].nb_lines;
184 while(min_start<0)
185 min_start+=viewer.num_tracks;
186 min_start %= viewer.num_tracks;
187 playlist_buffer_load_entries(pb, min_start, FORWARD);
189 else
191 int max_start=viewer.selected_track+2*screens[0].nb_lines;
192 max_start%=viewer.num_tracks;
193 playlist_buffer_load_entries(pb, max_start, BACKWARD);
197 static int playlist_entry_load(struct playlist_entry *entry, int index,
198 char* name_buffer, int remaining_size)
200 struct playlist_track_info info;
201 int len;
203 /* Playlist viewer orders songs based on display index. We need to
204 convert to real playlist index to access track */
205 index = (index + playlist_get_first_index(viewer.playlist)) %
206 viewer.num_tracks;
207 if (playlist_get_track_info(viewer.playlist, index, &info) < 0)
208 return -1;
210 len = strlen(info.filename) + 1;
212 if (len <= remaining_size)
214 strcpy(name_buffer, info.filename);
216 entry->name = name_buffer;
217 entry->index = info.index;
218 entry->display_index = info.display_index;
219 entry->queued = info.attr & PLAYLIST_ATTR_QUEUED;
220 entry->skipped = info.attr & PLAYLIST_ATTR_SKIPPED;
221 return len;
223 return -1;
226 static int playlist_buffer_get_index(struct playlist_buffer *pb, int index )
228 int buffer_index;
229 if(pb->direction==FORWARD)
231 if(index>=pb->first_index)
232 buffer_index=index-pb->first_index;
233 else /* rotation : track0 in buffer + requested track */
234 buffer_index=(viewer.num_tracks-pb->first_index)+(index);
236 else
238 if(index<=pb->first_index)
239 buffer_index=pb->first_index-index;
240 else /* rotation : track0 in buffer + dist from the last track
241 to the requested track (num_tracks-requested track) */
242 buffer_index=(pb->first_index)+(viewer.num_tracks-index);
244 return(buffer_index);
247 #define distance(a, b) \
248 a>b? (a) - (b) : (b) - (a)
249 static bool playlist_buffer_needs_reload(struct playlist_buffer* pb, int track_index)
251 if(pb->num_loaded==viewer.num_tracks)
252 return(false);
253 int selected_index=playlist_buffer_get_index(pb, track_index);
254 int first_buffer_index=playlist_buffer_get_index(pb, pb->first_index);
255 int distance_beginning=distance(selected_index, first_buffer_index);
256 if(distance_beginning<MIN_BUFFER_MARGIN)
257 return(true);
259 if(pb->num_loaded - distance_beginning < MIN_BUFFER_MARGIN)
260 return(true);
261 return(false);
264 static struct playlist_entry * playlist_buffer_get_track(struct playlist_buffer *pb,
265 int index)
267 int buffer_index=playlist_buffer_get_index(pb, index);
268 return(&(pb->tracks[buffer_index]));
271 /* Initialize the playlist viewer. */
272 static bool playlist_viewer_init(struct playlist_viewer * viewer,
273 char* filename, bool reload)
275 char* buffer;
276 size_t buffer_size;
277 bool is_playing = audio_status() & (AUDIO_STATUS_PLAY | AUDIO_STATUS_PAUSE);
278 bool have_list = filename || is_playing;
279 if (!have_list && (global_status.resume_index != -1))
281 /* Try to restore the list from control file */
282 have_list = (playlist_resume() != -1);
284 if (!have_list && (playlist_amount() > 0))
286 /*If dynamic playlist still exists, view it anyway even
287 if playback has reached the end of the playlist */
288 have_list = true;
290 if (!have_list)
292 /* Nothing to view, exit */
293 gui_syncsplash(HZ, str(LANG_CATALOG_NO_PLAYLISTS));
294 return false;
297 buffer = plugin_get_buffer(&buffer_size);
298 if (!buffer)
299 return false;
301 if (!filename)
302 viewer->playlist = NULL;
303 else
305 /* Viewing playlist on disk */
306 char *dir, *file, *temp_ptr;
307 char *index_buffer = NULL;
308 ssize_t index_buffer_size = 0;
310 viewer->playlist = &temp_playlist;
312 /* Separate directory from filename */
313 temp_ptr = strrchr(filename+1,'/');
314 if (temp_ptr)
316 *temp_ptr = 0;
317 dir = filename;
318 file = temp_ptr + 1;
320 else
322 dir = "/";
323 file = filename+1;
326 if (is_playing)
328 /* Something is playing, use half the plugin buffer for playlist
329 indices */
330 index_buffer_size = buffer_size / 2;
331 index_buffer = buffer;
334 playlist_create_ex(viewer->playlist, dir, file, index_buffer,
335 index_buffer_size, buffer+index_buffer_size,
336 buffer_size-index_buffer_size);
338 if (temp_ptr)
339 *temp_ptr = '/';
341 buffer += index_buffer_size;
342 buffer_size -= index_buffer_size;
344 playlist_buffer_init(&viewer->buffer, buffer, buffer_size );
346 viewer->move_track = -1;
348 if (!reload)
350 if (viewer->playlist)
351 viewer->selected_track = 0;
352 else
353 viewer->selected_track = playlist_get_display_index() - 1;
356 if (!update_playlist(true))
357 return false;
358 return true;
361 /* Format trackname for display purposes */
362 static void format_name(char* dest, const char* src)
364 switch (global_settings.playlist_viewer_track_display)
366 case 0:
367 default:
369 /* Only display the filename */
370 char* p = strrchr(src, '/');
372 strcpy(dest, p+1);
374 /* Remove the extension */
375 char* q = strrchr(dest, '.');
377 if (q != NULL)
378 *q = '\0';
380 break;
382 case 1:
383 /* Full path */
384 strcpy(dest, src);
385 break;
389 /* Format display line */
390 static void format_line(const struct playlist_entry* track, char* str,
391 int len)
393 char name[MAX_PATH];
394 char *skipped = "";
396 format_name(name, track->name);
398 if (track->skipped)
399 skipped = "(ERR) ";
401 if (global_settings.playlist_viewer_indices)
402 /* Display playlist index */
403 snprintf(str, len, "%d. %s%s", track->display_index, skipped, name);
404 else
405 snprintf(str, len, "%s%s", skipped, name);
409 /* Update playlist in case something has changed or forced */
410 static bool update_playlist(bool force)
412 if (!viewer.playlist)
413 playlist_get_resume_info(&viewer.current_playing_track);
414 else
415 viewer.current_playing_track = -1;
416 int nb_tracks=playlist_amount_ex(viewer.playlist);
417 force=force || nb_tracks != viewer.num_tracks;
418 if (force)
420 /* Reload tracks */
421 viewer.num_tracks = nb_tracks;
422 if (viewer.num_tracks <= 0)
423 return false;
424 playlist_buffer_load_entries_screen(&viewer.buffer, FORWARD);
425 if (viewer.buffer.num_loaded <= 0)
426 return false;
428 return true;
431 /* Menu of playlist commands. Invoked via ON+PLAY on main viewer screen.
432 Returns -1 if USB attached, 0 if no playlist change, and 1 if playlist
433 changed. */
434 static int onplay_menu(int index)
436 int result, ret = 0;
437 struct playlist_entry * current_track=
438 playlist_buffer_get_track(&viewer.buffer, index);
439 MENUITEM_STRINGLIST(menu_items, ID2P(LANG_PLAYLIST), NULL,
440 ID2P(LANG_REMOVE), ID2P(LANG_MOVE),
441 ID2P(LANG_CATALOG_ADD_TO), ID2P(LANG_CATALOG_ADD_TO_NEW));
442 bool current = (current_track->index == viewer.current_playing_track);
444 result = do_menu(&menu_items, NULL);
445 if (result == MENU_ATTACHED_USB)
447 ret = -1;
449 else if (result >= 0)
451 /* Abort current move */
452 viewer.move_track = -1;
454 switch (result)
456 case 0:
457 /* delete track */
458 playlist_delete(viewer.playlist, current_track->index);
459 if (current)
461 if (playlist_amount_ex(viewer.playlist) <= 0)
462 audio_stop();
463 else
465 /* Start playing new track except if it's the lasttrack
466 track in the playlist and repeat mode is disabled */
467 current_track =
468 playlist_buffer_get_track(&viewer.buffer, index);
469 if (current_track->display_index!=viewer.num_tracks ||
470 global_settings.repeat_mode == REPEAT_ALL)
472 #if CONFIG_CODEC != SWCODEC
473 talk_buffer_steal(); /* will use the mp3 buffer */
474 #endif
475 audio_play(0);
476 viewer.current_playing_track = -1;
480 ret = 1;
481 break;
482 case 1:
483 /* move track */
484 viewer.move_track = current_track->index;
485 ret = 0;
486 break;
487 case 2: /* add to catalog */
488 case 3: /* add to a new one */
489 catalog_add_to_a_playlist(current_track->name,
490 FILE_ATTR_AUDIO,
491 result==3 );
492 ret = 0;
493 break;
496 return ret;
499 /* Menu of viewer options. Invoked via F1(r) or Menu(p). */
500 MENUITEM_SETTING(show_icons, &global_settings.playlist_viewer_icons, NULL);
501 MENUITEM_SETTING(show_indices, &global_settings.playlist_viewer_indices, NULL);
502 MENUITEM_SETTING(track_display,
503 &global_settings.playlist_viewer_track_display, NULL);
504 MENUITEM_FUNCTION(save_playlist_item, 0, ID2P(LANG_SAVE_DYNAMIC_PLAYLIST),
505 save_playlist_func, 0, NULL, Icon_NOICON);
506 MAKE_MENU(viewer_settings_menu, ID2P(LANG_PLAYLISTVIEWER_SETTINGS),
507 NULL, Icon_Playlist,
508 &show_icons, &show_indices, &track_display, &save_playlist_item);
509 static bool viewer_menu(void)
511 return do_menu(&viewer_settings_menu, NULL) == MENU_ATTACHED_USB;
514 /* Save playlist to disk */
515 static int save_playlist_func(void)
517 save_playlist_screen(viewer.playlist);
518 return 0;
521 /* View current playlist */
522 bool playlist_viewer(void)
524 return playlist_viewer_ex(NULL);
527 static int get_track_num( struct playlist_viewer * local_viewer,
528 int selected_item )
530 if( local_viewer->move_track >= 0 )
532 if( local_viewer->selected_track == selected_item )
534 return local_viewer->move_track;
536 else if( local_viewer->selected_track > selected_item
537 && selected_item >= local_viewer->move_track )
539 return selected_item+1;
541 else if( local_viewer->selected_track < selected_item
542 && selected_item <= local_viewer->move_track )
544 return selected_item-1;
547 return selected_item;
550 static char *playlist_callback_name(int selected_item, void *data, char *buffer)
552 struct playlist_viewer * local_viewer = (struct playlist_viewer *)data;
553 struct playlist_entry *track = playlist_buffer_get_track(&(local_viewer->buffer), get_track_num(local_viewer,selected_item));
554 format_line(track, buffer, MAX_PATH);
555 return(buffer);
559 static int playlist_callback_icons(int selected_item, void *data)
561 struct playlist_viewer * local_viewer=(struct playlist_viewer *)data;
562 struct playlist_entry *track=
563 playlist_buffer_get_track(&(local_viewer->buffer),
564 get_track_num(local_viewer, selected_item));
565 if (track->index == local_viewer->current_playing_track)
567 /* Current playing track */
568 return Icon_Audio;
570 else if (track->index == local_viewer->move_track)
572 /* Track we are moving */
573 return Icon_Moving;
575 else if (track->queued)
577 /* Queued track */
578 return Icon_Queued;
580 else
581 return Icon_NOICON;
584 /* Main viewer function. Filename identifies playlist to be viewed. If NULL,
585 view current playlist. */
586 bool playlist_viewer_ex(char* filename)
588 bool ret = false; /* return value */
589 bool exit=false; /* exit viewer */
590 int button;
591 struct gui_synclist playlist_lists;
592 if (!playlist_viewer_init(&viewer, filename, false))
593 goto exit;
595 gui_synclist_init(&playlist_lists, playlist_callback_name, &viewer, false, 1);
596 gui_synclist_set_icon_callback(&playlist_lists,
597 global_settings.playlist_viewer_icons?
598 &playlist_callback_icons:NULL);
599 gui_synclist_set_nb_items(&playlist_lists, viewer.num_tracks);
600 gui_synclist_select_item(&playlist_lists, viewer.selected_track);
601 gui_synclist_set_title(&playlist_lists, str(LANG_PLAYLIST), Icon_Playlist);
602 gui_synclist_draw(&playlist_lists);
603 while (!exit)
605 int track;
607 if (global_status.resume_index != -1 && !viewer.playlist)
608 playlist_get_resume_info(&track);
609 else
610 track = -1;
612 if (track != viewer.current_playing_track ||
613 playlist_amount_ex(viewer.playlist) != viewer.num_tracks)
615 /* Playlist has changed (new track started?) */
616 if (!update_playlist(false))
617 goto exit;
618 /*Needed because update_playlist gives wrong value when
619 playing is stopped*/
620 viewer.current_playing_track = track;
621 gui_synclist_set_nb_items(&playlist_lists, viewer.num_tracks);
622 /* Abort move on playlist change */
623 viewer.move_track = -1;
624 gui_synclist_draw(&playlist_lists);
627 /* Timeout so we can determine if play status has changed */
628 button = get_action(CONTEXT_TREE,HZ/2);
629 if( (gui_synclist_do_button(&playlist_lists, &button,LIST_WRAP_UNLESS_HELD)) )
631 viewer.selected_track=gui_synclist_get_sel_pos(&playlist_lists);
632 if(playlist_buffer_needs_reload(&viewer.buffer,
633 viewer.selected_track))
634 playlist_buffer_load_entries_screen(&viewer.buffer,
635 button==ACTION_STD_NEXT?
636 FORWARD
638 BACKWARD
640 gui_synclist_draw(&playlist_lists);
642 switch (button)
644 case ACTION_TREE_WPS:
645 case ACTION_STD_CANCEL:
646 exit = true;
647 break;
648 case ACTION_STD_OK:
650 struct playlist_entry * current_track =
651 playlist_buffer_get_track(&viewer.buffer,
652 viewer.selected_track);
653 if (viewer.move_track >= 0)
655 /* Move track */
656 int ret_val;
658 ret_val = playlist_move(viewer.playlist, viewer.move_track,
659 current_track->index);
660 if (ret_val < 0)
661 gui_syncsplash(HZ, (unsigned char *)"%s %s",
662 str(LANG_MOVE), str(LANG_FAILED));
663 update_playlist(true);
664 viewer.move_track = -1;
666 else if (!viewer.playlist)
668 /* play new track */
669 playlist_start(current_track->index, 0);
670 update_playlist(false);
672 else
674 /* New playlist */
675 if (playlist_set_current(viewer.playlist) < 0)
676 goto exit;
678 playlist_start(current_track->index, 0);
680 /* Our playlist is now the current list */
681 if (!playlist_viewer_init(&viewer, NULL, true))
682 goto exit;
684 gui_synclist_draw(&playlist_lists);
686 break;
688 case ACTION_STD_CONTEXT:
690 /* ON+PLAY menu */
691 int ret_val;
693 ret_val = onplay_menu(viewer.selected_track);
695 if (ret_val < 0)
697 ret = true;
698 goto exit;
700 else if (ret > 0)
702 /* Playlist changed */
703 gui_synclist_del_item(&playlist_lists);
704 update_playlist(true);
705 if (viewer.num_tracks <= 0)
706 exit = true;
707 if(viewer.selected_track >= viewer.num_tracks)
708 viewer.selected_track = viewer.num_tracks-1;
710 gui_synclist_draw(&playlist_lists);
711 break;
713 case ACTION_STD_MENU:
714 if (viewer_menu())
716 ret = true;
717 goto exit;
719 gui_synclist_set_icon_callback(
720 &playlist_lists,
721 global_settings.playlist_viewer_icons?
722 &playlist_callback_icons:NULL
724 gui_synclist_draw(&playlist_lists);
725 break;
727 case ACTION_NONE:
728 gui_syncstatusbar_draw(&statusbars, false);
729 break;
731 default:
732 if(default_event_handler(button) == SYS_USB_CONNECTED)
734 ret = true;
735 goto exit;
737 break;
741 exit:
742 if (viewer.playlist)
743 playlist_close(viewer.playlist);
744 return ret;
747 static char *playlist_search_callback_name(int selected_item, void * data, char *buffer)
749 int *found_indicies = (int*)data;
750 static struct playlist_track_info track;
751 playlist_get_track_info(viewer.playlist,found_indicies[selected_item],&track);
752 format_name(buffer,track.filename);
753 return(buffer);
756 bool search_playlist(void)
758 char search_str[32] = "";
759 bool ret = false, exit = false;
760 int i, playlist_count;
761 int found_indicies[MAX_PLAYLIST_ENTRIES],found_indicies_count = 0;
762 int button;
763 struct gui_synclist playlist_lists;
764 struct playlist_track_info track;
766 if (!playlist_viewer_init(&viewer, 0, false))
767 return ret;
768 if (kbd_input(search_str,sizeof(search_str)) == -1)
769 return ret;
770 lcd_clear_display();
771 playlist_count = playlist_amount_ex(viewer.playlist);
772 for (i=0;(i<playlist_count)&&(found_indicies_count<MAX_PLAYLIST_ENTRIES);i++)
774 gui_syncsplash(0, str(LANG_PLAYLIST_SEARCH_MSG),found_indicies_count,
775 str(LANG_OFF_ABORT));
776 if (action_userabort(TIMEOUT_NOBLOCK))
778 if (!found_indicies_count)
779 return ret;
780 break;
782 playlist_get_track_info(viewer.playlist,i,&track);
783 if (strcasestr(track.filename,search_str))
785 found_indicies[found_indicies_count++] = track.index;
788 if (!found_indicies_count)
790 return ret;
792 backlight_on();
793 gui_synclist_init(&playlist_lists, playlist_search_callback_name,
794 found_indicies, false, 1);
795 gui_synclist_set_icon_callback(&playlist_lists, NULL);
796 gui_synclist_set_nb_items(&playlist_lists, found_indicies_count);
797 gui_synclist_select_item(&playlist_lists, 0);
798 gui_synclist_draw(&playlist_lists);
799 while (!exit)
801 button = get_action(CONTEXT_LIST,TIMEOUT_BLOCK);
802 if (gui_synclist_do_button(&playlist_lists, &button, LIST_WRAP_UNLESS_HELD))
803 continue;
804 switch (button)
806 case ACTION_STD_CANCEL:
807 exit = true;
808 break;
810 case ACTION_STD_OK:
811 playlist_start(
812 found_indicies[gui_synclist_get_sel_pos(&playlist_lists)]
813 ,0);
814 exit = 1;
815 break;
816 case ACTION_NONE:
817 break;
818 default:
819 if(default_event_handler(button) == SYS_USB_CONNECTED)
821 ret = true;
822 exit = true;
824 break;
827 return ret;