afs.h

   1 /*
   2  * Copyright (C) 2007-2013 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
  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, aac, wma, spx. */
  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  * Data about one audio file.
 109  *
 110  * Needed to produce ls and stat output.
 111  */
 112 struct ls_data {
 113         /** Usual audio format handler information. */
 114         struct afh_info afhi;
 115         /** Audio file selector information. */
 116         struct afs_info afsi;
 117         /** The full path of the audio file. */
 118         char *path;
 119         /** The score value (if -a was given). */
 120         long score;
 121         /** The hash value of audio file data. */
 122         unsigned char *hash;
 123 };
 124
 125 /** Data about the current audio file, passed from afs to server. */
 126 struct audio_file_data {
 127         /** The open file descriptor to the current audio file. */
 128         int fd;
 129         /** Vss needs this for streaming. */
 130         struct afh_info afhi;
 131         /** Size of the largest chunk. */
 132         uint32_t max_chunk_size;
 133         /** Needed to get the audio file header. */
 134         uint8_t audio_format_id;
 135 };
 136
 137 /**
 138  * Codes used for communication between the server and the afs process.
 139  *
 140  * Before forking the afs child, para_server creates a bidirectional pipe
 141  * through which both processes communicate. Usually para_server requests a new
 142  * audio in order to start streaming or when the end of the current audio file
 143  * has been reached.  The afs process responds to such a request by sending
 144  * back an eight byte buffer. The first four bytes is the uint32_t
 145  * representation of the code, usually \p NEXT_AUDIO_FILE if an admissible
 146  * audio file was found, successfully opened and verified. The other four bytes
 147  * represent the shared memory id of the shared memory area that contains
 148  * details about the audio file to be streamed next. The open file descriptor
 149  * of that file is also passed from afs to para_server through the same pipe.
 150  */
 151 enum afs_server_code {
 152         /** An audio file was successfully opened. */
 153         NEXT_AUDIO_FILE,
 154         /** No admissible audio file was found. */
 155         NO_ADMISSIBLE_FILES,
 156 };
 157
 158 /** Flags passed to for_each_matching_row(). */
 159 enum pattern_match_flags {
 160         /** Loop in reverse order. */
 161         PM_REVERSE_LOOP = 1,
 162         /** If no pattern is given, loop over all rows. */
 163         PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
 164         /** If the data in match_column is the empty string, skip this row. */
 165         PM_SKIP_EMPTY_NAME = 4,
 166 };
 167
 168 /** Structure passed to for_each_matching_row(). */
 169 struct pattern_match_data {
 170         /** Loop over all rows in this table. */
 171         struct osl_table *table;
 172         /** Determines the loop order. Must be an rbtree column. */
 173         unsigned loop_col_num;
 174         /** Data from this column is matched against the given patterns. */
 175         unsigned match_col_num;
 176         /** \see pattern_match_flags. */
 177         unsigned pm_flags;
 178         /** This value is passed verbatim to fnmatch(). */
 179         int fnmatch_flags;
 180         /** Null-terminated array of patterns. */
 181         struct osl_object patterns;
 182         /** Data pointer passed to the action function. */
 183         void *data;
 184         /** Gets increased by one for each match. */
 185         unsigned num_matches;
 186         /** For each matching row, this function will be called. */
 187         int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
 188 };
 189
 190
 191 /**
 192  * Afs command handlers run as a process which is not related to the afs
 193  * process, i.e. they can not change the address space of afs directly.
 194  * Therefore afs commands typically consist of two functions: The command
 195  * handler and the corresponding callback function that runs in afs context.
 196  *
 197  * \sa send_callback_request().
 198  */
 199 typedef void callback_function(int fd, const struct osl_object *);
 200
 201 /**
 202  * Callbacks send chunks to data back to the command handler. Pointers to
 203  * this type of function are used by \ref send_callback_request and friends
 204  * to deal with the data in the command handler process.
 205  *
 206  * \sa \ref send_callback_request().
 207  */
 208 typedef int callback_result_handler(struct osl_object *result, uint8_t band, void *private);
 209 int afs_cb_result_handler(struct osl_object *result, uint8_t band, void *private);
 210 int pass_buffer_as_shm(int fd, uint8_t band, char *buf, size_t size);
 211
 212 /** Structure passed to the AFS max_size handler. */
 213 struct afs_max_size_handler_data {
 214         /** Local socket connecting the command handler and the AFS process. */
 215         int fd;
 216         /** The sideband designator for this data packet. */
 217         uint8_t band;
 218 };
 219
 220 /**
 221  * Standard max_size handler for AFS commands.
 222  *
 223  * \param buf Contains (part of) the AFS command output.
 224  * \param size The number of bytes in \a buf.
 225  * \param private Pointer to a \ref afs_max_size_handler_data structure.
 226  *
 227  * Whenever the output of an AFS command exceeds the maximal size of a shared
 228  * memory area, the max size handler of the para_buffer which holds the command
 229  * output is called with \a private being a pointer to a structure of type
 230  * afs_max_size_handler_data.
 231  *
 232  * \return The return value of the underlying call to \ref
 233  *  pass_buffer_as_shm().
 234  */
 235 _static_inline_ int afs_max_size_handler(char *buf, size_t size, void *private)
 236 {
 237         struct afs_max_size_handler_data *amshd = private;
 238         return pass_buffer_as_shm(amshd->fd, amshd->band, buf, size);
 239 }
 240
 241 __noreturn void afs_init(uint32_t cookie, int socket_fd);
 242 void afs_event(enum afs_events event, struct para_buffer *pb,
 243         void *data);
 244 int send_callback_request(callback_function *f, struct osl_object *query,
 245                 callback_result_handler *result_handler,
 246                 void *private_result_data);
 247 int send_option_arg_callback_request(struct osl_object *options,
 248                 int argc,  char * const * const argv, callback_function *f,
 249                 callback_result_handler *result_handler,
 250                 void *private_result_data);
 251 int send_standard_callback_request(int argc,  char * const * const argv,
 252                 callback_function *f, callback_result_handler *result_handler,
 253                 void *private_result_data);
 254 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
 255 int for_each_matching_row(struct pattern_match_data *pmd);
 256
 257 /* score */
 258 void score_init(struct afs_table *t);
 259 int admissible_file_loop(void *data, osl_rbtree_loop_func *func);
 260 int admissible_file_loop_reverse(void *data, osl_rbtree_loop_func *func);
 261 int score_get_best(struct osl_row **aft_row, long *score);
 262 int get_score_and_aft_row(struct osl_row *score_row, long *score, struct osl_row **aft_row);
 263 int score_add(const struct osl_row *row, long score);
 264 int score_update(const struct osl_row *aft_row, long new_score);
 265 int get_num_admissible_files(unsigned *num);
 266 int score_delete(const struct osl_row *aft_row);
 267 int clear_score_table(void);
 268 int row_belongs_to_score_table(const struct osl_row *aft_row, unsigned *rank);
 269
 270 /* attribute */
 271 void attribute_init(struct afs_table *t);
 272 void get_attribute_bitmap(const uint64_t *atts, char *buf); /* needed by com_ls() */
 273 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum);
 274 int get_attribute_text(uint64_t *atts, const char *delim, char **text);
 275
 276 /* aft */
 277 void aft_init(struct afs_table *t);
 278 int aft_get_row_of_path(const char *path, struct osl_row **row);
 279 int open_and_update_audio_file(struct osl_row *aft_row, long score,
 280         struct audio_file_data *afd);
 281 int load_afd(int shmid, struct audio_file_data *afd);
 282 int load_afsi(struct afs_info *afsi, struct osl_object *obj);
 283 void save_afsi(struct afs_info *afsi, struct osl_object *obj);
 284 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
 285 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi);
 286 int get_afsi_of_path(const char *path, struct afs_info *afsi);
 287 int get_audio_file_path_of_row(const struct osl_row *row, char **path);
 288 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj);
 289 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
 290 void aft_check_callback(int fd, __a_unused const struct osl_object *query);
 291
 292 /* playlist */
 293 int playlist_open(char *name);
 294 void playlist_close(void);
 295 void playlist_check_callback(int fd, __a_unused const struct osl_object *query);
 296
 297 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
 298 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
 299
 300
 301 /** Define exported functions and a table pointer for an osl blob table. */
 302 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
 303         void table_name ## _init(struct afs_table *t); \
 304         int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
 305         int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
 306         int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def); \
 307         int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
 308                 char **name, struct osl_object *def); \
 309         int table_name ##_event_handler(enum afs_events event, \
 310                 struct para_buffer *pb, void *data); \
 311         extern struct osl_table *table_name ## _table;
 312
 313 DECLARE_BLOB_SYMBOLS(lyrics, lyr);
 314 DECLARE_BLOB_SYMBOLS(images, img);
 315 DECLARE_BLOB_SYMBOLS(moods, mood);
 316 DECLARE_BLOB_SYMBOLS(playlists, pl);
 317
 318 /** The columns of an abstract blob table. */
 319 enum blob_table_columns {
 320         /** The identifier, a positive integer that never repeats. */
 321         BLOBCOL_ID,
 322         /** The unique name of the blob. */
 323         BLOBCOL_NAME,
 324         /** The actual blob contents. */
 325         BLOBCOL_DEF,
 326         /** A blob table has that many columns. */
 327         NUM_BLOB_COLUMNS
 328 };