2 * Copyright (C) 2007-2009 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. */
22 * Contains statistical data of the currently admissible audio files.
24 * It is used to assign normalized score values to each admissible audio file.
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 */
38 struct afs_statistics statistics;
41 * Each line of the current mood corresponds to a 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. */
48 /** The given score value, or zero if none was given. */
50 /** Non-zero if random scoring was requested. */
52 /** Whether the "not" keyword was given in the mood line. */
54 /** The position in the list of items. */
55 struct list_head mood_item_node;
59 * Created from the mood definition by mood_open().
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.
66 * \sa mood_item, mood_open().
69 /** The name of this mood. */
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;
79 static struct mood *current_mood;
82 * Rough approximation to sqrt.
84 * \param x Integer of which to calculate the sqrt.
86 * \return An integer res with res * res <= x.
88 static uint64_t int_sqrt(uint64_t x)
90 uint64_t op, res, one = 1;
99 if (op >= res + one) {
100 op = op - (res + one);
106 // PARA_NOTICE_LOG("sqrt(%llu) = %llu\n", x, res);
110 /* returns 1 if row matches score item, 0 if not, negative on errors */
111 static int get_item_score(const struct osl_row *row, struct mood_item *item,
112 long *score, long *score_arg_sum)
114 struct afs_info afsi;
115 struct afh_info afhi;
119 *score_arg_sum += item->random_score? 100 : PARA_ABS(item->score_arg);
122 ret = get_afsi_of_row(row, &afsi);
125 ret = get_afhi_of_row(row, &afhi);
128 ret = get_audio_file_path_of_row(row, &path);
131 ret = item->method->score_function(path, &afsi, &afhi,
133 if ((ret < 0 && !item->logical_not) || (ret >= 0 && item->logical_not))
134 match = 0; /* no match */
136 if (item->random_score)
137 *score = PARA_ABS(ret) * para_random(100);
139 *score = PARA_ABS(ret) * item->score_arg;
143 /* returns 1 if row admissible, 0 if not, negative on errors */
144 static int compute_mood_score(const struct osl_row *aft_row, struct mood *m,
147 struct mood_item *item;
149 long score_arg_sum = 0, score = 0, item_score;
153 /* reject audio file if it matches any entry in the deny list */
154 list_for_each_entry(item, &m->deny_list, mood_item_node) {
155 ret = get_item_score(aft_row, item, &item_score,
159 if (ret > 0) /* not admissible */
163 list_for_each_entry(item, &m->accept_list, mood_item_node) {
164 ret = get_item_score(aft_row, item, &item_score,
173 /* reject if there is no matching entry in the accept list */
174 if (!match && !list_empty(&m->accept_list))
176 list_for_each_entry(item, &m->score_list, mood_item_node) {
177 ret = get_item_score(aft_row, item, &item_score,
184 score /= score_arg_sum;
189 static void cleanup_list_entry(struct mood_item *item)
191 if (item->method && item->method->cleanup)
192 item->method->cleanup(item->parser_data);
194 free(item->parser_data);
195 list_del(&item->mood_item_node);
199 static void destroy_mood(struct mood *m)
201 struct mood_item *tmp, *item;
205 list_for_each_entry_safe(item, tmp, &m->accept_list, mood_item_node)
206 cleanup_list_entry(item);
207 list_for_each_entry_safe(item, tmp, &m->deny_list, mood_item_node)
208 cleanup_list_entry(item);
209 list_for_each_entry_safe(item, tmp, &m->score_list, mood_item_node)
210 cleanup_list_entry(item);
215 static struct mood *alloc_new_mood(const char *name)
217 struct mood *m = para_calloc(sizeof(struct mood));
218 m->name = para_strdup(name);
219 INIT_LIST_HEAD(&m->accept_list);
220 INIT_LIST_HEAD(&m->deny_list);
221 INIT_LIST_HEAD(&m->score_list);
225 /** The different types of a mood line. */
226 enum mood_line_type {
237 /** Data passed to the parser of a mood line. */
238 struct mood_line_parser_data {
239 /** The mood this mood line belongs to. */
241 /** The line number in the mood definition. */
246 * <accept [with score <score>] | deny [with score <score>] | score <score>>
247 * [if] [not] <mood_method> [options]
248 * <score> is either an integer or "random" which assigns a random score to
252 static int parse_mood_line(char *mood_line, void *data)
254 struct mood_line_parser_data *mlpd = data;
259 enum mood_line_type mlt = ML_INVALID;
260 struct mood_item *mi = NULL;
263 ret = create_argv(mood_line, " \t", &argv);
267 if (!num_words) /* empty line */
270 if (**w == '#') /* comment */
272 if (!strcmp(*w, "accept"))
274 else if (!strcmp(*w, "deny"))
276 else if (!strcmp(*w, "score"))
278 ret = -E_MOOD_SYNTAX;
279 if (mlt == ML_INVALID)
281 mi = para_calloc(sizeof(struct mood_item));
282 if (mlt != ML_SCORE) {
283 ret = -E_MOOD_SYNTAX;
287 if (strcmp(*w, "with"))
292 if (strcmp(*w, "score"))
295 if (mlt == ML_SCORE || !strcmp(*w, "score")) {
296 ret = -E_MOOD_SYNTAX;
300 if (strcmp(*w, "random")) {
301 mi->random_score = 0;
302 ret = para_atoi32(*w, &mi->score_arg);
306 mi->random_score = 1;
308 goto success; /* the line "score random" is valid */
312 ret = -E_MOOD_SYNTAX;
317 if (!strcmp(*w, "if")) {
318 ret = -E_MOOD_SYNTAX;
323 if (!strcmp(*w, "not")) {
324 ret = -E_MOOD_SYNTAX;
331 for (i = 0; mood_methods[i].parser; i++) {
332 if (strcmp(*w, mood_methods[i].name))
336 ret = -E_MOOD_SYNTAX;
337 if (!mood_methods[i].parser)
339 ret = mood_methods[i].parser(num_words - 1 - (w - argv), w,
343 mi->method = &mood_methods[i];
346 if (mlt == ML_ACCEPT)
347 para_list_add(&mi->mood_item_node, &mlpd->m->accept_list);
348 else if (mlt == ML_DENY)
349 para_list_add(&mi->mood_item_node, &mlpd->m->deny_list);
351 para_list_add(&mi->mood_item_node, &mlpd->m->score_list);
353 PARA_DEBUG_LOG("%s entry added, method: %p\n", mlt == ML_ACCEPT? "accept" :
354 (mlt == ML_DENY? "deny" : "score"), mi->method);
361 free(mi->parser_data);
367 static int load_mood(const struct osl_row *mood_row, struct mood **m)
370 struct osl_object mood_def;
371 struct mood_line_parser_data mlpd = {.line_num = 0};
372 int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
378 mlpd.m = alloc_new_mood(mood_name);
379 ret = for_each_line_ro(mood_def.data, mood_def.size,
380 parse_mood_line, &mlpd);
381 osl_close_disk_object(&mood_def);
383 PARA_ERROR_LOG("unable to load mood %s: %s\n", mlpd.m->name,
384 para_strerror(-ret));
385 destroy_mood(mlpd.m);
392 static int check_mood(struct osl_row *mood_row, void *data)
394 struct para_buffer *pb = data;
396 struct osl_object mood_def;
397 struct mood_line_parser_data mlpd = {.line_num = 0};
399 int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
402 para_printf(pb, "failed to get mood definition: %s\n",
403 para_strerror(-ret));
406 if (!*mood_name) /* ignore dummy row */
408 ret = para_printf(pb, "checking mood %s...\n", mood_name);
411 ret = for_each_line_ro(mood_def.data, mood_def.size,
412 parse_mood_line, &mlpd);
414 para_printf(pb, "%s line %u: %s\n", mood_name, mlpd.line_num,
415 para_strerror(-ret));
417 osl_close_disk_object(&mood_def);
422 * Check all moods for syntax errors.
424 * \param fd The afs socket.
425 * \param query Unused.
427 void mood_check_callback(int fd, __a_unused const struct osl_object *query)
429 struct para_buffer pb = {
432 .max_size_handler = pass_buffer_as_shm
435 int ret = para_printf(&pb, "checking moods...\n");
438 osl_rbtree_loop(moods_table, BLOBCOL_ID, &pb,
441 pass_buffer_as_shm(pb.buf, pb.offset, &fd);
446 static unsigned int_log2(uint64_t x)
458 static int64_t normalized_value(int64_t x, int64_t n, int64_t sum, int64_t qd)
462 return 100 * (n * x - sum) / (int64_t)int_sqrt(n * qd);
465 static long compute_num_played_score(struct afs_info *afsi)
467 return -normalized_value(afsi->num_played, statistics.num,
468 statistics.num_played_sum, statistics.num_played_qd);
471 static long compute_last_played_score(struct afs_info *afsi)
473 return -normalized_value(afsi->last_played, statistics.num,
474 statistics.last_played_sum, statistics.last_played_qd);
477 static long compute_dynamic_score(const struct osl_row *aft_row)
479 struct afs_info afsi;
480 int64_t score, nscore = 0, lscore = 0;
483 ret = get_afsi_of_row(aft_row, &afsi);
486 nscore = compute_num_played_score(&afsi);
487 lscore = compute_last_played_score(&afsi);
488 score = nscore + lscore;
492 static int add_afs_statistics(const struct osl_row *row)
495 struct afs_info afsi;
498 ret = get_afsi_of_row(row, &afsi);
502 x = afsi.last_played;
503 s = statistics.last_played_sum;
505 statistics.last_played_qd += (x - s / n) * (x - s / n) * n / (n + 1);
506 statistics.last_played_sum += x;
509 s = statistics.num_played_sum;
511 statistics.num_played_qd += (x - s / n) * (x - s / n) * n / (n + 1);
512 statistics.num_played_sum += x;
517 static int del_afs_statistics(const struct osl_row *row)
519 uint64_t n, s, q, a, new_s;
520 struct afs_info afsi;
522 ret = get_afsi_of_row(row, &afsi);
528 memset(&statistics, 0, sizeof(statistics));
532 s = statistics.last_played_sum;
533 q = statistics.last_played_qd;
534 a = afsi.last_played;
536 statistics.last_played_sum = new_s;
537 statistics.last_played_qd = q + s * s / n - a * a
538 - new_s * new_s / (n - 1);
540 s = statistics.num_played_sum;
541 q = statistics.num_played_qd;
544 statistics.num_played_sum = new_s;
545 statistics.num_played_qd = q + s * s / n - a * a
546 - new_s * new_s / (n - 1);
553 * Structure used during mood_open().
555 * At mood open time, we look at each file in the audio file table in order to
556 * determine whether it is admissible. If a file happens to be admissible, its
557 * mood score is computed by calling each relevant mood_score_function. Next,
558 * we update the afs_statistics and add a struct admissible_file_info to a
561 * If all files have been processed that way, the final score of each
562 * admissible file is computed by adding the dynamic score (which depends on
563 * the afs_statistics) to the mood score. Finally, all audio files in the
564 * array are added to the score table and the admissible array is freed.
566 * \sa mood_method, admissible_array.
568 struct admissible_file_info
570 /** The admissible audio file. */
571 struct osl_row *aft_row;
576 /** The temporary array of admissible files. */
577 struct admissible_array {
578 /** Files are admissible wrt. this mood. */
580 /** The size of the array */
582 /** Pointer to the array of admissible files. */
583 struct admissible_file_info *array;
587 * Add an entry to the array of admissible files.
589 * \param aft_row The audio file to be added.
590 * \param private_data Pointer to a struct admissible_file_info.
592 * \return 1 if row admissible, 0 if not, negative on errors.
594 static int add_if_admissible(struct osl_row *aft_row, void *data)
596 struct admissible_array *aa = data;
600 ret = compute_mood_score(aft_row, aa->m, &score);
603 if (statistics.num >= aa->size) {
606 aa->array = para_realloc(aa->array,
607 aa->size * sizeof(struct admissible_file_info));
609 aa->array[statistics.num].aft_row = aft_row;
610 aa->array[statistics.num].score = score;
611 ret = add_afs_statistics(aft_row);
618 * Compute the new quadratic deviation in case one element changes.
620 * \param n Number of elements.
621 * \param old_qd The quadratic deviation before the change.
622 * \param old_val The value that was replaced.
623 * \param new_val The replacement value.
624 * \param old_sum The sum of all elements before the update.
626 * \return The new quadratic deviation resulting from replacing old_val
629 * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
630 * their quadratic deviation
632 * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
634 * and a real number b, the quadratic deviation q' of a_1,...a_{n-1}, b (ie.
635 * the last number a_n was replaced by b) may be computed in O(1) time in terms
636 * of n, q, a_n, b, and S as
638 * q' = q + d * s - (2 * S + d) * 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 + delta) * delta / n;
658 static int update_afs_statistics(struct afs_info *old_afsi, struct afs_info *new_afsi)
661 int ret = get_num_admissible_files(&n);
667 statistics.last_played_qd = update_quadratic_deviation(n,
668 statistics.last_played_qd, old_afsi->last_played,
669 new_afsi->last_played, statistics.last_played_sum);
670 statistics.last_played_sum += new_afsi->last_played - old_afsi->last_played;
672 statistics.num_played_qd = update_quadratic_deviation(n,
673 statistics.num_played_qd, old_afsi->num_played,
674 new_afsi->num_played, statistics.num_played_sum);
675 statistics.num_played_sum += new_afsi->num_played - old_afsi->num_played;
679 static int add_to_score_table(const struct osl_row *aft_row, long mood_score)
681 long score = (compute_dynamic_score(aft_row) + mood_score) / 3;
682 return score_add(aft_row, score);
685 static int delete_from_statistics_and_score_table(const struct osl_row *aft_row)
687 int ret = del_afs_statistics(aft_row);
690 return score_delete(aft_row);
694 * Delete one entry from the statistics and from the score table.
696 * \param aft_row The audio file which is no longer admissible.
698 * \return Positive on success, negative on errors.
700 * \sa score_delete().
702 static int mood_delete_audio_file(const struct osl_row *aft_row)
706 ret = row_belongs_to_score_table(aft_row, NULL);
709 if (!ret) /* not admissible, nothing to do */
711 return delete_from_statistics_and_score_table(aft_row);
715 * Compute the new score of an audio file wrt. the current mood.
717 * \param aft_row Determines the audio file.
718 * \param old_afsi The audio file selector info before updating.
720 * The \a old_afsi argument may be \p NULL which indicates that no changes to
721 * the audio file info were made.
723 * \return Positive on success, negative on errors.
725 static int mood_update_audio_file(const struct osl_row *aft_row,
726 struct afs_info *old_afsi)
729 int ret, is_admissible, was_admissible = 0;
730 struct afs_info afsi;
734 return 1; /* nothing to do */
735 ret = row_belongs_to_score_table(aft_row, &rank);
738 was_admissible = ret;
739 ret = compute_mood_score(aft_row, current_mood, &score);
742 is_admissible = (ret > 0);
743 if (!was_admissible && !is_admissible)
745 if (was_admissible && !is_admissible)
746 return delete_from_statistics_and_score_table(aft_row);
747 if (!was_admissible && is_admissible) {
748 ret = add_afs_statistics(aft_row);
751 return add_to_score_table(aft_row, score);
754 ret = get_afsi_of_row(aft_row, &afsi);
758 ret = update_afs_statistics(old_afsi, &afsi);
762 score += compute_num_played_score(&afsi);
763 score += compute_last_played_score(&afsi);
765 PARA_DEBUG_LOG("score: %li\n", score);
766 percent = (score + 100) / 3;
769 else if (percent < 0)
771 PARA_DEBUG_LOG("moving from rank %u to %lu%%\n", rank, percent);
772 return score_update(aft_row, percent);
775 static void log_statistics(void)
777 unsigned n = statistics.num;
780 PARA_NOTICE_LOG("no admissible files\n");
783 PARA_INFO_LOG("last_played mean: %lli, last_played sigma: %llu\n",
784 (long long int)(statistics.last_played_sum / n),
785 (long long unsigned)int_sqrt(statistics.last_played_qd / n));
786 PARA_INFO_LOG("num_played mean: %lli, num_played sigma: %llu\n",
787 (long long int)statistics.num_played_sum / n,
788 (long long unsigned)int_sqrt(statistics.num_played_qd / n));
792 * Close the current mood.
794 * Free all resources of the current mood which were allocated during
797 void close_current_mood(void)
799 destroy_mood(current_mood);
801 memset(&statistics, 0, sizeof(statistics));
805 * Change the current mood.
807 * \param mood_name The name of the mood to open.
809 * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
810 * and uses a scoring method based only on the \a last_played information.
812 * If there is already an open mood, it will be closed first.
814 * \return Positive on success, negative on errors. Loading the dummy mood
817 * \sa struct admissible_file_info, struct admissible_array, struct
818 * afs_info::last_played, mood_close().
820 int change_current_mood(char *mood_name)
823 struct admissible_array aa = {
831 struct osl_object obj = {
833 .size = strlen(mood_name) + 1
835 ret = osl(osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row));
837 PARA_NOTICE_LOG("no such mood: %s\n", mood_name);
840 ret = load_mood(row, &m);
843 close_current_mood();
846 close_current_mood();
847 current_mood = alloc_new_mood("dummy");
850 PARA_NOTICE_LOG("computing statistics of admissible files\n");
851 ret = audio_file_loop(&aa, add_if_admissible);
855 PARA_INFO_LOG("%d admissible files \n", statistics.num);
856 for (i = 0; i < statistics.num; i++) {
857 struct admissible_file_info *a = aa.array + i;
858 ret = add_to_score_table(a->aft_row, a->score);
862 PARA_NOTICE_LOG("loaded mood %s\n", current_mood->name);
863 ret = statistics.num;
869 * Close and re-open the current mood.
871 * This function is used if changes to the audio file table or the
872 * attribute table were made that render the current list of admissible
873 * files useless. For example, if an attribute is removed from the
874 * attribute table, this function is called.
876 * \return Positive on success, negative on errors. If no mood is currently
877 * open, the function returns success.
879 * \sa mood_open(), mood_close().
881 int reload_current_mood(void)
884 char *mood_name = NULL;
888 PARA_NOTICE_LOG("reloading %s\n", current_mood->name?
889 current_mood->name : "(dummy)");
890 if (current_mood->name)
891 mood_name = para_strdup(current_mood->name);
892 close_current_mood();
893 ret = change_current_mood(mood_name);
898 int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb,
903 * The three blob events might change the set of admissible files,
904 * so we must reload the score list.
909 if (data == moods_table || data == playlists_table)
910 return 1; /* no reload necessary for these */
911 return reload_current_mood();
912 /* these also require reload of the score table */
914 case ATTRIBUTE_REMOVE:
915 case ATTRIBUTE_RENAME:
916 return reload_current_mood();
917 /* changes to the aft only require to re-examine the audio file */
919 struct afsi_change_event_data *aced = data;
920 return mood_update_audio_file(aced->aft_row, aced->old_afsi);
923 case AUDIO_FILE_RENAME:
925 return mood_update_audio_file(data, NULL);
926 case AUDIO_FILE_REMOVE:
927 return mood_delete_audio_file(data);