1 /* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
15 /** \file playlist.c Functions for loading and saving playlists. */
17 /** Structure used for adding entries to a playlist. */
18 struct playlist_info {
19 /** The name of the playlist. */
21 /** The number of entries currently in the playlist. */
24 static struct playlist_info current_playlist;
27 * Re-insert an audio file into the tree of admissible files.
29 * \param aft_row Determines the audio file.
31 * \return The return value of score_update().
33 static int playlist_update_audio_file(const struct osl_row *aft_row)
35 /* always re-insert to the top of the tree */
36 return score_update(aft_row, 0);
39 static int add_playlist_entry(char *path, void *data)
41 struct playlist_info *playlist = data;
42 struct osl_row *aft_row;
43 int ret = aft_get_row_of_path(path, &aft_row);
46 PARA_NOTICE_LOG("%s: %s\n", path, para_strerror(-ret));
49 ret = score_add(aft_row, -playlist->length);
51 PARA_ERROR_LOG("failed to add %s: %s\n", path, para_strerror(-ret));
58 /* returns -E_PLAYLIST_LOADED on _success_ to terminate the loop */
59 static int load_playlist(struct osl_row *row, void *data)
61 struct playlist_info *playlist = data;
62 struct osl_object playlist_def;
66 ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
70 ret = for_each_line(FELF_READ_ONLY, playlist_def.data,
71 playlist_def.size, add_playlist_entry, playlist);
72 osl_close_disk_object(&playlist_def);
75 ret = -E_PLAYLIST_EMPTY;
76 if (!playlist->length)
78 playlist->name = para_strdup(playlist_name);
79 PARA_NOTICE_LOG("loaded playlist %s (%u files)\n", playlist->name,
81 return -E_PLAYLIST_LOADED;
83 if (ret != -E_DUMMY_ROW)
84 PARA_NOTICE_LOG("unable to load playlist (%s)\n",
89 static int check_playlist_path(char *path, void *data)
91 struct para_buffer *pb = data;
92 struct osl_row *aft_row;
93 int ret = aft_get_row_of_path(path, &aft_row);
96 para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
97 return 1; /* do not fail the loop on bad paths */
100 static int check_playlist(struct osl_row *row, void *data)
102 struct para_buffer *pb = data;
103 struct osl_object playlist_def;
105 int ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
107 if (ret < 0) { /* log error, but continue */
108 para_printf(pb, "failed to get playlist data: %s\n",
109 para_strerror(-ret));
112 if (*playlist_name) { /* skip dummy row */
113 para_printf(pb, "checking playlist %s...\n", playlist_name);
114 for_each_line(FELF_READ_ONLY, playlist_def.data,
115 playlist_def.size, check_playlist_path, pb);
117 osl_close_disk_object(&playlist_def);
122 * Check the playlist table for inconsistencies.
124 * \param aca This callback ignores ->query.
126 * \return Standard. Invalid paths are reported, but are not considered an
129 int playlist_check_callback(struct afs_callback_arg *aca)
131 para_printf(&aca->pbout, "checking playlists...\n");
132 return osl(osl_rbtree_loop(playlists_table, BLOBCOL_ID, &aca->pbout,
137 * Close the current playlist.
139 * \sa \ref playlist_open().
141 void playlist_close(void)
143 if (!current_playlist.name)
145 free(current_playlist.name);
146 current_playlist.name = NULL;
150 * Open the given playlist.
152 * \param name The name of the playlist to open.
154 * Files which are listed in the playlist, but not contained in the database
155 * are ignored. This is not considered an error.
159 int playlist_open(const char *name)
161 struct osl_object obj;
165 obj.data = (char *)name;
166 obj.size = strlen(obj.data);
167 ret = osl(osl_get_row(playlists_table, BLOBCOL_NAME, &obj, &row));
169 PARA_NOTICE_LOG("failed to load playlist %s\n", name);
173 ret = load_playlist(row, ¤t_playlist);
174 return (ret == -E_PLAYLIST_LOADED)? current_playlist.length : ret;
177 static int search_path(char *path, void *data)
179 if (strcmp(path, data))
181 return -E_PATH_FOUND;
184 static int handle_audio_file_event(enum afs_events event, void *data)
187 bool was_admissible = false, is_admissible;
188 struct osl_object playlist_def;
190 const struct osl_row *row = data;
192 if (event == AUDIO_FILE_RENAME) {
193 ret = row_belongs_to_score_table(row, NULL);
196 was_admissible = ret;
198 ret = get_audio_file_path_of_row(row, &new_path);
201 ret = pl_get_def_by_name(current_playlist.name, &playlist_def);
204 ret = for_each_line(FELF_READ_ONLY, playlist_def.data,
205 playlist_def.size, search_path, new_path);
206 osl_close_disk_object(&playlist_def);
207 is_admissible = (ret < 0);
208 if (was_admissible && is_admissible)
210 if (!was_admissible && !is_admissible)
212 if (was_admissible && !is_admissible) {
213 current_playlist.length--;
214 return score_delete(row);
216 /* !was_admissible && is_admissible */
217 current_playlist.length++;
218 return score_add(row, 0); /* play it immediately */
222 * Handle afs events relevant to playlists.
224 * \param event The event type.
226 * \param data Depends on the event type.
230 int playlists_event_handler(enum afs_events event,
231 __a_unused struct para_buffer *pb, void *data)
234 struct afsi_change_event_data *aced = data;
236 if (!current_playlist.name)
240 return playlist_update_audio_file(aced->aft_row);
241 case AUDIO_FILE_RENAME:
243 return handle_audio_file_event(event, data);
244 case AUDIO_FILE_REMOVE:
245 ret = row_belongs_to_score_table(data, NULL);
250 current_playlist.length--;
251 return score_delete(data);