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