afs.h

   1 /*
   2  * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
   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
  11 /** Audio file selector data stored in the audio file table. */
  12 struct afs_info {
  13         /** Seconds since the epoch. */
  14         uint64_t last_played;
  15         /** Bit field of set attributes. */
  16         uint64_t attributes;
  17         /** Counts how many times the file was selected. */
  18         uint32_t num_played;
  19         /** Image blob associated with this file (foreign key). */
  20         uint32_t image_id;
  21         /** Lyrics blob associated with this file (foreign key). */
  22         uint32_t lyrics_id;
  23         /** Mp3, ogg, ... */
  24         uint8_t audio_format_id;
  25         /** Amplification value. */
  26         uint8_t amp;
  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 /**
  63  * Used as data for \ref afs_event() for events of type \p ATTRIBUTE_ADD.
  64  */
  65 struct rmatt_event_data {
  66         /** The name of the attribute being added. */
  67         const char *name;
  68         /** Its bit number. */
  69         unsigned char bitnum;
  70 };
  71
  72 /**
  73  * Used as data for \ref afs_event() for events of type \p ATTRIBUTE_AFSI_CHANGE.
  74  */
  75 struct afsi_change_event_data {
  76         /** Pointer to the row that has changed. */
  77         struct osl_row *aft_row;
  78         /** Afs info before the change. */
  79         struct afs_info *old_afsi;
  80 };
  81
  82 /** Function pointers for table handling.  */
  83 struct afs_table {
  84         /** Initializes the other pointers in this struct. */
  85         void (*init)(struct afs_table *t);
  86         /** The name of this table. */
  87         const char *name;
  88         /** Gets called on startup and on \p SIGHUP. */
  89         int (*open)(const char *base_dir);
  90         /** Gets called on shutdown and on \p SIGHUP. */
  91         void (*close)(void);
  92         /** Called by the \a init afs command. */
  93         int (*create)(const char *);
  94         /** Handles afs events. */
  95         int (*event_handler)(enum afs_events event, struct para_buffer *pb,
  96                 void *data);
  97 };
  98
  99 /** How audio files are selected by afs. */
 100 enum play_mode {
 101         /** Admissible files are determined by a mood definition. */
 102         PLAY_MODE_MOOD,
 103         /** All listed files are admissible. */
 104         PLAY_MODE_PLAYLIST,
 105 };
 106
 107 /**
 108  * Codes used for communication between the server and the afs process.
 109  *
 110  * Before forking the afs child, para_server creates a bidirectional pipe
 111  * through which both processes communicate. Usually para_server requests a new
 112  * audio file in order to start streaming or when the end of the current audio file
 113  * has been reached.  The afs process responds to such a request by sending
 114  * back an eight byte buffer. The first four bytes is the uint32_t
 115  * representation of the code, usually \p NEXT_AUDIO_FILE if an admissible
 116  * audio file was found, successfully opened and verified. The other four bytes
 117  * represent the shared memory id of the shared memory area that contains
 118  * details about the audio file to be streamed next. The open file descriptor
 119  * of that file is also passed from afs to para_server through the same pipe.
 120  */
 121 enum afs_server_code {
 122         /** An audio file was successfully opened. */
 123         NEXT_AUDIO_FILE,
 124         /** No admissible audio file was found. */
 125         NO_ADMISSIBLE_FILES,
 126 };
 127
 128 /** Flags passed to for_each_matching_row(). */
 129 enum pattern_match_flags {
 130         /** Loop in reverse order. */
 131         PM_REVERSE_LOOP = 1,
 132         /** If no pattern is given, loop over all rows. */
 133         PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
 134         /** If the data in match_column is the empty string, skip this row. */
 135         PM_SKIP_EMPTY_NAME = 4,
 136 };
 137
 138 /** Structure passed to for_each_matching_row(). */
 139 struct pattern_match_data {
 140         /** Loop over all rows in this table. */
 141         struct osl_table *table;
 142         /** Determines the loop order. Must be an rbtree column. */
 143         unsigned loop_col_num;
 144         /** Data from this column is matched against the given patterns. */
 145         unsigned match_col_num;
 146         /** \see pattern_match_flags. */
 147         unsigned pm_flags;
 148         /** This value is passed verbatim to fnmatch(). */
 149         int fnmatch_flags;
 150         /** Null-terminated array of patterns. */
 151         struct osl_object patterns;
 152         /** Data pointer passed to the action function. */
 153         void *data;
 154         /** Gets increased by one for each match. */
 155         unsigned num_matches;
 156         /** For each matching row, this function will be called. */
 157         int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
 158 };
 159
 160 /** Arguments passed to each afs callback. */
 161 struct afs_callback_arg {
 162         /** The local socket connecting afs and the command handler. */
 163         int fd;
 164         /** Callback-specific data. */
 165         struct osl_object query;
 166         /** Will be written on band SBD_OUTPUT, fully buffered. */
 167         struct para_buffer pbout;
 168 };
 169
 170 /**
 171  * Afs command handlers run as a process which is not related to the afs
 172  * process, i.e. they can not change the address space of afs directly.
 173  * Therefore afs commands typically consist of two functions: The command
 174  * handler and the corresponding callback function that runs in afs context.
 175  *
 176  * \sa send_callback_request().
 177  */
 178 typedef int afs_callback(struct afs_callback_arg *aca);
 179
 180 /**
 181  * Callbacks send chunks to data back to the command handler. Pointers to
 182  * this type of function are used by \ref send_callback_request and friends
 183  * to deal with the data in the command handler process.
 184  *
 185  * \sa \ref send_callback_request().
 186  */
 187 typedef int callback_result_handler(struct osl_object *result, uint8_t band, void *private);
 188 int afs_cb_result_handler(struct osl_object *result, uint8_t band, void *private);
 189 int pass_buffer_as_shm(int fd, uint8_t band, const char *buf, size_t size);
 190
 191 /** Structure passed to the AFS max_size handler. */
 192 struct afs_max_size_handler_data {
 193         /** Local socket connecting the command handler and the AFS process. */
 194         int fd;
 195         /** The sideband designator for this data packet. */
 196         uint8_t band;
 197 };
 198
 199 /**
 200  * Standard max_size handler for AFS commands.
 201  *
 202  * \param buf Contains (part of) the AFS command output.
 203  * \param size The number of bytes in \a buf.
 204  * \param private Pointer to a \ref afs_max_size_handler_data structure.
 205  *
 206  * Whenever the output of an AFS command exceeds the maximal size of a shared
 207  * memory area, the max size handler of the para_buffer which holds the command
 208  * output is called with \a private being a pointer to a structure of type
 209  * afs_max_size_handler_data.
 210  *
 211  * \return The return value of the underlying call to \ref
 212  *  pass_buffer_as_shm().
 213  */
 214 _static_inline_ int afs_max_size_handler(char *buf, size_t size, void *private)
 215 {
 216         struct afs_max_size_handler_data *amshd = private;
 217         return pass_buffer_as_shm(amshd->fd, amshd->band, buf, size);
 218 }
 219
 220 __noreturn void afs_init(uint32_t cookie, int socket_fd);
 221 __must_check int afs_event(enum afs_events event, struct para_buffer *pb,
 222         void *data);
 223 int send_callback_request(afs_callback *f, struct osl_object *query,
 224                 callback_result_handler *result_handler,
 225                 void *private_result_data);
 226 int send_option_arg_callback_request(struct osl_object *options,
 227                 int argc,  char * const * const argv, afs_callback *f,
 228                 callback_result_handler *result_handler,
 229                 void *private_result_data);
 230 int send_standard_callback_request(int argc,  char * const * const argv,
 231                 afs_callback *f, callback_result_handler *result_handler,
 232                 void *private_result_data);
 233 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
 234 int for_each_matching_row(struct pattern_match_data *pmd);
 235
 236 /* score */
 237 void score_init(struct afs_table *t);
 238 int admissible_file_loop(void *data, osl_rbtree_loop_func *func);
 239 int score_get_best(struct osl_row **aft_row, long *score);
 240 int get_score_and_aft_row(struct osl_row *score_row, long *score, struct osl_row **aft_row);
 241 int score_add(const struct osl_row *row, long score);
 242 int score_update(const struct osl_row *aft_row, long new_score);
 243 int get_num_admissible_files(unsigned *num);
 244 int score_delete(const struct osl_row *aft_row);
 245 int clear_score_table(void);
 246 int row_belongs_to_score_table(const struct osl_row *aft_row, unsigned *rank);
 247
 248 /* attribute */
 249 void attribute_init(struct afs_table *t);
 250 void get_attribute_bitmap(const uint64_t *atts, char *buf); /* needed by com_ls() */
 251 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum);
 252 int get_attribute_text(uint64_t *atts, const char *delim, char **text);
 253 int attribute_check_callback(struct afs_callback_arg *aca);
 254
 255 /* aft */
 256 void aft_init(struct afs_table *t);
 257 int aft_get_row_of_path(const char *path, struct osl_row **row);
 258 int aft_check_attributes(uint64_t att_mask, struct para_buffer *pb);
 259 int open_and_update_audio_file(struct audio_file_data *afd);
 260 int load_afd(int shmid, struct audio_file_data *afd);
 261 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
 262 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi);
 263 int get_audio_file_path_of_row(const struct osl_row *row, char **path);
 264 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
 265 int aft_check_callback(struct afs_callback_arg *aca);
 266
 267 /* playlist */
 268 int playlist_open(char *name);
 269 void playlist_close(void);
 270 int playlist_check_callback(struct afs_callback_arg *aca);
 271
 272 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
 273 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
 274
 275
 276 /** Define exported functions and a table pointer for an osl blob table. */
 277 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
 278         void table_name ## _init(struct afs_table *t); \
 279         int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
 280         int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
 281         int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def); \
 282         int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
 283                 char **name, struct osl_object *def); \
 284         int table_name ##_event_handler(enum afs_events event, \
 285                 struct para_buffer *pb, void *data); \
 286         extern struct osl_table *table_name ## _table;
 287
 288 DECLARE_BLOB_SYMBOLS(lyrics, lyr);
 289 DECLARE_BLOB_SYMBOLS(images, img);
 290 DECLARE_BLOB_SYMBOLS(moods, mood);
 291 DECLARE_BLOB_SYMBOLS(playlists, pl);
 292
 293 /** The columns of an abstract blob table. */
 294 enum blob_table_columns {
 295         /** The identifier, a positive integer that never repeats. */
 296         BLOBCOL_ID,
 297         /** The unique name of the blob. */
 298         BLOBCOL_NAME,
 299         /** The actual blob contents. */
 300         BLOBCOL_DEF,
 301         /** A blob table has that many columns. */
 302         NUM_BLOB_COLUMNS
 303 };