playerclient.py 14.8 KB
Newer Older
1
#
David Trattnig's avatar
David Trattnig committed
2
# Aura Engine (https://gitlab.servus.at/aura/engine)
3
#
David Trattnig's avatar
David Trattnig committed
4
# Copyright (C) 2017-2020 - The Aura Engine Team.
5
#
David Trattnig's avatar
David Trattnig committed
6
7
8
9
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
10
#
David Trattnig's avatar
David Trattnig committed
11
12
13
14
# 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 Affero General Public License for more details.
15
#
David Trattnig's avatar
David Trattnig committed
16
17
18
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

19

20
from src.core.client.client import LiquidSoapClient
21
22
23
24


class LiquidSoapPlayerClient(LiquidSoapClient):

25
26
27
28
    #
    # Mixer
    #

29
30
31
    # def mixer(self, mixer_id, command, *args):
    #     if command == "status":
    #         return self.mixer_status(mixer_id, *args)
32

33
34
    #     if command == "inputs":
    #         return self.mixer_inputs(mixer_id)
35

36
37
    #     if command == "volume":
    #         return self.mixer_volume(mixer_id, *args)
38

39
40
41
    #     if command == "select":
    #         if len(args) == 2:
    #             return self.mixer_select(mixer_id, args[0], args[1])
42

43
44
45
    #     if command == "activate":
    #         if len(args) == 2:
    #             return self.mixer_activate(mixer_id, args[0], args[1])
46

47
    #     return "LiquidSoapPlayerClient does not understand mixer."+command+str(args)
48

49

50
    # ------------------------------------------------------------------------------------------ #
51
    def mixer_inputs(self, mixer_id):
52
        # send command
53
        self.command(mixer_id, "inputs")
54

55
56
        # convert to list and return it
        return self.message.strip().split(' ')
57

58
    # ------------------------------------------------------------------------------------------ #
59
    def mixer_status(self, mixer_id, pos=""):
60
61
62
63
64
65
66
        """
        Get state of a source in the mixer
        @type    pos:       string
        @param   pos:       Mixerposition
        @rtype:  string
        @return: Response from LiquidSoap
        """
67
        self.command(mixer_id, "status", str(pos))
68
        return self.message
69
70


71
    def mixer_volume(self, mixer_id, pos, volume):
72
73
74
75
76
77
78
79
80
81
        """
        Sets some mixer channel to the given volume

        Args:
            pos (Integer):  The channel number
            volume (Integer): The volume

        Returns:
            (String):   Liquidsoap server response
        """
82
        self.command(mixer_id, "volume", str(pos) + " " + str(volume))
83
84
85
        return self.message


86
    def mixer_select(self, mixer_id, pos, select):
87
88
89
90
91
92
93
94
95
96
        """
        Selects some mixer channel or vice versa.

        Args:
            pos (Integer):  The channel number
            select (Boolean): Select or deselect

        Returns:
            (String):   Liquidsoap server response
        """
97
        self.command(mixer_id, "select", str(pos) + " " + str(select).lower())
98
99
100
        return self.message


101
    def mixer_activate(self, mixer_id, pos, activate):
102
103
104
105
106
107
108
109
110
111
        """
        Selects some mixer channel and increases the volume to 100 or vice versa.

        Args:
            pos (Integer):  The channel number
            activate (Boolean): Activate or deactivate

        Returns:
            (String):   Liquidsoap server response
        """
112
        self.command(mixer_id, "activate", str(pos) + " " + str(activate).lower())
113
        return self.message
114
115


David Trattnig's avatar
David Trattnig committed
116
    #
117
    # Queues
David Trattnig's avatar
David Trattnig committed
118
    #
119

120
    def queue_push(self, channel, uri):
David Trattnig's avatar
David Trattnig committed
121
        """
122
        Pushes the passed file URI to the `equeue` playlist channel.
David Trattnig's avatar
David Trattnig committed
123
124

        Args:
125
            channel (String):   Liquidsoap Source ID
126
            uri (String):       Path to the file
David Trattnig's avatar
David Trattnig committed
127
128
129
        """
        self.command(channel, 'push', uri)
        return self.message
