1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
<?php
/*
Copyright 2001 - 2006 Ampache.org
All Rights Reserved
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
/**
* AmpacheMpd Class
* the Ampache Mpd Controller, this is the glue between
* the MPD class and the Ampahce Localplay class
*/
class AmpacheMpd {
/* Variables */
/* Constructed variables */
var $_mpd;
/**
* Constructor
* This returns the array map for the localplay object
* REQUIRED for Localplay
*/
function AmpacheMpd() {
/* Do a Require Once On the needed Libraries */
require_once(conf('prefix') . '/modules/mpd/mpd.class.php');
} // AmpacheMpd
/**
* function_map
* This function returns a named array of the functions
* that this player supports and their names in this local
* class. This is a REQUIRED function
*/
function function_map() {
$map = array();
/* Required Functions */
$map['add'] = 'add_songs';
$map['delete'] = 'delete_songs';
$map['play'] = 'play';
$map['stop'] = 'stop';
$map['get'] = 'get_songs';
$map['status'] = 'get_status';
$map['connect'] = 'connect';
/* Recommended Functions */
$map['next'] = 'next';
$map['prev'] = 'prev';
$map['pause'] = 'pause';
$map['volume'] = 'volume';
$map['loop'] = 'loop';
$map['random'] = 'random';
/* Optional Functions */
$map['move'] = 'move';
$map['delete_all'] = 'clear_playlist';
return $map;
} // function_map
/**
* preference
* This function returns an array of the preferences and their
* information for Ampache to use All preferences will get a
* localplay_mpd_ appended to their name to avoid conflicts
* however this controller does not need to take that into acount
* REQUIRE for Locaplay
*/
function preferences() {
$preferences = array();
$preferences[] = array('name'=>'hostname','default'=>'localhost','type'=>'string','description'=>'MPD Hostname');
$preferences[] = array('name'=>'port','default'=>'6600','type'=>'integer','description'=>'MPD Port');
$preferences[] = array('name'=>'password','default'=>'','type'=>'string','description'=>'MPD Password');
return $preferences;
} // preferences
/**
* add_songs
* This must take an array of URL's from Ampache
* and then add them to MPD
*/
function add_songs($songs) {
foreach ($songs as $song_id) {
$song = new Song($song_id);
$url = $song->get_url();
if (is_null($this->_mpd->PlAdd($url))) {
debug_event('mpd_add','Error: Unable to add $url to MPD ' . $this->_mpd->errStr,'1');
}
} // end foreach
return true;
} // add_songs
/**
* delete_songs
* This must take an array of ID's (as passed by get function) from Ampache
* and delete them from MPD
*/
function delete_songs($songs) {
/* Default to true */
$return = true;
/* This should be an array of UID's as returned by
* the get function so that we can just call the class based
* functions to remove them or if there isn't a uid for
* the songs, then however ya'll have stored them
* in this controller
*/
foreach ($songs as $uid) {
if (is_null($this->_mpd->PLRemove($uid))) { $return = false; }
} // foreach of songs
return $return;
} // delete_songs
/**
* clear_playlist
* This deletes the entire MPD playlist... nuff said
*/
function clear_playlist() {
if (is_null($this->_mpd->PLClear())) { return false; }
return true;
} // clear_playlist
/**
* play
* This just tells MPD to start playing, it does not
* take any arguments
*/
function play() {
if (is_null($this->_mpd->Play())) { return false; }
return true;
} // play
/**
* stop
* This just tells MPD to stop playing, it does not take
* any arguments
*/
function stop() {
if (is_null($this->_mpd->Stop())) { return false; }
return true;
} // stop
/**
* next
* This just tells MPD to skip to the next song
*/
function next() {
if (is_null($this->_mpd->Next())) { return false; }
return true;
} // next
/**
* prev
* This just tells MPD to skip to the prev song
*/
function prev() {
if (is_null($this->_mpd->Previous())) { return false; }
return true;
} // prev
/**
* pause
* This tells MPD to pause the current song
*/
function pause() {
if (is_null($this->_mpd->Pause())) { return false; }
return true;
} // pause
/**
* volume
* This tells MPD to set the volume to the parameter
*/
function volume($volume) {
if (is_null($this->_mpd->SetVolume($volume))) { return false; }
return true;
} // volume
/**
* loop
* This tells MPD to set the repeating the playlist (i.e. loop) to either on or off
*/
function loop($onoff) {
if (is_null($this->_mpd->SetRepeat($onoff))) { return false; }
return true;
} // loop
/**
* random
* This tells MPD to turn on or off the playing of songs from the playlist in random order
*/
function random($onoff) {
if (is_null($this->_mpd->SetRandom($onoff))) { return false; }
return true;
} // random
/**
* move
* This tells MPD to move song from SrcPos to DestPos
*/
function move($SrcPos, $DestPos) {
if (is_null($this->_mpd->PLMoveTrack($SrcPos, $DestPos))) { return false; }
return true;
} // move
/**
* get_songs
* This functions returns an array containing information about
* The songs that MPD currently has in it's playlist. This must be
* done in a standardized fashion
*/
function get_songs() {
/* Get the Current Playlist */
$playlist = $this->_mpd->playlist;
foreach ($playlist as $entry) {
$data = array();
/* Required Elements */
$data['id'] = $entry['Pos'];
$data['raw'] = $entry['file'];
/* Parse out the song ID and then create the song object */
preg_match("/song=(\d+)\&/",$entry['file'],$matches);
$song = new Song($matches['1']);
$song->format_song();
$data['name'] = $song->f_title . ' - ' . $song->f_album . ' - ' . $song->f_artist;
/* Just incase prevent emtpy names */
if (!$song->title) { $data['name'] = _('Unknown'); }
/* Optional Elements */
$data['link'] = '';
$data['track'] = $entry['Pos'];
$results[] = $data;
} // foreach playlist items
return $results;
} // get_songs
/**
* get_status
* This returns bool/int values for features, loop, repeat and any other features
* That this localplay method support
*/
function get_status() {
/* Construct the Array */
$array['state'] = $this->_mpd->state;
$array['volume'] = $this->_mpd->volume;
$array['repeat'] = $this->_mpd->repeat;
$array['random'] = $this->_mpd->random;
return $array;
} // get_status
/**
* connect
* This functions creates the connection to MPD and returns
* a boolean value for the status, to save time this handle
* is stored in this class
*/
function connect() {
$this->_mpd = new mpd(conf('localplay_mpd_hostname'),conf('localplay_mpd_port'));
if ($this->_mpd->connected) { return true; }
return false;
} // connect
} //end of AmpacheMpd
?>
|
