mood.c

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