130

131

132
    def queue_seek(self, channel, duration):
David Trattnig's avatar
David Trattnig committed
133
        """
134
        Forward the playing `equeue` track/playlist of the given channel.
135

David Trattnig's avatar
David Trattnig committed
136
        Args:
137
            channel (String):   Liquidsoap Source ID
David Trattnig's avatar
David Trattnig committed
138
139
140
141
142
143
144
145
146
            duration (Integer): Seek duration ins seconds

        Returns:
            Liquidsoap server response
        """
        self.command(channel, 'seek', str(duration))
        return self.message

   
147
    def queue_clear(self, channel):
David Trattnig's avatar
David Trattnig committed
148
        """
149
        Clears all `equeue` playlist entries of the given channel.
David Trattnig's avatar
David Trattnig committed
150
151

        Args:
152
            channel (String):   Liquidsoap Source ID
David Trattnig's avatar
David Trattnig committed
153
154
155
156
157
            duration (Integer): Seek duration ins seconds

        Returns:
            Liquidsoap server response
        """
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
        self.command(channel, 'clear')
        return self.message


    #
    # Playlist
    #

    def playlist_uri_set(self, channel, uri):
        """
        Sets the URI of a playlist source.

        Args:
            channel (String):   Liquidsoap Source ID
            uri (String):       URI to the playlist file

        Returns:
            Liquidsoap server response
        """
177
        self.command(channel, 'uri', uri)            
178
179
180
        return self.message


181
    def playlist_uri_clear(self, channel):
182
        """
183
        Clears the URI of a playlist source.
184
185
186
187
188
189
190
191

        Args:
            channel (String):   Liquidsoap Source ID
            uri (String):       URI to the playlist file

        Returns:
            Liquidsoap server response
        """
192
        self.command(channel, 'clear')            
David Trattnig's avatar
David Trattnig committed
193
194
195
        return self.message


David Trattnig's avatar
David Trattnig committed
196
197
198
199
    #
    # Stream
    #

David Trattnig's avatar
David Trattnig committed
200
    def stream_set_url(self, channel, url):
David Trattnig's avatar
David Trattnig committed
201
202
203
204
205
206
207
        """
        Sets the URL on the given HTTP channel.
        """
        self.command(channel, 'url', url)
        return self.message


David Trattnig's avatar
David Trattnig committed
208
    def stream_start(self, channel):
David Trattnig's avatar
David Trattnig committed
209
210
211
212
213
214
215
        """
        Starts the HTTP stream set with `stream_set_url` on the given channel.
        """
        self.command(channel, 'start')
        return self.message


David Trattnig's avatar
David Trattnig committed
216
    def stream_stop(self, channel):
David Trattnig's avatar
David Trattnig committed
217
218
219
220
221
222
223
        """
        Stops the HTTP stream on the given channel.
        """
        self.command(channel, 'stop')
        return self.message


David Trattnig's avatar
David Trattnig committed
224
    def stream_status(self, channel):
David Trattnig's avatar
David Trattnig committed
225
226
227
228
229
230
231
        """
        Returns the status of the HTTP stream on the given channel.
        """
        self.command(channel, 'status')
        return self.message


232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
    #
    # General Entries
    #

    def entry_status(self, rid):
        """
        Retrieves the status of a given entry.

        Args:
            rid (String):   Resource ID (RID)

        Returns:
            Liquidsoap server response
        """
        self.command("request", "status", str(rid))
        return self.message


David Trattnig's avatar
David Trattnig committed
250
251
252
253
    #
    # Other
    #

254
    def uptime(self, command=""): # no command will come
David Trattnig's avatar
David Trattnig committed
255
256
257
258
        """
        Retrieves how long the engine is running already.
        """
        return self.command("", "uptime")
259

