mood.c

   1 /*
   2  * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file mood.c Paraslash's mood handling functions. */
   8
   9 #include <regex.h>
  10 #include <osl.h>
  11
  12 #include "para.h"
  13 #include "error.h"
  14 #include "string.h"
  15 #include "afh.h"
  16 #include "afs.h"
  17 #include "list.h"
  18 #include "ipc.h"
  19 #include "mm.h"
  20 #include "sideband.h"
  21 #include "mood.h"
  22 #include "sched.h"
  23
  24 /**
  25  * Contains statistical data of the currently admissible audio files.
  26  *
  27  * It is used to assign normalized score values to each admissible audio file.
  28  */
  29 struct afs_statistics {
  30         /** Sum of num played over all admissible files. */
  31         int64_t num_played_sum;
  32         /** Sum of last played times over all admissible files. */
  33         int64_t last_played_sum;
  34         /** Quadratic deviation of num played count. */
  35         int64_t num_played_qd;
  36         /** Quadratic deviation of last played time. */
  37         int64_t last_played_qd;
  38         /** Number of admissible files */
  39         unsigned num;
  40 };
  41 static struct afs_statistics statistics;
  42
  43 /**
  44  * Each line of the current mood corresponds to a mood_item.
  45  */
  46 struct mood_item {
  47         /** The method this line is referring to. */
  48         const struct mood_method *method;
  49         /** The data structure computed by the mood parser. */
  50         void *parser_data;
  51         /** The given score value, or zero if none was given. */
  52         int32_t score_arg;
  53         /** Non-zero if random scoring was requested. */
  54         int random_score;
  55         /** Whether the "not" keyword was given in the mood line. */
  56         int logical_not;
  57         /** The position in the list of items. */
  58         struct list_head mood_item_node;
  59 };
  60
  61 /**
  62  * Created from the mood definition by mood_open().
  63  *
  64  * When a mood is opened, each line of its definition is investigated, and a
  65  * corresponding mood item is produced. Each mood line starts with \p accept,
  66  * \p deny, or \p score which determines the type of the mood line.  For each
  67  * such type a linked list is maintained whose entries are the mood items.
  68  *
  69  * \sa mood_item, mood_open().
  70  */
  71 struct mood {
  72         /** The name of this mood. */
  73         char *name;
  74         /** The list of mood items of type \p accept. */
  75         struct list_head accept_list;
  76         /** The list of mood items of type \p deny. */
  77         struct list_head deny_list;
  78         /** The list of mood items of type \p score. */
  79         struct list_head score_list;
  80 };
  81
  82 /*
  83  * If current_mood is NULL then no mood is currently open. If
  84  * current_mood->name is NULL, the dummy mood is currently open
  85  */
  86 static struct mood *current_mood;
  87
  88 /**
  89  * Rough approximation to sqrt.
  90  *
  91  * \param x Integer of which to calculate the sqrt.
  92  *
  93  * \return An integer res with res * res <= x.
  94  */
  95 __a_const static uint64_t int_sqrt(uint64_t x)
  96 {
  97         uint64_t op, res, one = 1;
  98         op = x;
  99         res = 0;
 100
 101         one = one << 62;
 102         while (one > op)
 103                 one >>= 2;
 104
 105         while (one != 0) {
 106                 if (op >= res + one) {
 107                         op = op - (res + one);
 108                         res = res +  2 * one;
 109                 }
 110                 res /= 2;
 111                 one /= 4;
 112         }
 113 //      PARA_NOTICE_LOG("sqrt(%llu) = %llu\n", x, res);
 114         return res;
 115 }
 116
 117 /*
 118  * Returns true if row matches, false if it does not match. In any case score
 119  * and score_arg_sum are set/increased accordingly.
 120  */
 121 static bool get_item_score(struct mood_item *item, const struct afs_info *afsi,
 122                 const struct afh_info *afhi, const char *path, long *score,
 123                 long *score_arg_sum)
 124 {
 125         int ret;
 126         bool match = true;
 127
 128         *score_arg_sum += item->random_score? 100 : PARA_ABS(item->score_arg);
 129         ret = 100;
 130         if (item->method) {
 131                 ret = item->method->score_function(path, afsi, afhi,
 132                         item->parser_data);
 133                 if ((ret < 0 && !item->logical_not) || (ret >= 0 && item->logical_not))
 134                         match = false;
 135         }
 136         if (item->random_score)
 137                 *score = PARA_ABS(ret) * para_random(100);
 138         else
 139                 *score = PARA_ABS(ret) * item->score_arg;
 140         return match;
 141 }
 142
 143 /* returns 1 if row admissible, 0 if not, negative on errors */
 144 static int compute_mood_score(const struct osl_row *aft_row, struct mood *m,
 145                 long *result)
 146 {
 147         struct mood_item *item;
 148         int ret;
 149         bool match;
 150         long score_arg_sum = 0, score = 0, item_score;
 151         struct afs_info afsi;
 152         struct afh_info afhi;
 153         char *path;
 154
 155         if (!m)
 156                 return -E_NO_MOOD;
 157         ret = get_afsi_of_row(aft_row, &afsi);
 158         if (ret< 0)
 159                 return ret;
 160         ret = get_afhi_of_row(aft_row, &afhi);
 161         if (ret< 0)
 162                 return ret;
 163         ret = get_audio_file_path_of_row(aft_row, &path);
 164         if (ret< 0)
 165                 return ret;
 166         /* reject audio file if it matches any entry in the deny list */
 167         list_for_each_entry(item, &m->deny_list, mood_item_node) {
 168                 match = get_item_score(item, &afsi, &afhi, path, &item_score,
 169                         &score_arg_sum);
 170                 if (match) /* not admissible */
 171                         return 0;
 172                 score += item_score;
 173         }
 174         match = false;
 175         list_for_each_entry(item, &m->accept_list, mood_item_node) {
 176                 ret = get_item_score(item, &afsi, &afhi, path, &item_score,
 177                         &score_arg_sum);
 178                 if (ret == 0)
 179                         continue;
 180                 match = true;
 181                 score += item_score;
 182         }
 183         /* reject if there is no matching entry in the accept list */
 184         if (!match && !list_empty(&m->accept_list))
 185                 return 0;
 186         list_for_each_entry(item, &m->score_list, mood_item_node) {
 187                 match = get_item_score(item, &afsi, &afhi, path, &item_score,
 188                         &score_arg_sum);
 189                 if (match)
 190                         score += item_score;
 191         }
 192         if (score_arg_sum)
 193                 score /= score_arg_sum;
 194         *result = score;
 195         return 1;
 196 }
 197
 198 static void cleanup_list_entry(struct mood_item *item)
 199 {
 200         if (item->method && item->method->cleanup)
 201                 item->method->cleanup(item->parser_data);
 202         else
 203                 free(item->parser_data);
 204         list_del(&item->mood_item_node);
 205         free(item);
 206 }
 207
 208 static void destroy_mood(struct mood *m)
 209 {
 210         struct mood_item *tmp, *item;
 211
 212         if (!m)
 213                 return;
 214         list_for_each_entry_safe(item, tmp, &m->accept_list, mood_item_node)
 215                 cleanup_list_entry(item);
 216         list_for_each_entry_safe(item, tmp, &m->deny_list, mood_item_node)
 217                 cleanup_list_entry(item);
 218         list_for_each_entry_safe(item, tmp, &m->score_list, mood_item_node)
 219                 cleanup_list_entry(item);
 220         free(m->name);
 221         free(m);
 222 }
 223
 224 static struct mood *alloc_new_mood(const char *name)
 225 {
 226         struct mood *m = para_calloc(sizeof(struct mood));
 227         if (name)
 228                 m->name = para_strdup(name);
 229         INIT_LIST_HEAD(&m->accept_list);
 230         INIT_LIST_HEAD(&m->deny_list);
 231         INIT_LIST_HEAD(&m->score_list);
 232         return m;
 233 }
 234
 235 /** The different types of a mood line. */
 236 enum mood_line_type {
 237         /** Invalid. */
 238         ML_INVALID,
 239         /** Accept line. */
 240         ML_ACCEPT,
 241         /** Deny line. */
 242         ML_DENY,
 243         /** Score line. */
 244         ML_SCORE
 245 };
 246
 247 /** Data passed to the parser of a mood line. */
 248 struct mood_line_parser_data {
 249         /** The mood this mood line belongs to. */
 250         struct mood *m;
 251         /** The line number in the mood definition. */
 252         unsigned line_num;
 253 };
 254
 255 /*
 256  * <accept [with score <score>] | deny [with score <score>]  | score <score>>
 257  *      [if] [not] <mood_method> [options]
 258  * <score> is either an integer or "random" which assigns a random score to
 259  * all matching files
 260  */
 261
 262 static int parse_mood_line(char *mood_line, void *data)
 263 {
 264         struct mood_line_parser_data *mlpd = data;
 265         char **argv;
 266         unsigned num_words;
 267         char **w;
 268         int i, ret;
 269         enum mood_line_type mlt = ML_INVALID;
 270         struct mood_item *mi = NULL;
 271
 272         mlpd->line_num++;
 273         ret = create_argv(mood_line, " \t", &argv);
 274         if (ret < 0)
 275                 return ret;
 276         num_words = ret;
 277         if (!num_words) /* empty line */
 278                 goto out;
 279         w = argv;
 280         if (**w == '#') /* comment */
 281                 goto out;
 282         if (!strcmp(*w, "accept"))
 283                 mlt = ML_ACCEPT;
 284         else if (!strcmp(*w, "deny"))
 285                 mlt = ML_DENY;
 286         else if (!strcmp(*w, "score"))
 287                 mlt = ML_SCORE;
 288         ret = -E_MOOD_SYNTAX;
 289         if (mlt == ML_INVALID)
 290                 goto out;
 291         mi = para_calloc(sizeof(struct mood_item));
 292         if (mlt != ML_SCORE) {
 293                 ret = -E_MOOD_SYNTAX;
 294                 w++;
 295                 if (!*w)
 296                         goto out;
 297                 if (strcmp(*w, "with"))
 298                         goto check_for_if;
 299                 w++;
 300                 if (!*w)
 301                         goto out;
 302                 if (strcmp(*w, "score"))
 303                         goto out;
 304         }
 305         if (mlt == ML_SCORE || !strcmp(*w, "score")) {
 306                 ret = -E_MOOD_SYNTAX;
 307                 w++;
 308                 if (!*w)
 309                         goto out;
 310                 if (strcmp(*w, "random")) {
 311                         mi->random_score = 0;
 312                         ret = para_atoi32(*w, &mi->score_arg);
 313                         if (ret < 0)
 314                                 goto out;
 315                 } else {
 316                         mi->random_score = 1;
 317                         if (!*(w + 1))
 318                         goto success; /* the line "score random" is valid */
 319                 }
 320         } else
 321                 mi->score_arg = 0;
 322         ret = -E_MOOD_SYNTAX;
 323         w++;
 324         if (!*w)
 325                 goto out;
 326 check_for_if:
 327         if (!strcmp(*w, "if")) {
 328                 ret = -E_MOOD_SYNTAX;
 329                 w++;
 330                 if (!*w)
 331                         goto out;
 332         }
 333         if (!strcmp(*w, "not")) {
 334                 ret = -E_MOOD_SYNTAX;
 335                 w++;
 336                 if (!*w)
 337                         goto out;
 338                 mi->logical_not = 1;
 339         } else
 340                 mi->logical_not = 0;
 341         for (i = 0; mood_methods[i].parser; i++) {
 342                 if (strcmp(*w, mood_methods[i].name))
 343                         continue;
 344                 break;
 345         }
 346         ret = -E_MOOD_SYNTAX;
 347         if (!mood_methods[i].parser)
 348                 goto out;
 349         ret = mood_methods[i].parser(num_words - 1 - (w - argv), w,
 350                 &mi->parser_data);
 351         if (ret < 0)
 352                 goto out;
 353         mi->method = &mood_methods[i];
 354 success:
 355         if (mlpd->m) {
 356                 if (mlt == ML_ACCEPT)
 357                         para_list_add(&mi->mood_item_node, &mlpd->m->accept_list);
 358                 else if (mlt == ML_DENY)
 359                         para_list_add(&mi->mood_item_node, &mlpd->m->deny_list);
 360                 else
 361                         para_list_add(&mi->mood_item_node, &mlpd->m->score_list);
 362         }
 363         PARA_DEBUG_LOG("%s entry added, method: %p\n", mlt == ML_ACCEPT? "accept" :
 364                 (mlt == ML_DENY? "deny" : "score"), mi->method);
 365         ret = 1;
 366 out:
 367         free_argv(argv);
 368         if (ret >= 0)
 369                 return ret;
 370         if (mi) {
 371                 free(mi->parser_data);
 372                 free(mi);
 373         }
 374         return ret;
 375 }
 376
 377 static int load_mood(const struct osl_row *mood_row, struct mood **m)
 378 {
 379         char *mood_name;
 380         struct osl_object mood_def;
 381         struct mood_line_parser_data mlpd = {.line_num = 0};
 382         int ret;
 383
 384         *m = NULL;
 385         ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
 386         if (ret < 0)
 387                 return ret;
 388         if (!*mood_name)
 389                 return -E_DUMMY_ROW;
 390         mlpd.m = alloc_new_mood(mood_name);
 391         ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
 392                 parse_mood_line, &mlpd);
 393         osl_close_disk_object(&mood_def);
 394         if (ret < 0) {
 395                 PARA_ERROR_LOG("unable to load mood %s: %s\n", mlpd.m->name,
 396                         para_strerror(-ret));
 397                 destroy_mood(mlpd.m);
 398                 return ret;
 399         }
 400         *m = mlpd.m;
 401         return 1;
 402 }
 403
 404 static int check_mood(struct osl_row *mood_row, void *data)
 405 {
 406         struct para_buffer *pb = data;
 407         char *mood_name;
 408         struct osl_object mood_def;
 409         struct mood_line_parser_data mlpd = {.line_num = 0};
 410
 411         int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
 412
 413         if (ret < 0) {
 414                 para_printf(pb, "cannot read mood\n");
 415                 return ret;
 416         }
 417         if (!*mood_name) /* ignore dummy row */
 418                 goto out;
 419         para_printf(pb, "checking mood %s...\n", mood_name);
 420         ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
 421                 parse_mood_line, &mlpd);
 422         if (ret < 0)
 423                 para_printf(pb, "mood %s: error in line %u: %s\n", mood_name,
 424                         mlpd.line_num, para_strerror(-ret));
 425         ret = 1; /* don't fail the loop on invalid mood definitions */
 426 out:
 427         osl_close_disk_object(&mood_def);
 428         return ret;
 429 }
 430
 431 /**
 432  * Check all moods for syntax errors.
 433  *
 434  * \param aca Only ->pbout is used for diagnostics.
 435  *
 436  * \return Negative on fatal errors. Inconsistent mood definitions are not
 437  * considered an error.
 438  */
 439 int mood_check_callback(struct afs_callback_arg *aca)
 440 {
 441         para_printf(&aca->pbout, "checking moods...\n");
 442         return osl(osl_rbtree_loop(moods_table, BLOBCOL_ID, &aca->pbout,
 443                 check_mood));
 444 }
 445
 446 static int64_t normalized_value(int64_t x, int64_t n, int64_t sum, int64_t qd)
 447 {
 448         if (!n || !qd)
 449                 return 0;
 450         return 100 * (n * x - sum) / (int64_t)int_sqrt(n) / (int64_t)int_sqrt(qd);
 451 }
 452
 453 static long compute_score(struct afs_info *afsi, long mood_score)
 454 {
 455         mood_score -= normalized_value(afsi->num_played, statistics.num,
 456                 statistics.num_played_sum, statistics.num_played_qd);
 457         mood_score -= normalized_value(afsi->last_played, statistics.num,
 458                 statistics.last_played_sum, statistics.last_played_qd);
 459         return mood_score / 3;
 460 }
 461
 462 static int add_afs_statistics(const struct osl_row *row)
 463 {
 464         uint64_t n, x, s, q;
 465         struct afs_info afsi;
 466         int ret;
 467
 468         ret = get_afsi_of_row(row, &afsi);
 469         if (ret < 0)
 470                 return ret;
 471         n = statistics.num;
 472         x = afsi.last_played;
 473         s = statistics.last_played_sum;
 474         if (n > 0) {
 475                 q = (x > s / n)? x - s / n : s / n - x;
 476                 statistics.last_played_qd += q * q * n / (n + 1);
 477         }
 478         statistics.last_played_sum += x;
 479
 480         x = afsi.num_played;
 481         s = statistics.num_played_sum;
 482         if (n > 0) {
 483                 q = (x > s / n)? x - s / n : s / n - x;
 484                 statistics.num_played_qd += q * q * n / (n + 1);
 485         }
 486         statistics.num_played_sum += x;
 487         statistics.num++;
 488         return 1;
 489 }
 490
 491 static int del_afs_statistics(const struct osl_row *row)
 492 {
 493         uint64_t n, s, q, a, new_s;
 494         struct afs_info afsi;
 495         int ret;
 496         ret = get_afsi_of_row(row, &afsi);
 497         if (ret < 0)
 498                 return ret;
 499         n = statistics.num;
 500         assert(n);
 501         if (n == 1) {
 502                 memset(&statistics, 0, sizeof(statistics));
 503                 return 1;
 504         }
 505
 506         s = statistics.last_played_sum;
 507         q = statistics.last_played_qd;
 508         a = afsi.last_played;
 509         new_s = s - a;
 510         statistics.last_played_sum = new_s;
 511         statistics.last_played_qd = q + s * s / n - a * a
 512                 - new_s * new_s / (n - 1);
 513
 514         s = statistics.num_played_sum;
 515         q = statistics.num_played_qd;
 516         a = afsi.num_played;
 517         new_s = s - a;
 518         statistics.num_played_sum = new_s;
 519         statistics.num_played_qd = q + s * s / n - a * a
 520                 - new_s * new_s / (n - 1);
 521
 522         statistics.num--;
 523         return 1;
 524 }
 525
 526 /**
 527  * Structure used during mood_open().
 528  *
 529  * At mood open time we determine the set of admissible files for the given
 530  * mood. The mood score of each admissible file is computed by adding up all
 531  * mood item scores. Next, we update the afs statistics and append a struct
 532  * admissible_file_info to a temporary array.
 533  *
 534  * When all files have been processed in this way, the final score of each
 535  * admissible file is computed by adding the dynamic score (which depends on
 536  * the afs_statistics and the current time) to the mood score. Finally, all
 537  * audio files in the temporary array are added to the score table and the
 538  * array is freed.
 539  *
 540  * \sa mood_method, admissible_array.
 541  */
 542 struct admissible_file_info
 543 {
 544         /** The admissible audio file. */
 545         struct osl_row *aft_row;
 546         /** Its score. */
 547         long score;
 548 };
 549
 550 /** The temporary array of admissible files. */
 551 struct admissible_array {
 552         /** Files are admissible wrt. this mood. */
 553         struct mood *m;
 554         /** The size of the array */
 555         unsigned size;
 556         /** Pointer to the array of admissible files. */
 557         struct admissible_file_info *array;
 558 };
 559
 560 /**
 561  * Add an entry to the array of admissible files.
 562  *
 563  * \param aft_row The audio file to be added.
 564  * \param private_data Pointer to a struct admissible_file_info.
 565  *
 566  * \return 1 if row admissible, 0 if not, negative on errors.
 567  */
 568 static int add_if_admissible(struct osl_row *aft_row, void *data)
 569 {
 570         struct admissible_array *aa = data;
 571         int ret;
 572         long score = 0;
 573
 574         ret = compute_mood_score(aft_row, aa->m, &score);
 575         if (ret <= 0)
 576                 return ret;
 577         if (statistics.num >= aa->size) {
 578                 aa->size *= 2;
 579                 aa->size += 100;
 580                 aa->array = para_realloc(aa->array,
 581                         aa->size * sizeof(struct admissible_file_info));
 582         }
 583         aa->array[statistics.num].aft_row = aft_row;
 584         aa->array[statistics.num].score = score;
 585         ret = add_afs_statistics(aft_row);
 586         if (ret < 0)
 587                 return ret;
 588         return 1;
 589 }
 590
 591 /**
 592  * Compute the new quadratic deviation in case one element changes.
 593  *
 594  * \param n Number of elements.
 595  * \param old_qd The quadratic deviation before the change.
 596  * \param old_val The value that was replaced.
 597  * \param new_val The replacement value.
 598  * \param old_sum The sum of all elements before the update.
 599  *
 600  * \return The new quadratic deviation resulting from replacing old_val
 601  * by new_val.
 602  *
 603  * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
 604  * their quadratic deviation
 605  *
 606  * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
 607  *
 608  * and a real number b, the quadratic deviation q' of a_1,...a_{n-1}, b (ie.
 609  * the last number a_n was replaced by b) may be computed in O(1) time in terms
 610  * of n, q, a_n, b, and S as
 611  *
 612  *      q' = q + d * s - (2 * S + d) * d / n
 613  *         = q + d * (s - 2 * S / n - d /n),
 614  *
 615  * where d = b - a_n, and s = b + a_n.
 616  *
 617  * Example: n = 3, a_1 = 3, a_2 = 5, a_3 = 7, b = 10. Then S = 15, q = 8, d = 3,
 618  * s = 17, so
 619  *
 620  *      q + d * s - (2 * S + d) * d / n = 8 + 51 - 33 = 26,
 621  *
 622  * which equals q' = (3 - 6)^2 + (5 - 6)^2 + (10 - 6)^2.
 623  *
 624  */
 625 _static_inline_ int64_t update_quadratic_deviation(int64_t n, int64_t old_qd,
 626                 int64_t old_val, int64_t new_val, int64_t old_sum)
 627 {
 628         int64_t delta = new_val - old_val;
 629         int64_t sigma = new_val + old_val;
 630         return old_qd + delta * (sigma - 2 * old_sum / n - delta / n);
 631 }
 632
 633 static int update_afs_statistics(struct afs_info *old_afsi, struct afs_info *new_afsi)
 634 {
 635         unsigned n;
 636         int ret = get_num_admissible_files(&n);
 637
 638         if (ret < 0)
 639                 return ret;
 640         assert(n);
 641
 642         statistics.last_played_qd = update_quadratic_deviation(n,
 643                 statistics.last_played_qd, old_afsi->last_played,
 644                 new_afsi->last_played, statistics.last_played_sum);
 645         statistics.last_played_sum += new_afsi->last_played - old_afsi->last_played;
 646
 647         statistics.num_played_qd = update_quadratic_deviation(n,
 648                 statistics.num_played_qd, old_afsi->num_played,
 649                 new_afsi->num_played, statistics.num_played_sum);
 650         statistics.num_played_sum += new_afsi->num_played - old_afsi->num_played;
 651         return 1;
 652 }
 653
 654 static int add_to_score_table(const struct osl_row *aft_row, long mood_score)
 655 {
 656         long score;
 657         struct afs_info afsi;
 658         int ret = get_afsi_of_row(aft_row, &afsi);
 659
 660         if (ret < 0)
 661                 return ret;
 662         score = compute_score(&afsi, mood_score);
 663         return score_add(aft_row, score);
 664 }
 665
 666 static int delete_from_statistics_and_score_table(const struct osl_row *aft_row)
 667 {
 668         int ret = del_afs_statistics(aft_row);
 669         if (ret < 0)
 670                 return ret;
 671         return score_delete(aft_row);
 672 }
 673
 674 /**
 675  * Delete one entry from the statistics and from the score table.
 676  *
 677  * \param aft_row The audio file which is no longer admissible.
 678  *
 679  * \return Positive on success, negative on errors.
 680  *
 681  * \sa score_delete().
 682  */
 683 static int mood_delete_audio_file(const struct osl_row *aft_row)
 684 {
 685         int ret;
 686
 687         ret = row_belongs_to_score_table(aft_row, NULL);
 688         if (ret < 0)
 689                 return ret;
 690         if (!ret) /* not admissible, nothing to do */
 691                 return 1;
 692         return delete_from_statistics_and_score_table(aft_row);
 693 }
 694
 695 /**
 696  * Compute the new score of an audio file wrt. the current mood.
 697  *
 698  * \param aft_row Determines the audio file.
 699  * \param old_afsi The audio file selector info before updating.
 700  *
 701  * The \a old_afsi argument may be \p NULL which indicates that no changes to
 702  * the audio file info were made.
 703  *
 704  * \return Positive on success, negative on errors.
 705  */
 706 static int mood_update_audio_file(const struct osl_row *aft_row,
 707                 struct afs_info *old_afsi)
 708 {
 709         long score, percent;
 710         int ret, is_admissible, was_admissible = 0;
 711         struct afs_info afsi;
 712         unsigned rank;
 713
 714         if (!current_mood)
 715                 return 1; /* nothing to do */
 716         ret = row_belongs_to_score_table(aft_row, &rank);
 717         if (ret < 0)
 718                 return ret;
 719         was_admissible = ret;
 720         ret = compute_mood_score(aft_row, current_mood, &score);
 721         if (ret < 0)
 722                 return ret;
 723         is_admissible = (ret > 0);
 724         if (!was_admissible && !is_admissible)
 725                 return 1;
 726         if (was_admissible && !is_admissible)
 727                 return delete_from_statistics_and_score_table(aft_row);
 728         if (!was_admissible && is_admissible) {
 729                 ret = add_afs_statistics(aft_row);
 730                 if (ret < 0)
 731                         return ret;
 732                 return add_to_score_table(aft_row, score);
 733         }
 734         /* update score */
 735         ret = get_afsi_of_row(aft_row, &afsi);
 736         if (ret < 0)
 737                 return ret;
 738         if (old_afsi) {
 739                 ret = update_afs_statistics(old_afsi, &afsi);
 740                 if (ret < 0)
 741                         return ret;
 742         }
 743         score = compute_score(&afsi, score);
 744         PARA_DEBUG_LOG("score: %li\n", score);
 745         percent = (score + 100) / 3;
 746         if (percent > 100)
 747                 percent = 100;
 748         else if (percent < 0)
 749                 percent = 0;
 750         PARA_DEBUG_LOG("moving from rank %u to %li%%\n", rank, percent);
 751         return score_update(aft_row, percent);
 752 }
 753
 754 static void log_statistics(void)
 755 {
 756         unsigned n = statistics.num;
 757         int mean_days, sigma_days;
 758         /*
 759          * We can not use the "now" pointer from sched.c here because we are
 760          * called before schedule(), which initializes "now".
 761          */
 762         struct timeval rnow;
 763
 764         assert(current_mood);
 765         PARA_NOTICE_LOG("loaded mood %s\n", current_mood->name?
 766                 current_mood->name : "(dummy)");
 767         if (!n) {
 768                 PARA_WARNING_LOG("no admissible files\n");
 769                 return;
 770         }
 771         PARA_NOTICE_LOG("%u admissible files\n", statistics.num);
 772         clock_get_realtime(&rnow);
 773         mean_days = (rnow.tv_sec - statistics.last_played_sum / n) / 3600 / 24;
 774         sigma_days = int_sqrt(statistics.last_played_qd / n) / 3600 / 24;
 775         PARA_NOTICE_LOG("last_played mean/sigma: %d/%d days\n", mean_days, sigma_days);
 776         PARA_NOTICE_LOG("num_played mean/sigma: %llu/%llu\n",
 777                 (long long unsigned)statistics.num_played_sum / n,
 778                 (long long unsigned)int_sqrt(statistics.num_played_qd / n));
 779 }
 780
 781 /**
 782  * Close the current mood.
 783  *
 784  * Free all resources of the current mood which were allocated during
 785  * mood_open().
 786  */
 787 void close_current_mood(void)
 788 {
 789         destroy_mood(current_mood);
 790         current_mood = NULL;
 791         memset(&statistics, 0, sizeof(statistics));
 792 }
 793
 794 /**
 795  * Change the current mood.
 796  *
 797  * \param mood_name The name of the mood to open.
 798  *
 799  * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
 800  * and uses a scoring method based only on the \a last_played information.
 801  *
 802  * If there is already an open mood, it will be closed first.
 803  *
 804  * \return Positive on success, negative on errors. Loading the dummy mood
 805  * always succeeds.
 806  *
 807  * \sa struct admissible_file_info, struct admissible_array, struct
 808  * afs_info::last_played, mood_close().
 809  */
 810 int change_current_mood(const char *mood_name)
 811 {
 812         int i, ret;
 813         struct admissible_array aa = {
 814                 .size = 0,
 815                 .array = NULL
 816         };
 817
 818         if (mood_name) {
 819                 struct mood *m;
 820                 struct osl_row *row;
 821                 struct osl_object obj = {
 822                         .data = (char *)mood_name,
 823                         .size = strlen(mood_name) + 1
 824                 };
 825                 ret = osl(osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row));
 826                 if (ret < 0) {
 827                         PARA_NOTICE_LOG("no such mood: %s\n", mood_name);
 828                         return ret;
 829                 }
 830                 ret = load_mood(row, &m);
 831                 if (ret < 0)
 832                         return ret;
 833                 close_current_mood();
 834                 current_mood = m;
 835         } else { /* load dummy mood */
 836                 close_current_mood();
 837                 current_mood = alloc_new_mood(NULL);
 838         }
 839         aa.m = current_mood;
 840         PARA_NOTICE_LOG("computing statistics of admissible files\n");
 841         ret = audio_file_loop(&aa, add_if_admissible);
 842         if (ret < 0)
 843                 return ret;
 844         for (i = 0; i < statistics.num; i++) {
 845                 struct admissible_file_info *a = aa.array + i;
 846                 ret = add_to_score_table(a->aft_row, a->score);
 847                 if (ret < 0)
 848                         goto out;
 849         }
 850         log_statistics();
 851         ret = statistics.num;
 852 out:
 853         free(aa.array);
 854         return ret;
 855 }
 856 /**
 857  * Close and re-open the current mood.
 858  *
 859  * This function is used if changes to the audio file table or the
 860  * attribute table were made that render the current list of admissible
 861  * files useless. For example, if an attribute is removed from the
 862  * attribute table, this function is called.
 863  *
 864  * \return Positive on success, negative on errors. If no mood is currently
 865  * open, the function returns success.
 866  *
 867  * \sa mood_open(), mood_close().
 868  */
 869 static int reload_current_mood(void)
 870 {
 871         int ret;
 872         char *mood_name = NULL;
 873
 874         ret = clear_score_table();
 875         if (ret < 0)
 876                 return ret;
 877         if (!current_mood)
 878                 return 1;
 879         PARA_NOTICE_LOG("reloading %s\n", current_mood->name?
 880                 current_mood->name : "(dummy)");
 881         if (current_mood->name)
 882                 mood_name = para_strdup(current_mood->name);
 883         close_current_mood();
 884         ret = change_current_mood(mood_name);
 885         free(mood_name);
 886         return ret;
 887 }
 888
 889 /**
 890  * Notification callback for the moods table.
 891  *
 892  * \param event Type of the event just occurred.
 893  * \param pb Unused.
 894  * \param data Its type depends on the event.
 895  *
 896  * This function performs actions required due to the occurrence of the given
 897  * event. Possible actions include reload of the current mood and update of the
 898  * score of an audio file.
 899  *
 900  * \return Standard.
 901  */
 902 int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb,
 903                 void *data)
 904 {
 905         if (!current_mood)
 906                 return 0;
 907         switch (event) {
 908         /*
 909          * The three blob events might change the set of admissible files,
 910          * so we must reload the score list.
 911          */
 912         case BLOB_RENAME:
 913         case BLOB_REMOVE:
 914         case BLOB_ADD:
 915                 if (data == moods_table || data == playlists_table)
 916                         return 1; /* no reload necessary for these */
 917                 return reload_current_mood();
 918         /* these also require reload of the score table */
 919         case ATTRIBUTE_ADD:
 920         case ATTRIBUTE_REMOVE:
 921         case ATTRIBUTE_RENAME:
 922                 return reload_current_mood();
 923         /* changes to the aft only require to re-examine the audio file */
 924         case AFSI_CHANGE: {
 925                 struct afsi_change_event_data *aced = data;
 926                 return mood_update_audio_file(aced->aft_row, aced->old_afsi);
 927                 }
 928         case AFHI_CHANGE:
 929         case AUDIO_FILE_RENAME:
 930         case AUDIO_FILE_ADD:
 931                 return mood_update_audio_file(data, NULL);
 932         case AUDIO_FILE_REMOVE:
 933                 return mood_delete_audio_file(data);
 934         default:
 935                 return 1;
 936         }
 937 }