playerclient.py 14.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
#
#  engine
#
#  Playout Daemon for autoradio project
#
#
#  Copyright (C) 2017-2018 Gottfried Gaisbauer <gottfried.gaisbauer@servus.at>
#
#  This file is part of engine.
#
#  engine 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 3 of the License, or
#  any later version.
#
#  engine 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 engine. If not, see <http://www.gnu.org/licenses/>.
#

David Trattnig's avatar
David Trattnig committed
25
from modules.base.enum import Channel, ChannelType
26
from modules.communication.liquidsoap.client import LiquidSoapClient
27
28
29
30
31
32
33
34
35
36
37
38


class LiquidSoapPlayerClient(LiquidSoapClient):

    # ------------------------------------------------------------------------------------------ #
    def mixer(self, command, *args):
        if command == "status":
            return self.mixerstatus(*args)

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

39
40
41
        if command == "volume":
            return self.mixervolume(*args)

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

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

48
49
50
51
52
53
54
55
56
57
58
59
60
    # ------------------------------------------------------------------------------------------ #
    def recorder(self, num, command, *args):
        if command == "status":
            return self.recorderstatus(num)

        if command == "start":
            return self.recorderstart(num)

        if command == "stop":
            return self.recorderstop(num)

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

61
62
63
64
65
66
67
68
69
    # ------------------------------------------------------------------------------------------ #
    def http(self, command, *args):
        if command == "url":
            return self.set_http_url(*args)

        return "LiquidSoapPlayerClient does not understand http." + command + str(args)

    # ------------------------------------------------------------------------------------------ #

David Trattnig's avatar
David Trattnig committed
70
71
72
73
74
75
76
77
78
    def playlist_push(self, channel, uri):
        """
        Pushs the passed file URI to the playlist channel.

        Args:
            channel (String):   Liquidsoap Channel ID
        """
        self.command(channel, 'push', uri)
        return self.message
79

80

David Trattnig's avatar
David Trattnig committed
81
82
83
    def playlist_seek(self, channel, duration):
        """
        Forward the playing track/playlist of the given channel.
84

David Trattnig's avatar
David Trattnig committed
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
        Args:
            channel (String):   Liquidsoap Channel ID
            duration (Integer): Seek duration ins seconds

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

   
    def playlist_clear(self, channel):
        """
        Clears all playlist entries of the given channel.

        Args:
            channel (String):   Liquidsoap Channel ID
            duration (Integer): Seek duration ins seconds

        Returns:
            Liquidsoap server response
        """
        if channel == Channel.FILESYSTEM_A.value:
108
            self.command(channel, 'clear_filesystem_0')
David Trattnig's avatar
David Trattnig committed
109
        elif channel == Channel.FILESYSTEM_B.value:
110
            self.command(channel, 'clear_filesystem_1')
David Trattnig's avatar
David Trattnig committed
111
112
113
114
115
116
117
        else:
            return "Invalid filesystem channel '%s'" % channel

        return self.message


     # ------------------------------------------------------------------------------------------ #
118
119
120
    def uptime(self, command=""): # no command will come
        return self.command("uptime", "")

121
122
123
124
125
126
127
128
129
130
131
132
    # ------------------------------------------------------------------------------------------ #
    def auraengine(self, command, *args):
        if command == "state":
            return self.auraengine_state()

        return "LiquidSoapPlayerClient does not understand auraengine." + command + str(args)

    # ------------------------------------------------------------------------------------------ #
    def auraengine_state(self):
        self.command('auraengine', 'state')
        return self.message

133
134
135
136
    # ------------------------------------------------------------------------------------------ #
    def set_http_url(self, uri):
        self.command('http', 'url', uri)
        return self.message
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

    # ------------------------------------------------------------------------------------------ #
    def mixerinputs(self):
        # send command
        self.command("mixer", "inputs")

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

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

    # ------------------------------------------------------------------------------------------ #
    def mixerselect(self, pos, activate):
        """
        Kanal/Source aktivieren
        @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("mixer", "select", str(pos) + " " + str(activate).lower())
        return self.message
171
172
173
174
175
176
177
178
179
180
181
182

    # ------------------------------------------------------------------------------------------ #
    def mixervolume(self, pos, volume):
        """
        set channel volume
        :param pos:
        :param volume:
        :return:
        """
        self.command("mixer", "volume", str(pos) + " " + str(volume))
        return self.message

183
    # ------------------------------------------------------------------------------------------ #
David Trattnig's avatar
David Trattnig committed
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
    # 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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374

    # ------------------------------------------------------------------------------------------ #
    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
375
376
377
378
379
380
381
382
    # 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
383
384

    # ------------------------------------------------------------------------------------------ #
David Trattnig's avatar
David Trattnig committed
385
386
387
388
389
    # def list_channels(self):
    #     """
    #     Channels auflisten (Simple JSON)
    #     """
    #     # Liquidsoap Kommando
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
390

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

David Trattnig's avatar
David Trattnig committed
393
394
395
396
397
398
    #     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
399

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