2 * Copyright (C) 2007-2012 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
;
80 static struct mood
*current_mood
;
83 * Rough approximation to sqrt.
85 * \param x Integer of which to calculate the sqrt.
87 * \return An integer res with res * res <= x.
89 __a_const
static uint64_t int_sqrt(uint64_t x
)
91 uint64_t op
, res
, one
= 1;
100 if (op
>= res
+ one
) {
101 op
= op
- (res
+ one
);
107 // PARA_NOTICE_LOG("sqrt(%llu) = %llu\n", x, res);
111 /* returns 1 if row matches score item, 0 if not. */
112 static int get_item_score(struct mood_item
*item
, const struct afs_info
*afsi
,
113 const struct afh_info
*afhi
, const char *path
, long *score
,
118 *score_arg_sum
+= item
->random_score
? 100 : PARA_ABS(item
->score_arg
);
121 ret
= item
->method
->score_function(path
, afsi
, afhi
,
123 if ((ret
< 0 && !item
->logical_not
) || (ret
>= 0 && item
->logical_not
))
124 match
= 0; /* no match */
126 if (item
->random_score
)
127 *score
= PARA_ABS(ret
) * para_random(100);
129 *score
= PARA_ABS(ret
) * item
->score_arg
;
133 /* returns 1 if row admissible, 0 if not, negative on errors */
134 static int compute_mood_score(const struct osl_row
*aft_row
, struct mood
*m
,
137 struct mood_item
*item
;
139 long score_arg_sum
= 0, score
= 0, item_score
;
140 struct afs_info afsi
;
141 struct afh_info afhi
;
146 ret
= get_afsi_of_row(aft_row
, &afsi
);
149 ret
= get_afhi_of_row(aft_row
, &afhi
);
152 ret
= get_audio_file_path_of_row(aft_row
, &path
);
155 /* reject audio file if it matches any entry in the deny list */
156 list_for_each_entry(item
, &m
->deny_list
, mood_item_node
) {
157 ret
= get_item_score(item
, &afsi
, &afhi
, path
, &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(item
, &afsi
, &afhi
, path
, &item_score
,
171 /* reject if there is no matching entry in the accept list */
172 if (!match
&& !list_empty(&m
->accept_list
))
174 list_for_each_entry(item
, &m
->score_list
, mood_item_node
) {
175 ret
= get_item_score(item
, &afsi
, &afhi
, path
, &item_score
,
180 score
/= score_arg_sum
;
185 static void cleanup_list_entry(struct mood_item
*item
)
187 if (item
->method
&& item
->method
->cleanup
)
188 item
->method
->cleanup(item
->parser_data
);
190 free(item
->parser_data
);
191 list_del(&item
->mood_item_node
);
195 static void destroy_mood(struct mood
*m
)
197 struct mood_item
*tmp
, *item
;
201 list_for_each_entry_safe(item
, tmp
, &m
->accept_list
, mood_item_node
)
202 cleanup_list_entry(item
);
203 list_for_each_entry_safe(item
, tmp
, &m
->deny_list
, mood_item_node
)
204 cleanup_list_entry(item
);
205 list_for_each_entry_safe(item
, tmp
, &m
->score_list
, mood_item_node
)
206 cleanup_list_entry(item
);
211 static struct mood
*alloc_new_mood(const char *name
)
213 struct mood
*m
= para_calloc(sizeof(struct mood
));
214 m
->name
= para_strdup(name
);
215 INIT_LIST_HEAD(&m
->accept_list
);
216 INIT_LIST_HEAD(&m
->deny_list
);
217 INIT_LIST_HEAD(&m
->score_list
);
221 /** The different types of a mood line. */
222 enum mood_line_type
{
233 /** Data passed to the parser of a mood line. */
234 struct mood_line_parser_data
{
235 /** The mood this mood line belongs to. */
237 /** The line number in the mood definition. */
242 * <accept [with score <score>] | deny [with score <score>] | score <score>>
243 * [if] [not] <mood_method> [options]
244 * <score> is either an integer or "random" which assigns a random score to
248 static int parse_mood_line(char *mood_line
, void *data
)
250 struct mood_line_parser_data
*mlpd
= data
;
255 enum mood_line_type mlt
= ML_INVALID
;
256 struct mood_item
*mi
= NULL
;
259 ret
= create_argv(mood_line
, " \t", &argv
);
263 if (!num_words
) /* empty line */
266 if (**w
== '#') /* comment */
268 if (!strcmp(*w
, "accept"))
270 else if (!strcmp(*w
, "deny"))
272 else if (!strcmp(*w
, "score"))
274 ret
= -E_MOOD_SYNTAX
;
275 if (mlt
== ML_INVALID
)
277 mi
= para_calloc(sizeof(struct mood_item
));
278 if (mlt
!= ML_SCORE
) {
279 ret
= -E_MOOD_SYNTAX
;
283 if (strcmp(*w
, "with"))
288 if (strcmp(*w
, "score"))
291 if (mlt
== ML_SCORE
|| !strcmp(*w
, "score")) {
292 ret
= -E_MOOD_SYNTAX
;
296 if (strcmp(*w
, "random")) {
297 mi
->random_score
= 0;
298 ret
= para_atoi32(*w
, &mi
->score_arg
);
302 mi
->random_score
= 1;
304 goto success
; /* the line "score random" is valid */
308 ret
= -E_MOOD_SYNTAX
;
313 if (!strcmp(*w
, "if")) {
314 ret
= -E_MOOD_SYNTAX
;
319 if (!strcmp(*w
, "not")) {
320 ret
= -E_MOOD_SYNTAX
;
327 for (i
= 0; mood_methods
[i
].parser
; i
++) {
328 if (strcmp(*w
, mood_methods
[i
].name
))
332 ret
= -E_MOOD_SYNTAX
;
333 if (!mood_methods
[i
].parser
)
335 ret
= mood_methods
[i
].parser(num_words
- 1 - (w
- argv
), w
,
339 mi
->method
= &mood_methods
[i
];
342 if (mlt
== ML_ACCEPT
)
343 para_list_add(&mi
->mood_item_node
, &mlpd
->m
->accept_list
);
344 else if (mlt
== ML_DENY
)
345 para_list_add(&mi
->mood_item_node
, &mlpd
->m
->deny_list
);
347 para_list_add(&mi
->mood_item_node
, &mlpd
->m
->score_list
);
349 PARA_DEBUG_LOG("%s entry added, method: %p\n", mlt
== ML_ACCEPT
? "accept" :
350 (mlt
== ML_DENY
? "deny" : "score"), mi
->method
);
357 free(mi
->parser_data
);
363 static int load_mood(const struct osl_row
*mood_row
, struct mood
**m
)
366 struct osl_object mood_def
;
367 struct mood_line_parser_data mlpd
= {.line_num
= 0};
371 ret
= mood_get_name_and_def_by_row(mood_row
, &mood_name
, &mood_def
);
376 mlpd
.m
= alloc_new_mood(mood_name
);
377 ret
= for_each_line_ro(mood_def
.data
, mood_def
.size
,
378 parse_mood_line
, &mlpd
);
379 osl_close_disk_object(&mood_def
);
381 PARA_ERROR_LOG("unable to load mood %s: %s\n", mlpd
.m
->name
,
382 para_strerror(-ret
));
383 destroy_mood(mlpd
.m
);
390 static int check_mood(struct osl_row
*mood_row
, void *data
)
392 struct para_buffer
*pb
= data
;
394 struct osl_object mood_def
;
395 struct mood_line_parser_data mlpd
= {.line_num
= 0};
397 int ret
= mood_get_name_and_def_by_row(mood_row
, &mood_name
, &mood_def
);
400 para_printf(pb
, "failed to get mood definition: %s\n",
401 para_strerror(-ret
));
404 if (!*mood_name
) /* ignore dummy row */
406 ret
= para_printf(pb
, "checking mood %s...\n", mood_name
);
409 ret
= for_each_line_ro(mood_def
.data
, mood_def
.size
,
410 parse_mood_line
, &mlpd
);
412 para_printf(pb
, "%s line %u: %s\n", mood_name
, mlpd
.line_num
,
413 para_strerror(-ret
));
415 osl_close_disk_object(&mood_def
);
420 * Check all moods for syntax errors.
422 * \param fd The afs socket.
423 * \param query Unused.
425 void mood_check_callback(int fd
, __a_unused
const struct osl_object
*query
)
427 struct para_buffer pb
= {
428 .max_size
= shm_get_shmmax(),
429 .private_data
= &(struct afs_max_size_handler_data
) {
433 .max_size_handler
= afs_max_size_handler
436 int ret
= para_printf(&pb
, "checking moods...\n");
439 osl_rbtree_loop(moods_table
, BLOBCOL_ID
, &pb
,
442 pass_buffer_as_shm(fd
, SBD_OUTPUT
, pb
.buf
, pb
.offset
);
447 static unsigned int_log2(uint64_t x
)
459 static int64_t normalized_value(int64_t x
, int64_t n
, int64_t sum
, int64_t qd
)
463 return 100 * (n
* x
- sum
) / (int64_t)int_sqrt(n
* qd
);
466 static long compute_num_played_score(struct afs_info
*afsi
)
468 return -normalized_value(afsi
->num_played
, statistics
.num
,
469 statistics
.num_played_sum
, statistics
.num_played_qd
);
472 static long compute_last_played_score(struct afs_info
*afsi
)
474 return -normalized_value(afsi
->last_played
, statistics
.num
,
475 statistics
.last_played_sum
, statistics
.last_played_qd
);
478 static long compute_dynamic_score(const struct osl_row
*aft_row
)
480 struct afs_info afsi
;
481 int64_t score
, nscore
= 0, lscore
= 0;
484 ret
= get_afsi_of_row(aft_row
, &afsi
);
487 nscore
= compute_num_played_score(&afsi
);
488 lscore
= compute_last_played_score(&afsi
);
489 score
= nscore
+ lscore
;
493 static int add_afs_statistics(const struct osl_row
*row
)
496 struct afs_info afsi
;
499 ret
= get_afsi_of_row(row
, &afsi
);
503 x
= afsi
.last_played
;
504 s
= statistics
.last_played_sum
;
506 statistics
.last_played_qd
+= (x
- s
/ n
) * (x
- s
/ n
) * n
/ (n
+ 1);
507 statistics
.last_played_sum
+= x
;
510 s
= statistics
.num_played_sum
;
512 statistics
.num_played_qd
+= (x
- s
/ n
) * (x
- s
/ n
) * n
/ (n
+ 1);
513 statistics
.num_played_sum
+= x
;
518 static int del_afs_statistics(const struct osl_row
*row
)
520 uint64_t n
, s
, q
, a
, new_s
;
521 struct afs_info afsi
;
523 ret
= get_afsi_of_row(row
, &afsi
);
529 memset(&statistics
, 0, sizeof(statistics
));
533 s
= statistics
.last_played_sum
;
534 q
= statistics
.last_played_qd
;
535 a
= afsi
.last_played
;
537 statistics
.last_played_sum
= new_s
;
538 statistics
.last_played_qd
= q
+ s
* s
/ n
- a
* a
539 - new_s
* new_s
/ (n
- 1);
541 s
= statistics
.num_played_sum
;
542 q
= statistics
.num_played_qd
;
545 statistics
.num_played_sum
= new_s
;
546 statistics
.num_played_qd
= q
+ s
* s
/ n
- a
* a
547 - new_s
* new_s
/ (n
- 1);
554 * Structure used during mood_open().
556 * At mood open time, we look at each file in the audio file table in order to
557 * determine whether it is admissible. If a file happens to be admissible, its
558 * mood score is computed by calling each relevant mood_score_function. Next,
559 * we update the afs_statistics and add a struct admissible_file_info to a
562 * If all files have been processed that way, the final score of each
563 * admissible file is computed by adding the dynamic score (which depends on
564 * the afs_statistics) to the mood score. Finally, all audio files in the
565 * array are added to the score table and the admissible array is freed.
567 * \sa mood_method, admissible_array.
569 struct admissible_file_info
571 /** The admissible audio file. */
572 struct osl_row
*aft_row
;
577 /** The temporary array of admissible files. */
578 struct admissible_array
{
579 /** Files are admissible wrt. this mood. */
581 /** The size of the array */
583 /** Pointer to the array of admissible files. */
584 struct admissible_file_info
*array
;
588 * Add an entry to the array of admissible files.
590 * \param aft_row The audio file to be added.
591 * \param private_data Pointer to a struct admissible_file_info.
593 * \return 1 if row admissible, 0 if not, negative on errors.
595 static int add_if_admissible(struct osl_row
*aft_row
, void *data
)
597 struct admissible_array
*aa
= data
;
601 ret
= compute_mood_score(aft_row
, aa
->m
, &score
);
604 if (statistics
.num
>= aa
->size
) {
607 aa
->array
= para_realloc(aa
->array
,
608 aa
->size
* sizeof(struct admissible_file_info
));
610 aa
->array
[statistics
.num
].aft_row
= aft_row
;
611 aa
->array
[statistics
.num
].score
= score
;
612 ret
= add_afs_statistics(aft_row
);
619 * Compute the new quadratic deviation in case one element changes.
621 * \param n Number of elements.
622 * \param old_qd The quadratic deviation before the change.
623 * \param old_val The value that was replaced.
624 * \param new_val The replacement value.
625 * \param old_sum The sum of all elements before the update.
627 * \return The new quadratic deviation resulting from replacing old_val
630 * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
631 * their quadratic deviation
633 * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
635 * and a real number b, the quadratic deviation q' of a_1,...a_{n-1}, b (ie.
636 * the last number a_n was replaced by b) may be computed in O(1) time in terms
637 * of n, q, a_n, b, and S as
639 * q' = q + d * s - (2 * S + d) * d / n,
641 * where d = b - a_n, and s = b + a_n.
643 * Example: n = 3, a_1 = 3, a_2 = 5, a_3 = 7, b = 10. Then S = 15, q = 8, d = 3,
646 * q + d * s - (2 * S + d) * d / n = 8 + 51 - 33 = 26,
648 * which equals q' = (3 - 6)^2 + (5 - 6)^2 + (10 - 6)^2.
651 _static_inline_
int64_t update_quadratic_deviation(int64_t n
, int64_t old_qd
,
652 int64_t old_val
, int64_t new_val
, int64_t old_sum
)
654 int64_t delta
= new_val
- old_val
;
655 int64_t sigma
= new_val
+ old_val
;
656 return old_qd
+ delta
* sigma
- (2 * old_sum
+ delta
) * delta
/ n
;
659 static int update_afs_statistics(struct afs_info
*old_afsi
, 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
)
682 long score
= (compute_dynamic_score(aft_row
) + mood_score
) / 3;
683 return score_add(aft_row
, score
);
686 static int delete_from_statistics_and_score_table(const struct osl_row
*aft_row
)
688 int ret
= del_afs_statistics(aft_row
);
691 return score_delete(aft_row
);
695 * Delete one entry from the statistics and from the score table.
697 * \param aft_row The audio file which is no longer admissible.
699 * \return Positive on success, negative on errors.
701 * \sa score_delete().
703 static int mood_delete_audio_file(const struct osl_row
*aft_row
)
707 ret
= row_belongs_to_score_table(aft_row
, NULL
);
710 if (!ret
) /* not admissible, nothing to do */
712 return delete_from_statistics_and_score_table(aft_row
);
716 * Compute the new score of an audio file wrt. the current mood.
718 * \param aft_row Determines the audio file.
719 * \param old_afsi The audio file selector info before updating.
721 * The \a old_afsi argument may be \p NULL which indicates that no changes to
722 * the audio file info were made.
724 * \return Positive on success, negative on errors.
726 static int mood_update_audio_file(const struct osl_row
*aft_row
,
727 struct afs_info
*old_afsi
)
730 int ret
, is_admissible
, was_admissible
= 0;
731 struct afs_info afsi
;
735 return 1; /* nothing to do */
736 ret
= row_belongs_to_score_table(aft_row
, &rank
);
739 was_admissible
= ret
;
740 ret
= compute_mood_score(aft_row
, current_mood
, &score
);
743 is_admissible
= (ret
> 0);
744 if (!was_admissible
&& !is_admissible
)
746 if (was_admissible
&& !is_admissible
)
747 return delete_from_statistics_and_score_table(aft_row
);
748 if (!was_admissible
&& is_admissible
) {
749 ret
= add_afs_statistics(aft_row
);
752 return add_to_score_table(aft_row
, score
);
755 ret
= get_afsi_of_row(aft_row
, &afsi
);
759 ret
= update_afs_statistics(old_afsi
, &afsi
);
763 score
+= compute_num_played_score(&afsi
);
764 score
+= compute_last_played_score(&afsi
);
766 PARA_DEBUG_LOG("score: %li\n", score
);
767 percent
= (score
+ 100) / 3;
770 else if (percent
< 0)
772 PARA_DEBUG_LOG("moving from rank %u to %lu%%\n", rank
, percent
);
773 return score_update(aft_row
, percent
);
776 static void log_statistics(void)
778 unsigned n
= statistics
.num
;
781 PARA_NOTICE_LOG("no admissible files\n");
784 PARA_INFO_LOG("last_played mean: %lli, last_played sigma: %llu\n",
785 (long long int)(statistics
.last_played_sum
/ n
),
786 (long long unsigned)int_sqrt(statistics
.last_played_qd
/ n
));
787 PARA_INFO_LOG("num_played mean: %lli, num_played sigma: %llu\n",
788 (long long int)statistics
.num_played_sum
/ n
,
789 (long long unsigned)int_sqrt(statistics
.num_played_qd
/ n
));
793 * Close the current mood.
795 * Free all resources of the current mood which were allocated during
798 void close_current_mood(void)
800 destroy_mood(current_mood
);
802 memset(&statistics
, 0, sizeof(statistics
));
806 * Change the current mood.
808 * \param mood_name The name of the mood to open.
810 * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
811 * and uses a scoring method based only on the \a last_played information.
813 * If there is already an open mood, it will be closed first.
815 * \return Positive on success, negative on errors. Loading the dummy mood
818 * \sa struct admissible_file_info, struct admissible_array, struct
819 * afs_info::last_played, mood_close().
821 int change_current_mood(char *mood_name
)
824 struct admissible_array aa
= {
832 struct osl_object obj
= {
834 .size
= strlen(mood_name
) + 1
836 ret
= osl(osl_get_row(moods_table
, BLOBCOL_NAME
, &obj
, &row
));
838 PARA_NOTICE_LOG("no such mood: %s\n", mood_name
);
841 ret
= load_mood(row
, &m
);
844 close_current_mood();
847 close_current_mood();
848 current_mood
= alloc_new_mood("dummy");
851 PARA_NOTICE_LOG("computing statistics of admissible files\n");
852 ret
= audio_file_loop(&aa
, add_if_admissible
);
856 PARA_INFO_LOG("%d admissible files \n", statistics
.num
);
857 for (i
= 0; i
< statistics
.num
; i
++) {
858 struct admissible_file_info
*a
= aa
.array
+ i
;
859 ret
= add_to_score_table(a
->aft_row
, a
->score
);
863 PARA_NOTICE_LOG("loaded mood %s\n", current_mood
->name
);
864 ret
= statistics
.num
;
870 * Close and re-open the current mood.
872 * This function is used if changes to the audio file table or the
873 * attribute table were made that render the current list of admissible
874 * files useless. For example, if an attribute is removed from the
875 * attribute table, this function is called.
877 * \return Positive on success, negative on errors. If no mood is currently
878 * open, the function returns success.
880 * \sa mood_open(), mood_close().
882 static int reload_current_mood(void)
885 char *mood_name
= NULL
;
889 PARA_NOTICE_LOG("reloading %s\n", current_mood
->name
?
890 current_mood
->name
: "(dummy)");
891 if (current_mood
->name
)
892 mood_name
= para_strdup(current_mood
->name
);
893 close_current_mood();
894 ret
= change_current_mood(mood_name
);
900 * Notification callback for the moods table.
902 * \param event Type of the event just occurred.
904 * \param data Its type depends on the event.
906 * This function performs actions required due to the occurrence of the given
907 * event. Possible actions include reload of the current mood and update of the
908 * score of an audio file.
910 int moods_event_handler(enum afs_events event
, __a_unused
struct para_buffer
*pb
,
919 * The three blob events might change the set of admissible files,
920 * so we must reload the score list.
925 if (data
== moods_table
|| data
== playlists_table
)
926 return 1; /* no reload necessary for these */
927 ret
= clear_score_table();
929 PARA_CRIT_LOG("clear score table returned %s\n",
930 para_strerror(-ret
));
931 return reload_current_mood();
932 /* these also require reload of the score table */
934 case ATTRIBUTE_REMOVE
:
935 case ATTRIBUTE_RENAME
:
936 return reload_current_mood();
937 /* changes to the aft only require to re-examine the audio file */
939 struct afsi_change_event_data
*aced
= data
;
940 return mood_update_audio_file(aced
->aft_row
, aced
->old_afsi
);
943 case AUDIO_FILE_RENAME
:
945 return mood_update_audio_file(data
, NULL
);
946 case AUDIO_FILE_REMOVE
:
947 return mood_delete_audio_file(data
);