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. */
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 struct afs_statistics statistics
;
42 * Assign scores according to a mood_method.
44 * Each mood_method has its own mood_score_function. The first three parameters
45 * passed to that function are informations about the audio file whose score is
46 * to be computed. The data argument depends on the mood method this function
47 * is used for. It usually is the argument given at the end of a mood line.
49 * Mood score functions must return values between -100 and +100 inclusively.
50 * Boolean score functions should always return either -100 or +100.
52 * \sa struct mood_method, mood_parser.
54 typedef int mood_score_function(const char *path
, const struct afs_info
*afsi
,
55 const struct afh_info
*afhi
, const void *data
);
58 * Pre-process a mood line.
60 * The mood_parser of a mood_method is called once at mood open time for each
61 * line of the current mood definition that contains the mood_method's name as
62 * a keyword. The line is passed to the mood_parser as the first argument. The
63 * mood_parser must determine whether the line is syntactically correct and
64 * return a positive value if so and a negative value otherwise.
66 * Some mood parsers pre-process the data given in the mood line to compute a
67 * structure which depends of the particular mood_method and which is used
68 * later in the mood_score_function of the mood_method. The mood_parser may
69 * store a pointer to its structure via the void** pointer.
71 * \sa mood_open(), mood_cleanup_function, mood_score_function.
73 typedef int mood_parser(int, char **, void **);
76 * Deallocate resources which were allocated by the mood_parser.
78 * This optional function of a mood_method is used to free any resources
79 * allocated in mood_open() by the mood_parser. The argument passed is a
80 * pointer to the mood_method specific data structure that was returned by the
85 typedef void mood_cleanup_function(void *);
88 * Used for scoring and to determine whether a file is admissible.
91 /** The name of the method. */
93 /** Pointer to the mood parser. */
95 /** Pointer to the score function */
96 mood_score_function
*score_function
;
97 /** Optional cleanup function. */
98 mood_cleanup_function
*cleanup
;
102 * Each line of the current mood corresponds to a mood_item.
105 /** The method this line is referring to. */
106 const struct mood_method
*method
;
107 /** The data structure computed by the mood parser. */
109 /** The given score value, or zero if none was given. */
111 /** Non-zero if random scoring was requested. */
113 /** Whether the "not" keyword was given in the mood line. */
115 /** The position in the list of items. */
116 struct list_head mood_item_node
;
120 * Created from the mood definition by mood_open().
122 * When a mood is opened, each line of its definition is investigated, and a
123 * corresponding mood item is produced. Each mood line starts with \p accept,
124 * \p deny, or \p score which determines the type of the mood line. For each
125 * such type a linked list is maintained whose entries are the mood items.
127 * \sa mood_item, mood_open().
130 /** The name of this mood. */
132 /** The list of mood items of type \p accept. */
133 struct list_head accept_list
;
134 /** The list of mood items of type \p deny. */
135 struct list_head deny_list
;
136 /** The list of mood items of type \p score. */
137 struct list_head score_list
;
140 static struct mood
*current_mood
;
143 * Rough approximation to sqrt.
145 * \param x Integer of which to calculate the sqrt.
147 * \return An integer res with res * res <= x.
149 static uint64_t int_sqrt(uint64_t x
)
151 uint64_t op
, res
, one
= 1;
160 if (op
>= res
+ one
) {
161 op
= op
- (res
+ one
);
167 // PARA_NOTICE_LOG("sqrt(%llu) = %llu\n", x, res);
171 #define MOOD_COMPARATORS \
173 MC(LESS_OR_EQUAL, <=) \
179 MC(GREATER_OR_EQUAL, >=) \
181 #define MC(a, b) MC_ ## a,
182 enum mood_comparator_id
{MOOD_COMPARATORS NUM_MOOD_COMPARATORS
};
184 #define MC(a, b) # b,
185 const char const *mood_comparators
[] = {MOOD_COMPARATORS
};
188 static int parse_mood_comparator(const char *word
)
192 for (i
= 0; i
< NUM_MOOD_COMPARATORS
; i
++)
193 if (!strcmp(word
, mood_comparators
[i
]))
195 return -E_MOOD_SYNTAX
;
198 static int compare_int32(int32_t a
, int32_t b
, enum mood_comparator_id id
)
205 case MC_LESS_OR_EQUAL
:
215 case MC_GREATER_OR_EQUAL
:
218 PARA_EMERG_LOG("BUG: invalid mood comparator\n");
221 return res
? 100 : -100;
224 struct mm_year_data
{
225 /** The year given at the mood line. */
227 /** Used to detect Y2K issues. */
228 int32_t current_year
;
229 /** <, <=, =, !=, >=, or >. */
230 enum mood_comparator_id id
;
233 static int mm_year_parser(int argc
, char **argv
, void **private)
235 int ret
= -E_MOOD_SYNTAX
;
236 struct mm_year_data
*mmyd
= para_malloc(sizeof(*mmyd
));
242 ret
= parse_mood_comparator(argv
[1]);
246 ret
= para_atoi32(argv
[2], &mmyd
->year
);
249 current_time
= time(NULL
);
250 gmt
= gmtime(¤t_time
);
251 /* tm_year is the number of years since 1900 */
252 mmyd
->current_year
= gmt
->tm_year
+ 1900;
260 static int mm_year_score_function(__a_unused
const char *path
,
261 __a_unused
const struct afs_info
*afsi
,
262 const struct afh_info
*afhi
,
265 const struct mm_year_data
*mmyd
= private;
267 int ret
= para_atoi32(afhi
->tags
.year
, &tag_year
);
269 if (ret
< 0) /* year tag not present or not a number */
273 /* try to work around Y2K issues */
274 if (tag_year
< 100) {
276 if (tag_year
+ 100 <= mmyd
->current_year
)
277 tag_year
+= 100; /* assume tag_year >= 2000 */
279 return compare_int32(tag_year
, mmyd
->year
, mmyd
->id
);
282 static void mm_year_cleanup(void *private)
287 static int mm_no_attributes_set_parser(int argc
, __a_unused
char **argv
,
288 __a_unused
void **ignored
)
290 return argc
? -E_MOOD_SYNTAX
: 1;
293 static int mm_no_attributes_set_score_function(__a_unused
const char *path
,
294 const struct afs_info
*afsi
,
295 __a_unused
const struct afh_info
*afhi
,
296 __a_unused
const void *data
)
298 if (!afsi
->attributes
)
303 static int mm_played_rarely_score_function(__a_unused
const char *path
,
304 const struct afs_info
*afsi
,
305 __a_unused
const struct afh_info
*afhi
,
306 __a_unused
const void *data
)
309 int ret
= get_num_admissible_files(&num
);
313 if (statistics
.num_played_sum
- num
* afsi
->num_played
314 > int_sqrt(statistics
.num_played_qd
* num
))
319 static int mm_played_rarely_parser(int argc
, __a_unused
char **argv
,
320 __a_unused
void **ignored
)
322 return argc
? -E_MOOD_SYNTAX
: 1;
325 static int mm_path_matches_score_function(const char *path
,
326 __a_unused
const struct afs_info
*afsi
,
327 __a_unused
const struct afh_info
*afhi
,
330 if (fnmatch(data
, path
, 0))
335 static int mm_path_matches_parser(int argc
, char **argv
, void **data
)
338 return -E_MOOD_SYNTAX
;
339 *data
= para_strdup(argv
[1]);
343 static void mm_path_matches_cleanup(void *data
)
348 static int mm_is_set_parser(int argc
, char **argv
, void **bitnum
)
351 unsigned char c
, *res
;
354 return -E_MOOD_SYNTAX
;
355 ret
= get_attribute_bitnum_by_name(argv
[1], &c
);
358 res
= para_malloc(1);
364 static int mm_is_set_score_function(__a_unused
const char *path
,
365 __a_unused
const struct afs_info
*afsi
,
366 __a_unused
const struct afh_info
*afhi
,
369 const unsigned char *bn
= data
;
370 if (afsi
->attributes
& (1ULL << *bn
))
375 /* returns 1 if row matches score item, negative otherwise */
376 static int add_item_score(const struct osl_row
*row
, struct mood_item
*item
, long *score
,
379 struct afs_info afsi
;
380 struct afh_info afhi
;
384 *score_arg_sum
+= item
->random_score
? 100 : PARA_ABS(item
->score_arg
);
387 ret
= get_afsi_of_row(row
, &afsi
);
390 ret
= get_afhi_of_row(row
, &afhi
);
393 ret
= get_audio_file_path_of_row(row
, &path
);
396 ret
= item
->method
->score_function(path
, &afsi
, &afhi
,
398 if ((ret
< 0 && !item
->logical_not
) || (ret
>= 0 && item
->logical_not
))
399 return -1; /* no match */
401 if (item
->random_score
)
402 *score
+= PARA_ABS(ret
) * para_random(100);
404 *score
+= PARA_ABS(ret
) * item
->score_arg
;
408 static int compute_mood_score(const struct osl_row
*aft_row
, struct mood
*m
,
411 struct mood_item
*item
;
413 long score_arg_sum
= 0, score
= 0;
417 /* reject audio file if it matches any entry in the deny list */
418 list_for_each_entry(item
, &m
->deny_list
, mood_item_node
)
419 if (add_item_score(aft_row
, item
, &score
, &score_arg_sum
) > 0)
420 return -E_NOT_ADMISSIBLE
;
421 list_for_each_entry(item
, &m
->accept_list
, mood_item_node
)
422 if (add_item_score(aft_row
, item
, &score
, &score_arg_sum
) > 0)
424 /* reject if there is no matching entry in the accept list */
425 if (!match
&& !list_empty(&m
->accept_list
))
426 return -E_NOT_ADMISSIBLE
;
427 list_for_each_entry(item
, &m
->score_list
, mood_item_node
)
428 add_item_score(aft_row
, item
, &score
, &score_arg_sum
);
430 score
/= score_arg_sum
;
435 #define DEFINE_MOOD_METHOD(_name) \
436 .parser = mm_ ## _name ## _parser, \
437 .score_function = mm_ ## _name ## _score_function, \
440 #define DEFINE_MOOD_METHOD_WITH_CLEANUP(_name) \
441 DEFINE_MOOD_METHOD(_name), \
442 .cleanup = mm_ ## _name ## _cleanup
444 static const struct mood_method mood_methods
[] = {
445 {DEFINE_MOOD_METHOD(no_attributes_set
)},
446 {DEFINE_MOOD_METHOD(played_rarely
)},
447 {DEFINE_MOOD_METHOD(is_set
)},
448 {DEFINE_MOOD_METHOD_WITH_CLEANUP(path_matches
)},
449 {DEFINE_MOOD_METHOD_WITH_CLEANUP(year
)},
453 static void cleanup_list_entry(struct mood_item
*item
)
455 if (item
->method
&& item
->method
->cleanup
)
456 item
->method
->cleanup(item
->parser_data
);
458 free(item
->parser_data
);
459 list_del(&item
->mood_item_node
);
463 static void destroy_mood(struct mood
*m
)
465 struct mood_item
*tmp
, *item
;
469 list_for_each_entry_safe(item
, tmp
, &m
->accept_list
, mood_item_node
)
470 cleanup_list_entry(item
);
471 list_for_each_entry_safe(item
, tmp
, &m
->deny_list
, mood_item_node
)
472 cleanup_list_entry(item
);
473 list_for_each_entry_safe(item
, tmp
, &m
->score_list
, mood_item_node
)
474 cleanup_list_entry(item
);
479 static struct mood
*alloc_new_mood(const char *name
)
481 struct mood
*m
= para_calloc(sizeof(struct mood
));
482 m
->name
= para_strdup(name
);
483 INIT_LIST_HEAD(&m
->accept_list
);
484 INIT_LIST_HEAD(&m
->deny_list
);
485 INIT_LIST_HEAD(&m
->score_list
);
489 /** The different types of a mood line. */
490 enum mood_line_type
{
501 /** Data passed to the parser of a mood line. */
502 struct mood_line_parser_data
{
503 /** The mood this mood line belongs to. */
505 /** The line number in the mood definition. */
510 * <accept [with score <score>] | deny [with score <score>] | score <score>>
511 * [if] [not] <mood_method> [options]
512 * <score> is either an integer or "random" which assigns a random score to
516 static int parse_mood_line(char *mood_line
, void *data
)
518 struct mood_line_parser_data
*mlpd
= data
;
523 enum mood_line_type mlt
= ML_INVALID
;
524 struct mood_item
*mi
= NULL
;
527 ret
= create_argv(mood_line
, " \t", &argv
);
531 if (!num_words
) /* empty line */
534 if (**w
== '#') /* comment */
536 if (!strcmp(*w
, "accept"))
538 else if (!strcmp(*w
, "deny"))
540 else if (!strcmp(*w
, "score"))
542 ret
= -E_MOOD_SYNTAX
;
543 if (mlt
== ML_INVALID
)
545 mi
= para_calloc(sizeof(struct mood_item
));
546 if (mlt
!= ML_SCORE
) {
547 ret
= -E_MOOD_SYNTAX
;
551 if (strcmp(*w
, "with"))
556 if (strcmp(*w
, "score"))
559 if (mlt
== ML_SCORE
|| !strcmp(*w
, "score")) {
560 ret
= -E_MOOD_SYNTAX
;
564 if (strcmp(*w
, "random")) {
565 mi
->random_score
= 0;
566 ret
= para_atoi32(*w
, &mi
->score_arg
);
570 mi
->random_score
= 1;
572 goto success
; /* the line "score random" is valid */
576 ret
= -E_MOOD_SYNTAX
;
581 if (!strcmp(*w
, "if")) {
582 ret
= -E_MOOD_SYNTAX
;
587 if (!strcmp(*w
, "not")) {
588 ret
= -E_MOOD_SYNTAX
;
595 for (i
= 0; mood_methods
[i
].parser
; i
++) {
596 if (strcmp(*w
, mood_methods
[i
].name
))
600 ret
= -E_MOOD_SYNTAX
;
601 if (!mood_methods
[i
].parser
)
603 ret
= mood_methods
[i
].parser(num_words
- 1 - (w
- argv
), w
,
607 mi
->method
= &mood_methods
[i
];
610 if (mlt
== ML_ACCEPT
)
611 para_list_add(&mi
->mood_item_node
, &mlpd
->m
->accept_list
);
612 else if (mlt
== ML_DENY
)
613 para_list_add(&mi
->mood_item_node
, &mlpd
->m
->deny_list
);
615 para_list_add(&mi
->mood_item_node
, &mlpd
->m
->score_list
);
617 PARA_DEBUG_LOG("%s entry added, method: %p\n", mlt
== ML_ACCEPT
? "accept" :
618 (mlt
== ML_DENY
? "deny" : "score"), mi
->method
);
625 free(mi
->parser_data
);
631 static int load_mood(const struct osl_row
*mood_row
, struct mood
**m
)
634 struct osl_object mood_def
;
635 struct mood_line_parser_data mlpd
= {.line_num
= 0};
636 int ret
= mood_get_name_and_def_by_row(mood_row
, &mood_name
, &mood_def
);
642 mlpd
.m
= alloc_new_mood(mood_name
);
643 ret
= for_each_line_ro(mood_def
.data
, mood_def
.size
,
644 parse_mood_line
, &mlpd
);
645 osl_close_disk_object(&mood_def
);
647 PARA_ERROR_LOG("unable to load mood %s: %s\n", mlpd
.m
->name
,
648 para_strerror(-ret
));
649 destroy_mood(mlpd
.m
);
656 static int check_mood(struct osl_row
*mood_row
, void *data
)
658 struct para_buffer
*pb
= data
;
660 struct osl_object mood_def
;
661 struct mood_line_parser_data mlpd
= {.line_num
= 0};
663 int ret
= mood_get_name_and_def_by_row(mood_row
, &mood_name
, &mood_def
);
666 para_printf(pb
, "failed to get mood definition: %s\n",
667 para_strerror(-ret
));
670 if (!*mood_name
) /* ignore dummy row */
672 ret
= para_printf(pb
, "checking mood %s...\n", mood_name
);
675 ret
= for_each_line_ro(mood_def
.data
, mood_def
.size
,
676 parse_mood_line
, &mlpd
);
678 para_printf(pb
, "%s line %u: %s\n", mood_name
, mlpd
.line_num
,
679 para_strerror(-ret
));
681 osl_close_disk_object(&mood_def
);
686 * Check all moods for syntax errors.
688 * \param fd The afs socket.
689 * \param query Unused.
691 void mood_check_callback(int fd
, __a_unused
const struct osl_object
*query
)
693 struct para_buffer pb
= {
696 .max_size_handler
= pass_buffer_as_shm
699 int ret
= para_printf(&pb
, "checking moods...\n");
702 osl_rbtree_loop(moods_table
, BLOBCOL_ID
, &pb
,
705 pass_buffer_as_shm(pb
.buf
, pb
.offset
, &fd
);
710 static unsigned int_log2(uint64_t x
)
722 static int64_t normalized_value(int64_t x
, int64_t n
, int64_t sum
, int64_t qd
)
726 return 100 * (n
* x
- sum
) / (int64_t)int_sqrt(n
* qd
);
729 static long compute_num_played_score(struct afs_info
*afsi
)
731 return -normalized_value(afsi
->num_played
, statistics
.num
,
732 statistics
.num_played_sum
, statistics
.num_played_qd
);
735 static long compute_last_played_score(struct afs_info
*afsi
)
737 return -normalized_value(afsi
->last_played
, statistics
.num
,
738 statistics
.last_played_sum
, statistics
.last_played_qd
);
741 static long compute_dynamic_score(const struct osl_row
*aft_row
)
743 struct afs_info afsi
;
744 int64_t score
, nscore
= 0, lscore
= 0;
747 ret
= get_afsi_of_row(aft_row
, &afsi
);
750 nscore
= compute_num_played_score(&afsi
);
751 lscore
= compute_last_played_score(&afsi
);
752 score
= nscore
+ lscore
;
756 static int add_afs_statistics(const struct osl_row
*row
)
759 struct afs_info afsi
;
762 ret
= get_afsi_of_row(row
, &afsi
);
766 x
= afsi
.last_played
;
767 s
= statistics
.last_played_sum
;
769 statistics
.last_played_qd
+= (x
- s
/ n
) * (x
- s
/ n
) * n
/ (n
+ 1);
770 statistics
.last_played_sum
+= x
;
773 s
= statistics
.num_played_sum
;
775 statistics
.num_played_qd
+= (x
- s
/ n
) * (x
- s
/ n
) * n
/ (n
+ 1);
776 statistics
.num_played_sum
+= x
;
781 static int del_afs_statistics(const struct osl_row
*row
)
783 uint64_t n
, s
, q
, a
, new_s
;
784 struct afs_info afsi
;
786 ret
= get_afsi_of_row(row
, &afsi
);
792 memset(&statistics
, 0, sizeof(statistics
));
796 s
= statistics
.last_played_sum
;
797 q
= statistics
.last_played_qd
;
798 a
= afsi
.last_played
;
800 statistics
.last_played_sum
= new_s
;
801 statistics
.last_played_qd
= q
+ s
* s
/ n
- a
* a
802 - new_s
* new_s
/ (n
- 1);
804 s
= statistics
.num_played_sum
;
805 q
= statistics
.num_played_qd
;
808 statistics
.num_played_sum
= new_s
;
809 statistics
.num_played_qd
= q
+ s
* s
/ n
- a
* a
810 - new_s
* new_s
/ (n
- 1);
817 * Structure used during mood_open().
819 * At mood open time, we look at each file in the audio file table in order to
820 * determine whether it is admissible. If a file happens to be admissible, its
821 * mood score is computed by calling each relevant mood_score_function. Next,
822 * we update the afs_statistics and add a struct admissible_file_info to a
825 * If all files have been processed that way, the final score of each
826 * admissible file is computed by adding the dynamic score (which depends on
827 * the afs_statistics) to the mood score. Finally, all audio files in the
828 * array are added to the score table and the admissible array is freed.
830 * \sa mood_method, admissible_array.
832 struct admissible_file_info
834 /** The admissible audio file. */
835 struct osl_row
*aft_row
;
840 /** The temporary array of admissible files. */
841 struct admissible_array
{
842 /** Files are admissible wrt. this mood. */
844 /** The size of the array */
846 /** Pointer to the array of admissible files. */
847 struct admissible_file_info
*array
;
851 * Add an entry to the array of admissible files.
853 * \param aft_row The audio file to be added.
854 * \param private_data Pointer to a struct admissible_file_info.
856 * \return Negative on errors, positive on success.
858 static int add_if_admissible(struct osl_row
*aft_row
, void *data
)
860 struct admissible_array
*aa
= data
;
864 ret
= compute_mood_score(aft_row
, aa
->m
, &score
);
866 return (ret
== -E_NOT_ADMISSIBLE
)? 1 : ret
;
867 if (statistics
.num
>= aa
->size
) {
870 aa
->array
= para_realloc(aa
->array
,
871 aa
->size
* sizeof(struct admissible_file_info
));
873 aa
->array
[statistics
.num
].aft_row
= aft_row
;
874 aa
->array
[statistics
.num
].score
= score
;
875 ret
= add_afs_statistics(aft_row
);
882 * Compute the new quadratic deviation in case one element changes.
884 * \param n Number of elements.
885 * \param old_qd The quadratic deviation before the change.
886 * \param old_val The value that was replaced.
887 * \param new_val The replacement value.
888 * \param old_sum The sum of all elements before the update.
890 * \return The new quadratic deviation resulting from replacing old_val
893 * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
894 * their quadratic deviation
896 * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
898 * and a real number b, the quadratic deviation q' of a_1,...a_{n-1}, b (ie.
899 * the last number a_n was replaced by b) may be computed in O(1) time in terms
900 * of n, q, a_n, b, and S as
902 * q' = q + d * s - (2 * S + d) * d / n,
904 * where d = b - a_n, and s = b + a_n.
906 * Example: n = 3, a_1 = 3, a_2 = 5, a_3 = 7, b = 10. Then S = 15, q = 8, d = 3,
909 * q + d * s - (2 * S + d) * d / n = 8 + 51 - 33 = 26,
911 * which equals q' = (3 - 6)^2 + (5 - 6)^2 + (10 - 6)^2.
914 _static_inline_
int64_t update_quadratic_deviation(int64_t n
, int64_t old_qd
,
915 int64_t old_val
, int64_t new_val
, int64_t old_sum
)
917 int64_t delta
= new_val
- old_val
;
918 int64_t sigma
= new_val
+ old_val
;
919 return old_qd
+ delta
* sigma
- (2 * old_sum
+ delta
) * delta
/ n
;
922 static int update_afs_statistics(struct afs_info
*old_afsi
, struct afs_info
*new_afsi
)
925 int ret
= get_num_admissible_files(&n
);
931 statistics
.last_played_qd
= update_quadratic_deviation(n
,
932 statistics
.last_played_qd
, old_afsi
->last_played
,
933 new_afsi
->last_played
, statistics
.last_played_sum
);
934 statistics
.last_played_sum
+= new_afsi
->last_played
- old_afsi
->last_played
;
936 statistics
.num_played_qd
= update_quadratic_deviation(n
,
937 statistics
.num_played_qd
, old_afsi
->num_played
,
938 new_afsi
->num_played
, statistics
.num_played_sum
);
939 statistics
.num_played_sum
+= new_afsi
->num_played
- old_afsi
->num_played
;
943 static int add_to_score_table(const struct osl_row
*aft_row
, long mood_score
)
945 long score
= (compute_dynamic_score(aft_row
) + mood_score
) / 3;
946 return score_add(aft_row
, score
);
949 static int delete_from_statistics_and_score_table(const struct osl_row
*aft_row
)
951 int ret
= del_afs_statistics(aft_row
);
954 return score_delete(aft_row
);
958 * Delete one entry from the statistics and from the score table.
960 * \param aft_row The audio file which is no longer admissible.
962 * \return Positive on success, negative on errors.
964 * \sa score_delete().
966 static int mood_delete_audio_file(const struct osl_row
*aft_row
)
970 ret
= row_belongs_to_score_table(aft_row
, NULL
);
973 if (!ret
) /* not admissible, nothing to do */
975 return delete_from_statistics_and_score_table(aft_row
);
979 * Compute the new score of an audio file wrt. the current mood.
981 * \param aft_row Determines the audio file.
982 * \param old_afsi The audio file selector info before updating.
984 * The \a old_afsi argument may be \p NULL which indicates that no changes to
985 * the audio file info were made.
987 * \return Positive on success, negative on errors.
989 static int mood_update_audio_file(const struct osl_row
*aft_row
,
990 struct afs_info
*old_afsi
)
993 int ret
, is_admissible
, was_admissible
= 0;
994 struct afs_info afsi
;
998 return 1; /* nothing to do */
999 ret
= row_belongs_to_score_table(aft_row
, &rank
);
1002 was_admissible
= ret
;
1003 ret
= compute_mood_score(aft_row
, current_mood
, &score
);
1004 is_admissible
= (ret
> 0);
1005 if (!was_admissible
&& !is_admissible
)
1007 if (was_admissible
&& !is_admissible
)
1008 return delete_from_statistics_and_score_table(aft_row
);
1009 if (!was_admissible
&& is_admissible
) {
1010 ret
= add_afs_statistics(aft_row
);
1013 return add_to_score_table(aft_row
, score
);
1016 ret
= get_afsi_of_row(aft_row
, &afsi
);
1020 ret
= update_afs_statistics(old_afsi
, &afsi
);
1024 score
+= compute_num_played_score(&afsi
);
1025 score
+= compute_last_played_score(&afsi
);
1027 PARA_DEBUG_LOG("score: %li\n", score
);
1028 percent
= (score
+ 100) / 3;
1031 else if (percent
< 0)
1033 PARA_DEBUG_LOG("moving from rank %u to %lu%%\n", rank
, percent
);
1034 return score_update(aft_row
, percent
);
1037 static void log_statistics(void)
1039 unsigned n
= statistics
.num
;
1042 PARA_NOTICE_LOG("no admissible files\n");
1045 PARA_INFO_LOG("last_played mean: %lli, last_played sigma: %llu\n",
1046 (long long int)(statistics
.last_played_sum
/ n
),
1047 (long long unsigned)int_sqrt(statistics
.last_played_qd
/ n
));
1048 PARA_INFO_LOG("num_played mean: %lli, num_played sigma: %llu\n",
1049 (long long int)statistics
.num_played_sum
/ n
,
1050 (long long unsigned)int_sqrt(statistics
.num_played_qd
/ n
));
1054 * Close the current mood.
1056 * Free all resources of the current mood which were allocated during
1059 void close_current_mood(void)
1061 destroy_mood(current_mood
);
1062 current_mood
= NULL
;
1063 memset(&statistics
, 0, sizeof(statistics
));
1068 * Change the current mood.
1070 * \param mood_name The name of the mood to open.
1072 * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
1073 * and uses a scoring method based only on the \a last_played information.
1075 * If there is already an open mood, it will be closed first.
1077 * \return Positive on success, negative on errors. Loading the dummy mood
1080 * \sa struct admissible_file_info, struct admissible_array, struct
1081 * afs_info::last_played, mood_close().
1083 int change_current_mood(char *mood_name
)
1086 struct admissible_array aa
= {
1093 struct osl_row
*row
;
1094 struct osl_object obj
= {
1096 .size
= strlen(mood_name
) + 1
1098 ret
= osl(osl_get_row(moods_table
, BLOBCOL_NAME
, &obj
, &row
));
1100 PARA_NOTICE_LOG("no such mood: %s\n", mood_name
);
1103 ret
= load_mood(row
, &m
);
1106 close_current_mood();
1109 close_current_mood();
1110 current_mood
= alloc_new_mood("dummy");
1112 aa
.m
= current_mood
;
1113 PARA_NOTICE_LOG("computing statistics of admissible files\n");
1114 ret
= audio_file_loop(&aa
, add_if_admissible
);
1118 PARA_INFO_LOG("%d admissible files \n", statistics
.num
);
1119 for (i
= 0; i
< statistics
.num
; i
++) {
1120 struct admissible_file_info
*a
= aa
.array
+ i
;
1121 ret
= add_to_score_table(a
->aft_row
, a
->score
);
1125 PARA_NOTICE_LOG("loaded mood %s\n", current_mood
->name
);
1126 ret
= statistics
.num
;
1132 * Close and re-open the current mood.
1134 * This function is used if changes to the audio file table or the
1135 * attribute table were made that render the current list of admissible
1136 * files useless. For example, if an attribute is removed from the
1137 * attribute table, this function is called.
1139 * \return Positive on success, negative on errors. If no mood is currently
1140 * open, the function returns success.
1142 * \sa mood_open(), mood_close().
1144 int reload_current_mood(void)
1147 char *mood_name
= NULL
;
1151 PARA_NOTICE_LOG("reloading %s\n", current_mood
->name
?
1152 current_mood
->name
: "(dummy)");
1153 if (current_mood
->name
)
1154 mood_name
= para_strdup(current_mood
->name
);
1155 close_current_mood();
1156 ret
= change_current_mood(mood_name
);
1161 int moods_event_handler(enum afs_events event
, __a_unused
struct para_buffer
*pb
,
1166 * The three blob events might change the set of admissible files,
1167 * so we must reload the score list.
1172 if (data
== moods_table
|| data
== playlists_table
)
1173 return 1; /* no reload necessary for these */
1174 return reload_current_mood();
1175 /* these also require reload of the score table */
1177 case ATTRIBUTE_REMOVE
:
1178 case ATTRIBUTE_RENAME
:
1179 return reload_current_mood();
1180 /* changes to the aft only require to re-examine the audio file */
1182 struct afsi_change_event_data
*aced
= data
;
1183 return mood_update_audio_file(aced
->aft_row
, aced
->old_afsi
);
1186 case AUDIO_FILE_RENAME
:
1187 case AUDIO_FILE_ADD
:
1188 return mood_update_audio_file(data
, NULL
);
1189 case AUDIO_FILE_REMOVE
:
1190 return mood_delete_audio_file(data
);