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 symbos 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
;
44 struct rmatt_event_data
{
50 struct addatt_event_data
{
55 struct afsi_change_event_data
{
56 const struct osl_row
*aft_row
;
57 struct afs_info
*old_afsi
;
61 void (*init
)(struct afs_table
*t
);
63 int (*open
)(const char *base_dir
);
65 int (*create
)(const char *);
66 int (*event_handler
)(enum afs_events event
, struct para_buffer
*pb
,
71 enum play_mode
{PLAY_MODE_MOOD
, PLAY_MODE_PLAYLIST
};
73 struct audio_file_data
{
74 enum play_mode current_play_mode
;
77 struct audio_format_info afhi
;
79 struct osl_object map
;
82 /** Flags passed to for_each_matching_row(). */
83 enum pattern_match_flags
{
84 /** Loop in reverse order. */
86 /** If no pattern is given, loop over all rows. */
87 PM_NO_PATTERN_MATCHES_EVERYTHING
= 2,
88 /** If the data in match_column is the empty string, skip this row. */
89 PM_SKIP_EMPTY_NAME
= 4,
92 /** Structure passed to for_each_matching_row(). */
93 struct pattern_match_data
{
94 /** Loop over all rows in this table. */
95 struct osl_table
*table
;
96 /** Determines the loop order. Must be an rbtree column. */
97 unsigned loop_col_num
;
98 /** Data from this column is matched against the given patterns. */
99 unsigned match_col_num
;
100 /** \see pattern_match_flags. */
102 /** This value is passed verbatim to fnmatch(). */
104 /** Null-terminated array of patterns. */
105 struct osl_object patterns
;
106 /** Data pointer passed to the action function. */
108 /** For each matching row, this function will be called. */
109 int (*action
)(struct osl_table
*table
, struct osl_row
*row
, const char *name
, void *data
);
113 typedef int callback_function(const struct osl_object
*, struct osl_object
*);
114 __noreturn
void afs_init(uint32_t cookie
, int socket_fd
);
115 void afs_event(enum afs_events event
, struct para_buffer
*pb
,
117 int send_callback_request(callback_function
*f
, struct osl_object
*query
,
118 struct osl_object
*result
);
119 int send_standard_callback_request(int argc
, char * const * const argv
,
120 callback_function
*f
, struct osl_object
*result
);
121 int send_option_arg_callback_request(struct osl_object
*options
,
122 int argc
, char * const * const argv
, callback_function
*f
,
123 struct osl_object
*result
);
124 int stdin_command(int fd
, struct osl_object
*arg_obj
, callback_function
*f
,
125 unsigned max_len
, struct osl_object
*result
);
126 int string_compare(const struct osl_object
*obj1
, const struct osl_object
*obj2
);
127 int open_next_audio_file(struct audio_file_data
*afd
);
128 int close_audio_file(struct audio_file_data
*afd
);
129 int for_each_matching_row(struct pattern_match_data
*pmd
);
132 void score_init(struct afs_table
*t
);
133 int admissible_file_loop(void *data
, osl_rbtree_loop_func
*func
);
134 int admissible_file_loop_reverse(void *data
, osl_rbtree_loop_func
*func
);
135 int score_get_best(struct osl_row
**aft_row
, long *score
);
136 int get_score_and_aft_row(struct osl_row
*score_row
, long *score
, struct osl_row
**aft_row
);
137 int score_add(const struct osl_row
*row
, long score
);
138 int score_update(const struct osl_row
*aft_row
, long new_score
);
139 int get_num_admissible_files(unsigned *num
);
140 int score_delete(const struct osl_row
*aft_row
);
141 int clear_score_table(void);
142 int row_belongs_to_score_table(const struct osl_row
*aft_row
, unsigned *rank
);
145 void attribute_init(struct afs_table
*t
);
146 void get_attribute_bitmap(const uint64_t *atts
, char *buf
); /* needed by com_ls() */
147 int get_attribute_bitnum_by_name(const char *att_name
, unsigned char *bitnum
);
148 int get_attribute_text(uint64_t *atts
, const char *delim
, char **text
);
151 void aft_init(struct afs_table
*t
);
152 int aft_get_row_of_path(const char *path
, struct osl_row
**row
);
153 int open_and_update_audio_file(struct osl_row
*aft_row
, struct audio_file_data
*afd
);
154 int load_afsi(struct afs_info
*afsi
, struct osl_object
*obj
);
155 void save_afsi(struct afs_info
*afsi
, struct osl_object
*obj
);
156 int get_afsi_of_row(const struct osl_row
*row
, struct afs_info
*afsi
);
157 int get_afhi_of_row(const struct osl_row
*row
, struct audio_format_info
*afhi
);
158 int get_afsi_of_path(const char *path
, struct afs_info
*afsi
);
159 int get_audio_file_path_of_row(const struct osl_row
*row
, char **path
);
160 int get_afsi_object_of_row(const struct osl_row
*row
, struct osl_object
*obj
);
161 int audio_file_loop(void *private_data
, osl_rbtree_loop_func
*func
);
162 int aft_check_callback(const struct osl_object
*query
, struct osl_object
*result
);
165 int change_current_mood(char *mood_name
);
166 int reload_current_mood(void);
167 int mood_check_callback(__a_unused
const struct osl_object
*query
,
168 struct osl_object
*result
);
172 int playlist_open(char *name
);
173 int playlist_update_audio_file(struct osl_row
*aft_row
);
174 int playlist_check_callback(__a_unused
const struct osl_object
*query
,
175 struct osl_object
*result
);
177 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
178 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
181 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
182 void table_name ## _init(struct afs_table *t); \
183 int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
184 int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
185 int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def); \
186 int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
187 char **name, struct osl_object *def); \
188 int table_name ##_event_handler(enum afs_events event, \
189 struct para_buffer *pb, void *data); \
190 extern struct osl_table *table_name ## _table;
192 DECLARE_BLOB_SYMBOLS(lyrics
, lyr
);
193 DECLARE_BLOB_SYMBOLS(images
, img
);
194 DECLARE_BLOB_SYMBOLS(moods
, mood
);
195 DECLARE_BLOB_SYMBOLS(playlists
, pl
);
197 /** The columns of an abstract blob table. */
198 enum blob_table_columns
{
199 /** The identifier, a positive integer that never repeats. */
201 /** The unique name of the blob. */
203 /** The actual blob contents. */
205 /** A blob table has that many columns. */
209 #define DEFINE_BLOB_TABLE_DESC(table_name) \
210 struct osl_table_description table_name ## _table_desc = { \
211 .name = #table_name, \
212 .num_columns = NUM_BLOB_COLUMNS, \
213 .flags = OSL_LARGE_TABLE, \
214 .column_descriptions = blob_cols \
217 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
219 #define INIT_BLOB_TABLE(table_name) \
220 DEFINE_BLOB_TABLE_DESC(table_name); \
221 DEFINE_BLOB_TABLE_PTR(table_name);