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 symbos 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 enum afs_events {
  30         ATTRIBUTE_ADD,
  31         ATTRIBUTE_RENAME,
  32         ATTRIBUTE_REMOVE,
  33         AFSI_CHANGE,
  34         AFHI_CHANGE,
  35         AUDIO_FILE_RENAME,
  36         AUDIO_FILE_ADD,
  37         AUDIO_FILE_REMOVE,
  38         LYRICS_ADD,
  39         LYRICS_REMOVE,
  40         LYRICS_RENAME,
  41         IMAGE_ADD,
  42         IMAGE_REMOVE,
  43         IMAGE_RENAME,
  44
  45 };
  46
  47 struct rmatt_event_data {
  48         const char *name;
  49         unsigned char bitnum;
  50 };
  51
  52
  53 struct addatt_event_data {
  54         const char *name;
  55         unsigned char bitnum;
  56 };
  57
  58 struct afsi_change_event_data {
  59         const struct osl_row *aft_row;
  60         struct afs_info *old_afsi;
  61 };
  62
  63 union afs_event_data {
  64         struct {
  65                 const char *name;
  66                 unsigned char bitnum;
  67         } rmatt_event_data;
  68         struct osl_row *row;
  69         struct {
  70                 const struct osl_row *row;
  71                 struct afs_info *old_afsi;
  72         } afsi_change;
  73
  74 };
  75
  76 struct afs_table {
  77         void (*init)(struct afs_table *t);
  78         const char *name;
  79         int (*open)(const char *base_dir);
  80         void (*close)(void);
  81         int (*create)(const char *);
  82         int (*event_handler)(enum afs_events event, struct para_buffer *pb,
  83                 void *data);
  84         /* int *(check)() */
  85 };
  86
  87 enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
  88
  89 struct audio_file_data {
  90         enum play_mode current_play_mode;
  91         long score;
  92         struct afs_info afsi;
  93         struct audio_format_info afhi;
  94         char *path;
  95         struct osl_object map;
  96 };
  97
  98 /** Flags passed to for_each_matching_row(). */
  99 enum pattern_match_flags {
 100         /** Loop in reverse order. */
 101         PM_REVERSE_LOOP = 1,
 102         /** If no pattern is given, loop over all rows. */
 103         PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
 104         /** If the data in match_column is the empty string, skip this row. */
 105         PM_SKIP_EMPTY_NAME = 4,
 106 };
 107
 108 /** Structure passed to for_each_matching_row(). */
 109 struct pattern_match_data {
 110         /** Loop over all rows in this table. */
 111         struct osl_table *table;
 112         /** Determines the loop order. Must be an rbtree column. */
 113         unsigned loop_col_num;
 114         /** Data from this column is matched against the given patterns. */
 115         unsigned match_col_num;
 116         /** \see pattern_match_flags. */
 117         unsigned pm_flags;
 118         /** This value is passed verbatim to fnmatch(). */
 119         int fnmatch_flags;
 120         /** Null-terminated array of patterns. */
 121         struct osl_object patterns;
 122         /** Data pointer passed to the action function. */
 123         void *data;
 124         /** For each matching row, this function will be called. */
 125         int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
 126 };
 127
 128 /* afs */
 129 typedef int callback_function(const struct osl_object *, struct osl_object *);
 130 __noreturn void afs_init(uint32_t cookie, int socket_fd);
 131 void afs_event(enum afs_events event, struct para_buffer *pb,
 132         void *data);
 133 int send_callback_request(callback_function *f, struct osl_object *query,
 134         struct osl_object *result);
 135 int send_standard_callback_request(int argc, char * const * const argv,
 136                 callback_function *f, struct osl_object *result);
 137 int send_option_arg_callback_request(struct osl_object *options,
 138         int argc, char * const * const argv, callback_function *f,
 139         struct osl_object *result);
 140 int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f,
 141                 unsigned max_len, struct osl_object *result);
 142 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
 143 int open_next_audio_file(struct audio_file_data *afd);
 144 int close_audio_file(struct audio_file_data *afd);
 145 int for_each_matching_row(struct pattern_match_data *pmd);
 146
 147 /* score */
 148 void score_init(struct afs_table *t);
 149 int admissible_file_loop(void *data, osl_rbtree_loop_func *func);
 150 int admissible_file_loop_reverse(void *data, osl_rbtree_loop_func *func);
 151 int score_get_best(struct osl_row **aft_row, long *score);
 152 int get_score_and_aft_row(struct osl_row *score_row, long *score, struct osl_row **aft_row);
 153 int score_add(const struct osl_row *row, long score);
 154 int score_update(const struct osl_row *aft_row, long new_score);
 155 int get_num_admissible_files(unsigned *num);
 156 int score_delete(const struct osl_row *aft_row);
 157 int row_belongs_to_score_table(const struct osl_row *aft_row, unsigned *rank);
 158
 159 /* attribute */
 160 void attribute_init(struct afs_table *t);
 161 void get_attribute_bitmap(const uint64_t *atts, char *buf); /* needed by com_ls() */
 162 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum);
 163 int get_attribute_text(uint64_t *atts, const char *delim, char **text);
 164
 165 /* aft */
 166 void aft_init(struct afs_table *t);
 167 int aft_get_row_of_path(const char *path, struct osl_row **row);
 168 int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *afd);
 169 int load_afsi(struct afs_info *afsi, struct osl_object *obj);
 170 void save_afsi(struct afs_info *afsi, struct osl_object *obj);
 171 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
 172 int get_afhi_of_row(const struct osl_row *row, struct audio_format_info *afhi);
 173 int get_afsi_of_path(const char *path, struct afs_info *afsi);
 174 int get_audio_file_path_of_row(const struct osl_row *row, char **path);
 175 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj);
 176 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
 177 int aft_check_callback(const struct osl_object *query, struct osl_object *result);
 178
 179 /* mood */
 180 int change_current_mood(char *mood_name);
 181 int reload_current_mood(void);
 182 int mood_check_callback(__a_unused const struct osl_object *query,
 183         struct osl_object *result);
 184
 185
 186 /* playlist */
 187 int playlist_open(char *name);
 188 int playlist_update_audio_file(struct osl_row *aft_row);
 189 int playlist_check_callback(__a_unused const struct osl_object *query,
 190         struct osl_object *result);
 191
 192 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
 193 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
 194
 195
 196 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
 197         void table_name ## _init(struct afs_table *t); \
 198         int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
 199         int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
 200         int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def); \
 201         int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
 202                 char **name, struct osl_object *def); \
 203         int table_name ##_event_handler(enum afs_events event, \
 204                 struct para_buffer *pb, void *data); \
 205         extern struct osl_table *table_name ## _table;
 206
 207 DECLARE_BLOB_SYMBOLS(lyrics, lyr);
 208 DECLARE_BLOB_SYMBOLS(images, img);
 209 DECLARE_BLOB_SYMBOLS(moods, mood);
 210 DECLARE_BLOB_SYMBOLS(playlists, pl);
 211
 212 /** The columns of an abstract blob table. */
 213 enum blob_table_columns {
 214         /** The identifier, a positive integer that never repeats. */
 215         BLOBCOL_ID,
 216         /** The unique name of the blob. */
 217         BLOBCOL_NAME,
 218         /** The actual blob contents. */
 219         BLOBCOL_DEF,
 220         /** A blob table has that many columns. */
 221         NUM_BLOB_COLUMNS
 222 };
 223
 224 #define DEFINE_BLOB_TABLE_DESC(table_name) \
 225         struct osl_table_description table_name ## _table_desc = { \
 226                 .name = #table_name, \
 227                 .num_columns = NUM_BLOB_COLUMNS, \
 228                 .flags = OSL_LARGE_TABLE, \
 229                 .column_descriptions = blob_cols \
 230         };
 231
 232 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
 233
 234 #define INIT_BLOB_TABLE(table_name) \
 235         DEFINE_BLOB_TABLE_DESC(table_name); \
 236         DEFINE_BLOB_TABLE_PTR(table_name);
 237