+/*
+ * Copyright (C) 2007 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 "para.h"
#include "error.h"
#include "afh.h"
#include "list.h"
#include "string.h"
-/** \file mood.c Paraslash's mood handling functions. */
-
/**
* Contains statistical data of the currently admissible audio files.
*
- * It is used to assign normalized score values to each admissbile audio file.
+ * It is used to assign normalized score values to each admissible audio file.
*/
struct afs_statistics {
- /** sum of num played over all admissible files */
+ /** Sum of num played over all admissible files. */
int64_t num_played_sum;
- /** sum of last played times over all admissible files */
+ /** Sum of last played times over all admissible files. */
int64_t last_played_sum;
- /** quadratic deviation of num played time */
+ /** Quadratic deviation of num played time. */
int64_t num_played_qd;
- /** quadratic deviation of last played time */
+ /** Quadratic deviation of last played time. */
int64_t last_played_qd;
- /** number of admissible 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 parameter passed
- * to that function is a pointer to a row of the audio file table. It
- * determines the audio file for which a score is to be assigned. The second
- * argument depends on the mood method this function is used for. It usually is
- * the argument given at the end of a mood line.
+ * 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 inclisively.
+ * 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 struct osl_row*, void *);
+typedef int mood_score_function(const char *path, const struct afs_info *afsi,
+ const struct audio_format_info *afhi, const void *data);
/**
- * Preprocess a mood line.
+ * 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
* 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 preprocess the data given in the mood line to compute a
+ * 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.
/** The data structure computed by the mood parser. */
void *parser_data;
/** The given score value, or zero if none was given. */
- long score_arg;
+ int32_t score_arg;
/** Non-zero if random scoring was requested. */
int random_score;
/** Whether the "not" keyword was given in the mood line. */
*
* When a mood is opened, each line of its definition is investigated, and a
* corresponding mood item is produced. Each mood line starts with \p accept,
- * \p deny, or \p score which determins the type of the mood line. For each
+ * \p deny, or \p score which determines the type of the mood line. For each
* such type a linked list is maintained whose entries are the mood items.
*
* \sa mood_item, mood_open().
*/
struct mood {
- /** the name of this mood */
+ /** The name of this mood. */
char *name;
/** The list of mood items of type \p accept. */
struct list_head accept_list;
return res;
}
-static int mm_played_rarely_score_function(const struct osl_row *row,
- __a_unused void *ignored)
+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 audio_format_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 audio_format_info *afhi,
+ __a_unused const void *data)
{
- struct afs_info afsi;
unsigned num;
- int ret = get_afsi_of_row(row, &afsi);
+ int ret = get_num_admissible_files(&num);
if (ret < 0)
return 0;
- ret = get_num_admissible_files(&num);
- if (ret < 0)
- return 0;
- if (statistics.num_played_sum - num * afsi.num_played
+ 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)
+ if (arg && *arg)
PARA_WARNING_LOG("ignored junk at eol: %s\n", arg);
return 1;
}
-static int mm_name_like_score_function(const struct osl_row *row, void *preg)
+static int mm_name_like_score_function(const char *path,
+ __a_unused const struct afs_info *afsi,
+ __a_unused const struct audio_format_info *afhi,
+ const void *data)
{
- char *path;
- int ret = get_audio_file_path_of_row(row, &path);
-
- if (ret < 0)
- return 0;
- ret = regexec((regex_t *)preg, path, 42, NULL, 0);
- return (ret == REG_NOMATCH)? -100 : 100;
+ if (fnmatch(data, path, 0))
+ return -100;
+ return 100;
}
-static int mm_name_like_parser(const char *arg, void **regex)
+static int mm_name_like_parser(const char *arg, void **data)
{
- regex_t *preg = para_malloc(sizeof(*preg));
- int ret = regcomp(preg, arg, REG_NOSUB);
-
- if (ret) {
- free(preg);
- return -E_MOOD_REGEX;
- }
- *regex = preg;
+ *data = para_strdup(arg);
return 1;
}
-static void mm_name_like_cleanup(void *preg)
+static void mm_name_like_cleanup(void *data)
{
- regfree(preg);
- free(preg);
+ free(data);
}
static int mm_is_set_parser(const char *arg, void **bitnum)
return ret;
}
-static int mm_is_set_score_function(const struct osl_row *row, void *bitnum)
+static int mm_is_set_score_function(__a_unused const char *path,
+ __a_unused const struct afs_info *afsi,
+ __a_unused const struct audio_format_info *afhi,
+ const void *data)
{
- unsigned char *bn = bitnum;
- struct afs_info afsi;
- int ret = get_afsi_of_row(row, &afsi);
-
- if (ret < 0)
- return 0;
- if (afsi.attributes & (1ULL << *bn))
+ const unsigned char *bn = data;
+ if (afsi->attributes & (1ULL << *bn))
return 100;
return -100;
}
-/* returns 1 if row matches score item, -1 otherwise */
-static int add_item_score(const void *row, struct mood_item *item, long *score,
+/* returns 1 if row matches score item, negative otherwise */
+static int add_item_score(const struct osl_row *row, struct mood_item *item, long *score,
long *score_arg_sum)
{
- int ret = 100;
+ struct afs_info afsi;
+ struct audio_format_info afhi;
+ char *path;
+ int ret;
*score_arg_sum += item->random_score? 100 : PARA_ABS(item->score_arg);
+ ret = 100;
if (item->method) {
- ret = item->method->score_function(row, item->parser_data);
+ ret = get_afsi_of_row(row, &afsi);
+ if (ret< 0)
+ return ret;
+ ret = get_afhi_of_row(row, &afhi);
+ if (ret< 0)
+ return ret;
+ ret = get_audio_file_path_of_row(row, &path);
+ if (ret< 0)
+ return ret;
+ ret = item->method->score_function(path, &afsi, &afhi,
+ item->parser_data);
if ((ret < 0 && !item->logical_not) || (ret >= 0 && item->logical_not))
return -1; /* no match */
}
return 1;
}
-static int compute_mood_score(const void *row, long *result)
+static int compute_mood_score(const struct osl_row *aft_row, struct mood *m,
+ long *result)
{
struct mood_item *item;
int match = 0;
long score_arg_sum = 0, score = 0;
- if (!current_mood)
+ if (!m)
return -E_NO_MOOD;
/* reject audio file if it matches any entry in the deny list */
- list_for_each_entry(item, ¤t_mood->deny_list, mood_item_node)
- if (add_item_score(row, item, &score, &score_arg_sum) > 0)
+ list_for_each_entry(item, &m->deny_list, mood_item_node)
+ if (add_item_score(aft_row, item, &score, &score_arg_sum) > 0)
return -E_NOT_ADMISSIBLE;
- list_for_each_entry(item, ¤t_mood->accept_list, mood_item_node)
- if (add_item_score(row, item, &score, &score_arg_sum) > 0)
+ list_for_each_entry(item, &m->accept_list, mood_item_node)
+ if (add_item_score(aft_row, item, &score, &score_arg_sum) > 0)
match = 1;
/* reject if there is no matching entry in the accept list */
- if (!match && !list_empty(¤t_mood->accept_list))
+ if (!match && !list_empty(&m->accept_list))
return -E_NOT_ADMISSIBLE;
- list_for_each_entry(item, ¤t_mood->score_list, mood_item_node)
- add_item_score(row, item, &score, &score_arg_sum);
+ list_for_each_entry(item, &m->score_list, mood_item_node)
+ add_item_score(aft_row, item, &score, &score_arg_sum);
if (score_arg_sum)
score /= score_arg_sum;
*result = score;
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[] = {
-{
- .parser = mm_played_rarely_parser,
- .score_function = mm_played_rarely_score_function,
- .name = "played_rarely"
-},
-{
- .parser = mm_is_set_parser,
- .score_function = mm_is_set_score_function,
- .name = "is_set"
-},
-{
- .parser = mm_name_like_parser,
- .score_function = mm_name_like_score_function,
- .cleanup = mm_name_like_cleanup,
- .name = "name_like"
-},
-{
- .parser = NULL
-}
+ {DEFINE_MOOD_METHOD(no_attributes_set)},
+ {DEFINE_MOOD_METHOD(played_rarely)},
+ {DEFINE_MOOD_METHOD(is_set)},
+ {DEFINE_MOOD_METHOD_WITH_CLEANUP(name_like)},
+ {.parser = NULL}
};
static void cleanup_list_entry(struct mood_item *item)
ML_SCORE
};
+struct mood_line_parser_data {
+ struct mood *m;
+ unsigned line_num;
+};
+
/*
* <accept [with score <score>] | deny [with score <score>] | score <score>>
* [if] [not] <mood_method> [options]
* all matching files
*/
-/* TODO: Use current_mood as private_data*/
-static int parse_mood_line(char *mood_line, __a_unused void *private_data)
+static int parse_mood_line(char *mood_line, void *data)
{
+ struct mood_line_parser_data *mlpd = data;
char **argv;
char *delim = " \t";
unsigned num_words;
int i, ret;
enum mood_line_type mlt = ML_INVALID;
struct mood_item *mi = NULL;
- struct mood *m = current_mood;
char *buf = para_strdup(mood_line);
+ mlpd->line_num++;
num_words = split_args(buf, &argv, delim);
ret = 1;
if (!num_words) /* empty line */
goto out;
if (strcmp(*w, "random")) {
mi->random_score = 0;
- ret = para_atol(*w, &mi->score_arg);
+ ret = para_atoi32(*w, &mi->score_arg);
if (ret < 0)
goto out;
} else {
goto out;
mi->method = &mood_methods[i];
success:
- if (mlt == ML_ACCEPT)
- para_list_add(&mi->mood_item_node, &m->accept_list);
- else if (mlt == ML_DENY)
- para_list_add(&mi->mood_item_node, &m->deny_list);
- else
- para_list_add(&mi->mood_item_node, &m->score_list);
+ if (mlpd->m) {
+ if (mlt == ML_ACCEPT)
+ para_list_add(&mi->mood_item_node, &mlpd->m->accept_list);
+ else if (mlt == ML_DENY)
+ para_list_add(&mi->mood_item_node, &mlpd->m->deny_list);
+ else
+ para_list_add(&mi->mood_item_node, &mlpd->m->score_list);
+ }
PARA_DEBUG_LOG("%s entry added, method: %p\n", mlt == ML_ACCEPT? "accept" :
(mlt == ML_DENY? "deny" : "score"), mi->method);
ret = 1;
return ret;
}
-static int load_mood(const void *row)
+static int load_mood(const struct osl_row *mood_row, struct mood **m)
{
- int ret;
- struct mood *new_mood, *old_mood = current_mood;
- struct osl_object objs[NUM_BLOB_COLUMNS];
+ 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);
- ret = osl_get_object(moods_table, row, BLOBCOL_NAME, &objs[BLOBCOL_NAME]);
if (ret < 0)
return ret;
- if (objs[BLOBCOL_NAME].size <= 1)
+ if (!*mood_name)
return -E_DUMMY_ROW;
- ret = osl_open_disk_object(moods_table, row, BLOBCOL_DEF, &objs[BLOBCOL_DEF]);
- if (ret < 0)
- return ret;
- new_mood = alloc_new_mood((char*)objs[BLOBCOL_NAME].data);
- current_mood = new_mood;
- ret = for_each_line_ro(objs[BLOBCOL_DEF].data, objs[BLOBCOL_DEF].size,
- parse_mood_line, NULL);
- osl_close_disk_object(&objs[BLOBCOL_DEF]);
+ mlpd.m = alloc_new_mood(mood_name);
+ ret = for_each_line_ro(mood_def.data, mood_def.size,
+ parse_mood_line, &mlpd);
+ osl_close_disk_object(&mood_def);
if (ret < 0) {
- PARA_ERROR_LOG("unable to load mood %s: %d\n",
- (char *)objs[BLOBCOL_NAME].data, ret);
- destroy_mood(new_mood);
- current_mood = old_mood;
+ PARA_ERROR_LOG("unable to load mood %s: %s\n", mlpd.m->name,
+ PARA_STRERROR(-ret));
+ destroy_mood(mlpd.m);
return ret;
}
- destroy_mood(old_mood);
- current_mood = new_mood;
- PARA_INFO_LOG("loaded mood %s\n", current_mood->name);
+ PARA_INFO_LOG("loaded mood %s\n", mlpd.m->name);
+ *m = mlpd.m;
return 1;
}
-/* returns -E_MOOD_LOADED on _success_ to terminate the loop */
-static int mood_loop(struct osl_row *row, __a_unused void *private_data)
+/*
+ * Calls load_mood() and reverts its error value: It returns -E_MOOD_LOADED
+ * on _success_, and 1 on errors. This way the loop over all moods stops at the
+ * first valid mood.
+ */
+static int load_mood_loop_func(struct osl_row *mood_row, void *data)
{
- int ret = load_mood(row);
+ struct mood **m = data;
+ int ret = load_mood(mood_row, m);
if (ret < 0) {
if (ret != -E_DUMMY_ROW)
PARA_NOTICE_LOG("invalid mood (%d), trying next mood\n", ret);
return -E_MOOD_LOADED;
}
-static int load_first_available_mood(void)
+static int load_first_available_mood(struct mood **m)
{
- int ret = osl_rbtree_loop(moods_table, BLOBCOL_NAME, NULL,
- mood_loop);
+ int ret = osl_rbtree_loop(moods_table, BLOBCOL_NAME, m,
+ load_mood_loop_func);
if (ret == -E_MOOD_LOADED) /* success */
return 1;
if (ret < 0)
return -E_NO_MOOD;
}
+static int check_mood(struct osl_row *mood_row, void *data)
+{
+ struct para_buffer *pb = data;
+ 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);
+
+ if (ret < 0) {
+ para_printf(pb, "failed to get mood definition\n");
+ return ret;
+ }
+ if (!*mood_name) /* ignore dummy row */
+ goto out;
+ para_printf(pb, "checking mood %s...\n", mood_name);
+ ret = for_each_line_ro(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,
+ PARA_STRERROR(-ret));
+out:
+ osl_close_disk_object(&mood_def);
+ return 1;
+}
+
+/**
+ * Check all moods for syntax errors.
+ *
+ * \param query Unused.
+ * \param result: Contains check messages.
+ */
+int mood_check_callback(__a_unused const struct osl_object *query,
+ struct osl_object *result)
+{
+ struct para_buffer pb = {.buf = NULL};
+
+ para_printf(&pb, "checking moods...\n");
+ osl_rbtree_loop(moods_table, BLOBCOL_ID, &pb,
+ check_mood);
+ result->data = pb.buf;
+ result->size = pb.size;
+ return 1;
+}
+
#if 0
static unsigned int_log2(uint64_t x)
{
struct admissible_file_info
{
/** The admissible audio file. */
- void *aft_row;
+ struct osl_row *aft_row;
/** Its score. */
long score;
};
/** The temporary array of admissible files. */
struct admissible_array {
+ /** Files are admissible wrt. this mood. */
+ struct mood *m;
/** The size of the array */
unsigned size;
/** Pointer to the array of admissible files. */
*
* \return Negative on errors, positive on success.
*/
-static int add_if_admissible(struct osl_row *aft_row, void *private_data)
+static int add_if_admissible(struct osl_row *aft_row, void *data)
{
+ struct admissible_array *aa = data;
int ret;
- struct admissible_array *aa = private_data;
long score = 0;
- score = 0;
- ret = compute_mood_score(aft_row, &score);
+ ret = compute_mood_score(aft_row, aa->m, &score);
if (ret < 0)
return (ret == -E_NOT_ADMISSIBLE)? 1 : ret;
if (statistics.num >= aa->size) {
*
* \param n Number of elements.
* \param old_qd The quadratic deviation before the change.
- * \param old_val The value that was repaced.
+ * \param old_val The value that was replaced.
* \param new_val The replacement value.
* \param old_sum The sum of all elements before the update.
*
}
/**
- * Delete one entry from the statitics and from the score table.
+ * Delete one entry from the statistics and from the score table.
*
* \param aft_row The audio file which is no longer admissible.
*
}
/**
- * Compute the new score of an audio file.
+ * Compute the new score of an audio file wrt. the current mood.
*
* \param aft_row Determines the audio file.
* \param old_afsi The audio file selector info before updating.
if (ret < 0)
return ret;
was_admissible = ret;
- ret = compute_mood_score(aft_row, &score);
+ ret = compute_mood_score(aft_row, current_mood, &score);
is_admissible = (ret > 0);
if (!was_admissible && !is_admissible)
return 1;
score += compute_num_played_score(&afsi);
score += compute_last_played_score(&afsi);
score /= 3;
- PARA_NOTICE_LOG("score: %li\n", score);
+ PARA_DEBUG_LOG("score: %li\n", score);
percent = (score + 100) / 3;
if (percent > 100)
percent = 100;
else if (percent < 0)
percent = 0;
- PARA_NOTICE_LOG("re-inserting at %lu%%\n", percent);
+ PARA_DEBUG_LOG("re-inserting at %lu%%\n", percent);
return score_update(aft_row, percent);
}
}
/**
- * Open the given mood.
+ * Change the current mood.
*
* \param mood_name The name of the mood to open.
*
* the dummy mood that accepts every audio file and uses a scoring method
* based only on the \a last_played information.
*
+ * If there is already an open mood, it will be closed first.
+ *
* \return Positive on success, negative on errors. Loading the dummy mood
* always succeeds.
*
* \sa struct admissible_file_info, struct admissible_array, struct
* afs_info::last_played, mood_close().
*/
-int mood_open(char *mood_name)
+int change_current_mood(char *mood_name)
{
int i, ret;
struct admissible_array aa = {
};
if (!mood_name) {
- ret = load_first_available_mood();
+ struct mood *m;
+ ret = load_first_available_mood(&m);
if (ret < 0)
return ret;
+ destroy_mood(current_mood);
+ current_mood = m;
} else if (*mood_name) {
+ struct mood *m;
struct osl_row *row;
struct osl_object obj = {
.data = mood_name,
PARA_NOTICE_LOG("no such mood: %s\n", mood_name);
return ret;
}
- ret = load_mood(row);
+ ret = load_mood(row, &m);
if (ret < 0)
return ret;
+ destroy_mood(current_mood);
+ current_mood = m;
} else {
destroy_mood(current_mood);
current_mood = alloc_new_mood("dummy");
}
+ aa.m = current_mood;
PARA_NOTICE_LOG("loaded mood %s\n", current_mood->name);
PARA_INFO_LOG("%s\n", "computing statistics of admissible files");
ret = audio_file_loop(&aa, add_if_admissible);
* Free all resources of the current mood which were allocated during
* mood_open().
*/
-void mood_close(void)
+void close_current_mood(void)
{
destroy_mood(current_mood);
current_mood = NULL;
*
* \sa mood_open(), mood_close().
*/
-int mood_reload(void)
+int reload_current_mood(void)
{
int ret;
char *mood_name;
return 1;
score_shutdown(0);
mood_name = para_strdup(current_mood->name);
- mood_close();
- ret = mood_open(mood_name);
+ close_current_mood();
+ ret = change_current_mood(mood_name);
free(mood_name);
return ret;
}