engine.py 36.7 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/>.
#

25
26
import time
import logging
27
import json
28

David Trattnig's avatar
David Trattnig committed
29
30
31
32
33
from urllib.parse import urlparse, ParseResult

from modules.base.enum          import ChannelType, Channel, TransitionType, LiquidsoapResponse, EntryPlayState
from modules.base.utils         import TerminalColors, SimpleUtil, EngineUtil
from modules.base.exceptions    import LQConnectionError, InvalidChannelException, NoActiveEntryException, EngineMalfunctionException, LQStreamException, LoadSourceException
34
from modules.communication.liquidsoap.playerclient import LiquidSoapPlayerClient
35
# from modules.communication.liquidsoap.recorderclient import LiquidSoapRecorderClient
David Trattnig's avatar
David Trattnig committed
36
37
38
from modules.core.startup       import StartupThread
from modules.core.state         import PlayerStateService
from modules.core.monitor       import Monitoring
39
from modules.communication.mail import AuraMailer
40

41

David Trattnig's avatar
David Trattnig committed
42
class SoundSystem():
43
    """ 
David Trattnig's avatar
David Trattnig committed
44
    SoundSystem Class
45
46

    Uses LiquidSoapClient, but introduces more complex commands, transactions and error handling.
47
    """
48
    client = None
49
    logger = None
50
    transaction = 0
51
    channels = None
52
    scheduler = None
David Trattnig's avatar
David Trattnig committed
53
    monitoring = None
54
    #error_data = None #FIXME Can be removed
55
    auramailer = None
56
    is_liquidsoap_running = False
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
57
    connection_attempts = 0
58
    disable_logging = False
59
60
    fade_in_active = False
    fade_out_active = False
61

62
63
64
65
66
67
68
    # Active Channel & Entry Handling
    active_channel_type = None
    active_channel = None
    player_state = None
    # active_entries = None


69
    def __init__(self, config):
70
        """
71
72
73
74
75
        Initializes the communicator by establishing a Socket connection
        to Liquidsoap.

        Args:
            config (AuraConfig):    The configuration
76
        """
77
        self.config = config
78
79
        self.logger = logging.getLogger("AuraEngine")

80
81
        self.client = LiquidSoapPlayerClient(config, "engine.sock")
        # self.lqcr = LiquidSoapRecorderClient(config, "record.sock")
82
        self.auramailer = AuraMailer(self.config)
83
84
        self.monitoring = Monitoring(config, self, self.auramailer)
        
David Trattnig's avatar
David Trattnig committed
85
        self.is_active()
86

87
88
89
        # Initialize Default Channels
        self.active_channel = {
            ChannelType.FILESYSTEM: Channel.FILESYSTEM_A,
David Trattnig's avatar
David Trattnig committed
90
            ChannelType.HTTP: Channel.HTTP_A,
David Trattnig's avatar
David Trattnig committed
91
            ChannelType.HTTPS: Channel.HTTPS_A,
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
            ChannelType.LIVE: Channel.LIVE_0
        }
        # self.active_entries = {}
        self.player_state = PlayerStateService(config)



    def start(self):
        """
        Starts the soundsystem.
        """
        # Sleep needed, because the socket is created too slowly by Liquidsoap
        time.sleep(1)
        self.enable_transaction()
        time.sleep(1)

        self.mixer_start()

        # Setting init params like a blank file
        install_dir = self.config.get("install_dir")
        channel = self.active_channel[ChannelType.FILESYSTEM]
        self.playlist_push(channel, install_dir + "/configuration/blank.flac")

        self.disable_transaction()
        self.is_liquidsoap_running = True
        self.logger.info(SimpleUtil.green("Engine Core ------[ connected ]-------- Liquidsoap"))

David Trattnig's avatar
David Trattnig committed
119
120
121
122
123
124
125
126
127
128
129
        # Start Monitoring
        is_valid = self.monitoring.has_valid_status(False)
        status = self.monitoring.get_status()
        self.logger.info("Status Monitor:\n%s" % json.dumps(status, indent=4))
        if not is_valid:
            self.logger.info("Engine Status: " + SimpleUtil.red(status["engine"]["status"]))
            raise EngineMalfunctionException
        else:
            self.logger.info("Engine Status: " + SimpleUtil.green("OK"))


130
131
132

    def is_ready(self):
        """
133
        Returns `True` if the soundsystem is connected to Liquidsoap and is ready to be used.
134
135
136
        """
        return self.is_liquidsoap_running

137

138
    #
