src/playlist_list.h

   1 /*
   2  * Copyright (C) 2003-2010 The Music Player Daemon Project
   3  * http://www.musicpd.org
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 #ifndef MPD_PLAYLIST_LIST_H
  21 #define MPD_PLAYLIST_LIST_H
  22
  23 struct playlist_provider;
  24 struct input_stream;
  25
  26 /**
  27  * Initializes all playlist plugins.
  28  */
  29 void
  30 playlist_list_global_init(void);
  31
  32 /**
  33  * Deinitializes all playlist plugins.
  34  */
  35 void
  36 playlist_list_global_finish(void);
  37
  38 /**
  39  * Opens a playlist by its URI.
  40  */
  41 struct playlist_provider *
  42 playlist_list_open_uri(const char *uri);
  43
  44 /**
  45  * Opens a playlist from an input stream.
  46  *
  47  * @param is an #input_stream object which is open and ready
  48  * @param uri optional URI which was used to open the stream; may be
  49  * used to select the appropriate playlist plugin
  50  */
  51 struct playlist_provider *
  52 playlist_list_open_stream(struct input_stream *is, const char *uri);
  53
  54 /**
  55  * Opens a playlist from a local file.
  56  *
  57  * @param path_fs the path of the playlist file
  58  * @return a playlist, or NULL on error
  59  */
  60 struct playlist_provider *
  61 playlist_list_open_path(const char *path_fs);
  62
  63 #endif