Version 2 moods.
[paraslash.git] / mood.c
1 /*
2 * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
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 <regex.h>
10 #include <osl.h>
11 #include <lopsub.h>
12
13 #include "para.h"
14 #include "error.h"
15 #include "string.h"
16 #include "afh.h"
17 #include "afs.h"
18 #include "list.h"
19 #include "mm.h"
20 #include "mood.h"
21
22 /*
23 * Mood parser API. It's overkill to have an own header file for
24 * these declarations as they are only needed in this .c file.
25 */
26 struct mp_context;
27 int mp_init(const char *definition, int nbytes, struct mp_context **result,
28 char **errmsg);
29 bool mp_eval_row(const struct osl_row *aft_row, struct mp_context *ctx);
30 void mp_shutdown(struct mp_context *ctx);
31
32 /**
33 * Contains statistical data of the currently admissible audio files.
34 *
35 * It is used to assign normalized score values to each admissible audio file.
36 */
37 struct afs_statistics {
38 /** Sum of num played over all admissible files. */
39 int64_t num_played_sum;
40 /** Sum of last played times over all admissible files. */
41 int64_t last_played_sum;
42 /** Quadratic deviation of num played count. */
43 int64_t num_played_qd;
44 /** Quadratic deviation of last played time. */
45 int64_t last_played_qd;
46 /** Number of admissible files */
47 unsigned num;
48 };
49 static struct afs_statistics statistics;
50
51 /**
52 * Each line of the current mood corresponds to a mood_item.
53 */
54 struct mood_item {
55 /** The method this line is referring to. */
56 const struct mood_method *method;
57 /** The data structure computed by the mood parser. */
58 void *parser_data;
59 /** The given score value, or zero if none was given. */
60 int32_t score_arg;
61 /** Non-zero if random scoring was requested. */
62 int random_score;
63 /** Whether the "not" keyword was given in the mood line. */
64 int logical_not;
65 /** The position in the list of items. */
66 struct list_head mood_item_node;
67 };
68
69 /*
70 * Created from the mood definition by \ref change_current_mood().
71 *
72 * When a mood is opened, each line of its definition is investigated, and a
73 * corresponding mood item is produced. Each mood line starts with accept,
74 * deny, or score which determines the type of the mood line. For each such
75 * type a linked list is maintained whose entries are the mood items.
76 */
77 struct mood {
78 /** The name of this mood. */
79 char *name;
80 /** The list of mood items of type \p accept. */
81 struct list_head accept_list;
82 /** The list of mood items of type \p deny. */
83 struct list_head deny_list;
84 /** The list of mood items of type \p score. */
85 struct list_head score_list;
86 /* Only used for version 2 moods. */
87 struct mp_context *parser_context;
88 };
89
90 /*
91 * If current_mood is NULL then no mood is currently open. If
92 * current_mood->name is NULL, the dummy mood is currently open.
93 */
94 static struct mood *current_mood;
95
96 /**
97 * Rough approximation to sqrt.
98 *
99 * \param x Integer of which to calculate the sqrt.
100 *
101 * \return An integer res with res * res <= x.
102 */
103 __a_const static uint64_t int_sqrt(uint64_t x)
104 {
105 uint64_t op, res, one = 1;
106 op = x;
107 res = 0;
108
109 one = one << 62;
110 while (one > op)
111 one >>= 2;
112
113 while (one != 0) {
114 if (op >= res + one) {
115 op = op - (res + one);
116 res = res + 2 * one;
117 }
118 res /= 2;
119 one /= 4;
120 }
121 // PARA_NOTICE_LOG("sqrt(%llu) = %llu\n", x, res);
122 return res;
123 }
124
125 /*
126 * Returns true if row matches, false if it does not match. In any case score
127 * and score_arg_sum are set/increased accordingly.
128 */
129 static bool get_item_score(struct mood_item *item, const struct afs_info *afsi,
130 const struct afh_info *afhi, const char *path, long *score,
131 long *score_arg_sum)
132 {
133 int ret;
134 bool match = true;
135
136 *score_arg_sum += item->random_score? 100 : PARA_ABS(item->score_arg);
137 ret = 100;
138 if (item->method) {
139 ret = item->method->score_function(path, afsi, afhi,
140 item->parser_data);
141 if ((ret < 0 && !item->logical_not) || (ret >= 0 && item->logical_not))
142 match = false;
143 }
144 if (item->random_score)
145 *score = PARA_ABS(ret) * para_random(100);
146 else
147 *score = PARA_ABS(ret) * item->score_arg;
148 return match;
149 }
150
151 /* returns 1 if row admissible, 0 if not, negative on errors */
152 static int row_is_admissible(const struct osl_row *aft_row, struct mood *m,
153 long *scorep)
154 {
155 struct mood_item *item;
156 int ret;
157 bool match;
158 long score_arg_sum = 0, score = 0, item_score;
159 struct afs_info afsi;
160 struct afh_info afhi;
161 char *path;
162
163 if (!m)
164 return -E_NO_MOOD;
165 if (m->parser_context) {
166 *scorep = 0;
167 return mp_eval_row(aft_row, m->parser_context);
168 }
169 ret = get_afsi_of_row(aft_row, &afsi);
170 if (ret < 0)
171 return ret;
172 ret = get_afhi_of_row(aft_row, &afhi);
173 if (ret < 0)
174 return ret;
175 ret = get_audio_file_path_of_row(aft_row, &path);
176 if (ret < 0)
177 return ret;
178 /* reject audio file if it matches any entry in the deny list */
179 list_for_each_entry(item, &m->deny_list, mood_item_node) {
180 match = get_item_score(item, &afsi, &afhi, path, &item_score,
181 &score_arg_sum);
182 if (match) /* not admissible */
183 return 0;
184 score += item_score;
185 }
186 match = false;
187 list_for_each_entry(item, &m->accept_list, mood_item_node) {
188 ret = get_item_score(item, &afsi, &afhi, path, &item_score,
189 &score_arg_sum);
190 if (ret == 0)
191 continue;
192 match = true;
193 score += item_score;
194 }
195 /* reject if there is no matching entry in the accept list */
196 if (!match && !list_empty(&m->accept_list))
197 return 0;
198 list_for_each_entry(item, &m->score_list, mood_item_node) {
199 match = get_item_score(item, &afsi, &afhi, path, &item_score,
200 &score_arg_sum);
201 if (match)
202 score += item_score;
203 }
204 if (score_arg_sum)
205 score /= score_arg_sum;
206 *scorep = score;
207 return 1;
208 }
209
210 static void cleanup_list_entry(struct mood_item *item)
211 {
212 if (item->method && item->method->cleanup)
213 item->method->cleanup(item->parser_data);
214 else
215 free(item->parser_data);
216 list_del(&item->mood_item_node);
217 free(item);
218 }
219
220 static void destroy_mood(struct mood *m)
221 {
222 struct mood_item *tmp, *item;
223
224 if (!m)
225 return;
226 list_for_each_entry_safe(item, tmp, &m->accept_list, mood_item_node)
227 cleanup_list_entry(item);
228 list_for_each_entry_safe(item, tmp, &m->deny_list, mood_item_node)
229 cleanup_list_entry(item);
230 list_for_each_entry_safe(item, tmp, &m->score_list, mood_item_node)
231 cleanup_list_entry(item);
232 free(m->name);
233 mp_shutdown(m->parser_context);
234 free(m);
235 }
236
237 static struct mood *alloc_new_mood(const char *name)
238 {
239 struct mood *m = para_calloc(sizeof(struct mood));
240 if (name)
241 m->name = para_strdup(name);
242 INIT_LIST_HEAD(&m->accept_list);
243 INIT_LIST_HEAD(&m->deny_list);
244 INIT_LIST_HEAD(&m->score_list);
245 return m;
246 }
247
248 /** The different types of a mood line. */
249 enum mood_line_type {
250 /** Invalid. */
251 ML_INVALID,
252 /** Accept line. */
253 ML_ACCEPT,
254 /** Deny line. */
255 ML_DENY,
256 /** Score line. */
257 ML_SCORE
258 };
259
260 /** Data passed to the parser of a mood line. */
261 struct mood_line_parser_data {
262 /** The mood this mood line belongs to. */
263 struct mood *m;
264 /** The line number in the mood definition. */
265 unsigned line_num;
266 };
267
268 /*
269 * <accept [with score <score>] | deny [with score <score>] | score <score>>
270 * [if] [not] <mood_method> [options]
271 * <score> is either an integer or "random" which assigns a random score to
272 * all matching files
273 */
274 static int parse_mood_line(char *mood_line, void *data)
275 {
276 struct mood_line_parser_data *mlpd = data;
277 char **argv;
278 unsigned num_words;
279 char **w;
280 int i, ret;
281 enum mood_line_type mlt = ML_INVALID;
282 struct mood_item *mi = NULL;
283
284 mlpd->line_num++;
285 ret = create_argv(mood_line, " \t", &argv);
286 if (ret < 0)
287 return ret;
288 num_words = ret;
289 if (!num_words) /* empty line */
290 goto out;
291 w = argv;
292 if (**w == '#') /* comment */
293 goto out;
294 if (!strcmp(*w, "accept"))
295 mlt = ML_ACCEPT;
296 else if (!strcmp(*w, "deny"))
297 mlt = ML_DENY;
298 else if (!strcmp(*w, "score"))
299 mlt = ML_SCORE;
300 ret = -E_MOOD_SYNTAX;
301 if (mlt == ML_INVALID)
302 goto out;
303 mi = para_calloc(sizeof(struct mood_item));
304 if (mlt != ML_SCORE) {
305 ret = -E_MOOD_SYNTAX;
306 w++;
307 if (!*w)
308 goto out;
309 if (strcmp(*w, "with"))
310 goto check_for_if;
311 w++;
312 if (!*w)
313 goto out;
314 if (strcmp(*w, "score"))
315 goto out;
316 }
317 if (mlt == ML_SCORE || !strcmp(*w, "score")) {
318 ret = -E_MOOD_SYNTAX;
319 w++;
320 if (!*w)
321 goto out;
322 if (strcmp(*w, "random")) {
323 mi->random_score = 0;
324 ret = para_atoi32(*w, &mi->score_arg);
325 if (ret < 0)
326 goto out;
327 } else {
328 mi->random_score = 1;
329 if (!*(w + 1))
330 goto success; /* the line "score random" is valid */
331 }
332 } else
333 mi->score_arg = 0;
334 ret = -E_MOOD_SYNTAX;
335 w++;
336 if (!*w)
337 goto out;
338 check_for_if:
339 if (!strcmp(*w, "if")) {
340 ret = -E_MOOD_SYNTAX;
341 w++;
342 if (!*w)
343 goto out;
344 }
345 if (!strcmp(*w, "not")) {
346 ret = -E_MOOD_SYNTAX;
347 w++;
348 if (!*w)
349 goto out;
350 mi->logical_not = 1;
351 } else
352 mi->logical_not = 0;
353 for (i = 0; mood_methods[i].parser; i++) {
354 if (strcmp(*w, mood_methods[i].name))
355 continue;
356 break;
357 }
358 ret = -E_MOOD_SYNTAX;
359 if (!mood_methods[i].parser)
360 goto out;
361 ret = mood_methods[i].parser(num_words - 1 - (w - argv), w,
362 &mi->parser_data);
363 if (ret < 0)
364 goto out;
365 mi->method = &mood_methods[i];
366 success:
367 if (mlpd->m) {
368 if (mlt == ML_ACCEPT)
369 para_list_add(&mi->mood_item_node, &mlpd->m->accept_list);
370 else if (mlt == ML_DENY)
371 para_list_add(&mi->mood_item_node, &mlpd->m->deny_list);
372 else
373 para_list_add(&mi->mood_item_node, &mlpd->m->score_list);
374 }
375 PARA_DEBUG_LOG("%s entry added, method: %p\n", mlt == ML_ACCEPT? "accept" :
376 (mlt == ML_DENY? "deny" : "score"), mi->method);
377 ret = 1;
378 out:
379 free_argv(argv);
380 if (mi && (ret < 0 || !mlpd->m)) { /* mi was not added to any list */
381 free(mi->parser_data);
382 free(mi);
383 }
384 return ret;
385 }
386
387 static int load_mood(const struct osl_row *mood_row, struct mood **m,
388 char **errmsg)
389 {
390 char *mood_name;
391 struct osl_object mood_def;
392 struct mood_line_parser_data mlpd = {.line_num = 0};
393 int ret;
394
395 *m = NULL;
396 ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
397 if (ret < 0)
398 return ret;
399 if (!*mood_name)
400 return -E_DUMMY_ROW;
401 mlpd.m = alloc_new_mood(mood_name);
402 ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
403 parse_mood_line, &mlpd);
404 if (ret < 0) {
405 PARA_INFO_LOG("opening version 2 mood %s\n", mlpd.m->name);
406 ret = mp_init(mood_def.data, mood_def.size, &mlpd.m->parser_context,
407 errmsg);
408 if (ret < 0)
409 destroy_mood(mlpd.m);
410 } else {
411 PARA_WARNING_LOG("loaded version 1 mood %s\n", mlpd.m->name);
412 PARA_WARNING_LOG("please convert to version 2\n");
413 ret = 1;
414 }
415 osl_close_disk_object(&mood_def);
416 if (ret >= 0)
417 *m = mlpd.m;
418 return ret;
419 }
420
421 static int check_mood(struct osl_row *mood_row, void *data)
422 {
423 struct para_buffer *pb = data;
424 char *mood_name;
425 struct osl_object mood_def;
426 struct mood_line_parser_data mlpd = {.line_num = 0};
427
428 int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
429
430 if (ret < 0) {
431 para_printf(pb, "cannot read mood\n");
432 return ret;
433 }
434 if (!*mood_name) /* ignore dummy row */
435 goto out;
436 ret = for_each_line(FELF_READ_ONLY, mood_def.data, mood_def.size,
437 parse_mood_line, &mlpd);
438 if (ret < 0) {
439 char *errmsg;
440 struct mood *m = alloc_new_mood("check");
441 ret = mp_init(mood_def.data, mood_def.size, &m->parser_context,
442 &errmsg);
443 if (ret < 0) {
444 para_printf(pb, "%s: %s\n", mood_name, errmsg);
445 free(errmsg);
446 para_printf(pb, "%s\n", para_strerror(-ret));
447 } else
448 destroy_mood(m);
449 } else {
450 para_printf(pb, "%s: v1 mood, please convert to v2\n",
451 mood_name);
452
453 }
454 ret = 1; /* don't fail the loop on invalid mood definitions */
455 out:
456 osl_close_disk_object(&mood_def);
457 return ret;
458 }
459
460 /**
461 * Check all moods for syntax errors.
462 *
463 * \param aca Only ->pbout is used for diagnostics.
464 *
465 * \return Negative on fatal errors. Inconsistent mood definitions are not
466 * considered an error.
467 */
468 int mood_check_callback(struct afs_callback_arg *aca)
469 {
470 para_printf(&aca->pbout, "checking moods...\n");
471 return osl(osl_rbtree_loop(moods_table, BLOBCOL_ID, &aca->pbout,
472 check_mood));
473 }
474
475 static int64_t normalized_value(int64_t x, int64_t n, int64_t sum, int64_t qd)
476 {
477 if (!n || !qd)
478 return 0;
479 return 100 * (n * x - sum) / (int64_t)int_sqrt(n) / (int64_t)int_sqrt(qd);
480 }
481
482 static long compute_score(struct afs_info *afsi, long mood_score)
483 {
484 mood_score -= normalized_value(afsi->num_played, statistics.num,
485 statistics.num_played_sum, statistics.num_played_qd);
486 mood_score -= normalized_value(afsi->last_played, statistics.num,
487 statistics.last_played_sum, statistics.last_played_qd);
488 return mood_score / 3;
489 }
490
491 static int add_afs_statistics(const struct osl_row *row)
492 {
493 uint64_t n, x, s, q;
494 struct afs_info afsi;
495 int ret;
496
497 ret = get_afsi_of_row(row, &afsi);
498 if (ret < 0)
499 return ret;
500 n = statistics.num;
501 x = afsi.last_played;
502 s = statistics.last_played_sum;
503 if (n > 0) {
504 q = (x > s / n)? x - s / n : s / n - x;
505 statistics.last_played_qd += q * q * n / (n + 1);
506 }
507 statistics.last_played_sum += x;
508
509 x = afsi.num_played;
510 s = statistics.num_played_sum;
511 if (n > 0) {
512 q = (x > s / n)? x - s / n : s / n - x;
513 statistics.num_played_qd += q * q * n / (n + 1);
514 }
515 statistics.num_played_sum += x;
516 statistics.num++;
517 return 1;
518 }
519
520 static int del_afs_statistics(const struct osl_row *row)
521 {
522 uint64_t n, s, q, a, new_s;
523 struct afs_info afsi;
524 int ret;
525 ret = get_afsi_of_row(row, &afsi);
526 if (ret < 0)
527 return ret;
528 n = statistics.num;
529 assert(n);
530 if (n == 1) {
531 memset(&statistics, 0, sizeof(statistics));
532 return 1;
533 }
534
535 s = statistics.last_played_sum;
536 q = statistics.last_played_qd;
537 a = afsi.last_played;
538 new_s = s - a;
539 statistics.last_played_sum = new_s;
540 statistics.last_played_qd = q + s * s / n - a * a
541 - new_s * new_s / (n - 1);
542
543 s = statistics.num_played_sum;
544 q = statistics.num_played_qd;
545 a = afsi.num_played;
546 new_s = s - a;
547 statistics.num_played_sum = new_s;
548 statistics.num_played_qd = q + s * s / n - a * a
549 - new_s * new_s / (n - 1);
550
551 statistics.num--;
552 return 1;
553 }
554
555 /*
556 * At mood open time we determine the set of admissible files for the given
557 * mood. The mood score of each admissible file is computed by adding up all
558 * mood item scores. Next, we update the afs statistics and append a struct
559 * admissible_file_info to a temporary array.
560 *
561 * When all files have been processed in this way, the final score of each
562 * admissible file is computed by adding the dynamic score (which depends on
563 * the afs_statistics and the current time) to the mood score. Finally, all
564 * audio files in the temporary array are added to the score table and the
565 * array is freed.
566 */
567 struct admissible_file_info
568 {
569 /** The admissible audio file. */
570 struct osl_row *aft_row;
571 /** Its score. */
572 long score;
573 };
574
575 /** The temporary array of admissible files. */
576 struct admissible_array {
577 /** Files are admissible wrt. this mood. */
578 struct mood *m;
579 /** The size of the array */
580 unsigned size;
581 /** Pointer to the array of admissible files. */
582 struct admissible_file_info *array;
583 };
584
585 /**
586 * Add an entry to the array of admissible files.
587 *
588 * \param aft_row The audio file to be added.
589 * \param private_data Pointer to a struct admissible_file_info.
590 *
591 * \return 1 if row admissible, 0 if not, negative on errors.
592 */
593 static int add_if_admissible(struct osl_row *aft_row, void *data)
594 {
595 struct admissible_array *aa = data;
596 int ret;
597 long score = 0;
598
599 ret = row_is_admissible(aft_row, aa->m, &score);
600 if (ret <= 0)
601 return ret;
602 if (statistics.num >= aa->size) {
603 aa->size *= 2;
604 aa->size += 100;
605 aa->array = para_realloc(aa->array,
606 aa->size * sizeof(struct admissible_file_info));
607 }
608 aa->array[statistics.num].aft_row = aft_row;
609 aa->array[statistics.num].score = score;
610 ret = add_afs_statistics(aft_row);
611 if (ret < 0)
612 return ret;
613 return 1;
614 }
615
616 /**
617 * Compute the new quadratic deviation in case one element changes.
618 *
619 * \param n Number of elements.
620 * \param old_qd The quadratic deviation before the change.
621 * \param old_val The value that was replaced.
622 * \param new_val The replacement value.
623 * \param old_sum The sum of all elements before the update.
624 *
625 * \return The new quadratic deviation resulting from replacing old_val
626 * by new_val.
627 *
628 * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
629 * their quadratic deviation
630 *
631 * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
632 *
633 * and a real number b, the quadratic deviation q' of a_1,...a_{n-1}, b (ie.
634 * the last number a_n was replaced by b) may be computed in O(1) time in terms
635 * of n, q, a_n, b, and S as
636 *
637 * q' = q + d * s - (2 * S + d) * d / n
638 * = q + d * (s - 2 * S / n - d /n),
639 *
640 * where d = b - a_n, and s = b + a_n.
641 *
642 * Example: n = 3, a_1 = 3, a_2 = 5, a_3 = 7, b = 10. Then S = 15, q = 8, d = 3,
643 * s = 17, so
644 *
645 * q + d * s - (2 * S + d) * d / n = 8 + 51 - 33 = 26,
646 *
647 * which equals q' = (3 - 6)^2 + (5 - 6)^2 + (10 - 6)^2.
648 *
649 */
650 _static_inline_ int64_t update_quadratic_deviation(int64_t n, int64_t old_qd,
651 int64_t old_val, int64_t new_val, int64_t old_sum)
652 {
653 int64_t delta = new_val - old_val;
654 int64_t sigma = new_val + old_val;
655 return old_qd + delta * (sigma - 2 * old_sum / n - delta / n);
656 }
657
658 static int update_afs_statistics(struct afs_info *old_afsi,
659 struct afs_info *new_afsi)
660 {
661 unsigned n;
662 int ret = get_num_admissible_files(&n);
663
664 if (ret < 0)
665 return ret;
666 assert(n);
667
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;
672
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;
677 return 1;
678 }
679
680 static int add_to_score_table(const struct osl_row *aft_row, long mood_score)
681 {
682 long score;
683 struct afs_info afsi;
684 int ret = get_afsi_of_row(aft_row, &afsi);
685
686 if (ret < 0)
687 return ret;
688 score = compute_score(&afsi, mood_score);
689 return score_add(aft_row, score);
690 }
691
692 static int delete_from_statistics_and_score_table(const struct osl_row *aft_row)
693 {
694 int ret = del_afs_statistics(aft_row);
695 if (ret < 0)
696 return ret;
697 return score_delete(aft_row);
698 }
699
700 /**
701 * Delete one entry from the statistics and from the score table.
702 *
703 * \param aft_row The audio file which is no longer admissible.
704 *
705 * \return Positive on success, negative on errors.
706 *
707 * \sa \ref score_delete().
708 */
709 static int mood_delete_audio_file(const struct osl_row *aft_row)
710 {
711 int ret;
712
713 ret = row_belongs_to_score_table(aft_row, NULL);
714 if (ret < 0)
715 return ret;
716 if (!ret) /* not admissible, nothing to do */
717 return 1;
718 return delete_from_statistics_and_score_table(aft_row);
719 }
720
721 /**
722 * Compute the new score of an audio file wrt. the current mood.
723 *
724 * \param aft_row Determines the audio file.
725 * \param old_afsi The audio file selector info before updating.
726 *
727 * The \a old_afsi argument may be \p NULL which indicates that no changes to
728 * the audio file info were made.
729 *
730 * \return Positive on success, negative on errors.
731 */
732 static int mood_update_audio_file(const struct osl_row *aft_row,
733 struct afs_info *old_afsi)
734 {
735 long score, percent;
736 int ret, is_admissible, was_admissible = 0;
737 struct afs_info afsi;
738 unsigned rank;
739
740 if (!current_mood)
741 return 1; /* nothing to do */
742 ret = row_belongs_to_score_table(aft_row, &rank);
743 if (ret < 0)
744 return ret;
745 was_admissible = ret;
746 ret = row_is_admissible(aft_row, current_mood, &score);
747 if (ret < 0)
748 return ret;
749 is_admissible = (ret > 0);
750 if (!was_admissible && !is_admissible)
751 return 1;
752 if (was_admissible && !is_admissible)
753 return delete_from_statistics_and_score_table(aft_row);
754 if (!was_admissible && is_admissible) {
755 ret = add_afs_statistics(aft_row);
756 if (ret < 0)
757 return ret;
758 return add_to_score_table(aft_row, score);
759 }
760 /* update score */
761 ret = get_afsi_of_row(aft_row, &afsi);
762 if (ret < 0)
763 return ret;
764 if (old_afsi) {
765 ret = update_afs_statistics(old_afsi, &afsi);
766 if (ret < 0)
767 return ret;
768 }
769 score = compute_score(&afsi, score);
770 PARA_DEBUG_LOG("score: %li\n", score);
771 percent = (score + 100) / 3;
772 if (percent > 100)
773 percent = 100;
774 else if (percent < 0)
775 percent = 0;
776 PARA_DEBUG_LOG("moving from rank %u to %li%%\n", rank, percent);
777 return score_update(aft_row, percent);
778 }
779
780 static void log_statistics(void)
781 {
782 unsigned n = statistics.num;
783 int mean_days, sigma_days;
784 /*
785 * We can not use the "now" pointer from sched.c here because we are
786 * called before schedule(), which initializes "now".
787 */
788 struct timeval rnow;
789
790 assert(current_mood);
791 PARA_NOTICE_LOG("loaded mood %s\n", current_mood->name?
792 current_mood->name : "(dummy)");
793 if (!n) {
794 PARA_WARNING_LOG("no admissible files\n");
795 return;
796 }
797 PARA_NOTICE_LOG("%u admissible files\n", statistics.num);
798 clock_get_realtime(&rnow);
799 mean_days = (rnow.tv_sec - statistics.last_played_sum / n) / 3600 / 24;
800 sigma_days = int_sqrt(statistics.last_played_qd / n) / 3600 / 24;
801 PARA_NOTICE_LOG("last_played mean/sigma: %d/%d days\n", mean_days, sigma_days);
802 PARA_NOTICE_LOG("num_played mean/sigma: %llu/%llu\n",
803 (long long unsigned)statistics.num_played_sum / n,
804 (long long unsigned)int_sqrt(statistics.num_played_qd / n));
805 }
806
807 /**
808 * Close the current mood.
809 *
810 * Frees all resources of the current mood.
811 */
812 void close_current_mood(void)
813 {
814 destroy_mood(current_mood);
815 current_mood = NULL;
816 memset(&statistics, 0, sizeof(statistics));
817 }
818
819 /**
820 * Change the current mood.
821 *
822 * \param mood_name The name of the mood to open.
823 * \param errmsg Error description is returned here.
824 *
825 * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
826 * and uses a scoring method based only on the \a last_played information.
827 *
828 * The errmsg pointer may be NULL, in which case no error message will be
829 * returned. If a non-NULL pointer is given, the caller must free *errmsg.
830 *
831 * If there is already an open mood, it will be closed first.
832 *
833 * \return Positive on success, negative on errors. Loading the dummy mood
834 * always succeeds.
835 *
836 * \sa struct \ref afs_info::last_played, \ref mp_eval_row().
837 */
838 int change_current_mood(const char *mood_name, char **errmsg)
839 {
840 int i, ret;
841 struct admissible_array aa = {
842 .size = 0,
843 .array = NULL
844 };
845
846 if (mood_name) {
847 struct mood *m;
848 struct osl_row *row;
849 struct osl_object obj = {
850 .data = (char *)mood_name,
851 .size = strlen(mood_name) + 1
852 };
853 ret = osl(osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row));
854 if (ret < 0) {
855 PARA_NOTICE_LOG("no such mood: %s\n", mood_name);
856 return ret;
857 }
858 ret = load_mood(row, &m, errmsg);
859 if (ret < 0)
860 return ret;
861 close_current_mood();
862 current_mood = m;
863 } else { /* load dummy mood */
864 close_current_mood();
865 current_mood = alloc_new_mood(NULL);
866 }
867 aa.m = current_mood;
868 PARA_NOTICE_LOG("computing statistics of admissible files\n");
869 ret = audio_file_loop(&aa, add_if_admissible);
870 if (ret < 0)
871 return ret;
872 for (i = 0; i < statistics.num; i++) {
873 struct admissible_file_info *a = aa.array + i;
874 ret = add_to_score_table(a->aft_row, a->score);
875 if (ret < 0)
876 goto out;
877 }
878 log_statistics();
879 ret = statistics.num;
880 out:
881 free(aa.array);
882 return ret;
883 }
884
885 /*
886 * Close and re-open the current mood.
887 *
888 * This function is called on events which render the current list of
889 * admissible files useless, for example if an attribute is removed from the
890 * attribute table.
891 *
892 * If no mood is currently open, the function returns success.
893 */
894 static int reload_current_mood(void)
895 {
896 int ret;
897 char *mood_name = NULL;
898
899 ret = clear_score_table();
900 if (ret < 0)
901 return ret;
902 if (!current_mood)
903 return 1;
904 PARA_NOTICE_LOG("reloading %s\n", current_mood->name?
905 current_mood->name : "(dummy)");
906 if (current_mood->name)
907 mood_name = para_strdup(current_mood->name);
908 close_current_mood();
909 ret = change_current_mood(mood_name, NULL);
910 free(mood_name);
911 return ret;
912 }
913
914 /**
915 * Notification callback for the moods table.
916 *
917 * \param event Type of the event just occurred.
918 * \param pb Unused.
919 * \param data Its type depends on the event.
920 *
921 * This function performs actions required due to the occurrence of the given
922 * event. Possible actions include reload of the current mood and update of the
923 * score of an audio file.
924 *
925 * \return Standard.
926 */
927 int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb,
928 void *data)
929 {
930 if (!current_mood)
931 return 0;
932 switch (event) {
933 /*
934 * The three blob events might change the set of admissible files,
935 * so we must reload the score list.
936 */
937 case BLOB_RENAME:
938 case BLOB_REMOVE:
939 case BLOB_ADD:
940 if (data == moods_table || data == playlists_table)
941 return 1; /* no reload necessary for these */
942 return reload_current_mood();
943 /* these also require reload of the score table */
944 case ATTRIBUTE_ADD:
945 case ATTRIBUTE_REMOVE:
946 case ATTRIBUTE_RENAME:
947 return reload_current_mood();
948 /* changes to the aft only require to re-examine the audio file */
949 case AFSI_CHANGE: {
950 struct afsi_change_event_data *aced = data;
951 return mood_update_audio_file(aced->aft_row, aced->old_afsi);
952 }
953 case AFHI_CHANGE:
954 case AUDIO_FILE_RENAME:
955 case AUDIO_FILE_ADD:
956 return mood_update_audio_file(data, NULL);
957 case AUDIO_FILE_REMOVE:
958 return mood_delete_audio_file(data);
959 default:
960 return 1;
961 }
962 }