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. */
23 * Contains statistical data of the currently admissible audio files.
25 * It is used to assign normalized score values to each admissible audio file.
27 struct afs_statistics {
28 /** Sum of num played over all admissible files. */
29 int64_t num_played_sum;
30 /** Sum of last played times over all admissible files. */
31 int64_t last_played_sum;
32 /** Quadratic deviation of num played count. */
33 int64_t num_played_qd;
34 /** Quadratic deviation of last played time. */
35 int64_t last_played_qd;
36 /** Number of admissible files */
39 static struct afs_statistics statistics;
42 * Each line of the current mood corresponds to a mood_item.
45 /** The method this line is referring to. */
46 const struct mood_method *method;
47 /** The data structure computed by the mood parser. */
49 /** The given score value, or zero if none was given. */
51 /** Non-zero if random scoring was requested. */
53 /** Whether the "not" keyword was given in the mood line. */
55 /** The position in the list of items. */
56 struct list_head mood_item_node;
60 * Created from the mood definition by \ref change_current_mood().
62 * When a mood is opened, each line of its definition is investigated, and a
63 * corresponding mood item is produced. Each mood line starts with accept,
64 * deny, or score which determines the type of the mood line. For each such
65 * type a linked list is maintained whose entries are the mood items.
68 /** The name of this mood. */
70 /** The list of mood items of type \p accept. */
71 struct list_head accept_list;
72 /** The list of mood items of type \p deny. */
73 struct list_head deny_list;
74 /** The list of mood items of type \p score. */
75 struct list_head score_list;
79 * If current_mood is NULL then no mood is currently open. If
80 * current_mood->name is NULL, the dummy mood is currently open.
82 static struct mood *current_mood;
85 * Rough approximation to sqrt.
87 * \param x Integer of which to calculate the sqrt.
89 * \return An integer res with res * res <= x.
91 __a_const static uint64_t int_sqrt(uint64_t x)
93 uint64_t op, res, one = 1;
102 if (op >= res + one) {
103 op = op - (res + one);
109 // PARA_NOTICE_LOG("sqrt(%llu) = %llu\n", x, res);
114 * Returns true if row matches, false if it does not match. In any case score
115 * and score_arg_sum are set/increased accordingly.
117 static bool get_item_score(struct mood_item *item, const struct afs_info *afsi,
118 const struct afh_info *afhi, const char *path, long *score,
124 *score_arg_sum += item->random_score? 100 : PARA_ABS(item->score_arg);
127 ret = item->method->score_function(path, afsi, afhi,
129 if ((ret < 0 && !item->logical_not) || (ret >= 0 && item->logical_not))
132 if (item->random_score)
133 *score = PARA_ABS(ret) * para_random(100);
135 *score = PARA_ABS(ret) * item->score_arg;
139 /* returns 1 if row admissible, 0 if not, negative on errors */
140 static int row_is_admissible(const struct osl_row *aft_row, struct mood *m,
143 struct mood_item *item;
146 long score_arg_sum = 0, score = 0, item_score;
147 struct afs_info afsi;
148 struct afh_info afhi;
153 ret = get_afsi_of_row(aft_row, &afsi);
156 ret = get_afhi_of_row(aft_row, &afhi);
159 ret = get_audio_file_path_of_row(aft_row, &path);
162 /* reject audio file if it matches any entry in the deny list */
163 list_for_each_entry(item, &m->deny_list, mood_item_node) {
164 match = get_item_score(item, &afsi, &afhi, path, &item_score,
166 if (match) /* not admissible */
171 list_for_each_entry(item, &m->accept_list, mood_item_node) {
172 ret = get_item_score(item, &afsi, &afhi, path, &item_score,
179 /* reject if there is no matching entry in the accept list */
180 if (!match && !list_empty(&m->accept_list))
182 list_for_each_entry(item, &m->score_list, mood_item_node) {
183 match = get_item_score(item, &afsi, &afhi, path, &item_score,
189 score /= score_arg_sum;
194 static void cleanup_list_entry(struct mood_item *item)
196 if (item->method && item->method->cleanup)
197 item->method->cleanup(item->parser_data);
199 free(item->parser_data);
200 list_del(&item->mood_item_node);
204 static void destroy_mood(struct mood *m)
206 struct mood_item *tmp, *item;
210 list_for_each_entry_safe(item, tmp, &m->accept_list, mood_item_node)
211 cleanup_list_entry(item);
212 list_for_each_entry_safe(item, tmp, &m->deny_list, mood_item_node)
213 cleanup_list_entry(item);
214 list_for_each_entry_safe(item, tmp, &m->score_list, mood_item_node)
215 cleanup_list_entry(item);
220 static struct mood *alloc_new_mood(const char *name)
222 struct mood *m = para_calloc(sizeof(struct mood));
224 m->name = para_strdup(name);
225 INIT_LIST_HEAD(&m->accept_list);
226 INIT_LIST_HEAD(&m->deny_list);
227 INIT_LIST_HEAD(&m->score_list);
231 /** The different types of a mood line. */
232 enum mood_line_type {
243 /** Data passed to the parser of a mood line. */
244 struct mood_line_parser_data {
245 /** The mood this mood line belongs to. */
247 /** The line number in the mood definition. */
252 * <accept [with score <score>] | deny [with score <score>] | score <score>>
253 * [if] [not] <mood_method> [options]
254 * <score> is either an integer or "random" which assigns a random score to
257 static int parse_mood_line(char *mood_line, void *data)
259 struct mood_line_parser_data *mlpd = data;
264 enum mood_line_type mlt = ML_INVALID;
265 struct mood_item *mi = NULL;
268 ret = create_argv(mood_line, " \t", &argv);
272 if (!num_words) /* empty line */
275 if (**w == '#') /* comment */
277 if (!strcmp(*w, "accept"))
279 else if (!strcmp(*w, "deny"))
281 else if (!strcmp(*w, "score"))
283 ret = -E_MOOD_SYNTAX;
284 if (mlt == ML_INVALID)
286 mi = para_calloc(sizeof(struct mood_item));
287 if (mlt != ML_SCORE) {
288 ret = -E_MOOD_SYNTAX;
292 if (strcmp(*w, "with"))
297 if (strcmp(*w, "score"))
300 if (mlt == ML_SCORE || !strcmp(*w, "score")) {
301 ret = -E_MOOD_SYNTAX;
305 if (strcmp(*w, "random")) {
306 mi->random_score = 0;
307 ret = para_atoi32(*w, &mi->score_arg);
311 mi->random_score = 1;
313 goto success; /* the line "score random" is valid */
317 ret = -E_MOOD_SYNTAX;
322 if (!strcmp(*w, "if")) {
323 ret = -E_MOOD_SYNTAX;
328 if (!strcmp(*w, "not")) {
329 ret = -E_MOOD_SYNTAX;
336 for (i = 0; mood_methods[i].parser; i++) {
337 if (strcmp(*w, mood_methods[i].name))
341 ret = -E_MOOD_SYNTAX;
342 if (!mood_methods[i].parser)
344 ret = mood_methods[i].parser(num_words - 1 - (w - argv), w,
348 mi->method = &mood_methods[i];
351 if (mlt == ML_ACCEPT)
352 para_list_add(&mi->mood_item_node, &mlpd->m->accept_list);
353 else if (mlt == ML_DENY)
354 para_list_add(&mi->mood_item_node, &mlpd->m->deny_list);
356 para_list_add(&mi->mood_item_node, &mlpd->m->score_list);
358 PARA_DEBUG_LOG("%s entry added, method: %p\n", mlt == ML_ACCEPT? "accept" :
359 (mlt == ML_DENY? "deny" : "score"), mi->method);
363 if (mi && (ret < 0 || !mlpd->m)) { /* mi was not added to any list */
364 free(mi->parser_data);
370 static int load_mood(const struct osl_row *mood_row, struct mood **m)
373 struct osl_object mood_def;
374 struct mood_line_parser_data mlpd = {.line_num = 0};
378 ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
383 mlpd.m = alloc_new_mood(mood_name);
384 ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
385 parse_mood_line, &mlpd);
386 osl_close_disk_object(&mood_def);
388 PARA_ERROR_LOG("unable to load mood %s: %s\n", mlpd.m->name,
389 para_strerror(-ret));
390 destroy_mood(mlpd.m);
397 static int check_mood(struct osl_row *mood_row, void *data)
399 struct para_buffer *pb = data;
401 struct osl_object mood_def;
402 struct mood_line_parser_data mlpd = {.line_num = 0};
404 int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
407 para_printf(pb, "cannot read mood\n");
410 if (!*mood_name) /* ignore dummy row */
412 para_printf(pb, "checking mood %s...\n", mood_name);
413 ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
414 parse_mood_line, &mlpd);
416 para_printf(pb, "mood %s: error in line %u: %s\n", mood_name,
417 mlpd.line_num, para_strerror(-ret));
418 ret = 1; /* don't fail the loop on invalid mood definitions */
420 osl_close_disk_object(&mood_def);
425 * Check all moods for syntax errors.
427 * \param aca Only ->pbout is used for diagnostics.
429 * \return Negative on fatal errors. Inconsistent mood definitions are not
430 * considered an error.
432 int mood_check_callback(struct afs_callback_arg *aca)
434 para_printf(&aca->pbout, "checking moods...\n");
435 return osl(osl_rbtree_loop(moods_table, BLOBCOL_ID, &aca->pbout,
439 static int64_t normalized_value(int64_t x, int64_t n, int64_t sum, int64_t qd)
443 return 100 * (n * x - sum) / (int64_t)int_sqrt(n) / (int64_t)int_sqrt(qd);
446 static long compute_score(struct afs_info *afsi, long mood_score)
448 mood_score -= normalized_value(afsi->num_played, statistics.num,
449 statistics.num_played_sum, statistics.num_played_qd);
450 mood_score -= normalized_value(afsi->last_played, statistics.num,
451 statistics.last_played_sum, statistics.last_played_qd);
452 return mood_score / 3;
455 static int add_afs_statistics(const struct osl_row *row)
458 struct afs_info afsi;
461 ret = get_afsi_of_row(row, &afsi);
465 x = afsi.last_played;
466 s = statistics.last_played_sum;
468 q = (x > s / n)? x - s / n : s / n - x;
469 statistics.last_played_qd += q * q * n / (n + 1);
471 statistics.last_played_sum += x;
474 s = statistics.num_played_sum;
476 q = (x > s / n)? x - s / n : s / n - x;
477 statistics.num_played_qd += q * q * n / (n + 1);
479 statistics.num_played_sum += x;
484 static int del_afs_statistics(const struct osl_row *row)
486 uint64_t n, s, q, a, new_s;
487 struct afs_info afsi;
489 ret = get_afsi_of_row(row, &afsi);
495 memset(&statistics, 0, sizeof(statistics));
499 s = statistics.last_played_sum;
500 q = statistics.last_played_qd;
501 a = afsi.last_played;
503 statistics.last_played_sum = new_s;
504 statistics.last_played_qd = q + s * s / n - a * a
505 - new_s * new_s / (n - 1);
507 s = statistics.num_played_sum;
508 q = statistics.num_played_qd;
511 statistics.num_played_sum = new_s;
512 statistics.num_played_qd = q + s * s / n - a * a
513 - new_s * new_s / (n - 1);
520 * At mood open time we determine the set of admissible files for the given
521 * mood. The mood score of each admissible file is computed by adding up all
522 * mood item scores. Next, we update the afs statistics and append a struct
523 * admissible_file_info to a temporary array.
525 * When all files have been processed in this way, the final score of each
526 * admissible file is computed by adding the dynamic score (which depends on
527 * the afs_statistics and the current time) to the mood score. Finally, all
528 * audio files in the temporary array are added to the score table and the
531 struct admissible_file_info
533 /** The admissible audio file. */
534 struct osl_row *aft_row;
539 /** The temporary array of admissible files. */
540 struct admissible_array {
541 /** Files are admissible wrt. this mood. */
543 /** The size of the array */
545 /** Pointer to the array of admissible files. */
546 struct admissible_file_info *array;
550 * Add an entry to the array of admissible files.
552 * \param aft_row The audio file to be added.
553 * \param private_data Pointer to a struct admissible_file_info.
555 * \return 1 if row admissible, 0 if not, negative on errors.
557 static int add_if_admissible(struct osl_row *aft_row, void *data)
559 struct admissible_array *aa = data;
563 ret = row_is_admissible(aft_row, aa->m, &score);
566 if (statistics.num >= aa->size) {
569 aa->array = para_realloc(aa->array,
570 aa->size * sizeof(struct admissible_file_info));
572 aa->array[statistics.num].aft_row = aft_row;
573 aa->array[statistics.num].score = score;
574 ret = add_afs_statistics(aft_row);
581 * Compute the new quadratic deviation in case one element changes.
583 * \param n Number of elements.
584 * \param old_qd The quadratic deviation before the change.
585 * \param old_val The value that was replaced.
586 * \param new_val The replacement value.
587 * \param old_sum The sum of all elements before the update.
589 * \return The new quadratic deviation resulting from replacing old_val
592 * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
593 * their quadratic deviation
595 * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
597 * and a real number b, the quadratic deviation q' of a_1,...a_{n-1}, b (ie.
598 * the last number a_n was replaced by b) may be computed in O(1) time in terms
599 * of n, q, a_n, b, and S as
601 * q' = q + d * s - (2 * S + d) * d / n
602 * = q + d * (s - 2 * S / n - d /n),
604 * where d = b - a_n, and s = b + a_n.
606 * Example: n = 3, a_1 = 3, a_2 = 5, a_3 = 7, b = 10. Then S = 15, q = 8, d = 3,
609 * q + d * s - (2 * S + d) * d / n = 8 + 51 - 33 = 26,
611 * which equals q' = (3 - 6)^2 + (5 - 6)^2 + (10 - 6)^2.
614 _static_inline_ int64_t update_quadratic_deviation(int64_t n, int64_t old_qd,
615 int64_t old_val, int64_t new_val, int64_t old_sum)
617 int64_t delta = new_val - old_val;
618 int64_t sigma = new_val + old_val;
619 return old_qd + delta * (sigma - 2 * old_sum / n - delta / n);
622 static int update_afs_statistics(struct afs_info *old_afsi,
623 struct afs_info *new_afsi)
626 int ret = get_num_admissible_files(&n);
632 statistics.last_played_qd = update_quadratic_deviation(n,
633 statistics.last_played_qd, old_afsi->last_played,
634 new_afsi->last_played, statistics.last_played_sum);
635 statistics.last_played_sum += new_afsi->last_played - old_afsi->last_played;
637 statistics.num_played_qd = update_quadratic_deviation(n,
638 statistics.num_played_qd, old_afsi->num_played,
639 new_afsi->num_played, statistics.num_played_sum);
640 statistics.num_played_sum += new_afsi->num_played - old_afsi->num_played;
644 static int add_to_score_table(const struct osl_row *aft_row, long mood_score)
647 struct afs_info afsi;
648 int ret = get_afsi_of_row(aft_row, &afsi);
652 score = compute_score(&afsi, mood_score);
653 return score_add(aft_row, score);
656 static int delete_from_statistics_and_score_table(const struct osl_row *aft_row)
658 int ret = del_afs_statistics(aft_row);
661 return score_delete(aft_row);
665 * Delete one entry from the statistics and from the score table.
667 * \param aft_row The audio file which is no longer admissible.
669 * \return Positive on success, negative on errors.
671 * \sa \ref score_delete().
673 static int mood_delete_audio_file(const struct osl_row *aft_row)
677 ret = row_belongs_to_score_table(aft_row, NULL);
680 if (!ret) /* not admissible, nothing to do */
682 return delete_from_statistics_and_score_table(aft_row);
686 * Compute the new score of an audio file wrt. the current mood.
688 * \param aft_row Determines the audio file.
689 * \param old_afsi The audio file selector info before updating.
691 * The \a old_afsi argument may be \p NULL which indicates that no changes to
692 * the audio file info were made.
694 * \return Positive on success, negative on errors.
696 static int mood_update_audio_file(const struct osl_row *aft_row,
697 struct afs_info *old_afsi)
700 int ret, is_admissible, was_admissible = 0;
701 struct afs_info afsi;
705 return 1; /* nothing to do */
706 ret = row_belongs_to_score_table(aft_row, &rank);
709 was_admissible = ret;
710 ret = row_is_admissible(aft_row, current_mood, &score);
713 is_admissible = (ret > 0);
714 if (!was_admissible && !is_admissible)
716 if (was_admissible && !is_admissible)
717 return delete_from_statistics_and_score_table(aft_row);
718 if (!was_admissible && is_admissible) {
719 ret = add_afs_statistics(aft_row);
722 return add_to_score_table(aft_row, score);
725 ret = get_afsi_of_row(aft_row, &afsi);
729 ret = update_afs_statistics(old_afsi, &afsi);
733 score = compute_score(&afsi, score);
734 PARA_DEBUG_LOG("score: %li\n", score);
735 percent = (score + 100) / 3;
738 else if (percent < 0)
740 PARA_DEBUG_LOG("moving from rank %u to %li%%\n", rank, percent);
741 return score_update(aft_row, percent);
744 static void log_statistics(void)
746 unsigned n = statistics.num;
747 int mean_days, sigma_days;
749 * We can not use the "now" pointer from sched.c here because we are
750 * called before schedule(), which initializes "now".
754 assert(current_mood);
755 PARA_NOTICE_LOG("loaded mood %s\n", current_mood->name?
756 current_mood->name : "(dummy)");
758 PARA_WARNING_LOG("no admissible files\n");
761 PARA_NOTICE_LOG("%u admissible files\n", statistics.num);
762 clock_get_realtime(&rnow);
763 mean_days = (rnow.tv_sec - statistics.last_played_sum / n) / 3600 / 24;
764 sigma_days = int_sqrt(statistics.last_played_qd / n) / 3600 / 24;
765 PARA_NOTICE_LOG("last_played mean/sigma: %d/%d days\n", mean_days, sigma_days);
766 PARA_NOTICE_LOG("num_played mean/sigma: %llu/%llu\n",
767 (long long unsigned)statistics.num_played_sum / n,
768 (long long unsigned)int_sqrt(statistics.num_played_qd / n));
772 * Close the current mood.
774 * Frees all resources of the current mood.
776 void close_current_mood(void)
778 destroy_mood(current_mood);
780 memset(&statistics, 0, sizeof(statistics));
784 * Change the current mood.
786 * \param mood_name The name of the mood to open.
788 * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
789 * and uses a scoring method based only on the \a last_played information.
791 * If there is already an open mood, it will be closed first.
793 * \return Positive on success, negative on errors. Loading the dummy mood
796 * \sa struct \ref afs_info::last_played.
798 int change_current_mood(const char *mood_name)
801 struct admissible_array aa = {
809 struct osl_object obj = {
810 .data = (char *)mood_name,
811 .size = strlen(mood_name) + 1
813 ret = osl(osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row));
815 PARA_NOTICE_LOG("no such mood: %s\n", mood_name);
818 ret = load_mood(row, &m);
821 close_current_mood();
823 } else { /* load dummy mood */
824 close_current_mood();
825 current_mood = alloc_new_mood(NULL);
828 PARA_NOTICE_LOG("computing statistics of admissible files\n");
829 ret = audio_file_loop(&aa, add_if_admissible);
832 for (i = 0; i < statistics.num; i++) {
833 struct admissible_file_info *a = aa.array + i;
834 ret = add_to_score_table(a->aft_row, a->score);
839 ret = statistics.num;
846 * Close and re-open the current mood.
848 * This function is called on events which render the current list of
849 * admissible files useless, for example if an attribute is removed from the
852 * If no mood is currently open, the function returns success.
854 static int reload_current_mood(void)
857 char *mood_name = NULL;
859 ret = clear_score_table();
864 PARA_NOTICE_LOG("reloading %s\n", current_mood->name?
865 current_mood->name : "(dummy)");
866 if (current_mood->name)
867 mood_name = para_strdup(current_mood->name);
868 close_current_mood();
869 ret = change_current_mood(mood_name);
875 * Notification callback for the moods table.
877 * \param event Type of the event just occurred.
879 * \param data Its type depends on the event.
881 * This function performs actions required due to the occurrence of the given
882 * event. Possible actions include reload of the current mood and update of the
883 * score of an audio file.
887 int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb,
894 * The three blob events might change the set of admissible files,
895 * so we must reload the score list.
900 if (data == moods_table || data == playlists_table)
901 return 1; /* no reload necessary for these */
902 return reload_current_mood();
903 /* these also require reload of the score table */
905 case ATTRIBUTE_REMOVE:
906 case ATTRIBUTE_RENAME:
907 return reload_current_mood();
908 /* changes to the aft only require to re-examine the audio file */
910 struct afsi_change_event_data *aced = data;
911 return mood_update_audio_file(aced->aft_row, aced->old_afsi);
914 case AUDIO_FILE_RENAME:
916 return mood_update_audio_file(data, NULL);
917 case AUDIO_FILE_REMOVE:
918 return mood_delete_audio_file(data);