139
140
141
142
143
144
145
146
147
148
149
150
151
152
    #   MIXER : GENERAL
    # 


    def mixer_start(self):
        # Reset channels and reload them
        channels = self.reload_channels()

        # For all available channels
        for c in channels:
            # Set volume to zero
            self.channel_volume(c, "0")
            # And activate this channel
            self.channel_activate(c, True)
153
154


155
    # ------------------------------------------------------------------------------------------ #
156
157
158
    # def set_volume(self, mixernumber, volume):
    #     #return self.client.command("mixer", 'volume', mixernumber, str(volume))
    #     return self.__send_lqc_command__(self.client, "mixer", "volume", mixernumber, volume)
David Trattnig's avatar
David Trattnig committed
159

160
161
162
163
164
    # ------------------------------------------------------------------------------------------ #
    def get_active_mixer(self):
        """
        get active mixer in liquidsoap server
        :return:
165
        """
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
        activeinputs = []

        # enable more control over the connection
        self.enable_transaction()

        inputs = self.get_all_channels()

        cnt = 0
        for input in inputs:
            status = self.__get_mixer_status__(cnt)

            if "selected=true" in status:
                activeinputs.append(input)

            cnt = cnt + 1

        self.disable_transaction()

        return activeinputs
185

186
    # ------------------------------------------------------------------------------------------ #
187
188
    def get_mixer_status(self):
        inputstate = {}
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
        self.enable_transaction()

        inputs = self.get_all_channels()

        cnt = 0
        for input in inputs:
            inputstate[input] = self.__get_mixer_status__(cnt)
            cnt = cnt + 1

        self.disable_transaction()

        return inputstate


    # ------------------------------------------------------------------------------------------ #
    def get_mixer_volume(self, channel):
        return False

    # ------------------------------------------------------------------------------------------ #
    def __get_mixer_status__(self, mixernumber):
        return self.__send_lqc_command__(self.client, "mixer", "status", mixernumber)


    #
    #   MIXER : CHANNELS
    #


David Trattnig's avatar
David Trattnig committed
218
219
220
    def load(self, entry):
        """
        Preloads the entry. This is required before the actual `play(..)` can happen.
221

David Trattnig's avatar
David Trattnig committed
222
223
224
225
226
        Note his method is blocking until loading has finished. If this method is called 
        asynchroniously, the progress on the preloading state can be looked up in `entry.state`.
        """
        entry.status = EntryPlayState.LOADING
        self.logger.info("Loading entry '%s'" % entry)
227

228
229
230
231
232
233
234
235
        # Choose and save the input channel
        if entry.type == ChannelType.LIVE:
            entry.channel = "linein_" + entry.source.split("line://")[1]
        else:
            self.enable_transaction()
            self.player_state.set_active_entry(entry)
            entry.channel = self.channel_swap(entry.type)
            self.disable_transaction()
236

David Trattnig's avatar
David Trattnig committed
237
238
239
240
241
        # PLAYLIST
        if entry.type == ChannelType.FILESYSTEM:
            self.playlist_push(entry.channel, entry.source)
            
        # STREAM
David Trattnig's avatar
David Trattnig committed
242
243
        elif entry.type == ChannelType.HTTP or entry.type == ChannelType.HTTPS:
            self.stream_load_entry(entry)
David Trattnig's avatar
David Trattnig committed
244

245
246
247


    def play(self, entry, transition):
David Trattnig's avatar
David Trattnig committed
248
        """
249
250
        Plays a new `Entry`. In case of a new schedule (or some intented, immediate transition),
        a clean channel is selected and transitions between old and new channel is performed.
David Trattnig's avatar
David Trattnig committed
251
252

        Args:
David Trattnig's avatar
David Trattnig committed
253
            entry (PlaylistEntry):          The audio source to be played
254
            transition (TransitionType):    The type of transition to use e.g. fade-out.
David Trattnig's avatar
David Trattnig committed
255
            queue (Boolean):                If `True` the entry is queued if the `ChannelType` does allow so; 
256
                otherwise a new channel of the same type is activated
David Trattnig's avatar
David Trattnig committed
257
258
        
        """
259
        try:
260
261
            
            # Move channel volume all the way up
David Trattnig's avatar
David Trattnig committed
262
            self.enable_transaction()
263
264
265
266
            if transition == TransitionType.FADE:
                self.fade_in(entry)
            else:
                self.channel_volume(entry.channel, entry.volume)
David Trattnig's avatar
David Trattnig committed
267
            self.disable_transaction()
268
269
270
271
272

            # Update active channel and type
            self.active_channel[entry.type] = entry.channel     
            
            
273
        except LQConnectionError:
