1 /* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
3 /** \file score.c Scoring functions to determine the audio file streaming order. */
15 static struct osl_table *score_table;
17 static int ptr_compare(const struct osl_object *obj1, const struct osl_object *obj2)
19 void *d1 = *(void **)obj1->data;
20 void *d2 = *(void **)obj2->data;
21 return NUM_COMPARE(d1, d2);
25 * This function first compares the score values. If they are equal, the
26 * addresses of the two objects are compared. Thus, the function returns
27 * "equal" only if the two objects alias each other, i.e., point to the same
30 static int score_compare(const struct osl_object *obj1, const struct osl_object *obj2)
32 long d1 = *(long *)obj1->data;
33 long d2 = *(long *)obj2->data;
34 int ret = NUM_COMPARE(d2, d1);
38 return NUM_COMPARE(obj2->data, obj1->data);
42 * The score table consists of two columns: The \a aft_row column contains
43 * pointers to the rows of the audio file table, and the score column contains
44 * the current score of the audio file associated with that row.
46 enum score_table_columns {
47 /** The row of the audio file. */
51 /** This table has two columns */
55 static struct osl_column_description score_cols[] = {
56 [SCORECOL_AFT_ROW] = {
57 .storage_type = OSL_NO_STORAGE,
58 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE | OSL_DONT_FREE,
60 .compare_function = ptr_compare,
61 .data_size = sizeof(void *)
64 .storage_type = OSL_NO_STORAGE,
65 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
67 .compare_function = score_compare,
68 .data_size = sizeof(long)
72 static struct osl_table_description score_table_desc = {
74 .num_columns = NUM_SCORE_COLUMNS,
76 .column_descriptions = score_cols
79 /* On errors (negative return value) the content of score is undefined. */
80 static int get_score_of_row(void *score_row, long *score)
82 struct osl_object obj;
83 int ret = osl(osl_get_object(score_table, score_row, SCORECOL_SCORE, &obj));
86 *score = *(long *)obj.data;
91 * Add an entry to the table of admissible files.
93 * \param aft_row The audio file to be added.
94 * \param score The score for this file.
96 * \return The return value of the underlying call to osl_add_row().
98 int score_add(const struct osl_row *aft_row, long score)
101 struct osl_object score_objs[NUM_SCORE_COLUMNS];
105 size = score_table_desc.column_descriptions[SCORECOL_AFT_ROW].data_size;
106 score_objs[SCORECOL_AFT_ROW].data = (struct osl_row *)aft_row;
107 score_objs[SCORECOL_AFT_ROW].size = size;
109 size = score_table_desc.column_descriptions[SCORECOL_SCORE].data_size;
110 score_objs[SCORECOL_SCORE].data = alloc(size);
111 score_objs[SCORECOL_SCORE].size = size;
112 *(long *)(score_objs[SCORECOL_SCORE].data) = score;
114 // PARA_DEBUG_LOG("adding %p\n", *(void **) (score_objs[SCORECOL_AFT_ROW].data));
115 ret = osl(osl_add_row(score_table, score_objs));
117 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
118 free(score_objs[SCORECOL_SCORE].data);
124 * Replace a row of the score table.
126 * \param aft_row Determines the audio file to change.
127 * \param percent The position to re-insert the audio file.
129 * The percent parameter must be between 0 and 100. A value of zero means to
130 * re-insert the audio file into the score table with a score lower than any
131 * other admissible file.
133 * \return Positive on success, negative on errors.
135 int score_update(const struct osl_row *aft_row, long percent)
137 struct osl_row *row, *rrow; /* score row, reference row */
140 struct osl_object obj = {.data = (struct osl_row *)aft_row,
141 .size = sizeof(aft_row)};
142 int ret = osl(osl_get_row(score_table, SCORECOL_AFT_ROW, &obj, &row));
144 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND)) /* not an error */
148 ret = osl(osl_get_num_rows(score_table, &n));
151 new_pos = 1 + (n - 1) * percent / 100;
152 ret = osl(osl_get_nth_row(score_table, SCORECOL_SCORE, new_pos, &rrow));
155 ret = get_score_of_row(rrow, &new_score);
159 obj.size = sizeof(long);
160 obj.data = alloc(obj.size);
161 *(long *)obj.data = new_score;
162 PARA_DEBUG_LOG("new score: %ld, rank %u/%u\n", new_score, new_pos, n);
163 return osl(osl_update_object(score_table, row, SCORECOL_SCORE, &obj));
167 * Given an admissible file, get the corresponding row in the aft and the score.
169 * \param score_row Determines the admissible file.
170 * \param score Result pointer.
171 * \param aft_row Result pointer.
175 int get_score_and_aft_row(struct osl_row *score_row, long *score,
176 struct osl_row **aft_row)
178 struct osl_object obj;
179 int ret = get_score_of_row(score_row, score);
183 ret = osl(osl_get_object(score_table, score_row, SCORECOL_AFT_ROW, &obj));
190 static int get_score_row_from_aft_row(const struct osl_row *aft_row,
191 struct osl_row **score_row)
193 struct osl_object obj = {.data = (struct osl_row *)aft_row,
194 .size = sizeof(aft_row)};
195 return osl(osl_get_row(score_table, SCORECOL_AFT_ROW, &obj, score_row));
199 * Call the given function for each row of the score table.
201 * \param func Callback, called once per row.
202 * \param data Passed verbatim to the callback.
204 * \return The return value of the underlying call to osl_rbtree_loop(). The
205 * loop terminates early if the callback returns negative.
207 int score_loop(osl_rbtree_loop_func *func, void *data)
209 return osl(osl_rbtree_loop(score_table, SCORECOL_SCORE, data, func));
213 * Get the admissible audio file with highest score.
215 * \param aft_row Points to the row in the aft of the "best" audio file.
216 * \param score Highest score value in the score table.
220 int score_get_best(struct osl_row **aft_row, long *score)
223 struct osl_object obj;
224 int ret = osl(osl_rbtree_last_row(score_table, SCORECOL_SCORE, &row));
228 ret = osl(osl_get_object(score_table, row, SCORECOL_AFT_ROW, &obj));
232 return get_score_of_row(row, score);
236 * Remove an entry from the rbtree of admissible files.
238 * \param aft_row The file which is no longer admissible.
242 * \sa \ref score_add().
244 int score_delete(const struct osl_row *aft_row)
246 struct osl_row *score_row;
247 int ret = get_score_row_from_aft_row(aft_row, &score_row);
251 return osl(osl_del_row(score_table, score_row));
255 * Find out whether an audio file is contained in the score table.
257 * \param aft_row The row of the audio file table.
259 * \return If the lookup operation fails for any other reason than "not found",
260 * the function aborts the current process (afs), since this is considered a
261 * fatal error that should never happen.
263 bool row_belongs_to_score_table(const struct osl_row *aft_row)
265 struct osl_row *score_row;
266 int ret = get_score_row_from_aft_row(aft_row, &score_row);
268 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
274 static void score_close(void)
276 osl_close_table(score_table, OSL_FREE_VOLATILE);
280 static int score_open(__a_unused const char *dir)
282 assert(osl_open_table(&score_table_desc, &score_table) >= 0);
287 * Remove all entries from the score table, but keep the table open.
289 void score_clear(void)
295 /** The score table stores (aft row, score) pairs in memory. */
296 const struct afs_table_operations score_ops = {
298 .close = score_close,