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