David Trattnig's avatar
David Trattnig committed
260
261
262
263
264
265
266
267
268
269
270
271

    def version(self, command=""): # no command will come
        """
        Retrieves the Liquidsoap version.
        """
        return self.command("", "version")


    def engine(self, command, *args):
        """
        Retrieves the state of all input and outputs.
        """
272
        if command == "state":
David Trattnig's avatar
David Trattnig committed
273
            return self.engine_state()
274

David Trattnig's avatar
David Trattnig committed
275
        return "LiquidSoapPlayerClient does not understand engine." + command + str(args)
276

David Trattnig's avatar
David Trattnig committed
277
278
279
280
281

    def engine_state(self):
        """
        Retrieves the state of all input and outputs.
        """
282
283
284
        self.command('auraengine', 'state')
        return self.message

David Trattnig's avatar
David Trattnig committed
285

David Trattnig's avatar
David Trattnig committed
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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
    # ------------------------------------------------------------------------------------------ #
    # def skip(self, namespace="playlist", pos=""):
    #     """
    #     Source skippen
    #     @type    namespace: string
    #     @param   namespace: Namespace der Source
    #     @type    pos:       string
    #     @param   pos:       Die Position - optional - Position des Channels vom Mixer benötigt
    #     @rtype:  string
    #     @return: Die Antwort des Liquidsoap-Servers
    #     """
    #     self.command('skip', namespace, pos)
    #     return self.message

    # # ------------------------------------------------------------------------------------------ #
    # def remove(self, pos, namespace="playlist"):
    #     """
    #     Track  aus der secondary_queue oder der Playlist entfernen
    #     @type    pos:       string
    #     @param   pos:       Die Position
    #     @type    namespace: string
    #     @param   namespace: Namespace der Source
    #     @rtype:  string
    #     @return: Die Antwort des Liquidsoap-Servers
    #     """
    #     self.command('remove', namespace, str(pos))
    #     return self.message

    # # ------------------------------------------------------------------------------------------ #
    # def insert(self, uri, pos='0', namespace="playlist"):
    #     """
    #     Track  einfügen
    #     @type    uri:       string
    #     @param   uri:       Uri einer Audiodatei
    #     @type    pos:       string
    #     @param   pos:       Die Position
    #     @type    namespace: string
    #     @param   namespace: Namespace der Source
    #     @rtype:  string
    #     @return: Die Antwort des Liquidsoap-Servers
    #     """
    #     self.command('insert', namespace, str(pos) + ' ' + uri)
    #     return self.message

    # # ------------------------------------------------------------------------------------------ #
    # def move(self, fromPos, toPos, namespace="playlist"):
    #     """
    #     Track  von Position fromPos nach Position toPos verschieben
    #     @type    fromPos:   string/int
    #     @param   fromPos:   Position des zu verschiebenden Tracks
    #     @type    toPos:     string
    #     @param   toPos:     Die Position zu der verschoben werden soll
    #     @type    namespace: string
    #     @param   namespace: Namespace der Source
    #     @rtype:  string
    #     @return: Die Antwort des Liquidsoap-Servers
    #     """
    #     self.command('move', namespace, str(fromPos) + ' ' + str(toPos))
    #     return self.message

    # ------------------------------------------------------------------------------------------ #
    # def play(self, namespace="playlist"):
    #     """
    #     Source abspielen - funktioniert nur bei Playlist
    #     @type    namespace: string
    #     @param   namespace: Namespace der Source
    #     @rtype:  string
    #     @return: Die Antwort des Liquidsoap-Servers
    #     """
    #     self.command('play', namespace)
    #     return self.message

    # # ------------------------------------------------------------------------------------------ #
    # def pause(self, namespace="playlist"):
    #     """
    #     Source pausieren/stoppen - funktioniert nur bei Playlist
    #     @type    namespace: string
    #     @param   namespace: Namespace der Source
    #     @rtype:  string
    #     @return: Die Antwort des Liquidsoap-Servers
    #     """
    #     self.command('pause', namespace)
    #     return self.message

    # # ------------------------------------------------------------------------------------------ #
    # def flush(self, namespace="playlist"):
    #     """
    #     Playlist leeren
    #     @type    namespace: string
    #     @param   namespace: Namespace der Source
    #     @rtype:  string
    #     @return: Die Antwort des Liquidsoap-Servers
    #     """
    #     self.command('flush', namespace)
    #     return self.message

    # # ------------------------------------------------------------------------------------------ #
    # def playlistData(self):
    #     """
    #     Metadaten der Playlist ausgeben
    #     @rtype:  string
    #     @return: Ein Json-String
    #     """
    #     self.command('data', 'playlist')
    #     return self.message

    # # ------------------------------------------------------------------------------------------ #
    # def get_queue(self, namespace="ch1", queue='queue'):
    #     """
    #     Queue eines Kanals ausgeben
    #     @type    namespace: string
    #     @param   namespace: Namespace der Source
    #     @type    queue:     string
    #     @param   queue:    Name des queues (queue, primary_queue, secondary_queue)
    #     @rtype:  string
    #     @return: Die Antwort des Liquidsoap-Servers
    #     """
    #     self.command(queue, namespace)
    #     return self.message

    # ------------------------------------------------------------------------------------------ #
    # def loadPlaylist(self, uri, params="", namespace="playlist"):
    #     """
    #     Playlist laden
    #     @type    uri:       string
    #     @param   uri:       Uri einer Playlist im XSPF-Format
    #     @type    params:    string
    #     @param   params:    obsolete
    #     @type    namespace: string
    #     @param   namespace: Namespace der Source - hier nur playlist
    #     @rtype:  string
    #     @return: Die Antwort des Liquidsoap-Servers
    #     """
    #     self.command('load', namespace, uri + params)
    #     return self.message

    # ------------------------------------------------------------------------------------------ #
    # def currentTrack(self, namespace="request"):
    #     """
    #     Das oder die ID(s) der gerade abgespielten requests erhalten
    #     @type    namespace: string
    #     @param   namespace: Namespace der Source
    #     @rtype:  string
    #     @return: Die Antwort des Liquidsoap-Servers (als String)
    #     """
    #     self.command('on_air', namespace)
    #     return self.message
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450

    # ------------------------------------------------------------------------------------------ #
    def volume(self, pos, volume, namespace="mixer"):
        """
        Lautstärke eines Kanals setzen
        @type    pos:       int/string
        @param   pos:       Die Position/ Nummer des Kanals (playlist=0)
        @type    volume:    int/string
        @param   volume:    Zahl von 1 -100
        @type    namespace: string
        @param   namespace: Namespace der Source (immer mixer)
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """
        self.command('volume', namespace, str(pos) + ' ' + str(volume))
        return self.message

    # ------------------------------------------------------------------------------------------ #
David Trattnig's avatar
David Trattnig committed
451
452
453
454
455
456
457
458
    # def playlist_remaining(self):
    #     """
    #     Wie lange läuft der aktuelle Track der Playlist noch
    #     @rtype:  string
    #     @return: Die Antwort des Liquidsoap-Servers
    #     """
    #     self.command('remaining', 'playlist')
    #     return self.message
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
459
460

    # ------------------------------------------------------------------------------------------ #
David Trattnig's avatar
David Trattnig committed
461
462
463
464
465
    # def list_channels(self):
    #     """
    #     Channels auflisten (Simple JSON)
    #     """
    #     # Liquidsoap Kommando
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
466

David Trattnig's avatar
David Trattnig committed
467
    #     channels = self.sendLqcCommand(self.lqc, 'mixer', 'inputs')
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
468

David Trattnig's avatar
David Trattnig committed
469
470
471
472
473
474
    #     if not isinstance(channels, list):
    #         self.error('02')
    #     elif len(channels) < 1:
    #         self.warning('01')
    #     else:
    #         self.success('00', channels)
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
475

David Trattnig's avatar
David Trattnig committed
476
    #     self.notifyClient()