s5l870x : use mmu-arm.S
[kugel-rb.git] / apps / tagcache.h
blob1488c3bd39e888b66b982804a2352ab04bcdcebf
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 ****************************************************************************/
21 #ifdef HAVE_TAGCACHE
22 #ifndef _TAGCACHE_H
23 #define _TAGCACHE_H
25 #include "system.h"
26 #include "metadata.h"
28 /**
29 Note: When adding new tags, make sure to update index_entry_ec in
30 tagcache.c and bump up the header version too.
32 enum tag_type { tag_artist = 0, tag_album, tag_genre, tag_title,
33 tag_filename, tag_composer, tag_comment, tag_albumartist, tag_grouping, tag_year,
34 tag_discnumber, tag_tracknumber, tag_bitrate, tag_length, tag_playcount, tag_rating,
35 tag_playtime, tag_lastplayed, tag_commitid, tag_mtime,
36 /* Real tags end here, count them. */
37 TAG_COUNT,
38 /* Virtual tags */
39 tag_virt_length_min, tag_virt_length_sec,
40 tag_virt_playtime_min, tag_virt_playtime_sec,
41 tag_virt_entryage, tag_virt_autoscore };
43 /* Maximum length of a single tag. */
44 #define TAG_MAXLEN (MAX_PATH*2)
46 /* Allow a little drift to the filename ordering (should not be too high/low). */
47 #define POS_HISTORY_COUNT 4
49 /* How much to pre-load entries while committing to prevent seeking. */
50 #define IDX_BUF_DEPTH 64
52 /* Tag Cache Header version 'TCHxx'. Increment when changing internal structures. */
53 #define TAGCACHE_MAGIC 0x5443480d
55 /* How much to allocate extra space for ramcache. */
56 #define TAGCACHE_RESERVE 32768
58 /**
59 * Define how long one entry must be at least (longer -> less memory at commit).
60 * Must be at least 4 bytes in length for correct alignment.
62 #define TAGFILE_ENTRY_CHUNK_LENGTH 8
64 /* Used to guess the necessary buffer size at commit. */
65 #define TAGFILE_ENTRY_AVG_LENGTH 16
67 /* How many entries to fetch to the seek table at once while searching. */
68 #define SEEK_LIST_SIZE 32
70 /* Always strict align entries for best performance and binary compatibility. */
71 #define TAGCACHE_STRICT_ALIGN 1
73 /* Max events in the internal tagcache command queue. */
74 #define TAGCACHE_COMMAND_QUEUE_LENGTH 32
75 /* Idle time before committing events in the command queue. */
76 #define TAGCACHE_COMMAND_QUEUE_COMMIT_DELAY HZ*2
78 #define TAGCACHE_MAX_FILTERS 4
79 #define TAGCACHE_MAX_CLAUSES 32
81 /* Tag database files. */
83 /* Temporary database containing new tags to be committed to the main db. */
84 #define TAGCACHE_FILE_TEMP ROCKBOX_DIR "/database_tmp.tcd"
86 /* The main database master index and numeric data. */
87 #define TAGCACHE_FILE_MASTER ROCKBOX_DIR "/database_idx.tcd"
89 /* The main database string data. */
90 #define TAGCACHE_FILE_INDEX ROCKBOX_DIR "/database_%d.tcd"
92 /* ASCII dumpfile of the DB contents. */
93 #define TAGCACHE_FILE_CHANGELOG ROCKBOX_DIR "/database_changelog.txt"
95 /* Serialized DB. */
96 #define TAGCACHE_STATEFILE ROCKBOX_DIR "/database_state.tcd"
98 /* Numeric tags (we can use these tags with conditional clauses). */
99 #define TAGCACHE_NUMERIC_TAGS ((1LU << tag_year) | (1LU << tag_discnumber) | \
100 (1LU << tag_tracknumber) | (1LU << tag_length) | (1LU << tag_bitrate) | \
101 (1LU << tag_playcount) | (1LU << tag_rating) | (1LU << tag_playtime) | \
102 (1LU << tag_lastplayed) | (1LU << tag_commitid) | (1LU << tag_mtime) | \
103 (1LU << tag_virt_length_min) | (1LU << tag_virt_length_sec) | \
104 (1LU << tag_virt_playtime_min) | (1LU << tag_virt_playtime_sec) | \
105 (1LU << tag_virt_entryage) | (1LU << tag_virt_autoscore))
107 #define TAGCACHE_IS_NUMERIC(tag) (BIT_N(tag) & TAGCACHE_NUMERIC_TAGS)
109 /* Flags */
110 #define FLAG_DELETED 0x0001 /* Entry has been removed from db */
111 #define FLAG_DIRCACHE 0x0002 /* Filename is a dircache pointer */
112 #define FLAG_DIRTYNUM 0x0004 /* Numeric data has been modified */
113 #define FLAG_TRKNUMGEN 0x0008 /* Track number has been generated */
114 #define FLAG_RESURRECTED 0x0010 /* Statistics data has been resurrected */
116 enum clause { clause_none, clause_is, clause_is_not, clause_gt, clause_gteq,
117 clause_lt, clause_lteq, clause_contains, clause_not_contains,
118 clause_begins_with, clause_not_begins_with, clause_ends_with,
119 clause_not_ends_with, clause_oneof };
121 struct tagcache_stat {
122 bool initialized; /* Is tagcache currently busy? */
123 bool readyvalid; /* Has tagcache ready status been ascertained */
124 bool ready; /* Is tagcache ready to be used? */
125 bool ramcache; /* Is tagcache loaded in ram? */
126 bool commit_delayed; /* Has commit been delayed until next reboot? */
127 bool econ; /* Is endianess correction enabled? */
128 int commit_step; /* Commit progress */
129 int ramcache_allocated; /* Has ram been allocated for ramcache? */
130 int ramcache_used; /* How much ram has been really used */
131 int progress; /* Current progress of disk scan */
132 int processed_entries; /* Scanned disk entries so far */
133 int queue_length; /* Command queue length */
134 volatile const char
135 *curentry; /* Path of the current entry being scanned. */
136 volatile bool syncscreen;/* Synchronous operation with debug screen? */
137 // const char *uimessage; /* Pending error message. Implement soon. */
140 enum source_type {source_constant,
141 source_runtime,
142 source_current_path /* dont add items after this.
143 it is used as an index
144 into id3_to_search_mapping */
147 struct tagcache_search_clause
149 int tag;
150 int type;
151 bool numeric;
152 int source;
153 long numeric_data;
154 char *str;
157 struct tagcache_seeklist_entry {
158 int32_t seek;
159 int32_t flag;
160 int32_t idx_id;
163 struct tagcache_search {
164 /* For internal use only. */
165 int fd, masterfd;
166 int idxfd[TAG_COUNT];
167 struct tagcache_seeklist_entry seeklist[SEEK_LIST_SIZE];
168 int seek_list_count;
169 int32_t filter_tag[TAGCACHE_MAX_FILTERS];
170 int32_t filter_seek[TAGCACHE_MAX_FILTERS];
171 int filter_count;
172 struct tagcache_search_clause *clause[TAGCACHE_MAX_CLAUSES];
173 int clause_count;
174 int list_position;
175 int seek_pos;
176 long position;
177 int entry_count;
178 bool valid;
179 bool initialized;
180 unsigned long *unique_list;
181 int unique_list_capacity;
182 int unique_list_count;
184 /* Exported variables. */
185 bool ramsearch; /* Is ram copy of the tagcache being used. */
186 bool ramresult; /* False if result is not static, and must be copied. */
187 int type;
188 char *result; /* The result data for all tags. */
189 int result_len; /* Length of the result including \0 */
190 int32_t result_seek; /* Current position in the tag data. */
191 int32_t idx_id; /* Entry number in the master index. */
194 void tagcache_build(const char *path);
196 #ifdef __PCTOOL__
197 void tagcache_reverse_scan(void);
198 #endif
200 const char* tagcache_tag_to_str(int tag);
202 #ifdef CPU_SH
203 bool tagcache_is_numeric_tag(int type);
204 #endif
205 bool tagcache_find_index(struct tagcache_search *tcs, const char *filename);
206 bool tagcache_check_clauses(struct tagcache_search *tcs,
207 struct tagcache_search_clause **clause, int count);
208 bool tagcache_is_busy(void);
209 bool tagcache_search(struct tagcache_search *tcs, int tag);
210 void tagcache_search_set_uniqbuf(struct tagcache_search *tcs,
211 void *buffer, long length);
212 bool tagcache_search_add_filter(struct tagcache_search *tcs,
213 int tag, int seek);
214 bool tagcache_search_add_clause(struct tagcache_search *tcs,
215 struct tagcache_search_clause *clause);
216 bool tagcache_get_next(struct tagcache_search *tcs);
217 bool tagcache_retrieve(struct tagcache_search *tcs, int idxid,
218 int tag, char *buf, long size);
219 void tagcache_search_finish(struct tagcache_search *tcs);
220 long tagcache_get_numeric(const struct tagcache_search *tcs, int tag);
221 long tagcache_increase_serial(void);
222 long tagcache_get_serial(void);
223 bool tagcache_import_changelog(void);
224 bool tagcache_create_changelog(struct tagcache_search *tcs);
225 void tagcache_update_numeric(int idx_id, int tag, long data);
226 bool tagcache_modify_numeric_entry(struct tagcache_search *tcs,
227 int tag, long data);
229 struct tagcache_stat* tagcache_get_stat(void);
230 int tagcache_get_commit_step(void);
231 bool tagcache_prepare_shutdown(void);
232 void tagcache_shutdown(void);
234 void tagcache_screensync_event(void);
235 void tagcache_screensync_enable(bool state);
237 #ifdef HAVE_TC_RAMCACHE
238 bool tagcache_is_ramcache(void);
239 bool tagcache_fill_tags(struct mp3entry *id3, const char *filename);
240 void tagcache_unload_ramcache(void);
241 #endif
242 void tagcache_init(void) INIT_ATTR;
243 bool tagcache_is_initialized(void);
244 bool tagcache_is_usable(void);
245 void tagcache_start_scan(void);
246 void tagcache_stop_scan(void);
247 bool tagcache_update(void);
248 bool tagcache_rebuild(void);
249 int tagcache_get_max_commit_step(void);
250 #endif
251 #endif