mood.c

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