/*
- * Copyright (C) 2007-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007-2013 Andre Noll <maan@systemlinux.org>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
/** \file mood.c Paraslash's mood handling functions. */
-#include <fnmatch.h>
+#include <regex.h>
+#include <osl.h>
+
#include "para.h"
#include "error.h"
#include "string.h"
#include "afs.h"
#include "list.h"
#include "ipc.h"
+#include "mm.h"
+#include "sideband.h"
/**
* Contains statistical data of the currently admissible audio files.
/** Number of admissible files */
unsigned num;
};
-struct afs_statistics statistics;
-
-/**
- * Assign scores according to a mood_method.
- *
- * Each mood_method has its own mood_score_function. The first three parameters
- * passed to that function are informations about the audio file whose score is
- * to be computed. The data argument depends on the mood method this function
- * is used for. It usually is the argument given at the end of a mood line.
- *
- * Mood score functions must return values between -100 and +100 inclusively.
- * Boolean score functions should always return either -100 or +100.
- *
- * \sa struct mood_method, mood_parser.
- */
-typedef int mood_score_function(const char *path, const struct afs_info *afsi,
- const struct afh_info *afhi, const void *data);
-
-/**
- * Pre-process a mood line.
- *
- * The mood_parser of a mood_method is called once at mood open time for each
- * line of the current mood definition that contains the mood_method's name as
- * a keyword. The line is passed to the mood_parser as the first argument. The
- * mood_parser must determine whether the line is syntactically correct and
- * return a positive value if so and a negative value otherwise.
- *
- * Some mood parsers pre-process the data given in the mood line to compute a
- * structure which depends of the particular mood_method and which is used
- * later in the mood_score_function of the mood_method. The mood_parser may
- * store a pointer to its structure via the second argument.
- *
- * \sa mood_open(), mood_cleanup_function, mood_score_function.
- */
-typedef int mood_parser(const char *, void **);
-
-/**
- * Deallocate resources which were allocated by the mood_parser.
- *
- * This optional function of a mood_method is used to free any resources
- * allocated in mood_open() by the mood_parser. The argument passed is a
- * pointer to the mood_method specific data structure that was returned by the
- * mood_parser.
- *
- * \sa mood_parser.
- */
-typedef void mood_cleanup_function(void *);
-
-/**
- * Used for scoring and to determine whether a file is admissible.
- */
-struct mood_method {
- /** The name of the method. */
- const char *name;
- /** Pointer to the mood parser. */
- mood_parser *parser;
- /** Pointer to the score function */
- mood_score_function *score_function;
- /** Optional cleanup function. */
- mood_cleanup_function *cleanup;
-};
+static struct afs_statistics statistics;
/**
* Each line of the current mood corresponds to a mood_item.
struct list_head score_list;
};
+/*
+ * If current_mood is NULL then no mood is currently open. If
+ * current_mood->name is NULL, the dummy mood is currently open
+ */
static struct mood *current_mood;
/**
- * Rough approximation to sqrt.
+ * Rough approximation to sqrt.
*
- * \param x Integer of which to calculate the sqrt.
+ * \param x Integer of which to calculate the sqrt.
*
- * \return An integer res with res * res <= x.
+ * \return An integer res with res * res <= x.
*/
-static uint64_t int_sqrt(uint64_t x)
+__a_const static uint64_t int_sqrt(uint64_t x)
{
uint64_t op, res, one = 1;
op = x;
return res;
}
-static int mm_no_attributes_set_parser(const char *arg, __a_unused void **ignored)
-{
- if (arg && *arg)
- PARA_WARNING_LOG("ignored junk at eol: %s\n", arg);
- return 1;
-}
-
-static int mm_no_attributes_set_score_function(__a_unused const char *path,
- const struct afs_info *afsi,
- __a_unused const struct afh_info *afhi,
- __a_unused const void *data)
-{
- if (!afsi->attributes)
- return 100;
- return -100;
-}
-
-static int mm_played_rarely_score_function(__a_unused const char *path,
- const struct afs_info *afsi,
- __a_unused const struct afh_info *afhi,
- __a_unused const void *data)
-{
- unsigned num;
- int ret = get_num_admissible_files(&num);
-
- if (ret < 0)
- return 0;
- if (statistics.num_played_sum - num * afsi->num_played
- > int_sqrt(statistics.num_played_qd * num))
- return 100;
- return -100;
-}
-
-static int mm_played_rarely_parser(const char *arg, __a_unused void **ignored)
-{
- if (arg && *arg)
- PARA_WARNING_LOG("ignored junk at eol: %s\n", arg);
- return 1;
-}
-
-static int mm_path_matches_score_function(const char *path,
- __a_unused const struct afs_info *afsi,
- __a_unused const struct afh_info *afhi,
- const void *data)
-{
- if (fnmatch(data, path, 0))
- return -100;
- return 100;
-}
-
-static int mm_path_matches_parser(const char *arg, void **data)
-{
- *data = para_strdup(arg);
- return 1;
-}
-
-static void mm_path_matches_cleanup(void *data)
-{
- free(data);
-}
-
-static int mm_is_set_parser(const char *arg, void **bitnum)
-{
- unsigned char *c = para_malloc(1);
- int ret = get_attribute_bitnum_by_name(arg, c);
-
- if (ret >= 0)
- *bitnum = c;
- else
- free(c);
- return ret;
-}
-
-static int mm_is_set_score_function(__a_unused const char *path,
- __a_unused const struct afs_info *afsi,
- __a_unused const struct afh_info *afhi,
- const void *data)
-{
- const unsigned char *bn = data;
- if (afsi->attributes & (1ULL << *bn))
- return 100;
- return -100;
-}
-
-/* returns 1 if row matches score item, 0 if not, negative on errors */
-static int get_item_score(const struct osl_row *row, struct mood_item *item,
- long *score, long *score_arg_sum)
+/*
+ * Returns true if row matches, false if it does not match. In any case score
+ * and score_arg_sum are set/increased accordingly.
+ */
+static bool get_item_score(struct mood_item *item, const struct afs_info *afsi,
+ const struct afh_info *afhi, const char *path, long *score,
+ long *score_arg_sum)
{
- struct afs_info afsi;
- struct afh_info afhi;
- char *path;
- int ret, match = 1;
+ int ret;
+ bool match = true;
*score_arg_sum += item->random_score? 100 : PARA_ABS(item->score_arg);
ret = 100;
if (item->method) {
- ret = get_afsi_of_row(row, &afsi);
- if (ret< 0)
- return ret;
- ret = get_afhi_of_row(row, &afhi);
- if (ret< 0)
- return ret;
- free(afhi.info_string); /* don't need the tag info */
- ret = get_audio_file_path_of_row(row, &path);
- if (ret< 0)
- return ret;
- ret = item->method->score_function(path, &afsi, &afhi,
+ ret = item->method->score_function(path, afsi, afhi,
item->parser_data);
if ((ret < 0 && !item->logical_not) || (ret >= 0 && item->logical_not))
- match = 0; /* no match */
+ match = false;
}
if (item->random_score)
*score = PARA_ABS(ret) * para_random(100);
long *result)
{
struct mood_item *item;
- int ret, match = 0;
+ int ret;
+ bool match;
long score_arg_sum = 0, score = 0, item_score;
+ struct afs_info afsi;
+ struct afh_info afhi;
+ char *path;
if (!m)
return -E_NO_MOOD;
+ ret = get_afsi_of_row(aft_row, &afsi);
+ if (ret< 0)
+ return ret;
+ ret = get_afhi_of_row(aft_row, &afhi);
+ if (ret< 0)
+ return ret;
+ ret = get_audio_file_path_of_row(aft_row, &path);
+ if (ret< 0)
+ return ret;
/* reject audio file if it matches any entry in the deny list */
list_for_each_entry(item, &m->deny_list, mood_item_node) {
- ret = get_item_score(aft_row, item, &item_score,
+ match = get_item_score(item, &afsi, &afhi, path, &item_score,
&score_arg_sum);
- if (ret < 0)
- return ret;
- if (ret > 0) /* not admissible */
+ if (match) /* not admissible */
return 0;
score += item_score;
}
+ match = false;
list_for_each_entry(item, &m->accept_list, mood_item_node) {
- ret = get_item_score(aft_row, item, &item_score,
+ ret = get_item_score(item, &afsi, &afhi, path, &item_score,
&score_arg_sum);
- if (ret < 0)
- return ret;
if (ret == 0)
continue;
- match = 1;
+ match = true;
score += item_score;
}
/* reject if there is no matching entry in the accept list */
if (!match && !list_empty(&m->accept_list))
return 0;
list_for_each_entry(item, &m->score_list, mood_item_node) {
- ret = get_item_score(aft_row, item, &item_score,
+ match = get_item_score(item, &afsi, &afhi, path, &item_score,
&score_arg_sum);
- if (ret < 0)
- return ret;
- score += item_score;
+ if (match)
+ score += item_score;
}
if (score_arg_sum)
score /= score_arg_sum;
return 1;
}
-#define DEFINE_MOOD_METHOD(_name) \
-.parser = mm_ ## _name ## _parser, \
-.score_function = mm_ ## _name ## _score_function, \
-.name = #_name
-
-#define DEFINE_MOOD_METHOD_WITH_CLEANUP(_name) \
- DEFINE_MOOD_METHOD(_name), \
- .cleanup = mm_ ## _name ## _cleanup
-
-static const struct mood_method mood_methods[] = {
- {DEFINE_MOOD_METHOD(no_attributes_set)},
- {DEFINE_MOOD_METHOD(played_rarely)},
- {DEFINE_MOOD_METHOD(is_set)},
- {DEFINE_MOOD_METHOD_WITH_CLEANUP(path_matches)},
- {.parser = NULL}
-};
-
static void cleanup_list_entry(struct mood_item *item)
{
if (item->method && item->method->cleanup)
static struct mood *alloc_new_mood(const char *name)
{
struct mood *m = para_calloc(sizeof(struct mood));
- m->name = para_strdup(name);
+ if (name)
+ m->name = para_strdup(name);
INIT_LIST_HEAD(&m->accept_list);
INIT_LIST_HEAD(&m->deny_list);
INIT_LIST_HEAD(&m->score_list);
{
struct mood_line_parser_data *mlpd = data;
char **argv;
- char *delim = " \t";
unsigned num_words;
char **w;
int i, ret;
enum mood_line_type mlt = ML_INVALID;
struct mood_item *mi = NULL;
- char *buf = para_strdup(mood_line);
mlpd->line_num++;
- num_words = split_args(buf, &argv, delim);
- ret = 1;
+ ret = create_argv(mood_line, " \t", &argv);
+ if (ret < 0)
+ return ret;
+ num_words = ret;
if (!num_words) /* empty line */
goto out;
w = argv;
ret = -E_MOOD_SYNTAX;
if (!mood_methods[i].parser)
goto out;
- w++;
- ret = mood_methods[i].parser(*w, &mi->parser_data);
+ ret = mood_methods[i].parser(num_words - 1 - (w - argv), w,
+ &mi->parser_data);
if (ret < 0)
goto out;
mi->method = &mood_methods[i];
(mlt == ML_DENY? "deny" : "score"), mi->method);
ret = 1;
out:
- free(argv);
- free(buf);
+ free_argv(argv);
if (ret >= 0)
return ret;
if (mi) {
char *mood_name;
struct osl_object mood_def;
struct mood_line_parser_data mlpd = {.line_num = 0};
- int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
+ int ret;
+ *m = NULL;
+ ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
if (ret < 0)
return ret;
if (!*mood_name)
return -E_DUMMY_ROW;
mlpd.m = alloc_new_mood(mood_name);
- ret = for_each_line_ro(mood_def.data, mood_def.size,
+ ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
parse_mood_line, &mlpd);
osl_close_disk_object(&mood_def);
if (ret < 0) {
ret = para_printf(pb, "checking mood %s...\n", mood_name);
if (ret < 0)
goto out;
- ret = for_each_line_ro(mood_def.data, mood_def.size,
+ ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
parse_mood_line, &mlpd);
if (ret < 0)
para_printf(pb, "%s line %u: %s\n", mood_name, mlpd.line_num,
void mood_check_callback(int fd, __a_unused const struct osl_object *query)
{
struct para_buffer pb = {
- .max_size = SHMMAX,
- .private_data = &fd,
- .max_size_handler = pass_buffer_as_shm
+ .max_size = shm_get_shmmax(),
+ .private_data = &(struct afs_max_size_handler_data) {
+ .fd = fd,
+ .band = SBD_OUTPUT
+ },
+ .max_size_handler = afs_max_size_handler
};
int ret = para_printf(&pb, "checking moods...\n");
osl_rbtree_loop(moods_table, BLOBCOL_ID, &pb,
check_mood);
if (pb.offset)
- pass_buffer_as_shm(pb.buf, pb.offset, &fd);
+ pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
free(pb.buf);
}
-#if 0
-static unsigned int_log2(uint64_t x)
-{
- unsigned res = 0;
-
- while (x) {
- x /= 2;
- res++;
- }
- return res;
-}
-#endif
-
static int64_t normalized_value(int64_t x, int64_t n, int64_t sum, int64_t qd)
{
if (!n || !qd)
return 100 * (n * x - sum) / (int64_t)int_sqrt(n * qd);
}
-static long compute_num_played_score(struct afs_info *afsi)
+static long compute_score(struct afs_info *afsi, long mood_score)
{
- return -normalized_value(afsi->num_played, statistics.num,
+ mood_score -= normalized_value(afsi->num_played, statistics.num,
statistics.num_played_sum, statistics.num_played_qd);
-}
-
-static long compute_last_played_score(struct afs_info *afsi)
-{
- return -normalized_value(afsi->last_played, statistics.num,
+ mood_score -= normalized_value(afsi->last_played, statistics.num,
statistics.last_played_sum, statistics.last_played_qd);
-}
-
-static long compute_dynamic_score(const struct osl_row *aft_row)
-{
- struct afs_info afsi;
- int64_t score, nscore = 0, lscore = 0;
- int ret;
-
- ret = get_afsi_of_row(aft_row, &afsi);
- if (ret < 0)
- return -100;
- nscore = compute_num_played_score(&afsi);
- lscore = compute_last_played_score(&afsi);
- score = nscore + lscore;
- return score;
+ return mood_score / 3;
}
static int add_afs_statistics(const struct osl_row *row)
static int add_to_score_table(const struct osl_row *aft_row, long mood_score)
{
- long score = (compute_dynamic_score(aft_row) + mood_score) / 3;
+ long score;
+ struct afs_info afsi;
+ int ret = get_afsi_of_row(aft_row, &afsi);
+
+ if (ret < 0)
+ return ret;
+ score = compute_score(&afsi, mood_score);
return score_add(aft_row, score);
}
if (ret < 0)
return ret;
}
- score += compute_num_played_score(&afsi);
- score += compute_last_played_score(&afsi);
- score /= 3;
+ score = compute_score(&afsi, score);
PARA_DEBUG_LOG("score: %li\n", score);
percent = (score + 100) / 3;
if (percent > 100)
memset(&statistics, 0, sizeof(statistics));
}
-
/**
* Change the current mood.
*
.data = mood_name,
.size = strlen(mood_name) + 1
};
- ret = osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row);
+ ret = osl(osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row));
if (ret < 0) {
PARA_NOTICE_LOG("no such mood: %s\n", mood_name);
return ret;
return ret;
close_current_mood();
current_mood = m;
- } else {
+ } else { /* load dummy mood */
close_current_mood();
- current_mood = alloc_new_mood("dummy");
+ current_mood = alloc_new_mood(NULL);
}
aa.m = current_mood;
PARA_NOTICE_LOG("computing statistics of admissible files\n");
if (ret < 0)
goto out;
}
- PARA_NOTICE_LOG("loaded mood %s\n", current_mood->name);
+ PARA_NOTICE_LOG("loaded mood %s\n", mood_name? mood_name : "(dummy)");
ret = statistics.num;
out:
free(aa.array);
*
* \sa mood_open(), mood_close().
*/
-int reload_current_mood(void)
+static int reload_current_mood(void)
{
int ret;
char *mood_name = NULL;
return ret;
}
+/**
+ * Notification callback for the moods table.
+ *
+ * \param event Type of the event just occurred.
+ * \param pb Unused.
+ * \param data Its type depends on the event.
+ *
+ * This function performs actions required due to the occurrence of the given
+ * event. Possible actions include reload of the current mood and update of the
+ * score of an audio file.
+ *
+ * \return Standard.
+ */
int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb,
void *data)
{
+ int ret;
+
if (!current_mood)
return 0;
switch (event) {
case BLOB_ADD:
if (data == moods_table || data == playlists_table)
return 1; /* no reload necessary for these */
+ ret = clear_score_table();
+ if (ret < 0)
+ PARA_CRIT_LOG("clear score table returned %s\n",
+ para_strerror(-ret));
return reload_current_mood();
/* these also require reload of the score table */
case ATTRIBUTE_ADD:
return 1;
}
}
-
projects / paraslash.git / blobdiff