David Trattnig's avatar
David Trattnig committed
274
275
            # we already caught and handled this error in __send_lqc_command__, 
            # but we do not want to execute this function further and pass the exception
276
            pass
277

David Trattnig's avatar
David Trattnig committed
278

279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294

    def on_play(self, source):
        """
        Event Handler which is called by soundsystem implementation (i.e. Liquidsoap) 
        when some entry is actually playing.
        """
        self.logger.info(SimpleUtil.pink("Source '%s' started playing" % source))

        try:
            self.player_state.store_trackservice_entry(source)
        except NoActiveEntryException:
            self.logger.warn(SimpleUtil.red("Currently there's nothing playing!"))



    def stop(self, entry, transition):
David Trattnig's avatar
David Trattnig committed
295
        """
296
        Stops the currently playing entry. 
David Trattnig's avatar
David Trattnig committed
297
298

        Args:
299
300
            entry (Entry):                  The entry to stop playing
            transition (TransitionType):    The type of transition to use e.g. fade-out.
David Trattnig's avatar
David Trattnig committed
301
        """
302

303
304
        try:
            self.enable_transaction()
305

306
307
308
309
310
311
312
313
            if not entry.channel:
                self.logger.warn("Trying to stop entry %s, but it has no channel assigned" % entry)
                return
            
            if transition == TransitionType.FADE:
                self.fade_out(entry)
            else:
                self.channel_volume(entry.channel, 0)
314

315
316
            # self.playlist_clear(entry.channel)
            self.logger.info(SimpleUtil.pink("Stopped channel '%s' for entry %s" % (entry.channel, entry)))
317

318
            self.disable_transaction()
319

320
321
322
323
        except LQConnectionError:
            # we already caught and handled this error in __send_lqc_command__, 
            # but we do not want to execute this function further and pass the exception
            pass
324

David Trattnig's avatar
David Trattnig committed
325

326

327
    def channel_swap(self, channel_type):
David Trattnig's avatar
David Trattnig committed
328
329
330
331
332
333
334
335
        """
        Returns the currently in-active channel for a given type. For example if the currently some
        file on channel FILESYSTEM_A is playing, the channel FILESYSTEM B is returned for being used
        to queue new entries.

        Args:
            channel_type (ChannelType): The channel type such es filesystem, stream or live channel
        """
336
337
338
339
340
341
342
343
344
345
346
347
        active_channel = self.active_channel[channel_type]
        channel = None
        msg = None

        if channel_type == ChannelType.FILESYSTEM:
            if active_channel == Channel.FILESYSTEM_A:
                channel = Channel.FILESYSTEM_B
                msg = "Swapped filesystem channel from A > B"
            else:
                channel = Channel.FILESYSTEM_A
                msg = "Swapped filesystem channel from B > A"
            
David Trattnig's avatar
David Trattnig committed
348
349
350
351
352
            # TODO Clear old channel
            
        elif channel_type == ChannelType.HTTP:
            if active_channel == Channel.HTTP_A:
                channel = Channel.HTTP_B
David Trattnig's avatar
David Trattnig committed
353
                msg = "Swapped HTTP Stream channel from A > B"
David Trattnig's avatar
David Trattnig committed
354

355
            else:
David Trattnig's avatar
David Trattnig committed
356
                channel = Channel.HTTP_A
David Trattnig's avatar
David Trattnig committed
357
358
359
360
361
362
363
364
365
366
367
                msg = "Swapped HTTP Stream channel from B > A"


        elif channel_type == ChannelType.HTTPS:
            if active_channel == Channel.HTTPS_A:
                channel = Channel.HTTPS_B
                msg = "Swapped HTTPS Stream channel from A > B"

            else:
                channel = Channel.HTTPS_A
                msg = "Swapped HTTPS Stream channel from B > A"
David Trattnig's avatar
David Trattnig committed
368
            
369

David Trattnig's avatar
David Trattnig committed
370

371
372
        if msg: self.logger.info(SimpleUtil.pink(msg))
        return channel
373
374
375



376
377
    # ------------------------------------------------------------------------------------------ #
    def all_inputs_but(self, input_type):
378
        try:
379
            activemixer_copy = self.get_all_channels().copy()
380
            activemixer_copy.remove(input_type)
381
382
        except ValueError as e:
            self.logger.error("Requested channel (" + input_type + ") not in channellist. Reason: " + str(e))
383
384
        except AttributeError:
            self.logger.critical("Channellist is None")
385

386
387
388
389
        return activemixer_copy

    # ------------------------------------------------------------------------------------------ #
    def get_all_channels(self):
390
        if self.channels is None or len(self.channels) == 0:
