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