2 * Copyright (C) 2007-2013 Andre Noll <maan@systemlinux.org>
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 time. */
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 mood_open().
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 \p accept,
64 * \p deny, or \p score which determines the type of the mood line. For each
65 * such type a linked list is maintained whose entries are the mood items.
67 * \sa mood_item, mood_open().
70 /** The name of this mood. */
72 /** The list of mood items of type \p accept. */
73 struct list_head accept_list;
74 /** The list of mood items of type \p deny. */
75 struct list_head deny_list;
76 /** The list of mood items of type \p score. */
77 struct list_head score_list;
81 * If current_mood is NULL then no mood is currently open. If
82 * current_mood->name is NULL, the dummy mood is currently open
84 static struct mood *current_mood;
87 * Rough approximation to sqrt.
89 * \param x Integer of which to calculate the sqrt.
91 * \return An integer res with res * res <= x.
93 __a_const static uint64_t int_sqrt(uint64_t x)
95 uint64_t op, res, one = 1;
104 if (op >= res + one) {
105 op = op - (res + one);
111 // PARA_NOTICE_LOG("sqrt(%llu) = %llu\n", x, res);
116 * Returns true if row matches, false if it does not match. In any case score
117 * and score_arg_sum are set/increased accordingly.
119 static bool get_item_score(struct mood_item *item, const struct afs_info *afsi,
120 const struct afh_info *afhi, const char *path, long *score,
126 *score_arg_sum += item->random_score? 100 : PARA_ABS(item->score_arg);
129 ret = item->method->score_function(path, afsi, afhi,
131 if ((ret < 0 && !item->logical_not) || (ret >= 0 && item->logical_not))
134 if (item->random_score)
135 *score = PARA_ABS(ret) * para_random(100);
137 *score = PARA_ABS(ret) * item->score_arg;
141 /* returns 1 if row admissible, 0 if not, negative on errors */
142 static int compute_mood_score(const struct osl_row *aft_row, struct mood *m,
145 struct mood_item *item;
148 long score_arg_sum = 0, score = 0, item_score;
149 struct afs_info afsi;
150 struct afh_info afhi;
155 ret = get_afsi_of_row(aft_row, &afsi);
158 ret = get_afhi_of_row(aft_row, &afhi);
161 ret = get_audio_file_path_of_row(aft_row, &path);
164 /* reject audio file if it matches any entry in the deny list */
165 list_for_each_entry(item, &m->deny_list, mood_item_node) {
166 match = get_item_score(item, &afsi, &afhi, path, &item_score,
168 if (match) /* not admissible */
173 list_for_each_entry(item, &m->accept_list, mood_item_node) {
174 ret = get_item_score(item, &afsi, &afhi, path, &item_score,
181 /* reject if there is no matching entry in the accept list */
182 if (!match && !list_empty(&m->accept_list))
184 list_for_each_entry(item, &m->score_list, mood_item_node) {
185 match = get_item_score(item, &afsi, &afhi, path, &item_score,
191 score /= score_arg_sum;
196 static void cleanup_list_entry(struct mood_item *item)
198 if (item->method && item->method->cleanup)
199 item->method->cleanup(item->parser_data);
201 free(item->parser_data);
202 list_del(&item->mood_item_node);
206 static void destroy_mood(struct mood *m)
208 struct mood_item *tmp, *item;
212 list_for_each_entry_safe(item, tmp, &m->accept_list, mood_item_node)
213 cleanup_list_entry(item);
214 list_for_each_entry_safe(item, tmp, &m->deny_list, mood_item_node)
215 cleanup_list_entry(item);
216 list_for_each_entry_safe(item, tmp, &m->score_list, mood_item_node)
217 cleanup_list_entry(item);
222 static struct mood *alloc_new_mood(const char *name)
224 struct mood *m = para_calloc(sizeof(struct mood));
226 m->name = para_strdup(name);
227 INIT_LIST_HEAD(&m->accept_list);
228 INIT_LIST_HEAD(&m->deny_list);
229 INIT_LIST_HEAD(&m->score_list);
233 /** The different types of a mood line. */
234 enum mood_line_type {
245 /** Data passed to the parser of a mood line. */
246 struct mood_line_parser_data {
247 /** The mood this mood line belongs to. */
249 /** The line number in the mood definition. */
254 * <accept [with score <score>] | deny [with score <score>] | score <score>>
255 * [if] [not] <mood_method> [options]
256 * <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);
369 free(mi->parser_data);
375 static int load_mood(const struct osl_row *mood_row, struct mood **m)
378 struct osl_object mood_def;
379 struct mood_line_parser_data mlpd = {.line_num = 0};
383 ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
388 mlpd.m = alloc_new_mood(mood_name);
389 ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
390 parse_mood_line, &mlpd);
391 osl_close_disk_object(&mood_def);
393 PARA_ERROR_LOG("unable to load mood %s: %s\n", mlpd.m->name,
394 para_strerror(-ret));
395 destroy_mood(mlpd.m);
402 static int check_mood(struct osl_row *mood_row, void *data)
404 struct para_buffer *pb = data;
406 struct osl_object mood_def;
407 struct mood_line_parser_data mlpd = {.line_num = 0};
409 int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
412 para_printf(pb, "failed to get mood definition: %s\n",
413 para_strerror(-ret));
416 if (!*mood_name) /* ignore dummy row */
418 ret = para_printf(pb, "checking mood %s...\n", mood_name);
421 ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
422 parse_mood_line, &mlpd);
424 para_printf(pb, "%s line %u: %s\n", mood_name, mlpd.line_num,
425 para_strerror(-ret));
427 osl_close_disk_object(&mood_def);
432 * Check all moods for syntax errors.
434 * \param fd The afs socket.
435 * \param query Unused.
437 void mood_check_callback(int fd, __a_unused const struct osl_object *query)
439 struct para_buffer pb = {
440 .max_size = shm_get_shmmax(),
441 .private_data = &(struct afs_max_size_handler_data) {
445 .max_size_handler = afs_max_size_handler
448 int ret = para_printf(&pb, "checking moods...\n");
451 osl_rbtree_loop(moods_table, BLOBCOL_ID, &pb,
454 pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
459 static unsigned int_log2(uint64_t x)
471 static int64_t normalized_value(int64_t x, int64_t n, int64_t sum, int64_t qd)
475 return 100 * (n * x - sum) / (int64_t)int_sqrt(n) / (int64_t)int_sqrt(qd);
478 static long compute_num_played_score(struct afs_info *afsi)
480 return -normalized_value(afsi->num_played, statistics.num,
481 statistics.num_played_sum, statistics.num_played_qd);
484 static long compute_last_played_score(struct afs_info *afsi)
486 return -normalized_value(afsi->last_played, statistics.num,
487 statistics.last_played_sum, statistics.last_played_qd);
490 static long compute_dynamic_score(const struct osl_row *aft_row)
492 struct afs_info afsi;
493 int64_t score, nscore = 0, lscore = 0;
496 ret = get_afsi_of_row(aft_row, &afsi);
499 nscore = compute_num_played_score(&afsi);
500 lscore = compute_last_played_score(&afsi);
501 score = nscore + lscore;
505 static int add_afs_statistics(const struct osl_row *row)
508 struct afs_info afsi;
511 ret = get_afsi_of_row(row, &afsi);
515 x = afsi.last_played;
516 s = statistics.last_played_sum;
518 q = (x > s / n)? x - s / n : s / n - x;
519 statistics.last_played_qd += q * q * n / (n + 1);
521 statistics.last_played_sum += x;
524 s = statistics.num_played_sum;
526 q = (x > s / n)? x - s / n : s / n - x;
527 statistics.num_played_qd += q * q * n / (n + 1);
529 statistics.num_played_sum += x;
534 static int del_afs_statistics(const struct osl_row *row)
536 uint64_t n, s, q, a, new_s;
537 struct afs_info afsi;
539 ret = get_afsi_of_row(row, &afsi);
545 memset(&statistics, 0, sizeof(statistics));
549 s = statistics.last_played_sum;
550 q = statistics.last_played_qd;
551 a = afsi.last_played;
553 statistics.last_played_sum = new_s;
554 statistics.last_played_qd = q + s * s / n - a * a
555 - new_s * new_s / (n - 1);
557 s = statistics.num_played_sum;
558 q = statistics.num_played_qd;
561 statistics.num_played_sum = new_s;
562 statistics.num_played_qd = q + s * s / n - a * a
563 - new_s * new_s / (n - 1);
570 * Structure used during mood_open().
572 * At mood open time, we look at each file in the audio file table in order to
573 * determine whether it is admissible. If a file happens to be admissible, its
574 * mood score is computed by calling each relevant mood_score_function. Next,
575 * we update the afs_statistics and add a struct admissible_file_info to a
578 * If all files have been processed that way, the final score of each
579 * admissible file is computed by adding the dynamic score (which depends on
580 * the afs_statistics) to the mood score. Finally, all audio files in the
581 * array are added to the score table and the admissible array is freed.
583 * \sa mood_method, admissible_array.
585 struct admissible_file_info
587 /** The admissible audio file. */
588 struct osl_row *aft_row;
593 /** The temporary array of admissible files. */
594 struct admissible_array {
595 /** Files are admissible wrt. this mood. */
597 /** The size of the array */
599 /** Pointer to the array of admissible files. */
600 struct admissible_file_info *array;
604 * Add an entry to the array of admissible files.
606 * \param aft_row The audio file to be added.
607 * \param private_data Pointer to a struct admissible_file_info.
609 * \return 1 if row admissible, 0 if not, negative on errors.
611 static int add_if_admissible(struct osl_row *aft_row, void *data)
613 struct admissible_array *aa = data;
617 ret = compute_mood_score(aft_row, aa->m, &score);
620 if (statistics.num >= aa->size) {
623 aa->array = para_realloc(aa->array,
624 aa->size * sizeof(struct admissible_file_info));
626 aa->array[statistics.num].aft_row = aft_row;
627 aa->array[statistics.num].score = score;
628 ret = add_afs_statistics(aft_row);
635 * Compute the new quadratic deviation in case one element changes.
637 * \param n Number of elements.
638 * \param old_qd The quadratic deviation before the change.
639 * \param old_val The value that was replaced.
640 * \param new_val The replacement value.
641 * \param old_sum The sum of all elements before the update.
643 * \return The new quadratic deviation resulting from replacing old_val
646 * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
647 * their quadratic deviation
649 * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
651 * and a real number b, the quadratic deviation q' of a_1,...a_{n-1}, b (ie.
652 * the last number a_n was replaced by b) may be computed in O(1) time in terms
653 * of n, q, a_n, b, and S as
655 * q' = q + d * s - (2 * S + d) * d / n
656 * = q + d * (s - 2 * S / n - d /n),
658 * where d = b - a_n, and s = b + a_n.
660 * Example: n = 3, a_1 = 3, a_2 = 5, a_3 = 7, b = 10. Then S = 15, q = 8, d = 3,
663 * q + d * s - (2 * S + d) * d / n = 8 + 51 - 33 = 26,
665 * which equals q' = (3 - 6)^2 + (5 - 6)^2 + (10 - 6)^2.
668 _static_inline_ int64_t update_quadratic_deviation(int64_t n, int64_t old_qd,
669 int64_t old_val, int64_t new_val, int64_t old_sum)
671 int64_t delta = new_val - old_val;
672 int64_t sigma = new_val + old_val;
673 return old_qd + delta * (sigma - 2 * old_sum / n - delta / n);
676 static int update_afs_statistics(struct afs_info *old_afsi, struct afs_info *new_afsi)
679 int ret = get_num_admissible_files(&n);
685 statistics.last_played_qd = update_quadratic_deviation(n,
686 statistics.last_played_qd, old_afsi->last_played,
687 new_afsi->last_played, statistics.last_played_sum);
688 statistics.last_played_sum += new_afsi->last_played - old_afsi->last_played;
690 statistics.num_played_qd = update_quadratic_deviation(n,
691 statistics.num_played_qd, old_afsi->num_played,
692 new_afsi->num_played, statistics.num_played_sum);
693 statistics.num_played_sum += new_afsi->num_played - old_afsi->num_played;
697 static int add_to_score_table(const struct osl_row *aft_row, long mood_score)
699 long score = (compute_dynamic_score(aft_row) + mood_score) / 3;
700 return score_add(aft_row, score);
703 static int delete_from_statistics_and_score_table(const struct osl_row *aft_row)
705 int ret = del_afs_statistics(aft_row);
708 return score_delete(aft_row);
712 * Delete one entry from the statistics and from the score table.
714 * \param aft_row The audio file which is no longer admissible.
716 * \return Positive on success, negative on errors.
718 * \sa score_delete().
720 static int mood_delete_audio_file(const struct osl_row *aft_row)
724 ret = row_belongs_to_score_table(aft_row, NULL);
727 if (!ret) /* not admissible, nothing to do */
729 return delete_from_statistics_and_score_table(aft_row);
733 * Compute the new score of an audio file wrt. the current mood.
735 * \param aft_row Determines the audio file.
736 * \param old_afsi The audio file selector info before updating.
738 * The \a old_afsi argument may be \p NULL which indicates that no changes to
739 * the audio file info were made.
741 * \return Positive on success, negative on errors.
743 static int mood_update_audio_file(const struct osl_row *aft_row,
744 struct afs_info *old_afsi)
747 int ret, is_admissible, was_admissible = 0;
748 struct afs_info afsi;
752 return 1; /* nothing to do */
753 ret = row_belongs_to_score_table(aft_row, &rank);
756 was_admissible = ret;
757 ret = compute_mood_score(aft_row, current_mood, &score);
760 is_admissible = (ret > 0);
761 if (!was_admissible && !is_admissible)
763 if (was_admissible && !is_admissible)
764 return delete_from_statistics_and_score_table(aft_row);
765 if (!was_admissible && is_admissible) {
766 ret = add_afs_statistics(aft_row);
769 return add_to_score_table(aft_row, score);
772 ret = get_afsi_of_row(aft_row, &afsi);
776 ret = update_afs_statistics(old_afsi, &afsi);
780 score += compute_num_played_score(&afsi);
781 score += compute_last_played_score(&afsi);
783 PARA_DEBUG_LOG("score: %li\n", score);
784 percent = (score + 100) / 3;
787 else if (percent < 0)
789 PARA_DEBUG_LOG("moving from rank %u to %lu%%\n", rank, percent);
790 return score_update(aft_row, percent);
793 static void log_statistics(void)
795 unsigned n = statistics.num;
798 PARA_NOTICE_LOG("no admissible files\n");
801 PARA_INFO_LOG("last_played mean: %lli, last_played sigma: %llu\n",
802 (long long int)(statistics.last_played_sum / n),
803 (long long unsigned)int_sqrt(statistics.last_played_qd / n));
804 PARA_INFO_LOG("num_played mean: %lli, num_played sigma: %llu\n",
805 (long long int)statistics.num_played_sum / n,
806 (long long unsigned)int_sqrt(statistics.num_played_qd / n));
810 * Close the current mood.
812 * Free all resources of the current mood which were allocated during
815 void close_current_mood(void)
817 destroy_mood(current_mood);
819 memset(&statistics, 0, sizeof(statistics));
823 * Change the current mood.
825 * \param mood_name The name of the mood to open.
827 * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
828 * and uses a scoring method based only on the \a last_played information.
830 * If there is already an open mood, it will be closed first.
832 * \return Positive on success, negative on errors. Loading the dummy mood
835 * \sa struct admissible_file_info, struct admissible_array, struct
836 * afs_info::last_played, mood_close().
838 int change_current_mood(char *mood_name)
841 struct admissible_array aa = {
849 struct osl_object obj = {
851 .size = strlen(mood_name) + 1
853 ret = osl(osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row));
855 PARA_NOTICE_LOG("no such mood: %s\n", mood_name);
858 ret = load_mood(row, &m);
861 close_current_mood();
863 } else { /* load dummy mood */
864 close_current_mood();
865 current_mood = alloc_new_mood(NULL);
868 PARA_NOTICE_LOG("computing statistics of admissible files\n");
869 ret = audio_file_loop(&aa, add_if_admissible);
873 PARA_INFO_LOG("%d admissible files \n", statistics.num);
874 for (i = 0; i < statistics.num; i++) {
875 struct admissible_file_info *a = aa.array + i;
876 ret = add_to_score_table(a->aft_row, a->score);
880 PARA_NOTICE_LOG("loaded mood %s\n", mood_name? mood_name : "(dummy)");
881 ret = statistics.num;
887 * Close and re-open the current mood.
889 * This function is used if changes to the audio file table or the
890 * attribute table were made that render the current list of admissible
891 * files useless. For example, if an attribute is removed from the
892 * attribute table, this function is called.
894 * \return Positive on success, negative on errors. If no mood is currently
895 * open, the function returns success.
897 * \sa mood_open(), mood_close().
899 static int reload_current_mood(void)
902 char *mood_name = NULL;
904 ret = clear_score_table();
909 PARA_NOTICE_LOG("reloading %s\n", current_mood->name?
910 current_mood->name : "(dummy)");
911 if (current_mood->name)
912 mood_name = para_strdup(current_mood->name);
913 close_current_mood();
914 ret = change_current_mood(mood_name);
920 * Notification callback for the moods table.
922 * \param event Type of the event just occurred.
924 * \param data Its type depends on the event.
926 * This function performs actions required due to the occurrence of the given
927 * event. Possible actions include reload of the current mood and update of the
928 * score of an audio file.
932 int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb,
939 * The three blob events might change the set of admissible files,
940 * so we must reload the score list.
945 if (data == moods_table || data == playlists_table)
946 return 1; /* no reload necessary for these */
947 return reload_current_mood();
948 /* these also require reload of the score table */
950 case ATTRIBUTE_REMOVE:
951 case ATTRIBUTE_RENAME:
952 return reload_current_mood();
953 /* changes to the aft only require to re-examine the audio file */
955 struct afsi_change_event_data *aced = data;
956 return mood_update_audio_file(aced->aft_row, aced->old_afsi);
959 case AUDIO_FILE_RENAME:
961 return mood_update_audio_file(data, NULL);
962 case AUDIO_FILE_REMOVE:
963 return mood_delete_audio_file(data);