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. */
12 /** Audio file selector data stored in the audio file table. */
14 /** Seconds since the epoch. */
16 /** Bit field of set attributes. */
18 /** Counts how many times the file was selected. */
20 /** Image blob associated with this file (foreign key). */
22 /** Lyrics blob associated with this file (foreign key). */
24 /** Mp3, ogg or aac. */
25 uint8_t audio_format_id
;
26 /** Amplification value. */
31 * Events caused by changes to an afs table.
33 * Whenever an afs table changes, an event is generated which causes afs to
34 * call the event handlers of all other tables. For example, if an audio file
35 * is added, the event handler of the mood table checks the new file for
39 /** An attribute was added. */
41 /** An attribute was renamed. */
43 /** An attribute was removed. */
45 /** The afs info struct of an audio file changed. */
47 /** The afh info struct of an audio file changed. */
49 /** An audio file was renamed. */
51 /** An audio file was added. */
53 /** An audio file is about to be removed. */
55 /** A new blob was added. */
57 /** A blob was renamed. */
59 /** A blob is about to be removed. */
64 * Used as data for \ref afs_event() for events of type \p ATTRIBUTE_ADD.
66 struct rmatt_event_data
{
67 /** The name of the attribute being added. */
69 /** Its bit number. */
74 * Used as data for \ref afs_event() for events of type \p ATTRIBUTE_AFSI_CHANGE.
76 struct afsi_change_event_data
{
77 /** Pointer to the row that has changed. */
78 struct osl_row
*aft_row
;
79 /** Afs info before the change. */
80 struct afs_info
*old_afsi
;
83 /** Function pointers for table handling. */
85 /** Initializes the other pointers in this struct. */
86 void (*init
)(struct afs_table
*t
);
87 /** The name of this table. */
89 /** Gets called on startup and on \p SIGHUP. */
90 int (*open
)(const char *base_dir
);
91 /** Gets called on shutdown and on \p SIGHUP. */
93 /** Called by the \a init afs command. */
94 int (*create
)(const char *);
95 /** Handles afs events. */
96 int (*event_handler
)(enum afs_events event
, struct para_buffer
*pb
,
100 enum play_mode
{PLAY_MODE_MOOD
, PLAY_MODE_PLAYLIST
};
103 * Data about one audio file.
105 * Needed to produce ls and stat output.
108 /** Usual audio format handler information. */
109 struct afh_info afhi
;
110 /** Audio file selector information. */
111 struct afs_info afsi
;
112 /** The full path of the audio file. */
114 /** The score value (if -a was given). */
116 /** The sha1 hash of audio file. */
120 /** Data about the current audio file, passed from afs to server. */
121 struct audio_file_data
{
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 void callback_function(int fd
, const struct osl_object
*);
176 * Callbacks send chunks to data back to the command handler. Pointers to
177 * this type of function are used by \ref send_callback_request and friends
178 * to deal with the data in the command handler process.
180 * \sa \ref send_callback_request().
182 typedef int callback_result_handler(struct osl_object
*result
, void *private);
183 int rc4_send_result(struct osl_object
*result
, void *private);
184 int pass_buffer_as_shm(char *buf
, size_t size
, void *fd_ptr
);
186 __noreturn
void afs_init(uint32_t cookie
, int socket_fd
);
187 void afs_event(enum afs_events event
, struct para_buffer
*pb
,
189 int send_callback_request(callback_function
*f
, struct osl_object
*query
,
190 callback_result_handler
*result_handler
,
191 void *private_result_data
);
192 int send_option_arg_callback_request(struct osl_object
*options
,
193 int argc
, char * const * const argv
, callback_function
*f
,
194 callback_result_handler
*result_handler
,
195 void *private_result_data
);
196 int send_standard_callback_request(int argc
, char * const * const argv
,
197 callback_function
*f
, callback_result_handler
*result_handler
,
198 void *private_result_data
);
199 int string_compare(const struct osl_object
*obj1
, const struct osl_object
*obj2
);
200 int for_each_matching_row(struct pattern_match_data
*pmd
);
203 void score_init(struct afs_table
*t
);
204 int admissible_file_loop(void *data
, osl_rbtree_loop_func
*func
);
205 int admissible_file_loop_reverse(void *data
, osl_rbtree_loop_func
*func
);
206 int score_get_best(struct osl_row
**aft_row
, long *score
);
207 int get_score_and_aft_row(struct osl_row
*score_row
, long *score
, struct osl_row
**aft_row
);
208 int score_add(const struct osl_row
*row
, long score
);
209 int score_update(const struct osl_row
*aft_row
, long new_score
);
210 int get_num_admissible_files(unsigned *num
);
211 int score_delete(const struct osl_row
*aft_row
);
212 int clear_score_table(void);
213 int row_belongs_to_score_table(const struct osl_row
*aft_row
, unsigned *rank
);
216 void attribute_init(struct afs_table
*t
);
217 void get_attribute_bitmap(const uint64_t *atts
, char *buf
); /* needed by com_ls() */
218 int get_attribute_bitnum_by_name(const char *att_name
, unsigned char *bitnum
);
219 int get_attribute_text(uint64_t *atts
, const char *delim
, char **text
);
222 void aft_init(struct afs_table
*t
);
223 int aft_get_row_of_path(const char *path
, struct osl_row
**row
);
224 int open_and_update_audio_file(struct osl_row
*aft_row
, long score
,
225 struct audio_file_data
*afd
);
226 int load_afd(int shmid
, struct audio_file_data
*afd
);
227 int load_afsi(struct afs_info
*afsi
, struct osl_object
*obj
);
228 void save_afsi(struct afs_info
*afsi
, struct osl_object
*obj
);
229 int get_afsi_of_row(const struct osl_row
*row
, struct afs_info
*afsi
);
230 int get_afhi_of_row(const struct osl_row
*row
, struct afh_info
*afhi
);
231 int get_afsi_of_path(const char *path
, struct afs_info
*afsi
);
232 int get_audio_file_path_of_row(const struct osl_row
*row
, char **path
);
233 int get_afsi_object_of_row(const struct osl_row
*row
, struct osl_object
*obj
);
234 int audio_file_loop(void *private_data
, osl_rbtree_loop_func
*func
);
235 void aft_check_callback(int fd
, __a_unused
const struct osl_object
*query
);
238 int playlist_open(char *name
);
239 void playlist_close(void);
240 void playlist_check_callback(int fd
, __a_unused
const struct osl_object
*query
);
242 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
243 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
246 /** Define exported functions and a table pointer for an osl blob table. */
247 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
248 void table_name ## _init(struct afs_table *t); \
249 int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
250 int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
251 int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def); \
252 int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
253 char **name, struct osl_object *def); \
254 int table_name ##_event_handler(enum afs_events event, \
255 struct para_buffer *pb, void *data); \
256 extern struct osl_table *table_name ## _table;
258 DECLARE_BLOB_SYMBOLS(lyrics
, lyr
);
259 DECLARE_BLOB_SYMBOLS(images
, img
);
260 DECLARE_BLOB_SYMBOLS(moods
, mood
);
261 DECLARE_BLOB_SYMBOLS(playlists
, pl
);
263 /** The columns of an abstract blob table. */
264 enum blob_table_columns
{
265 /** The identifier, a positive integer that never repeats. */
267 /** The unique name of the blob. */
269 /** The actual blob contents. */
271 /** A blob table has that many columns. */