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 * Find the position of the most-significant set bit.
90 * Copied and slightly adapted from the linux source tree, version 4.9.39
93 __a_const static uint32_t fls64(uint64_t v)
96 const uint64_t ones = ~(uint64_t)0U;
98 if ((v & (ones << 32)) == 0) {
102 if ((v & (ones << (64 - 16))) == 0) {
106 if ((v & (ones << (64 - 8))) == 0) {
110 if ((v & (ones << (64 - 4))) == 0) {
114 if ((v & (ones << (64 - 2))) == 0) {
118 if ((v & (ones << (64 - 1))) == 0)
124 * Compute the integer square root floor(sqrt(x)).
126 * Taken 2007 from the linux source tree.
128 __a_const static uint64_t int_sqrt(uint64_t x)
130 uint64_t op, res, one = 1;
134 one = one << (fls64(x) & ~one);
136 if (op >= res + one) {
137 op = op - (res + one);
143 // PARA_NOTICE_LOG("sqrt(%llu) = %llu\n", x, res);
148 * Returns true if row matches, false if it does not match. In any case score
149 * and score_arg_sum are set/increased accordingly.
151 static bool get_item_score(struct mood_item *item, const struct afs_info *afsi,
152 const struct afh_info *afhi, const char *path, long *score,
158 *score_arg_sum += item->random_score? 100 : PARA_ABS(item->score_arg);
161 ret = item->method->score_function(path, afsi, afhi,
163 if ((ret < 0 && !item->logical_not) || (ret >= 0 && item->logical_not))
166 if (item->random_score)
167 *score = PARA_ABS(ret) * para_random(100);
169 *score = PARA_ABS(ret) * item->score_arg;
173 /* returns 1 if row admissible, 0 if not, negative on errors */
174 static int row_is_admissible(const struct osl_row *aft_row, struct mood *m,
177 struct mood_item *item;
180 long score_arg_sum = 0, score = 0, item_score;
181 struct afs_info afsi;
182 struct afh_info afhi;
187 ret = get_afsi_of_row(aft_row, &afsi);
190 ret = get_afhi_of_row(aft_row, &afhi);
193 ret = get_audio_file_path_of_row(aft_row, &path);
196 /* reject audio file if it matches any entry in the deny list */
197 list_for_each_entry(item, &m->deny_list, mood_item_node) {
198 match = get_item_score(item, &afsi, &afhi, path, &item_score,
200 if (match) /* not admissible */
205 list_for_each_entry(item, &m->accept_list, mood_item_node) {
206 ret = get_item_score(item, &afsi, &afhi, path, &item_score,
213 /* reject if there is no matching entry in the accept list */
214 if (!match && !list_empty(&m->accept_list))
216 list_for_each_entry(item, &m->score_list, mood_item_node) {
217 match = get_item_score(item, &afsi, &afhi, path, &item_score,
223 score /= score_arg_sum;
228 static void cleanup_list_entry(struct mood_item *item)
230 if (item->method && item->method->cleanup)
231 item->method->cleanup(item->parser_data);
233 free(item->parser_data);
234 list_del(&item->mood_item_node);
238 static void destroy_mood(struct mood *m)
240 struct mood_item *tmp, *item;
244 list_for_each_entry_safe(item, tmp, &m->accept_list, mood_item_node)
245 cleanup_list_entry(item);
246 list_for_each_entry_safe(item, tmp, &m->deny_list, mood_item_node)
247 cleanup_list_entry(item);
248 list_for_each_entry_safe(item, tmp, &m->score_list, mood_item_node)
249 cleanup_list_entry(item);
254 static struct mood *alloc_new_mood(const char *name)
256 struct mood *m = para_calloc(sizeof(struct mood));
258 m->name = para_strdup(name);
259 INIT_LIST_HEAD(&m->accept_list);
260 INIT_LIST_HEAD(&m->deny_list);
261 INIT_LIST_HEAD(&m->score_list);
265 /** The different types of a mood line. */
266 enum mood_line_type {
277 /** Data passed to the parser of a mood line. */
278 struct mood_line_parser_data {
279 /** The mood this mood line belongs to. */
281 /** The line number in the mood definition. */
286 * <accept [with score <score>] | deny [with score <score>] | score <score>>
287 * [if] [not] <mood_method> [options]
288 * <score> is either an integer or "random" which assigns a random score to
291 static int parse_mood_line(char *mood_line, void *data)
293 struct mood_line_parser_data *mlpd = data;
298 enum mood_line_type mlt = ML_INVALID;
299 struct mood_item *mi = NULL;
302 ret = create_argv(mood_line, " \t", &argv);
306 if (!num_words) /* empty line */
309 if (**w == '#') /* comment */
311 if (!strcmp(*w, "accept"))
313 else if (!strcmp(*w, "deny"))
315 else if (!strcmp(*w, "score"))
317 ret = -E_MOOD_SYNTAX;
318 if (mlt == ML_INVALID)
320 mi = para_calloc(sizeof(struct mood_item));
321 if (mlt != ML_SCORE) {
322 ret = -E_MOOD_SYNTAX;
326 if (strcmp(*w, "with"))
331 if (strcmp(*w, "score"))
334 if (mlt == ML_SCORE || !strcmp(*w, "score")) {
335 ret = -E_MOOD_SYNTAX;
339 if (strcmp(*w, "random")) {
340 mi->random_score = 0;
341 ret = para_atoi32(*w, &mi->score_arg);
345 mi->random_score = 1;
347 goto success; /* the line "score random" is valid */
351 ret = -E_MOOD_SYNTAX;
356 if (!strcmp(*w, "if")) {
357 ret = -E_MOOD_SYNTAX;
362 if (!strcmp(*w, "not")) {
363 ret = -E_MOOD_SYNTAX;
370 for (i = 0; mood_methods[i].parser; i++) {
371 if (strcmp(*w, mood_methods[i].name))
375 ret = -E_MOOD_SYNTAX;
376 if (!mood_methods[i].parser)
378 ret = mood_methods[i].parser(num_words - 1 - (w - argv), w,
382 mi->method = &mood_methods[i];
385 if (mlt == ML_ACCEPT)
386 para_list_add(&mi->mood_item_node, &mlpd->m->accept_list);
387 else if (mlt == ML_DENY)
388 para_list_add(&mi->mood_item_node, &mlpd->m->deny_list);
390 para_list_add(&mi->mood_item_node, &mlpd->m->score_list);
392 PARA_DEBUG_LOG("%s entry added, method: %p\n", mlt == ML_ACCEPT? "accept" :
393 (mlt == ML_DENY? "deny" : "score"), mi->method);
400 free(mi->parser_data);
406 static int load_mood(const struct osl_row *mood_row, struct mood **m)
409 struct osl_object mood_def;
410 struct mood_line_parser_data mlpd = {.line_num = 0};
414 ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
419 mlpd.m = alloc_new_mood(mood_name);
420 ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
421 parse_mood_line, &mlpd);
422 osl_close_disk_object(&mood_def);
424 PARA_ERROR_LOG("unable to load mood %s: %s\n", mlpd.m->name,
425 para_strerror(-ret));
426 destroy_mood(mlpd.m);
433 static int check_mood(struct osl_row *mood_row, void *data)
435 struct para_buffer *pb = data;
437 struct osl_object mood_def;
438 struct mood_line_parser_data mlpd = {.line_num = 0};
440 int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
443 para_printf(pb, "cannot read mood\n");
446 if (!*mood_name) /* ignore dummy row */
448 para_printf(pb, "checking mood %s...\n", mood_name);
449 ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
450 parse_mood_line, &mlpd);
452 para_printf(pb, "mood %s: error in line %u: %s\n", mood_name,
453 mlpd.line_num, para_strerror(-ret));
454 ret = 1; /* don't fail the loop on invalid mood definitions */
456 osl_close_disk_object(&mood_def);
461 * Check all moods for syntax errors.
463 * \param aca Only ->pbout is used for diagnostics.
465 * \return Negative on fatal errors. Inconsistent mood definitions are not
466 * considered an error.
468 int mood_check_callback(struct afs_callback_arg *aca)
470 para_printf(&aca->pbout, "checking moods...\n");
471 return osl(osl_rbtree_loop(moods_table, BLOBCOL_ID, &aca->pbout,
475 static int64_t normalized_value(int64_t x, int64_t n, int64_t sum, int64_t qd)
479 return 100 * (n * x - sum) / (int64_t)int_sqrt(n) / (int64_t)int_sqrt(qd);
482 static long compute_score(struct afs_info *afsi, long mood_score)
484 mood_score -= normalized_value(afsi->num_played, statistics.num,
485 statistics.num_played_sum, statistics.num_played_qd);
486 mood_score -= normalized_value(afsi->last_played, statistics.num,
487 statistics.last_played_sum, statistics.last_played_qd);
488 return mood_score / 3;
491 static int add_afs_statistics(const struct osl_row *row)
494 struct afs_info afsi;
497 ret = get_afsi_of_row(row, &afsi);
501 x = afsi.last_played;
502 s = statistics.last_played_sum;
504 q = (x > s / n)? x - s / n : s / n - x;
505 statistics.last_played_qd += q * q * n / (n + 1);
507 statistics.last_played_sum += x;
510 s = statistics.num_played_sum;
512 q = (x > s / n)? x - s / n : s / n - x;
513 statistics.num_played_qd += q * q * n / (n + 1);
515 statistics.num_played_sum += x;
520 static int del_afs_statistics(const struct osl_row *row)
522 uint64_t n, s, q, a, new_s;
523 struct afs_info afsi;
525 ret = get_afsi_of_row(row, &afsi);
531 memset(&statistics, 0, sizeof(statistics));
535 s = statistics.last_played_sum;
536 q = statistics.last_played_qd;
537 a = afsi.last_played;
539 statistics.last_played_sum = new_s;
540 statistics.last_played_qd = q + s * s / n - a * a
541 - new_s * new_s / (n - 1);
543 s = statistics.num_played_sum;
544 q = statistics.num_played_qd;
547 statistics.num_played_sum = new_s;
548 statistics.num_played_qd = q + s * s / n - a * a
549 - new_s * new_s / (n - 1);
556 * At mood open time we determine the set of admissible files for the given
557 * mood. The mood score of each admissible file is computed by adding up all
558 * mood item scores. Next, we update the afs statistics and append a struct
559 * admissible_file_info to a temporary array.
561 * When all files have been processed in this way, the final score of each
562 * admissible file is computed by adding the dynamic score (which depends on
563 * the afs_statistics and the current time) to the mood score. Finally, all
564 * audio files in the temporary array are added to the score table and the
567 struct admissible_file_info
569 /** The admissible audio file. */
570 struct osl_row *aft_row;
575 /** The temporary array of admissible files. */
576 struct admissible_array {
577 /** Files are admissible wrt. this mood. */
579 /** The size of the array */
581 /** Pointer to the array of admissible files. */
582 struct admissible_file_info *array;
586 * Add an entry to the array of admissible files.
588 * \param aft_row The audio file to be added.
589 * \param private_data Pointer to a struct admissible_file_info.
591 * \return 1 if row admissible, 0 if not, negative on errors.
593 static int add_if_admissible(struct osl_row *aft_row, void *data)
595 struct admissible_array *aa = data;
599 ret = row_is_admissible(aft_row, aa->m, &score);
602 if (statistics.num >= aa->size) {
605 aa->array = para_realloc(aa->array,
606 aa->size * sizeof(struct admissible_file_info));
608 aa->array[statistics.num].aft_row = aft_row;
609 aa->array[statistics.num].score = score;
610 ret = add_afs_statistics(aft_row);
617 * Compute the new quadratic deviation in case one element changes.
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.
625 * \return The new quadratic deviation resulting from replacing old_val
628 * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
629 * their quadratic deviation
631 * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
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
637 * q' = q + d * s - (2 * S + d) * d / n
638 * = q + d * (s - 2 * S / n - d /n),
640 * where d = b - a_n, and s = b + a_n.
642 * Example: n = 3, a_1 = 3, a_2 = 5, a_3 = 7, b = 10. Then S = 15, q = 8, d = 3,
645 * q + d * s - (2 * S + d) * d / n = 8 + 51 - 33 = 26,
647 * which equals q' = (3 - 6)^2 + (5 - 6)^2 + (10 - 6)^2.
650 _static_inline_ int64_t update_quadratic_deviation(int64_t n, int64_t old_qd,
651 int64_t old_val, int64_t new_val, int64_t old_sum)
653 int64_t delta = new_val - old_val;
654 int64_t sigma = new_val + old_val;
655 return old_qd + delta * (sigma - 2 * old_sum / n - delta / n);
658 static int update_afs_statistics(struct afs_info *old_afsi,
659 struct afs_info *new_afsi)
662 int ret = get_num_admissible_files(&n);
668 statistics.last_played_qd = update_quadratic_deviation(n,
669 statistics.last_played_qd, old_afsi->last_played,
670 new_afsi->last_played, statistics.last_played_sum);
671 statistics.last_played_sum += new_afsi->last_played - old_afsi->last_played;
673 statistics.num_played_qd = update_quadratic_deviation(n,
674 statistics.num_played_qd, old_afsi->num_played,
675 new_afsi->num_played, statistics.num_played_sum);
676 statistics.num_played_sum += new_afsi->num_played - old_afsi->num_played;
680 static int add_to_score_table(const struct osl_row *aft_row, long mood_score)
683 struct afs_info afsi;
684 int ret = get_afsi_of_row(aft_row, &afsi);
688 score = compute_score(&afsi, mood_score);
689 return score_add(aft_row, score);
692 static int delete_from_statistics_and_score_table(const struct osl_row *aft_row)
694 int ret = del_afs_statistics(aft_row);
697 return score_delete(aft_row);
701 * Delete one entry from the statistics and from the score table.
703 * \param aft_row The audio file which is no longer admissible.
705 * \return Positive on success, negative on errors.
707 * \sa \ref score_delete().
709 static int mood_delete_audio_file(const struct osl_row *aft_row)
713 ret = row_belongs_to_score_table(aft_row, NULL);
716 if (!ret) /* not admissible, nothing to do */
718 return delete_from_statistics_and_score_table(aft_row);
722 * Compute the new score of an audio file wrt. the current mood.
724 * \param aft_row Determines the audio file.
725 * \param old_afsi The audio file selector info before updating.
727 * The \a old_afsi argument may be \p NULL which indicates that no changes to
728 * the audio file info were made.
730 * \return Positive on success, negative on errors.
732 static int mood_update_audio_file(const struct osl_row *aft_row,
733 struct afs_info *old_afsi)
736 int ret, is_admissible, was_admissible = 0;
737 struct afs_info afsi;
741 return 1; /* nothing to do */
742 ret = row_belongs_to_score_table(aft_row, &rank);
745 was_admissible = ret;
746 ret = row_is_admissible(aft_row, current_mood, &score);
749 is_admissible = (ret > 0);
750 if (!was_admissible && !is_admissible)
752 if (was_admissible && !is_admissible)
753 return delete_from_statistics_and_score_table(aft_row);
754 if (!was_admissible && is_admissible) {
755 ret = add_afs_statistics(aft_row);
758 return add_to_score_table(aft_row, score);
761 ret = get_afsi_of_row(aft_row, &afsi);
765 ret = update_afs_statistics(old_afsi, &afsi);
769 score = compute_score(&afsi, score);
770 PARA_DEBUG_LOG("score: %li\n", score);
771 percent = (score + 100) / 3;
774 else if (percent < 0)
776 PARA_DEBUG_LOG("moving from rank %u to %li%%\n", rank, percent);
777 return score_update(aft_row, percent);
780 static void log_statistics(void)
782 unsigned n = statistics.num;
783 int mean_days, sigma_days;
785 * We can not use the "now" pointer from sched.c here because we are
786 * called before schedule(), which initializes "now".
790 assert(current_mood);
791 PARA_NOTICE_LOG("loaded mood %s\n", current_mood->name?
792 current_mood->name : "(dummy)");
794 PARA_WARNING_LOG("no admissible files\n");
797 PARA_NOTICE_LOG("%u admissible files\n", statistics.num);
798 clock_get_realtime(&rnow);
799 mean_days = (rnow.tv_sec - statistics.last_played_sum / n) / 3600 / 24;
800 sigma_days = int_sqrt(statistics.last_played_qd / n) / 3600 / 24;
801 PARA_NOTICE_LOG("last_played mean/sigma: %d/%d days\n", mean_days, sigma_days);
802 PARA_NOTICE_LOG("num_played mean/sigma: %llu/%llu\n",
803 (long long unsigned)statistics.num_played_sum / n,
804 (long long unsigned)int_sqrt(statistics.num_played_qd / n));
808 * Close the current mood.
810 * Frees all resources of the current mood.
812 void close_current_mood(void)
814 destroy_mood(current_mood);
816 memset(&statistics, 0, sizeof(statistics));
820 * Change the current mood.
822 * \param mood_name The name of the mood to open.
824 * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
825 * and uses a scoring method based only on the \a last_played information.
827 * If there is already an open mood, it will be closed first.
829 * \return Positive on success, negative on errors. Loading the dummy mood
832 * \sa struct \ref afs_info::last_played.
834 int change_current_mood(const char *mood_name)
837 struct admissible_array aa = {
845 struct osl_object obj = {
846 .data = (char *)mood_name,
847 .size = strlen(mood_name) + 1
849 ret = osl(osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row));
851 PARA_NOTICE_LOG("no such mood: %s\n", mood_name);
854 ret = load_mood(row, &m);
857 close_current_mood();
859 } else { /* load dummy mood */
860 close_current_mood();
861 current_mood = alloc_new_mood(NULL);
864 PARA_NOTICE_LOG("computing statistics of admissible files\n");
865 ret = audio_file_loop(&aa, add_if_admissible);
868 for (i = 0; i < statistics.num; i++) {
869 struct admissible_file_info *a = aa.array + i;
870 ret = add_to_score_table(a->aft_row, a->score);
875 ret = statistics.num;
882 * Close and re-open the current mood.
884 * This function is called on events which render the current list of
885 * admissible files useless, for example if an attribute is removed from the
888 * If no mood is currently open, the function returns success.
890 static int reload_current_mood(void)
893 char *mood_name = NULL;
895 ret = clear_score_table();
900 PARA_NOTICE_LOG("reloading %s\n", current_mood->name?
901 current_mood->name : "(dummy)");
902 if (current_mood->name)
903 mood_name = para_strdup(current_mood->name);
904 close_current_mood();
905 ret = change_current_mood(mood_name);
911 * Notification callback for the moods table.
913 * \param event Type of the event just occurred.
915 * \param data Its type depends on the event.
917 * This function performs actions required due to the occurrence of the given
918 * event. Possible actions include reload of the current mood and update of the
919 * score of an audio file.
923 int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb,
930 * The three blob events might change the set of admissible files,
931 * so we must reload the score list.
936 if (data == moods_table || data == playlists_table)
937 return 1; /* no reload necessary for these */
938 return reload_current_mood();
939 /* these also require reload of the score table */
941 case ATTRIBUTE_REMOVE:
942 case ATTRIBUTE_RENAME:
943 return reload_current_mood();
944 /* changes to the aft only require to re-examine the audio file */
946 struct afsi_change_event_data *aced = data;
947 return mood_update_audio_file(aced->aft_row, aced->old_afsi);
950 case AUDIO_FILE_RENAME:
952 return mood_update_audio_file(data, NULL);
953 case AUDIO_FILE_REMOVE:
954 return mood_delete_audio_file(data);