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