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