VuoDisplayRefresh.c

Go to the documentation of this file.

 
#include "VuoDisplayRefresh.h"
#include <CoreVideo/CoreVideo.h>
 
#ifdef VUO_COMPILER
VuoModuleMetadata({
                     "title" : "VuoDisplayRefresh",
                     "dependencies" : [
                        "ApplicationServices.framework",
                        "CoreVideo.framework"
                     ]
                 });
#endif
 
typedef struct
{
    void (*requestedFrameTrigger)(VuoReal); 
    void (*requestedFrameTriggerWithContext)(VuoReal, void *context);   
    void *triggerContext;   
 
    bool firstRequest;  
    int64_t initialTime;    
    VuoInteger frameCount;  
 
    CVDisplayLinkRef displayLink;   
    bool displayLinkCancelRequested;    
    dispatch_semaphore_t displayLinkCanceledAndCompleted;   
} VuoDisplayRefreshInternal;
 
static CVReturn VuoDisplayRefresh_displayLinkCallback(CVDisplayLinkRef displayLink,
                                                            const CVTimeStamp *inNow, const CVTimeStamp *inOutputTime,
                                                            CVOptionFlags flagsIn, CVOptionFlags *flagsOut,
                                                            void *ctx)
{
    int64_t plannedFrameTime = inOutputTime->videoTime;
 
    VuoDisplayRefreshInternal *displayRefresh = (VuoDisplayRefreshInternal *)ctx;
    if (displayRefresh->firstRequest)
    {
        displayRefresh->initialTime = plannedFrameTime;
        displayRefresh->firstRequest = false;
    }
 
    if (displayRefresh->displayLinkCancelRequested)
    {
        CVDisplayLinkStop(displayRefresh->displayLink);
        dispatch_semaphore_signal(displayRefresh->displayLinkCanceledAndCompleted);
        return kCVReturnSuccess;
    }
 
    VuoReal timestamp = (double)(plannedFrameTime - displayRefresh->initialTime)/(double)inOutputTime->videoTimeScale;
 
    if (displayRefresh->requestedFrameTrigger)
        displayRefresh->requestedFrameTrigger(timestamp);
 
    if (displayRefresh->requestedFrameTriggerWithContext)
        displayRefresh->requestedFrameTriggerWithContext(timestamp, displayRefresh->triggerContext);
 
    return kCVReturnSuccess;
}
 
VuoDisplayRefresh VuoDisplayRefresh_make(void *context)
{
    VuoDisplayRefreshInternal *displayRefresh = (VuoDisplayRefreshInternal *)malloc(sizeof(VuoDisplayRefreshInternal));
    VuoRegister(displayRefresh, free);
 
    displayRefresh->firstRequest = true;
    // displayRefresh->initialTime is initialized by VuoDisplayRefresh_displayLinkCallback().
    displayRefresh->frameCount = 0;
 
    displayRefresh->triggerContext = context;
 
    return (VuoDisplayRefresh)displayRefresh;
}
 
void VuoDisplayRefresh_enableTriggers
(
        VuoDisplayRefresh dr,
        void (*requestedFrameTrigger)(VuoReal),
        void (*requestedFrameTriggerWithContext)(VuoReal, void *context)
)
{
    VuoDisplayRefreshInternal *displayRefresh = (VuoDisplayRefreshInternal *)dr;
 
    displayRefresh->requestedFrameTrigger = requestedFrameTrigger;
    displayRefresh->requestedFrameTriggerWithContext = requestedFrameTriggerWithContext;
 
    if (CVDisplayLinkCreateWithCGDisplay(kCGDirectMainDisplay, &displayRefresh->displayLink) == kCVReturnSuccess)
    {
        displayRefresh->displayLinkCancelRequested = false;
        displayRefresh->displayLinkCanceledAndCompleted = dispatch_semaphore_create(0);
        CVDisplayLinkSetOutputCallback(displayRefresh->displayLink, VuoDisplayRefresh_displayLinkCallback, displayRefresh);
        CVDisplayLinkStart(displayRefresh->displayLink);
 
        CVTime nominal = CVDisplayLinkGetNominalOutputVideoRefreshPeriod(displayRefresh->displayLink);
        VDebugLog("Refresh: %g Hz (%d/%lld)", (double)nominal.timeScale/nominal.timeValue, nominal.timeScale, nominal.timeValue);
 
        CVTime latency = CVDisplayLinkGetOutputVideoLatency(displayRefresh->displayLink);
        if (latency.timeScale)
        {
            double latencyFrames = ((double)latency.timeValue/latency.timeScale)/((double)nominal.timeValue/nominal.timeScale);
            VDebugLog("Latency: %g frame%s (%d/%lld)", latencyFrames, fabs(latencyFrames-1)<0.00001 ? "" : "s", latency.timeScale, latency.timeValue);
        }
        else
            VDebugLog("Latency: unknown");
    }
    else
    {
        VUserLog("Failed to create CVDisplayLink.");
        displayRefresh->displayLink = NULL;
    }
}
 
void VuoDisplayRefresh_disableTriggers(VuoDisplayRefresh dr)
{
    VuoDisplayRefreshInternal *displayRefresh = (VuoDisplayRefreshInternal *)dr;
    if (displayRefresh->displayLink)
    {
        displayRefresh->displayLinkCancelRequested = true;
 
        // Wait for the last sendoff to complete.
        dispatch_semaphore_wait(displayRefresh->displayLinkCanceledAndCompleted, DISPATCH_TIME_FOREVER);
    }
}