2 * Copyright (C) 2007-2009 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file afs.h Exported symbols of the audio file selector. */
13 /** Audio file selector data stored in the audio file table. */
15 /** Seconds since the epoch. */
17 /** Bit field of set attributes. */
19 /** Counts how many times the file was selected. */
21 /** Image blob associated with this file (foreign key). */
23 /** Lyrics blob associated with this file (foreign key). */
25 /** Mp3, ogg or aac. */
26 uint8_t audio_format_id
;
27 /** Amplification value. */
32 * Events caused by changes to an afs table.
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
40 /** An attribute was added. */
42 /** An attribute was renamed. */
44 /** An attribute was removed. */
46 /** The afs info struct of an audio file changed. */
48 /** The afh info struct of an audio file changed. */
50 /** An audio file was renamed. */
52 /** An audio file was added. */
54 /** An audio file is about to be removed. */
56 /** A new blob was added. */
58 /** A blob was renamed. */
60 /** A blob is about to be removed. */
64 struct rmatt_event_data
{
70 struct afsi_change_event_data
{
71 struct osl_row
*aft_row
;
72 struct afs_info
*old_afsi
;
75 /** Function pointers for table handling. */
77 /** Initializes the other pointers in this struct. */
78 void (*init
)(struct afs_table
*t
);
79 /** The name of this table. */
81 /** Gets called on startup and on \p SIGHUP. */
82 int (*open
)(const char *base_dir
);
83 /** Gets called on shutdown and on \p SIGHUP. */
85 /** Called by the \a init afs command. */
86 int (*create
)(const char *);
87 /** Handles afs events. */
88 int (*event_handler
)(enum afs_events event
, struct para_buffer
*pb
,
92 enum play_mode
{PLAY_MODE_MOOD
, PLAY_MODE_PLAYLIST
};
95 * Data about one audio file.
97 * Needed to produce ls and stat output.
100 /** Usual audio format handler information. */
101 struct afh_info afhi
;
102 /** Audio file selector information. */
103 struct afs_info afsi
;
104 /** The full path of the audio file. */
106 /** The score value (if -a was given). */
108 /** The sha1 hash of audio file. */
111 int make_status_items(struct ls_data
*d
, struct para_buffer
*pb
);
112 void make_empty_status_items(char *buf
);
114 /** At most that many bytes will be passed from afs to para_server. */
115 #define VERBOSE_LS_OUTPUT_SIZE 4096
117 /** Data about the current audio file, passed from afs to server. */
118 struct audio_file_data
{
119 /** Same info as ls -lv -p current audio_file. */
120 char verbose_ls_output
[VERBOSE_LS_OUTPUT_SIZE
];
121 /** The open file descriptor to the current audio file. */
123 /** Vss needs this for streaming. */
124 struct afh_info afhi
;
127 enum afs_server_code
{
133 /** Flags passed to for_each_matching_row(). */
134 enum pattern_match_flags
{
135 /** Loop in reverse order. */
137 /** If no pattern is given, loop over all rows. */
138 PM_NO_PATTERN_MATCHES_EVERYTHING
= 2,
139 /** If the data in match_column is the empty string, skip this row. */
140 PM_SKIP_EMPTY_NAME
= 4,
143 /** Structure passed to for_each_matching_row(). */
144 struct pattern_match_data
{
145 /** Loop over all rows in this table. */
146 struct osl_table
*table
;
147 /** Determines the loop order. Must be an rbtree column. */
148 unsigned loop_col_num
;
149 /** Data from this column is matched against the given patterns. */
150 unsigned match_col_num
;
151 /** \see pattern_match_flags. */
153 /** This value is passed verbatim to fnmatch(). */
155 /** Null-terminated array of patterns. */
156 struct osl_object patterns
;
157 /** Data pointer passed to the action function. */
159 /** For each matching row, this function will be called. */
160 int (*action
)(struct osl_table
*table
, struct osl_row
*row
, const char *name
, void *data
);
165 * Afs command handlers run as a process which is not related to the afs
166 * process, i.e. they can not change the address space of afs directly.
167 * Therefore afs commands typically consist of two functions: The command
168 * handler and the corresponding callback function that runs in afs context.
170 * \sa send_callback_request().
172 typedef void callback_function(int fd
, const struct osl_object
*);
175 * Callbacks send chunks to data back to the command handler. Pointers to
176 * this type of function are used by \ref send_callback_request and friends
177 * to deal with the data in the command handler process.
179 * \sa \ref send_callback_request().
181 typedef int callback_result_handler(struct osl_object
*result
, void *private);
182 int send_result(struct osl_object
*result
, void *fd_ptr
);
183 int pass_buffer_as_shm(char *buf
, size_t size
, void *fd_ptr
);
185 __noreturn
void afs_init(uint32_t cookie
, int socket_fd
);
186 void afs_event(enum afs_events event
, struct para_buffer
*pb
,
188 int send_callback_request(callback_function
*f
, struct osl_object
*query
,
189 callback_result_handler
*result_handler
,
190 void *private_result_data
);
191 int send_option_arg_callback_request(struct osl_object
*options
,
192 int argc
, char * const * const argv
, callback_function
*f
,
193 callback_result_handler
*result_handler
,
194 void *private_result_data
);
195 int send_standard_callback_request(int argc
, char * const * const argv
,
196 callback_function
*f
, callback_result_handler
*result_handler
,
197 void *private_result_data
);
198 int stdin_command(int fd
, struct osl_object
*arg_obj
, callback_function
*f
,
199 unsigned max_len
, callback_result_handler
*result_handler
,
200 void *private_result_data
);
201 int string_compare(const struct osl_object
*obj1
, const struct osl_object
*obj2
);
202 int for_each_matching_row(struct pattern_match_data
*pmd
);
205 void score_init(struct afs_table
*t
);
206 int admissible_file_loop(void *data
, osl_rbtree_loop_func
*func
);
207 int admissible_file_loop_reverse(void *data
, osl_rbtree_loop_func
*func
);
208 int score_get_best(struct osl_row
**aft_row
, long *score
);
209 int get_score_and_aft_row(struct osl_row
*score_row
, long *score
, struct osl_row
**aft_row
);
210 int score_add(const struct osl_row
*row
, long score
);
211 int score_update(const struct osl_row
*aft_row
, long new_score
);
212 int get_num_admissible_files(unsigned *num
);
213 int score_delete(const struct osl_row
*aft_row
);
214 int clear_score_table(void);
215 int row_belongs_to_score_table(const struct osl_row
*aft_row
, unsigned *rank
);
218 void attribute_init(struct afs_table
*t
);
219 void get_attribute_bitmap(const uint64_t *atts
, char *buf
); /* needed by com_ls() */
220 int get_attribute_bitnum_by_name(const char *att_name
, unsigned char *bitnum
);
221 int get_attribute_text(uint64_t *atts
, const char *delim
, char **text
);
224 void aft_init(struct afs_table
*t
);
225 int aft_get_row_of_path(const char *path
, struct osl_row
**row
);
226 int open_and_update_audio_file(struct osl_row
*aft_row
, long score
,
227 struct audio_file_data
*afd
);
228 int load_afd(int shmid
, struct audio_file_data
*afd
);
229 int load_afsi(struct afs_info
*afsi
, struct osl_object
*obj
);
230 void save_afsi(struct afs_info
*afsi
, struct osl_object
*obj
);
231 int get_afsi_of_row(const struct osl_row
*row
, struct afs_info
*afsi
);
232 int get_afhi_of_row(const struct osl_row
*row
, struct afh_info
*afhi
);
233 int get_afsi_of_path(const char *path
, struct afs_info
*afsi
);
234 int get_audio_file_path_of_row(const struct osl_row
*row
, char **path
);
235 int get_afsi_object_of_row(const struct osl_row
*row
, struct osl_object
*obj
);
236 int audio_file_loop(void *private_data
, osl_rbtree_loop_func
*func
);
237 void aft_check_callback(int fd
, __a_unused
const struct osl_object
*query
);
240 int change_current_mood(char *mood_name
);
241 void close_current_mood(void);
242 int reload_current_mood(void);
243 void mood_check_callback(int fd
, __a_unused
const struct osl_object
*query
);
247 int playlist_open(char *name
);
248 void playlist_close(void);
249 void playlist_check_callback(int fd
, __a_unused
const struct osl_object
*query
);
251 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
252 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
255 /** Define exported functions and a table pointer for an osl blob table. */
256 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
257 void table_name ## _init(struct afs_table *t); \
258 int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
259 int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
260 int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def); \
261 int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
262 char **name, struct osl_object *def); \
263 int table_name ##_event_handler(enum afs_events event, \
264 struct para_buffer *pb, void *data); \
265 extern struct osl_table *table_name ## _table;
267 DECLARE_BLOB_SYMBOLS(lyrics
, lyr
);
268 DECLARE_BLOB_SYMBOLS(images
, img
);
269 DECLARE_BLOB_SYMBOLS(moods
, mood
);
270 DECLARE_BLOB_SYMBOLS(playlists
, pl
);
272 /** The columns of an abstract blob table. */
273 enum blob_table_columns
{
274 /** The identifier, a positive integer that never repeats. */
276 /** The unique name of the blob. */
278 /** The actual blob contents. */
280 /** A blob table has that many columns. */
284 /** Define an osl table description for a blob table. */
285 #define DEFINE_BLOB_TABLE_DESC(table_name) \
286 struct osl_table_description table_name ## _table_desc = { \
287 .name = #table_name, \
288 .num_columns = NUM_BLOB_COLUMNS, \
289 .flags = OSL_LARGE_TABLE, \
290 .column_descriptions = blob_cols \
293 /** Define a pointer to an osl blob table with a canonical name. */
294 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
296 /** Define a blob table. */
297 #define INIT_BLOB_TABLE(table_name) \
298 DEFINE_BLOB_TABLE_DESC(table_name); \
299 DEFINE_BLOB_TABLE_PTR(table_name);