summaryrefslogtreecommitdiffstats
path: root/video/out/cocoa_cb_common.swift
blob: 426181d13e88e2a091eab5fec83054f6afd505d2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
/*
 * 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 <http://www.gnu.org/licenses/>.
 */

import Cocoa
import IOKit.pwr_mgt

class CocoaCB: NSObject {

    var mpv: MPVHelper!
    var window: Window!
    var view: EventsView!
    var layer: VideoLayer!
    var link: CVDisplayLink?

    var cursorHidden: Bool = false
    var cursorVisibilityWanted: Bool = true
    var isShuttingDown: Bool = false

    enum State {
        case uninit
        case needsInit
        case `init`
    }
    var backendState: State = .uninit

    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)

    let queue: DispatchQueue = DispatchQueue(label: "io.mpv.queue")

    override init() {
        super.init()
        window = Window(cocoaCB: self)

        view = EventsView(frame: window.contentView!.bounds, cocoaCB: self)
        window.contentView!.addSubview(view)

        layer = VideoLayer(cocoaCB: self)
        view.layer = layer
        view.wantsLayer = true
    }

    func setMpvHandle(_ ctx: OpaquePointer) {
        mpv = MPVHelper(ctx)
        layer.setUpRender()
    }

    func preinit() {
        if backendState == .uninit {
            backendState = .needsInit
            DispatchQueue.main.async {
                self.updateICCProfile()
            }
            startDisplayLink()
        } else {
            layer.setVideo(true)
        }
    }

    func uninit() {
        layer.setVideo(false)
        window.orderOut(nil)
    }

    func reconfig() {
        if backendState == .needsInit {
            initBackend()
        } else {
            updateWindowSize()
            layer.neededFlips += 1
        }
    }

    func initBackend() {
        NSApp.setActivationPolicy(.regular)

        let targetScreen = getTargetScreen(forFullscreen: false) ?? NSScreen.main()
        let wr = getWindowGeometry(forScreen: targetScreen!, videoOut: mpv.mpctx!.pointee.video_out)
        let win = Window(contentRect: wr, styleMask: window.styleMask,
                              screen: targetScreen, cocoaCB: self)
        win.title = window.title
        win.setOnTop(mpv.getBoolProperty("ontop"))
        win.keepAspect = mpv.getBoolProperty("keepaspect-window")
        window.close()
        window = win
        window.contentView!.addSubview(view)
        view.frame = window.contentView!.frame
        window.initTitleBar()

        setAppIcon()
        window.isRestorable = false
        window.makeMain()
        window.makeKeyAndOrderFront(nil)
        NSApp.activate(ignoringOtherApps: true)
        layer.setVideo(true)

        if mpv.getBoolProperty("fullscreen") {
            DispatchQueue.main.async {
                self.window.toggleFullScreen(nil)
            }
        } else {
            window.isMovableByWindowBackground = true
        }

        initLightSensor()
        addDisplayReconfigureObserver()
        backendState = .init
    }

    func updateWindowSize() {
        if layer.hasVideo {
            let targetScreen = getTargetScreen(forFullscreen: false) ?? NSScreen.main()
            let wr = getWindowGeometry(forScreen: targetScreen!, videoOut: mpv.mpctx!.pointee.video_out)
            if !window.isVisible {
                window.makeKeyAndOrderFront(nil)
            }
            window.updateSize(wr.size)
        }
    }

    func setAppIcon() {
        if let app = NSApp as? Application {
            NSApp.applicationIconImage = app.getMPVIcon()
        }
    }

    let linkCallback: CVDisplayLinkOutputCallback = {
                    (displayLink: CVDisplayLink,
                           inNow: UnsafePointer<CVTimeStamp>,
                    inOutputTime: UnsafePointer<CVTimeStamp>,
                         flagsIn: CVOptionFlags,
                        flagsOut: UnsafeMutablePointer<CVOptionFlags>,
              displayLinkContext: UnsafeMutableRawPointer?) -> CVReturn in
        let ccb: CocoaCB = MPVHelper.bridge(ptr: displayLinkContext!)
        ccb.layer.reportFlip()
        return kCVReturnSuccess
    }

    func startDisplayLink() {
        let displayId = UInt32(window.screen!.deviceDescription["NSScreenNumber"] as! Int)
        CVDisplayLinkCreateWithActiveCGDisplays(&link)
        CVDisplayLinkSetCurrentCGDisplay(link!, displayId)
        if #available(macOS 10.12, *) {
            CVDisplayLinkSetOutputHandler(link!) { link, now, out, inFlags, outFlags -> CVReturn in
                self.layer.reportFlip()
                return kCVReturnSuccess
            }
        } else {
            CVDisplayLinkSetOutputCallback(link!, linkCallback, MPVHelper.bridge(obj: self))
        }
        CVDisplayLinkStart(link!)
    }

    func stopDisplaylink() {
        if link != nil && CVDisplayLinkIsRunning(link!) {
            CVDisplayLinkStop(link!)
        }
    }

    func updateDisplaylink() {
        let displayId = UInt32(window.screen!.deviceDescription["NSScreenNumber"] as! Int)
        CVDisplayLinkSetCurrentCGDisplay(link!, displayId)

        queue.asyncAfter(deadline: DispatchTime.now() + 0.1) {
            self.flagEvents(VO_EVENT_WIN_STATE)
        }
    }

    func currentFps() -> Double {
        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 {
                mpv.sendVerbose("Falling back to nominal display refresh rate: \(nominalFps)")
                return nominalFps
            } else {
                return actualFps
            }
        }
        mpv.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 updateCusorVisibility() {
        setCursorVisiblility(cursorVisibilityWanted)
    }

    func setCursorVisiblility(_ visible: Bool) {
        let visibility = visible ? true : !view.canHideCursor()

        if visibility && cursorHidden {
            NSCursor.unhide()
            cursorHidden = false;
        } else if !visibility && !cursorHidden {
            NSCursor.hide()
            cursorHidden = true
        }
    }

    func updateICCProfile() {
        if mpv.getBoolProperty("icc-profile-auto") {
            mpv.setRenderICCProfile(window.screen!.colorSpace!)
        }
        layer.colorspace = window.screen!.colorSpace!.cgColorSpace!
    }

    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 = 1 / pow(10, 27)
        let power_c3 = 1 / pow(10, 19)
        let power_c2 = 1 / pow(10, 12)
        let power_c1 = 1 / pow(10, 5)

        let term4 = -3.0 * power_c4 * pow(Decimal(v), 4)
        let term3 = 2.6 * power_c3 * pow(Decimal(v), 3)
        let term2 = -3.4 * power_c2 * pow(Decimal(v), 2)
        let term1 = 3.9 * power_c1 * Decimal(v)

        let lux = Int(ceil( Double((term4 + term3 + term2 + term1 - 0.19) as NSNumber)))
        return Int(lux > 0 ? lux : 0)
    }

    var lightSensorCallback: IOServiceInterestCallback = { (ctx, service, messageType, messageArgument) -> Void in
        let ccb: CocoaCB = MPVHelper.bridge(ptr: ctx!)

        var outputs: UInt32 = 2
        var values: [UInt64] = [0, 0]

        var kr = IOConnectCallMethod(ccb.lightSensor, 0, nil, 0, nil, 0, &values, &outputs, nil, nil)
        if kr == KERN_SUCCESS {
            var mean = (values[0] + values[1]) / 2
            if ccb.lastLmu != mean {
                ccb.lastLmu = mean
                ccb.mpv.setRenderLux(ccb.lmuToLux(ccb.lastLmu))
            }
        }
    }

    func initLightSensor() {
        let srv = IOServiceGetMatchingService(kIOMasterPortDefault, IOServiceMatching("AppleLMUController"))
        if srv == IO_OBJECT_NULL {
            mpv.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 {
            mpv.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 ccb: CocoaCB = MPVHelper.bridge(ptr: userInfo!)
            let displayID = (ccb.window.screen!.deviceDescription["NSScreenNumber"] as! NSNumber).intValue
            if UInt32(displayID) == display {
                ccb.mpv.sendVerbose("Detected display mode change, updating screen refresh rate\n");
                ccb.flagEvents(VO_EVENT_WIN_STATE)
            }
        }
    }

    func addDisplayReconfigureObserver() {
        CGDisplayRegisterReconfigurationCallback(reconfigureCallback, MPVHelper.bridge(obj: self))
    }

    func removeDisplayReconfigureObserver() {
        CGDisplayRemoveReconfigurationCallback(reconfigureCallback, MPVHelper.bridge(obj: self))
    }

    func getTargetScreen(forFullscreen fs: Bool) -> NSScreen? {
        let screenID = fs ? mpv.getStringProperty("fs-screen") ?? "current":
                            mpv.getStringProperty("screen") ?? "current"

        switch screenID {
        case "current", "default", "all":
            return getScreenBy(id: -1)
        default:
            return getScreenBy(id: Int(screenID)!)
        }
    }

    func getScreenBy(id screenID: Int) -> NSScreen? {
        let screens = NSScreen.screens()
        if screenID >= screens!.count {
            mpv.sendInfo("Screen ID \(screenID) does not exist, falling back to current device")
            return nil
        } else if screenID < 0 {
            return nil
        }
        return screens![screenID]
    }

    func getWindowGeometry(forScreen targetScreen: NSScreen,
                           videoOut vo: UnsafeMutablePointer<vo>) -> NSRect {
        let r = targetScreen.convertRectToBacking(targetScreen.frame)
        var screenRC: mp_rect = mp_rect(x0: Int32(0),
                                        y0: Int32(0),
                                        x1: Int32(r.size.width),
                                        y1: Int32(r.size.height))

        var geo: vo_win_geometry = vo_win_geometry()
        vo_calc_window_geometry2(vo, &screenRC, Double(targetScreen.backingScaleFactor), &geo)

        // flip y coordinates
        geo.win.y1 = Int32(r.size.height) - geo.win.y1
        geo.win.y0 = Int32(r.size.height) - geo.win.y0

        let wr = NSMakeRect(CGFloat(geo.win.x0), CGFloat(geo.win.y1),
                            CGFloat(geo.win.x1 - geo.win.x0),
                            CGFloat(geo.win.y0 - geo.win.y1))
        return targetScreen.convertRectFromBacking(wr)
    }

    func flagEvents(_ ev: Int) {
        eventsLock.lock()
        events |= ev
        eventsLock.unlock()
    }

    func checkEvents() -> Int {
        eventsLock.lock()
        let ev = events
        events = 0
        eventsLock.unlock()
        return ev
    }

    var controlCallback: mp_render_cb_control_fn = { ( ctx, events, request, data ) -> Int32 in
        let ccb: CocoaCB = MPVHelper.bridge(ptr: ctx!)

        switch mp_voctrl(request) {
        case VOCTRL_CHECK_EVENTS:
            events!.pointee = Int32(ccb.checkEvents())
            return VO_TRUE
        case VOCTRL_FULLSCREEN:
            DispatchQueue.main.async {
                ccb.window.toggleFullScreen(nil)
            }
            return VO_TRUE
        case VOCTRL_GET_FULLSCREEN:
            let fsData = data!.assumingMemoryBound(to: Int32.self)
            fsData.pointee = ccb.window.isInFullscreen ? 1 : 0
            return VO_TRUE
        case VOCTRL_GET_DISPLAY_FPS:
            let fps = data!.assumingMemoryBound(to: CDouble.self)
            fps.pointee = ccb.currentFps()
            return VO_TRUE
        case VOCTRL_RESTORE_SCREENSAVER:
            ccb.enableDisplaySleep()
            return VO_TRUE
        case VOCTRL_KILL_SCREENSAVER:
            ccb.disableDisplaySleep()
            return VO_TRUE
        case VOCTRL_SET_CURSOR_VISIBILITY:
            ccb.cursorVisibilityWanted = data!.assumingMemoryBound(to: CBool.self).pointee
            DispatchQueue.main.async {
                ccb.setCursorVisiblility(ccb.cursorVisibilityWanted)
            }
            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 !ccb.mpv.getBoolProperty("hidpi-window-scale") {
                    rect = ccb.window.currentScreen!.convertRectFromBacking(rect)
                }
                ccb.window.updateSize(rect.size)
            }
            return VO_TRUE
        case VOCTRL_GET_WIN_STATE:
            let minimized = data!.assumingMemoryBound(to: Int32.self)
            minimized.pointee = ccb.window.isMiniaturized ? VO_WIN_STATE_MINIMIZED : Int32(0)
            return VO_TRUE
        case VOCTRL_UPDATE_WINDOW_TITLE:
            let titleData = data!.assumingMemoryBound(to: Int8.self)
            let title = String(cString: titleData)
            DispatchQueue.main.async {
                ccb.window.title = String(cString: titleData)
            }
            return VO_TRUE
        case VOCTRL_PREINIT:
            ccb.preinit()
            return VO_TRUE
        case VOCTRL_UNINIT:
            DispatchQueue.main.async {
                ccb.uninit()
            }
            return VO_TRUE
        case VOCTRL_RECONFIG:
            DispatchQueue.main.async {
                ccb.reconfig()
            }
            return VO_TRUE
        default:
            return VO_NOTIMPL
        }
    }

    func processEvent(_ event: UnsafePointer<mpv_event>) {
        switch event.pointee.event_id {
        case MPV_EVENT_SHUTDOWN:
            if window.isAnimating {
                isShuttingDown = true
                return
            }
            setCursorVisiblility(true)
            stopDisplaylink()
            uninitLightSensor()
            removeDisplayReconfigureObserver()
            mpv.deinitRender()
            mpv.deinitMPV()
        case MPV_EVENT_PROPERTY_CHANGE:
            if backendState == .init {
                handlePropertyChange(event)
            }
        default:
            break
        }
    }

    func handlePropertyChange(_ event: UnsafePointer<mpv_event>) {
        let pData = OpaquePointer(event.pointee.data)
        guard let property = UnsafePointer<mpv_event_property>(pData)?.pointee else {
            return
        }

        switch String(cString: property.name) {
        case "border":
            if let data = MPVHelper.mpvFlagToBool(property.data) {
                window.border = data
            }
        case "ontop":
            if let data = MPVHelper.mpvFlagToBool(property.data) {
                window.setOnTop(data)
            }
        case "keepaspect-window":
            if let data = MPVHelper.mpvFlagToBool(property.data) {
                window.keepAspect = data
            }
        case "macos-title-bar-style":
            if let data = MPVHelper.mpvStringArrayToString(property.data) {
                window.setTitleBarStyle(data)
            }
        default:
            break
        }
    }
}