mood.c

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