2 * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
18 /** \file playlist.c Functions for loading and saving playlists. */
20 /** Structure used for adding entries to a playlist. */
21 struct playlist_info {
22 /** The name of the playlist. */
24 /** The number of entries currently in the playlist. */
27 static struct playlist_info current_playlist;
30 * Re-insert an audio file into the tree of admissible files.
32 * \param aft_row Determines the audio file.
34 * \return The return value of score_update().
36 static int playlist_update_audio_file(const struct osl_row *aft_row)
38 /* always re-insert to the top of the tree */
39 return score_update(aft_row, 0);
42 static int add_playlist_entry(char *path, void *data)
44 struct playlist_info *playlist = data;
45 struct osl_row *aft_row;
46 int ret = aft_get_row_of_path(path, &aft_row);
49 PARA_NOTICE_LOG("%s: %s\n", path, para_strerror(-ret));
52 ret = score_add(aft_row, -playlist->length);
54 PARA_ERROR_LOG("failed to add %s: %s\n", path, para_strerror(-ret));
61 /* returns -E_PLAYLIST_LOADED on _success_ to terminate the loop */
62 static int load_playlist(struct osl_row *row, void *data)
64 struct playlist_info *playlist = data;
65 struct osl_object playlist_def;
69 ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
73 ret = for_each_line(FELF_READ_ONLY, playlist_def.data,
74 playlist_def.size, add_playlist_entry, playlist);
75 osl_close_disk_object(&playlist_def);
78 ret = -E_PLAYLIST_EMPTY;
79 if (!playlist->length)
81 playlist->name = para_strdup(playlist_name);
82 PARA_NOTICE_LOG("loaded playlist %s (%u files)\n", playlist->name,
84 return -E_PLAYLIST_LOADED;
86 if (ret != -E_DUMMY_ROW)
87 PARA_NOTICE_LOG("unable to load playlist (%s)\n",
92 static int check_playlist_path(char *path, void *data)
94 struct para_buffer *pb = data;
95 struct osl_row *aft_row;
96 int ret = aft_get_row_of_path(path, &aft_row);
99 para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
100 return 1; /* do not fail the loop on bad paths */
103 static int check_playlist(struct osl_row *row, void *data)
105 struct para_buffer *pb = data;
106 struct osl_object playlist_def;
108 int ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
110 if (ret < 0) { /* log error, but continue */
111 para_printf(pb, "failed to get playlist data: %s\n",
112 para_strerror(-ret));
115 if (*playlist_name) { /* skip dummy row */
116 para_printf(pb, "checking playlist %s...\n", playlist_name);
117 for_each_line(FELF_READ_ONLY, playlist_def.data,
118 playlist_def.size, check_playlist_path, pb);
120 osl_close_disk_object(&playlist_def);
125 * Check the playlist table for inconsistencies.
127 * \param aca This callback ignores ->query.
129 * \return Standard. Invalid paths are reported, but are not considered an
132 int playlist_check_callback(struct afs_callback_arg *aca)
134 para_printf(&aca->pbout, "checking playlists...\n");
135 return osl(osl_rbtree_loop(playlists_table, BLOBCOL_ID, &aca->pbout,
140 * Close the current playlist.
142 * \sa playlist_open().
144 void playlist_close(void)
146 if (!current_playlist.name)
148 free(current_playlist.name);
149 current_playlist.name = NULL;
153 * Open the given playlist.
155 * \param name The name of the playlist to open.
157 * Files which are listed in the playlist, but not contained in the database
158 * are ignored. This is not considered an error.
162 int playlist_open(char *name)
164 struct osl_object obj;
169 obj.size = strlen(obj.data);
170 ret = osl(osl_get_row(playlists_table, BLOBCOL_NAME, &obj, &row));
172 PARA_NOTICE_LOG("failed to load playlist %s\n", name);
176 ret = load_playlist(row, ¤t_playlist);
177 return (ret == -E_PLAYLIST_LOADED)? current_playlist.length : ret;
180 static int search_path(char *path, void *data)
182 if (strcmp(path, data))
184 return -E_PATH_FOUND;
187 static int handle_audio_file_event(enum afs_events event, void *data)
189 int ret, was_admissible = 0, is_admissible;
190 struct osl_object playlist_def;
192 const struct osl_row *row = data;
194 if (event == AUDIO_FILE_RENAME) {
195 ret = row_belongs_to_score_table(row, NULL);
198 was_admissible = ret;
200 ret = get_audio_file_path_of_row(row, &new_path);
203 ret = pl_get_def_by_name(current_playlist.name, &playlist_def);
206 ret = for_each_line(FELF_READ_ONLY, playlist_def.data,
207 playlist_def.size, search_path, new_path);
208 osl_close_disk_object(&playlist_def);
209 is_admissible = (ret < 0);
210 if (was_admissible && is_admissible)
212 if (!was_admissible && !is_admissible)
214 if (was_admissible && !is_admissible) {
215 current_playlist.length--;
216 return score_delete(row);
218 /* !was_admissible && is_admissible */
219 current_playlist.length++;
220 return score_add(row, 0); /* play it immediately */
224 * Handle afs events relevant to playlists.
226 * \param event The event type.
228 * \param data Depends on the event type.
232 int playlists_event_handler(enum afs_events event,
233 __a_unused struct para_buffer *pb, void *data)
236 struct afsi_change_event_data *aced = data;
238 if (!current_playlist.name)
242 return playlist_update_audio_file(aced->aft_row);
243 case AUDIO_FILE_RENAME:
245 return handle_audio_file_event(event, data);
246 case AUDIO_FILE_REMOVE:
247 ret = row_belongs_to_score_table(data, NULL);
252 current_playlist.length--;
253 return score_delete(data);