391
            self.channels = self.__send_lqc_command__(self.client, "mixer", "inputs")
392
393

        return self.channels
394

395
396
397
398
399
    # ------------------------------------------------------------------------------------------ #
    def reload_channels(self):
        self.channels = None
        return self.get_all_channels()

400

401

402
403
404
    # ------------------------------------------------------------------------------------------ #
    def channel_activate(self, channel, activate):
        channels = self.get_all_channels()
405
406
407
408

        try:
            index = channels.index(channel)
            if len(channel) < 1:
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
409
410
411
412
413
414
                self.logger.critical("Cannot activate channel. There are no channels!")
            else:
                message = self.__send_lqc_command__(self.client, "mixer", "select", index, activate)
                return message
        except Exception as e:
            self.logger.critical("Ran into exception when activating channel. Reason: " + str(e))
415

416
417
418
    # ------------------------------------------------------------------------------------------ #
    def channel_volume(self, channel, volume):
        """
419
420
421
422
423
        Set volume of a channel

        Args:
            channel (Channel):      The channel
            volume  (Integer)       Volume between 0 and 100
424
        """
425

426
        channel = str(channel)
427
        try:
428
429
430
431
432
433
            if str(volume) == "100":
                channels = self.get_all_channels()
                index = channels.index(channel)
            else:
                channels = self.get_all_channels()
                index = channels.index(channel)
434
        except ValueError as e:
435
436
            msg = SimpleUtil.red("Cannot set volume of channel " + channel + " to " + str(volume) + "!. Reason: " + str(e))
            self.logger.error(msg)
David Trattnig's avatar
David Trattnig committed
437
            self.logger.info("Available channels: %s" % str(channels))
438
439
440
            return

        try:
441
            if len(channel) < 1:
442
443
                msg = SimpleUtil.red("Cannot set volume of channel " + channel + " to " + str(volume) + "! There are no channels.")
                self.logger.warning(msg)
444
            else:
445
                message = self.__send_lqc_command__(self.client, "mixer", "volume", str(index), str(int(volume)))
446

447
448
                if not self.disable_logging:
                    if message.find('volume=' + str(volume) + '%'):
449
                        self.logger.info(SimpleUtil.pink("Set volume of channel '%s' to %s" % (channel, str(volume))))
450
                    else:
451
452
                        msg = SimpleUtil.red("Setting volume of channel " + channel + " gone wrong! Liquidsoap message: " + message)
                        self.logger.warning(msg)
453

454
                return message
455
        except AttributeError as e: #(LQConnectionError, AttributeError):
456
            self.disable_transaction(force=True)
457
458
            msg = SimpleUtil.red("Ran into exception when setting volume of channel " + channel + ". Reason: " + str(e))
            self.logger.error(msg)
459

460
461

    #
462
    #   Channel Type - Stream 
463
464
    #

David Trattnig's avatar
David Trattnig committed
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501

    def stream_load_entry(self, entry):
        """
        Loads the given stream entry and updates the entries's status codes.
        """

        # Hack to avoid Liquidsoap SSL Error "Connection failed: 
        #   `SSL connection() error: error:1408F10B:SSL routines:ssl3_get_record:wrong version number`
        # when passing HTTPS URLs without the port number.
        # if EngineUtil.get_channel_type(entry.source) == ChannelType.HTTPS:

        #     old_url = urlparse(entry.source)
        #     new_url = ParseResult(scheme=old_url.scheme, netloc="{}:{}".format(old_url.hostname, 443),
        #                     path=old_url.path, params=old_url.params, query=old_url.query, fragment=old_url.fragment)
        #     self.logger.warn("Replacing entry.source HTTPS URL '%s' with '%s'" % (str(old_url.geturl()), str(new_url.geturl())))
        #     entry.Source = new_url.geturl()


        self.stream_load(entry.channel, entry.source)
        time.sleep(1)

        retry_delay = self.config.get("input_stream_retry_delay") 
        max_retries =  self.config.get("input_stream_max_retries")
        retries = 0

        while not self.stream_is_ready(entry.channel, entry.source):
            self.logger.info("Loading Stream ...")
            if retries >= max_retries:
                raise LoadSourceException("Could not connect to stream while waiting for %s seconds!" % retries*retry_delay)
            time.sleep(retry_delay)
            retries += 1

        entry.status = EntryPlayState.READY



    def stream_load(self, channel, url):
David Trattnig's avatar
David Trattnig committed
502
        """
David Trattnig's avatar
David Trattnig committed
503
504
        Preloads the stream URL on the given channel. Note this method is blocking
        some serious amount of time; hence it's worth being called asynchroneously.
David Trattnig's avatar
David Trattnig committed
505
506
        """
        result = None
