mood.c

   1 /* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
   2
   3 /** \file mood.c Paraslash's mood handling functions. */
   4
   5 #include <regex.h>
   6 #include <osl.h>
   7 #include <lopsub.h>
   8
   9 #include "para.h"
  10 #include "error.h"
  11 #include "string.h"
  12 #include "afh.h"
  13 #include "afs.h"
  14 #include "list.h"
  15 #include "mood.h"
  16
  17 /*
  18  * Mood parser API. It's overkill to have an own header file for
  19  * these declarations as they are only needed in this .c file.
  20  */
  21 struct mp_context;
  22 int mp_init(const char *definition, int nbytes, struct mp_context **result,
  23                  char **errmsg);
  24 bool mp_eval_row(const struct osl_row *aft_row, struct mp_context *ctx);
  25 void mp_shutdown(struct mp_context *ctx);
  26
  27 /**
  28  * Contains statistical data of the currently admissible audio files.
  29  *
  30  * It is used to assign normalized score values to each admissible audio file.
  31  */
  32 struct afs_statistics {
  33         /** Sum of num played over all admissible files. */
  34         int64_t num_played_sum;
  35         /** Sum of last played times over all admissible files. */
  36         int64_t last_played_sum;
  37         /** Quadratic deviation of num played count. */
  38         int64_t num_played_qd;
  39         /** Quadratic deviation of last played time. */
  40         int64_t last_played_qd;
  41         /** Correction factor for the num played score. */
  42         int64_t num_played_correction;
  43         /** Correction factor for the last played score. */
  44         int64_t last_played_correction;
  45         /** Common divisor of the correction factors. */
  46         int64_t normalization_divisor;
  47         /** Number of admissible files */
  48         unsigned num;
  49 };
  50 static struct afs_statistics statistics = {.normalization_divisor = 1};
  51
  52 struct mood {
  53         /** The name of this mood. */
  54         char *name;
  55         /** Info for the bison parser. */
  56         struct mp_context *parser_context;
  57 };
  58
  59 /*
  60  * If current_mood is NULL then no mood is currently open. If
  61  * current_mood->name is NULL, the dummy mood is currently open.
  62  */
  63 static struct mood *current_mood;
  64
  65 /*
  66  * Find the position of the most-significant set bit.
  67  *
  68  * Copied and slightly adapted from the linux source tree, version 4.9.39
  69  * (2017-07).
  70  */
  71 __a_const static uint32_t fls64(uint64_t v)
  72 {
  73         int n = 63;
  74         const uint64_t ones = ~(uint64_t)0U;
  75
  76         if ((v & (ones << 32)) == 0) {
  77                 n -= 32;
  78                 v <<= 32;
  79         }
  80         if ((v & (ones << (64 - 16))) == 0) {
  81                 n -= 16;
  82                 v <<= 16;
  83         }
  84         if ((v & (ones << (64 - 8))) == 0) {
  85                 n -= 8;
  86                 v <<= 8;
  87         }
  88         if ((v & (ones << (64 - 4))) == 0) {
  89                 n -= 4;
  90                 v <<= 4;
  91         }
  92         if ((v & (ones << (64 - 2))) == 0) {
  93                 n -= 2;
  94                 v <<= 2;
  95         }
  96         if ((v & (ones << (64 - 1))) == 0)
  97                 n -= 1;
  98         return n;
  99 }
 100
 101 /*
 102  * Compute the integer square root floor(sqrt(x)).
 103  *
 104  * Taken 2007 from the linux source tree.
 105  */
 106 __a_const static uint64_t int_sqrt(uint64_t x)
 107 {
 108         uint64_t op = x, res = 0, one = 1;
 109
 110         one = one << (fls64(x) & ~one);
 111         while (one != 0) {
 112                 if (op >= res + one) {
 113                         op = op - (res + one);
 114                         res = res + 2 * one;
 115                 }
 116                 res /= 2;
 117                 one /= 4;
 118         }
 119         return res;
 120 }
 121
 122 static void destroy_mood(struct mood *m)
 123 {
 124         if (!m)
 125                 return;
 126         mp_shutdown(m->parser_context);
 127         free(m->name);
 128         free(m);
 129 }
 130
 131 static struct mood *alloc_new_mood(const char *name)
 132 {
 133         struct mood *m = zalloc(sizeof(struct mood));
 134         if (name)
 135                 m->name = para_strdup(name);
 136         return m;
 137 }
 138
 139 static int load_mood(const struct osl_row *mood_row, struct mood **m,
 140                 char **errmsg)
 141 {
 142         char *mood_name;
 143         struct osl_object mood_def;
 144         int ret;
 145
 146         ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
 147         if (ret < 0) {
 148                 if (errmsg)
 149                         *errmsg = make_message(
 150                                 "could not read mood definition");
 151                 return ret;
 152         }
 153         assert(*mood_name);
 154         *m = alloc_new_mood(mood_name);
 155         PARA_INFO_LOG("opening mood %s\n", mood_name);
 156         ret = mp_init(mood_def.data, mood_def.size, &(*m)->parser_context, errmsg);
 157         osl_close_disk_object(&mood_def);
 158         if (ret < 0)
 159                 destroy_mood(*m);
 160         return ret;
 161 }
 162
 163 static int check_mood(struct osl_row *mood_row, void *data)
 164 {
 165         struct para_buffer *pb = data;
 166         char *mood_name, *errmsg;
 167         struct osl_object mood_def;
 168         struct mood *m;
 169         int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
 170
 171         if (ret < 0) {
 172                 para_printf(pb, "cannot read mood\n");
 173                 return ret;
 174         }
 175         if (!*mood_name) /* ignore dummy row */
 176                 goto out;
 177         m = alloc_new_mood("check");
 178         ret = mp_init(mood_def.data, mood_def.size, &m->parser_context,
 179                 &errmsg);
 180         if (ret < 0) {
 181                 para_printf(pb, "%s: %s\n", mood_name, errmsg);
 182                 free(errmsg);
 183                 para_printf(pb, "%s\n", para_strerror(-ret));
 184         } else
 185                 destroy_mood(m);
 186         ret = 1; /* don't fail the loop on invalid mood definitions */
 187 out:
 188         osl_close_disk_object(&mood_def);
 189         return ret;
 190 }
 191
 192 /**
 193  * Check all moods for syntax errors.
 194  *
 195  * \param aca Only ->pbout is used for diagnostics.
 196  *
 197  * \return Negative on fatal errors. Inconsistent mood definitions are not
 198  * considered an error.
 199  */
 200 int mood_check_callback(struct afs_callback_arg *aca)
 201 {
 202         para_printf(&aca->pbout, "checking moods...\n");
 203         return osl(osl_rbtree_loop(moods_table, BLOBCOL_ID, &aca->pbout,
 204                 check_mood));
 205 }
 206
 207 /*
 208  * The normalized num_played and last_played values are defined as
 209  *
 210  *      nn := -(np - mean_n) / sigma_n and nl := -(lp - mean_l) / sigma_l
 211  *
 212  *  For a (hypothetical) file with np = 0 and lp = now we thus have
 213  *
 214  *      nn =  mean_n / sigma_n =: hn > 0
 215  *      nl = -(now - mean_l) / sigma_l =: hl < 0
 216  *
 217  * We design the score function so that both contributions get the same
 218  * weight. Define the np and lp score of an arbitrary file as
 219  *
 220  *      sn := nn * -hl and sl := nl * hn
 221  *
 222  * Example:
 223  *      num_played mean/sigma: 87/14
 224  *      last_played mean/sigma: 45/32 days
 225  *
 226  *      We have hn = 87 / 14 = 6.21 and hl = -45 / 32 = -1.41. Multiplying
 227  *      nn of every file with the correction factor 1.41 and nl with
 228  *      6.21 makes the weight of the two contributions equal.
 229  *
 230  * The total score s := sn + sl has the representation
 231  *
 232  *      s = -cn * (np - mean_n) - cl * (lp - mean_l)
 233  *
 234  * with positive correction factors
 235  *
 236  *      cn = (now - mean_l) / (sqrt(ql) * sqrt(qn) / n)
 237  *      cl = mean_n / (sqrt(ql) * sqrt(qn) / n)
 238  *
 239  * where ql and qn are the quadratic deviations stored in the statistics
 240  * structure and n is the number of admissible files. To avoid integer
 241  * overflows and rounding errors we store the common divisor of the
 242  * correction factors separately.
 243  */
 244 static int64_t normalized_value(int64_t x, int64_t n, int64_t sum, int64_t qd)
 245 {
 246         if (!n || !qd)
 247                 return 0;
 248         return 100 * (n * x - sum) / (int64_t)int_sqrt(n) / (int64_t)int_sqrt(qd);
 249 }
 250
 251 static long compute_score(struct afs_info *afsi)
 252 {
 253         long score = -normalized_value(afsi->num_played, statistics.num,
 254                 statistics.num_played_sum, statistics.num_played_qd);
 255         score -= normalized_value(afsi->last_played, statistics.num,
 256                 statistics.last_played_sum, statistics.last_played_qd);
 257         return score / 2;
 258 }
 259
 260 static int add_afs_statistics(const struct osl_row *row)
 261 {
 262         uint64_t n, x, s, q;
 263         struct afs_info afsi;
 264         int ret;
 265
 266         ret = get_afsi_of_row(row, &afsi);
 267         if (ret < 0)
 268                 return ret;
 269         n = statistics.num;
 270         x = afsi.last_played;
 271         s = statistics.last_played_sum;
 272         if (n > 0) {
 273                 q = (x > s / n)? x - s / n : s / n - x;
 274                 statistics.last_played_qd += q * q * n / (n + 1);
 275         }
 276         statistics.last_played_sum += x;
 277
 278         x = afsi.num_played;
 279         s = statistics.num_played_sum;
 280         if (n > 0) {
 281                 q = (x > s / n)? x - s / n : s / n - x;
 282                 statistics.num_played_qd += q * q * n / (n + 1);
 283         }
 284         statistics.num_played_sum += x;
 285         statistics.num++;
 286         return 1;
 287 }
 288
 289 static int del_afs_statistics(const struct osl_row *row)
 290 {
 291         uint64_t n, s, q, a, new_s;
 292         struct afs_info afsi;
 293         int ret;
 294         ret = get_afsi_of_row(row, &afsi);
 295         if (ret < 0)
 296                 return ret;
 297         n = statistics.num;
 298         assert(n);
 299         if (n == 1) {
 300                 memset(&statistics, 0, sizeof(statistics));
 301                 statistics.normalization_divisor = 1;
 302                 return 1;
 303         }
 304
 305         s = statistics.last_played_sum;
 306         q = statistics.last_played_qd;
 307         a = afsi.last_played;
 308         new_s = s - a;
 309         statistics.last_played_sum = new_s;
 310         statistics.last_played_qd = q + s * s / n - a * a
 311                 - new_s * new_s / (n - 1);
 312
 313         s = statistics.num_played_sum;
 314         q = statistics.num_played_qd;
 315         a = afsi.num_played;
 316         new_s = s - a;
 317         statistics.num_played_sum = new_s;
 318         statistics.num_played_qd = q + s * s / n - a * a
 319                 - new_s * new_s / (n - 1);
 320
 321         statistics.num--;
 322         return 1;
 323 }
 324
 325 /*
 326  * At mood open time we determine the set of admissible files for the given
 327  * mood where each file is identified by a pointer to a row of the audio file
 328  * table. In the first pass the pointers are added to a temporary array and
 329  * statistics are computed. When all admissible files have been processed in
 330  * this way, the score of each admissible file is computed and the (row, score)
 331  * pair is added to the score table. This has to be done in a second pass
 332  * since the score depends on the statistics. Finally, the array is freed.
 333  */
 334 struct admissible_array {
 335         /** Files are admissible wrt. this mood. */
 336         struct mood *m;
 337         /** The size of the array */
 338         unsigned size;
 339         /** Pointer to the array of admissible files. */
 340         struct osl_row **array;
 341 };
 342
 343 /*
 344  * Check whether the given audio file is admissible. If it is, add it to array
 345  * of admissible files.
 346  */
 347 static int add_if_admissible(struct osl_row *aft_row, void *data)
 348 {
 349         struct admissible_array *aa = data;
 350
 351         if (!mp_eval_row(aft_row, aa->m->parser_context))
 352                 return 0;
 353         if (statistics.num >= aa->size) {
 354                 aa->size *= 2;
 355                 aa->size += 100;
 356                 aa->array = arr_realloc(aa->array, aa->size,
 357                         sizeof(struct osl_row *));
 358         }
 359         aa->array[statistics.num] = aft_row;
 360         return add_afs_statistics(aft_row);
 361 }
 362
 363 /**
 364  * Compute the new quadratic deviation in case one element changes.
 365  *
 366  * \param n Number of elements.
 367  * \param old_qd The quadratic deviation before the change.
 368  * \param old_val The value that was replaced.
 369  * \param new_val The replacement value.
 370  * \param old_sum The sum of all elements before the update.
 371  *
 372  * \return The new quadratic deviation resulting from replacing old_val
 373  * by new_val.
 374  *
 375  * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
 376  * their quadratic deviation
 377  *
 378  * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
 379  *
 380  * and a real number b, the quadratic deviation q' of a_1,...a_{n-1}, b (ie.
 381  * the last number a_n was replaced by b) may be computed in O(1) time in terms
 382  * of n, q, a_n, b, and S as
 383  *
 384  *      q' = q + d * s - (2 * S + d) * d / n
 385  *         = q + d * (s - 2 * S / n - d /n),
 386  *
 387  * where d = b - a_n, and s = b + a_n.
 388  *
 389  * Example: n = 3, a_1 = 3, a_2 = 5, a_3 = 7, b = 10. Then S = 15, q = 8, d = 3,
 390  * s = 17, so
 391  *
 392  *      q + d * s - (2 * S + d) * d / n = 8 + 51 - 33 = 26,
 393  *
 394  * which equals q' = (3 - 6)^2 + (5 - 6)^2 + (10 - 6)^2.
 395  *
 396  */
 397 _static_inline_ int64_t update_quadratic_deviation(int64_t n, int64_t old_qd,
 398                 int64_t old_val, int64_t new_val, int64_t old_sum)
 399 {
 400         int64_t delta = new_val - old_val;
 401         int64_t sigma = new_val + old_val;
 402         return old_qd + delta * (sigma - 2 * old_sum / n - delta / n);
 403 }
 404
 405 static int update_afs_statistics(struct afs_info *old_afsi,
 406                 struct afs_info *new_afsi)
 407 {
 408         unsigned n = statistics.num;
 409         assert(n);
 410
 411         statistics.last_played_qd = update_quadratic_deviation(n,
 412                 statistics.last_played_qd, old_afsi->last_played,
 413                 new_afsi->last_played, statistics.last_played_sum);
 414         statistics.last_played_sum += new_afsi->last_played - old_afsi->last_played;
 415
 416         statistics.num_played_qd = update_quadratic_deviation(n,
 417                 statistics.num_played_qd, old_afsi->num_played,
 418                 new_afsi->num_played, statistics.num_played_sum);
 419         statistics.num_played_sum += new_afsi->num_played - old_afsi->num_played;
 420         return 1;
 421 }
 422
 423 static int add_to_score_table(const struct osl_row *aft_row)
 424 {
 425         long score;
 426         struct afs_info afsi;
 427         int ret = get_afsi_of_row(aft_row, &afsi);
 428
 429         if (ret < 0)
 430                 return ret;
 431         score = compute_score(&afsi);
 432         return score_add(aft_row, score);
 433 }
 434
 435 static int delete_from_statistics_and_score_table(const struct osl_row *aft_row)
 436 {
 437         int ret = del_afs_statistics(aft_row);
 438         if (ret < 0)
 439                 return ret;
 440         return score_delete(aft_row);
 441 }
 442
 443 /**
 444  * Delete one entry from the statistics and from the score table.
 445  *
 446  * \param aft_row The audio file which is no longer admissible.
 447  *
 448  * \return Positive on success, negative on errors.
 449  *
 450  * \sa \ref score_delete().
 451  */
 452 static int mood_delete_audio_file(const struct osl_row *aft_row)
 453 {
 454         int ret;
 455
 456         ret = row_belongs_to_score_table(aft_row, NULL);
 457         if (ret < 0)
 458                 return ret;
 459         if (!ret) /* not admissible, nothing to do */
 460                 return 1;
 461         return delete_from_statistics_and_score_table(aft_row);
 462 }
 463
 464 /**
 465  * Compute the new score of an audio file wrt. the current mood.
 466  *
 467  * \param aft_row Determines the audio file.
 468  * \param old_afsi The audio file selector info before updating.
 469  *
 470  * The \a old_afsi argument may be \p NULL which indicates that no changes to
 471  * the audio file info were made.
 472  *
 473  * \return Positive on success, negative on errors.
 474  */
 475 static int mood_update_audio_file(const struct osl_row *aft_row,
 476                 struct afs_info *old_afsi)
 477 {
 478         long score, percent;
 479         int ret;
 480         bool is_admissible, was_admissible;
 481         struct afs_info afsi;
 482         unsigned rank;
 483
 484         if (!current_mood)
 485                 return 1; /* nothing to do */
 486         ret = row_belongs_to_score_table(aft_row, &rank);
 487         if (ret < 0)
 488                 return ret;
 489         was_admissible = ret;
 490         is_admissible = mp_eval_row(aft_row, current_mood->parser_context);
 491         if (!was_admissible && !is_admissible)
 492                 return 1;
 493         if (was_admissible && !is_admissible)
 494                 return delete_from_statistics_and_score_table(aft_row);
 495         if (!was_admissible && is_admissible) {
 496                 ret = add_afs_statistics(aft_row);
 497                 if (ret < 0)
 498                         return ret;
 499                 return add_to_score_table(aft_row);
 500         }
 501         /* update score */
 502         ret = get_afsi_of_row(aft_row, &afsi);
 503         if (ret < 0)
 504                 return ret;
 505         if (old_afsi) {
 506                 ret = update_afs_statistics(old_afsi, &afsi);
 507                 if (ret < 0)
 508                         return ret;
 509         }
 510         score = compute_score(&afsi);
 511         PARA_DEBUG_LOG("score: %li\n", score);
 512         percent = (score + 100) / 3;
 513         if (percent > 100)
 514                 percent = 100;
 515         else if (percent < 0)
 516                 percent = 0;
 517         PARA_DEBUG_LOG("moving from rank %u to %li%%\n", rank, percent);
 518         return score_update(aft_row, percent);
 519 }
 520
 521 /* sse: seconds since epoch. */
 522 static void log_statistics(int64_t sse)
 523 {
 524         unsigned n = statistics.num;
 525         int mean_days, sigma_days;
 526
 527         assert(current_mood);
 528         PARA_NOTICE_LOG("loaded mood %s\n", current_mood->name?
 529                 current_mood->name : "(dummy)");
 530         if (!n) {
 531                 PARA_WARNING_LOG("no admissible files\n");
 532                 return;
 533         }
 534         PARA_NOTICE_LOG("%u admissible files\n", statistics.num);
 535         mean_days = (sse - statistics.last_played_sum / n) / 3600 / 24;
 536         sigma_days = int_sqrt(statistics.last_played_qd / n) / 3600 / 24;
 537         PARA_NOTICE_LOG("last_played mean/sigma: %d/%d days\n", mean_days, sigma_days);
 538         PARA_NOTICE_LOG("num_played mean/sigma: %" PRId64 "/%" PRIu64 "\n",
 539                 statistics.num_played_sum / n,
 540                 int_sqrt(statistics.num_played_qd / n));
 541         PARA_NOTICE_LOG("num_played correction factor: %" PRId64 "\n",
 542                 statistics.num_played_correction);
 543         PARA_NOTICE_LOG("last_played correction factor: %" PRId64 "\n",
 544                 statistics.last_played_correction);
 545         PARA_NOTICE_LOG("normalization divisor: %" PRId64 "\n",
 546                 statistics.normalization_divisor);
 547 }
 548
 549 /**
 550  * Close the current mood.
 551  *
 552  * Frees all resources of the current mood.
 553  */
 554 void close_current_mood(void)
 555 {
 556         destroy_mood(current_mood);
 557         current_mood = NULL;
 558         memset(&statistics, 0, sizeof(statistics));
 559         statistics.normalization_divisor = 1;
 560 }
 561
 562 static void compute_correction_factors(int64_t sse)
 563 {
 564         struct afs_statistics *s = &statistics;
 565
 566         if (s->num > 0) {
 567                 s->normalization_divisor = int_sqrt(s->last_played_qd)
 568                         * int_sqrt(s->num_played_qd) / s->num / 100;
 569                 s->num_played_correction = sse - s->last_played_sum / s->num;
 570                 s->last_played_correction = s->num_played_sum / s->num;
 571         }
 572         if (s->num_played_correction == 0)
 573                 s->num_played_correction = 1;
 574         if (s->normalization_divisor == 0)
 575                 s->normalization_divisor = 1;
 576         if (s->last_played_correction == 0)
 577                 s->last_played_correction = 1;
 578 }
 579
 580 /**
 581  * Change the current mood.
 582  *
 583  * \param mood_name The name of the mood to open.
 584  * \param errmsg Error description is returned here.
 585  *
 586  * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
 587  * and uses a scoring method based only on the \a last_played information.
 588  *
 589  * The errmsg pointer may be NULL, in which case no error message will be
 590  * returned. If a non-NULL pointer is given, the caller must free *errmsg.
 591  *
 592  * If there is already an open mood, it will be closed first.
 593  *
 594  * \return Positive on success, negative on errors.
 595  *
 596  * \sa struct \ref afs_info::last_played, \ref mp_eval_row().
 597  */
 598 int change_current_mood(const char *mood_name, char **errmsg)
 599 {
 600         int i, ret;
 601         struct admissible_array aa = {
 602                 .size = 0,
 603                 .array = NULL
 604         };
 605         /*
 606          * We can not use the "now" pointer from sched.c here because we are
 607          * called before schedule(), which initializes "now".
 608          */
 609         struct timeval rnow;
 610
 611         if (mood_name) {
 612                 struct mood *m;
 613                 struct osl_row *row;
 614                 struct osl_object obj;
 615
 616                 if (!*mood_name) {
 617                         *errmsg = make_message("empty mood name");
 618                         return -ERRNO_TO_PARA_ERROR(EINVAL);
 619                 }
 620                 obj.data = (char *)mood_name;
 621                 obj.size = strlen(mood_name) + 1;
 622                 ret = osl(osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row));
 623                 if (ret < 0) {
 624                         if (errmsg)
 625                                 *errmsg = make_message("no such mood: %s",
 626                                         mood_name);
 627                         return ret;
 628                 }
 629                 ret = load_mood(row, &m, errmsg);
 630                 if (ret < 0)
 631                         return ret;
 632                 close_current_mood();
 633                 current_mood = m;
 634         } else { /* load dummy mood */
 635                 close_current_mood();
 636                 current_mood = alloc_new_mood(NULL);
 637         }
 638         aa.m = current_mood;
 639         PARA_NOTICE_LOG("computing statistics of admissible files\n");
 640         ret = audio_file_loop(&aa, add_if_admissible);
 641         if (ret < 0) {
 642                 if (errmsg)
 643                         *errmsg = make_message("audio file loop failed");
 644                 goto out;
 645         }
 646         clock_get_realtime(&rnow);
 647         compute_correction_factors(rnow.tv_sec);
 648         log_statistics(rnow.tv_sec);
 649         for (i = 0; i < statistics.num; i++) {
 650                 ret = add_to_score_table(aa.array[i]);
 651                 if (ret < 0) {
 652                         if (errmsg)
 653                                 *errmsg = make_message(
 654                                         "could not add row to score table");
 655                         goto out;
 656                 }
 657         }
 658         ret = statistics.num;
 659 out:
 660         free(aa.array);
 661         if (ret < 0)
 662                 close_current_mood();
 663         return ret;
 664 }
 665
 666 /*
 667  * Close and re-open the current mood.
 668  *
 669  * This function is called on events which render the current list of
 670  * admissible files useless, for example if an attribute is removed from the
 671  * attribute table.
 672  */
 673 static int reload_current_mood(void)
 674 {
 675         int ret;
 676         char *mood_name = NULL;
 677
 678         assert(current_mood);
 679         ret = clear_score_table();
 680         if (ret < 0)
 681                 return ret;
 682         PARA_NOTICE_LOG("reloading %s\n", current_mood->name?
 683                 current_mood->name : "(dummy)");
 684         if (current_mood->name)
 685                 mood_name = para_strdup(current_mood->name);
 686         close_current_mood();
 687         ret = change_current_mood(mood_name, NULL);
 688         free(mood_name);
 689         return ret;
 690 }
 691
 692 /**
 693  * Notification callback for the moods table.
 694  *
 695  * \param event Type of the event just occurred.
 696  * \param pb Unused.
 697  * \param data Its type depends on the event.
 698  *
 699  * This function updates the score table according to the event that has
 700  * occurred. Two actions are possible: (a) reload the current mood, or (b)
 701  * add/remove/update the row of the score table which corresponds to the audio
 702  * file that has been modified or whose afs info has been changed. It depends
 703  * on the type of the event which action (if any) is performed.
 704  *
 705  * The callbacks of command handlers such as com_add() or com_touch() which
 706  * modify the audio file table call this function. The virtual streaming system
 707  * also calls this after it has updated the afs info of the file it is about to
 708  * stream (the one with the highest score). If the file stays admissible, its
 709  * score is recomputed so that a different file is picked next time.
 710  *
 711  * \return Standard.
 712  */
 713 int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb,
 714                 void *data)
 715 {
 716         if (!current_mood)
 717                 return 0;
 718         switch (event) {
 719         /*
 720          * The three blob events might change the set of admissible files,
 721          * so we must reload the score list.
 722          */
 723         case BLOB_RENAME:
 724         case BLOB_REMOVE:
 725         case BLOB_ADD:
 726                 if (data == moods_table || data == playlists_table)
 727                         return 1; /* no reload necessary for these */
 728                 return reload_current_mood();
 729         /* these also require reload of the score table */
 730         case ATTRIBUTE_ADD:
 731         case ATTRIBUTE_REMOVE:
 732         case ATTRIBUTE_RENAME:
 733                 return reload_current_mood();
 734         /* changes to the aft only require to re-examine the audio file */
 735         case AFSI_CHANGE: {
 736                 struct afsi_change_event_data *aced = data;
 737                 return mood_update_audio_file(aced->aft_row, aced->old_afsi);
 738                 }
 739         case AFHI_CHANGE:
 740         case AUDIO_FILE_RENAME:
 741         case AUDIO_FILE_ADD:
 742                 return mood_update_audio_file(data, NULL);
 743         case AUDIO_FILE_REMOVE:
 744                 return mood_delete_audio_file(data);
 745         default:
 746                 return 1;
 747         }
 748 }