2 * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file mood.c Paraslash's mood handling functions. */
26 * Contains statistical data of the currently admissible audio files.
28 * It is used to assign normalized score values to each admissible audio file.
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 */
42 static struct afs_statistics statistics;
45 * Each line of the current mood corresponds to a 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. */
52 /** The given score value, or zero if none was given. */
54 /** Non-zero if random scoring was requested. */
56 /** Whether the "not" keyword was given in the mood line. */
58 /** The position in the list of items. */
59 struct list_head mood_item_node;
63 * Created from the mood definition by \ref change_current_mood().
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.
71 /** The name of this mood. */
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;
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.
85 static struct mood *current_mood;
88 * Rough approximation to sqrt.
90 * \param x Integer of which to calculate the sqrt.
92 * \return An integer res with res * res <= x.
94 __a_const static uint64_t int_sqrt(uint64_t x)
96 uint64_t op, res, one = 1;
105 if (op >= res + one) {
106 op = op - (res + one);
112 // PARA_NOTICE_LOG("sqrt(%llu) = %llu\n", x, res);
117 * Returns true if row matches, false if it does not match. In any case score
118 * and score_arg_sum are set/increased accordingly.
120 static bool get_item_score(struct mood_item *item, const struct afs_info *afsi,
121 const struct afh_info *afhi, const char *path, long *score,
127 *score_arg_sum += item->random_score? 100 : PARA_ABS(item->score_arg);
130 ret = item->method->score_function(path, afsi, afhi,
132 if ((ret < 0 && !item->logical_not) || (ret >= 0 && item->logical_not))
135 if (item->random_score)
136 *score = PARA_ABS(ret) * para_random(100);
138 *score = PARA_ABS(ret) * item->score_arg;
142 /* returns 1 if row admissible, 0 if not, negative on errors */
143 static int row_is_admissible(const struct osl_row *aft_row, struct mood *m,
146 struct mood_item *item;
149 long score_arg_sum = 0, score = 0, item_score;
150 struct afs_info afsi;
151 struct afh_info afhi;
156 ret = get_afsi_of_row(aft_row, &afsi);
159 ret = get_afhi_of_row(aft_row, &afhi);
162 ret = get_audio_file_path_of_row(aft_row, &path);
165 /* reject audio file if it matches any entry in the deny list */
166 list_for_each_entry(item, &m->deny_list, mood_item_node) {
167 match = get_item_score(item, &afsi, &afhi, path, &item_score,
169 if (match) /* not admissible */
174 list_for_each_entry(item, &m->accept_list, mood_item_node) {
175 ret = get_item_score(item, &afsi, &afhi, path, &item_score,
182 /* reject if there is no matching entry in the accept list */
183 if (!match && !list_empty(&m->accept_list))
185 list_for_each_entry(item, &m->score_list, mood_item_node) {
186 match = get_item_score(item, &afsi, &afhi, path, &item_score,
192 score /= score_arg_sum;
197 static void cleanup_list_entry(struct mood_item *item)
199 if (item->method && item->method->cleanup)
200 item->method->cleanup(item->parser_data);
202 free(item->parser_data);
203 list_del(&item->mood_item_node);
207 static void destroy_mood(struct mood *m)
209 struct mood_item *tmp, *item;
213 list_for_each_entry_safe(item, tmp, &m->accept_list, mood_item_node)
214 cleanup_list_entry(item);
215 list_for_each_entry_safe(item, tmp, &m->deny_list, mood_item_node)
216 cleanup_list_entry(item);
217 list_for_each_entry_safe(item, tmp, &m->score_list, mood_item_node)
218 cleanup_list_entry(item);
223 static struct mood *alloc_new_mood(const char *name)
225 struct mood *m = para_calloc(sizeof(struct mood));
227 m->name = para_strdup(name);
228 INIT_LIST_HEAD(&m->accept_list);
229 INIT_LIST_HEAD(&m->deny_list);
230 INIT_LIST_HEAD(&m->score_list);
234 /** The different types of a mood line. */
235 enum mood_line_type {
246 /** Data passed to the parser of a mood line. */
247 struct mood_line_parser_data {
248 /** The mood this mood line belongs to. */
250 /** The line number in the mood definition. */
255 * <accept [with score <score>] | deny [with score <score>] | score <score>>
256 * [if] [not] <mood_method> [options]
257 * <score> is either an integer or "random" which assigns a random score to
260 static int parse_mood_line(char *mood_line, void *data)
262 struct mood_line_parser_data *mlpd = data;
267 enum mood_line_type mlt = ML_INVALID;
268 struct mood_item *mi = NULL;
271 ret = create_argv(mood_line, " \t", &argv);
275 if (!num_words) /* empty line */
278 if (**w == '#') /* comment */
280 if (!strcmp(*w, "accept"))
282 else if (!strcmp(*w, "deny"))
284 else if (!strcmp(*w, "score"))
286 ret = -E_MOOD_SYNTAX;
287 if (mlt == ML_INVALID)
289 mi = para_calloc(sizeof(struct mood_item));
290 if (mlt != ML_SCORE) {
291 ret = -E_MOOD_SYNTAX;
295 if (strcmp(*w, "with"))
300 if (strcmp(*w, "score"))
303 if (mlt == ML_SCORE || !strcmp(*w, "score")) {
304 ret = -E_MOOD_SYNTAX;
308 if (strcmp(*w, "random")) {
309 mi->random_score = 0;
310 ret = para_atoi32(*w, &mi->score_arg);
314 mi->random_score = 1;
316 goto success; /* the line "score random" is valid */
320 ret = -E_MOOD_SYNTAX;
325 if (!strcmp(*w, "if")) {
326 ret = -E_MOOD_SYNTAX;
331 if (!strcmp(*w, "not")) {
332 ret = -E_MOOD_SYNTAX;
339 for (i = 0; mood_methods[i].parser; i++) {
340 if (strcmp(*w, mood_methods[i].name))
344 ret = -E_MOOD_SYNTAX;
345 if (!mood_methods[i].parser)
347 ret = mood_methods[i].parser(num_words - 1 - (w - argv), w,
351 mi->method = &mood_methods[i];
354 if (mlt == ML_ACCEPT)
355 para_list_add(&mi->mood_item_node, &mlpd->m->accept_list);
356 else if (mlt == ML_DENY)
357 para_list_add(&mi->mood_item_node, &mlpd->m->deny_list);
359 para_list_add(&mi->mood_item_node, &mlpd->m->score_list);
361 PARA_DEBUG_LOG("%s entry added, method: %p\n", mlt == ML_ACCEPT? "accept" :
362 (mlt == ML_DENY? "deny" : "score"), mi->method);
366 if (mi && (ret < 0 || !mlpd->m)) { /* mi was not added to any list */
367 free(mi->parser_data);
373 static int load_mood(const struct osl_row *mood_row, struct mood **m)
376 struct osl_object mood_def;
377 struct mood_line_parser_data mlpd = {.line_num = 0};
381 ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
386 mlpd.m = alloc_new_mood(mood_name);
387 ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
388 parse_mood_line, &mlpd);
389 osl_close_disk_object(&mood_def);
391 PARA_ERROR_LOG("unable to load mood %s: %s\n", mlpd.m->name,
392 para_strerror(-ret));
393 destroy_mood(mlpd.m);
400 static int check_mood(struct osl_row *mood_row, void *data)
402 struct para_buffer *pb = data;
404 struct osl_object mood_def;
405 struct mood_line_parser_data mlpd = {.line_num = 0};
407 int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
410 para_printf(pb, "cannot read mood\n");
413 if (!*mood_name) /* ignore dummy row */
415 para_printf(pb, "checking mood %s...\n", mood_name);
416 ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
417 parse_mood_line, &mlpd);
419 para_printf(pb, "mood %s: error in line %u: %s\n", mood_name,
420 mlpd.line_num, para_strerror(-ret));
421 ret = 1; /* don't fail the loop on invalid mood definitions */
423 osl_close_disk_object(&mood_def);
428 * Check all moods for syntax errors.
430 * \param aca Only ->pbout is used for diagnostics.
432 * \return Negative on fatal errors. Inconsistent mood definitions are not
433 * considered an error.
435 int mood_check_callback(struct afs_callback_arg *aca)
437 para_printf(&aca->pbout, "checking moods...\n");
438 return osl(osl_rbtree_loop(moods_table, BLOBCOL_ID, &aca->pbout,
442 static int64_t normalized_value(int64_t x, int64_t n, int64_t sum, int64_t qd)
446 return 100 * (n * x - sum) / (int64_t)int_sqrt(n) / (int64_t)int_sqrt(qd);
449 static long compute_score(struct afs_info *afsi, long mood_score)
451 mood_score -= normalized_value(afsi->num_played, statistics.num,
452 statistics.num_played_sum, statistics.num_played_qd);
453 mood_score -= normalized_value(afsi->last_played, statistics.num,
454 statistics.last_played_sum, statistics.last_played_qd);
455 return mood_score / 3;
458 static int add_afs_statistics(const struct osl_row *row)
461 struct afs_info afsi;
464 ret = get_afsi_of_row(row, &afsi);
468 x = afsi.last_played;
469 s = statistics.last_played_sum;
471 q = (x > s / n)? x - s / n : s / n - x;
472 statistics.last_played_qd += q * q * n / (n + 1);
474 statistics.last_played_sum += x;
477 s = statistics.num_played_sum;
479 q = (x > s / n)? x - s / n : s / n - x;
480 statistics.num_played_qd += q * q * n / (n + 1);
482 statistics.num_played_sum += x;
487 static int del_afs_statistics(const struct osl_row *row)
489 uint64_t n, s, q, a, new_s;
490 struct afs_info afsi;
492 ret = get_afsi_of_row(row, &afsi);
498 memset(&statistics, 0, sizeof(statistics));
502 s = statistics.last_played_sum;
503 q = statistics.last_played_qd;
504 a = afsi.last_played;
506 statistics.last_played_sum = new_s;
507 statistics.last_played_qd = q + s * s / n - a * a
508 - new_s * new_s / (n - 1);
510 s = statistics.num_played_sum;
511 q = statistics.num_played_qd;
514 statistics.num_played_sum = new_s;
515 statistics.num_played_qd = q + s * s / n - a * a
516 - new_s * new_s / (n - 1);
523 * At mood open time we determine the set of admissible files for the given
524 * mood. The mood score of each admissible file is computed by adding up all
525 * mood item scores. Next, we update the afs statistics and append a struct
526 * admissible_file_info to a temporary array.
528 * When all files have been processed in this way, the final score of each
529 * admissible file is computed by adding the dynamic score (which depends on
530 * the afs_statistics and the current time) to the mood score. Finally, all
531 * audio files in the temporary array are added to the score table and the
534 struct admissible_file_info
536 /** The admissible audio file. */
537 struct osl_row *aft_row;
542 /** The temporary array of admissible files. */
543 struct admissible_array {
544 /** Files are admissible wrt. this mood. */
546 /** The size of the array */
548 /** Pointer to the array of admissible files. */
549 struct admissible_file_info *array;
553 * Add an entry to the array of admissible files.
555 * \param aft_row The audio file to be added.
556 * \param private_data Pointer to a struct admissible_file_info.
558 * \return 1 if row admissible, 0 if not, negative on errors.
560 static int add_if_admissible(struct osl_row *aft_row, void *data)
562 struct admissible_array *aa = data;
566 ret = row_is_admissible(aft_row, aa->m, &score);
569 if (statistics.num >= aa->size) {
572 aa->array = para_realloc(aa->array,
573 aa->size * sizeof(struct admissible_file_info));
575 aa->array[statistics.num].aft_row = aft_row;
576 aa->array[statistics.num].score = score;
577 ret = add_afs_statistics(aft_row);
584 * Compute the new quadratic deviation in case one element changes.
586 * \param n Number of elements.
587 * \param old_qd The quadratic deviation before the change.
588 * \param old_val The value that was replaced.
589 * \param new_val The replacement value.
590 * \param old_sum The sum of all elements before the update.
592 * \return The new quadratic deviation resulting from replacing old_val
595 * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
596 * their quadratic deviation
598 * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
600 * and a real number b, the quadratic deviation q' of a_1,...a_{n-1}, b (ie.
601 * the last number a_n was replaced by b) may be computed in O(1) time in terms
602 * of n, q, a_n, b, and S as
604 * q' = q + d * s - (2 * S + d) * d / n
605 * = q + d * (s - 2 * S / n - d /n),
607 * where d = b - a_n, and s = b + a_n.
609 * Example: n = 3, a_1 = 3, a_2 = 5, a_3 = 7, b = 10. Then S = 15, q = 8, d = 3,
612 * q + d * s - (2 * S + d) * d / n = 8 + 51 - 33 = 26,
614 * which equals q' = (3 - 6)^2 + (5 - 6)^2 + (10 - 6)^2.
617 _static_inline_ int64_t update_quadratic_deviation(int64_t n, int64_t old_qd,
618 int64_t old_val, int64_t new_val, int64_t old_sum)
620 int64_t delta = new_val - old_val;
621 int64_t sigma = new_val + old_val;
622 return old_qd + delta * (sigma - 2 * old_sum / n - delta / n);
625 static int update_afs_statistics(struct afs_info *old_afsi,
626 struct afs_info *new_afsi)
629 int ret = get_num_admissible_files(&n);
635 statistics.last_played_qd = update_quadratic_deviation(n,
636 statistics.last_played_qd, old_afsi->last_played,
637 new_afsi->last_played, statistics.last_played_sum);
638 statistics.last_played_sum += new_afsi->last_played - old_afsi->last_played;
640 statistics.num_played_qd = update_quadratic_deviation(n,
641 statistics.num_played_qd, old_afsi->num_played,
642 new_afsi->num_played, statistics.num_played_sum);
643 statistics.num_played_sum += new_afsi->num_played - old_afsi->num_played;
647 static int add_to_score_table(const struct osl_row *aft_row, long mood_score)
650 struct afs_info afsi;
651 int ret = get_afsi_of_row(aft_row, &afsi);
655 score = compute_score(&afsi, mood_score);
656 return score_add(aft_row, score);
659 static int delete_from_statistics_and_score_table(const struct osl_row *aft_row)
661 int ret = del_afs_statistics(aft_row);
664 return score_delete(aft_row);
668 * Delete one entry from the statistics and from the score table.
670 * \param aft_row The audio file which is no longer admissible.
672 * \return Positive on success, negative on errors.
674 * \sa \ref score_delete().
676 static int mood_delete_audio_file(const struct osl_row *aft_row)
680 ret = row_belongs_to_score_table(aft_row, NULL);
683 if (!ret) /* not admissible, nothing to do */
685 return delete_from_statistics_and_score_table(aft_row);
689 * Compute the new score of an audio file wrt. the current mood.
691 * \param aft_row Determines the audio file.
692 * \param old_afsi The audio file selector info before updating.
694 * The \a old_afsi argument may be \p NULL which indicates that no changes to
695 * the audio file info were made.
697 * \return Positive on success, negative on errors.
699 static int mood_update_audio_file(const struct osl_row *aft_row,
700 struct afs_info *old_afsi)
703 int ret, is_admissible, was_admissible = 0;
704 struct afs_info afsi;
708 return 1; /* nothing to do */
709 ret = row_belongs_to_score_table(aft_row, &rank);
712 was_admissible = ret;
713 ret = row_is_admissible(aft_row, current_mood, &score);
716 is_admissible = (ret > 0);
717 if (!was_admissible && !is_admissible)
719 if (was_admissible && !is_admissible)
720 return delete_from_statistics_and_score_table(aft_row);
721 if (!was_admissible && is_admissible) {
722 ret = add_afs_statistics(aft_row);
725 return add_to_score_table(aft_row, score);
728 ret = get_afsi_of_row(aft_row, &afsi);
732 ret = update_afs_statistics(old_afsi, &afsi);
736 score = compute_score(&afsi, score);
737 PARA_DEBUG_LOG("score: %li\n", score);
738 percent = (score + 100) / 3;
741 else if (percent < 0)
743 PARA_DEBUG_LOG("moving from rank %u to %li%%\n", rank, percent);
744 return score_update(aft_row, percent);
747 static void log_statistics(void)
749 unsigned n = statistics.num;
750 int mean_days, sigma_days;
752 * We can not use the "now" pointer from sched.c here because we are
753 * called before schedule(), which initializes "now".
757 assert(current_mood);
758 PARA_NOTICE_LOG("loaded mood %s\n", current_mood->name?
759 current_mood->name : "(dummy)");
761 PARA_WARNING_LOG("no admissible files\n");
764 PARA_NOTICE_LOG("%u admissible files\n", statistics.num);
765 clock_get_realtime(&rnow);
766 mean_days = (rnow.tv_sec - statistics.last_played_sum / n) / 3600 / 24;
767 sigma_days = int_sqrt(statistics.last_played_qd / n) / 3600 / 24;
768 PARA_NOTICE_LOG("last_played mean/sigma: %d/%d days\n", mean_days, sigma_days);
769 PARA_NOTICE_LOG("num_played mean/sigma: %llu/%llu\n",
770 (long long unsigned)statistics.num_played_sum / n,
771 (long long unsigned)int_sqrt(statistics.num_played_qd / n));
775 * Close the current mood.
777 * Frees all resources of the current mood.
779 void close_current_mood(void)
781 destroy_mood(current_mood);
783 memset(&statistics, 0, sizeof(statistics));
787 * Change the current mood.
789 * \param mood_name The name of the mood to open.
791 * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
792 * and uses a scoring method based only on the \a last_played information.
794 * If there is already an open mood, it will be closed first.
796 * \return Positive on success, negative on errors. Loading the dummy mood
799 * \sa struct \ref afs_info::last_played.
801 int change_current_mood(const char *mood_name)
804 struct admissible_array aa = {
812 struct osl_object obj = {
813 .data = (char *)mood_name,
814 .size = strlen(mood_name) + 1
816 ret = osl(osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row));
818 PARA_NOTICE_LOG("no such mood: %s\n", mood_name);
821 ret = load_mood(row, &m);
824 close_current_mood();
826 } else { /* load dummy mood */
827 close_current_mood();
828 current_mood = alloc_new_mood(NULL);
831 PARA_NOTICE_LOG("computing statistics of admissible files\n");
832 ret = audio_file_loop(&aa, add_if_admissible);
835 for (i = 0; i < statistics.num; i++) {
836 struct admissible_file_info *a = aa.array + i;
837 ret = add_to_score_table(a->aft_row, a->score);
842 ret = statistics.num;
849 * Close and re-open the current mood.
851 * This function is called on events which render the current list of
852 * admissible files useless, for example if an attribute is removed from the
855 * If no mood is currently open, the function returns success.
857 static int reload_current_mood(void)
860 char *mood_name = NULL;
862 ret = clear_score_table();
867 PARA_NOTICE_LOG("reloading %s\n", current_mood->name?
868 current_mood->name : "(dummy)");
869 if (current_mood->name)
870 mood_name = para_strdup(current_mood->name);
871 close_current_mood();
872 ret = change_current_mood(mood_name);
878 * Notification callback for the moods table.
880 * \param event Type of the event just occurred.
882 * \param data Its type depends on the event.
884 * This function performs actions required due to the occurrence of the given
885 * event. Possible actions include reload of the current mood and update of the
886 * score of an audio file.
890 int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb,
897 * The three blob events might change the set of admissible files,
898 * so we must reload the score list.
903 if (data == moods_table || data == playlists_table)
904 return 1; /* no reload necessary for these */
905 return reload_current_mood();
906 /* these also require reload of the score table */
908 case ATTRIBUTE_REMOVE:
909 case ATTRIBUTE_RENAME:
910 return reload_current_mood();
911 /* changes to the aft only require to re-examine the audio file */
913 struct afsi_change_event_data *aced = data;
914 return mood_update_audio_file(aced->aft_row, aced->old_afsi);
917 case AUDIO_FILE_RENAME:
919 return mood_update_audio_file(data, NULL);
920 case AUDIO_FILE_REMOVE:
921 return mood_delete_audio_file(data);