Oops. On a roll...that shouldn't have been committed.
[Rockbox.git] / apps / tagtree.c
blob0163ddbb2ff6d39e9709a487694836b9a805bed7
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2005 by Miika Pekkarinen
12 * All files in this archive are subject to the GNU General Public License.
13 * See the file COPYING in the source tree root for full license agreement.
15 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
16 * KIND, either express or implied.
18 ****************************************************************************/
20 /**
21 * Basic structure on this file was copied from dbtree.c and modified to
22 * support the tag cache interface.
24 #include <stdio.h>
25 #include <string.h>
26 #include <stdlib.h>
27 #include "config.h"
28 #include "system.h"
29 #include "kernel.h"
30 #include "splash.h"
31 #include "icons.h"
32 #include "tree.h"
33 #include "action.h"
34 #include "settings.h"
35 #include "tagcache.h"
36 #include "tagtree.h"
37 #include "lang.h"
38 #include "logf.h"
39 #include "playlist.h"
40 #include "keyboard.h"
41 #include "gui/list.h"
42 #include "buffer.h"
43 #include "atoi.h"
44 #include "playback.h"
45 #include "yesno.h"
46 #include "misc.h"
47 #include "filetypes.h"
48 #include "audio.h"
50 #define FILE_SEARCH_INSTRUCTIONS ROCKBOX_DIR "/tagnavi.config"
52 static int tagtree_play_folder(struct tree_context* c);
54 #define SEARCHSTR_SIZE 256
56 static const struct id3_to_search_mapping {
57 char *string;
58 size_t id3_offset;
59 } id3_to_search_mapping[] = {
60 { "", 0 }, /* offset n/a */
61 { "#directory#", 0 }, /* offset n/a */
62 { "#title#", offsetof(struct mp3entry, title) },
63 { "#artist#", offsetof(struct mp3entry, artist) },
64 { "#album#", offsetof(struct mp3entry, album) },
65 { "#genre#", offsetof(struct mp3entry, genre_string) },
66 { "#composer#", offsetof(struct mp3entry, composer) },
67 { "#albumartist#", offsetof(struct mp3entry, albumartist) },
69 enum variables {
70 var_sorttype = 100,
71 var_limit,
72 var_strip,
73 var_menu_start,
74 var_include,
75 var_rootmenu,
76 var_format,
77 menu_next,
78 menu_load,
81 /* Capacity 10 000 entries (for example 10k different artists) */
82 #define UNIQBUF_SIZE (64*1024)
83 static long *uniqbuf;
85 #define MAX_TAGS 5
86 #define MAX_MENU_ID_SIZE 32
88 static struct tagcache_search tcs, tcs2;
89 static bool sort_inverse;
92 * "%3d. %s" autoscore title %sort = "inverse" %limit = "100"
94 * valid = true
95 * formatstr = "%-3d. %s"
96 * tags[0] = tag_autoscore
97 * tags[1] = tag_title
98 * tag_count = 2
100 * limit = 100
101 * sort_inverse = true
103 struct display_format {
104 char name[32];
105 struct tagcache_search_clause *clause[TAGCACHE_MAX_CLAUSES];
106 int clause_count;
107 char *formatstr;
108 int group_id;
109 int tags[MAX_TAGS];
110 int tag_count;
112 int limit;
113 int strip;
114 bool sort_inverse;
115 bool sort;
118 static struct display_format *formats[TAGMENU_MAX_FMTS];
119 static int format_count;
121 struct search_instruction {
122 char name[64];
123 int tagorder[MAX_TAGS];
124 int tagorder_count;
125 struct tagcache_search_clause *clause[MAX_TAGS][TAGCACHE_MAX_CLAUSES];
126 int format_id[MAX_TAGS];
127 int clause_count[MAX_TAGS];
128 int result_seek[MAX_TAGS];
131 struct menu_entry {
132 char name[64];
133 int type;
134 struct search_instruction *si;
135 int link;
138 struct root_menu {
139 char title[64];
140 char id[MAX_MENU_ID_SIZE];
141 int itemcount;
142 struct menu_entry *items[TAGMENU_MAX_ITEMS];
145 /* Statusbar text of the current view. */
146 static char current_title[MAX_TAGS][128];
148 static struct root_menu *menus[TAGMENU_MAX_MENUS];
149 static struct root_menu *menu;
150 static struct search_instruction *csi;
151 static const char *strp;
152 static int menu_count;
153 static int root_menu;
155 static int current_offset;
156 static int current_entry_count;
158 static int format_count;
159 static struct tree_context *tc;
161 static int get_token_str(char *buf, int size)
163 /* Find the start. */
164 while (*strp != '"' && *strp != '\0')
165 strp++;
167 if (*strp == '\0' || *(++strp) == '\0')
168 return -1;
170 /* Read the data. */
171 while (*strp != '"' && *strp != '\0' && --size > 0)
172 *(buf++) = *(strp++);
174 *buf = '\0';
175 if (*strp != '"')
176 return -2;
178 strp++;
180 return 0;
183 #define MATCH(tag,str1,str2,settag) \
184 if (!strcasecmp(str1, str2)) { \
185 *tag = settag; \
186 return 1; \
189 static int get_tag(int *tag)
191 char buf[128];
192 int i;
194 /* Find the start. */
195 while ((*strp == ' ' || *strp == '>') && *strp != '\0')
196 strp++;
198 if (*strp == '\0' || *strp == '?')
199 return 0;
201 for (i = 0; i < (int)sizeof(buf)-1; i++)
203 if (*strp == '\0' || *strp == ' ')
204 break ;
205 buf[i] = *strp;
206 strp++;
208 buf[i] = '\0';
210 MATCH(tag, buf, "album", tag_album);
211 MATCH(tag, buf, "artist", tag_artist);
212 MATCH(tag, buf, "bitrate", tag_bitrate);
213 MATCH(tag, buf, "composer", tag_composer);
214 MATCH(tag, buf, "comment", tag_comment);
215 MATCH(tag, buf, "albumartist", tag_albumartist);
216 MATCH(tag, buf, "ensemble", tag_albumartist);
217 MATCH(tag, buf, "grouping", tag_grouping);
218 MATCH(tag, buf, "genre", tag_genre);
219 MATCH(tag, buf, "length", tag_length);
220 MATCH(tag, buf, "Lm", tag_virt_length_min);
221 MATCH(tag, buf, "Ls", tag_virt_length_sec);
222 MATCH(tag, buf, "Pm", tag_virt_playtime_min);
223 MATCH(tag, buf, "Ps", tag_virt_playtime_sec);
224 MATCH(tag, buf, "title", tag_title);
225 MATCH(tag, buf, "filename", tag_filename);
226 MATCH(tag, buf, "tracknum", tag_tracknumber);
227 MATCH(tag, buf, "discnum", tag_discnumber);
228 MATCH(tag, buf, "year", tag_year);
229 MATCH(tag, buf, "playcount", tag_playcount);
230 MATCH(tag, buf, "rating", tag_rating);
231 MATCH(tag, buf, "lastplayed", tag_lastplayed);
232 MATCH(tag, buf, "commitid", tag_commitid);
233 MATCH(tag, buf, "entryage", tag_virt_entryage);
234 MATCH(tag, buf, "autoscore", tag_virt_autoscore);
235 MATCH(tag, buf, "%sort", var_sorttype);
236 MATCH(tag, buf, "%limit", var_limit);
237 MATCH(tag, buf, "%strip", var_strip);
238 MATCH(tag, buf, "%menu_start", var_menu_start);
239 MATCH(tag, buf, "%include", var_include);
240 MATCH(tag, buf, "%root_menu", var_rootmenu);
241 MATCH(tag, buf, "%format", var_format);
242 MATCH(tag, buf, "->", menu_next);
243 MATCH(tag, buf, "==>", menu_load);
245 logf("NO MATCH: %s\n", buf);
246 if (buf[0] == '?')
247 return 0;
249 return -1;
252 static int get_clause(int *condition)
254 char buf[4];
255 int i;
257 /* Find the start. */
258 while (*strp == ' ' && *strp != '\0')
259 strp++;
261 if (*strp == '\0')
262 return 0;
264 for (i = 0; i < (int)sizeof(buf)-1; i++)
266 if (*strp == '\0' || *strp == ' ')
267 break ;
268 buf[i] = *strp;
269 strp++;
271 buf[i] = '\0';
273 MATCH(condition, buf, "=", clause_is);
274 MATCH(condition, buf, "==", clause_is);
275 MATCH(condition, buf, "!=", clause_is_not);
276 MATCH(condition, buf, ">", clause_gt);
277 MATCH(condition, buf, ">=", clause_gteq);
278 MATCH(condition, buf, "<", clause_lt);
279 MATCH(condition, buf, "<=", clause_lteq);
280 MATCH(condition, buf, "~", clause_contains);
281 MATCH(condition, buf, "!~", clause_not_contains);
282 MATCH(condition, buf, "^", clause_begins_with);
283 MATCH(condition, buf, "!^", clause_not_begins_with);
284 MATCH(condition, buf, "$", clause_ends_with);
285 MATCH(condition, buf, "!$", clause_not_ends_with);
286 MATCH(condition, buf, "@", clause_oneof);
288 return 0;
291 static bool read_clause(struct tagcache_search_clause *clause)
293 char buf[SEARCHSTR_SIZE];
294 unsigned int i;
296 if (get_tag(&clause->tag) <= 0)
297 return false;
299 if (get_clause(&clause->type) <= 0)
300 return false;
302 if (get_token_str(buf, sizeof buf) < 0)
303 return false;
305 for (i=0; i<ARRAYLEN(id3_to_search_mapping); i++)
307 if (!strcasecmp(buf, id3_to_search_mapping[i].string))
308 break;
311 if (i<ARRAYLEN(id3_to_search_mapping)) /* runtime search operand found */
313 clause->source = source_runtime+i;
314 clause->str = buffer_alloc(SEARCHSTR_SIZE);
316 else
318 clause->source = source_constant;
319 clause->str = buffer_alloc(strlen(buf)+1);
320 strcpy(clause->str, buf);
323 if (tagcache_is_numeric_tag(clause->tag))
325 clause->numeric = true;
326 clause->numeric_data = atoi(clause->str);
328 else
329 clause->numeric = false;
331 logf("got clause: %d/%d [%s]", clause->tag, clause->type, clause->str);
333 return true;
336 static bool read_variable(char *buf, int size)
338 int condition;
340 if (!get_clause(&condition))
341 return false;
343 if (condition != clause_is)
344 return false;
346 if (get_token_str(buf, size) < 0)
347 return false;
349 return true;
352 /* "%3d. %s" autoscore title %sort = "inverse" %limit = "100" */
353 static int get_format_str(struct display_format *fmt)
355 int ret;
356 char buf[128];
357 int i;
359 memset(fmt, 0, sizeof(struct display_format));
361 if (get_token_str(fmt->name, sizeof fmt->name) < 0)
362 return -10;
364 /* Determine the group id */
365 fmt->group_id = 0;
366 for (i = 0; i < format_count; i++)
368 if (!strcasecmp(formats[i]->name, fmt->name))
370 fmt->group_id = formats[i]->group_id;
371 break;
374 if (formats[i]->group_id > fmt->group_id)
375 fmt->group_id = formats[i]->group_id;
378 if (i == format_count)
379 fmt->group_id++;
381 logf("format: (%d) %s", fmt->group_id, fmt->name);
383 if (get_token_str(buf, sizeof buf) < 0)
384 return -10;
386 fmt->formatstr = buffer_alloc(strlen(buf) + 1);
387 strcpy(fmt->formatstr, buf);
389 while (fmt->tag_count < MAX_TAGS)
391 ret = get_tag(&fmt->tags[fmt->tag_count]);
392 if (ret < 0)
393 return -11;
395 if (ret == 0)
396 break;
398 switch (fmt->tags[fmt->tag_count]) {
399 case var_sorttype:
400 if (!read_variable(buf, sizeof buf))
401 return -12;
402 if (!strcasecmp("inverse", buf))
403 fmt->sort_inverse = true;
405 fmt->sort = true;
406 break;
408 case var_limit:
409 if (!read_variable(buf, sizeof buf))
410 return -13;
411 fmt->limit = atoi(buf);
412 break;
414 case var_strip:
415 if (!read_variable(buf, sizeof buf))
416 return -14;
417 fmt->strip = atoi(buf);
418 break;
420 default:
421 fmt->tag_count++;
425 return 1;
428 static int add_format(const char *buf)
430 strp = buf;
432 if (formats[format_count] == NULL)
433 formats[format_count] = buffer_alloc(sizeof(struct display_format));
435 memset(formats[format_count], 0, sizeof(struct display_format));
436 if (get_format_str(formats[format_count]) < 0)
438 logf("get_format_str() parser failed!");
439 return -4;
442 while (*strp != '\0' && *strp != '?')
443 strp++;
445 if (*strp == '?')
447 int clause_count = 0;
448 strp++;
450 while (1)
452 if (clause_count >= TAGCACHE_MAX_CLAUSES)
454 logf("too many clauses");
455 break;
458 formats[format_count]->clause[clause_count] =
459 buffer_alloc(sizeof(struct tagcache_search_clause));
461 if (!read_clause(formats[format_count]->clause[clause_count]))
462 break;
464 clause_count++;
467 formats[format_count]->clause_count = clause_count;
470 format_count++;
472 return 1;
475 static int get_condition(struct search_instruction *inst)
477 int clause_count;
478 char buf[128];
480 switch (*strp)
482 case '=':
484 int i;
486 if (get_token_str(buf, sizeof buf) < 0)
487 return -1;
489 for (i = 0; i < format_count; i++)
491 if (!strcasecmp(formats[i]->name, buf))
492 break;
495 if (i == format_count)
497 logf("format not found: %s", buf);
498 return -2;
501 inst->format_id[inst->tagorder_count] = formats[i]->group_id;
502 return 1;
504 case '?':
505 case ' ':
506 case '&':
507 strp++;
508 return 1;
509 case '-':
510 case '\0':
511 return 0;
514 clause_count = inst->clause_count[inst->tagorder_count];
515 if (clause_count >= TAGCACHE_MAX_CLAUSES)
517 logf("Too many clauses");
518 return false;
521 inst->clause[inst->tagorder_count][clause_count] =
522 buffer_alloc(sizeof(struct tagcache_search_clause));
524 if (!read_clause(inst->clause[inst->tagorder_count][clause_count]))
525 return -1;
527 inst->clause_count[inst->tagorder_count]++;
529 return 1;
532 /* example search:
533 * "Best" artist ? year >= "2000" & title !^ "crap" & genre = "good genre" \
534 * : album ? year >= "2000" : songs
535 * ^ begins with
536 * * contains
537 * $ ends with
540 static bool parse_search(struct menu_entry *entry, const char *str)
542 int ret;
543 int type;
544 struct search_instruction *inst = entry->si;
545 char buf[MAX_PATH];
546 int i;
547 struct root_menu *new_menu;
549 strp = str;
551 /* Parse entry name */
552 if (get_token_str(entry->name, sizeof entry->name) < 0)
554 logf("No name found.");
555 return false;
558 /* Parse entry type */
559 if (get_tag(&entry->type) <= 0)
560 return false;
562 if (entry->type == menu_load)
564 if (get_token_str(buf, sizeof buf) < 0)
565 return false;
567 /* Find the matching root menu or "create" it */
568 for (i = 0; i < menu_count; i++)
570 if (!strcasecmp(menus[i]->id, buf))
572 entry->link = i;
573 return true;
577 if (menu_count >= TAGMENU_MAX_MENUS)
579 logf("max menucount reached");
580 return false;
583 /* Allocate a new menu unless link is found. */
584 menus[menu_count] = buffer_alloc(sizeof(struct root_menu));
585 new_menu = menus[menu_count];
586 memset(new_menu, 0, sizeof(struct root_menu));
587 strncpy(new_menu->id, buf, MAX_MENU_ID_SIZE-1);
588 entry->link = menu_count;
589 ++menu_count;
591 return true;
594 if (entry->type != menu_next)
595 return false;
597 while (inst->tagorder_count < MAX_TAGS)
599 ret = get_tag(&inst->tagorder[inst->tagorder_count]);
600 if (ret < 0)
602 logf("Parse error #1");
603 logf("%s", strp);
604 return false;
607 if (ret == 0)
608 break ;
610 logf("tag: %d", inst->tagorder[inst->tagorder_count]);
612 while ( (ret = get_condition(inst)) > 0 ) ;
613 if (ret < 0)
614 return false;
616 inst->tagorder_count++;
618 if (get_tag(&type) <= 0 || type != menu_next)
619 break;
622 return true;
625 static int compare(const void *p1, const void *p2)
627 struct tagentry *e1 = (struct tagentry *)p1;
628 struct tagentry *e2 = (struct tagentry *)p2;
630 if (sort_inverse)
631 return strncasecmp(e2->name, e1->name, MAX_PATH);
633 return strncasecmp(e1->name, e2->name, MAX_PATH);
636 static void tagtree_buffer_event(struct mp3entry *id3)
638 /* Do not gather data unless proper setting has been enabled. */
639 if (!global_settings.runtimedb)
640 return;
642 logf("be:%s", id3->path);
644 if (!tagcache_find_index(&tcs, id3->path))
646 logf("tc stat: not found: %s", id3->path);
647 return;
650 id3->playcount = tagcache_get_numeric(&tcs, tag_playcount);
651 if (!id3->rating)
652 id3->rating = tagcache_get_numeric(&tcs, tag_rating);
653 id3->lastplayed = tagcache_get_numeric(&tcs, tag_lastplayed);
654 id3->score = tagcache_get_numeric(&tcs, tag_virt_autoscore) / 10;
655 id3->playtime = tagcache_get_numeric(&tcs, tag_playtime);
657 /* Store our tagcache index pointer. */
658 id3->tagcache_idx = tcs.idx_id;
660 tagcache_search_finish(&tcs);
663 static void tagtree_unbuffer_event(struct mp3entry *id3)
665 long playcount;
666 long playtime;
667 long lastplayed;
669 /* Do not gather data unless proper setting has been enabled. */
670 if (!global_settings.runtimedb)
672 logf("runtimedb gathering not enabled");
673 return;
676 if (!id3->tagcache_idx)
678 logf("No tagcache index pointer found");
679 return;
682 /* Don't process unplayed tracks. */
683 if (id3->elapsed == 0)
685 logf("not logging unplayed track");
686 return;
689 playcount = id3->playcount + 1;
690 lastplayed = tagcache_increase_serial();
691 if (lastplayed < 0)
693 logf("incorrect tc serial:%ld", lastplayed);
694 return;
697 /* Ignore the last 15s (crossfade etc.) */
698 playtime = id3->playtime + MIN(id3->length, id3->elapsed + 15 * 1000);
700 logf("ube:%s", id3->path);
701 logf("-> %ld/%ld", playcount, playtime);
702 logf("-> %ld/%ld/%ld", id3->elapsed, id3->length, MIN(id3->length, id3->elapsed + 15 * 1000));
704 /* Queue the updates to the tagcache system. */
705 tagcache_update_numeric(id3->tagcache_idx, tag_playcount, playcount);
706 tagcache_update_numeric(id3->tagcache_idx, tag_playtime, playtime);
707 tagcache_update_numeric(id3->tagcache_idx, tag_lastplayed, lastplayed);
710 bool tagtree_export(void)
712 gui_syncsplash(0, str(LANG_CREATING));
713 if (!tagcache_create_changelog(&tcs))
715 gui_syncsplash(HZ*2, ID2P(LANG_FAILED));
718 return false;
721 bool tagtree_import(void)
723 gui_syncsplash(0, ID2P(LANG_WAIT));
724 if (!tagcache_import_changelog())
726 gui_syncsplash(HZ*2, ID2P(LANG_FAILED));
729 return false;
732 static bool parse_menu(const char *filename);
734 static int parse_line(int n, const char *buf, void *parameters)
736 char data[256];
737 int variable;
738 static bool read_menu;
739 int i;
741 (void)parameters;
743 logf("parse:%d/%s", n, buf);
745 /* First line, do initialisation. */
746 if (n == 0)
748 if (strcasecmp(TAGNAVI_VERSION, buf))
750 logf("Version mismatch");
751 return -1;
754 read_menu = false;
757 if (buf[0] == '#')
758 return 0;
760 if (buf[0] == '\0')
762 if (read_menu)
764 /* End the menu */
765 read_menu = false;
767 return 0;
770 if (!read_menu)
772 strp = buf;
773 if (get_tag(&variable) <= 0)
774 return 0;
776 switch (variable)
778 case var_format:
779 if (add_format(strp) < 0)
781 logf("Format add fail: %s", data);
783 break;
785 case var_include:
786 if (get_token_str(data, sizeof(data)) < 0)
788 logf("%%include empty");
789 return 0;
792 if (!parse_menu(data))
794 logf("Load menu fail: %s", data);
796 break;
798 case var_menu_start:
799 if (menu_count >= TAGMENU_MAX_MENUS)
801 logf("max menucount reached");
802 return 0;
805 if (get_token_str(data, sizeof data) < 0)
807 logf("%%menu_start id empty");
808 return 0;
811 menu = NULL;
812 for (i = 0; i < menu_count; i++)
814 if (!strcasecmp(menus[i]->id, data))
816 menu = menus[i];
820 if (menu == NULL)
822 menus[menu_count] = buffer_alloc(sizeof(struct root_menu));
823 menu = menus[menu_count];
824 ++menu_count;
825 memset(menu, 0, sizeof(struct root_menu));
826 strncpy(menu->id, data, MAX_MENU_ID_SIZE-1);
829 if (get_token_str(menu->title, sizeof(menu->title)) < 0)
831 logf("%%menu_start title empty");
832 return 0;
834 logf("menu: %s", menu->title);
835 read_menu = true;
836 break;
838 case var_rootmenu:
839 /* Only set root menu once. */
840 if (root_menu >= 0)
841 break;
843 if (get_token_str(data, sizeof(data)) < 0)
845 logf("%%root_menu empty");
846 return 0;
849 for (i = 0; i < menu_count; i++)
851 if (!strcasecmp(menus[i]->id, data))
853 root_menu = i;
856 break;
859 return 0;
862 if (menu->itemcount >= TAGMENU_MAX_ITEMS)
864 logf("max itemcount reached");
865 return 0;
868 /* Allocate */
869 if (menu->items[menu->itemcount] == NULL)
871 menu->items[menu->itemcount] = buffer_alloc(sizeof(struct menu_entry));
872 memset(menu->items[menu->itemcount], 0, sizeof(struct menu_entry));
873 menu->items[menu->itemcount]->si = buffer_alloc(sizeof(struct search_instruction));
876 memset(menu->items[menu->itemcount]->si, 0, sizeof(struct search_instruction));
877 if (!parse_search(menu->items[menu->itemcount], buf))
878 return 0;
880 menu->itemcount++;
882 return 0;
885 static bool parse_menu(const char *filename)
887 int fd;
888 char buf[1024];
890 if (menu_count >= TAGMENU_MAX_MENUS)
892 logf("max menucount reached");
893 return false;
896 fd = open(filename, O_RDONLY);
897 if (fd < 0)
899 logf("Search instruction file not found.");
900 return false;
903 /* Now read file for real, parsing into si */
904 fast_readline(fd, buf, sizeof buf, NULL, parse_line);
905 close(fd);
907 return true;
910 void tagtree_init(void)
912 format_count = 0;
913 menu_count = 0;
914 menu = NULL;
915 root_menu = -1;
916 parse_menu(FILE_SEARCH_INSTRUCTIONS);
918 /* If no root menu is set, assume it's the first single menu
919 * we have. That shouldn't normally happen. */
920 if (root_menu < 0)
921 root_menu = 0;
923 uniqbuf = buffer_alloc(UNIQBUF_SIZE);
924 audio_set_track_buffer_event(tagtree_buffer_event);
925 audio_set_track_unbuffer_event(tagtree_unbuffer_event);
928 static bool show_search_progress(bool init, int count)
930 static int last_tick = 0;
932 if (init)
934 last_tick = current_tick;
935 return true;
938 if (current_tick - last_tick > HZ/4)
940 gui_syncsplash(0, str(LANG_PLAYLIST_SEARCH_MSG), count,
941 str(LANG_OFF_ABORT));
942 if (action_userabort(TIMEOUT_NOBLOCK))
943 return false;
944 last_tick = current_tick;
945 yield();
948 return true;
951 static int format_str(struct tagcache_search *tcs, struct display_format *fmt,
952 char *buf, int buf_size)
954 char fmtbuf[8];
955 bool read_format = false;
956 int fmtbuf_pos = 0;
957 int parpos = 0;
958 int buf_pos = 0;
959 int i;
961 memset(buf, 0, buf_size);
962 for (i = 0; fmt->formatstr[i] != '\0'; i++)
964 if (fmt->formatstr[i] == '%')
966 read_format = true;
967 fmtbuf_pos = 0;
968 if (parpos >= fmt->tag_count)
970 logf("too many format tags");
971 return -1;
975 if (read_format)
977 fmtbuf[fmtbuf_pos++] = fmt->formatstr[i];
978 if (fmtbuf_pos >= buf_size)
980 logf("format parse error");
981 return -2;
984 if (fmt->formatstr[i] == 's')
986 fmtbuf[fmtbuf_pos] = '\0';
987 read_format = false;
988 if (fmt->tags[parpos] == tcs->type)
990 snprintf(&buf[buf_pos], buf_size - buf_pos, fmtbuf, tcs->result);
992 else
994 /* Need to fetch the tag data. */
995 if (!tagcache_retrieve(tcs, tcs->idx_id, fmt->tags[parpos],
996 &buf[buf_pos], buf_size - buf_pos))
998 logf("retrieve failed");
999 return -3;
1002 buf_pos += strlen(&buf[buf_pos]);
1003 parpos++;
1005 else if (fmt->formatstr[i] == 'd')
1007 fmtbuf[fmtbuf_pos] = '\0';
1008 read_format = false;
1009 snprintf(&buf[buf_pos], buf_size - buf_pos, fmtbuf,
1010 tagcache_get_numeric(tcs, fmt->tags[parpos]));
1011 buf_pos += strlen(&buf[buf_pos]);
1012 parpos++;
1014 continue;
1017 buf[buf_pos++] = fmt->formatstr[i];
1019 if (buf_pos - 1 >= buf_size)
1021 logf("buffer overflow");
1022 return -4;
1026 buf[buf_pos++] = '\0';
1028 return 0;
1031 static int retrieve_entries(struct tree_context *c, struct tagcache_search *tcs,
1032 int offset, bool init)
1034 struct tagentry *dptr = (struct tagentry *)c->dircache;
1035 struct display_format *fmt;
1036 int i;
1037 int namebufused = 0;
1038 int total_count = 0;
1039 int special_entry_count = 0;
1040 int level = c->currextra;
1041 int tag;
1042 bool sort = false;
1043 int sort_limit;
1044 int strip;
1046 if (init
1047 #ifdef HAVE_TC_RAMCACHE
1048 && !tagcache_is_ramcache()
1049 #endif
1052 show_search_progress(true, 0);
1053 gui_syncsplash(0, str(LANG_PLAYLIST_SEARCH_MSG),
1054 0, csi->name);
1057 if (c->currtable == allsubentries)
1059 tag = tag_title;
1060 level--;
1062 else
1063 tag = csi->tagorder[level];
1065 if (!tagcache_search(tcs, tag))
1066 return -1;
1068 /* Prevent duplicate entries in the search list. */
1069 tagcache_search_set_uniqbuf(tcs, uniqbuf, UNIQBUF_SIZE);
1071 if (level || csi->clause_count[0] || tagcache_is_numeric_tag(tag))
1072 sort = true;
1074 for (i = 0; i < level; i++)
1076 if (tagcache_is_numeric_tag(csi->tagorder[i]))
1078 static struct tagcache_search_clause cc;
1080 memset(&cc, 0, sizeof(struct tagcache_search_clause));
1081 cc.tag = csi->tagorder[i];
1082 cc.type = clause_is;
1083 cc.numeric = true;
1084 cc.numeric_data = csi->result_seek[i];
1085 tagcache_search_add_clause(tcs, &cc);
1087 else
1089 tagcache_search_add_filter(tcs, csi->tagorder[i],
1090 csi->result_seek[i]);
1094 for (i = 0; i <= level; i++)
1096 int j;
1098 for (j = 0; j < csi->clause_count[i]; j++)
1099 tagcache_search_add_clause(tcs, csi->clause[i][j]);
1102 current_offset = offset;
1103 current_entry_count = 0;
1104 c->dirfull = false;
1106 fmt = NULL;
1107 for (i = 0; i < format_count; i++)
1109 if (formats[i]->group_id == csi->format_id[level])
1110 fmt = formats[i];
1113 if (fmt)
1115 sort_inverse = fmt->sort_inverse;
1116 sort_limit = fmt->limit;
1117 strip = fmt->strip;
1119 /* Check if sorting is forced. */
1120 if (fmt->sort)
1121 sort = true;
1123 else
1125 sort_inverse = false;
1126 sort_limit = 0;
1127 strip = 0;
1130 if (tag != tag_title && tag != tag_filename)
1132 if (offset == 0)
1134 dptr->newtable = allsubentries;
1135 dptr->name = str(LANG_TAGNAVI_ALL_TRACKS);
1136 dptr++;
1137 current_entry_count++;
1139 if (offset <= 1)
1141 dptr->newtable = navibrowse;
1142 dptr->name = str(LANG_TAGNAVI_RANDOM);
1143 dptr->extraseek = -1;
1144 dptr++;
1145 current_entry_count++;
1147 special_entry_count+=2;
1150 total_count += special_entry_count;
1152 while (tagcache_get_next(tcs))
1154 if (total_count++ < offset)
1155 continue;
1157 dptr->newtable = navibrowse;
1158 if (tag == tag_title || tag == tag_filename)
1160 dptr->newtable = playtrack;
1161 dptr->extraseek = tcs->idx_id;
1163 else
1164 dptr->extraseek = tcs->result_seek;
1166 fmt = NULL;
1167 /* Check the format */
1168 for (i = 0; i < format_count; i++)
1170 if (formats[i]->group_id != csi->format_id[level])
1171 continue;
1173 if (tagcache_check_clauses(tcs, formats[i]->clause,
1174 formats[i]->clause_count))
1176 fmt = formats[i];
1177 break;
1181 if (!tcs->ramresult || fmt)
1183 char buf[MAX_PATH];
1185 if (fmt)
1187 if (format_str(tcs, fmt, buf, sizeof buf) < 0)
1189 logf("format_str() failed");
1190 return 0;
1194 dptr->name = &c->name_buffer[namebufused];
1195 if (fmt)
1196 namebufused += strlen(buf)+1;
1197 else
1198 namebufused += tcs->result_len;
1200 if (namebufused >= c->name_buffer_size)
1202 logf("chunk mode #2: %d", current_entry_count);
1203 c->dirfull = true;
1204 sort = false;
1205 break ;
1207 if (fmt)
1208 strcpy(dptr->name, buf);
1209 else
1210 strcpy(dptr->name, tcs->result);
1212 else
1213 dptr->name = tcs->result;
1215 dptr++;
1216 current_entry_count++;
1218 if (current_entry_count >= global_settings.max_files_in_dir)
1220 logf("chunk mode #3: %d", current_entry_count);
1221 c->dirfull = true;
1222 sort = false;
1223 break ;
1226 if (init && !tcs->ramsearch)
1228 if (!show_search_progress(false, i))
1230 tagcache_search_finish(tcs);
1231 return current_entry_count;
1236 if (sort)
1237 qsort(c->dircache + special_entry_count * c->dentry_size,
1238 current_entry_count - special_entry_count,
1239 c->dentry_size, compare);
1241 if (!init)
1243 tagcache_search_finish(tcs);
1244 return current_entry_count;
1247 while (tagcache_get_next(tcs))
1249 if (!tcs->ramsearch)
1251 if (!show_search_progress(false, total_count))
1252 break;
1254 total_count++;
1257 tagcache_search_finish(tcs);
1259 if (!sort && (sort_inverse || sort_limit))
1261 gui_syncsplash(HZ*4, ID2P(LANG_SHOWDIR_BUFFER_FULL), total_count);
1262 logf("Too small dir buffer");
1263 return 0;
1266 if (sort_limit)
1267 total_count = MIN(total_count, sort_limit);
1269 if (strip)
1271 dptr = c->dircache;
1272 for (i = 0; i < total_count; i++, dptr++)
1274 int len = strlen(dptr->name);
1276 if (len < strip)
1277 continue;
1279 dptr->name = &dptr->name[strip];
1283 return total_count;
1286 static int load_root(struct tree_context *c)
1288 struct tagentry *dptr = (struct tagentry *)c->dircache;
1289 int i;
1291 tc = c;
1292 c->currtable = root;
1293 if (c->dirlevel == 0)
1294 c->currextra = root_menu;
1296 menu = menus[c->currextra];
1297 if (menu == NULL)
1298 return 0;
1300 for (i = 0; i < menu->itemcount; i++)
1302 dptr->name = menu->items[i]->name;
1303 switch (menu->items[i]->type)
1305 case menu_next:
1306 dptr->newtable = navibrowse;
1307 dptr->extraseek = i;
1308 break;
1310 case menu_load:
1311 dptr->newtable = root;
1312 dptr->extraseek = menu->items[i]->link;
1313 break;
1316 dptr++;
1319 current_offset = 0;
1320 current_entry_count = i;
1322 return i;
1325 int tagtree_load(struct tree_context* c)
1327 int count;
1328 int table = c->currtable;
1330 c->dentry_size = sizeof(struct tagentry);
1331 c->dirsindir = 0;
1333 if (!table)
1335 c->dirfull = false;
1336 table = root;
1337 c->currtable = table;
1338 c->currextra = root_menu;
1341 switch (table)
1343 case root:
1344 count = load_root(c);
1345 break;
1347 case allsubentries:
1348 case navibrowse:
1349 logf("navibrowse...");
1350 cpu_boost(true);
1351 count = retrieve_entries(c, &tcs, 0, true);
1352 cpu_boost(false);
1353 break;
1355 default:
1356 logf("Unsupported table %d\n", table);
1357 return -1;
1360 if (count < 0)
1362 c->dirlevel = 0;
1363 count = load_root(c);
1364 gui_syncsplash(HZ, str(LANG_TAGCACHE_BUSY));
1367 /* The _total_ numer of entries available. */
1368 c->dirlength = c->filesindir = count;
1370 return count;
1373 int tagtree_enter(struct tree_context* c)
1375 int rc = 0;
1376 struct tagentry *dptr;
1377 struct mp3entry *id3;
1378 int newextra;
1379 int seek;
1380 int source;
1382 dptr = tagtree_get_entry(c, c->selected_item);
1384 c->dirfull = false;
1385 seek = dptr->extraseek;
1386 if (seek == -1)
1388 if(c->filesindir<=2)
1389 return 0;
1390 srand(current_tick);
1391 dptr = (tagtree_get_entry(c, 2+(rand() % (c->filesindir-2))));
1392 seek = dptr->extraseek;
1394 newextra = dptr->newtable;
1396 if (c->dirlevel >= MAX_DIR_LEVELS)
1397 return 0;
1399 c->selected_item_history[c->dirlevel]=c->selected_item;
1400 c->table_history[c->dirlevel] = c->currtable;
1401 c->extra_history[c->dirlevel] = c->currextra;
1402 c->pos_history[c->dirlevel] = c->firstpos;
1403 c->dirlevel++;
1405 switch (c->currtable) {
1406 case root:
1407 c->currextra = newextra;
1409 if (newextra == root)
1411 menu = menus[seek];
1412 c->currextra = seek;
1415 else if (newextra == navibrowse)
1417 int i, j;
1419 csi = menu->items[seek]->si;
1420 c->currextra = 0;
1422 strncpy(current_title[c->currextra], dptr->name,
1423 sizeof(current_title[0]) - 1);
1425 /* Read input as necessary. */
1426 for (i = 0; i < csi->tagorder_count; i++)
1428 for (j = 0; j < csi->clause_count[i]; j++)
1430 char* searchstring;
1431 source = csi->clause[i][j]->source;
1433 if (source == source_constant)
1434 continue;
1436 searchstring=csi->clause[i][j]->str;
1437 *searchstring = '\0';
1439 id3 = audio_current_track();
1441 if (source == source_current_path && id3)
1443 char *e;
1444 strncpy(searchstring, id3->path, SEARCHSTR_SIZE);
1445 e = strrchr(searchstring, '/');
1446 if (e)
1447 *e = '\0';
1449 else if (source > source_runtime && id3)
1452 int k = source-source_runtime;
1453 int offset = id3_to_search_mapping[k].id3_offset;
1454 char **src = (char**)((char*)id3 + offset);
1455 if (*src)
1457 strncpy(searchstring, *src, SEARCHSTR_SIZE);
1458 searchstring[SEARCHSTR_SIZE-1] = '\0';
1461 else
1463 rc = kbd_input(searchstring, SEARCHSTR_SIZE);
1464 if (rc == -1 || !searchstring[0])
1466 tagtree_exit(c);
1467 return 0;
1469 if (csi->clause[i][j]->numeric)
1470 csi->clause[i][j]->numeric_data = atoi(searchstring);
1477 c->currtable = newextra;
1479 break;
1481 case navibrowse:
1482 case allsubentries:
1483 if (newextra == playtrack)
1485 c->dirlevel--;
1486 /* about to create a new current playlist...
1487 allow user to cancel the operation */
1488 if (global_settings.warnon_erase_dynplaylist &&
1489 !global_settings.party_mode &&
1490 playlist_modified(NULL))
1492 char *lines[]={ID2P(LANG_WARN_ERASEDYNPLAYLIST_PROMPT)};
1493 struct text_message message={lines, 1};
1495 if (gui_syncyesno_run(&message, NULL, NULL) != YESNO_YES)
1496 break;
1499 if (tagtree_play_folder(c) >= 0)
1500 rc = 2;
1501 break;
1504 c->currtable = newextra;
1505 csi->result_seek[c->currextra] = seek;
1506 if (c->currextra < csi->tagorder_count-1)
1507 c->currextra++;
1508 else
1509 c->dirlevel--;
1511 /* Update the statusbar title */
1512 strncpy(current_title[c->currextra], dptr->name,
1513 sizeof(current_title[0]) - 1);
1514 break;
1516 default:
1517 c->dirlevel--;
1518 break;
1521 c->selected_item=0;
1522 gui_synclist_select_item(&tree_lists, c->selected_item);
1524 return rc;
1527 void tagtree_exit(struct tree_context* c)
1529 c->dirfull = false;
1530 if (c->dirlevel > 0)
1531 c->dirlevel--;
1532 c->selected_item=c->selected_item_history[c->dirlevel];
1533 gui_synclist_select_item(&tree_lists, c->selected_item);
1534 c->currtable = c->table_history[c->dirlevel];
1535 c->currextra = c->extra_history[c->dirlevel];
1536 c->firstpos = c->pos_history[c->dirlevel];
1539 int tagtree_get_filename(struct tree_context* c, char *buf, int buflen)
1541 struct tagentry *entry;
1543 entry = tagtree_get_entry(c, c->selected_item);
1545 if (!tagcache_search(&tcs, tag_filename))
1546 return -1;
1548 if (!tagcache_retrieve(&tcs, entry->extraseek, tcs.type, buf, buflen))
1550 tagcache_search_finish(&tcs);
1551 return -2;
1554 tagcache_search_finish(&tcs);
1556 return 0;
1559 static bool insert_all_playlist(struct tree_context *c, int position, bool queue)
1561 int i;
1562 char buf[MAX_PATH];
1563 int from, to, direction;
1564 int files_left = c->filesindir;
1566 cpu_boost(true);
1567 if (!tagcache_search(&tcs, tag_filename))
1569 gui_syncsplash(HZ, ID2P(LANG_TAGCACHE_BUSY));
1570 cpu_boost(false);
1571 return false;
1574 if (position == PLAYLIST_REPLACE)
1576 if (remove_all_tracks(NULL) == 0)
1577 position = PLAYLIST_INSERT_LAST;
1578 else return -1; }
1580 if (position == PLAYLIST_INSERT_FIRST)
1582 from = c->filesindir - 1;
1583 to = -1;
1584 direction = -1;
1586 else
1588 from = 0;
1589 to = c->filesindir;
1590 direction = 1;
1593 for (i = from; i != to; i += direction)
1595 /* Count back to zero */
1596 if (!show_search_progress(false, files_left--))
1597 break;
1599 if (!tagcache_retrieve(&tcs, tagtree_get_entry(c, i)->extraseek,
1600 tcs.type, buf, sizeof buf))
1602 continue;
1605 if (playlist_insert_track(NULL, buf, position, queue, false) < 0)
1607 logf("playlist_insert_track failed");
1608 break;
1610 yield();
1612 playlist_sync(NULL);
1613 tagcache_search_finish(&tcs);
1614 cpu_boost(false);
1616 return true;
1619 bool tagtree_insert_selection_playlist(int position, bool queue)
1621 struct tagentry *dptr;
1622 char buf[MAX_PATH];
1623 int dirlevel = tc->dirlevel;
1625 /* We need to set the table to allsubentries. */
1626 show_search_progress(true, 0);
1628 dptr = tagtree_get_entry(tc, tc->selected_item);
1630 /* Insert a single track? */
1631 if (dptr->newtable == playtrack)
1633 if (tagtree_get_filename(tc, buf, sizeof buf) < 0)
1635 logf("tagtree_get_filename failed");
1636 return false;
1638 playlist_insert_track(NULL, buf, position, queue, true);
1640 return true;
1643 if (dptr->newtable == navibrowse)
1645 tagtree_enter(tc);
1646 tagtree_load(tc);
1647 dptr = tagtree_get_entry(tc, tc->selected_item);
1649 else if (dptr->newtable != allsubentries)
1651 logf("unsupported table: %d", dptr->newtable);
1652 return false;
1655 /* Now the current table should be allsubentries. */
1656 if (dptr->newtable != playtrack)
1658 tagtree_enter(tc);
1659 tagtree_load(tc);
1660 dptr = tagtree_get_entry(tc, tc->selected_item);
1662 /* And now the newtable should be playtrack. */
1663 if (dptr->newtable != playtrack)
1665 logf("newtable: %d !!", dptr->newtable);
1666 tc->dirlevel = dirlevel;
1667 return false;
1671 if (tc->filesindir <= 0)
1672 gui_syncsplash(HZ, ID2P(LANG_END_PLAYLIST));
1673 else
1675 logf("insert_all_playlist");
1676 if (!insert_all_playlist(tc, position, queue))
1677 gui_syncsplash(HZ*2, ID2P(LANG_FAILED));
1680 /* Finally return the dirlevel to its original value. */
1681 while (tc->dirlevel > dirlevel)
1682 tagtree_exit(tc);
1683 tagtree_load(tc);
1685 return true;
1688 static int tagtree_play_folder(struct tree_context* c)
1690 if (playlist_create(NULL, NULL) < 0)
1692 logf("Failed creating playlist\n");
1693 return -1;
1696 if (!insert_all_playlist(c, PLAYLIST_INSERT_LAST, false))
1697 return -2;
1699 if (global_settings.playlist_shuffle)
1700 c->selected_item = playlist_shuffle(current_tick, c->selected_item);
1701 if (!global_settings.play_selected)
1702 c->selected_item = 0;
1703 gui_synclist_select_item(&tree_lists, c->selected_item);
1705 playlist_start(c->selected_item,0);
1707 return 0;
1710 struct tagentry* tagtree_get_entry(struct tree_context *c, int id)
1712 struct tagentry *entry = (struct tagentry *)c->dircache;
1713 int realid = id - current_offset;
1715 /* Load the next chunk if necessary. */
1716 if (realid >= current_entry_count || realid < 0)
1718 cpu_boost(true);
1719 if (retrieve_entries(c, &tcs2, MAX(0, id - (current_entry_count / 2)),
1720 false) < 0)
1722 logf("retrieve failed");
1723 cpu_boost(false);
1724 return NULL;
1726 realid = id - current_offset;
1727 cpu_boost(false);
1730 return &entry[realid];
1733 char *tagtree_get_title(struct tree_context* c)
1735 switch (c->currtable)
1737 case root:
1738 return menu->title;
1740 case navibrowse:
1741 case allsubentries:
1742 return current_title[c->currextra];
1745 return "?";
1748 int tagtree_get_attr(struct tree_context* c)
1750 int attr = -1;
1751 switch (c->currtable)
1753 case navibrowse:
1754 if (csi->tagorder[c->currextra] == tag_title)
1755 attr = FILE_ATTR_AUDIO;
1756 else
1757 attr = ATTR_DIRECTORY;
1758 break;
1760 case allsubentries:
1761 attr = FILE_ATTR_AUDIO;
1762 break;
1764 default:
1765 attr = ATTR_DIRECTORY;
1766 break;
1769 return attr;
1772 int tagtree_get_icon(struct tree_context* c)
1774 int icon = Icon_Folder;
1776 if (tagtree_get_attr(c) == FILE_ATTR_AUDIO)
1777 icon = Icon_Audio;
1779 return icon;