mood.c

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