""" BAPSicle Server Next-gen audio playout server for University Radio York playout, based on WebStudio interface. Flask Server Authors: Matthew Stratford Michael Grace Date: October, November 2020 """ from datetime import datetime from file_manager import FileManager import multiprocessing from multiprocessing.queues import Queue import multiprocessing.managers as m import time from typing import Any, Optional import json from setproctitle import setproctitle import psutil from helpers.os_environment import isLinux, isMacOS if not isMacOS(): # Rip, this doesn't like threading on MacOS. import pyttsx3 import package from typing import Dict, List from helpers.state_manager import StateManager from helpers.logging_manager import LoggingManager from websocket_server import WebsocketServer from web_server import WebServer from player_handler import PlayerHandler from controllers.mattchbox_usb import MattchBox from helpers.the_terminator import Terminator import player PROCESS_KILL_TIMEOUT_S = 5 setproctitle("server.py") """ Proxy Manager to proxy Class Objects into multiprocessing processes, instead of making a copy. """ class ProxyManager(m.BaseManager): pass # Pass is really enough. Nothing needs to be done here. class BAPSicleServer: default_state = { "server_version": "unknown", "server_build": "unknown", "server_branch": "unknown", "server_beta": True, "server_name": "URY BAPSicle", "host": "localhost", "port": 13500, "ws_port": 13501, "num_channels": 3, "serial_port": None, "ser_connected": False, "myradio_api_key": None, "myradio_base_url": "https://ury.org.uk/myradio", "myradio_api_url": "https://ury.org.uk/api", "myradio_api_tracklist_source": "", "running_state": "running", "tracklist_mode": "off", "normalisation_mode": "off", } player_to_q: List[Queue] = [] player_from_q: Queue ui_to_q: Queue websocket_to_q: Queue controller_to_q: Queue file_to_q: Queue player: List[multiprocessing.Process] = [] websockets_server: Optional[multiprocessing.Process] = None controller_handler: Optional[multiprocessing.Process] = None player_handler: Optional[multiprocessing.Process] = None file_manager: Optional[multiprocessing.Process] = None webserver: Optional[multiprocessing.Process] = None def __init__(self): while True: self.startServer() self.check_processes() self.stopServer() if self.state.get()["running_state"] != "restarting": break def check_processes(self): terminator = Terminator() log_function = self.logger.log.info while ( not terminator.terminate and self.state.get()[ "running_state"] == "running" ): for channel in range(self.state.get()["num_channels"]): # Use pid_exists to confirm process is actually still running. # Python may not report is_alive() correctly (especially over system sleeps etc.) # https://medium.com/pipedrive-engineering/encountering-some-python-trickery-683bd5f66750 if ( not self.player[channel] or not self.player[channel].is_alive() or not psutil.pid_exists(self.player[channel].pid) ): log_function( "Player {} not running, (re)starting.".format(channel)) self.player[channel] = multiprocessing.Process( target=player.Player, args=( channel, self.player_to_q[channel], self.player_from_q, self.state, ), ) self.player[channel].start() if ( not self.player_handler or not self.player_handler.is_alive() or not psutil.pid_exists(self.player_handler.pid) ): log_function("Player Handler not running, (re)starting.") self.player_handler = multiprocessing.Process( target=PlayerHandler, args=( self.player_from_q, self.websocket_to_q, self.ui_to_q, self.controller_to_q, self.file_to_q, ), ) self.player_handler.start() if ( not self.file_manager or not self.file_manager.is_alive() or not psutil.pid_exists(self.file_manager.pid) ): log_function("File Manager not running, (re)starting.") self.file_manager = multiprocessing.Process( target=FileManager, args=(self.file_to_q, self.state), ) self.file_manager.start() if ( not self.websockets_server or not self.websockets_server.is_alive() or not psutil.pid_exists(self.websockets_server.pid) ): log_function("Websocket Server not running, (re)starting.") self.websockets_server = multiprocessing.Process( target=WebsocketServer, args=(self.player_to_q, self.websocket_to_q, self.state), ) self.websockets_server.start() if ( not self.webserver or not self.webserver.is_alive() or not psutil.pid_exists(self.webserver.pid) ): log_function("Webserver not running, (re)starting.") self.webserver = multiprocessing.Process( target=WebServer, args=( self.player_to_q, self.ui_to_q, self.state) ) self.webserver.start() if ( not self.controller_handler or not self.controller_handler.is_alive() or not psutil.pid_exists(self.controller_handler.pid) ): log_function("Controller Handler not running, (re)starting.") self.controller_handler = multiprocessing.Process( target=MattchBox, args=(self.player_to_q, self.controller_to_q, self.state), ) self.controller_handler.start() # After first starting processes, switch logger to error, since any future starts will have been failures. log_function = self.logger.log.error time.sleep(1) def startServer(self): # On MacOS, the default causes something to keep creating new processes. # On Linux, this is needed to make pulseaudio initiate properly. if isMacOS() or isLinux(): multiprocessing.set_start_method("spawn", True) process_title = "startServer" setproctitle(process_title) multiprocessing.current_process().name = process_title self.logger = LoggingManager("BAPSicleServer") # Since we're passing the StateManager across processes, it must be made a manager. # PLEASE NOTE: You can't read attributes directly, use state.get()["var"] and state.update("var", "val") ProxyManager.register("StateManager", StateManager) manager = ProxyManager() manager.start() self.state: StateManager = manager.StateManager( "BAPSicleServer", self.logger, self.default_state ) self.state.update("running_state", "running") self.state.update("start_time", datetime.now().timestamp()) print("Launching BAPSicle...") # TODO: Check these match, if not, trigger any upgrade noticies / welcome self.state.update("server_version", package.VERSION) self.state.update("server_build", package.BUILD) self.state.update("server_branch", package.BRANCH) self.state.update("server_beta", package.BETA) channel_count = self.state.get()["num_channels"] self.player = [None] * channel_count for channel in range(self.state.get()["num_channels"]): self.player_to_q.append(multiprocessing.Queue()) self.player_from_q = multiprocessing.Queue() self.ui_to_q = multiprocessing.Queue() self.websocket_to_q = multiprocessing.Queue() self.controller_to_q = multiprocessing.Queue() self.file_to_q = multiprocessing.Queue() print( "Welcome to BAPSicle Server version: {}, build: {}.".format( package.VERSION, package.BUILD ) ) print( "The Server UI is available at http://{}:{}".format( self.state.get()["host"], self.state.get()["port"] ) ) # TODO Move this to player or installer. if False: if not isMacOS(): # Temporary RIP. # Welcome Speech text_to_speach = pyttsx3.init() text_to_speach.save_to_file( """Thank-you for installing BAPSicle - the play-out server from the broadcasting and presenting suite. By default, this server is accepting connections on port 13500 The version of the server service is {} Please refer to the documentation included with this application for further assistance.""".format( package.VERSION ), "dev/welcome.mp3", ) text_to_speach.runAndWait() new_item: Dict[str, Any] = { "channel_weight": 0, "filename": "dev/welcome.mp3", "title": "Welcome to BAPSicle", "artist": "University Radio York", } self.player_to_q[0].put("ADD:" + json.dumps(new_item)) self.player_to_q[0].put("LOAD:0") self.player_to_q[0].put("PLAY") def stopServer(self): print("Stopping BASPicle Server.") print("Stopping Websocket Server") self.websocket_to_q.put("0:WEBSOCKET:QUIT") if self.websockets_server: self.websockets_server.join(timeout=PROCESS_KILL_TIMEOUT_S) del self.websockets_server print("Stopping File Manager") if self.file_manager: self.file_manager.terminate() self.file_manager.join(timeout=PROCESS_KILL_TIMEOUT_S) del self.file_manager print("Stopping Controllers") if self.controller_handler: self.controller_handler.terminate() self.controller_handler.join(timeout=PROCESS_KILL_TIMEOUT_S) del self.controller_handler # Stop the Webserver late as we can to allow Presenter to pull images for the disconnection page if it needs to. print("Stopping Web Server") if self.webserver: self.webserver.terminate() self.webserver.join(timeout=PROCESS_KILL_TIMEOUT_S) del self.webserver print("Stopping Player Handler") if self.player_handler: self.player_handler.terminate() self.player_handler.join(timeout=PROCESS_KILL_TIMEOUT_S) del self.player_handler # Now we've stopped everything else, now is the time to stop the players. # This is to keep playing for as long as possible during a restart. print("Stopping Players") for q in self.player_to_q: q.put("ALL:QUIT") for player in self.player: player.join(timeout=PROCESS_KILL_TIMEOUT_S) del self.player print("Deleting all queues.") # Should speed up GC on exit a bit. queues = [ self.player_to_q, self.player_from_q, self.ui_to_q, self.websocket_to_q, self.controller_to_q, self.file_to_q, ] for queue in queues: if isinstance(queue, List): for inner_queue in queue: while not inner_queue.empty(): inner_queue.get() del inner_queue elif isinstance(queue, Queue): while not queue.empty(): queue.get() for queue in queues: del queue print("Stopped all processes.") if __name__ == "__main__": raise Exception("BAPSicle is a service. Please run it like one.")