playerclient.py 16.4 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

David Trattnig's avatar
David Trattnig committed
20
21
# FIXME Refactor to avoid use of Channel Class here
from modules.core.channels import Channel
David Trattnig's avatar
David Trattnig committed
22
from modules.core.liquidsoap.client import LiquidSoapClient
23
24
25
26


class LiquidSoapPlayerClient(LiquidSoapClient):

27
28
29
30
    #
    # Mixer
    #

31
32
33
34
35
36
37
    def mixer(self, command, *args):
        if command == "status":
            return self.mixerstatus(*args)

        if command == "inputs":
            return self.mixerinputs()

38
        if command == "volume":
39
            return self.mixer_volume(*args)
40

41
42
        if command == "select":
            if len(args) == 2:
43
44
45
46
47
                return self.mixer_select(args[0], args[1])

        if command == "activate":
            if len(args) == 2:
                return self.mixer_activate(args[0], args[1])
48

49
50
        return "LiquidSoapPlayerClient does not understand mixer."+command+str(args)

51

52
    # ------------------------------------------------------------------------------------------ #
53
54
55
    def mixerinputs(self):
        # send command
        self.command("mixer", "inputs")
56

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

60
61
62
63
64
65
66
67
68
69
70
    # ------------------------------------------------------------------------------------------ #
    def mixerstatus(self, pos=""):
        """
        Get state of a source in the mixer
        @type    pos:       string
        @param   pos:       Mixerposition
        @rtype:  string
        @return: Response from LiquidSoap
        """
        self.command("mixer", "status", str(pos))
        return self.message
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
    def mixer_volume(self, pos, volume):
        """
        Sets some mixer channel to the given volume

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

        Returns:
            (String):   Liquidsoap server response
        """
        self.command("mixer", "volume", str(pos) + " " + str(volume))
        return self.message


    def mixer_select(self, pos, select):
        """
        Selects some mixer channel or vice versa.

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

        Returns:
            (String):   Liquidsoap server response
        """
        self.command("mixer", "select", str(pos) + " " + str(select).lower())
        return self.message


    def mixer_activate(self, pos, activate):
        """
        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
        """
        self.command("mixer", "activate", str(pos) + " " + str(activate).lower())
        return self.message
116
117


David Trattnig's avatar
David Trattnig committed
118
    #
119
    # Queues
David Trattnig's avatar
David Trattnig committed
120
    #
121

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

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

133

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

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

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

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

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

        Returns:
            Liquidsoap server response
        """
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
        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
        """
        if channel == Channel.SCHEDULED_FALLBACK.value:
            self.command(channel, 'uri', uri)            
181
182
183
184
185
186
        else:
            return "Invalid filesystem channel '%s'" % channel

        return self.message


187
    def playlist_uri_clear(self, channel):
188
        """
189
        Clears the URI of a playlist source.
190
191
192
193
194
195
196
197
198

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

        Returns:
            Liquidsoap server response
        """
        if channel == Channel.SCHEDULED_FALLBACK.value:
199
            self.command(channel, 'clear')            
David Trattnig's avatar
David Trattnig committed
200
201
202
203
204
205
        else:
            return "Invalid filesystem channel '%s'" % channel

        return self.message


David Trattnig's avatar
David Trattnig committed
206
207
208
209
    #
    # Stream
    #

David Trattnig's avatar
David Trattnig committed
210
    def stream_set_url(self, channel, url):
David Trattnig's avatar
David Trattnig committed
211
212
213
214
215
216
217
        """
        Sets the URL on the given HTTP channel.
        """
        self.command(channel, 'url', url)
        return self.message


David Trattnig's avatar
David Trattnig committed
218
    def stream_start(self, channel):
David Trattnig's avatar
David Trattnig committed
219
220
221
222
223
224
225
        """
        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
226
    def stream_stop(self, channel):
David Trattnig's avatar
David Trattnig committed
227
228
229
230
231
232
233
        """
        Stops the HTTP stream on the given channel.
        """
        self.command(channel, 'stop')
        return self.message


David Trattnig's avatar
David Trattnig committed
234
    def stream_status(self, channel):
David Trattnig's avatar
David Trattnig committed
235
236
237
238
239
240
241
        """
        Returns the status of the HTTP stream on the given channel.
        """
        self.command(channel, 'status')
        return self.message


242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
    #
    # 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
260
261
262
263
    #
    # Other
    #

264
    def uptime(self, command=""): # no command will come
David Trattnig's avatar
David Trattnig committed
265
266
267
268
        """
        Retrieves how long the engine is running already.
        """
        return self.command("", "uptime")
269

David Trattnig's avatar
David Trattnig committed
270
271
272
273
274
275
276
277
278
279
280
281

    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.
        """
282
        if command == "state":
David Trattnig's avatar
David Trattnig committed
283
            return self.engine_state()
284

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

David Trattnig's avatar
David Trattnig committed
287
288
289
290
291

    def engine_state(self):
        """
        Retrieves the state of all input and outputs.
        """
292
293
294
        self.command('auraengine', 'state')
        return self.message

David Trattnig's avatar
David Trattnig committed
295

296
    # ------------------------------------------------------------------------------------------ #
David Trattnig's avatar
David Trattnig committed
297
298
299
    # def recorder(self, num, command, *args):
    #     if command == "status":
    #         return self.recorderstatus(num)
300

David Trattnig's avatar
David Trattnig committed
301
302
    #     if command == "start":
    #         return self.recorderstart(num)
303

David Trattnig's avatar
David Trattnig committed
304
305
    #     if command == "stop":
    #         return self.recorderstop(num)
306

David Trattnig's avatar
David Trattnig committed
307
    #     return "LiquidSoapPlayerClient does not understand mixer." + command + str(args)
308
309


310
    # ------------------------------------------------------------------------------------------ #
David Trattnig's avatar
David Trattnig committed
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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
    # def recorderstatus(self, num):
    #     """
    #     get status of a recorder
    #     :return:
    #     """
    #     self.command("recorder_" + str(num), "status")
    #     return self.message

    # # ------------------------------------------------------------------------------------------ #
    # def recorderstart(self, num):
    #     """
    #     get status of a recorder
    #     :return:
    #     """
    #     self.command("recorder_" + str(num), "start")
    #     return self.message

    # # ------------------------------------------------------------------------------------------ #
    # def recorderstop(self, num):
    #     """
    #     get status of a recorder
    #     :return:
    #     """
    #     self.command("recorder_" + str(num), "stop")
    #     return self.message

    # ------------------------------------------------------------------------------------------ #
    # 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
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501

    # ------------------------------------------------------------------------------------------ #
    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
502
503
504
505
506
507
508
509
    # 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
510
511

    # ------------------------------------------------------------------------------------------ #
David Trattnig's avatar
David Trattnig committed
512
513
514
515
516
    # def list_channels(self):
    #     """
    #     Channels auflisten (Simple JSON)
    #     """
    #     # Liquidsoap Kommando
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
517

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

David Trattnig's avatar
David Trattnig committed
520
521
522
523
524
525
    #     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
526

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