afs: Replace DATABASE_DIR by a runtime config option.
[paraslash.git] / afs.h
1 #include <regex.h>
2 #include "osl.h"
3 #include "hash.h"
4
5 struct afs_info {
6 uint64_t last_played;
7 uint64_t attributes;
8 uint32_t num_played;
9 uint32_t image_id;
10 uint32_t lyrics_id;
11 uint8_t audio_format_id;
12 };
13
14 enum afs_table_flags {TBLFLAG_SKIP_CREATE};
15
16 struct table_info {
17 const struct osl_table_description *desc;
18 struct osl_table *table;
19 enum afs_table_flags flags;
20 };
21
22 enum ls_sorting_method {
23 LS_SORT_BY_PATH, /* -sp (default) */
24 LS_SORT_BY_SCORE, /* -ss */
25 LS_SORT_BY_LAST_PLAYED, /* -sl */
26 LS_SORT_BY_NUM_PLAYED, /* -sn */
27 LS_SORT_BY_FREQUENCY, /* -sf */
28 LS_SORT_BY_CHANNELS, /* -sc */
29 LS_SORT_BY_IMAGE_ID, /* -si */
30 LS_SORT_BY_LYRICS_ID, /* -sy */
31 LS_SORT_BY_BITRATE, /* -sb */
32 LS_SORT_BY_DURATION, /* -sd */
33 LS_SORT_BY_AUDIO_FORMAT, /* -sa */
34 LS_SORT_BY_HASH, /* -sh */
35 };
36
37 enum ls_listing_mode {
38 LS_MODE_SHORT,
39 LS_MODE_LONG,
40 LS_MODE_VERBOSE,
41 LS_MODE_MBOX
42 };
43
44 enum ls_flags {
45 LS_FLAG_FULL_PATH = 1,
46 LS_FLAG_ADMISSIBLE_ONLY = 2,
47 LS_FLAG_REVERSE = 4,
48 };
49
50 struct ls_widths {
51 unsigned short score_width;
52 unsigned short image_id_width;
53 unsigned short lyrics_id_width;
54 unsigned short bitrate_width;
55 unsigned short frequency_width;
56 unsigned short duration_width;
57 unsigned short num_played_width;
58 };
59
60 struct ls_data {
61 struct audio_format_info afhi;
62 struct afs_info afsi;
63 char *path;
64 long score;
65 HASH_TYPE *hash;
66 };
67
68 struct ls_options {
69 unsigned flags;
70 enum ls_sorting_method sorting;
71 enum ls_listing_mode mode;
72 char **patterns;
73 int num_patterns;
74 struct ls_widths widths;
75 uint32_t array_size;
76 uint32_t num_matching_paths;
77 struct ls_data *data;
78 struct ls_data **data_ptr;
79 };
80
81 enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
82
83 struct audio_file_data {
84 enum play_mode current_play_mode;
85 long score;
86 struct afs_info afsi;
87 struct audio_format_info afhi;
88 char *path;
89 struct osl_object map;
90 };
91
92 /* afs */
93 typedef int callback_function(const struct osl_object *, struct osl_object *);
94 __noreturn int afs_init(uint32_t cookie, int socket_fd);
95 int send_callback_request(callback_function *f, struct osl_object *query,
96 struct osl_object *result);
97 int send_standard_callback_request(int argc, char * const * const argv,
98 callback_function *f, struct osl_object *result);
99 int send_option_arg_callback_request(struct osl_object *options,
100 int argc, char * const * const argv, callback_function *f,
101 struct osl_object *result);
102 int stdin_command(struct osl_object *arg_obj, callback_function *f,
103 unsigned max_len, struct osl_object *result);
104 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
105 int para_atol(const char *str, long *result);
106 int open_next_audio_file(struct audio_file_data *afd);
107 int close_audio_file(struct audio_file_data *afd);
108
109 /* score */
110 int score_init(struct table_info *ti, const char *db);
111 void score_shutdown(enum osl_close_flags flags);
112 int admissible_file_loop(void *data, osl_rbtree_loop_func *func);
113 int admissible_file_loop_reverse(void *data, osl_rbtree_loop_func *func);
114 int score_get_best(struct osl_row **aft_row, long *score);
115 int get_score_and_aft_row(struct osl_row *score_row, long *score, struct osl_row **aft_row);
116 int score_add(const struct osl_row *row, long score);
117 int score_update(const struct osl_row *aft_row, long new_score);
118 int get_num_admissible_files(unsigned *num);
119 int score_delete(const struct osl_row *aft_row);
120 int row_belongs_to_score_table(const struct osl_row *aft_row);
121
122 /* attribute */
123 int attribute_init(struct table_info *ti, const char *db);
124 void attribute_shutdown(enum osl_close_flags flags);
125 void get_attribute_bitmap(uint64_t *atts, char *buf);
126 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum);
127 int get_attribute_text(uint64_t *atts, const char *delim, char **text);
128
129 /* aft */
130 int aft_init(struct table_info *ti, const char *db);
131 void aft_shutdown(enum osl_close_flags flags);
132 int aft_get_row_of_path(char *path, struct osl_row **row);
133 int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *afd);
134 int load_afsi(struct afs_info *afsi, struct osl_object *obj);
135 void save_afsi(struct afs_info *afsi, struct osl_object *obj);
136 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
137 int get_audio_file_path_of_row(const struct osl_row *row, char **path);
138 int get_afsi_object_of_row(const void *row, struct osl_object *obj);
139 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
140
141 /* mood */
142 int mood_open(char *mood_name);
143 void mood_close(void);
144 int mood_update_audio_file(const struct osl_row *aft_row, struct afs_info *old_afsi);
145 int mood_reload(void);
146 int mood_delete_audio_file(const struct osl_row *aft_row);
147
148
149 /* playlist */
150 int playlist_open(char *name);
151 void playlist_close(void);
152 int playlist_update_audio_file(struct osl_row *aft_row);
153
154 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
155 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
156
157
158 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
159 int table_name ## _init(struct table_info *ti, const char *db); \
160 void table_name ## _shutdown(enum osl_close_flags flags); \
161 int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
162 extern struct osl_table *table_name ## _table;
163
164 DECLARE_BLOB_SYMBOLS(lyrics, lyr);
165 DECLARE_BLOB_SYMBOLS(images, img);
166 DECLARE_BLOB_SYMBOLS(moods, mood);
167 DECLARE_BLOB_SYMBOLS(playlists, pl);
168
169 enum blob_table_columns {BLOBCOL_ID, BLOBCOL_NAME, BLOBCOL_DEF, NUM_BLOB_COLUMNS};
170 #define DEFINE_BLOB_TABLE_DESC(table_name) \
171 struct osl_table_description table_name ## _table_desc = { \
172 .name = #table_name, \
173 .num_columns = NUM_BLOB_COLUMNS, \
174 .flags = OSL_LARGE_TABLE, \
175 .column_descriptions = blob_cols \
176 };
177
178 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
179
180 #define INIT_BLOB_TABLE(table_name) \
181 DEFINE_BLOB_TABLE_DESC(table_name); \
182 DEFINE_BLOB_TABLE_PTR(table_name);
183