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