507

David Trattnig's avatar
David Trattnig committed
508
        self.enable_transaction()
David Trattnig's avatar
David Trattnig committed
509
        result = self.__send_lqc_command__(self.client, channel, "stream_stop")
David Trattnig's avatar
David Trattnig committed
510
511
        
        if result != LiquidsoapResponse.SUCCESS.value:
David Trattnig's avatar
David Trattnig committed
512
            self.logger.error("%s.stop result: %s" % (channel, result))
David Trattnig's avatar
David Trattnig committed
513
            raise LQStreamException("Error while stopping stream!")
514

David Trattnig's avatar
David Trattnig committed
515
        result = self.__send_lqc_command__(self.client, channel, "stream_set_url", url)
516

David Trattnig's avatar
David Trattnig committed
517
        if result != LiquidsoapResponse.SUCCESS.value:
David Trattnig's avatar
David Trattnig committed
518
            self.logger.error("%s.set_url result: %s" % (channel, result))
David Trattnig's avatar
David Trattnig committed
519
            raise LQStreamException("Error while setting stream URL!")
520

David Trattnig's avatar
David Trattnig committed
521
522
        # Liquidsoap ignores commands sent without a certain timeout
        time.sleep(2)
523

David Trattnig's avatar
David Trattnig committed
524
525
        result = self.__send_lqc_command__(self.client, channel, "stream_start")
        self.logger.info("%s.start result: %s" % (channel, result))
526

David Trattnig's avatar
David Trattnig committed
527
528
529
530
531
        self.disable_transaction()
        return result



David Trattnig's avatar
David Trattnig committed
532
    def stream_is_ready(self, channel, url):
David Trattnig's avatar
David Trattnig committed
533
        """
David Trattnig's avatar
David Trattnig committed
534
535
        Checks if the stream on the given channel is ready to play. Note this method is blocking
        some serious amount of time even when successfull; hence it's worth being called asynchroneously.
David Trattnig's avatar
David Trattnig committed
536
537
538
539
540
        """
        result = None

        self.enable_transaction()

David Trattnig's avatar
David Trattnig committed
541
542
        result = self.__send_lqc_command__(self.client, channel, "stream_status")
        self.logger.info("%s.status result: %s" % (channel, result))
David Trattnig's avatar
David Trattnig committed
543
544
545
546
547
548
549
550
551
552
553

        if not result.startswith(LiquidsoapResponse.STREAM_STATUS_CONNECTED.value):
            return False

        lqs_url = result.split(" ")[1]
        if not url == lqs_url:
            self.logger.error("Wrong URL '%s' set for channel '%s', expected: '%s'." % (lqs_url, channel, url))
            return False

        self.disable_transaction()

David Trattnig's avatar
David Trattnig committed
554
555
556
        stream_buffer = self.config.get("input_stream_buffer")
        self.logger.info("Ready to play stream, but wait %s seconds until the buffer is filled..." % str(stream_buffer))
        time.sleep(round(float(stream_buffer)))
David Trattnig's avatar
David Trattnig committed
557
        return True
558
559


David Trattnig's avatar
David Trattnig committed
560

561

562
563
564
    #
    #   Channel Type - Playlist 
    #
David Trattnig's avatar
David Trattnig committed
565

566
567
568
569
    # FIXME
    # def playlist_activate(self, playlist, cue_in=0.0):
    #     """
    #     Activates a new Playlist.
570

571
572
573
574
575
576
577
578
579
580
    #     Args:
    #         new_entry (Playlist):       The playlist to be played
    #         cue_in (Float):             Start/cue-time of track (For some reason Liquidsoap doesn't acknowledge this yet)
        
    #     Raises:
    #         (LQConnectionError): In case connecting to LiquidSoap isn't possible
    #     """
        
    #     # Grab the actual active entry
    #     # active_entry = self.scheduler.get_active_entry()
581

582
583
    #     # Set default channel, if no previous track is available
    #     current_channel = self.active_channel[ChannelType.FILESYSTEM]
584

585
586
    #     # if active_entry:
    #     #     current_channel = active_entry.channel
587

588
589
590
591
592
593
    #     try:
    #         # FIXME clearing creates some serious timing issues
    #         # To activate this feature we'd need some more sophisticated
    #         # Liquidsoap logic, such as >= 2 filesystem channels and
    #         # possiblities to pause pre-queued channels or cleaning them
    #         # after each completed schedule.
594

