More mood cleanups.
[paraslash.git] / mood.c
diff --git a/mood.c b/mood.c
index decc77fc74f407b901ac13b59e18afe32da308e5..61332461d7bbed500723452fb956c3dd05cf416b 100644 (file)
--- a/mood.c
+++ b/mood.c
@@ -1,3 +1,11 @@
+/*
+ * 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 "para.h"
 #include "error.h"
 #include "afh.h"
@@ -5,8 +13,6 @@
 #include "list.h"
 #include "string.h"
 
-/** \file mood.c Paraslash's mood handling functions. */
-
 /**
  * Contains statistical data of the currently admissible audio files.
  *
@@ -115,7 +121,7 @@ struct mood_item {
  * \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;
@@ -237,7 +243,7 @@ static int mm_is_set_score_function(const struct osl_row *row, void *bitnum)
 }
 
 /* returns 1 if row matches score item, -1 otherwise */
-static int add_item_score(const void *row, struct mood_item *item, long *score,
+static int add_item_score(const struct osl_row *row, struct mood_item *item, long *score,
                long *score_arg_sum)
 {
        int ret = 100;
@@ -255,26 +261,27 @@ static int add_item_score(const void *row, struct mood_item *item, long *score,
        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, &current_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, &current_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(&current_mood->accept_list))
+       if (!match && !list_empty(&m->accept_list))
                return -E_NOT_ADMISSIBLE;
-       list_for_each_entry(item, &current_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;
@@ -358,9 +365,9 @@ enum mood_line_type {
  * 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 *m = data;
        char **argv;
        char *delim = " \t";
        unsigned num_words;
@@ -368,7 +375,6 @@ static int parse_mood_line(char *mood_line, __a_unused void *private_data)
        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);
 
        num_words = split_args(buf, &argv, delim);
@@ -469,42 +475,38 @@ out:
        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];
 
-       ret = osl_get_object(moods_table, row, BLOBCOL_NAME, &objs[BLOBCOL_NAME]);
+       ret = osl_get_object(moods_table, mood_row, BLOBCOL_NAME, &objs[BLOBCOL_NAME]);
        if (ret < 0)
                return ret;
        if (objs[BLOBCOL_NAME].size <= 1)
                return -E_DUMMY_ROW;
-       ret = osl_open_disk_object(moods_table, row, BLOBCOL_DEF, &objs[BLOBCOL_DEF]);
+       ret = osl_open_disk_object(moods_table, mood_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;
+       *m = alloc_new_mood((char*)objs[BLOBCOL_NAME].data);
        ret = for_each_line_ro(objs[BLOBCOL_DEF].data, objs[BLOBCOL_DEF].size,
-               parse_mood_line, NULL);
+               parse_mood_line, *m);
        osl_close_disk_object(&objs[BLOBCOL_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", (*m)->name,
+                       PARA_STRERROR(-ret));
+               destroy_mood(*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", (*m)->name);
        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)
+static int mood_loop(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);
@@ -513,9 +515,9 @@ static int mood_loop(struct osl_row *row, __a_unused void *private_data)
        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,
+       int ret = osl_rbtree_loop(moods_table, BLOBCOL_NAME, m,
                mood_loop);
        if (ret == -E_MOOD_LOADED) /* success */
                return 1;
@@ -651,13 +653,15 @@ static int del_afs_statistics(const struct osl_row *row)
 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. */
@@ -672,14 +676,13 @@ struct admissible_array {
  *
  * \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) {
@@ -794,7 +797,7 @@ int mood_delete_audio_file(const struct osl_row *aft_row)
 }
 
 /**
- * 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.
@@ -816,7 +819,7 @@ int mood_update_audio_file(const struct osl_row *aft_row, struct afs_info *old_a
        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;
@@ -840,13 +843,13 @@ int mood_update_audio_file(const struct osl_row *aft_row, struct afs_info *old_a
        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);
 }
 
@@ -858,14 +861,16 @@ static void log_statistics(void)
                PARA_NOTICE_LOG("no admissible files\n");
                return;
        }
-       PARA_NOTICE_LOG("last_played mean: %lli, last_played sigma: %lli\n",
-               statistics.last_played_sum / n, int_sqrt(statistics.last_played_qd / n));
-       PARA_NOTICE_LOG("num_played mean: %lli, num_played sigma: %lli\n",
-               statistics.num_played_sum / n, int_sqrt(statistics.num_played_qd / n));
+       PARA_NOTICE_LOG("last_played mean: %lli, last_played sigma: %llu\n",
+               (long long int)(statistics.last_played_sum / n),
+               (long long unsigned)int_sqrt(statistics.last_played_qd / n));
+       PARA_NOTICE_LOG("num_played mean: %lli, num_played sigma: %llu\n",
+               (long long int)statistics.num_played_sum / n,
+               (long long unsigned)int_sqrt(statistics.num_played_qd / n));
 }
 
 /**
- * Open the given mood.
+ * Change the current mood.
  *
  * \param mood_name The name of the mood to open.
  *
@@ -874,13 +879,15 @@ static void log_statistics(void)
  * 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 = {
@@ -889,10 +896,14 @@ int mood_open(char *mood_name)
        };
 
        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,
@@ -903,13 +914,16 @@ int mood_open(char *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);
@@ -936,7 +950,7 @@ out:
  * 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;
@@ -956,7 +970,7 @@ void mood_close(void)
  *
  * \sa mood_open(), mood_close().
  */
-int mood_reload(void)
+int reload_current_mood(void)
 {
        int ret;
        char *mood_name;
@@ -965,8 +979,8 @@ int mood_reload(void)
                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;
 }