/* * This file is part of mpv. * * mpv is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * mpv 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 Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with mpv. If not, see . */ import Cocoa import IOKit.pwr_mgt class Common: NSObject { var mpv: MPVHelper? var log: LogHelper let queue: DispatchQueue = DispatchQueue(label: "io.mpv.queue") var window: Window? var view: View? var titleBar: TitleBar? var link: CVDisplayLink? let eventsLock = NSLock() var events: Int = 0 var lightSensor: io_connect_t = 0 var lastLmu: UInt64 = 0 var lightSensorIOPort: IONotificationPortRef? var displaySleepAssertion: IOPMAssertionID = IOPMAssertionID(0) var appNotificationObservers: [NSObjectProtocol] = [] var cursorVisibilityWanted: Bool = true var title: String = "mpv" { didSet { if let window = window { window.title = title } } } init(_ mpLog: OpaquePointer?) { log = LogHelper(mpLog) } func initMisc(_ vo: UnsafeMutablePointer) { guard let mpv = mpv else { log.sendError("Something went wrong, no MPVHelper was initialized") exit(1) } startDisplayLink(vo) initLightSensor() addDisplayReconfigureObserver() addAppNotifications() mpv.setMacOptionCallback(macOptsWakeupCallback, context: self) } func initApp() { guard let mpv = mpv else { log.sendError("Something went wrong, no MPVHelper was initialized") exit(1) } var policy: NSApplication.ActivationPolicy = .regular switch mpv.macOpts.macos_app_activation_policy { case 0: policy = .regular case 1: policy = .accessory case 2: policy = .prohibited default: break } NSApp.setActivationPolicy(policy) setAppIcon() } func initWindow(_ vo: UnsafeMutablePointer, _ previousActiveApp: NSRunningApplication?) { let (mpv, targetScreen, wr) = getInitProperties(vo) guard let view = self.view else { log.sendError("Something went wrong, no View was initialized") exit(1) } window = Window(contentRect: wr, screen: targetScreen, view: view, common: self) guard let window = self.window else { log.sendError("Something went wrong, no Window was initialized") exit(1) } window.setOnTop(Bool(mpv.opts.ontop), Int(mpv.opts.ontop_level)) window.setOnAllWorkspaces(Bool(mpv.opts.all_workspaces)) window.keepAspect = Bool(mpv.opts.keepaspect_window) window.title = title window.border = Bool(mpv.opts.border) titleBar = TitleBar(frame: wr, window: window, common: self) let minimized = Bool(mpv.opts.window_minimized) window.isRestorable = false window.isReleasedWhenClosed = false window.setMaximized(minimized ? false : Bool(mpv.opts.window_maximized)) window.setMinimized(minimized) window.makeMain() window.makeKey() if !minimized { window.orderFront(nil) } NSApp.activate(ignoringOtherApps: mpv.opts.focus_on_open) // workaround for macOS 10.15 to refocus the previous App if (!mpv.opts.focus_on_open) { previousActiveApp?.activate(options: .activateAllWindows) } } func initView(_ vo: UnsafeMutablePointer, _ layer: CALayer) { let (_, _, wr) = getInitProperties(vo) view = View(frame: wr, common: self) guard let view = self.view else { log.sendError("Something went wrong, no View was initialized") exit(1) } view.layer = layer view.wantsLayer = true view.layerContentsPlacement = .scaleProportionallyToFit } func initWindowState() { if mpv?.opts.fullscreen ?? false { DispatchQueue.main.async { self.window?.toggleFullScreen(nil) } } else { window?.isMovableByWindowBackground = true } } func uninitCommon() { setCursorVisiblility(true) stopDisplaylink() uninitLightSensor() removeDisplayReconfigureObserver() removeAppNotifications() enableDisplaySleep() window?.orderOut(nil) titleBar?.removeFromSuperview() view?.removeFromSuperview() } let linkCallback: CVDisplayLinkOutputCallback = { (displayLink: CVDisplayLink, inNow: UnsafePointer, inOutputTime: UnsafePointer, flagsIn: CVOptionFlags, flagsOut: UnsafeMutablePointer, displayLinkContext: UnsafeMutableRawPointer?) -> CVReturn in let com = unsafeBitCast(displayLinkContext, to: Common.self) return com.displayLinkCallback(displayLink, inNow, inOutputTime, flagsIn, flagsOut) } func displayLinkCallback(_ displayLink: CVDisplayLink, _ inNow: UnsafePointer, _ inOutputTime: UnsafePointer, _ flagsIn: CVOptionFlags, _ flagsOut: UnsafeMutablePointer) -> CVReturn { return kCVReturnSuccess } func startDisplayLink(_ vo: UnsafeMutablePointer) { CVDisplayLinkCreateWithActiveCGDisplays(&link) guard let screen = getTargetScreen(forFullscreen: false) ?? NSScreen.main, let link = self.link else { log.sendWarning("Couldn't start DisplayLink, no MPVHelper, Screen or DisplayLink available") return } CVDisplayLinkSetCurrentCGDisplay(link, screen.displayID) if #available(macOS 10.12, *) { CVDisplayLinkSetOutputHandler(link) { link, now, out, inFlags, outFlags -> CVReturn in return self.displayLinkCallback(link, now, out, inFlags, outFlags) } } else { CVDisplayLinkSetOutputCallback(link, linkCallback, MPVHelper.bridge(obj: self)) } CVDisplayLinkStart(link) } func stopDisplaylink() { if let link = self.link, CVDisplayLinkIsRunning(link) { CVDisplayLinkStop(link) } } func updateDisplaylink() { guard let screen = window?.screen, let link = self.link else { log.sendWarning("Couldn't update DisplayLink, no Screen or DisplayLink available") return } CVDisplayLinkSetCurrentCGDisplay(link, screen.displayID) queue.asyncAfter(deadline: DispatchTime.now() + 0.1) { self.flagEvents(VO_EVENT_WIN_STATE) } } func currentFps() -> Double { if let link = self.link { var actualFps = CVDisplayLinkGetActualOutputVideoRefreshPeriod(link) let nominalData = CVDisplayLinkGetNominalOutputVideoRefreshPeriod(link) if (nominalData.flags & Int32(CVTimeFlags.isIndefinite.rawValue)) < 1 { let nominalFps = Double(nominalData.timeScale) / Double(nominalData.timeValue) if actualFps > 0 { actualFps = 1/actualFps } if fabs(actualFps - nominalFps) > 0.1 { log.sendVerbose("Falling back to nominal display refresh rate: \(nominalFps)") return nominalFps } else { return actualFps } } } else { log.sendWarning("No DisplayLink available") } log.sendWarning("Falling back to standard display refresh rate: 60Hz") return 60.0 } func enableDisplaySleep() { IOPMAssertionRelease(displaySleepAssertion) displaySleepAssertion = IOPMAssertionID(0) } func disableDisplaySleep() { if displaySleepAssertion != IOPMAssertionID(0) { return } IOPMAssertionCreateWithName( kIOPMAssertionTypePreventUserIdleDisplaySleep as CFString, IOPMAssertionLevel(kIOPMAssertionLevelOn), "io.mpv.video_playing_back" as CFString, &displaySleepAssertion) } func lmuToLux(_ v: UInt64) -> Int { // the polinomial approximation for apple lmu value -> lux was empirically // derived by firefox developers (Apple provides no documentation). // https://bugzilla.mozilla.org/show_bug.cgi?id=793728 let power_c4: Double = 1 / pow(10, 27) let power_c3: Double = 1 / pow(10, 19) let power_c2: Double = 1 / pow(10, 12) let power_c1: Double = 1 / pow(10, 5) let lum = Double(v) let term4: Double = -3.0 * power_c4 * pow(lum, 4.0) let term3: Double = 2.6 * power_c3 * pow(lum, 3.0) let term2: Double = -3.4 * power_c2 * pow(lum, 2.0) let term1: Double = 3.9 * power_c1 * lum let lux = Int(ceil(term4 + term3 + term2 + term1 - 0.19)) return lux > 0 ? lux : 0 } var lightSensorCallback: IOServiceInterestCallback = { (ctx, service, messageType, messageArgument) -> Void in let com = unsafeBitCast(ctx, to: Common.self) var outputs: UInt32 = 2 var values: [UInt64] = [0, 0] var kr = IOConnectCallMethod(com.lightSensor, 0, nil, 0, nil, 0, &values, &outputs, nil, nil) if kr == KERN_SUCCESS { var mean = (values[0] + values[1]) / 2 if com.lastLmu != mean { com.lastLmu = mean com.lightSensorUpdate() } } } func lightSensorUpdate() { log.sendWarning("lightSensorUpdate not implemented") } func initLightSensor() { let srv = IOServiceGetMatchingService(kIOMasterPortDefault, IOServiceMatching("AppleLMUController")) if srv == IO_OBJECT_NULL { log.sendVerbose("Can't find an ambient light sensor") return } lightSensorIOPort = IONotificationPortCreate(kIOMasterPortDefault) IONotificationPortSetDispatchQueue(lightSensorIOPort, queue) var n = io_object_t() IOServiceAddInterestNotification(lightSensorIOPort, srv, kIOGeneralInterest, lightSensorCallback, MPVHelper.bridge(obj: self), &n) let kr = IOServiceOpen(srv, mach_task_self_, 0, &lightSensor) IOObjectRelease(srv) if kr != KERN_SUCCESS { log.sendVerbose("Can't start ambient light sensor connection") return } lightSensorCallback(MPVHelper.bridge(obj: self), 0, 0, nil) } func uninitLightSensor() { if lightSensorIOPort != nil { IONotificationPortDestroy(lightSensorIOPort) IOObjectRelease(lightSensor) } } var reconfigureCallback: CGDisplayReconfigurationCallBack = { (display, flags, userInfo) in if flags.contains(.setModeFlag) { let com = unsafeBitCast(userInfo, to: Common.self) let displayID = com.window?.screen?.displayID ?? display if displayID == display { com.log.sendVerbose("Detected display mode change, updating screen refresh rate") com.flagEvents(VO_EVENT_WIN_STATE) } } } func addDisplayReconfigureObserver() { CGDisplayRegisterReconfigurationCallback(reconfigureCallback, MPVHelper.bridge(obj: self)) } func removeDisplayReconfigureObserver() { CGDisplayRemoveReconfigurationCallback(reconfigureCallback, MPVHelper.bridge(obj: self)) } func addAppNotifications() { appNotificationObservers.append(NotificationCenter.default.addObserver( forName: NSApplication.didBecomeActiveNotification, object: nil, queue: .main, using: { [weak self] (_) in self?.appDidBecomeActive() } )) appNotificationObservers.append(NotificationCenter.default.addObserver( forName: NSApplication.didResignActiveNotification, object: nil, queue: .main, using: { [weak self] (_) in self?.appDidResignActive() } )) } func removeAppNotifications() { appNotificationObservers.forEach { NotificationCenter.default.removeObserver($0) } appNotificationObservers.removeAll() } func appDidBecomeActive() { flagEvents(VO_EVENT_FOCUS) } func appDidResignActive() { flagEvents(VO_EVENT_FOCUS) } func setAppIcon() { if let app = NSApp as? Application, ProcessInfo.processInfo.environment["MPVBUNDLE"] != "true" { NSApp.applicationIconImage = app.getMPVIcon() } } func updateCursorVisibility() { setCursorVisiblility(cursorVisibilityWanted) } func setCursorVisiblility(_ visible: Bool) { NSCursor.setHiddenUntilMouseMoves(!visible && (view?.canHideCursor() ?? false)) } func updateICCProfile() { log.sendWarning("updateICCProfile not implemented") } func getScreenBy(id screenID: Int) -> NSScreen? { if screenID >= NSScreen.screens.count { log.sendInfo("Screen ID \(screenID) does not exist, falling back to current device") return nil } else if screenID < 0 { return nil } return NSScreen.screens[screenID] } func getScreenBy(name screenName: String?) -> NSScreen? { for screen in NSScreen.screens { if screen.displayName == screenName { return screen } } return nil } func getTargetScreen(forFullscreen fs: Bool) -> NSScreen? { guard let mpv = mpv else { log.sendWarning("Unexpected nil value in getTargetScreen") return nil } let screenID = fs ? mpv.opts.fsscreen_id : mpv.opts.screen_id var name: String? if let screenName = fs ? mpv.opts.fsscreen_name : mpv.opts.screen_name { name = String(cString: screenName) } return getScreenBy(id: Int(screenID)) ?? getScreenBy(name: name) } func getCurrentScreen() -> NSScreen? { return window != nil ? window?.screen : getTargetScreen(forFullscreen: false) ?? NSScreen.main } func getWindowGeometry(forScreen screen: NSScreen, videoOut vo: UnsafeMutablePointer) -> NSRect { let r = screen.convertRectToBacking(screen.frame) let targetFrame = (mpv?.macOpts.macos_geometry_calculation ?? Int32(FRAME_VISIBLE)) == FRAME_VISIBLE ? screen.visibleFrame : screen.frame let rv = screen.convertRectToBacking(targetFrame) // convert origin to be relative to target screen var originY = rv.origin.y - r.origin.y let originX = rv.origin.x - r.origin.x // flip the y origin, mp_rect expects the origin at the top-left // macOS' windowing system operates from the bottom-left originY = -(originY + rv.size.height) var screenRC: mp_rect = mp_rect(x0: Int32(originX), y0: Int32(originY), x1: Int32(originX + rv.size.width), y1: Int32(originY + rv.size.height)) var geo: vo_win_geometry = vo_win_geometry() vo_calc_window_geometry2(vo, &screenRC, Double(screen.backingScaleFactor), &geo) vo_apply_window_geometry(vo, &geo) let height = CGFloat(geo.win.y1 - geo.win.y0) let width = CGFloat(geo.win.x1 - geo.win.x0) // flip the y origin again let y = CGFloat(-geo.win.y1) let x = CGFloat(geo.win.x0) return screen.convertRectFromBacking(NSMakeRect(x, y, width, height)) } func getInitProperties(_ vo: UnsafeMutablePointer) -> (MPVHelper, NSScreen, NSRect) { guard let mpv = mpv else { log.sendError("Something went wrong, no MPVHelper was initialized") exit(1) } guard let targetScreen = getTargetScreen(forFullscreen: false) ?? NSScreen.main else { log.sendError("Something went wrong, no Screen was found") exit(1) } let wr = getWindowGeometry(forScreen: targetScreen, videoOut: vo) return (mpv, targetScreen, wr) } // call before initApp, because on macOS +10.15 it changes the active App func getActiveApp() -> NSRunningApplication? { return NSWorkspace.shared.runningApplications.first(where: {$0.isActive}) } func flagEvents(_ ev: Int) { eventsLock.lock() events |= ev eventsLock.unlock() guard let vout = mpv?.vo else { log.sendWarning("vo nil in flagEvents") return } vo_wakeup(vout) } func checkEvents() -> Int { eventsLock.lock() let ev = events events = 0 eventsLock.unlock() return ev } func windowDidEndAnimation() {} func windowSetToFullScreen() {} func windowSetToWindow() {} func windowDidUpdateFrame() {} func windowDidChangeScreen() {} func windowDidChangeScreenProfile() {} func windowDidChangeBackingProperties() {} func windowWillStartLiveResize() {} func windowDidEndLiveResize() {} func windowDidResize() {} func windowDidChangeOcclusionState() {} @objc func control(_ vo: UnsafeMutablePointer, events: UnsafeMutablePointer, request: UInt32, data: UnsafeMutableRawPointer?) -> Int32 { guard let mpv = mpv else { log.sendWarning("Unexpected nil value in Control Callback") return VO_FALSE } switch mp_voctrl(request) { case VOCTRL_CHECK_EVENTS: events.pointee |= Int32(checkEvents()) return VO_TRUE case VOCTRL_VO_OPTS_CHANGED: var opt: UnsafeMutableRawPointer? while mpv.nextChangedOption(property: &opt) { switch opt { case MPVHelper.getPointer(&mpv.optsPtr.pointee.border): DispatchQueue.main.async { self.window?.border = Bool(mpv.opts.border) } case MPVHelper.getPointer(&mpv.optsPtr.pointee.fullscreen): DispatchQueue.main.async { self.window?.toggleFullScreen(nil) } case MPVHelper.getPointer(&mpv.optsPtr.pointee.ontop): fallthrough case MPVHelper.getPointer(&mpv.optsPtr.pointee.ontop_level): DispatchQueue.main.async { self.window?.setOnTop(Bool(mpv.opts.ontop), Int(mpv.opts.ontop_level)) } case MPVHelper.getPointer(&mpv.optsPtr.pointee.all_workspaces): DispatchQueue.main.async { self.window?.setOnAllWorkspaces(Bool(mpv.opts.all_workspaces)) } case MPVHelper.getPointer(&mpv.optsPtr.pointee.keepaspect_window): DispatchQueue.main.async { self.window?.keepAspect = Bool(mpv.opts.keepaspect_window) } case MPVHelper.getPointer(&mpv.optsPtr.pointee.window_minimized): DispatchQueue.main.async { self.window?.setMinimized(Bool(mpv.opts.window_minimized)) } case MPVHelper.getPointer(&mpv.optsPtr.pointee.window_maximized): DispatchQueue.main.async { self.window?.setMaximized(Bool(mpv.opts.window_maximized)) } default: break } } return VO_TRUE case VOCTRL_GET_DISPLAY_FPS: let fps = data!.assumingMemoryBound(to: CDouble.self) fps.pointee = currentFps() return VO_TRUE case VOCTRL_GET_HIDPI_SCALE: let scaleFactor = data!.assumingMemoryBound(to: CDouble.self) let screen = getCurrentScreen() let factor = window?.backingScaleFactor ?? screen?.backingScaleFactor ?? 1.0 scaleFactor.pointee = Double(factor) return VO_TRUE case VOCTRL_RESTORE_SCREENSAVER: enableDisplaySleep() return VO_TRUE case VOCTRL_KILL_SCREENSAVER: disableDisplaySleep() return VO_TRUE case VOCTRL_SET_CURSOR_VISIBILITY: let cursorVisibility = data!.assumingMemoryBound(to: CBool.self) cursorVisibilityWanted = cursorVisibility.pointee DispatchQueue.main.async { self.setCursorVisiblility(self.cursorVisibilityWanted) } return VO_TRUE case VOCTRL_GET_ICC_PROFILE: let screen = getCurrentScreen() guard var iccData = screen?.colorSpace?.iccProfileData else { log.sendWarning("No Screen available to retrieve ICC profile") return VO_TRUE } let icc = data!.assumingMemoryBound(to: bstr.self) iccData.withUnsafeMutableBytes { (ptr: UnsafeMutableRawBufferPointer) in guard let baseAddress = ptr.baseAddress, ptr.count > 0 else { return } let u8Ptr = baseAddress.assumingMemoryBound(to: UInt8.self) icc.pointee = bstrdup(nil, bstr(start: u8Ptr, len: ptr.count)) } return VO_TRUE case VOCTRL_GET_AMBIENT_LUX: if lightSensor != 0 { let lux = data!.assumingMemoryBound(to: Int32.self) lux.pointee = Int32(lmuToLux(lastLmu)) return VO_TRUE; } return VO_NOTIMPL case VOCTRL_GET_UNFS_WINDOW_SIZE: let sizeData = data!.assumingMemoryBound(to: Int32.self) let size = UnsafeMutableBufferPointer(start: sizeData, count: 2) var rect = window?.unfsContentFrame ?? NSRect(x: 0, y: 0, width: 1280, height: 720) if let screen = window?.currentScreen, !Bool(mpv.opts.hidpi_window_scale) { rect = screen.convertRectToBacking(rect) } size[0] = Int32(rect.size.width) size[1] = Int32(rect.size.height) return VO_TRUE case VOCTRL_SET_UNFS_WINDOW_SIZE: let sizeData = data!.assumingMemoryBound(to: Int32.self) let size = UnsafeBufferPointer(start: sizeData, count: 2) var rect = NSMakeRect(0, 0, CGFloat(size[0]), CGFloat(size[1])) DispatchQueue.main.async { if let screen = self.window?.currentScreen, !Bool(self.mpv?.opts.hidpi_window_scale ?? 1) { rect = screen.convertRectFromBacking(rect) } self.window?.updateSize(rect.size) } return VO_TRUE case VOCTRL_GET_DISPLAY_NAMES: let dnames = data!.assumingMemoryBound(to: UnsafeMutablePointer?>?.self) var array: UnsafeMutablePointer?>? = nil var count: Int32 = 0 let displayName = getCurrentScreen()?.displayName ?? "Unknown" SWIFT_TARRAY_STRING_APPEND(nil, &array, &count, ta_xstrdup(nil, displayName)) SWIFT_TARRAY_STRING_APPEND(nil, &array, &count, nil) dnames.pointee = array return VO_TRUE case VOCTRL_GET_DISPLAY_RES: guard let screen = getCurrentScreen() else { log.sendWarning("No Screen available to retrieve frame") return VO_NOTAVAIL } let sizeData = data!.assumingMemoryBound(to: Int32.self) let size = UnsafeMutableBufferPointer(start: sizeData, count: 2) let frame = screen.convertRectToBacking(screen.frame) size[0] = Int32(frame.size.width) size[1] = Int32(frame.size.height) return VO_TRUE case VOCTRL_GET_FOCUSED: let focus = data!.assumingMemoryBound(to: CBool.self) focus.pointee = NSApp.isActive return VO_TRUE case VOCTRL_UPDATE_WINDOW_TITLE: let titleData = data!.assumingMemoryBound(to: Int8.self) DispatchQueue.main.async { let title = NSString(utf8String: titleData) as String? self.title = title ?? "Unknown Title" } return VO_TRUE default: return VO_NOTIMPL } } let macOptsWakeupCallback: swift_wakeup_cb_fn = { ( ctx ) in let com = unsafeBitCast(ctx, to: Common.self) DispatchQueue.main.async { com.macOptsUpdate() } } func macOptsUpdate() { guard let mpv = mpv else { log.sendWarning("Unexpected nil value in mac opts update") return } var opt: UnsafeMutableRawPointer? while mpv.nextChangedMacOption(property: &opt) { switch opt { case MPVHelper.getPointer(&mpv.macOptsPtr.pointee.macos_title_bar_appearance): titleBar?.set(appearance: Int(mpv.macOpts.macos_title_bar_appearance)) case MPVHelper.getPointer(&mpv.macOptsPtr.pointee.macos_title_bar_material): titleBar?.set(material: Int(mpv.macOpts.macos_title_bar_material)) case MPVHelper.getPointer(&mpv.macOptsPtr.pointee.macos_title_bar_color): titleBar?.set(color: mpv.macOpts.macos_title_bar_color) default: break } } } }