2 * Copyright (C) 2007 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
;
30 * Events caused by changes to an afs table.
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
38 /** An attribute was added. */
40 /** An attribute was renamed. */
42 /** An attribute was removed. */
44 /** The afs info struct of an audio file changed. */
46 /** The afh info struct of an audio file changed. */
48 /** An audio file was renamed. */
50 /** An audio file was added. */
52 /** An audio file is about to be removed. */
54 /** A new blob was added. */
56 /** A blob was renamed. */
58 /** A blob is about to be removed. */
62 struct rmatt_event_data
{
68 struct afsi_change_event_data
{
69 struct osl_row
*aft_row
;
70 struct afs_info
*old_afsi
;
73 /** Function pointers for table handling. */
75 /** Initializes the other pointers in this struct. */
76 void (*init
)(struct afs_table
*t
);
77 /** The name of this table. */
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. */
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
,
91 enum play_mode
{PLAY_MODE_MOOD
, PLAY_MODE_PLAYLIST
};
94 * Data about one audio file.
96 * Needed to produce ls and stat output.
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. */
105 /** The score value (if -a was given). */
107 /** The sha1 hash of audio file. */
110 int make_status_items(struct ls_data
*d
, struct para_buffer
*pb
);
111 void make_empty_status_items(char *buf
);
113 /** At most that many bytes will be passed from afs to para_server. */
114 #define VERBOSE_LS_OUTPUT_SIZE 4096
117 * Data about the current audio file, passed from afs to server.
119 struct audio_file_data
{
120 /** Same info as ls -lv -p current audio_file. */
121 char verbose_ls_output
[VERBOSE_LS_OUTPUT_SIZE
];
122 /** The open file descriptor to the current audio file. */
124 /** Vss needs this for streaming. */
125 struct afh_info afhi
;
128 enum afs_server_code
{
134 /** Flags passed to for_each_matching_row(). */
135 enum pattern_match_flags
{
136 /** Loop in reverse order. */
138 /** If no pattern is given, loop over all rows. */
139 PM_NO_PATTERN_MATCHES_EVERYTHING
= 2,
140 /** If the data in match_column is the empty string, skip this row. */
141 PM_SKIP_EMPTY_NAME
= 4,
144 /** Structure passed to for_each_matching_row(). */
145 struct pattern_match_data
{
146 /** Loop over all rows in this table. */
147 struct osl_table
*table
;
148 /** Determines the loop order. Must be an rbtree column. */
149 unsigned loop_col_num
;
150 /** Data from this column is matched against the given patterns. */
151 unsigned match_col_num
;
152 /** \see pattern_match_flags. */
154 /** This value is passed verbatim to fnmatch(). */
156 /** Null-terminated array of patterns. */
157 struct osl_object patterns
;
158 /** Data pointer passed to the action function. */
160 /** For each matching row, this function will be called. */
161 int (*action
)(struct osl_table
*table
, struct osl_row
*row
, const char *name
, void *data
);
166 * Afs command handlers run as a process which is not related to the afs
167 * process, i.e. they can not change the address space of afs directly.
168 * Therefore afs commands typically consist of two functions: The command
169 * handler and the corresponding callback function that runs in afs context.
171 * \sa send_callback_request().
173 typedef int callback_function(const struct osl_object
*, struct osl_object
*);
174 __noreturn
void afs_init(uint32_t cookie
, int socket_fd
);
175 void afs_event(enum afs_events event
, struct para_buffer
*pb
,
177 int send_callback_request(callback_function
*f
, struct osl_object
*query
,
178 struct osl_object
*result
);
179 int send_standard_callback_request(int argc
, char * const * const argv
,
180 callback_function
*f
, struct osl_object
*result
);
181 int send_option_arg_callback_request(struct osl_object
*options
,
182 int argc
, char * const * const argv
, callback_function
*f
,
183 struct osl_object
*result
);
184 int stdin_command(int fd
, struct osl_object
*arg_obj
, callback_function
*f
,
185 unsigned max_len
, struct osl_object
*result
);
186 int string_compare(const struct osl_object
*obj1
, const struct osl_object
*obj2
);
187 int for_each_matching_row(struct pattern_match_data
*pmd
);
190 void score_init(struct afs_table
*t
);
191 int admissible_file_loop(void *data
, osl_rbtree_loop_func
*func
);
192 int admissible_file_loop_reverse(void *data
, osl_rbtree_loop_func
*func
);
193 int score_get_best(struct osl_row
**aft_row
, long *score
);
194 int get_score_and_aft_row(struct osl_row
*score_row
, long *score
, struct osl_row
**aft_row
);
195 int score_add(const struct osl_row
*row
, long score
);
196 int score_update(const struct osl_row
*aft_row
, long new_score
);
197 int get_num_admissible_files(unsigned *num
);
198 int score_delete(const struct osl_row
*aft_row
);
199 int clear_score_table(void);
200 int row_belongs_to_score_table(const struct osl_row
*aft_row
, unsigned *rank
);
203 void attribute_init(struct afs_table
*t
);
204 void get_attribute_bitmap(const uint64_t *atts
, char *buf
); /* needed by com_ls() */
205 int get_attribute_bitnum_by_name(const char *att_name
, unsigned char *bitnum
);
206 int get_attribute_text(uint64_t *atts
, const char *delim
, char **text
);
209 void aft_init(struct afs_table
*t
);
210 int aft_get_row_of_path(const char *path
, struct osl_row
**row
);
211 int open_and_update_audio_file(struct osl_row
*aft_row
, long score
,
212 struct audio_file_data
*afd
);
213 int load_afd(int shmid
, struct audio_file_data
*afd
);
214 int load_afsi(struct afs_info
*afsi
, struct osl_object
*obj
);
215 void save_afsi(struct afs_info
*afsi
, struct osl_object
*obj
);
216 int get_afsi_of_row(const struct osl_row
*row
, struct afs_info
*afsi
);
217 int get_afhi_of_row(const struct osl_row
*row
, struct afh_info
*afhi
);
218 int get_afsi_of_path(const char *path
, struct afs_info
*afsi
);
219 int get_audio_file_path_of_row(const struct osl_row
*row
, char **path
);
220 int get_afsi_object_of_row(const struct osl_row
*row
, struct osl_object
*obj
);
221 int audio_file_loop(void *private_data
, osl_rbtree_loop_func
*func
);
222 int aft_check_callback(const struct osl_object
*query
, struct osl_object
*result
);
225 int change_current_mood(char *mood_name
);
226 void close_current_mood(void);
227 int reload_current_mood(void);
228 int mood_check_callback(__a_unused
const struct osl_object
*query
,
229 struct osl_object
*result
);
233 int playlist_open(char *name
);
234 void playlist_close(void);
235 int playlist_check_callback(__a_unused
const struct osl_object
*query
,
236 struct osl_object
*result
);
238 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
239 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
242 /** Define exported functions and a table pointer for an osl blob table. */
243 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
244 void table_name ## _init(struct afs_table *t); \
245 int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
246 int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
247 int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def); \
248 int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
249 char **name, struct osl_object *def); \
250 int table_name ##_event_handler(enum afs_events event, \
251 struct para_buffer *pb, void *data); \
252 extern struct osl_table *table_name ## _table;
254 DECLARE_BLOB_SYMBOLS(lyrics
, lyr
);
255 DECLARE_BLOB_SYMBOLS(images
, img
);
256 DECLARE_BLOB_SYMBOLS(moods
, mood
);
257 DECLARE_BLOB_SYMBOLS(playlists
, pl
);
259 /** The columns of an abstract blob table. */
260 enum blob_table_columns
{
261 /** The identifier, a positive integer that never repeats. */
263 /** The unique name of the blob. */
265 /** The actual blob contents. */
267 /** A blob table has that many columns. */
271 /** Define an osl table description for a blob table. */
272 #define DEFINE_BLOB_TABLE_DESC(table_name) \
273 struct osl_table_description table_name ## _table_desc = { \
274 .name = #table_name, \
275 .num_columns = NUM_BLOB_COLUMNS, \
276 .flags = OSL_LARGE_TABLE, \
277 .column_descriptions = blob_cols \
280 /** Define a pointer to an osl blob table with a canonical name. */
281 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
283 /** Define a blob table. */
284 #define INIT_BLOB_TABLE(table_name) \
285 DEFINE_BLOB_TABLE_DESC(table_name); \
286 DEFINE_BLOB_TABLE_PTR(table_name);