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