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. */
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 static 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 __a_const
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. */
111 static int get_item_score(struct mood_item
*item
, const struct afs_info
*afsi
,
112 const struct afh_info
*afhi
, const char *path
, long *score
,
117 *score_arg_sum
+= item
->random_score
? 100 : PARA_ABS(item
->score_arg
);
120 ret
= item
->method
->score_function(path
, afsi
, afhi
,
122 if ((ret
< 0 && !item
->logical_not
) || (ret
>= 0 && item
->logical_not
))
123 match
= 0; /* no match */
125 if (item
->random_score
)
126 *score
= PARA_ABS(ret
) * para_random(100);
128 *score
= PARA_ABS(ret
) * item
->score_arg
;
132 /* returns 1 if row admissible, 0 if not, negative on errors */
133 static int compute_mood_score(const struct osl_row
*aft_row
, struct mood
*m
,
136 struct mood_item
*item
;
138 long score_arg_sum
= 0, score
= 0, item_score
;
139 struct afs_info afsi
;
140 struct afh_info afhi
;
145 ret
= get_afsi_of_row(aft_row
, &afsi
);
148 ret
= get_afhi_of_row(aft_row
, &afhi
);
151 ret
= get_audio_file_path_of_row(aft_row
, &path
);
154 /* reject audio file if it matches any entry in the deny list */
155 list_for_each_entry(item
, &m
->deny_list
, mood_item_node
) {
156 ret
= get_item_score(item
, &afsi
, &afhi
, path
, &item_score
,
158 if (ret
> 0) /* not admissible */
162 list_for_each_entry(item
, &m
->accept_list
, mood_item_node
) {
163 ret
= get_item_score(item
, &afsi
, &afhi
, path
, &item_score
,
170 /* reject if there is no matching entry in the accept list */
171 if (!match
&& !list_empty(&m
->accept_list
))
173 list_for_each_entry(item
, &m
->score_list
, mood_item_node
) {
174 ret
= get_item_score(item
, &afsi
, &afhi
, path
, &item_score
,
179 score
/= score_arg_sum
;
184 static void cleanup_list_entry(struct mood_item
*item
)
186 if (item
->method
&& item
->method
->cleanup
)
187 item
->method
->cleanup(item
->parser_data
);
189 free(item
->parser_data
);
190 list_del(&item
->mood_item_node
);
194 static void destroy_mood(struct mood
*m
)
196 struct mood_item
*tmp
, *item
;
200 list_for_each_entry_safe(item
, tmp
, &m
->accept_list
, mood_item_node
)
201 cleanup_list_entry(item
);
202 list_for_each_entry_safe(item
, tmp
, &m
->deny_list
, mood_item_node
)
203 cleanup_list_entry(item
);
204 list_for_each_entry_safe(item
, tmp
, &m
->score_list
, mood_item_node
)
205 cleanup_list_entry(item
);
210 static struct mood
*alloc_new_mood(const char *name
)
212 struct mood
*m
= para_calloc(sizeof(struct mood
));
213 m
->name
= para_strdup(name
);
214 INIT_LIST_HEAD(&m
->accept_list
);
215 INIT_LIST_HEAD(&m
->deny_list
);
216 INIT_LIST_HEAD(&m
->score_list
);
220 /** The different types of a mood line. */
221 enum mood_line_type
{
232 /** Data passed to the parser of a mood line. */
233 struct mood_line_parser_data
{
234 /** The mood this mood line belongs to. */
236 /** The line number in the mood definition. */
241 * <accept [with score <score>] | deny [with score <score>] | score <score>>
242 * [if] [not] <mood_method> [options]
243 * <score> is either an integer or "random" which assigns a random score to
247 static int parse_mood_line(char *mood_line
, void *data
)
249 struct mood_line_parser_data
*mlpd
= data
;
254 enum mood_line_type mlt
= ML_INVALID
;
255 struct mood_item
*mi
= NULL
;
258 ret
= create_argv(mood_line
, " \t", &argv
);
262 if (!num_words
) /* empty line */
265 if (**w
== '#') /* comment */
267 if (!strcmp(*w
, "accept"))
269 else if (!strcmp(*w
, "deny"))
271 else if (!strcmp(*w
, "score"))
273 ret
= -E_MOOD_SYNTAX
;
274 if (mlt
== ML_INVALID
)
276 mi
= para_calloc(sizeof(struct mood_item
));
277 if (mlt
!= ML_SCORE
) {
278 ret
= -E_MOOD_SYNTAX
;
282 if (strcmp(*w
, "with"))
287 if (strcmp(*w
, "score"))
290 if (mlt
== ML_SCORE
|| !strcmp(*w
, "score")) {
291 ret
= -E_MOOD_SYNTAX
;
295 if (strcmp(*w
, "random")) {
296 mi
->random_score
= 0;
297 ret
= para_atoi32(*w
, &mi
->score_arg
);
301 mi
->random_score
= 1;
303 goto success
; /* the line "score random" is valid */
307 ret
= -E_MOOD_SYNTAX
;
312 if (!strcmp(*w
, "if")) {
313 ret
= -E_MOOD_SYNTAX
;
318 if (!strcmp(*w
, "not")) {
319 ret
= -E_MOOD_SYNTAX
;
326 for (i
= 0; mood_methods
[i
].parser
; i
++) {
327 if (strcmp(*w
, mood_methods
[i
].name
))
331 ret
= -E_MOOD_SYNTAX
;
332 if (!mood_methods
[i
].parser
)
334 ret
= mood_methods
[i
].parser(num_words
- 1 - (w
- argv
), w
,
338 mi
->method
= &mood_methods
[i
];
341 if (mlt
== ML_ACCEPT
)
342 para_list_add(&mi
->mood_item_node
, &mlpd
->m
->accept_list
);
343 else if (mlt
== ML_DENY
)
344 para_list_add(&mi
->mood_item_node
, &mlpd
->m
->deny_list
);
346 para_list_add(&mi
->mood_item_node
, &mlpd
->m
->score_list
);
348 PARA_DEBUG_LOG("%s entry added, method: %p\n", mlt
== ML_ACCEPT
? "accept" :
349 (mlt
== ML_DENY
? "deny" : "score"), mi
->method
);
356 free(mi
->parser_data
);
362 static int load_mood(const struct osl_row
*mood_row
, struct mood
**m
)
365 struct osl_object mood_def
;
366 struct mood_line_parser_data mlpd
= {.line_num
= 0};
370 ret
= mood_get_name_and_def_by_row(mood_row
, &mood_name
, &mood_def
);
375 mlpd
.m
= alloc_new_mood(mood_name
);
376 ret
= for_each_line_ro(mood_def
.data
, mood_def
.size
,
377 parse_mood_line
, &mlpd
);
378 osl_close_disk_object(&mood_def
);
380 PARA_ERROR_LOG("unable to load mood %s: %s\n", mlpd
.m
->name
,
381 para_strerror(-ret
));
382 destroy_mood(mlpd
.m
);
389 static int check_mood(struct osl_row
*mood_row
, void *data
)
391 struct para_buffer
*pb
= data
;
393 struct osl_object mood_def
;
394 struct mood_line_parser_data mlpd
= {.line_num
= 0};
396 int ret
= mood_get_name_and_def_by_row(mood_row
, &mood_name
, &mood_def
);
399 para_printf(pb
, "failed to get mood definition: %s\n",
400 para_strerror(-ret
));
403 if (!*mood_name
) /* ignore dummy row */
405 ret
= para_printf(pb
, "checking mood %s...\n", mood_name
);
408 ret
= for_each_line_ro(mood_def
.data
, mood_def
.size
,
409 parse_mood_line
, &mlpd
);
411 para_printf(pb
, "%s line %u: %s\n", mood_name
, mlpd
.line_num
,
412 para_strerror(-ret
));
414 osl_close_disk_object(&mood_def
);
419 * Check all moods for syntax errors.
421 * \param fd The afs socket.
422 * \param query Unused.
424 void mood_check_callback(int fd
, __a_unused
const struct osl_object
*query
)
426 struct para_buffer pb
= {
427 .max_size
= shm_get_shmmax(),
429 .max_size_handler
= pass_buffer_as_shm
432 int ret
= para_printf(&pb
, "checking moods...\n");
435 osl_rbtree_loop(moods_table
, BLOBCOL_ID
, &pb
,
438 pass_buffer_as_shm(pb
.buf
, pb
.offset
, &fd
);
443 static unsigned int_log2(uint64_t x
)
455 static int64_t normalized_value(int64_t x
, int64_t n
, int64_t sum
, int64_t qd
)
459 return 100 * (n
* x
- sum
) / (int64_t)int_sqrt(n
* qd
);
462 static long compute_num_played_score(struct afs_info
*afsi
)
464 return -normalized_value(afsi
->num_played
, statistics
.num
,
465 statistics
.num_played_sum
, statistics
.num_played_qd
);
468 static long compute_last_played_score(struct afs_info
*afsi
)
470 return -normalized_value(afsi
->last_played
, statistics
.num
,
471 statistics
.last_played_sum
, statistics
.last_played_qd
);
474 static long compute_dynamic_score(const struct osl_row
*aft_row
)
476 struct afs_info afsi
;
477 int64_t score
, nscore
= 0, lscore
= 0;
480 ret
= get_afsi_of_row(aft_row
, &afsi
);
483 nscore
= compute_num_played_score(&afsi
);
484 lscore
= compute_last_played_score(&afsi
);
485 score
= nscore
+ lscore
;
489 static int add_afs_statistics(const struct osl_row
*row
)
492 struct afs_info afsi
;
495 ret
= get_afsi_of_row(row
, &afsi
);
499 x
= afsi
.last_played
;
500 s
= statistics
.last_played_sum
;
502 statistics
.last_played_qd
+= (x
- s
/ n
) * (x
- s
/ n
) * n
/ (n
+ 1);
503 statistics
.last_played_sum
+= x
;
506 s
= statistics
.num_played_sum
;
508 statistics
.num_played_qd
+= (x
- s
/ n
) * (x
- s
/ n
) * n
/ (n
+ 1);
509 statistics
.num_played_sum
+= x
;
514 static int del_afs_statistics(const struct osl_row
*row
)
516 uint64_t n
, s
, q
, a
, new_s
;
517 struct afs_info afsi
;
519 ret
= get_afsi_of_row(row
, &afsi
);
525 memset(&statistics
, 0, sizeof(statistics
));
529 s
= statistics
.last_played_sum
;
530 q
= statistics
.last_played_qd
;
531 a
= afsi
.last_played
;
533 statistics
.last_played_sum
= new_s
;
534 statistics
.last_played_qd
= q
+ s
* s
/ n
- a
* a
535 - new_s
* new_s
/ (n
- 1);
537 s
= statistics
.num_played_sum
;
538 q
= statistics
.num_played_qd
;
541 statistics
.num_played_sum
= new_s
;
542 statistics
.num_played_qd
= q
+ s
* s
/ n
- a
* a
543 - new_s
* new_s
/ (n
- 1);
550 * Structure used during mood_open().
552 * At mood open time, we look at each file in the audio file table in order to
553 * determine whether it is admissible. If a file happens to be admissible, its
554 * mood score is computed by calling each relevant mood_score_function. Next,
555 * we update the afs_statistics and add a struct admissible_file_info to a
558 * If all files have been processed that way, the final score of each
559 * admissible file is computed by adding the dynamic score (which depends on
560 * the afs_statistics) to the mood score. Finally, all audio files in the
561 * array are added to the score table and the admissible array is freed.
563 * \sa mood_method, admissible_array.
565 struct admissible_file_info
567 /** The admissible audio file. */
568 struct osl_row
*aft_row
;
573 /** The temporary array of admissible files. */
574 struct admissible_array
{
575 /** Files are admissible wrt. this mood. */
577 /** The size of the array */
579 /** Pointer to the array of admissible files. */
580 struct admissible_file_info
*array
;
584 * Add an entry to the array of admissible files.
586 * \param aft_row The audio file to be added.
587 * \param private_data Pointer to a struct admissible_file_info.
589 * \return 1 if row admissible, 0 if not, negative on errors.
591 static int add_if_admissible(struct osl_row
*aft_row
, void *data
)
593 struct admissible_array
*aa
= data
;
597 ret
= compute_mood_score(aft_row
, aa
->m
, &score
);
600 if (statistics
.num
>= aa
->size
) {
603 aa
->array
= para_realloc(aa
->array
,
604 aa
->size
* sizeof(struct admissible_file_info
));
606 aa
->array
[statistics
.num
].aft_row
= aft_row
;
607 aa
->array
[statistics
.num
].score
= score
;
608 ret
= add_afs_statistics(aft_row
);
615 * Compute the new quadratic deviation in case one element changes.
617 * \param n Number of elements.
618 * \param old_qd The quadratic deviation before the change.
619 * \param old_val The value that was replaced.
620 * \param new_val The replacement value.
621 * \param old_sum The sum of all elements before the update.
623 * \return The new quadratic deviation resulting from replacing old_val
626 * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
627 * their quadratic deviation
629 * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
631 * and a real number b, the quadratic deviation q' of a_1,...a_{n-1}, b (ie.
632 * the last number a_n was replaced by b) may be computed in O(1) time in terms
633 * of n, q, a_n, b, and S as
635 * q' = q + d * s - (2 * S + d) * d / n,
637 * where d = b - a_n, and s = b + a_n.
639 * Example: n = 3, a_1 = 3, a_2 = 5, a_3 = 7, b = 10. Then S = 15, q = 8, d = 3,
642 * q + d * s - (2 * S + d) * d / n = 8 + 51 - 33 = 26,
644 * which equals q' = (3 - 6)^2 + (5 - 6)^2 + (10 - 6)^2.
647 _static_inline_
int64_t update_quadratic_deviation(int64_t n
, int64_t old_qd
,
648 int64_t old_val
, int64_t new_val
, int64_t old_sum
)
650 int64_t delta
= new_val
- old_val
;
651 int64_t sigma
= new_val
+ old_val
;
652 return old_qd
+ delta
* sigma
- (2 * old_sum
+ delta
) * delta
/ n
;
655 static int update_afs_statistics(struct afs_info
*old_afsi
, struct afs_info
*new_afsi
)
658 int ret
= get_num_admissible_files(&n
);
664 statistics
.last_played_qd
= update_quadratic_deviation(n
,
665 statistics
.last_played_qd
, old_afsi
->last_played
,
666 new_afsi
->last_played
, statistics
.last_played_sum
);
667 statistics
.last_played_sum
+= new_afsi
->last_played
- old_afsi
->last_played
;
669 statistics
.num_played_qd
= update_quadratic_deviation(n
,
670 statistics
.num_played_qd
, old_afsi
->num_played
,
671 new_afsi
->num_played
, statistics
.num_played_sum
);
672 statistics
.num_played_sum
+= new_afsi
->num_played
- old_afsi
->num_played
;
676 static int add_to_score_table(const struct osl_row
*aft_row
, long mood_score
)
678 long score
= (compute_dynamic_score(aft_row
) + mood_score
) / 3;
679 return score_add(aft_row
, score
);
682 static int delete_from_statistics_and_score_table(const struct osl_row
*aft_row
)
684 int ret
= del_afs_statistics(aft_row
);
687 return score_delete(aft_row
);
691 * Delete one entry from the statistics and from the score table.
693 * \param aft_row The audio file which is no longer admissible.
695 * \return Positive on success, negative on errors.
697 * \sa score_delete().
699 static int mood_delete_audio_file(const struct osl_row
*aft_row
)
703 ret
= row_belongs_to_score_table(aft_row
, NULL
);
706 if (!ret
) /* not admissible, nothing to do */
708 return delete_from_statistics_and_score_table(aft_row
);
712 * Compute the new score of an audio file wrt. the current mood.
714 * \param aft_row Determines the audio file.
715 * \param old_afsi The audio file selector info before updating.
717 * The \a old_afsi argument may be \p NULL which indicates that no changes to
718 * the audio file info were made.
720 * \return Positive on success, negative on errors.
722 static int mood_update_audio_file(const struct osl_row
*aft_row
,
723 struct afs_info
*old_afsi
)
726 int ret
, is_admissible
, was_admissible
= 0;
727 struct afs_info afsi
;
731 return 1; /* nothing to do */
732 ret
= row_belongs_to_score_table(aft_row
, &rank
);
735 was_admissible
= ret
;
736 ret
= compute_mood_score(aft_row
, current_mood
, &score
);
739 is_admissible
= (ret
> 0);
740 if (!was_admissible
&& !is_admissible
)
742 if (was_admissible
&& !is_admissible
)
743 return delete_from_statistics_and_score_table(aft_row
);
744 if (!was_admissible
&& is_admissible
) {
745 ret
= add_afs_statistics(aft_row
);
748 return add_to_score_table(aft_row
, score
);
751 ret
= get_afsi_of_row(aft_row
, &afsi
);
755 ret
= update_afs_statistics(old_afsi
, &afsi
);
759 score
+= compute_num_played_score(&afsi
);
760 score
+= compute_last_played_score(&afsi
);
762 PARA_DEBUG_LOG("score: %li\n", score
);
763 percent
= (score
+ 100) / 3;
766 else if (percent
< 0)
768 PARA_DEBUG_LOG("moving from rank %u to %lu%%\n", rank
, percent
);
769 return score_update(aft_row
, percent
);
772 static void log_statistics(void)
774 unsigned n
= statistics
.num
;
777 PARA_NOTICE_LOG("no admissible files\n");
780 PARA_INFO_LOG("last_played mean: %lli, last_played sigma: %llu\n",
781 (long long int)(statistics
.last_played_sum
/ n
),
782 (long long unsigned)int_sqrt(statistics
.last_played_qd
/ n
));
783 PARA_INFO_LOG("num_played mean: %lli, num_played sigma: %llu\n",
784 (long long int)statistics
.num_played_sum
/ n
,
785 (long long unsigned)int_sqrt(statistics
.num_played_qd
/ n
));
789 * Close the current mood.
791 * Free all resources of the current mood which were allocated during
794 void close_current_mood(void)
796 destroy_mood(current_mood
);
798 memset(&statistics
, 0, sizeof(statistics
));
802 * Change the current mood.
804 * \param mood_name The name of the mood to open.
806 * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
807 * and uses a scoring method based only on the \a last_played information.
809 * If there is already an open mood, it will be closed first.
811 * \return Positive on success, negative on errors. Loading the dummy mood
814 * \sa struct admissible_file_info, struct admissible_array, struct
815 * afs_info::last_played, mood_close().
817 int change_current_mood(char *mood_name
)
820 struct admissible_array aa
= {
828 struct osl_object obj
= {
830 .size
= strlen(mood_name
) + 1
832 ret
= osl(osl_get_row(moods_table
, BLOBCOL_NAME
, &obj
, &row
));
834 PARA_NOTICE_LOG("no such mood: %s\n", mood_name
);
837 ret
= load_mood(row
, &m
);
840 close_current_mood();
843 close_current_mood();
844 current_mood
= alloc_new_mood("dummy");
847 PARA_NOTICE_LOG("computing statistics of admissible files\n");
848 ret
= audio_file_loop(&aa
, add_if_admissible
);
852 PARA_INFO_LOG("%d admissible files \n", statistics
.num
);
853 for (i
= 0; i
< statistics
.num
; i
++) {
854 struct admissible_file_info
*a
= aa
.array
+ i
;
855 ret
= add_to_score_table(a
->aft_row
, a
->score
);
859 PARA_NOTICE_LOG("loaded mood %s\n", current_mood
->name
);
860 ret
= statistics
.num
;
866 * Close and re-open the current mood.
868 * This function is used if changes to the audio file table or the
869 * attribute table were made that render the current list of admissible
870 * files useless. For example, if an attribute is removed from the
871 * attribute table, this function is called.
873 * \return Positive on success, negative on errors. If no mood is currently
874 * open, the function returns success.
876 * \sa mood_open(), mood_close().
878 static int reload_current_mood(void)
881 char *mood_name
= NULL
;
885 PARA_NOTICE_LOG("reloading %s\n", current_mood
->name
?
886 current_mood
->name
: "(dummy)");
887 if (current_mood
->name
)
888 mood_name
= para_strdup(current_mood
->name
);
889 close_current_mood();
890 ret
= change_current_mood(mood_name
);
896 * Notification callback for the moods table.
898 * \param event Type of the event just occurred.
900 * \param data Its type depends on the event.
902 * This function performs actions required due to the occurrence of the given
903 * event. Possible actions include reload of the current mood and update of the
904 * score of an audio file.
906 int moods_event_handler(enum afs_events event
, __a_unused
struct para_buffer
*pb
,
915 * The three blob events might change the set of admissible files,
916 * so we must reload the score list.
921 if (data
== moods_table
|| data
== playlists_table
)
922 return 1; /* no reload necessary for these */
923 ret
= clear_score_table();
925 PARA_CRIT_LOG("clear score table returned %s\n",
926 para_strerror(-ret
));
927 return reload_current_mood();
928 /* these also require reload of the score table */
930 case ATTRIBUTE_REMOVE
:
931 case ATTRIBUTE_RENAME
:
932 return reload_current_mood();
933 /* changes to the aft only require to re-examine the audio file */
935 struct afsi_change_event_data
*aced
= data
;
936 return mood_update_audio_file(aced
->aft_row
, aced
->old_afsi
);
939 case AUDIO_FILE_RENAME
:
941 return mood_update_audio_file(data
, NULL
);
942 case AUDIO_FILE_REMOVE
:
943 return mood_delete_audio_file(data
);