2 * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
13 /** \file playlist.c Functions for loading and saving playlists. */
15 /** Structure used for adding entries to a playlist. */
16 struct playlist_info {
17 /** The name of the playlist. */
19 /** The number of entries currently in the playlist. */
22 static struct playlist_info current_playlist;
25 * Re-insert an audio file into the tree of admissible files.
27 * \param aft_row Determines the audio file.
29 * \return The return value of score_update().
31 static int playlist_update_audio_file(const struct osl_row *aft_row)
33 /* always re-insert to the top of the tree */
34 return score_update(aft_row, 0);
37 static int add_playlist_entry(char *path, void *data)
39 struct playlist_info *playlist = data;
40 struct osl_row *aft_row;
41 int ret = aft_get_row_of_path(path, &aft_row);
44 PARA_NOTICE_LOG("%s: %s\n", path, PARA_STRERROR(-ret));
47 ret = score_add(aft_row, -playlist->length);
49 PARA_ERROR_LOG("failed to add %s: %s\n", path, PARA_STRERROR(-ret));
56 /* returns -E_PLAYLIST_LOADED on _success_ to terminate the loop */
57 static int load_playlist(struct osl_row *row, void *data)
59 struct playlist_info *playlist = data;
60 struct osl_object playlist_def;
64 ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
68 ret = for_each_line_ro(playlist_def.data, playlist_def.size,
69 add_playlist_entry, playlist);
70 osl_close_disk_object(&playlist_def);
73 ret = -E_PLAYLIST_EMPTY;
74 if (!playlist->length)
76 playlist->name = para_strdup(playlist_name);
77 PARA_NOTICE_LOG("loaded playlist %s (%u files)\n", playlist->name,
79 return -E_PLAYLIST_LOADED;
81 if (ret != -E_DUMMY_ROW)
82 PARA_NOTICE_LOG("unable to load playlist (%s)\n",
87 static int check_playlist_path(char *path, void *data)
89 struct para_buffer *pb = data;
90 struct osl_row *aft_row;
91 int ret = aft_get_row_of_path(path, &aft_row);
94 para_printf(pb, "%s: %s\n", path, PARA_STRERROR(-ret));
98 static int check_playlist(struct osl_row *row, void *data)
100 struct para_buffer *pb = data;
101 struct osl_object playlist_def;
103 int ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
106 para_printf(pb, "failed to get playlist data: %s\n",
107 PARA_STRERROR(-ret));
110 if (*playlist_name) { /* skip dummy row */
111 para_printf(pb, "checking playlist %s...\n", playlist_name);
112 for_each_line_ro(playlist_def.data, playlist_def.size,
113 check_playlist_path, pb);
115 osl_close_disk_object(&playlist_def);
120 * Check the playlist table for inconsistencies.
122 * \param query Unused.
123 * \param result Contains messages about inconsistencies.
125 * \return The return value of the underlying call to osl_rbtree_loop().
127 int playlist_check_callback(__a_unused const struct osl_object *query,
128 struct osl_object *result)
130 struct para_buffer pb = {.buf = NULL};
132 para_printf(&pb, "checking playlists...\n");
133 osl_rbtree_loop(playlists_table, BLOBCOL_ID, &pb,
135 result->data = pb.buf;
136 result->size = pb.size;
141 * Close the current playlist.
143 * \sa playlist_open().
145 void playlist_close(void)
147 if (!current_playlist.name)
149 free(current_playlist.name);
150 current_playlist.name = NULL;
154 * Open the given playlist.
156 * \param name The name of the playlist to open.
158 * Files which are listed in the playlist, but not contained in the database
159 * are ignored. This is not considered an error.
163 int playlist_open(char *name)
165 struct osl_object obj;
170 obj.size = strlen(obj.data);
171 ret = osl_get_row(playlists_table, BLOBCOL_NAME, &obj, &row);
173 PARA_NOTICE_LOG("failed to load playlist %s\n", name);
177 ret = load_playlist(row, ¤t_playlist);
178 return (ret == -E_PLAYLIST_LOADED)? current_playlist.length : ret;
181 static int search_path(char *path, void *data)
183 if (strcmp(path, data))
185 return -E_PATH_FOUND;
188 static int handle_audio_file_event(enum afs_events event, void *data)
190 int ret, was_admissible = 0, is_admissible;
191 struct osl_object playlist_def;
193 const struct osl_row *row = data;
195 if (!current_playlist.name)
197 if (event == AUDIO_FILE_RENAME) {
198 ret = row_belongs_to_score_table(row, NULL);
201 was_admissible = ret;
203 ret = get_audio_file_path_of_row(row, &new_path);
206 ret = pl_get_def_by_name(current_playlist.name, &playlist_def);
209 ret = for_each_line_ro(playlist_def.data, playlist_def.size,
210 search_path, new_path);
211 osl_close_disk_object(&playlist_def);
212 is_admissible = (ret < 0);
213 if (was_admissible && is_admissible)
215 if (!was_admissible && !is_admissible)
217 if (was_admissible && !is_admissible) {
218 current_playlist.length--;
219 return score_delete(row);
221 /* !was_admissible && is_admissible */
222 current_playlist.length++;
223 return score_add(row, 0); /* play it immediately */
227 * Handle afs events relevant to playlists.
229 * \param event The event type.
231 * \param data Depends on the event type.
235 int playlists_event_handler(enum afs_events event,
236 __a_unused struct para_buffer *pb, void *data)
239 struct afsi_change_event_data *aced = data;
243 return playlist_update_audio_file(aced->aft_row);
244 case AUDIO_FILE_RENAME:
246 return handle_audio_file_event(event, data);
247 case AUDIO_FILE_REMOVE:
248 ret = row_belongs_to_score_table(data, NULL);
253 current_playlist.length--;
254 return score_delete(data);