Fix a dircache NULL-pointer dereference.
[kugel-rb.git] / apps / tagtree.c
blobef9c9d2de75b1efd1130b92c32c0db50f9913e97
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2005 by Miika Pekkarinen
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
18 * KIND, either express or implied.
20 ****************************************************************************/
22 /**
23 * Basic structure on this file was copied from dbtree.c and modified to
24 * support the tag cache interface.
27 /*#define LOGF_ENABLE*/
29 #include <stdio.h>
30 #include <string.h>
31 #include <stdlib.h>
32 #include "config.h"
33 #include "system.h"
34 #include "kernel.h"
35 #include "splash.h"
36 #include "icons.h"
37 #include "tree.h"
38 #include "action.h"
39 #include "settings.h"
40 #include "tagcache.h"
41 #include "tagtree.h"
42 #include "lang.h"
43 #include "logf.h"
44 #include "playlist.h"
45 #include "keyboard.h"
46 #include "gui/list.h"
47 #include "buffer.h"
48 #include "yesno.h"
49 #include "misc.h"
50 #include "filetypes.h"
51 #include "audio.h"
52 #include "appevents.h"
53 #include "storage.h"
54 #include "dir_uncached.h"
56 #define FILE_SEARCH_INSTRUCTIONS ROCKBOX_DIR "/tagnavi.config"
58 static int tagtree_play_folder(struct tree_context* c);
60 #define SEARCHSTR_SIZE 256
62 enum table {
63 ROOT = 1,
64 NAVIBROWSE,
65 ALLSUBENTRIES,
66 PLAYTRACK,
69 static const struct id3_to_search_mapping {
70 char *string;
71 size_t id3_offset;
72 } id3_to_search_mapping[] = {
73 { "", 0 }, /* offset n/a */
74 { "#directory#", 0 }, /* offset n/a */
75 { "#title#", offsetof(struct mp3entry, title) },
76 { "#artist#", offsetof(struct mp3entry, artist) },
77 { "#album#", offsetof(struct mp3entry, album) },
78 { "#genre#", offsetof(struct mp3entry, genre_string) },
79 { "#composer#", offsetof(struct mp3entry, composer) },
80 { "#albumartist#", offsetof(struct mp3entry, albumartist) },
82 enum variables {
83 var_sorttype = 100,
84 var_limit,
85 var_strip,
86 var_menu_start,
87 var_include,
88 var_rootmenu,
89 var_format,
90 menu_next,
91 menu_load,
94 /* Capacity 10 000 entries (for example 10k different artists) */
95 #define UNIQBUF_SIZE (64*1024)
96 static long *uniqbuf;
98 #define MAX_TAGS 5
99 #define MAX_MENU_ID_SIZE 32
101 static bool sort_inverse;
104 * "%3d. %s" autoscore title %sort = "inverse" %limit = "100"
106 * valid = true
107 * formatstr = "%-3d. %s"
108 * tags[0] = tag_autoscore
109 * tags[1] = tag_title
110 * tag_count = 2
112 * limit = 100
113 * sort_inverse = true
115 struct display_format {
116 char name[32];
117 struct tagcache_search_clause *clause[TAGCACHE_MAX_CLAUSES];
118 int clause_count;
119 char *formatstr;
120 int group_id;
121 int tags[MAX_TAGS];
122 int tag_count;
124 int limit;
125 int strip;
126 bool sort_inverse;
129 static struct display_format *formats[TAGMENU_MAX_FMTS];
130 static int format_count;
132 struct search_instruction {
133 char name[64];
134 int tagorder[MAX_TAGS];
135 int tagorder_count;
136 struct tagcache_search_clause *clause[MAX_TAGS][TAGCACHE_MAX_CLAUSES];
137 int format_id[MAX_TAGS];
138 int clause_count[MAX_TAGS];
139 int result_seek[MAX_TAGS];
142 struct menu_entry {
143 char name[64];
144 int type;
145 struct search_instruction *si;
146 int link;
149 struct menu_root {
150 char title[64];
151 char id[MAX_MENU_ID_SIZE];
152 int itemcount;
153 struct menu_entry *items[TAGMENU_MAX_ITEMS];
156 /* Statusbar text of the current view. */
157 static char current_title[MAX_TAGS][128];
159 static struct menu_root *menus[TAGMENU_MAX_MENUS];
160 static struct menu_root *menu;
161 static struct search_instruction *csi;
162 static const char *strp;
163 static int menu_count;
164 static int rootmenu;
166 static int current_offset;
167 static int current_entry_count;
169 static struct tree_context *tc;
171 static int get_token_str(char *buf, int size)
173 /* Find the start. */
174 while (*strp != '"' && *strp != '\0')
175 strp++;
177 if (*strp == '\0' || *(++strp) == '\0')
178 return -1;
180 /* Read the data. */
181 while (*strp != '"' && *strp != '\0' && --size > 0)
182 *(buf++) = *(strp++);
184 *buf = '\0';
185 if (*strp != '"')
186 return -2;
188 strp++;
190 return 0;
193 #define MATCH(tag,str1,str2,settag) \
194 if (!strcasecmp(str1, str2)) { \
195 *tag = settag; \
196 return 1; \
199 static int get_tag(int *tag)
201 char buf[128];
202 int i;
204 /* Find the start. */
205 while ((*strp == ' ' || *strp == '>') && *strp != '\0')
206 strp++;
208 if (*strp == '\0' || *strp == '?')
209 return 0;
211 for (i = 0; i < (int)sizeof(buf)-1; i++)
213 if (*strp == '\0' || *strp == ' ')
214 break ;
215 buf[i] = *strp;
216 strp++;
218 buf[i] = '\0';
220 MATCH(tag, buf, "album", tag_album);
221 MATCH(tag, buf, "artist", tag_artist);
222 MATCH(tag, buf, "bitrate", tag_bitrate);
223 MATCH(tag, buf, "composer", tag_composer);
224 MATCH(tag, buf, "comment", tag_comment);
225 MATCH(tag, buf, "albumartist", tag_albumartist);
226 MATCH(tag, buf, "ensemble", tag_albumartist);
227 MATCH(tag, buf, "grouping", tag_grouping);
228 MATCH(tag, buf, "genre", tag_genre);
229 MATCH(tag, buf, "length", tag_length);
230 MATCH(tag, buf, "Lm", tag_virt_length_min);
231 MATCH(tag, buf, "Ls", tag_virt_length_sec);
232 MATCH(tag, buf, "Pm", tag_virt_playtime_min);
233 MATCH(tag, buf, "Ps", tag_virt_playtime_sec);
234 MATCH(tag, buf, "title", tag_title);
235 MATCH(tag, buf, "filename", tag_filename);
236 MATCH(tag, buf, "tracknum", tag_tracknumber);
237 MATCH(tag, buf, "discnum", tag_discnumber);
238 MATCH(tag, buf, "year", tag_year);
239 MATCH(tag, buf, "playcount", tag_playcount);
240 MATCH(tag, buf, "rating", tag_rating);
241 MATCH(tag, buf, "lastplayed", tag_lastplayed);
242 MATCH(tag, buf, "commitid", tag_commitid);
243 MATCH(tag, buf, "entryage", tag_virt_entryage);
244 MATCH(tag, buf, "autoscore", tag_virt_autoscore);
245 MATCH(tag, buf, "%sort", var_sorttype);
246 MATCH(tag, buf, "%limit", var_limit);
247 MATCH(tag, buf, "%strip", var_strip);
248 MATCH(tag, buf, "%menu_start", var_menu_start);
249 MATCH(tag, buf, "%include", var_include);
250 MATCH(tag, buf, "%root_menu", var_rootmenu);
251 MATCH(tag, buf, "%format", var_format);
252 MATCH(tag, buf, "->", menu_next);
253 MATCH(tag, buf, "==>", menu_load);
255 logf("NO MATCH: %s\n", buf);
256 if (buf[0] == '?')
257 return 0;
259 return -1;
262 static int get_clause(int *condition)
264 char buf[4];
265 int i;
267 /* Find the start. */
268 while (*strp == ' ' && *strp != '\0')
269 strp++;
271 if (*strp == '\0')
272 return 0;
274 for (i = 0; i < (int)sizeof(buf)-1; i++)
276 if (*strp == '\0' || *strp == ' ')
277 break ;
278 buf[i] = *strp;
279 strp++;
281 buf[i] = '\0';
283 MATCH(condition, buf, "=", clause_is);
284 MATCH(condition, buf, "==", clause_is);
285 MATCH(condition, buf, "!=", clause_is_not);
286 MATCH(condition, buf, ">", clause_gt);
287 MATCH(condition, buf, ">=", clause_gteq);
288 MATCH(condition, buf, "<", clause_lt);
289 MATCH(condition, buf, "<=", clause_lteq);
290 MATCH(condition, buf, "~", clause_contains);
291 MATCH(condition, buf, "!~", clause_not_contains);
292 MATCH(condition, buf, "^", clause_begins_with);
293 MATCH(condition, buf, "!^", clause_not_begins_with);
294 MATCH(condition, buf, "$", clause_ends_with);
295 MATCH(condition, buf, "!$", clause_not_ends_with);
296 MATCH(condition, buf, "@", clause_oneof);
298 return 0;
301 static bool read_clause(struct tagcache_search_clause *clause)
303 char buf[SEARCHSTR_SIZE];
304 unsigned int i;
306 if (get_tag(&clause->tag) <= 0)
307 return false;
309 if (get_clause(&clause->type) <= 0)
310 return false;
312 if (get_token_str(buf, sizeof buf) < 0)
313 return false;
315 for (i=0; i<ARRAYLEN(id3_to_search_mapping); i++)
317 if (!strcasecmp(buf, id3_to_search_mapping[i].string))
318 break;
321 if (i<ARRAYLEN(id3_to_search_mapping)) /* runtime search operand found */
323 clause->source = source_runtime+i;
324 clause->str = buffer_alloc(SEARCHSTR_SIZE);
326 else
328 clause->source = source_constant;
329 clause->str = buffer_alloc(strlen(buf)+1);
330 strcpy(clause->str, buf);
333 if (TAGCACHE_IS_NUMERIC(clause->tag))
335 clause->numeric = true;
336 clause->numeric_data = atoi(clause->str);
338 else
339 clause->numeric = false;
341 logf("got clause: %d/%d [%s]", clause->tag, clause->type, clause->str);
343 return true;
346 static bool read_variable(char *buf, int size)
348 int condition;
350 if (!get_clause(&condition))
351 return false;
353 if (condition != clause_is)
354 return false;
356 if (get_token_str(buf, size) < 0)
357 return false;
359 return true;
362 /* "%3d. %s" autoscore title %sort = "inverse" %limit = "100" */
363 static int get_format_str(struct display_format *fmt)
365 int ret;
366 char buf[128];
367 int i;
369 memset(fmt, 0, sizeof(struct display_format));
371 if (get_token_str(fmt->name, sizeof fmt->name) < 0)
372 return -10;
374 /* Determine the group id */
375 fmt->group_id = 0;
376 for (i = 0; i < format_count; i++)
378 if (!strcasecmp(formats[i]->name, fmt->name))
380 fmt->group_id = formats[i]->group_id;
381 break;
384 if (formats[i]->group_id > fmt->group_id)
385 fmt->group_id = formats[i]->group_id;
388 if (i == format_count)
389 fmt->group_id++;
391 logf("format: (%d) %s", fmt->group_id, fmt->name);
393 if (get_token_str(buf, sizeof buf) < 0)
394 return -10;
396 fmt->formatstr = buffer_alloc(strlen(buf) + 1);
397 strcpy(fmt->formatstr, buf);
399 while (fmt->tag_count < MAX_TAGS)
401 ret = get_tag(&fmt->tags[fmt->tag_count]);
402 if (ret < 0)
403 return -11;
405 if (ret == 0)
406 break;
408 switch (fmt->tags[fmt->tag_count]) {
409 case var_sorttype:
410 if (!read_variable(buf, sizeof buf))
411 return -12;
412 if (!strcasecmp("inverse", buf))
413 fmt->sort_inverse = true;
414 break;
416 case var_limit:
417 if (!read_variable(buf, sizeof buf))
418 return -13;
419 fmt->limit = atoi(buf);
420 break;
422 case var_strip:
423 if (!read_variable(buf, sizeof buf))
424 return -14;
425 fmt->strip = atoi(buf);
426 break;
428 default:
429 fmt->tag_count++;
433 return 1;
436 static int add_format(const char *buf)
438 strp = buf;
440 if (formats[format_count] == NULL)
441 formats[format_count] = buffer_alloc(sizeof(struct display_format));
443 memset(formats[format_count], 0, sizeof(struct display_format));
444 if (get_format_str(formats[format_count]) < 0)
446 logf("get_format_str() parser failed!");
447 return -4;
450 while (*strp != '\0' && *strp != '?')
451 strp++;
453 if (*strp == '?')
455 int clause_count = 0;
456 strp++;
458 while (1)
460 if (clause_count >= TAGCACHE_MAX_CLAUSES)
462 logf("too many clauses");
463 break;
466 formats[format_count]->clause[clause_count] =
467 buffer_alloc(sizeof(struct tagcache_search_clause));
469 if (!read_clause(formats[format_count]->clause[clause_count]))
470 break;
472 clause_count++;
475 formats[format_count]->clause_count = clause_count;
478 format_count++;
480 return 1;
483 static int get_condition(struct search_instruction *inst)
485 int clause_count;
486 char buf[128];
488 switch (*strp)
490 case '=':
492 int i;
494 if (get_token_str(buf, sizeof buf) < 0)
495 return -1;
497 for (i = 0; i < format_count; i++)
499 if (!strcasecmp(formats[i]->name, buf))
500 break;
503 if (i == format_count)
505 logf("format not found: %s", buf);
506 return -2;
509 inst->format_id[inst->tagorder_count] = formats[i]->group_id;
510 return 1;
512 case '?':
513 case ' ':
514 case '&':
515 strp++;
516 return 1;
517 case '-':
518 case '\0':
519 return 0;
522 clause_count = inst->clause_count[inst->tagorder_count];
523 if (clause_count >= TAGCACHE_MAX_CLAUSES)
525 logf("Too many clauses");
526 return false;
529 inst->clause[inst->tagorder_count][clause_count] =
530 buffer_alloc(sizeof(struct tagcache_search_clause));
532 if (!read_clause(inst->clause[inst->tagorder_count][clause_count]))
533 return -1;
535 inst->clause_count[inst->tagorder_count]++;
537 return 1;
540 /* example search:
541 * "Best" artist ? year >= "2000" & title !^ "crap" & genre = "good genre" \
542 * : album ? year >= "2000" : songs
543 * ^ begins with
544 * * contains
545 * $ ends with
548 static bool parse_search(struct menu_entry *entry, const char *str)
550 int ret;
551 int type;
552 struct search_instruction *inst = entry->si;
553 char buf[MAX_PATH];
554 int i;
555 struct menu_root *new_menu;
557 strp = str;
559 /* Parse entry name */
560 if (get_token_str(entry->name, sizeof entry->name) < 0)
562 logf("No name found.");
563 return false;
566 /* Parse entry type */
567 if (get_tag(&entry->type) <= 0)
568 return false;
570 if (entry->type == menu_load)
572 if (get_token_str(buf, sizeof buf) < 0)
573 return false;
575 /* Find the matching root menu or "create" it */
576 for (i = 0; i < menu_count; i++)
578 if (!strcasecmp(menus[i]->id, buf))
580 entry->link = i;
581 return true;
585 if (menu_count >= TAGMENU_MAX_MENUS)
587 logf("max menucount reached");
588 return false;
591 /* Allocate a new menu unless link is found. */
592 menus[menu_count] = buffer_alloc(sizeof(struct menu_root));
593 new_menu = menus[menu_count];
594 memset(new_menu, 0, sizeof(struct menu_root));
595 strlcpy(new_menu->id, buf, MAX_MENU_ID_SIZE);
596 entry->link = menu_count;
597 ++menu_count;
599 return true;
602 if (entry->type != menu_next)
603 return false;
605 while (inst->tagorder_count < MAX_TAGS)
607 ret = get_tag(&inst->tagorder[inst->tagorder_count]);
608 if (ret < 0)
610 logf("Parse error #1");
611 logf("%s", strp);
612 return false;
615 if (ret == 0)
616 break ;
618 logf("tag: %d", inst->tagorder[inst->tagorder_count]);
620 while ( (ret = get_condition(inst)) > 0 ) ;
621 if (ret < 0)
622 return false;
624 inst->tagorder_count++;
626 if (get_tag(&type) <= 0 || type != menu_next)
627 break;
630 return true;
633 static int compare(const void *p1, const void *p2)
635 struct tagentry *e1 = (struct tagentry *)p1;
636 struct tagentry *e2 = (struct tagentry *)p2;
638 if (sort_inverse)
639 return strncasecmp(e2->name, e1->name, MAX_PATH);
641 return strncasecmp(e1->name, e2->name, MAX_PATH);
644 static void tagtree_buffer_event(void *data)
646 struct tagcache_search tcs;
647 struct mp3entry *id3 = (struct mp3entry*)data;
649 /* Do not gather data unless proper setting has been enabled. */
650 if (!global_settings.runtimedb)
651 return;
653 logf("be:%s", id3->path);
655 if (!tagcache_find_index(&tcs, id3->path))
657 logf("tc stat: not found: %s", id3->path);
658 return;
661 id3->playcount = tagcache_get_numeric(&tcs, tag_playcount);
662 if (!id3->rating)
663 id3->rating = tagcache_get_numeric(&tcs, tag_rating);
664 id3->lastplayed = tagcache_get_numeric(&tcs, tag_lastplayed);
665 id3->score = tagcache_get_numeric(&tcs, tag_virt_autoscore) / 10;
666 id3->playtime = tagcache_get_numeric(&tcs, tag_playtime);
668 /* Store our tagcache index pointer. */
669 id3->tagcache_idx = tcs.idx_id+1;
671 tagcache_search_finish(&tcs);
674 static void tagtree_track_finish_event(void *data)
676 long playcount;
677 long playtime;
678 long lastplayed;
679 long tagcache_idx;
680 struct mp3entry *id3 = (struct mp3entry*)data;
682 /* Do not gather data unless proper setting has been enabled. */
683 if (!global_settings.runtimedb)
685 logf("runtimedb gathering not enabled");
686 return;
689 tagcache_idx=id3->tagcache_idx;
690 if (!tagcache_idx)
692 logf("No tagcache index pointer found");
693 return;
695 tagcache_idx--;
697 /* Don't process unplayed tracks. */
698 if (id3->elapsed == 0)
700 logf("not logging unplayed track");
701 return;
704 playcount = id3->playcount + 1;
705 lastplayed = tagcache_increase_serial();
706 if (lastplayed < 0)
708 logf("incorrect tc serial:%ld", lastplayed);
709 return;
712 /* Ignore the last 15s (crossfade etc.) */
713 playtime = id3->playtime + MIN(id3->length, id3->elapsed + 15 * 1000);
715 logf("ube:%s", id3->path);
716 logf("-> %ld/%ld", playcount, playtime);
717 logf("-> %ld/%ld/%ld", id3->elapsed, id3->length, MIN(id3->length, id3->elapsed + 15 * 1000));
719 /* Queue the updates to the tagcache system. */
720 tagcache_update_numeric(tagcache_idx, tag_playcount, playcount);
721 tagcache_update_numeric(tagcache_idx, tag_playtime, playtime);
722 tagcache_update_numeric(tagcache_idx, tag_lastplayed, lastplayed);
725 bool tagtree_export(void)
727 struct tagcache_search tcs;
729 splash(0, str(LANG_CREATING));
730 if (!tagcache_create_changelog(&tcs))
732 splash(HZ*2, ID2P(LANG_FAILED));
735 return false;
738 bool tagtree_import(void)
740 splash(0, ID2P(LANG_WAIT));
741 if (!tagcache_import_changelog())
743 splash(HZ*2, ID2P(LANG_FAILED));
746 return false;
749 static bool parse_menu(const char *filename);
751 static int parse_line(int n, const char *buf, void *parameters)
753 char data[256];
754 int variable;
755 static bool read_menu;
756 int i;
758 (void)parameters;
760 logf("parse:%d/%s", n, buf);
762 /* First line, do initialisation. */
763 if (n == 0)
765 if (strcasecmp(TAGNAVI_VERSION, buf))
767 logf("Version mismatch");
768 return -1;
771 read_menu = false;
774 if (buf[0] == '#')
775 return 0;
777 if (buf[0] == '\0')
779 if (read_menu)
781 /* End the menu */
782 read_menu = false;
784 return 0;
787 if (!read_menu)
789 strp = buf;
790 if (get_tag(&variable) <= 0)
791 return 0;
793 switch (variable)
795 case var_format:
796 if (add_format(strp) < 0)
798 logf("Format add fail: %s", data);
800 break;
802 case var_include:
803 if (get_token_str(data, sizeof(data)) < 0)
805 logf("%%include empty");
806 return 0;
809 if (!parse_menu(data))
811 logf("Load menu fail: %s", data);
813 break;
815 case var_menu_start:
816 if (menu_count >= TAGMENU_MAX_MENUS)
818 logf("max menucount reached");
819 return 0;
822 if (get_token_str(data, sizeof data) < 0)
824 logf("%%menu_start id empty");
825 return 0;
828 menu = NULL;
829 for (i = 0; i < menu_count; i++)
831 if (!strcasecmp(menus[i]->id, data))
833 menu = menus[i];
837 if (menu == NULL)
839 menus[menu_count] = buffer_alloc(sizeof(struct menu_root));
840 menu = menus[menu_count];
841 ++menu_count;
842 memset(menu, 0, sizeof(struct menu_root));
843 strlcpy(menu->id, data, MAX_MENU_ID_SIZE);
846 if (get_token_str(menu->title, sizeof(menu->title)) < 0)
848 logf("%%menu_start title empty");
849 return 0;
851 logf("menu: %s", menu->title);
852 read_menu = true;
853 break;
855 case var_rootmenu:
856 /* Only set root menu once. */
857 if (rootmenu >= 0)
858 break;
860 if (get_token_str(data, sizeof(data)) < 0)
862 logf("%%rootmenu empty");
863 return 0;
866 for (i = 0; i < menu_count; i++)
868 if (!strcasecmp(menus[i]->id, data))
870 rootmenu = i;
873 break;
876 return 0;
879 if (menu->itemcount >= TAGMENU_MAX_ITEMS)
881 logf("max itemcount reached");
882 return 0;
885 /* Allocate */
886 if (menu->items[menu->itemcount] == NULL)
888 menu->items[menu->itemcount] = buffer_alloc(sizeof(struct menu_entry));
889 memset(menu->items[menu->itemcount], 0, sizeof(struct menu_entry));
890 menu->items[menu->itemcount]->si = buffer_alloc(sizeof(struct search_instruction));
893 memset(menu->items[menu->itemcount]->si, 0, sizeof(struct search_instruction));
894 if (!parse_search(menu->items[menu->itemcount], buf))
895 return 0;
897 menu->itemcount++;
899 return 0;
902 static bool parse_menu(const char *filename)
904 int fd;
905 char buf[1024];
907 if (menu_count >= TAGMENU_MAX_MENUS)
909 logf("max menucount reached");
910 return false;
913 fd = open(filename, O_RDONLY);
914 if (fd < 0)
916 logf("Search instruction file not found.");
917 return false;
920 /* Now read file for real, parsing into si */
921 fast_readline(fd, buf, sizeof buf, NULL, parse_line);
922 close(fd);
924 return true;
927 void tagtree_init(void)
929 format_count = 0;
930 menu_count = 0;
931 menu = NULL;
932 rootmenu = -1;
933 parse_menu(FILE_SEARCH_INSTRUCTIONS);
935 /* If no root menu is set, assume it's the first single menu
936 * we have. That shouldn't normally happen. */
937 if (rootmenu < 0)
938 rootmenu = 0;
940 uniqbuf = buffer_alloc(UNIQBUF_SIZE);
942 add_event(PLAYBACK_EVENT_TRACK_BUFFER, false, tagtree_buffer_event);
943 add_event(PLAYBACK_EVENT_TRACK_FINISH, false, tagtree_track_finish_event);
946 static bool show_search_progress(bool init, int count)
948 static int last_tick = 0;
950 /* Don't show splashes for 1/2 second after starting search */
951 if (init)
953 last_tick = current_tick + HZ/2;
954 return true;
957 /* Update progress every 1/10 of a second */
958 if (TIME_AFTER(current_tick, last_tick + HZ/10))
960 splashf(0, str(LANG_PLAYLIST_SEARCH_MSG), count, str(LANG_OFF_ABORT));
961 if (action_userabort(TIMEOUT_NOBLOCK))
962 return false;
963 last_tick = current_tick;
964 yield();
967 return true;
970 static int format_str(struct tagcache_search *tcs, struct display_format *fmt,
971 char *buf, int buf_size)
973 char fmtbuf[8];
974 bool read_format = false;
975 int fmtbuf_pos = 0;
976 int parpos = 0;
977 int buf_pos = 0;
978 int i;
980 memset(buf, 0, buf_size);
981 for (i = 0; fmt->formatstr[i] != '\0'; i++)
983 if (fmt->formatstr[i] == '%')
985 read_format = true;
986 fmtbuf_pos = 0;
987 if (parpos >= fmt->tag_count)
989 logf("too many format tags");
990 return -1;
994 if (read_format)
996 fmtbuf[fmtbuf_pos++] = fmt->formatstr[i];
997 if (fmtbuf_pos >= buf_size)
999 logf("format parse error");
1000 return -2;
1003 if (fmt->formatstr[i] == 's')
1005 fmtbuf[fmtbuf_pos] = '\0';
1006 read_format = false;
1007 if (fmt->tags[parpos] == tcs->type)
1009 snprintf(&buf[buf_pos], buf_size - buf_pos, fmtbuf, tcs->result);
1011 else
1013 /* Need to fetch the tag data. */
1014 if (!tagcache_retrieve(tcs, tcs->idx_id, fmt->tags[parpos],
1015 &buf[buf_pos], buf_size - buf_pos))
1017 logf("retrieve failed");
1018 return -3;
1021 buf_pos += strlen(&buf[buf_pos]);
1022 parpos++;
1024 else if (fmt->formatstr[i] == 'd')
1026 fmtbuf[fmtbuf_pos] = '\0';
1027 read_format = false;
1028 snprintf(&buf[buf_pos], buf_size - buf_pos, fmtbuf,
1029 tagcache_get_numeric(tcs, fmt->tags[parpos]));
1030 buf_pos += strlen(&buf[buf_pos]);
1031 parpos++;
1033 continue;
1036 buf[buf_pos++] = fmt->formatstr[i];
1038 if (buf_pos - 1 >= buf_size)
1040 logf("buffer overflow");
1041 return -4;
1045 buf[buf_pos++] = '\0';
1047 return 0;
1050 static int retrieve_entries(struct tree_context *c, int offset, bool init)
1052 struct tagcache_search tcs;
1053 struct tagentry *dptr = (struct tagentry *)c->dircache;
1054 struct display_format *fmt;
1055 int i;
1056 int namebufused = 0;
1057 int total_count = 0;
1058 int special_entry_count = 0;
1059 int level = c->currextra;
1060 int tag;
1061 bool sort = false;
1062 int sort_limit;
1063 int strip;
1065 /* Show search progress straight away if the disk needs to spin up,
1066 otherwise show it after the normal 1/2 second delay */
1067 show_search_progress(
1068 #ifdef HAVE_DISK_STORAGE
1069 storage_disk_is_active()
1070 #else
1071 true
1072 #endif
1073 , 0);
1075 if (c->currtable == ALLSUBENTRIES)
1077 tag = tag_title;
1078 level--;
1080 else
1081 tag = csi->tagorder[level];
1083 if (!tagcache_search(&tcs, tag))
1084 return -1;
1086 /* Prevent duplicate entries in the search list. */
1087 tagcache_search_set_uniqbuf(&tcs, uniqbuf, UNIQBUF_SIZE);
1089 if (level || csi->clause_count[0] || TAGCACHE_IS_NUMERIC(tag))
1090 sort = true;
1092 for (i = 0; i < level; i++)
1094 if (TAGCACHE_IS_NUMERIC(csi->tagorder[i]))
1096 static struct tagcache_search_clause cc;
1098 memset(&cc, 0, sizeof(struct tagcache_search_clause));
1099 cc.tag = csi->tagorder[i];
1100 cc.type = clause_is;
1101 cc.numeric = true;
1102 cc.numeric_data = csi->result_seek[i];
1103 tagcache_search_add_clause(&tcs, &cc);
1105 else
1107 tagcache_search_add_filter(&tcs, csi->tagorder[i],
1108 csi->result_seek[i]);
1112 for (i = 0; i <= level; i++)
1114 int j;
1116 for (j = 0; j < csi->clause_count[i]; j++)
1117 tagcache_search_add_clause(&tcs, csi->clause[i][j]);
1120 current_offset = offset;
1121 current_entry_count = 0;
1122 c->dirfull = false;
1124 fmt = NULL;
1125 for (i = 0; i < format_count; i++)
1127 if (formats[i]->group_id == csi->format_id[level])
1128 fmt = formats[i];
1131 if (fmt)
1133 sort_inverse = fmt->sort_inverse;
1134 sort_limit = fmt->limit;
1135 strip = fmt->strip;
1136 sort = true;
1138 else
1140 sort_inverse = false;
1141 sort_limit = 0;
1142 strip = 0;
1145 if (tag != tag_title && tag != tag_filename)
1147 if (offset == 0)
1149 dptr->newtable = ALLSUBENTRIES;
1150 dptr->name = str(LANG_TAGNAVI_ALL_TRACKS);
1151 dptr++;
1152 current_entry_count++;
1154 if (offset <= 1)
1156 dptr->newtable = NAVIBROWSE;
1157 dptr->name = str(LANG_TAGNAVI_RANDOM);
1158 dptr->extraseek = -1;
1159 dptr++;
1160 current_entry_count++;
1162 special_entry_count+=2;
1165 total_count += special_entry_count;
1167 while (tagcache_get_next(&tcs))
1169 if (total_count++ < offset)
1170 continue;
1172 dptr->newtable = NAVIBROWSE;
1173 if (tag == tag_title || tag == tag_filename)
1175 dptr->newtable = PLAYTRACK;
1176 dptr->extraseek = tcs.idx_id;
1178 else
1179 dptr->extraseek = tcs.result_seek;
1181 fmt = NULL;
1182 /* Check the format */
1183 for (i = 0; i < format_count; i++)
1185 if (formats[i]->group_id != csi->format_id[level])
1186 continue;
1188 if (tagcache_check_clauses(&tcs, formats[i]->clause,
1189 formats[i]->clause_count))
1191 fmt = formats[i];
1192 break;
1196 if (!tcs.ramresult || fmt)
1198 char buf[MAX_PATH];
1200 if (fmt)
1202 if (format_str(&tcs, fmt, buf, sizeof buf) < 0)
1204 logf("format_str() failed");
1205 tagcache_search_finish(&tcs);
1206 return 0;
1210 dptr->name = &c->name_buffer[namebufused];
1211 if (fmt)
1212 namebufused += strlen(buf)+1;
1213 else
1214 namebufused += tcs.result_len;
1216 if (namebufused >= c->name_buffer_size)
1218 logf("chunk mode #2: %d", current_entry_count);
1219 c->dirfull = true;
1220 sort = false;
1221 break ;
1223 if (fmt)
1224 strcpy(dptr->name, buf);
1225 else
1226 strcpy(dptr->name, tcs.result);
1228 else
1229 dptr->name = tcs.result;
1231 dptr++;
1232 current_entry_count++;
1234 if (current_entry_count >= global_settings.max_files_in_dir)
1236 logf("chunk mode #3: %d", current_entry_count);
1237 c->dirfull = true;
1238 sort = false;
1239 break ;
1242 if (init && !tcs.ramsearch)
1244 if (!show_search_progress(false, total_count))
1245 { /* user aborted */
1246 tagcache_search_finish(&tcs);
1247 return current_entry_count;
1252 if (sort)
1253 qsort(c->dircache + special_entry_count * c->dentry_size,
1254 current_entry_count - special_entry_count,
1255 c->dentry_size, compare);
1257 if (!init)
1259 tagcache_search_finish(&tcs);
1260 return current_entry_count;
1263 while (tagcache_get_next(&tcs))
1265 if (!tcs.ramsearch)
1267 if (!show_search_progress(false, total_count))
1268 break;
1270 total_count++;
1273 tagcache_search_finish(&tcs);
1275 if (!sort && (sort_inverse || sort_limit))
1277 splashf(HZ*4, ID2P(LANG_SHOWDIR_BUFFER_FULL), total_count);
1278 logf("Too small dir buffer");
1279 return 0;
1282 if (sort_limit)
1283 total_count = MIN(total_count, sort_limit);
1285 if (strip)
1287 dptr = c->dircache;
1288 for (i = 0; i < total_count; i++, dptr++)
1290 int len = strlen(dptr->name);
1292 if (len < strip)
1293 continue;
1295 dptr->name = &dptr->name[strip];
1299 return total_count;
1303 static int load_root(struct tree_context *c)
1305 struct tagentry *dptr = (struct tagentry *)c->dircache;
1306 int i;
1308 tc = c;
1309 c->currtable = ROOT;
1310 if (c->dirlevel == 0)
1311 c->currextra = rootmenu;
1313 menu = menus[c->currextra];
1314 if (menu == NULL)
1315 return 0;
1317 for (i = 0; i < menu->itemcount; i++)
1319 dptr->name = menu->items[i]->name;
1320 switch (menu->items[i]->type)
1322 case menu_next:
1323 dptr->newtable = NAVIBROWSE;
1324 dptr->extraseek = i;
1325 break;
1327 case menu_load:
1328 dptr->newtable = ROOT;
1329 dptr->extraseek = menu->items[i]->link;
1330 break;
1333 dptr++;
1336 current_offset = 0;
1337 current_entry_count = i;
1339 return i;
1342 int tagtree_load(struct tree_context* c)
1344 int count;
1345 int table = c->currtable;
1347 c->dentry_size = sizeof(struct tagentry);
1348 c->dirsindir = 0;
1350 if (!table)
1352 c->dirfull = false;
1353 table = ROOT;
1354 c->currtable = table;
1355 c->currextra = rootmenu;
1358 switch (table)
1360 case ROOT:
1361 count = load_root(c);
1362 break;
1364 case ALLSUBENTRIES:
1365 case NAVIBROWSE:
1366 logf("navibrowse...");
1367 cpu_boost(true);
1368 count = retrieve_entries(c, 0, true);
1369 cpu_boost(false);
1370 break;
1372 default:
1373 logf("Unsupported table %d\n", table);
1374 return -1;
1377 if (count < 0)
1379 c->dirlevel = 0;
1380 count = load_root(c);
1381 splash(HZ, str(LANG_TAGCACHE_BUSY));
1384 /* The _total_ numer of entries available. */
1385 c->dirlength = c->filesindir = count;
1387 return count;
1390 int tagtree_enter(struct tree_context* c)
1392 int rc = 0;
1393 struct tagentry *dptr;
1394 struct mp3entry *id3;
1395 int newextra;
1396 int seek;
1397 int source;
1399 dptr = tagtree_get_entry(c, c->selected_item);
1401 c->dirfull = false;
1402 seek = dptr->extraseek;
1403 if (seek == -1)
1405 if(c->filesindir<=2)
1406 return 0;
1407 srand(current_tick);
1408 dptr = (tagtree_get_entry(c, 2+(rand() % (c->filesindir-2))));
1409 seek = dptr->extraseek;
1411 newextra = dptr->newtable;
1413 if (c->dirlevel >= MAX_DIR_LEVELS)
1414 return 0;
1416 c->selected_item_history[c->dirlevel]=c->selected_item;
1417 c->table_history[c->dirlevel] = c->currtable;
1418 c->extra_history[c->dirlevel] = c->currextra;
1419 c->pos_history[c->dirlevel] = c->firstpos;
1420 c->dirlevel++;
1422 switch (c->currtable) {
1423 case ROOT:
1424 c->currextra = newextra;
1426 if (newextra == ROOT)
1428 menu = menus[seek];
1429 c->currextra = seek;
1432 else if (newextra == NAVIBROWSE)
1434 int i, j;
1436 csi = menu->items[seek]->si;
1437 c->currextra = 0;
1439 strlcpy(current_title[c->currextra], dptr->name,
1440 sizeof(current_title[0]));
1442 /* Read input as necessary. */
1443 for (i = 0; i < csi->tagorder_count; i++)
1445 for (j = 0; j < csi->clause_count[i]; j++)
1447 char* searchstring;
1448 source = csi->clause[i][j]->source;
1450 if (source == source_constant)
1451 continue;
1453 searchstring=csi->clause[i][j]->str;
1454 *searchstring = '\0';
1456 id3 = audio_current_track();
1458 if (source == source_current_path && id3)
1460 char *e;
1461 strlcpy(searchstring, id3->path, SEARCHSTR_SIZE);
1462 e = strrchr(searchstring, '/');
1463 if (e)
1464 *e = '\0';
1466 else if (source > source_runtime && id3)
1469 int k = source-source_runtime;
1470 int offset = id3_to_search_mapping[k].id3_offset;
1471 char **src = (char**)((char*)id3 + offset);
1472 if (*src)
1474 strlcpy(searchstring, *src, SEARCHSTR_SIZE);
1477 else
1479 rc = kbd_input(searchstring, SEARCHSTR_SIZE);
1480 if (rc < 0 || !searchstring[0])
1482 tagtree_exit(c);
1483 return 0;
1485 if (csi->clause[i][j]->numeric)
1486 csi->clause[i][j]->numeric_data = atoi(searchstring);
1493 c->currtable = newextra;
1495 break;
1497 case NAVIBROWSE:
1498 case ALLSUBENTRIES:
1499 if (newextra == PLAYTRACK)
1501 if (global_settings.party_mode && audio_status()) {
1502 splash(HZ, ID2P(LANG_PARTY_MODE));
1503 break;
1505 c->dirlevel--;
1506 /* about to create a new current playlist...
1507 allow user to cancel the operation */
1508 if (!warn_on_pl_erase())
1509 break;
1510 if (tagtree_play_folder(c) >= 0)
1511 rc = 2;
1512 break;
1515 c->currtable = newextra;
1516 csi->result_seek[c->currextra] = seek;
1517 if (c->currextra < csi->tagorder_count-1)
1518 c->currextra++;
1519 else
1520 c->dirlevel--;
1522 /* Update the statusbar title */
1523 strlcpy(current_title[c->currextra], dptr->name,
1524 sizeof(current_title[0]));
1525 break;
1527 default:
1528 c->dirlevel--;
1529 break;
1532 c->selected_item=0;
1533 gui_synclist_select_item(&tree_lists, c->selected_item);
1535 return rc;
1538 void tagtree_exit(struct tree_context* c)
1540 c->dirfull = false;
1541 if (c->dirlevel > 0)
1542 c->dirlevel--;
1543 c->selected_item=c->selected_item_history[c->dirlevel];
1544 gui_synclist_select_item(&tree_lists, c->selected_item);
1545 c->currtable = c->table_history[c->dirlevel];
1546 c->currextra = c->extra_history[c->dirlevel];
1547 c->firstpos = c->pos_history[c->dirlevel];
1550 int tagtree_get_filename(struct tree_context* c, char *buf, int buflen)
1552 struct tagcache_search tcs;
1553 struct tagentry *entry;
1555 entry = tagtree_get_entry(c, c->selected_item);
1557 if (!tagcache_search(&tcs, tag_filename))
1558 return -1;
1560 if (!tagcache_retrieve(&tcs, entry->extraseek, tcs.type, buf, buflen))
1562 tagcache_search_finish(&tcs);
1563 return -2;
1566 tagcache_search_finish(&tcs);
1568 return 0;
1571 static bool insert_all_playlist(struct tree_context *c, int position, bool queue)
1573 struct tagcache_search tcs;
1574 int i;
1575 char buf[MAX_PATH];
1576 int from, to, direction;
1577 int files_left = c->filesindir;
1579 cpu_boost(true);
1580 if (!tagcache_search(&tcs, tag_filename))
1582 splash(HZ, ID2P(LANG_TAGCACHE_BUSY));
1583 cpu_boost(false);
1584 return false;
1587 if (position == PLAYLIST_REPLACE)
1589 if (playlist_remove_all_tracks(NULL) == 0)
1590 position = PLAYLIST_INSERT_LAST;
1591 else
1593 cpu_boost(false);
1594 return false;
1598 if (position == PLAYLIST_INSERT_FIRST)
1600 from = c->filesindir - 1;
1601 to = -1;
1602 direction = -1;
1604 else
1606 from = 0;
1607 to = c->filesindir;
1608 direction = 1;
1611 for (i = from; i != to; i += direction)
1613 /* Count back to zero */
1614 if (!show_search_progress(false, files_left--))
1615 break;
1617 if (!tagcache_retrieve(&tcs, tagtree_get_entry(c, i)->extraseek,
1618 tcs.type, buf, sizeof buf))
1620 continue;
1623 if (playlist_insert_track(NULL, buf, position, queue, false) < 0)
1625 logf("playlist_insert_track failed");
1626 break;
1628 yield();
1630 playlist_sync(NULL);
1631 tagcache_search_finish(&tcs);
1632 cpu_boost(false);
1634 return true;
1637 bool tagtree_insert_selection_playlist(int position, bool queue)
1639 struct tagentry *dptr;
1640 char buf[MAX_PATH];
1641 int dirlevel = tc->dirlevel;
1643 show_search_progress(
1644 #ifdef HAVE_DISK_STORAGE
1645 storage_disk_is_active()
1646 #else
1647 true
1648 #endif
1649 , 0);
1652 /* We need to set the table to allsubentries. */
1653 dptr = tagtree_get_entry(tc, tc->selected_item);
1655 /* Insert a single track? */
1656 if (dptr->newtable == PLAYTRACK)
1658 if (tagtree_get_filename(tc, buf, sizeof buf) < 0)
1660 logf("tagtree_get_filename failed");
1661 return false;
1663 playlist_insert_track(NULL, buf, position, queue, true);
1665 return true;
1668 if (dptr->newtable == NAVIBROWSE)
1670 tagtree_enter(tc);
1671 tagtree_load(tc);
1672 dptr = tagtree_get_entry(tc, tc->selected_item);
1674 else if (dptr->newtable != ALLSUBENTRIES)
1676 logf("unsupported table: %d", dptr->newtable);
1677 return false;
1680 /* Now the current table should be allsubentries. */
1681 if (dptr->newtable != PLAYTRACK)
1683 tagtree_enter(tc);
1684 tagtree_load(tc);
1685 dptr = tagtree_get_entry(tc, tc->selected_item);
1687 /* And now the newtable should be playtrack. */
1688 if (dptr->newtable != PLAYTRACK)
1690 logf("newtable: %d !!", dptr->newtable);
1691 tc->dirlevel = dirlevel;
1692 return false;
1696 if (tc->filesindir <= 0)
1697 splash(HZ, ID2P(LANG_END_PLAYLIST));
1698 else
1700 logf("insert_all_playlist");
1701 if (!insert_all_playlist(tc, position, queue))
1702 splash(HZ*2, ID2P(LANG_FAILED));
1705 /* Finally return the dirlevel to its original value. */
1706 while (tc->dirlevel > dirlevel)
1707 tagtree_exit(tc);
1708 tagtree_load(tc);
1710 return true;
1713 static int tagtree_play_folder(struct tree_context* c)
1715 if (playlist_create(NULL, NULL) < 0)
1717 logf("Failed creating playlist\n");
1718 return -1;
1721 if (!insert_all_playlist(c, PLAYLIST_INSERT_LAST, false))
1722 return -2;
1724 if (global_settings.playlist_shuffle)
1725 c->selected_item = playlist_shuffle(current_tick, c->selected_item);
1726 if (!global_settings.play_selected)
1727 c->selected_item = 0;
1728 gui_synclist_select_item(&tree_lists, c->selected_item);
1730 playlist_start(c->selected_item,0);
1731 playlist_get_current()->num_inserted_tracks = 0; /* make warn on playlist erase work */
1732 return 0;
1735 struct tagentry* tagtree_get_entry(struct tree_context *c, int id)
1737 struct tagentry *entry = (struct tagentry *)c->dircache;
1738 int realid = id - current_offset;
1740 /* Load the next chunk if necessary. */
1741 if (realid >= current_entry_count || realid < 0)
1743 cpu_boost(true);
1744 if (retrieve_entries(c, MAX(0, id - (current_entry_count / 2)),
1745 false) < 0)
1747 logf("retrieve failed");
1748 cpu_boost(false);
1749 return NULL;
1751 realid = id - current_offset;
1752 cpu_boost(false);
1755 return &entry[realid];
1758 char *tagtree_get_title(struct tree_context* c)
1760 switch (c->currtable)
1762 case ROOT:
1763 return menu->title;
1765 case NAVIBROWSE:
1766 case ALLSUBENTRIES:
1767 return current_title[c->currextra];
1770 return "?";
1773 int tagtree_get_attr(struct tree_context* c)
1775 int attr = -1;
1776 switch (c->currtable)
1778 case NAVIBROWSE:
1779 if (csi->tagorder[c->currextra] == tag_title)
1780 attr = FILE_ATTR_AUDIO;
1781 else
1782 attr = ATTR_DIRECTORY;
1783 break;
1785 case ALLSUBENTRIES:
1786 attr = FILE_ATTR_AUDIO;
1787 break;
1789 default:
1790 attr = ATTR_DIRECTORY;
1791 break;
1794 return attr;
1797 int tagtree_get_icon(struct tree_context* c)
1799 int icon = Icon_Folder;
1801 if (tagtree_get_attr(c) == FILE_ATTR_AUDIO)
1802 icon = Icon_Audio;
1804 return icon;