Source/UPnAtom.swift

//
//  UPnAtom.swift
//
//  Copyright (c) 2015 David Robles
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in all
//  copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
//  SOFTWARE.

import Foundation

/// TODO: For now rooting to NSObject to expose to Objective-C, see Github issue #16
public class UPnAtom: NSObject {
    // public
    public static let sharedInstance = UPnAtom()
    public let upnpRegistry: UPnPRegistry
    public var ssdpTypes: Set<String> {
        get { return ssdpDiscoveryAdapter.rawSSDPTypes }
        set { ssdpDiscoveryAdapter.rawSSDPTypes = newValue }
    }
    
    // internal
    unowned let ssdpDiscoveryAdapter: SSDPDiscoveryAdapter
    
    override init() {
        // configure discovery adapter
        let adapterClass = UPnAtom.ssdpDiscoveryAdapterClass()
        let adapter = adapterClass.init()
        ssdpDiscoveryAdapter = adapter

        // configure UPNP registry
        upnpRegistry = UPnPRegistry(ssdpDiscoveryAdapter: ssdpDiscoveryAdapter)
        for (upnpClass, urn) in UPnAtom.upnpClasses() {
            self.upnpRegistry.register(upnpClass: upnpClass, forURN: urn)
        }
    }
    
    deinit {
        ssdpDiscoveryAdapter.stop()
    }
    
    public func ssdpDiscoveryRunning() -> Bool {
        return ssdpDiscoveryAdapter.running
    }
    
    public func startSSDPDiscovery() {
        ssdpDiscoveryAdapter.start()
    }
    
    public func stopSSDPDiscovery() {
        ssdpDiscoveryAdapter.stop()
    }
    
    public func restartSSDPDiscovery() {
        ssdpDiscoveryAdapter.restart()
    }
    
    /// Override to use a different SSDP adapter if another SSDP system is preferred over CocoaSSDP
    class func ssdpDiscoveryAdapterClass() -> AbstractSSDPDiscoveryAdapter.Type {
        return SSDPExplorerDiscoveryAdapter.self
    }
    
    /// Override to use a different default set of UPnP classes. Alternatively, registrations can be replaced, see UPnAtom.upnpRegistry.register()
    class func upnpClasses() -> [(upnpClass: AbstractUPnP.Type, forURN: String)] {
        return [
            (upnpClass: MediaRenderer1Device.self, forURN: "urn:schemas-upnp-org:device:MediaRenderer:1"),
            (upnpClass: MediaServer1Device.self, forURN: "urn:schemas-upnp-org:device:MediaServer:1"),
            (upnpClass: AVTransport1Service.self, forURN: "urn:schemas-upnp-org:service:AVTransport:1"),
            (upnpClass: ConnectionManager1Service.self, forURN: "urn:schemas-upnp-org:service:ConnectionManager:1"),
            (upnpClass: ContentDirectory1Service.self, forURN: "urn:schemas-upnp-org:service:ContentDirectory:1"),
            (upnpClass: RenderingControl1Service.self, forURN: "urn:schemas-upnp-org:service:RenderingControl:1")
        ]
    }
}