src/playlist.h

   1 /* the Music Player Daemon (MPD)
   2  * Copyright (C) 2003-2007 by Warren Dukes (warren.dukes@gmail.com)
   3  * This project's homepage is: 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  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 #ifndef PLAYLIST_H
  20 #define PLAYLIST_H
  21
  22 #include "../config.h"
  23
  24 #include "dbUtils.h"
  25
  26 #include <stdio.h>
  27 #include <sys/param.h>
  28 #include <time.h>
  29
  30 #define PLAYLIST_FILE_SUFFIX    "m3u"
  31 #define PLAYLIST_COMMENT        '#'
  32
  33 typedef struct _Playlist {
  34         Song **songs;
  35         /* holds version a song was modified on */
  36         mpd_uint32 *songMod;
  37         int *order;
  38         int *positionToId;
  39         int *idToPosition;
  40         int length;
  41         int current;
  42         int queued;
  43         int repeat;
  44         int random;
  45         mpd_uint32 version;
  46         mpd_uint32 queueversion;
  47 } Playlist;
  48
  49 extern int playlist_saveAbsolutePaths;
  50
  51 void initPlaylist(void);
  52
  53 void finishPlaylist(void);
  54
  55 void readPlaylistState(FILE *);
  56
  57 void savePlaylistState(FILE *);
  58
  59 int clearPlaylist(int fd);
  60
  61 int clearStoredPlaylist(int fd, char *utf8file);
  62
  63 int addToPlaylist(int fd, char *file, int printId);
  64
  65 int addToStoredPlaylist(int fd, char *file, char *utf8file);
  66
  67 int addSongToPlaylist(int fd, Song * song, int printId);
  68
  69 int showPlaylist(int fd);
  70
  71 int deleteFromPlaylist(int fd, int song);
  72
  73 int deleteFromPlaylistById(int fd, int song);
  74
  75 int playlistInfo(int fd, int song);
  76
  77 int playlistId(int fd, int song);
  78
  79 int stopPlaylist(int fd);
  80
  81 int playPlaylist(int fd, int song, int stopOnError);
  82
  83 int playNextPlaylistQueue(int fd, int stopOnError);
  84
  85 int playPlaylistById(int fd, int song, int stopOnError);
  86
  87 int nextSongInPlaylist(int fd);
  88
  89 void syncPlayerAndPlaylist(void);
  90
  91 int previousSongInPlaylist(int fd);
  92
  93 int shufflePlaylist(int fd);
  94
  95 int savePlaylist(int fd, char *utf8file);
  96
  97 int deletePlaylist(int fd, char *utf8file);
  98
  99 int deletePlaylistById(int fd, char *utf8file);
 100
 101 void deleteASongFromPlaylist(Song * song);
 102
 103 int moveSongInPlaylist(int fd, int from, int to);
 104
 105 int moveSongInPlaylistById(int fd, int id, int to);
 106
 107 int swapSongsInPlaylist(int fd, int song1, int song2);
 108
 109 int swapSongsInPlaylistById(int fd, int id1, int id2);
 110
 111 int loadPlaylist(int fd, char *utf8file);
 112
 113 int getPlaylistRepeatStatus(void);
 114
 115 int setPlaylistRepeatStatus(int fd, int status);
 116
 117 int getPlaylistRandomStatus(void);
 118
 119 int setPlaylistRandomStatus(int fd, int status);
 120
 121 int getPlaylistCurrentSong(void);
 122
 123 int getPlaylistSongId(int song);
 124
 125 int getPlaylistLength(void);
 126
 127 unsigned long getPlaylistVersion(void);
 128
 129 unsigned long getPlaylistQueueVersion(void);
 130
 131 void playPlaylistIfPlayerStopped(void);
 132
 133 int seekSongInPlaylist(int fd, int song, float time);
 134
 135 int seekSongInPlaylistById(int fd, int id, float time);
 136
 137 void playlistVersionChange(void);
 138
 139 int playlistChanges(int fd, mpd_uint32 version);
 140
 141 int playlistChangesPosId(int fd, mpd_uint32 version);
 142
 143 int PlaylistInfo(int fd, char *utf8file, int detail);
 144
 145 void searchForSongsInPlaylist(int fd, int numItems, LocateTagItem * items);
 146
 147 void findSongsInPlaylist(int fd, int numItems, LocateTagItem * items);
 148
 149 void clearPlaylistQueue(void);
 150
 151 int addToPlaylistQueueById(int fd, int song, int toPosition);
 152
 153 int deleteFromPlaylistQueue(int fd, int song);
 154
 155 int deleteFromPlaylistQueueInternal(int song);
 156
 157 int playlistQueueInfo(int fd);
 158
 159 #endif