mood.c: Remove debug log message.
[paraslash.git] / mood.c
1 /*
2 * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file mood.c Paraslash's mood handling functions. */
8
9 #include <fnmatch.h>
10 #include "para.h"
11 #include "error.h"
12 #include "afh.h"
13 #include "afs.h"
14 #include "list.h"
15 #include "string.h"
16
17 /**
18 * Contains statistical data of the currently admissible audio files.
19 *
20 * It is used to assign normalized score values to each admissible audio file.
21 */
22 struct afs_statistics {
23 /** Sum of num played over all admissible files. */
24 int64_t num_played_sum;
25 /** Sum of last played times over all admissible files. */
26 int64_t last_played_sum;
27 /** Quadratic deviation of num played time. */
28 int64_t num_played_qd;
29 /** Quadratic deviation of last played time. */
30 int64_t last_played_qd;
31 /** Number of admissible files */
32 unsigned num;
33 };
34 struct afs_statistics statistics;
35
36 /**
37 * Assign scores according to a mood_method.
38 *
39 * Each mood_method has its own mood_score_function. The first parameter passed
40 * to that function is a pointer to a row of the audio file table. It
41 * determines the audio file for which a score is to be assigned. The second
42 * argument depends on the mood method this function is used for. It usually is
43 * the argument given at the end of a mood line.
44 *
45 * Mood score functions must return values between -100 and +100 inclusively.
46 * Boolean score functions should always return either -100 or +100.
47 *
48 * \sa struct mood_method, mood_parser.
49 */
50 typedef int mood_score_function(const char *path, const struct afs_info *afsi,
51 const struct audio_format_info *afhi, const void *data);
52
53 /**
54 * Pre-process a mood line.
55 *
56 * The mood_parser of a mood_method is called once at mood open time for each
57 * line of the current mood definition that contains the mood_method's name as
58 * a keyword. The line is passed to the mood_parser as the first argument. The
59 * mood_parser must determine whether the line is syntactically correct and
60 * return a positive value if so and a negative value otherwise.
61 *
62 * Some mood parsers pre-process the data given in the mood line to compute a
63 * structure which depends of the particular mood_method and which is used
64 * later in the mood_score_function of the mood_method. The mood_parser may
65 * store a pointer to its structure via the second argument.
66 *
67 * \sa mood_open(), mood_cleanup_function, mood_score_function.
68 */
69 typedef int mood_parser(const char *, void **);
70
71 /**
72 * Deallocate resources which were allocated by the mood_parser.
73 *
74 * This optional function of a mood_method is used to free any resources
75 * allocated in mood_open() by the mood_parser. The argument passed is a
76 * pointer to the mood_method specific data structure that was returned by the
77 * mood_parser.
78 *
79 * \sa mood_parser.
80 */
81 typedef void mood_cleanup_function(void *);
82
83 /**
84 * Used for scoring and to determine whether a file is admissible.
85 */
86 struct mood_method {
87 /* The name of the method. */
88 const char *name;
89 /** Pointer to the mood parser. */
90 mood_parser *parser;
91 /** Pointer to the score function */
92 mood_score_function *score_function;
93 /** Optional cleanup function. */
94 mood_cleanup_function *cleanup;
95 };
96
97 /**
98 * Each line of the current mood corresponds to a mood_item.
99 */
100 struct mood_item {
101 /** The method this line is referring to. */
102 const struct mood_method *method;
103 /** The data structure computed by the mood parser. */
104 void *parser_data;
105 /** The given score value, or zero if none was given. */
106 int32_t score_arg;
107 /** Non-zero if random scoring was requested. */
108 int random_score;
109 /** Whether the "not" keyword was given in the mood line. */
110 int logical_not;
111 /** The position in the list of items. */
112 struct list_head mood_item_node;
113 };
114
115 /**
116 * Created from the mood definition by mood_open().
117 *
118 * When a mood is opened, each line of its definition is investigated, and a
119 * corresponding mood item is produced. Each mood line starts with \p accept,
120 * \p deny, or \p score which determines the type of the mood line. For each
121 * such type a linked list is maintained whose entries are the mood items.
122 *
123 * \sa mood_item, mood_open().
124 */
125 struct mood {
126 /** The name of this mood. */
127 char *name;
128 /** The list of mood items of type \p accept. */
129 struct list_head accept_list;
130 /** The list of mood items of type \p deny. */
131 struct list_head deny_list;
132 /** The list of mood items of type \p score. */
133 struct list_head score_list;
134 };
135
136 static struct mood *current_mood;
137
138 /**
139 * Rough approximation to sqrt.
140 *
141 * \param x Integer of which to calculate the sqrt.
142 *
143 * \return An integer res with res * res <= x.
144 */
145 static uint64_t int_sqrt(uint64_t x)
146 {
147 uint64_t op, res, one = 1;
148 op = x;
149 res = 0;
150
151 one = one << 62;
152 while (one > op)
153 one >>= 2;
154
155 while (one != 0) {
156 if (op >= res + one) {
157 op = op - (res + one);
158 res = res + 2 * one;
159 }
160 res /= 2;
161 one /= 4;
162 }
163 // PARA_NOTICE_LOG("sqrt(%llu) = %llu\n", x, res);
164 return res;
165 }
166
167 static int mm_no_attributes_set_parser(const char *arg, __a_unused void **ignored)
168 {
169 if (arg && *arg)
170 PARA_WARNING_LOG("ignored junk at eol: %s\n", arg);
171 return 1;
172 }
173
174 static int mm_no_attributes_set_score_function(__a_unused const char *path,
175 const struct afs_info *afsi,
176 __a_unused const struct audio_format_info *afhi,
177 __a_unused const void *data)
178 {
179 if (!afsi->attributes)
180 return 100;
181 return -100;
182 }
183
184 static int mm_played_rarely_score_function(__a_unused const char *path,
185 const struct afs_info *afsi,
186 __a_unused const struct audio_format_info *afhi,
187 __a_unused const void *data)
188 {
189 unsigned num;
190 int ret = get_num_admissible_files(&num);
191
192 if (ret < 0)
193 return 0;
194 if (statistics.num_played_sum - num * afsi->num_played
195 > int_sqrt(statistics.num_played_qd * num))
196 return 100;
197 return -100;
198 }
199
200 static int mm_played_rarely_parser(const char *arg, __a_unused void **ignored)
201 {
202 if (arg && *arg)
203 PARA_WARNING_LOG("ignored junk at eol: %s\n", arg);
204 return 1;
205 }
206
207 static int mm_name_like_score_function(const char *path,
208 __a_unused const struct afs_info *afsi,
209 __a_unused const struct audio_format_info *afhi,
210 const void *data)
211 {
212 if (fnmatch(data, path, 0))
213 return -100;
214 return 100;
215 }
216
217 static int mm_name_like_parser(const char *arg, void **data)
218 {
219 *data = para_strdup(arg);
220 return 1;
221 }
222
223 static void mm_name_like_cleanup(void *data)
224 {
225 free(data);
226 }
227
228 static int mm_is_set_parser(const char *arg, void **bitnum)
229 {
230 unsigned char *c = para_malloc(1);
231 int ret = get_attribute_bitnum_by_name(arg, c);
232
233 if (ret >= 0)
234 *bitnum = c;
235 else
236 free(c);
237 return ret;
238 }
239
240 static int mm_is_set_score_function(__a_unused const char *path,
241 __a_unused const struct afs_info *afsi,
242 __a_unused const struct audio_format_info *afhi,
243 const void *data)
244 {
245 const unsigned char *bn = data;
246 if (afsi->attributes & (1ULL << *bn))
247 return 100;
248 return -100;
249 }
250
251 /* returns 1 if row matches score item, negative otherwise */
252 static int add_item_score(const struct osl_row *row, struct mood_item *item, long *score,
253 long *score_arg_sum)
254 {
255 struct afs_info afsi;
256 struct audio_format_info afhi;
257 char *path;
258 int ret;
259
260 *score_arg_sum += item->random_score? 100 : PARA_ABS(item->score_arg);
261 ret = 100;
262 if (item->method) {
263 ret = get_afsi_of_row(row, &afsi);
264 if (ret< 0)
265 return ret;
266 ret = get_afhi_of_row(row, &afhi);
267 if (ret< 0)
268 return ret;
269 ret = get_audio_file_path_of_row(row, &path);
270 if (ret< 0)
271 return ret;
272 ret = item->method->score_function(path, &afsi, &afhi,
273 item->parser_data);
274 if ((ret < 0 && !item->logical_not) || (ret >= 0 && item->logical_not))
275 return -1; /* no match */
276 }
277 if (item->random_score)
278 *score += PARA_ABS(ret) * para_random(100);
279 else
280 *score += PARA_ABS(ret) * item->score_arg;
281 return 1;
282 }
283
284 static int compute_mood_score(const struct osl_row *aft_row, struct mood *m,
285 long *result)
286 {
287 struct mood_item *item;
288 int match = 0;
289 long score_arg_sum = 0, score = 0;
290
291 if (!m)
292 return -E_NO_MOOD;
293 /* reject audio file if it matches any entry in the deny list */
294 list_for_each_entry(item, &m->deny_list, mood_item_node)
295 if (add_item_score(aft_row, item, &score, &score_arg_sum) > 0)
296 return -E_NOT_ADMISSIBLE;
297 list_for_each_entry(item, &m->accept_list, mood_item_node)
298 if (add_item_score(aft_row, item, &score, &score_arg_sum) > 0)
299 match = 1;
300 /* reject if there is no matching entry in the accept list */
301 if (!match && !list_empty(&m->accept_list))
302 return -E_NOT_ADMISSIBLE;
303 list_for_each_entry(item, &m->score_list, mood_item_node)
304 add_item_score(aft_row, item, &score, &score_arg_sum);
305 if (score_arg_sum)
306 score /= score_arg_sum;
307 *result = score;
308 return 1;
309 }
310
311 #define DEFINE_MOOD_METHOD(_name) \
312 .parser = mm_ ## _name ## _parser, \
313 .score_function = mm_ ## _name ## _score_function, \
314 .name = #_name
315
316 #define DEFINE_MOOD_METHOD_WITH_CLEANUP(_name) \
317 DEFINE_MOOD_METHOD(_name), \
318 .cleanup = mm_ ## _name ## _cleanup
319
320 static const struct mood_method mood_methods[] = {
321 {DEFINE_MOOD_METHOD(no_attributes_set)},
322 {DEFINE_MOOD_METHOD(played_rarely)},
323 {DEFINE_MOOD_METHOD(is_set)},
324 {DEFINE_MOOD_METHOD_WITH_CLEANUP(name_like)},
325 {.parser = NULL}
326 };
327
328 static void cleanup_list_entry(struct mood_item *item)
329 {
330 if (item->method && item->method->cleanup)
331 item->method->cleanup(item->parser_data);
332 else
333 free(item->parser_data);
334 list_del(&item->mood_item_node);
335 free(item);
336 }
337
338 static void destroy_mood(struct mood *m)
339 {
340 struct mood_item *tmp, *item;
341
342 if (!m)
343 return;
344 list_for_each_entry_safe(item, tmp, &m->accept_list, mood_item_node)
345 cleanup_list_entry(item);
346 list_for_each_entry_safe(item, tmp, &m->deny_list, mood_item_node)
347 cleanup_list_entry(item);
348 list_for_each_entry_safe(item, tmp, &m->score_list, mood_item_node)
349 cleanup_list_entry(item);
350 free(m->name);
351 free(m);
352 }
353
354 static struct mood *alloc_new_mood(const char *name)
355 {
356 struct mood *m = para_calloc(sizeof(struct mood));
357 m->name = para_strdup(name);
358 INIT_LIST_HEAD(&m->accept_list);
359 INIT_LIST_HEAD(&m->deny_list);
360 INIT_LIST_HEAD(&m->score_list);
361 return m;
362 }
363
364 /** The different types of a mood line. */
365 enum mood_line_type {
366 /** Invalid. */
367 ML_INVALID,
368 /** Accept line. */
369 ML_ACCEPT,
370 /** Deny line. */
371 ML_DENY,
372 /** Score line. */
373 ML_SCORE
374 };
375
376 struct mood_line_parser_data {
377 struct mood *m;
378 unsigned line_num;
379 };
380
381 /*
382 * <accept [with score <score>] | deny [with score <score>] | score <score>>
383 * [if] [not] <mood_method> [options]
384 * <score> is either an integer or "random" which assigns a random score to
385 * all matching files
386 */
387
388 static int parse_mood_line(char *mood_line, void *data)
389 {
390 struct mood_line_parser_data *mlpd = data;
391 char **argv;
392 char *delim = " \t";
393 unsigned num_words;
394 char **w;
395 int i, ret;
396 enum mood_line_type mlt = ML_INVALID;
397 struct mood_item *mi = NULL;
398 char *buf = para_strdup(mood_line);
399
400 mlpd->line_num++;
401 num_words = split_args(buf, &argv, delim);
402 ret = 1;
403 if (!num_words) /* empty line */
404 goto out;
405 w = argv;
406 if (**w == '#') /* comment */
407 goto out;
408 if (!strcmp(*w, "accept"))
409 mlt = ML_ACCEPT;
410 else if (!strcmp(*w, "deny"))
411 mlt = ML_DENY;
412 else if (!strcmp(*w, "score"))
413 mlt = ML_SCORE;
414 ret = -E_MOOD_SYNTAX;
415 if (mlt == ML_INVALID)
416 goto out;
417 mi = para_calloc(sizeof(struct mood_item));
418 if (mlt != ML_SCORE) {
419 ret = -E_MOOD_SYNTAX;
420 w++;
421 if (!*w)
422 goto out;
423 if (!strcmp(*w, "with")) {
424 w++;
425 if (!*w)
426 goto out;
427 }
428 }
429 if (mlt == ML_SCORE || !strcmp(*w, "score")) {
430 ret = -E_MOOD_SYNTAX;
431 w++;
432 if (!*w)
433 goto out;
434 if (strcmp(*w, "random")) {
435 mi->random_score = 0;
436 ret = para_atoi32(*w, &mi->score_arg);
437 if (ret < 0)
438 goto out;
439 } else {
440 mi->random_score = 1;
441 if (!*(w + 1))
442 goto success; /* the line "score random" is valid */
443 }
444 } else
445 mi->score_arg = 0;
446 ret = -E_MOOD_SYNTAX;
447 w++;
448 if (!*w)
449 goto out;
450 if (!strcmp(*w, "if")) {
451 ret = -E_MOOD_SYNTAX;
452 w++;
453 if (!*w)
454 goto out;
455 }
456 if (!strcmp(*w, "not")) {
457 ret = -E_MOOD_SYNTAX;
458 w++;
459 if (!*w)
460 goto out;
461 mi->logical_not = 1;
462 } else
463 mi->logical_not = 0;
464 for (i = 0; mood_methods[i].parser; i++) {
465 if (strcmp(*w, mood_methods[i].name))
466 continue;
467 break;
468 }
469 ret = -E_MOOD_SYNTAX;
470 if (!mood_methods[i].parser)
471 goto out;
472 w++;
473 ret = mood_methods[i].parser(*w, &mi->parser_data);
474 if (ret < 0)
475 goto out;
476 mi->method = &mood_methods[i];
477 success:
478 if (mlpd->m) {
479 if (mlt == ML_ACCEPT)
480 para_list_add(&mi->mood_item_node, &mlpd->m->accept_list);
481 else if (mlt == ML_DENY)
482 para_list_add(&mi->mood_item_node, &mlpd->m->deny_list);
483 else
484 para_list_add(&mi->mood_item_node, &mlpd->m->score_list);
485 }
486 PARA_DEBUG_LOG("%s entry added, method: %p\n", mlt == ML_ACCEPT? "accept" :
487 (mlt == ML_DENY? "deny" : "score"), mi->method);
488 ret = 1;
489 out:
490 free(argv);
491 free(buf);
492 if (ret >= 0)
493 return ret;
494 if (mi) {
495 free(mi->parser_data);
496 free(mi);
497 }
498 return ret;
499 }
500
501 static int load_mood(const struct osl_row *mood_row, struct mood **m)
502 {
503 char *mood_name;
504 struct osl_object mood_def;
505 struct mood_line_parser_data mlpd = {.line_num = 0};
506 int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
507
508 if (ret < 0)
509 return ret;
510 if (!*mood_name)
511 return -E_DUMMY_ROW;
512 mlpd.m = alloc_new_mood(mood_name);
513 ret = for_each_line_ro(mood_def.data, mood_def.size,
514 parse_mood_line, &mlpd);
515 osl_close_disk_object(&mood_def);
516 if (ret < 0) {
517 PARA_ERROR_LOG("unable to load mood %s: %s\n", mlpd.m->name,
518 PARA_STRERROR(-ret));
519 destroy_mood(mlpd.m);
520 return ret;
521 }
522 PARA_INFO_LOG("loaded mood %s\n", mlpd.m->name);
523 *m = mlpd.m;
524 return 1;
525 }
526
527 /*
528 * Calls load_mood() and reverts its error value: It returns -E_MOOD_LOADED
529 * on _success_, and 1 on errors. This way the loop over all moods stops at the
530 * first valid mood.
531 */
532 static int load_mood_loop_func(struct osl_row *mood_row, void *data)
533 {
534 struct mood **m = data;
535 int ret = load_mood(mood_row, m);
536 if (ret < 0) {
537 if (ret != -E_DUMMY_ROW)
538 PARA_NOTICE_LOG("invalid mood (%d), trying next mood\n", ret);
539 return 1;
540 }
541 return -E_MOOD_LOADED;
542 }
543
544 static int load_first_available_mood(struct mood **m)
545 {
546 int ret = osl_rbtree_loop(moods_table, BLOBCOL_NAME, m,
547 load_mood_loop_func);
548 if (ret == -E_MOOD_LOADED) /* success */
549 return 1;
550 if (ret < 0)
551 return ret; /* error */
552 PARA_NOTICE_LOG("no valid mood found\n");
553 return -E_NO_MOOD;
554 }
555
556 static int check_mood(struct osl_row *mood_row, void *data)
557 {
558 struct para_buffer *pb = data;
559 char *mood_name;
560 struct osl_object mood_def;
561 struct mood_line_parser_data mlpd = {.line_num = 0};
562
563 int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
564
565 if (ret < 0) {
566 para_printf(pb, "failed to get mood definition\n");
567 return ret;
568 }
569 if (!*mood_name) /* ignore dummy row */
570 goto out;
571 para_printf(pb, "checking mood %s...\n", mood_name);
572 ret = for_each_line_ro(mood_def.data, mood_def.size,
573 parse_mood_line, &mlpd);
574 if (ret < 0)
575 para_printf(pb, "%s line %u: %s\n", mood_name, mlpd.line_num,
576 PARA_STRERROR(-ret));
577 out:
578 osl_close_disk_object(&mood_def);
579 return 1;
580 }
581
582 /**
583 * Check all moods for syntax errors.
584 *
585 * \param query Unused.
586 * \param result: Contains check messages.
587 */
588 int mood_check_callback(__a_unused const struct osl_object *query,
589 struct osl_object *result)
590 {
591 struct para_buffer pb = {.buf = NULL};
592
593 para_printf(&pb, "checking moods...\n");
594 osl_rbtree_loop(moods_table, BLOBCOL_ID, &pb,
595 check_mood);
596 result->data = pb.buf;
597 result->size = pb.size;
598 return 1;
599 }
600
601 #if 0
602 static unsigned int_log2(uint64_t x)
603 {
604 unsigned res = 0;
605
606 while (x) {
607 x /= 2;
608 res++;
609 }
610 return res;
611 }
612 #endif
613
614 static int64_t normalized_value(int64_t x, int64_t n, int64_t sum, int64_t qd)
615 {
616 if (!n || !qd)
617 return 0;
618 return 100 * (n * x - sum) / (int64_t)int_sqrt(n * qd);
619 }
620
621 static long compute_num_played_score(struct afs_info *afsi)
622 {
623 return -normalized_value(afsi->num_played, statistics.num,
624 statistics.num_played_sum, statistics.num_played_qd);
625 }
626
627 static long compute_last_played_score(struct afs_info *afsi)
628 {
629 return -normalized_value(afsi->last_played, statistics.num,
630 statistics.last_played_sum, statistics.last_played_qd);
631 }
632
633 static long compute_dynamic_score(const struct osl_row *aft_row)
634 {
635 struct afs_info afsi;
636 int64_t score, nscore = 0, lscore = 0;
637 int ret;
638
639 ret = get_afsi_of_row(aft_row, &afsi);
640 if (ret < 0)
641 return -100;
642 nscore = compute_num_played_score(&afsi);
643 lscore = compute_last_played_score(&afsi);
644 score = nscore + lscore;
645 return score;
646 }
647
648 static int add_afs_statistics(const struct osl_row *row)
649 {
650 uint64_t n, x, s;
651 struct afs_info afsi;
652 int ret;
653
654 ret = get_afsi_of_row(row, &afsi);
655 if (ret < 0)
656 return ret;
657 n = statistics.num;
658 x = afsi.last_played;
659 s = statistics.last_played_sum;
660 if (n > 0)
661 statistics.last_played_qd += (x - s / n) * (x - s / n) * n / (n + 1);
662 statistics.last_played_sum += x;
663
664 x = afsi.num_played;
665 s = statistics.num_played_sum;
666 if (n > 0)
667 statistics.num_played_qd += (x - s / n) * (x - s / n) * n / (n + 1);
668 statistics.num_played_sum += x;
669 statistics.num++;
670 return 1;
671 }
672
673 static int del_afs_statistics(const struct osl_row *row)
674 {
675 uint64_t n, s, q, a, new_s;
676 struct afs_info afsi;
677 int ret;
678 ret = get_afsi_of_row(row, &afsi);
679 if (ret < 0)
680 return ret;
681 n = statistics.num;
682 assert(n);
683 if (n == 1) {
684 memset(&statistics, 0, sizeof(statistics));
685 return 1;
686 }
687
688 s = statistics.last_played_sum;
689 q = statistics.last_played_qd;
690 a = afsi.last_played;
691 new_s = s - a;
692 statistics.last_played_sum = new_s;
693 statistics.last_played_qd = q + s * s / n - a * a
694 - new_s * new_s / (n - 1);
695
696 s = statistics.num_played_sum;
697 q = statistics.num_played_qd;
698 a = afsi.num_played;
699 new_s = s - a;
700 statistics.num_played_sum = new_s;
701 statistics.num_played_qd = q + s * s / n - a * a
702 - new_s * new_s / (n - 1);
703
704 statistics.num--;
705 return 1;
706 }
707
708 /**
709 * Structure used during mood_open().
710 *
711 * At mood open time, we look at each file in the audio file table in order to
712 * determine whether it is admissible. If a file happens to be admissible, its
713 * mood score is computed by calling each relevant mood_score_function. Next,
714 * we update the afs_statistics and add a struct admissible_file_info to a
715 * temporary array.
716 *
717 * If all files have been processed that way, the final score of each
718 * admissible file is computed by adding the dynamic score (which depends on
719 * the afs_statistics) to the mood score. Finally, all audio files in the
720 * array are added to the score table and the admissible array is freed.
721 *
722 * \sa mood_method, admissible_array.
723 */
724 struct admissible_file_info
725 {
726 /** The admissible audio file. */
727 struct osl_row *aft_row;
728 /** Its score. */
729 long score;
730 };
731
732 /** The temporary array of admissible files. */
733 struct admissible_array {
734 /** Files are admissible wrt. this mood. */
735 struct mood *m;
736 /** The size of the array */
737 unsigned size;
738 /** Pointer to the array of admissible files. */
739 struct admissible_file_info *array;
740 };
741
742 /**
743 * Add an entry to the array of admissible files.
744 *
745 * \param aft_row The audio file to be added.
746 * \param private_data Pointer to a struct admissible_file_info.
747 *
748 * \return Negative on errors, positive on success.
749 */
750 static int add_if_admissible(struct osl_row *aft_row, void *data)
751 {
752 struct admissible_array *aa = data;
753 int ret;
754 long score = 0;
755
756 ret = compute_mood_score(aft_row, aa->m, &score);
757 if (ret < 0)
758 return (ret == -E_NOT_ADMISSIBLE)? 1 : ret;
759 if (statistics.num >= aa->size) {
760 aa->size *= 2;
761 aa->size += 100;
762 aa->array = para_realloc(aa->array,
763 aa->size * sizeof(struct admissible_file_info));
764 }
765 aa->array[statistics.num].aft_row = aft_row;
766 aa->array[statistics.num].score = score;
767 ret = add_afs_statistics(aft_row);
768 if (ret < 0)
769 return ret;
770 return 1;
771 }
772
773 /**
774 * Compute the new quadratic deviation in case one element changes.
775 *
776 * \param n Number of elements.
777 * \param old_qd The quadratic deviation before the change.
778 * \param old_val The value that was replaced.
779 * \param new_val The replacement value.
780 * \param old_sum The sum of all elements before the update.
781 *
782 * \return The new quadratic deviation resulting from replacing old_val
783 * by new_val.
784 *
785 * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
786 * their quadratic deviation
787 *
788 * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
789 *
790 * and a real number b, the quadratic deviation q' of a_1,...a_{n-1}, b (ie.
791 * the last number a_n was replaced by b) may be computed in O(1) time in terms
792 * of n, q, a_n, b, and S as
793 *
794 * q' = q + d * s - (2 * S + d) * d / n,
795 *
796 * where d = b - a_n, and s = b + a_n.
797 *
798 * Example: n = 3, a_1 = 3, a_2 = 5, a_3 = 7, b = 10. Then S = 15, q = 8, d = 3,
799 * s = 17, so
800 *
801 * q + d * s - (2 * S + d) * d / n = 8 + 51 - 33 = 26,
802 *
803 * which equals q' = (3 - 6)^2 + (5 - 6)^2 + (10 - 6)^2.
804 *
805 */
806 _static_inline_ int64_t update_quadratic_deviation(int64_t n, int64_t old_qd,
807 int64_t old_val, int64_t new_val, int64_t old_sum)
808 {
809 int64_t delta = new_val - old_val;
810 int64_t sigma = new_val + old_val;
811 return old_qd + delta * sigma - (2 * old_sum + delta) * delta / n;
812 }
813
814 static int update_afs_statistics(struct afs_info *old_afsi, struct afs_info *new_afsi)
815 {
816 unsigned n;
817 int ret = get_num_admissible_files(&n);
818
819 if (ret < 0)
820 return ret;
821 assert(n);
822
823 statistics.last_played_qd = update_quadratic_deviation(n,
824 statistics.last_played_qd, old_afsi->last_played,
825 new_afsi->last_played, statistics.last_played_sum);
826 statistics.last_played_sum += new_afsi->last_played - old_afsi->last_played;
827
828 statistics.num_played_qd = update_quadratic_deviation(n,
829 statistics.num_played_qd, old_afsi->num_played,
830 new_afsi->num_played, statistics.num_played_sum);
831 statistics.num_played_sum += new_afsi->num_played - old_afsi->num_played;
832 return 1;
833 }
834
835 static int add_to_score_table(const struct osl_row *aft_row, long mood_score)
836 {
837 long score = (compute_dynamic_score(aft_row) + mood_score) / 3;
838 return score_add(aft_row, score);
839 }
840
841 static int delete_from_statistics_and_score_table(const struct osl_row *aft_row)
842 {
843 int ret = del_afs_statistics(aft_row);
844 if (ret < 0)
845 return ret;
846 return score_delete(aft_row);
847 }
848
849 /**
850 * Delete one entry from the statistics and from the score table.
851 *
852 * \param aft_row The audio file which is no longer admissible.
853 *
854 * \return Positive on success, negative on errors.
855 *
856 * \sa score_delete(), mood_update_audio_file().
857 */
858 int mood_delete_audio_file(const struct osl_row *aft_row)
859 {
860 int ret;
861
862 ret = row_belongs_to_score_table(aft_row);
863 if (ret < 0)
864 return ret;
865 if (!ret) /* not admissible, nothing to do */
866 return 1;
867 return delete_from_statistics_and_score_table(aft_row);
868 }
869
870 /**
871 * Compute the new score of an audio file wrt. the current mood.
872 *
873 * \param aft_row Determines the audio file.
874 * \param old_afsi The audio file selector info before updating.
875 *
876 * The \a old_afsi argument may be \p NULL which indicates that no changes to
877 * the audio file info were made.
878 *
879 * \return Positive on success, negative on errors.
880 */
881 int mood_update_audio_file(const struct osl_row *aft_row, struct afs_info *old_afsi)
882 {
883 long score, percent;
884 int ret, is_admissible, was_admissible = 0;
885 struct afs_info afsi;
886
887 if (!current_mood)
888 return 1; /* nothing to do */
889 ret = row_belongs_to_score_table(aft_row);
890 if (ret < 0)
891 return ret;
892 was_admissible = ret;
893 ret = compute_mood_score(aft_row, current_mood, &score);
894 is_admissible = (ret > 0);
895 if (!was_admissible && !is_admissible)
896 return 1;
897 if (was_admissible && !is_admissible)
898 return delete_from_statistics_and_score_table(aft_row);
899 if (!was_admissible && is_admissible) {
900 ret = add_afs_statistics(aft_row);
901 if (ret < 0)
902 return ret;
903 return add_to_score_table(aft_row, score);
904 }
905 /* update score */
906 ret = get_afsi_of_row(aft_row, &afsi);
907 if (ret < 0)
908 return ret;
909 if (old_afsi) {
910 ret = update_afs_statistics(old_afsi, &afsi);
911 if (ret < 0)
912 return ret;
913 }
914 score += compute_num_played_score(&afsi);
915 score += compute_last_played_score(&afsi);
916 score /= 3;
917 PARA_DEBUG_LOG("score: %li\n", score);
918 percent = (score + 100) / 3;
919 if (percent > 100)
920 percent = 100;
921 else if (percent < 0)
922 percent = 0;
923 PARA_DEBUG_LOG("re-inserting at %lu%%\n", percent);
924 return score_update(aft_row, percent);
925 }
926
927 static void log_statistics(void)
928 {
929 unsigned n = statistics.num;
930
931 if (!n) {
932 PARA_NOTICE_LOG("no admissible files\n");
933 return;
934 }
935 PARA_NOTICE_LOG("last_played mean: %lli, last_played sigma: %llu\n",
936 (long long int)(statistics.last_played_sum / n),
937 (long long unsigned)int_sqrt(statistics.last_played_qd / n));
938 PARA_NOTICE_LOG("num_played mean: %lli, num_played sigma: %llu\n",
939 (long long int)statistics.num_played_sum / n,
940 (long long unsigned)int_sqrt(statistics.num_played_qd / n));
941 }
942
943 /**
944 * Change the current mood.
945 *
946 * \param mood_name The name of the mood to open.
947 *
948 * There are two special cases: If \a mood_name is \a NULL, load the
949 * first available mood. If \a mood_name is the empty string "", load
950 * the dummy mood that accepts every audio file and uses a scoring method
951 * based only on the \a last_played information.
952 *
953 * If there is already an open mood, it will be closed first.
954 *
955 * \return Positive on success, negative on errors. Loading the dummy mood
956 * always succeeds.
957 *
958 * \sa struct admissible_file_info, struct admissible_array, struct
959 * afs_info::last_played, mood_close().
960 */
961 int change_current_mood(char *mood_name)
962 {
963 int i, ret;
964 struct admissible_array aa = {
965 .size = 0,
966 .array = NULL
967 };
968
969 if (!mood_name) {
970 struct mood *m;
971 ret = load_first_available_mood(&m);
972 if (ret < 0)
973 return ret;
974 destroy_mood(current_mood);
975 current_mood = m;
976 } else if (*mood_name) {
977 struct mood *m;
978 struct osl_row *row;
979 struct osl_object obj = {
980 .data = mood_name,
981 .size = strlen(mood_name) + 1
982 };
983 ret = osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row);
984 if (ret < 0) {
985 PARA_NOTICE_LOG("no such mood: %s\n", mood_name);
986 return ret;
987 }
988 ret = load_mood(row, &m);
989 if (ret < 0)
990 return ret;
991 destroy_mood(current_mood);
992 current_mood = m;
993 } else {
994 destroy_mood(current_mood);
995 current_mood = alloc_new_mood("dummy");
996 }
997 aa.m = current_mood;
998 PARA_NOTICE_LOG("loaded mood %s\n", current_mood->name);
999 PARA_INFO_LOG("%s\n", "computing statistics of admissible files");
1000 ret = audio_file_loop(&aa, add_if_admissible);
1001 if (ret < 0)
1002 return ret;
1003 log_statistics();
1004 PARA_NOTICE_LOG("%d admissible files \n", statistics.num);
1005 for (i = 0; i < statistics.num; i++) {
1006 struct admissible_file_info *a = aa.array + i;
1007 ret = add_to_score_table(a->aft_row, a->score);
1008 if (ret < 0)
1009 goto out;
1010 }
1011 PARA_NOTICE_LOG("score add complete\n");
1012 ret = 1;
1013 out:
1014 free(aa.array);
1015 return ret;
1016 }
1017
1018 /**
1019 * Close the current mood.
1020 *
1021 * Free all resources of the current mood which were allocated during
1022 * mood_open().
1023 */
1024 void close_current_mood(void)
1025 {
1026 destroy_mood(current_mood);
1027 current_mood = NULL;
1028 memset(&statistics, 0, sizeof(statistics));
1029 }
1030
1031 /**
1032 * Close and re-open the current mood.
1033 *
1034 * This function is used if changes to the audio file table or the
1035 * attribute table were made that render the current list of admissible
1036 * files useless. For example, if an attribute is removed from the
1037 * attribute table, this function is called.
1038 *
1039 * \return Positive on success, negative on errors. If no mood is currently
1040 * open, the function returns success.
1041 *
1042 * \sa mood_open(), mood_close().
1043 */
1044 int reload_current_mood(void)
1045 {
1046 int ret;
1047 char *mood_name;
1048
1049 if (!current_mood)
1050 return 1;
1051 score_shutdown(0);
1052 mood_name = para_strdup(current_mood->name);
1053 close_current_mood();
1054 ret = change_current_mood(mood_name);
1055 free(mood_name);
1056 return ret;
1057 }