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