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