4d3feb4840ec21f4d315c0a2fce9926377e6d9e9
[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 symbos 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 enum afs_events {
30 ATTRIBUTE_ADD,
31 ATTRIBUTE_RENAME,
32 ATTRIBUTE_REMOVE,
33 AFSI_CHANGE,
34 AFHI_CHANGE,
35 AUDIO_FILE_RENAME,
36 AUDIO_FILE_ADD,
37 AUDIO_FILE_REMOVE,
38 BLOB_ADD,
39 BLOB_RENAME,
40 BLOB_REMOVE,
41
42 };
43
44 struct rmatt_event_data {
45 const char *name;
46 unsigned char bitnum;
47 };
48
49
50 struct addatt_event_data {
51 const char *name;
52 unsigned char bitnum;
53 };
54
55 struct afsi_change_event_data {
56 const struct osl_row *aft_row;
57 struct afs_info *old_afsi;
58 };
59
60 struct afs_table {
61 void (*init)(struct afs_table *t);
62 const char *name;
63 int (*open)(const char *base_dir);
64 void (*close)(void);
65 int (*create)(const char *);
66 int (*event_handler)(enum afs_events event, struct para_buffer *pb,
67 void *data);
68 /* int *(check)() */
69 };
70
71 enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
72
73 struct audio_file_data {
74 enum play_mode current_play_mode;
75 int fd;
76 long score;
77 struct afs_info afsi;
78 struct audio_format_info afhi;
79 char *path;
80 };
81
82 enum afs_server_code {
83 NEXT_AUDIO_FILE,
84 AFD_CHANGE
85 };
86
87 /** Flags passed to for_each_matching_row(). */
88 enum pattern_match_flags {
89 /** Loop in reverse order. */
90 PM_REVERSE_LOOP = 1,
91 /** If no pattern is given, loop over all rows. */
92 PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
93 /** If the data in match_column is the empty string, skip this row. */
94 PM_SKIP_EMPTY_NAME = 4,
95 };
96
97 /** Structure passed to for_each_matching_row(). */
98 struct pattern_match_data {
99 /** Loop over all rows in this table. */
100 struct osl_table *table;
101 /** Determines the loop order. Must be an rbtree column. */
102 unsigned loop_col_num;
103 /** Data from this column is matched against the given patterns. */
104 unsigned match_col_num;
105 /** \see pattern_match_flags. */
106 unsigned pm_flags;
107 /** This value is passed verbatim to fnmatch(). */
108 int fnmatch_flags;
109 /** Null-terminated array of patterns. */
110 struct osl_object patterns;
111 /** Data pointer passed to the action function. */
112 void *data;
113 /** For each matching row, this function will be called. */
114 int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
115 };
116
117 /* afs */
118 typedef int callback_function(const struct osl_object *, struct osl_object *);
119 __noreturn void afs_init(uint32_t cookie, int socket_fd);
120 void afs_event(enum afs_events event, struct para_buffer *pb,
121 void *data);
122 int send_callback_request(callback_function *f, struct osl_object *query,
123 struct osl_object *result);
124 int send_standard_callback_request(int argc, char * const * const argv,
125 callback_function *f, struct osl_object *result);
126 int send_option_arg_callback_request(struct osl_object *options,
127 int argc, char * const * const argv, callback_function *f,
128 struct osl_object *result);
129 int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f,
130 unsigned max_len, struct osl_object *result);
131 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
132 int close_audio_file(struct audio_file_data *afd);
133 int for_each_matching_row(struct pattern_match_data *pmd);
134
135 /* score */
136 void score_init(struct afs_table *t);
137 int admissible_file_loop(void *data, osl_rbtree_loop_func *func);
138 int admissible_file_loop_reverse(void *data, osl_rbtree_loop_func *func);
139 int score_get_best(struct osl_row **aft_row, long *score);
140 int get_score_and_aft_row(struct osl_row *score_row, long *score, struct osl_row **aft_row);
141 int score_add(const struct osl_row *row, long score);
142 int score_update(const struct osl_row *aft_row, long new_score);
143 int get_num_admissible_files(unsigned *num);
144 int score_delete(const struct osl_row *aft_row);
145 int clear_score_table(void);
146 int row_belongs_to_score_table(const struct osl_row *aft_row, unsigned *rank);
147
148 /* attribute */
149 void attribute_init(struct afs_table *t);
150 void get_attribute_bitmap(const uint64_t *atts, char *buf); /* needed by com_ls() */
151 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum);
152 int get_attribute_text(uint64_t *atts, const char *delim, char **text);
153
154 /* aft */
155 void aft_init(struct afs_table *t);
156 int aft_get_row_of_path(const char *path, struct osl_row **row);
157 int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *afd);
158 int load_afd(int shmid, struct audio_file_data *afd);
159 int load_afsi(struct afs_info *afsi, struct osl_object *obj);
160 void save_afsi(struct afs_info *afsi, struct osl_object *obj);
161 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
162 int get_afhi_of_row(const struct osl_row *row, struct audio_format_info *afhi);
163 int get_afsi_of_path(const char *path, struct afs_info *afsi);
164 int get_audio_file_path_of_row(const struct osl_row *row, char **path);
165 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj);
166 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
167 int aft_check_callback(const struct osl_object *query, struct osl_object *result);
168
169 /* mood */
170 int change_current_mood(char *mood_name);
171 void close_current_mood(void);
172 int reload_current_mood(void);
173 int mood_check_callback(__a_unused const struct osl_object *query,
174 struct osl_object *result);
175
176
177 /* playlist */
178 int playlist_open(char *name);
179 void playlist_close(void);
180 int playlist_update_audio_file(struct osl_row *aft_row);
181 int playlist_check_callback(__a_unused const struct osl_object *query,
182 struct osl_object *result);
183
184 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
185 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
186
187
188 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
189 void table_name ## _init(struct afs_table *t); \
190 int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
191 int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
192 int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def); \
193 int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
194 char **name, struct osl_object *def); \
195 int table_name ##_event_handler(enum afs_events event, \
196 struct para_buffer *pb, void *data); \
197 extern struct osl_table *table_name ## _table;
198
199 DECLARE_BLOB_SYMBOLS(lyrics, lyr);
200 DECLARE_BLOB_SYMBOLS(images, img);
201 DECLARE_BLOB_SYMBOLS(moods, mood);
202 DECLARE_BLOB_SYMBOLS(playlists, pl);
203
204 /** The columns of an abstract blob table. */
205 enum blob_table_columns {
206 /** The identifier, a positive integer that never repeats. */
207 BLOBCOL_ID,
208 /** The unique name of the blob. */
209 BLOBCOL_NAME,
210 /** The actual blob contents. */
211 BLOBCOL_DEF,
212 /** A blob table has that many columns. */
213 NUM_BLOB_COLUMNS
214 };
215
216 #define DEFINE_BLOB_TABLE_DESC(table_name) \
217 struct osl_table_description table_name ## _table_desc = { \
218 .name = #table_name, \
219 .num_columns = NUM_BLOB_COLUMNS, \
220 .flags = OSL_LARGE_TABLE, \
221 .column_descriptions = blob_cols \
222 };
223
224 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
225
226 #define INIT_BLOB_TABLE(table_name) \
227 DEFINE_BLOB_TABLE_DESC(table_name); \
228 DEFINE_BLOB_TABLE_PTR(table_name);
229