LiquidSoapClient.py 16.4 KB
Newer Older
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
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
#!/usr/bin/python
# -*- coding: utf-8 -*-
import os
import sys
import time
import socket
import urllib.parse
import configparser

from io import StringIO


class LQConnectionError(Exception):
    def __init__(self, value):
        self.value = value

    def __str__(self):
        return repr(self.value)


""" LiquidsoapClient Class 
    Kommandos an den Liquidsoap Soundserver oder Recorder senden
    Repräsentiert alle Kommandos, die Soundserver oder Recorder kennen
"""


class LiquidSoapClient():

    def __init__(self, socketPath):
        """
        Constructor
        @type    socketPath: string
        @param   socketPath: Der Pfad zum Socket des Liquidsoap-Scripts
        """
        self.socketpath = socketPath

        # init
        self.connected = False
        self.can_connect = True
        self.message = ''
        self.client = None
        if sys.version_info <= (3, 2):
            self.metareader = configparser.ConfigParser({'strict': False, 'interpolation': None})
        else:
            self.metareader = configparser.ConfigParser()

    # ------------------------------------------------------------------------------------------ #
    def connect(self):
        """
        Verbindung herstellen
        """
        try:
            self.client = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
            self.client.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
            self.client.connect(self.socketpath)
        except socket.error as e:
            self.connected = False
            raise LQConnectionError(e)
            return False
        else:
            self.can_connect = True
            self.connected = True
            return True

    # ------------------------------------------------------------------------------------------ #
    def isConnected(self):
        return self.connected

    # ------------------------------------------------------------------------------------------ #
    def write(self, data):
        """
        Auf den Socket schreiben
        @type    data: string
        @param   data: Der String der gesendet wird
        """
        if self.connected:
            self.client.sendall(data.decode("UTF-8"))

    # ------------------------------------------------------------------------------------------ #
    def read_all(self, timeout=2):
        """
        Vom Socket lesen, bis dieser "END" sendet
        @type    timeout: int
        @param   timeout: Ein optionales Timeout
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """
        # make socket non blocking
        # self.client.setblocking(0)

        data = '';
        self.client.settimeout(2)

        # recv something
        # while True:
        try:
            time.sleep(0.1)
            raw = self.client.recv(8192)
            data = raw.decode()
        except Exception as e:
            print(e)
            pass

        return data

    # ------------------------------------------------------------------------------------------ #
    def read(self):
        """
        Vom Socket lesen und anschließend quit senden, um den Server zu veranlassen, die Verbindung schließen
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """
        if self.connected:

            ret = self.read_all()
            ret = ret.splitlines()

            try:
                ret.pop()  # pop 'END' out
                self.message = str.join('\n', ret)
                # self.message = str(b'\n'.join(ret))
            except Exception as e:
                print(e)

            # self.client.sendall('quit\n')
            return self.message

    # ------------------------------------------------------------------------------------------ #
    def close(self):
        """
        Quit senden und Verbindung schließen
        """
        if self.connected:
            message = "quit\r"
            self.client.sendall(message.decode("UTF-8"))
            self.client.close()
            self.connected = False

    # ------------------------------------------------------------------------------------------ #
    def command(self, namespace, command, param=""):
        """
        Kommando an Liquidosap senden
        @type    command:   string
        @param   command:   Kommando
        @type    namespace: string
        @param   namespace: Namespace/Kanal der angesprochen wird
        @type    param:     mixed
        @param   param:     ein optionaler Parameter
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """

        param = (param.strip() if param.strip() == "" else " " + urllib.parse.unquote(param.strip()))

        if self.connected:
            # print namespace + '.' + command + param + "\n"
            if namespace is "":
                message = str(command) + str(param) + str('\n')
            else:
                message = str(namespace) + str('.') + str(command) + str(param) + str('\n')

            try:
                debug = False
                if debug:
                    print("command: " + command)
                    print("namespace: " + namespace)
                    print("param: " + param)
                    print("wanna send: " + message)
                self.client.sendall(message.encode())
                self.read()
                # self.client.close()
            except:
                print("Unexpected error:", sys.exc_info()[0], sys.exc_info()[1], sys.exc_info()[2])
                raise

            return self.message
        else:
            return False

    # ------------------------------------------------------------------------------------------ #
    def simplecommand(self, command):
        """
        Parameterloses Kommando ohne Namespace senden
        @type    command:   string
        @param   command:   Kommando
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """

        if self.connected:
            message = str(command) + '\n'
            self.client.sendall(message.decode("UTF-8"))
            self.read()
            # self.client.close()
            return self.message

    # ------------------------------------------------------------------------------------------ #
    def getMetadata(self, rid):
        """
        Parameterloses Kommando ohne Namespace senden
        @type    rid:   string/int
        @param   rid:   Die ID eines Requests
        @rtype:  dict
        @return: Die Metadaten als dict
        """
        meta = self.command('metadata ' + str(rid), 'request')

        meta = '[root]\n' + meta
        if sys.version_info <= (3, 2):
            meta = StringIO.StringIO(meta)
            try:
                self.metareader.readfp(meta)
            except configparser.ParsingError:
                return False
        else:
            try:
                self.metareader.read_string(meta)
            except configparser.ParsingError:
                return False
        return self.metareader

    # ------------------------------------------------------------------------------------------ #
    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 push(self, uri, namespace="playlist"):
        """
        Track einfügen und abspielen (wenn source aktiv ist)
        @type    uri:       string
        @param   uri:       Uri eines Audios
        @type    namespace: string
        @param   namespace: Namespace der Source
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """
        self.command('push', namespace, str(uri))
        return self.message

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

    # ------------------------------------------------------------------------------------------ #
    def seek(self, duration, namespace="playlist"):
        """
        Aktuell laufenen Track des Kanals vorspulen
        @type    duration:  string/int
        @param   duration:  Dauer in Sekunden
        @type    namespace: string
        @param   namespace: Namespace der Source
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """
        self.command('seek', namespace, str(duration))
        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

    # ------------------------------------------------------------------------------------------ #
    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

    # ------------------------------------------------------------------------------------------ #
    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



    # ------------------------------------------------------------------------------------------ #
    def help(self):
        """
        get liquidsoap server help
        @rtype:  string
        @return: the response of the liquidsoap server
        """
        if self.connected:
            self.command('help', '')
            print('read (' + str(len(self.message)) + ' bytes): ' + self.message)
            return self.message

    # ------------------------------------------------------------------------------------------ #
    def version(self):
        """
        Liquidsoap get version
        @rtype:  string
        @return: the response of the liquidsoap server
        """
        if self.connected:
            message = 'version'
            self.command(message, '')
            return self.message

    # ------------------------------------------------------------------------------------------ #
    def uptime(self):
        """
        Liquidsoap get uptime
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """

        if self.connected:
            self.command('uptime', '')
            print('read (' + str(len(self.message)) + ' bytes): ' + self.message)
            return self.message

    # ------------------------------------------------------------------------------------------ #
    def byebye(self):
        """
        Liquidsoap say byebye
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """

        if self.connected:
            message = 'quit'
            self.command("", message)  # client.sendall(message.encode())
            # self.read()
            # print("read: " + self.message)
            return self.message