playdate-kit/Sources/PlaydateKit/GraphicsVideo.swift

//
//  GraphicsVideo.swift
//  VideoPlayer and StreamPlayer wrappers around LCDVideoPlayer /
//  LCDStreamPlayer (playdate->graphics->video / ->videostream).
//

internal import CPlaydate

private var videoAPI: UnsafePointer<playdate_video> { Playdate.videoAPI.unsafelyUnwrapped }
private var streamAPI: UnsafePointer<playdate_videostream> { Playdate.videoStreamAPI.unsafelyUnwrapped }

extension Graphics {
    /// Plays .pdv video files. Wraps `LCDVideoPlayer`.
    public final class VideoPlayer {
        let pointer: OpaquePointer
        let isOwned: Bool
        /// Retains the render context bitmap while the player uses it.
        private var retainedContext: Bitmap?

        init(pointer: OpaquePointer, isOwned: Bool) {
            self.pointer = pointer
            self.isOwned = isOwned
        }

        /// Opens the .pdv file at `path`.
        public convenience init(path: String) throws(PlaydateError) {
            let pointer = path.withPlaydateCString { videoAPI.pointee.loadVideo.unsafelyUnwrapped($0) }
            guard let pointer else {
                throw PlaydateError(message: "unable to load video: \(path)")
            }
            self.init(pointer: pointer, isOwned: true)
        }

        deinit {
            if isOwned {
                videoAPI.pointee.freePlayer.unsafelyUnwrapped(pointer)
            }
        }

        /// Sets the bitmap the video renders into.
        public func setContext(_ context: Bitmap) throws(PlaydateError) {
            guard videoAPI.pointee.setContext.unsafelyUnwrapped(pointer, context.pointer) != 0 else {
                throw PlaydateError(message: error ?? "unable to set video context")
            }
            retainedContext = context
        }

        /// The bitmap the video renders into.
        public var context: Bitmap? {
            guard let context = videoAPI.pointee.getContext.unsafelyUnwrapped(pointer) else { return nil }
            return Bitmap(pointer: context, isOwned: false)
        }

        /// Renders directly into the display framebuffer.
        public func useScreenContext() {
            retainedContext = nil
            videoAPI.pointee.useScreenContext.unsafelyUnwrapped(pointer)
        }

        /// Renders frame `frame` into the current context.
        public func renderFrame(_ frame: Int) throws(PlaydateError) {
            guard videoAPI.pointee.renderFrame.unsafelyUnwrapped(pointer, Int32(frame)) != 0 else {
                // Static message: the caller knows the frame it passed, and
                // interpolating it would pull integer formatting machinery
                // into the device binary.
                throw PlaydateError(message: error ?? "unable to render frame")
            }
        }

        /// The most recent error message, if any.
        public var error: String? {
            String(playdateCString: videoAPI.pointee.getError.unsafelyUnwrapped(pointer))
        }

        /// The video's dimensions, frame rate, frame count, and current frame.
        public var info: (width: Int, height: Int, frameRate: Float, frameCount: Int, currentFrame: Int) {
            var width: Int32 = 0, height: Int32 = 0, frameCount: Int32 = 0, currentFrame: Int32 = 0
            var frameRate: Float = 0
            videoAPI.pointee.getInfo.unsafelyUnwrapped(pointer, &width, &height, &frameRate,
                                               &frameCount, &currentFrame)
            return (Int(width), Int(height), frameRate, Int(frameCount), Int(currentFrame))
        }
    }

    /// Streams video (and audio) from a file or network connection.
    /// Wraps `LCDStreamPlayer`.
    public final class StreamPlayer {
        let pointer: OpaquePointer
        /// Retains the active source so it outlives the stream.
        private var retainedSource: AnyObject?

        public init() {
            pointer = streamAPI.pointee.newPlayer.unsafelyUnwrapped().unsafelyUnwrapped
        }

        deinit {
            streamAPI.pointee.freePlayer.unsafelyUnwrapped(pointer)
        }

        /// Sets the sizes of the stream's video and audio buffers, in bytes.
        public func setBufferSize(video: Int, audio: Int) {
            streamAPI.pointee.setBufferSize.unsafelyUnwrapped(pointer, Int32(video), Int32(audio))
        }

        /// Streams from an open file.
        public func setFile(_ file: File.Handle) {
            retainedSource = file
            streamAPI.pointee.setFile.unsafelyUnwrapped(pointer, file.pointer)
        }

        /// Streams from an HTTP connection.
        public func setHTTPConnection(_ connection: Network.HTTPConnection) {
            retainedSource = connection
            streamAPI.pointee.setHTTPConnection.unsafelyUnwrapped(pointer, connection.pointer)
        }

        /// Streams from a TCP connection.
        public func setTCPConnection(_ connection: Network.TCPConnection) {
            retainedSource = connection
            streamAPI.pointee.setTCPConnection.unsafelyUnwrapped(pointer, connection.pointer)
        }

        /// The player used for the stream's audio track. Owned by the stream.
        /// The same wrapper is returned on every access, so callbacks
        /// registered on it stay valid for the stream's lifetime.
        public var filePlayer: Sound.FilePlayer? {
            guard let player = streamAPI.pointee.getFilePlayer.unsafelyUnwrapped(pointer) else { return nil }
            if let cached = cachedFilePlayer, cached.pointer == player {
                return cached
            }
            let wrapper = Sound.FilePlayer(pointer: player, isOwned: false)
            cachedFilePlayer = wrapper
            return wrapper
        }

        private var cachedFilePlayer: Sound.FilePlayer?

        /// The player used for the stream's video track. Owned by the stream.
        public var videoPlayer: VideoPlayer? {
            guard let player = streamAPI.pointee.getVideoPlayer.unsafelyUnwrapped(pointer) else { return nil }
            return VideoPlayer(pointer: player, isOwned: false)
        }

        /// Advances the stream. Returns `true` if a frame was drawn.
        @discardableResult
        public func update() -> Bool {
            streamAPI.pointee.update.unsafelyUnwrapped(pointer)
        }

        /// The number of video frames currently buffered.
        public var bufferedFrameCount: Int {
            Int(streamAPI.pointee.getBufferedFrameCount.unsafelyUnwrapped(pointer))
        }

        /// The total number of bytes read from the source.
        public var bytesRead: UInt32 {
            streamAPI.pointee.getBytesRead.unsafelyUnwrapped(pointer)
        }
    }
}