Doxyfile: Change web sync directory.
[paraslash.git] / afs.h
1 /*
2 * Copyright (C) 2007 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 const 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 struct audio_file_data {
94 enum play_mode current_play_mode;
95 char attributes_string[MAXLINE];
96 char path[_POSIX_PATH_MAX];
97 int fd;
98 long score;
99 struct afs_info afsi;
100 struct afh_info afhi;
101 };
102
103 enum afs_server_code {
104 NEXT_AUDIO_FILE,
105 AFD_CHANGE
106 };
107
108 /** Flags passed to for_each_matching_row(). */
109 enum pattern_match_flags {
110 /** Loop in reverse order. */
111 PM_REVERSE_LOOP = 1,
112 /** If no pattern is given, loop over all rows. */
113 PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
114 /** If the data in match_column is the empty string, skip this row. */
115 PM_SKIP_EMPTY_NAME = 4,
116 };
117
118 /** Structure passed to for_each_matching_row(). */
119 struct pattern_match_data {
120 /** Loop over all rows in this table. */
121 struct osl_table *table;
122 /** Determines the loop order. Must be an rbtree column. */
123 unsigned loop_col_num;
124 /** Data from this column is matched against the given patterns. */
125 unsigned match_col_num;
126 /** \see pattern_match_flags. */
127 unsigned pm_flags;
128 /** This value is passed verbatim to fnmatch(). */
129 int fnmatch_flags;
130 /** Null-terminated array of patterns. */
131 struct osl_object patterns;
132 /** Data pointer passed to the action function. */
133 void *data;
134 /** For each matching row, this function will be called. */
135 int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
136 };
137
138 /* afs */
139 typedef int callback_function(const struct osl_object *, struct osl_object *);
140 __noreturn void afs_init(uint32_t cookie, int socket_fd);
141 void afs_event(enum afs_events event, struct para_buffer *pb,
142 void *data);
143 int send_callback_request(callback_function *f, struct osl_object *query,
144 struct osl_object *result);
145 int send_standard_callback_request(int argc, char * const * const argv,
146 callback_function *f, struct osl_object *result);
147 int send_option_arg_callback_request(struct osl_object *options,
148 int argc, char * const * const argv, callback_function *f,
149 struct osl_object *result);
150 int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f,
151 unsigned max_len, struct osl_object *result);
152 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
153 int close_audio_file(struct audio_file_data *afd);
154 int for_each_matching_row(struct pattern_match_data *pmd);
155
156 /* score */
157 void score_init(struct afs_table *t);
158 int admissible_file_loop(void *data, osl_rbtree_loop_func *func);
159 int admissible_file_loop_reverse(void *data, osl_rbtree_loop_func *func);
160 int score_get_best(struct osl_row **aft_row, long *score);
161 int get_score_and_aft_row(struct osl_row *score_row, long *score, struct osl_row **aft_row);
162 int score_add(const struct osl_row *row, long score);
163 int score_update(const struct osl_row *aft_row, long new_score);
164 int get_num_admissible_files(unsigned *num);
165 int score_delete(const struct osl_row *aft_row);
166 int clear_score_table(void);
167 int row_belongs_to_score_table(const struct osl_row *aft_row, unsigned *rank);
168
169 /* attribute */
170 void attribute_init(struct afs_table *t);
171 void get_attribute_bitmap(const uint64_t *atts, char *buf); /* needed by com_ls() */
172 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum);
173 int get_attribute_text(uint64_t *atts, const char *delim, char **text);
174
175 /* aft */
176 void aft_init(struct afs_table *t);
177 int aft_get_row_of_path(const char *path, struct osl_row **row);
178 int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *afd);
179 int load_afd(int shmid, struct audio_file_data *afd);
180 int load_afsi(struct afs_info *afsi, struct osl_object *obj);
181 void save_afsi(struct afs_info *afsi, struct osl_object *obj);
182 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
183 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi);
184 int get_afsi_of_path(const char *path, struct afs_info *afsi);
185 int get_audio_file_path_of_row(const struct osl_row *row, char **path);
186 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj);
187 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
188 int aft_check_callback(const struct osl_object *query, struct osl_object *result);
189
190 /* mood */
191 int change_current_mood(char *mood_name);
192 void close_current_mood(void);
193 int reload_current_mood(void);
194 int mood_check_callback(__a_unused const struct osl_object *query,
195 struct osl_object *result);
196
197
198 /* playlist */
199 int playlist_open(char *name);
200 void playlist_close(void);
201 int playlist_check_callback(__a_unused const struct osl_object *query,
202 struct osl_object *result);
203
204 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
205 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
206
207
208 /** Define exported functions and a table pointer for an osl blob table. */
209 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
210 void table_name ## _init(struct afs_table *t); \
211 int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
212 int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
213 int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def); \
214 int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
215 char **name, struct osl_object *def); \
216 int table_name ##_event_handler(enum afs_events event, \
217 struct para_buffer *pb, void *data); \
218 extern struct osl_table *table_name ## _table;
219
220 DECLARE_BLOB_SYMBOLS(lyrics, lyr);
221 DECLARE_BLOB_SYMBOLS(images, img);
222 DECLARE_BLOB_SYMBOLS(moods, mood);
223 DECLARE_BLOB_SYMBOLS(playlists, pl);
224
225 /** The columns of an abstract blob table. */
226 enum blob_table_columns {
227 /** The identifier, a positive integer that never repeats. */
228 BLOBCOL_ID,
229 /** The unique name of the blob. */
230 BLOBCOL_NAME,
231 /** The actual blob contents. */
232 BLOBCOL_DEF,
233 /** A blob table has that many columns. */
234 NUM_BLOB_COLUMNS
235 };
236
237 /** Define an osl table decription for a blob table. */
238 #define DEFINE_BLOB_TABLE_DESC(table_name) \
239 struct osl_table_description table_name ## _table_desc = { \
240 .name = #table_name, \
241 .num_columns = NUM_BLOB_COLUMNS, \
242 .flags = OSL_LARGE_TABLE, \
243 .column_descriptions = blob_cols \
244 };
245
246 /** Define a pointer to an osl blob table with a canonical name. */
247 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
248
249 /** Define a blob table. */
250 #define INIT_BLOB_TABLE(table_name) \
251 DEFINE_BLOB_TABLE_DESC(table_name); \
252 DEFINE_BLOB_TABLE_PTR(table_name);
253