595
596
597
598
599
600
    #         # self.enable_transaction()
    #         # #if active_entry:
    #         #     #self.fade_out(active_entry)
    #         # res = self.playlist_clear(current_channel)
    #         # self.logger.info("Clear Queue Response: "+res)
    #         # self.disable_transaction()
601
602


603
604
605
606
607
608
609
610
611
612
    #         self.enable_transaction()
    #         self.reload_channels()
    #         # self.fade_in(playlist.entries[0])
    #         # FIXME rework
    #         for new_entry in playlist.entries:
    #             if current_channel == new_entry.channel:
    #                 self.activate_same_channel(new_entry, cue_in)
    #             else:
    #                 self.activate_different_channel(new_entry, cue_in, current_channel)
    #                 current_channel = new_entry.channel
613

614
    #         self.disable_transaction()
615

616
617
618
619
620
621
    #         # self.logger.critical("FIXME: Implement TrackService")
    #         #self.scheduler.update_track_service(new_entry)
    #     except LQConnectionError:
    #         # we already caught and handled this error in __send_lqc_command__, 
    #         # but we do not want to execute this function further and pass the exception
    #         pass
622
623
624



625
626
627
    def playlist_push(self, channel, uri):
        """
        Adds an filesystem URI to the given `ChannelType.FILESYSTEM` channel.
628

629
630
631
632
633
634
635
636
        Args:
            uri (String):   The URI of the file
        Returns:
            LiquidSoap Response
        """
        if channel not in ChannelType.FILESYSTEM.channels:
            raise InvalidChannelException
        self.logger.info(SimpleUtil.pink("playlist.push('%s', '%s'" % (channel, uri)))
637
638
639
640
641
642
643

        self.enable_transaction()
        result = self.__send_lqc_command__(self.client, channel, "playlist_push", uri)
        self.logger.info("%s.playlist_push result: %s" % (channel, result))
        self.disable_transaction()

        return result
644
645
646



647
648
649
    def playlist_seek(self, channel, seconds_to_seek):
        """
        Forwards the player of the given `ChannelType.FILESYSTEM` channel by (n) seconds.
650

651
652
653
654
655
        Args:
            seconds_to_seeks (Float):   The seconds to skip
        """
        if channel not in ChannelType.FILESYSTEM.channels:
            raise InvalidChannelException
656

657
658
659
660
661
662
        self.enable_transaction()
        result = self.__send_lqc_command__(self.client, channel, "playlist_seek", str(seconds_to_seek))
        self.logger.info("%s.playlist_seek result: %s" % (channel, result))
        self.disable_transaction()

        return result
663
664


665
666
667
668
669
670
671
672
    def playlist_clear(self, channel):
        """
        Removes all tracks currently queued in the given `ChannelType.FILESYSTEM` channel.
        """
        if channel not in ChannelType.FILESYSTEM.channels:
            raise InvalidChannelException

        self.logger.info(SimpleUtil.pink("Clearing filesystem queue '%s'!" % channel))
673

674
675
676
677
        self.enable_transaction()
        result = self.__send_lqc_command__(self.client, channel, "playlist_clear")
        self.logger.info("%s.playlist_clear result: %s" % (channel, result))
        self.disable_transaction()
678

679
        return result
680
681
682
683
684

    #
    #   Fading 
    #

685
686
687
688
689
690

    def fade_in(self, entry):
        """
        Performs a fade-in for the given `entry` to the `entry.volume` loudness
        at channel `entry.channel`.
        """
691
692
693
694
695
        try:
            fade_in_time = float(self.config.get("fade_in_time"))

            if fade_in_time > 0:
                self.fade_in_active = True
696
                target_volume = entry.volume
697
698
699

                step = fade_in_time / target_volume

700
701
702
                msg = "Starting to fading-in '%s'. Step is %ss and target volume is %s." % \
                    (entry.channel, str(step), str(target_volume))
                self.logger.info(SimpleUtil.pink(msg))
703

704
                # Enable logging, which might have been disabled in a previous fade-out
705
706
707
708
                self.disable_logging = True
                self.client.disable_logging = True

                for i in range(target_volume):
709
                    self.channel_volume(entry.channel.value, i + 1)
710
711
                    time.sleep(step)

712
713
                msg = "Finished with fading-in '%s'." % entry.channel
                self.logger.info(SimpleUtil.pink(msg))
714
715
716
717
718

                self.fade_in_active = False
                if not self.fade_out_active:
                    self.disable_logging = False
                    self.client.disable_logging = False
719

720
721
722
723
724
        except LQConnectionError as e:
            self.logger.critical(str(e))

        return True

725
726
727
728
729
730


    def fade_out(self, entry):
        """
        Performs a fade-out for the given `entry` at channel `entry.channel`.
        """
