afs.h

   1 /*
   2  * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file afs.h Exported symbols of the audio file selector. */
   8
   9 #include <regex.h>
  10 #include "osl.h"
  11 #include "hash.h"
  12
  13 /** Audio file selector data stored in the audio file table. */
  14 struct afs_info {
  15         /** Seconds since the epoch. */
  16         uint64_t last_played;
  17         /** Bit field of set attributes. */
  18         uint64_t attributes;
  19         /** Counts how many times the file was selected. */
  20         uint32_t num_played;
  21         /** Image blob associated with this file (foreign key). */
  22         uint32_t image_id;
  23         /** Lyrics blob associated with this file (foreign key). */
  24         uint32_t lyrics_id;
  25         /** Mp3, ogg or aac. */
  26         uint8_t audio_format_id;
  27 };
  28
  29 /**
  30  * Events caused by changes to an afs table.
  31  *
  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
  35  * admissibility.
  36  */
  37 enum afs_events {
  38         /** An attribute was added. */
  39         ATTRIBUTE_ADD,
  40         /** An attribute was renamed. */
  41         ATTRIBUTE_RENAME,
  42         /** An attribute was removed. */
  43         ATTRIBUTE_REMOVE,
  44         /** The afs info struct of an audio file changed. */
  45         AFSI_CHANGE,
  46         /** The afh info struct of an audio file changed. */
  47         AFHI_CHANGE,
  48         /** An audio file was renamed. */
  49         AUDIO_FILE_RENAME,
  50         /** An audio file was added. */
  51         AUDIO_FILE_ADD,
  52         /** An audio file is about to be removed. */
  53         AUDIO_FILE_REMOVE,
  54         /** A new blob was added. */
  55         BLOB_ADD,
  56         /** A blob was renamed. */
  57         BLOB_RENAME,
  58         /** A blob is about to be removed. */
  59         BLOB_REMOVE,
  60 };
  61
  62 struct rmatt_event_data {
  63         const char *name;
  64         unsigned char bitnum;
  65 };
  66
  67
  68 struct addatt_event_data {
  69         const char *name;
  70         unsigned char bitnum;
  71 };
  72
  73 struct afsi_change_event_data {
  74         const struct osl_row *aft_row;
  75         struct afs_info *old_afsi;
  76 };
  77
  78 /** Function pointers for table handling.  */
  79 struct afs_table {
  80         /** Initializes the other pointers in this struct. */
  81         void (*init)(struct afs_table *t);
  82         /** The name of this table. */
  83         const char *name;
  84         /** Gets called on startup and on \p SIGHUP. */
  85         int (*open)(const char *base_dir);
  86         /** Gets called on shutdown and on \p SIGHUP. */
  87         void (*close)(void);
  88         /** Called by the \a init afs command. */
  89         int (*create)(const char *);
  90         /** Handles afs events. */
  91         int (*event_handler)(enum afs_events event, struct para_buffer *pb,
  92                 void *data);
  93         /* int *(check)() */
  94 };
  95
  96 enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
  97
  98 struct audio_file_data {
  99         enum play_mode current_play_mode;
 100         char attributes_string[MAXLINE];
 101         char path[_POSIX_PATH_MAX];
 102         int fd;
 103         long score;
 104         struct afs_info afsi;
 105         struct audio_format_info afhi;
 106 };
 107
 108 enum afs_server_code {
 109         NEXT_AUDIO_FILE,
 110         AFD_CHANGE
 111 };
 112
 113 /** Flags passed to for_each_matching_row(). */
 114 enum pattern_match_flags {
 115         /** Loop in reverse order. */
 116         PM_REVERSE_LOOP = 1,
 117         /** If no pattern is given, loop over all rows. */
 118         PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
 119         /** If the data in match_column is the empty string, skip this row. */
 120         PM_SKIP_EMPTY_NAME = 4,
 121 };
 122
 123 /** Structure passed to for_each_matching_row(). */
 124 struct pattern_match_data {
 125         /** Loop over all rows in this table. */
 126         struct osl_table *table;
 127         /** Determines the loop order. Must be an rbtree column. */
 128         unsigned loop_col_num;
 129         /** Data from this column is matched against the given patterns. */
 130         unsigned match_col_num;
 131         /** \see pattern_match_flags. */
 132         unsigned pm_flags;
 133         /** This value is passed verbatim to fnmatch(). */
 134         int fnmatch_flags;
 135         /** Null-terminated array of patterns. */
 136         struct osl_object patterns;
 137         /** Data pointer passed to the action function. */
 138         void *data;
 139         /** For each matching row, this function will be called. */
 140         int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
 141 };
 142
 143 /* afs */
 144 typedef int callback_function(const struct osl_object *, struct osl_object *);
 145 __noreturn void afs_init(uint32_t cookie, int socket_fd);
 146 void afs_event(enum afs_events event, struct para_buffer *pb,
 147         void *data);
 148 int send_callback_request(callback_function *f, struct osl_object *query,
 149         struct osl_object *result);
 150 int send_standard_callback_request(int argc, char * const * const argv,
 151                 callback_function *f, struct osl_object *result);
 152 int send_option_arg_callback_request(struct osl_object *options,
 153         int argc, char * const * const argv, callback_function *f,
 154         struct osl_object *result);
 155 int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f,
 156                 unsigned max_len, struct osl_object *result);
 157 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
 158 int close_audio_file(struct audio_file_data *afd);
 159 int for_each_matching_row(struct pattern_match_data *pmd);
 160
 161 /* score */
 162 void score_init(struct afs_table *t);
 163 int admissible_file_loop(void *data, osl_rbtree_loop_func *func);
 164 int admissible_file_loop_reverse(void *data, osl_rbtree_loop_func *func);
 165 int score_get_best(struct osl_row **aft_row, long *score);
 166 int get_score_and_aft_row(struct osl_row *score_row, long *score, struct osl_row **aft_row);
 167 int score_add(const struct osl_row *row, long score);
 168 int score_update(const struct osl_row *aft_row, long new_score);
 169 int get_num_admissible_files(unsigned *num);
 170 int score_delete(const struct osl_row *aft_row);
 171 int clear_score_table(void);
 172 int row_belongs_to_score_table(const struct osl_row *aft_row, unsigned *rank);
 173
 174 /* attribute */
 175 void attribute_init(struct afs_table *t);
 176 void get_attribute_bitmap(const uint64_t *atts, char *buf); /* needed by com_ls() */
 177 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum);
 178 int get_attribute_text(uint64_t *atts, const char *delim, char **text);
 179
 180 /* aft */
 181 void aft_init(struct afs_table *t);
 182 int aft_get_row_of_path(const char *path, struct osl_row **row);
 183 int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *afd);
 184 int load_afd(int shmid, struct audio_file_data *afd);
 185 int load_afsi(struct afs_info *afsi, struct osl_object *obj);
 186 void save_afsi(struct afs_info *afsi, struct osl_object *obj);
 187 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
 188 int get_afhi_of_row(const struct osl_row *row, struct audio_format_info *afhi);
 189 int get_afsi_of_path(const char *path, struct afs_info *afsi);
 190 int get_audio_file_path_of_row(const struct osl_row *row, char **path);
 191 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj);
 192 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
 193 int aft_check_callback(const struct osl_object *query, struct osl_object *result);
 194
 195 /* mood */
 196 int change_current_mood(char *mood_name);
 197 void close_current_mood(void);
 198 int reload_current_mood(void);
 199 int mood_check_callback(__a_unused const struct osl_object *query,
 200         struct osl_object *result);
 201
 202
 203 /* playlist */
 204 int playlist_open(char *name);
 205 void playlist_close(void);
 206 int playlist_update_audio_file(struct osl_row *aft_row);
 207 int playlist_check_callback(__a_unused const struct osl_object *query,
 208         struct osl_object *result);
 209
 210 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
 211 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
 212
 213
 214 /** Define exported functions and a table pointer for an osl blob table. */
 215 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
 216         void table_name ## _init(struct afs_table *t); \
 217         int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
 218         int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
 219         int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def); \
 220         int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
 221                 char **name, struct osl_object *def); \
 222         int table_name ##_event_handler(enum afs_events event, \
 223                 struct para_buffer *pb, void *data); \
 224         extern struct osl_table *table_name ## _table;
 225
 226 DECLARE_BLOB_SYMBOLS(lyrics, lyr);
 227 DECLARE_BLOB_SYMBOLS(images, img);
 228 DECLARE_BLOB_SYMBOLS(moods, mood);
 229 DECLARE_BLOB_SYMBOLS(playlists, pl);
 230
 231 /** The columns of an abstract blob table. */
 232 enum blob_table_columns {
 233         /** The identifier, a positive integer that never repeats. */
 234         BLOBCOL_ID,
 235         /** The unique name of the blob. */
 236         BLOBCOL_NAME,
 237         /** The actual blob contents. */
 238         BLOBCOL_DEF,
 239         /** A blob table has that many columns. */
 240         NUM_BLOB_COLUMNS
 241 };
 242
 243 /** Define an osl table decription for a blob table. */
 244 #define DEFINE_BLOB_TABLE_DESC(table_name) \
 245         struct osl_table_description table_name ## _table_desc = { \
 246                 .name = #table_name, \
 247                 .num_columns = NUM_BLOB_COLUMNS, \
 248                 .flags = OSL_LARGE_TABLE, \
 249                 .column_descriptions = blob_cols \
 250         };
 251
 252 /** Define a pointer to an osl blob table with a canonical name. */
 253 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
 254
 255 /** Define a blob table. */
 256 #define INIT_BLOB_TABLE(table_name) \
 257         DEFINE_BLOB_TABLE_DESC(table_name); \
 258         DEFINE_BLOB_TABLE_PTR(table_name);
 259