* Licensed under the GPL v2. For licencing details see COPYING.
*/
+/** \file afs.h Exported symbos of the audio file selector. */
+
#include <regex.h>
#include "osl.h"
#include "hash.h"
struct afs_info {
/** Seconds since the epoch. */
uint64_t last_played;
- /** Bitfield of set attributes. */
+ /** Bit field of set attributes. */
uint64_t attributes;
/** Counts how many times the file was selected. */
uint32_t num_played;
struct table_info {
const struct osl_table_description *desc;
- struct osl_table *table;
enum afs_table_flags flags;
};
-enum ls_sorting_method {
- /** -sp (default) */
- LS_SORT_BY_PATH,
- /** -ss */
- LS_SORT_BY_SCORE,
- /** -sl */
- LS_SORT_BY_LAST_PLAYED,
- /** -sn */
- LS_SORT_BY_NUM_PLAYED,
- /** -sf */
- LS_SORT_BY_FREQUENCY,
- /** -sc */
- LS_SORT_BY_CHANNELS,
- /** -si */
- LS_SORT_BY_IMAGE_ID,
- /** -sy */
- LS_SORT_BY_LYRICS_ID,
- /** -sb */
- LS_SORT_BY_BITRATE,
- /** -sd */
- LS_SORT_BY_DURATION,
- /** -sa */
- LS_SORT_BY_AUDIO_FORMAT,
- /** -sh */
- LS_SORT_BY_HASH,
-};
-
enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
struct audio_file_data {
struct osl_object map;
};
+/** Flags passed to for_each_matching_row(). */
+enum pattern_match_flags {
+ /** Loop in reverse order. */
+ PM_REVERSE_LOOP = 1,
+ /** If no pattern is given, loop over all rows. */
+ PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
+ /** If the data in match_column is the empty string, skip this row. */
+ PM_SKIP_EMPTY_NAME = 4,
+};
+
+/** Structure passed to for_each_matching_row(). */
+struct pattern_match_data {
+ /** Loop over all rows in this table. */
+ struct osl_table *table;
+ /** Determines the loop order. Must be an rbtree column. */
+ unsigned loop_col_num;
+ /** Data from this column is matched against the given patterns. */
+ unsigned match_col_num;
+ /** \see pattern_match_flags. */
+ unsigned pm_flags;
+ /** This value is passed verbatim to fnmatch(). */
+ int fnmatch_flags;
+ /** Null-terminated array of patterns. */
+ struct osl_object patterns;
+ /** Data pointer passed to the action function. */
+ void *data;
+ /** For each matching row, this function will be called. */
+ int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
+};
+
/* afs */
typedef int callback_function(const struct osl_object *, struct osl_object *);
-__noreturn int afs_init(uint32_t cookie, int socket_fd);
+__noreturn void afs_init(uint32_t cookie, int socket_fd);
int send_callback_request(callback_function *f, struct osl_object *query,
struct osl_object *result);
int send_standard_callback_request(int argc, char * const * const argv,
int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f,
unsigned max_len, struct osl_object *result);
int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
-int para_atol(const char *str, long *result);
int open_next_audio_file(struct audio_file_data *afd);
int close_audio_file(struct audio_file_data *afd);
+int for_each_matching_row(struct pattern_match_data *pmd);
/* score */
int score_init(struct table_info *ti, const char *db);
/* aft */
int aft_init(struct table_info *ti, const char *db);
void aft_shutdown(enum osl_close_flags flags);
-int aft_get_row_of_path(char *path, struct osl_row **row);
+int aft_get_row_of_path(const char *path, struct osl_row **row);
int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *afd);
int load_afsi(struct afs_info *afsi, struct osl_object *obj);
void save_afsi(struct afs_info *afsi, struct osl_object *obj);
int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
+int get_afhi_of_row(const struct osl_row *row, struct audio_format_info *afhi);
+int get_afsi_of_path(const char *path, struct afs_info *afsi);
int get_audio_file_path_of_row(const struct osl_row *row, char **path);
int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj);
int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
int table_name ## _init(struct table_info *ti, const char *db); \
void table_name ## _shutdown(enum osl_close_flags flags); \
int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
+ int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
char **name, struct osl_object *def); \
extern struct osl_table *table_name ## _table;
DECLARE_BLOB_SYMBOLS(moods, mood);
DECLARE_BLOB_SYMBOLS(playlists, pl);
-enum blob_table_columns {BLOBCOL_ID, BLOBCOL_NAME, BLOBCOL_DEF, NUM_BLOB_COLUMNS};
+/** The columns of an abstract blob table. */
+enum blob_table_columns {
+ /** The identifier, a positive integer that never repeats. */
+ BLOBCOL_ID,
+ /** The unique name of the blob. */
+ BLOBCOL_NAME,
+ /** The actual blob contents. */
+ BLOBCOL_DEF,
+ /** A blob table has that many columns. */
+ NUM_BLOB_COLUMNS
+};
+
#define DEFINE_BLOB_TABLE_DESC(table_name) \
struct osl_table_description table_name ## _table_desc = { \
.name = #table_name, \