//
//  TrackEventProducer
//  AudioPlayer
//
//  Created by Kevin DELANNOY on 13/03/16.
//  Modified by David Chavez on 7.09.17.
//  Copyright © 2016 Kevin Delannoy. All rights reserved.
//

import Foundation

// MARK: - Track+KVO

extension Track {
    //swiftlint:disable variable_name
    /// The list of properties that is observed through KVO.
    fileprivate static var ap_KVOProperties: [String] {
        return ["artist", "title", "album", "artwork"]
    }
}

// MARK: - TrackEventProducer

/// An `TrackEventProducer` generates event when a property of an `AudioItem` has changed.
class TrackEventProducer: NSObject, EventProducer {
    /// An `AudioItemEvent` gets generated by `AudioItemEventProducer` when a property of `AudioItem` changes.
    ///
    /// - updatedArtist: `artist` was updated.
    /// - updatedTitle: `title` was updated.
    /// - updatedAlbum: `album` was updated.
    /// - updatedArtwork: `artwork` was updated.
    enum TrackEvent: String, Event {
        case updatedArtist = "artist"
        case updatedTitle = "title"
        case updatedAlbum = "album"
        case updatedArtwork = "artwork"
    }
    
    /// The player to produce events with.
    ///
    /// Note that setting it has the same result as calling `stopProducingEvents`.
    var item: Track? {
        willSet {
            stopProducingEvents()
        }
    }
    
    /// The listener that will be alerted a new event occured.
    weak var eventListener: EventListener?
    
    /// A boolean value indicating whether we're currently listening to events on the player.
    private var listening = false
    
    /// Stops producing events on deinitialization.
    deinit {
        stopProducingEvents()
    }
    
    /// Starts listening to the player events.
    func startProducingEvents() {
        guard let item = item, !listening else {
            return
        }
        
        //Observing AudioItem's property
        for keyPath in Track.ap_KVOProperties {
            item.addObserver(self, forKeyPath: keyPath, options: .new, context: nil)
        }
        
        listening = true
    }
    
    /// Stops listening to the player events.
    func stopProducingEvents() {
        guard let item = item, listening else {
            return
        }
        
        //Unobserving AudioItem's property
        for keyPath in Track.ap_KVOProperties {
            item.removeObserver(self, forKeyPath: keyPath)
        }
        
        listening = false
    }
    
    /// This message is sent to the receiver when the value at the specified key path relative to the given object has
    /// changed. The receiver must be registered as an observer for the specified `keyPath` and `object`.
    ///
    /// - Parameters:
    ///   - keyPath: The key path, relative to `object`, to the value that has changed.
    ///   - object: The source object of the key path `keyPath`.
    ///   - change: A dictionary that describes the changes that have been made to the value of the property at the key
    ///         path `keyPath` relative to `object`. Entries are described in Change Dictionary Keys.
    ///   - context: The value that was provided when the receiver was registered to receive key-value observation
    ///         notifications.
    override func observeValue(forKeyPath keyPath: String?,
                               of object: Any?,
                               change: [NSKeyValueChangeKey: Any]?,
                               context: UnsafeMutableRawPointer?) {
        if let event = keyPath.flatMap({ TrackEvent(rawValue: $0) }) {
            eventListener?.onEvent(event, generetedBy: self)
        }
    }
}