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