569798457b1338bd3261883557549a0b0129de02
[paraslash.git] / afs.h
1 /*
2 * Copyright (C) 2007-2008 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file afs.h Exported symbols of the audio file selector. */
8
9 #include <regex.h>
10 #include "osl.h"
11 #include "hash.h"
12
13 /** Audio file selector data stored in the audio file table. */
14 struct afs_info {
15 /** Seconds since the epoch. */
16 uint64_t last_played;
17 /** Bit field of set attributes. */
18 uint64_t attributes;
19 /** Counts how many times the file was selected. */
20 uint32_t num_played;
21 /** Image blob associated with this file (foreign key). */
22 uint32_t image_id;
23 /** Lyrics blob associated with this file (foreign key). */
24 uint32_t lyrics_id;
25 /** Mp3, ogg or aac. */
26 uint8_t audio_format_id;
27 };
28
29 /**
30 * Events caused by changes to an afs table.
31 *
32 * Whenever an afs table changes, an event is generated which causes afs to
33 * call the event handlers of all other tables. For example, if an audio file
34 * is added, the event handler of the mood table checks the new file for
35 * admissibility.
36 */
37 enum afs_events {
38 /** An attribute was added. */
39 ATTRIBUTE_ADD,
40 /** An attribute was renamed. */
41 ATTRIBUTE_RENAME,
42 /** An attribute was removed. */
43 ATTRIBUTE_REMOVE,
44 /** The afs info struct of an audio file changed. */
45 AFSI_CHANGE,
46 /** The afh info struct of an audio file changed. */
47 AFHI_CHANGE,
48 /** An audio file was renamed. */
49 AUDIO_FILE_RENAME,
50 /** An audio file was added. */
51 AUDIO_FILE_ADD,
52 /** An audio file is about to be removed. */
53 AUDIO_FILE_REMOVE,
54 /** A new blob was added. */
55 BLOB_ADD,
56 /** A blob was renamed. */
57 BLOB_RENAME,
58 /** A blob is about to be removed. */
59 BLOB_REMOVE,
60 };
61
62 struct rmatt_event_data {
63 const char *name;
64 unsigned char bitnum;
65 };
66
67
68 struct afsi_change_event_data {
69 struct osl_row *aft_row;
70 struct afs_info *old_afsi;
71 };
72
73 /** Function pointers for table handling. */
74 struct afs_table {
75 /** Initializes the other pointers in this struct. */
76 void (*init)(struct afs_table *t);
77 /** The name of this table. */
78 const char *name;
79 /** Gets called on startup and on \p SIGHUP. */
80 int (*open)(const char *base_dir);
81 /** Gets called on shutdown and on \p SIGHUP. */
82 void (*close)(void);
83 /** Called by the \a init afs command. */
84 int (*create)(const char *);
85 /** Handles afs events. */
86 int (*event_handler)(enum afs_events event, struct para_buffer *pb,
87 void *data);
88 /* int *(check)() */
89 };
90
91 enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
92
93 /**
94 * Data about one audio file.
95 *
96 * Needed to produce ls and stat output.
97 */
98 struct ls_data {
99 /** Usual audio format handler information. */
100 struct afh_info afhi;
101 /** Audio file selector information. */
102 struct afs_info afsi;
103 /** The full path of the audio file. */
104 char *path;
105 /** The score value (if -a was given). */
106 long score;
107 /** The sha1 hash of audio file. */
108 HASH_TYPE *hash;
109 };
110 int make_status_items(struct ls_data *d, struct para_buffer *pb);
111 void make_empty_status_items(char *buf);
112
113 /** At most that many bytes will be passed from afs to para_server. */
114 #define VERBOSE_LS_OUTPUT_SIZE 4096
115
116 /** Data about the current audio file, passed from afs to server. */
117 struct audio_file_data {
118 /** Same info as ls -lv -p current audio_file. */
119 char verbose_ls_output[VERBOSE_LS_OUTPUT_SIZE];
120 /** The open file descriptor to the current audio file. */
121 int fd;
122 /** Vss needs this for streaming. */
123 struct afh_info afhi;
124 };
125
126 enum afs_server_code {
127 NEXT_AUDIO_FILE,
128 NO_ADMISSIBLE_FILES,
129 AFD_CHANGE
130 };
131
132 /** Flags passed to for_each_matching_row(). */
133 enum pattern_match_flags {
134 /** Loop in reverse order. */
135 PM_REVERSE_LOOP = 1,
136 /** If no pattern is given, loop over all rows. */
137 PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
138 /** If the data in match_column is the empty string, skip this row. */
139 PM_SKIP_EMPTY_NAME = 4,
140 };
141
142 /** Structure passed to for_each_matching_row(). */
143 struct pattern_match_data {
144 /** Loop over all rows in this table. */
145 struct osl_table *table;
146 /** Determines the loop order. Must be an rbtree column. */
147 unsigned loop_col_num;
148 /** Data from this column is matched against the given patterns. */
149 unsigned match_col_num;
150 /** \see pattern_match_flags. */
151 unsigned pm_flags;
152 /** This value is passed verbatim to fnmatch(). */
153 int fnmatch_flags;
154 /** Null-terminated array of patterns. */
155 struct osl_object patterns;
156 /** Data pointer passed to the action function. */
157 void *data;
158 /** For each matching row, this function will be called. */
159 int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
160 };
161
162 /* afs */
163 /**
164 * Afs command handlers run as a process which is not related to the afs
165 * process, i.e. they can not change the address space of afs directly.
166 * Therefore afs commands typically consist of two functions: The command
167 * handler and the corresponding callback function that runs in afs context.
168 *
169 * \sa send_callback_request().
170 */
171 typedef int callback_function(const struct osl_object *, struct osl_object *);
172 typedef int callback_result_handler(struct osl_object *result, void *private);
173 int send_result(struct osl_object *result, void *private_result_data);
174
175 __noreturn void afs_init(uint32_t cookie, int socket_fd);
176 void afs_event(enum afs_events event, struct para_buffer *pb,
177 void *data);
178 int send_callback_request(callback_function *f, struct osl_object *query,
179 callback_result_handler *result_handler,
180 void *private_result_data);
181 int send_option_arg_callback_request(struct osl_object *options,
182 int argc, char * const * const argv, callback_function *f,
183 callback_result_handler *result_handler,
184 void *private_result_data);
185 int send_standard_callback_request(int argc, char * const * const argv,
186 callback_function *f, callback_result_handler *result_handler,
187 void *private_result_data);
188 int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f,
189 unsigned max_len, callback_result_handler *result_handler,
190 void *private_result_data);
191 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
192 int for_each_matching_row(struct pattern_match_data *pmd);
193
194 /* score */
195 void score_init(struct afs_table *t);
196 int admissible_file_loop(void *data, osl_rbtree_loop_func *func);
197 int admissible_file_loop_reverse(void *data, osl_rbtree_loop_func *func);
198 int score_get_best(struct osl_row **aft_row, long *score);
199 int get_score_and_aft_row(struct osl_row *score_row, long *score, struct osl_row **aft_row);
200 int score_add(const struct osl_row *row, long score);
201 int score_update(const struct osl_row *aft_row, long new_score);
202 int get_num_admissible_files(unsigned *num);
203 int score_delete(const struct osl_row *aft_row);
204 int clear_score_table(void);
205 int row_belongs_to_score_table(const struct osl_row *aft_row, unsigned *rank);
206
207 /* attribute */
208 void attribute_init(struct afs_table *t);
209 void get_attribute_bitmap(const uint64_t *atts, char *buf); /* needed by com_ls() */
210 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum);
211 int get_attribute_text(uint64_t *atts, const char *delim, char **text);
212
213 /* aft */
214 void aft_init(struct afs_table *t);
215 int aft_get_row_of_path(const char *path, struct osl_row **row);
216 int open_and_update_audio_file(struct osl_row *aft_row, long score,
217 struct audio_file_data *afd);
218 int load_afd(int shmid, struct audio_file_data *afd);
219 int load_afsi(struct afs_info *afsi, struct osl_object *obj);
220 void save_afsi(struct afs_info *afsi, struct osl_object *obj);
221 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
222 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi);
223 int get_afsi_of_path(const char *path, struct afs_info *afsi);
224 int get_audio_file_path_of_row(const struct osl_row *row, char **path);
225 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj);
226 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
227 int aft_check_callback(const struct osl_object *query, struct osl_object *result);
228
229 /* mood */
230 int change_current_mood(char *mood_name);
231 void close_current_mood(void);
232 int reload_current_mood(void);
233 int mood_check_callback(__a_unused const struct osl_object *query,
234 struct osl_object *result);
235
236
237 /* playlist */
238 int playlist_open(char *name);
239 void playlist_close(void);
240 int playlist_check_callback(__a_unused const struct osl_object *query,
241 struct osl_object *result);
242
243 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
244 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
245
246
247 /** Define exported functions and a table pointer for an osl blob table. */
248 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
249 void table_name ## _init(struct afs_table *t); \
250 int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
251 int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
252 int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def); \
253 int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
254 char **name, struct osl_object *def); \
255 int table_name ##_event_handler(enum afs_events event, \
256 struct para_buffer *pb, void *data); \
257 extern struct osl_table *table_name ## _table;
258
259 DECLARE_BLOB_SYMBOLS(lyrics, lyr);
260 DECLARE_BLOB_SYMBOLS(images, img);
261 DECLARE_BLOB_SYMBOLS(moods, mood);
262 DECLARE_BLOB_SYMBOLS(playlists, pl);
263
264 /** The columns of an abstract blob table. */
265 enum blob_table_columns {
266 /** The identifier, a positive integer that never repeats. */
267 BLOBCOL_ID,
268 /** The unique name of the blob. */
269 BLOBCOL_NAME,
270 /** The actual blob contents. */
271 BLOBCOL_DEF,
272 /** A blob table has that many columns. */
273 NUM_BLOB_COLUMNS
274 };
275
276 /** Define an osl table description for a blob table. */
277 #define DEFINE_BLOB_TABLE_DESC(table_name) \
278 struct osl_table_description table_name ## _table_desc = { \
279 .name = #table_name, \
280 .num_columns = NUM_BLOB_COLUMNS, \
281 .flags = OSL_LARGE_TABLE, \
282 .column_descriptions = blob_cols \
283 };
284
285 /** Define a pointer to an osl blob table with a canonical name. */
286 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
287
288 /** Define a blob table. */
289 #define INIT_BLOB_TABLE(table_name) \
290 DEFINE_BLOB_TABLE_DESC(table_name); \
291 DEFINE_BLOB_TABLE_PTR(table_name);
292