731
732
733
734
        try:
            fade_out_time = float(self.config.get("fade_out_time"))

            if fade_out_time > 0:
735
                step = abs(fade_out_time) / entry.volume
736

737
738
                msg = "Starting to fading-out '%s'. Step is %ss." % (entry.channel, str(step))
                self.logger.info(SimpleUtil.pink(msg))
739

740
                # Disable logging... it is going to be enabled again after fadein and -out is finished
741
742
743
                self.disable_logging = True
                self.client.disable_logging = True

744
745
                for i in range(entry.volume):
                    self.channel_volume(entry.channel.value, entry.volume-i-1)
746
747
                    time.sleep(step)

748
749
                msg = "Finished with fading-out '%s'" % entry.channel
                self.logger.info(SimpleUtil.pink(msg))
750

751
                # Enable logging again
752
753
754
755
                self.fade_out_active = False
                if not self.fade_in_active:
                    self.disable_logging = False
                    self.client.disable_logging = False
756

757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
        except LQConnectionError as e:
            self.logger.critical(str(e))

        return True



    #
    #   Recording
    #


    # ------------------------------------------------------------------------------------------ #
    def recorder_stop(self):
        self.enable_transaction()

        for i in range(5):
            if self.config.get("rec_" + str(i)) == "y":
                self.__send_lqc_command__(self.client, "recorder_" + str(i), "stop")

        self.disable_transaction()

    # ------------------------------------------------------------------------------------------ #
    def recorder_start(self, num=-1):
        if not self.is_liquidsoap_running:
            if num==-1:
                msg = "Want to start recorder, but LiquidSoap is not running"
            else:
                msg = "Want to start recorder " + str(num) + ", but LiquidSoap is not running"
            self.logger.warning(msg)
            return False

        self.enable_transaction()

        if num == -1:
            self.recorder_start_all()
        else:
            self.recorder_start_one(num)

        self.disable_transaction()

    # ------------------------------------------------------------------------------------------ #
    def recorder_start_all(self):
        if not self.is_liquidsoap_running:
            self.logger.warning("Want to start all recorder, but LiquidSoap is not running")
            return False

        self.enable_transaction()
        for i in range(5):
            self.recorder_start_one(i)
        self.disable_transaction()

    # ------------------------------------------------------------------------------------------ #
    def recorder_start_one(self, num):
        if not self.is_liquidsoap_running:
            return False

        if self.config.get("rec_" + str(num)) == "y":
            returnvalue = self.__send_lqc_command__(self.client, "recorder", str(num), "status")

            if returnvalue == "off":
                self.__send_lqc_command__(self.client, "recorder", str(num), "start")

    # ------------------------------------------------------------------------------------------ #
    def get_recorder_status(self):
        self.enable_transaction(self.client)
        recorder_state = self.__send_lqc_command__(self.client, "record", "status")
        self.disable_transaction(self.client)

        return recorder_state



    #
    #   Basic Methods
    #


    def init_player(self):
836
        """
837
838
839
840
        Initializes the LiquidSoap Player after startup of the engine.

        Returns:
            (String):   Message that the player is started.
841
        """
842
        t = StartupThread(self)
843
844
        t.start()

845
        return "Engine Core startup done!"
846

847
848

    # ------------------------------------------------------------------------------------------ #
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
849
    def __send_lqc_command__(self, lqs_instance, namespace, command, *args):
850
851
852
853
854
855
856
857
858
859
860
861
862
863
        """
        Ein Kommando an Liquidsoap senden
        @type  lqs_instance: object
        @param lqs_instance: Instance of LiquidSoap Client
        @type  namespace:    string
        @param namespace:    Namespace of function
        @type  command:      string
        @param command:      Function name
        @type args:          list
        @param args:         List of parameters
        @rtype:              string
        @return:             Response from LiquidSoap
        """
        try:
864
865
            if not self.disable_logging:
                if namespace == "recorder":
866
                    self.logger.debug("LiquidSoapCommunicator is calling " + str(namespace) + "_" + str(command) + "." + str(args))
867
                else:
868
                    if command == "":
869
                        self.logger.debug("LiquidSoapCommunicator is calling " + str(namespace) + str(args))
870
                    else:
871
                        self.logger.debug("LiquidSoapCommunicator is calling " + str(namespace) + "." + str(command) + str(args))
872

873
            # call wanted function ...
874
875

            # FIXME REFACTOR all calls in a common way
David Trattnig's avatar
David Trattnig committed
876
            if command in  ["playlist_push", "playlist_seek", "playlist_clear", "stream_set_url", "stream_start", "stream_stop", "stream_status"]:
