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