]> git.tuebingen.mpg.de Git - paraslash.git/blob - mood.c
Rename mood_switch(), mood_close(), playlist_{open/close}.
[paraslash.git] / mood.c
1 /* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
2
3 /** \file mood.c Paraslash's mood handling functions. */
4
5 #include <regex.h>
6 #include <osl.h>
7 #include <lopsub.h>
8
9 #include "para.h"
10 #include "error.h"
11 #include "string.h"
12 #include "afh.h"
13 #include "afs.h"
14 #include "list.h"
15
16 /*
17  * Mood parser API. It's overkill to have an own header file for
18  * these declarations as they are only needed in this .c file.
19  */
20 struct mp_context;
21 int mp_init(const char *definition, int nbytes, struct mp_context **result,
22                  char **errmsg);
23 bool mp_eval_row(const struct osl_row *aft_row, struct mp_context *ctx);
24 void mp_shutdown(struct mp_context *ctx);
25
26 /**
27  * Contains statistical data of the currently admissible audio files.
28  *
29  * It is used to assign normalized score values to each admissible audio file.
30  */
31 struct afs_statistics {
32         /** Sum of num played over all admissible files. */
33         int64_t num_played_sum;
34         /** Sum of last played times over all admissible files. */
35         int64_t last_played_sum;
36         /** Quadratic deviation of num played count. */
37         int64_t num_played_qd;
38         /** Quadratic deviation of last played time. */
39         int64_t last_played_qd;
40         /** Correction factor for the num played score. */
41         int64_t num_played_correction;
42         /** Correction factor for the last played score. */
43         int64_t last_played_correction;
44         /** Common divisor of the correction factors. */
45         int64_t normalization_divisor;
46         /** Number of admissible files */
47         unsigned num;
48 };
49
50 /**
51  * Stores an instance of a loaded mood (parser and statistics).
52  *
53  * A structure of this type is allocated and initialized when a mood is loaded.
54  */
55 struct mood_instance {
56         /** NULL means that this is the "dummy" mood. */
57         char *name;
58         /** Bison's abstract syntax tree, used to determine admissibility. */
59         struct mp_context *parser_context;
60         /** To compute the score. */
61         struct afs_statistics stats;
62 };
63
64 /*
65  * If current_mood is NULL then no mood is currently loaded. If
66  * current_mood->name is NULL, the current mood is the dummy mood.
67  *
68  * The statistics are adjusted dynamically through this pointer as files are
69  * added, removed or played.
70  */
71 static struct mood_instance *current_mood;
72
73 /*
74  * Find the position of the most-significant set bit.
75  *
76  * Copied and slightly adapted from the linux source tree, version 4.9.39
77  * (2017-07).
78  */
79 __a_const static uint32_t fls64(uint64_t v)
80 {
81         int n = 63;
82         const uint64_t ones = ~(uint64_t)0U;
83
84         if ((v & (ones << 32)) == 0) {
85                 n -= 32;
86                 v <<= 32;
87         }
88         if ((v & (ones << (64 - 16))) == 0) {
89                 n -= 16;
90                 v <<= 16;
91         }
92         if ((v & (ones << (64 - 8))) == 0) {
93                 n -= 8;
94                 v <<= 8;
95         }
96         if ((v & (ones << (64 - 4))) == 0) {
97                 n -= 4;
98                 v <<= 4;
99         }
100         if ((v & (ones << (64 - 2))) == 0) {
101                 n -= 2;
102                 v <<= 2;
103         }
104         if ((v & (ones << (64 - 1))) == 0)
105                 n -= 1;
106         return n;
107 }
108
109 /*
110  * Compute the integer square root floor(sqrt(x)).
111  *
112  * Taken 2007 from the linux source tree.
113  */
114 __a_const static uint64_t int_sqrt(uint64_t x)
115 {
116         uint64_t op = x, res = 0, one = 1;
117
118         one = one << (fls64(x) & ~one);
119         while (one != 0) {
120                 if (op >= res + one) {
121                         op = op - (res + one);
122                         res = res + 2 * one;
123                 }
124                 res /= 2;
125                 one /= 4;
126         }
127         return res;
128 }
129
130 static void destroy_mood(struct mood_instance *m)
131 {
132         if (!m)
133                 return;
134         mp_shutdown(m->parser_context);
135         free(m->name);
136         free(m);
137 }
138
139 static struct mood_instance *alloc_new_mood(const char *name)
140 {
141         struct mood_instance *m = zalloc(sizeof(*m));
142
143         if (name)
144                 m->name = para_strdup(name);
145         m->stats.normalization_divisor = 1;
146         return m;
147 }
148
149 static int init_mood_parser(const char *mood_name, struct mood_instance **m,
150                 char **err)
151 {
152         struct osl_object mood_def;
153         int ret;
154
155         if (!*mood_name) {
156                 if (err)
157                         *err = make_message("empty mood name\n");
158                 return -ERRNO_TO_PARA_ERROR(EINVAL);
159         }
160         ret = mood_get_def_by_name(mood_name, &mood_def);
161         if (ret < 0) {
162                 if (err)
163                         *err = make_message("could not read mood definition\n");
164                 return ret;
165         }
166         *m = alloc_new_mood(mood_name);
167         PARA_INFO_LOG("loading mood %s\n", mood_name);
168         ret = mp_init(mood_def.data, mood_def.size, &(*m)->parser_context, err);
169         osl_close_disk_object(&mood_def);
170         if (ret < 0)
171                 destroy_mood(*m);
172         return ret;
173 }
174
175 static int check_mood(struct osl_row *mood_row, void *data)
176 {
177         struct para_buffer *pb = data;
178         char *mood_name, *errmsg;
179         struct osl_object mood_def;
180         struct mood_instance *m;
181         int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
182
183         if (ret < 0) {
184                 para_printf(pb, "cannot read mood\n");
185                 return ret;
186         }
187         if (!*mood_name) /* ignore dummy row */
188                 goto out;
189         m = alloc_new_mood("check");
190         ret = mp_init(mood_def.data, mood_def.size, &m->parser_context,
191                 &errmsg);
192         if (ret < 0) {
193                 para_printf(pb, "%s: %s\n", mood_name, errmsg);
194                 free(errmsg);
195                 para_printf(pb, "%s\n", para_strerror(-ret));
196         } else
197                 destroy_mood(m);
198         ret = 1; /* don't fail the loop on invalid mood definitions */
199 out:
200         osl_close_disk_object(&mood_def);
201         return ret;
202 }
203
204 /**
205  * Check all moods for syntax errors.
206  *
207  * \param aca Only ->pbout is used for diagnostics.
208  *
209  * \return Negative on fatal errors. Inconsistent mood definitions are not
210  * considered an error.
211  */
212 int mood_check_callback(struct afs_callback_arg *aca)
213 {
214         para_printf(&aca->pbout, "checking moods...\n");
215         return osl(osl_rbtree_loop(moods_table, BLOBCOL_ID, &aca->pbout,
216                 check_mood));
217 }
218
219 /*
220  * The normalized num_played and last_played values are defined as
221  *
222  *      nn := -(np - mean_n) / sigma_n and nl := -(lp - mean_l) / sigma_l
223  *
224  *  For a (hypothetical) file with np = 0 and lp = now we thus have
225  *
226  *      nn =  mean_n / sigma_n =: hn > 0
227  *      nl = -(now - mean_l) / sigma_l =: hl < 0
228  *
229  * We design the score function so that both contributions get the same
230  * weight. Define the np and lp score of an arbitrary file as
231  *
232  *      sn := nn * -hl and sl := nl * hn
233  *
234  * Example:
235  *      num_played mean/sigma: 87/14
236  *      last_played mean/sigma: 45/32 days
237  *
238  *      We have hn = 87 / 14 = 6.21 and hl = -45 / 32 = -1.41. Multiplying
239  *      nn of every file with the correction factor 1.41 and nl with
240  *      6.21 makes the weight of the two contributions equal.
241  *
242  * The total score s := sn + sl has the representation
243  *
244  *      s = -cn * (np - mean_n) - cl * (lp - mean_l)
245  *
246  * with positive correction factors
247  *
248  *      cn = (now - mean_l) / (sqrt(ql) * sqrt(qn) / n)
249  *      cl = mean_n / (sqrt(ql) * sqrt(qn) / n)
250  *
251  * where ql and qn are the quadratic deviations stored in the statistics
252  * structure and n is the number of admissible files. To avoid integer
253  * overflows and rounding errors we store the common divisor of the
254  * correction factors separately.
255  */
256 static int64_t normalized_value(int64_t x, int64_t n, int64_t sum, int64_t qd)
257 {
258         if (!n || !qd)
259                 return 0;
260         return 100 * (n * x - sum) / (int64_t)int_sqrt(n) / (int64_t)int_sqrt(qd);
261 }
262
263 static long compute_score(struct afs_info *afsi,
264                 const struct afs_statistics *stats)
265 {
266         long score = -normalized_value(afsi->num_played, stats->num,
267                 stats->num_played_sum, stats->num_played_qd);
268         score -= normalized_value(afsi->last_played, stats->num,
269                 stats->last_played_sum, stats->last_played_qd);
270         return score / 2;
271 }
272
273 static int add_afs_statistics(const struct osl_row *row,
274                 struct afs_statistics *stats)
275 {
276         uint64_t n, x, s, q;
277         struct afs_info afsi;
278         int ret;
279
280         ret = get_afsi_of_row(row, &afsi);
281         if (ret < 0)
282                 return ret;
283         n = stats->num;
284         x = afsi.last_played;
285         s = stats->last_played_sum;
286         if (n > 0) {
287                 q = (x > s / n)? x - s / n : s / n - x;
288                 stats->last_played_qd += q * q * n / (n + 1);
289         }
290         stats->last_played_sum += x;
291
292         x = afsi.num_played;
293         s = stats->num_played_sum;
294         if (n > 0) {
295                 q = (x > s / n)? x - s / n : s / n - x;
296                 stats->num_played_qd += q * q * n / (n + 1);
297         }
298         stats->num_played_sum += x;
299         stats->num++;
300         return 1;
301 }
302
303 static int del_afs_statistics(const struct osl_row *row)
304 {
305         struct afs_statistics *stats = &current_mood->stats;
306         uint64_t n, s, q, a, new_s;
307         struct afs_info afsi;
308         int ret;
309         ret = get_afsi_of_row(row, &afsi);
310         if (ret < 0)
311                 return ret;
312         n = stats->num;
313         assert(n);
314         if (n == 1) {
315                 memset(stats, 0, sizeof(*stats));
316                 stats->normalization_divisor = 1;
317                 return 1;
318         }
319
320         s = stats->last_played_sum;
321         q = stats->last_played_qd;
322         a = afsi.last_played;
323         new_s = s - a;
324         stats->last_played_sum = new_s;
325         stats->last_played_qd = q + s * s / n - a * a
326                 - new_s * new_s / (n - 1);
327
328         s = stats->num_played_sum;
329         q = stats->num_played_qd;
330         a = afsi.num_played;
331         new_s = s - a;
332         stats->num_played_sum = new_s;
333         stats->num_played_qd = q + s * s / n - a * a
334                 - new_s * new_s / (n - 1);
335
336         stats->num--;
337         return 1;
338 }
339
340 /*
341  * At mood load time we determine the set of admissible files for the given
342  * mood where each file is identified by a pointer to a row of the audio file
343  * table. In the first pass the pointers are added to a temporary array and
344  * statistics are computed. When all admissible files have been processed in
345  * this way, the score of each admissible file is computed and the (row, score)
346  * pair is added to the score table. This has to be done in a second pass
347  * since the score depends on the statistics. Finally, the array is freed.
348  */
349 struct admissible_array {
350         /** Files are admissible wrt. this mood. */
351         struct mood_instance *m;
352         /** The size of the array */
353         unsigned size;
354         /** Pointer to the array of admissible files. */
355         struct osl_row **array;
356 };
357
358 /*
359  * Check whether the given audio file is admissible. If it is, add it to array
360  * of admissible files.
361  */
362 static int add_if_admissible(struct osl_row *aft_row, void *data)
363 {
364         struct admissible_array *aa = data;
365         struct afs_statistics *stats = &aa->m->stats;
366
367         if (!mp_eval_row(aft_row, aa->m->parser_context))
368                 return 0;
369         if (stats->num >= aa->size) {
370                 aa->size *= 2;
371                 aa->size += 100;
372                 aa->array = arr_realloc(aa->array, aa->size,
373                         sizeof(struct osl_row *));
374         }
375         aa->array[stats->num] = aft_row;
376         return add_afs_statistics(aft_row, stats);
377 }
378
379 /**
380  * Compute the new quadratic deviation in case one element changes.
381  *
382  * \param n Number of elements.
383  * \param old_qd The quadratic deviation before the change.
384  * \param old_val The value that was replaced.
385  * \param new_val The replacement value.
386  * \param old_sum The sum of all elements before the update.
387  *
388  * \return The new quadratic deviation resulting from replacing old_val
389  * by new_val.
390  *
391  * Given n real numbers a_1, ..., a_n, their sum S = a_1 + ... + a_n,
392  * their quadratic deviation
393  *
394  * q = (a_1 - S/n)^2 + ... + (a_n - S/n)^2,
395  *
396  * and a real number b, the quadratic deviation q' of a_1,...a_{n-1}, b (ie.
397  * the last number a_n was replaced by b) may be computed in O(1) time in terms
398  * of n, q, a_n, b, and S as
399  *
400  *      q' = q + d * s - (2 * S + d) * d / n
401  *         = q + d * (s - 2 * S / n - d /n),
402  *
403  * where d = b - a_n, and s = b + a_n.
404  *
405  * Example: n = 3, a_1 = 3, a_2 = 5, a_3 = 7, b = 10. Then S = 15, q = 8, d = 3,
406  * s = 17, so
407  *
408  *      q + d * s - (2 * S + d) * d / n = 8 + 51 - 33 = 26,
409  *
410  * which equals q' = (3 - 6)^2 + (5 - 6)^2 + (10 - 6)^2.
411  *
412  */
413 _static_inline_ int64_t update_quadratic_deviation(int64_t n, int64_t old_qd,
414                 int64_t old_val, int64_t new_val, int64_t old_sum)
415 {
416         int64_t delta = new_val - old_val;
417         int64_t sigma = new_val + old_val;
418         return old_qd + delta * (sigma - 2 * old_sum / n - delta / n);
419 }
420
421 static void update_afs_statistics(struct afs_info *old_afsi,
422                 struct afs_info *new_afsi)
423 {
424         struct afs_statistics *stats = &current_mood->stats;
425
426         assert(stats->num > 0);
427         stats->last_played_qd = update_quadratic_deviation(stats->num,
428                 stats->last_played_qd, old_afsi->last_played,
429                 new_afsi->last_played, stats->last_played_sum);
430         stats->last_played_sum += new_afsi->last_played - old_afsi->last_played;
431
432         stats->num_played_qd = update_quadratic_deviation(stats->num,
433                 stats->num_played_qd, old_afsi->num_played,
434                 new_afsi->num_played, stats->num_played_sum);
435         stats->num_played_sum += new_afsi->num_played - old_afsi->num_played;
436 }
437
438 static int add_to_score_table(const struct osl_row *aft_row,
439                 const struct afs_statistics *stats)
440 {
441         long score;
442         struct afs_info afsi;
443         int ret = get_afsi_of_row(aft_row, &afsi);
444
445         if (ret < 0)
446                 return ret;
447         score = compute_score(&afsi, stats);
448         return score_add(aft_row, score);
449 }
450
451 static int delete_from_statistics_and_score_table(const struct osl_row *aft_row)
452 {
453         int ret = del_afs_statistics(aft_row);
454         if (ret < 0)
455                 return ret;
456         return score_delete(aft_row);
457 }
458
459 /**
460  * Delete an audio file from the score table and update mood statistics.
461  *
462  * \param aft_row Identifies the row to delete.
463  *
464  * \return Standard.
465  *
466  * \sa \ref score_delete().
467  */
468 static int mood_delete_audio_file(const struct osl_row *aft_row)
469 {
470         if (!row_belongs_to_score_table(aft_row))
471                 return 0;
472         return delete_from_statistics_and_score_table(aft_row);
473 }
474
475 /**
476  * Compute the new score of an audio file wrt. the current mood.
477  *
478  * \param aft_row Determines the audio file.
479  * \param old_afsi The audio file selector info before updating.
480  *
481  * The \a old_afsi argument may be \p NULL which indicates that no changes to
482  * the audio file info were made.
483  *
484  * \return Positive on success, negative on errors.
485  */
486 static int mood_update_audio_file(const struct osl_row *aft_row,
487                 struct afs_info *old_afsi)
488 {
489         long score, percent;
490         int ret;
491         bool is_admissible, was_admissible;
492         struct afs_info afsi;
493
494         if (!current_mood)
495                 return 1; /* nothing to do */
496         was_admissible = row_belongs_to_score_table(aft_row);
497         is_admissible = mp_eval_row(aft_row, current_mood->parser_context);
498         if (!was_admissible && !is_admissible)
499                 return 1;
500         if (was_admissible && !is_admissible)
501                 return delete_from_statistics_and_score_table(aft_row);
502         if (!was_admissible && is_admissible) {
503                 ret = add_afs_statistics(aft_row, &current_mood->stats);
504                 if (ret < 0)
505                         return ret;
506                 return add_to_score_table(aft_row, &current_mood->stats);
507         }
508         /* update score */
509         ret = get_afsi_of_row(aft_row, &afsi);
510         if (ret < 0)
511                 return ret;
512         if (old_afsi)
513                 update_afs_statistics(old_afsi, &afsi);
514         score = compute_score(&afsi, &current_mood->stats);
515         PARA_DEBUG_LOG("score: %li\n", score);
516         percent = (score + 100) / 3;
517         if (percent > 100)
518                 percent = 100;
519         else if (percent < 0)
520                 percent = 0;
521         PARA_DEBUG_LOG("moving to %li%%\n", percent);
522         return score_update(aft_row, percent);
523 }
524
525 /* sse: seconds since epoch. */
526 static char *get_statistics(struct mood_instance *m, int64_t sse)
527 {
528         unsigned n = m->stats.num;
529         int mean_days, sigma_days;
530
531         mean_days = (sse - m->stats.last_played_sum / n) / 3600 / 24;
532         sigma_days = int_sqrt(m->stats.last_played_qd / n) / 3600 / 24;
533         return make_message(
534                 "loaded mood %s (%u files)\n"
535                 "last_played mean/sigma: %d/%d days\n"
536                 "num_played mean/sigma: %" PRId64 "/%" PRIu64 "\n"
537         ,
538                 m->name? m->name : "(dummy)",
539                 n,
540                 mean_days, sigma_days,
541                 m->stats.num_played_sum / n,
542                         int_sqrt(m->stats.num_played_qd / n)
543         );
544 }
545
546 /** Free all resources of the current mood, if any. */
547 void mood_unload(void)
548 {
549         destroy_mood(current_mood);
550         current_mood = NULL;
551 }
552
553 static void compute_correction_factors(int64_t sse, struct afs_statistics *s)
554 {
555         if (s->num > 0) {
556                 s->normalization_divisor = int_sqrt(s->last_played_qd)
557                         * int_sqrt(s->num_played_qd) / s->num / 100;
558                 s->num_played_correction = sse - s->last_played_sum / s->num;
559                 s->last_played_correction = s->num_played_sum / s->num;
560         }
561         if (s->num_played_correction == 0)
562                 s->num_played_correction = 1;
563         if (s->normalization_divisor == 0)
564                 s->normalization_divisor = 1;
565         if (s->last_played_correction == 0)
566                 s->last_played_correction = 1;
567 }
568
569 /**
570  * Change the current mood.
571  *
572  * \param mood_name The name of the mood to load.
573  * \param msg Error message or mood info is returned here.
574  *
575  * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
576  * and uses a scoring method based only on the \a last_played information.
577  *
578  * If the message pointer is not NULL, a suitable message is returned there in
579  * all cases. The caller must free this string.
580  *
581  * \return The number of admissible files on success, negative on errors. It is
582  * not considered an error if no files are admissible.
583  *
584  * \sa struct \ref afs_info::last_played, \ref mp_eval_row().
585  */
586 int mood_load(const char *mood_name, char **msg)
587 {
588         int i, ret;
589         struct admissible_array aa = {.size = 0};
590         /*
591          * We can not use the "now" pointer from sched.c here because we are
592          * called before schedule(), which initializes "now".
593          */
594         struct timeval rnow;
595
596         if (mood_name) {
597                 ret = init_mood_parser(mood_name, &aa.m, msg);
598                 if (ret < 0)
599                         return ret;
600         } else /* load dummy mood */
601                 aa.m = alloc_new_mood(NULL);
602         PARA_NOTICE_LOG("computing statistics of admissible files\n");
603         ret = audio_file_loop(&aa, add_if_admissible);
604         if (ret < 0) {
605                 if (msg) /* false if we are called via the event handler */
606                         *msg = make_message("audio file loop failed\n");
607                 goto out;
608         }
609         clock_get_realtime(&rnow);
610         compute_correction_factors(rnow.tv_sec, &aa.m->stats);
611         if (aa.m->stats.num == 0) {
612                 if (msg)
613                         *msg = make_message("no admissible files\n");
614                 ret = 0;
615                 goto out;
616         }
617         for (i = 0; i < aa.m->stats.num; i++) {
618                 ret = add_to_score_table(aa.array[i], &aa.m->stats);
619                 if (ret < 0) {
620                         if (msg)
621                                 *msg = make_message(
622                                         "could not add row to score table\n");
623                         goto out;
624                 }
625         }
626         /* success */
627         if (msg)
628                 *msg = get_statistics(aa.m, rnow.tv_sec);
629         ret = aa.m->stats.num;
630         mood_unload();
631         current_mood = aa.m;
632 out:
633         free(aa.array);
634         if (ret < 0)
635                 destroy_mood(aa.m);
636         return ret;
637 }
638
639 /*
640  * Empty the score table and start over.
641  *
642  * This function is called on events which render the current list of
643  * admissible files useless, for example if an attribute is removed from the
644  * attribute table.
645  */
646 static int reload_current_mood(void)
647 {
648         int ret;
649         char *mood_name = NULL;
650
651         assert(current_mood);
652         score_clear();
653         PARA_NOTICE_LOG("reloading %s\n", current_mood->name?
654                 current_mood->name : "(dummy)");
655         if (current_mood->name)
656                 mood_name = para_strdup(current_mood->name);
657         mood_unload();
658         ret = mood_load(mood_name, NULL);
659         free(mood_name);
660         return ret;
661 }
662
663 /**
664  * Notification callback for the moods table.
665  *
666  * \param event Type of the event just occurred.
667  * \param pb Unused.
668  * \param data Its type depends on the event.
669  *
670  * This function updates the score table according to the event that has
671  * occurred. Two actions are possible: (a) reload the current mood, or (b)
672  * add/remove/update the row of the score table which corresponds to the audio
673  * file that has been modified or whose afs info has been changed. It depends
674  * on the type of the event which action (if any) is performed.
675  *
676  * The callbacks of command handlers such as com_add() or com_touch() which
677  * modify the audio file table call this function. The virtual streaming system
678  * also calls this after it has updated the afs info of the file it is about to
679  * stream (the one with the highest score). If the file stays admissible, its
680  * score is recomputed so that a different file is picked next time.
681  *
682  * \return Standard.
683  */
684 int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb,
685                 void *data)
686 {
687         if (!current_mood)
688                 return 0;
689         switch (event) {
690         /*
691          * The three blob events might change the set of admissible files,
692          * so we must reload the score list.
693          */
694         case BLOB_RENAME:
695         case BLOB_REMOVE:
696         case BLOB_ADD:
697                 if (data == moods_table || data == playlists_table)
698                         return 1; /* no reload necessary for these */
699                 return reload_current_mood();
700         /* these also require reload of the score table */
701         case ATTRIBUTE_ADD:
702         case ATTRIBUTE_REMOVE:
703         case ATTRIBUTE_RENAME:
704                 return reload_current_mood();
705         /* changes to the aft only require to re-examine the audio file */
706         case AFSI_CHANGE: {
707                 struct afsi_change_event_data *aced = data;
708                 return mood_update_audio_file(aced->aft_row, aced->old_afsi);
709                 }
710         case AFHI_CHANGE:
711         case AUDIO_FILE_RENAME:
712         case AUDIO_FILE_ADD:
713                 return mood_update_audio_file(data, NULL);
714         case AUDIO_FILE_REMOVE:
715                 return mood_delete_audio_file(data);
716         default:
717                 return 1;
718         }
719 }