877
878
879
880
881
882
                func = getattr(lqs_instance, command)
                result = func(str(namespace), *args)
            else:
                func = getattr(lqs_instance, namespace)
                result = func(command, *args)            

883

884
885
            if not self.disable_logging:
                self.logger.debug("LiquidSoapCommunicator got response " + str(result))
886

Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
887
            self.connection_attempts = 0
888

889
890
            return result

891
        except LQConnectionError as e:
892
            self.logger.error("Connection Error when sending " + str(namespace) + "." + str(command) + str(args))
893
            if self.try_to_reconnect():
894
                time.sleep(0.2)
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
895
896
                self.connection_attempts += 1
                if self.connection_attempts < 5:
897
898
899
900
901
902
903
904
905
                    # reconnect
                    self.__open_conn(self.client)
                    self.logger.info("Trying to resend " + str(namespace) + "." + str(command) + str(args))
                    # grab return value
                    retval = self.__send_lqc_command__(lqs_instance, namespace, command, *args)
                    # disconnect
                    self.__close_conn(self.client)
                    # return the val
                    return retval
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
906
                else:
907
908
909
910
911
912
                    if command == "":
                        msg = "Rethrowing Exception while trying to send " + str(namespace) + str(args)
                    else:
                        msg = "Rethrowing Exception while trying to send " + str(namespace) + "." + str(command) + str(args)

                    self.logger.info(msg)
913
                    self.disable_transaction(socket=self.client, force=True)
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
914
                    raise e
915
            else:
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
916
                # also store when was last admin mail sent with which content...
David Trattnig's avatar
David Trattnig committed
917
                # FIXME implement admin mail sending
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
918
                self.logger.critical("SEND ADMIN MAIL AT THIS POINT")
919
920
                raise e

David Trattnig's avatar
David Trattnig committed
921
922
923
924
925

    def is_active(self):
        """
        Checks if Liquidsoap is running
        """
926
927
928
929
930
931
932
933
934
        try:
            self.uptime()
            self.is_liquidsoap_running = True
        except LQConnectionError as e:
            self.logger.info("Liquidsoap is not running so far")
            self.is_liquidsoap_running = False
        except Exception as e:
            self.logger.error("Cannot check if Liquidsoap is running. Reason: " + str(e))
            self.is_liquidsoap_running = False
David Trattnig's avatar
David Trattnig committed
935
936
        
        return self.is_liquidsoap_running
937

David Trattnig's avatar
David Trattnig committed
938
939
940
941
942
943

    def engine_state(self):
        """
        Retrieves the state of all inputs and outputs.
        """
        state = self.__send_lqc_command__(self.client, "engine", "state")
944
945
        return state

David Trattnig's avatar
David Trattnig committed
946

947
    def liquidsoap_help(self):
David Trattnig's avatar
David Trattnig committed
948
949
950
        """
        Retrieves the Liquidsoap help.
        """
951
952
953
954
955
956
957
        data = self.__send_lqc_command__(self.client, "help", "")
        if not data:
            self.logger.warning("Could not get Liquidsoap's help")
        else:
            self.logger.debug("Got Liquidsoap's help")
        return data

David Trattnig's avatar
David Trattnig committed
958

959
960
    def version(self):
        """
David Trattnig's avatar
David Trattnig committed
961
        Get the version of Liquidsoap.
962
963
964
965
966
        """
        data = self.__send_lqc_command__(self.client, "version", "")
        self.logger.debug("Got Liquidsoap's version")
        return data

David Trattnig's avatar
David Trattnig committed
967

968
969
    def uptime(self):
        """
David Trattnig's avatar
David Trattnig committed
970
        Retrieves the uptime of Liquidsoap.
971
972
973
974
975
976
977
978
979
980
981
        """
        data = self.__send_lqc_command__(self.client, "uptime", "")
        self.logger.debug("Got Liquidsoap's uptime")
        return data


    #
    #   Connection and Transaction Handling
    #


982
    # ------------------------------------------------------------------------------------------ #
983
984
985
986
987
988
989
990
    def try_to_reconnect(self):
        self.enable_transaction()
        return self.transaction > 0

    # ------------------------------------------------------------------------------------------ #
    def enable_transaction(self, socket=None):
        # set socket to playout if nothing else is given
        if socket is None:
991
            socket = self.client
992

993
994
        self.transaction = self.transaction + 1

995
        self.logger.debug(TerminalColors.WARNING.value + "Enabling transaction! cnt: " + str(self.transaction) + TerminalColors.ENDC.value)
996
997
998
999

        if self.transaction > 1:
            return

1000
        try: