/* PsychSynchronizeDisplayScreens() -- (Try to) synchronize display refresh cycles of multiple displays
*
* This tries whatever method is available/appropriate/or requested to synchronize the video refresh
* cycles of multiple graphics cards physical display heads -- corresponding to PTB logical Screens.
*
* The method may or may not be supported on a specific OS/gfx-card combo. It will return a PsychError_unimplemented
* if it can't do what core wants.
*
* numScreens = Ptr to the number of display screens to sync. If numScreens>0, all screens with the screenIds stored
* in the integer array 'screenIds' will be synched. If numScreens == 0, PTB will try to sync all
* available screens in the system. On return, the location will contain the count of synced screens.
*
* screenIds = Either a list with 'numScreens' screenIds for the screens to sync, or NULL if numScreens == 0.
*
* residuals = List with 'numScreens' (on return) values indicating the residual sync error wrt. to the first
* screen (the reference). Ideally all items should contain zero for perfect sync on return.
*
* syncMethod = Numeric Id for the sync method to use: 0 = Don't care, whatever is appropriate. 1 = Only hard
* sync, which is fast and reliable if supported. 2 = Soft sync via drift-syncing. More to come...
*
* syncTimeOut = If some non-immediate method is requested/chosen, it should give up after syncTimeOut seconds if
* it doesn't manage to bring the displays in sync in that timeframe.
*
* allowedResidual = How many scanlines offset after sync are acceptable? Will retry until syncTimeOut if criterion not met.
*
*/
PsychError PsychSynchronizeDisplayScreens(int *numScreens, int* screenIds, int* residuals, unsigned int syncMethod, double syncTimeOut, int allowedResidual)
{
// Currently, we only support a hard, immediate sync of all display heads of a single dual-head gfx-card,
// so we ignore most of our arguments. Well, still check them for validity, but then ignore them after
// successfull validation ;-)
if (numScreens == NULL) PsychErrorExitMsg(PsychError_internal, "NULL-Ptr passed as numScreens argument!");
if (*numScreens < 0 || *numScreens >= PsychGetNumDisplays()) PsychErrorExitMsg(PsychError_internal, "Invalid number passed as numScreens argument! (Negativ or more than available screens)");
if (syncMethod < 0 || syncMethod > 2) PsychErrorExitMsg(PsychError_internal, "Invalid syncMethod argument passed!");
if (syncTimeOut < 0) PsychErrorExitMsg(PsychError_internal, "Invalid (negative) syncTimeOut argument passed!");
if (allowedResidual < 0) PsychErrorExitMsg(PsychError_internal, "Invalid (negative) allowedResidual argument passed!");
// System support:
#if PSYCH_SYSTEM == PSYCH_WINDOWS
if(PsychPrefStateGet_Verbosity() > 1) printf("PTB-WARNING: Synchronization of graphics display heads requested, but this is not supported on MS-Windows.\n");
return(PsychError_unimplemented);
#endif
#if PSYCH_SYSTEM == PSYCH_LINUX
// Dispatch to routine in PsychScreenGlue.c Linux:
return(PsychOSSynchronizeDisplayScreens(numScreens, screenIds, residuals, syncMethod, syncTimeOut, allowedResidual));
#endif
#if PSYCH_SYSTEM == PSYCH_OSX
// Dispatch to routine in PsychScreenGlue.c OSX:
return(PsychOSSynchronizeDisplayScreens(numScreens, screenIds, residuals, syncMethod, syncTimeOut, allowedResidual));
#endif
// Often not reached...
return(PsychError_none);
}
PsychError ScreenExitFunction(void)
{
CGDirectDisplayID dpy, last_dpy;
int i;
//The timing array holds time values set by Screen internal diagnostics. It allocates memory with
//malloc to hold the array of times. This call frees the memory prior to unloading Screen
ClearTimingArray();
// Close all open onscreen windows and release their resources,
// -> Perform exactly the same cleanup that Screen('CloseAll') would do.
ScreenCloseAllWindows();
CloseWindowBank();
#if PSYCH_SYSTEM == PSYCH_LINUX
// Linux specific hack. Close display connection(s) to X-Server(s). This is a bit unclean.
last_dpy = NULL;
// Go trough full screen list:
for (i=0; i < PsychGetNumDisplays(); i++) {
// Get display-ptr for this screen:
PsychGetCGDisplayIDFromScreenNumber(&dpy, i);
// Did we close this connection already (dpy==last_dpy)?
if (dpy != last_dpy) {
// Nope. Keep track of it...
last_dpy=dpy;
// ...and close display connection to X-Server:
XCloseDisplay(dpy);
}
}
// All connections should be closed now. We can't NULL-out the display list, but
// Matlab will flush the Screen - Mexfile anyway...
#endif
return(PsychError_none);
}
/* PsychEnableNative10BitFramebuffer() - Enable/Disable native 10 bpc RGB framebuffer modes.
*
* This function enables or disables the native ARGB2101010 framebuffer readout mode of supported
* graphics hardware. Currently the ATI Radeon X1000/HD2000/HD3000 and later cards should allow this.
*
* This needs support from the Psychtoolbox kernel level support driver for low-level register reads
* and writes to the GPU registers.
*
* 'windowRecord' Is used to find the Id of the screen for which mode should be changed, as well as enable
* flags to see if a change is required at all, and the OpenGL context for some specific
* fixups. A value of NULL will try to apply the operation to all heads, but may only work
* for *disabling* 10 bpc mode, not for enabling it -- Mostly useful for a master reset to
* system default, e.g., as part of error handling or Screen shutdown handling.
* 'enable' True = Enable ABGR2101010 support, False = Disable ARGB2101010 support, reenable ARGB8888 support.
*
*/
boolean PsychEnableNative10BitFramebuffer(PsychWindowRecordType* windowRecord, boolean enable)
{
int i,si,ei, headid, screenId;
unsigned int lutreg, ctlreg, value, status;
// Child protection:
if (windowRecord && !PsychIsOnscreenWindow(windowRecord)) PsychErrorExitMsg(PsychError_internal, "Invalid non-onscreen windowRecord provided!!!");
// Either screenid from windowRecord or our special -1 "all Screens" Id:
screenId = (windowRecord) ? windowRecord->screenNumber : -1;
// Define range of screens: Either a single specific one, or all:
si = (screenId!=-1) ? screenId : 0;
ei = (screenId!=-1) ? screenId+1 : PsychGetNumDisplays();
#if PSYCH_SYSTEM == PSYCH_OSX || PSYCH_SYSTEM == PSYCH_LINUX
// Loop over all target screens:
for (i=si; i<ei; i++) {
// Map screenid to headid: For now we only support 2 heads and assume
// screenId 0 == head 0, all others equal head 1:
headid = (i<=0) ? 0 : 1;
// Select Radeon HW registers for corresponding heads:
lutreg = (headid == 0) ? RADEON_D1GRPH_LUT_SEL : RADEON_D2GRPH_LUT_SEL;
ctlreg = (headid == 0) ? RADEON_D1GRPH_CONTROL : RADEON_D2GRPH_CONTROL;
// Enable or Disable?
if (enable) {
// Enable:
// Switch hardware LUT's to bypass mode:
// We set bit 8 to enable "bypass LUT in 2101010 mode":
value = PsychOSKDReadRegister(screenId, lutreg, &status);
if (status) {
printf("PTB-ERROR: Failed to set 10 bit framebuffer mode (LUTReg read failed).\n");
return(false);
}
// Set the bypass bit:
value = value | 0x1 << 8;
PsychOSKDWriteRegister(screenId, lutreg, value, &status);
if (status) {
printf("PTB-ERROR: Failed to set 10 bit framebuffer mode (LUTReg write failed).\n");
return(false);
}
// Switch CRTC to ABGR2101010 readout mode:
// We set bit 8 to enable that mode:
value = PsychOSKDReadRegister(screenId, ctlreg, &status);
if (status) {
printf("PTB-ERROR: Failed to set 10 bit framebuffer mode (CTLReg read failed).\n");
return(false);
}
// Set 2101010 moe bit:
value = value | 0x1 << 8;
PsychOSKDWriteRegister(screenId, ctlreg, value, &status);
if (status) {
printf("PTB-ERROR: Failed to set 10 bit framebuffer mode (CTLReg write failed).\n");
return(false);
}
// Pipe should be in 10 bpc mode now...
if (PsychPrefStateGet_Verbosity() > 2) printf("PTB-INFO: System framebuffer switched to ARGB2101010 mode for screen %i [head %i].\n", i, headid);
}
else {
// Disable:
// Switch CRTC to ABGR8888 readout mode:
// We clear bit 8 to enable that mode:
value = PsychOSKDReadRegister(screenId, ctlreg, &status);
if (status) {
// This codepath gets always called in PsychCloseWindow(), so we should skip it
// silently if register read fails, as this is expected on MS-Windows and on all
// non-Radeon hardware and if kernel driver isn't loaded:
if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-ERROR: Failed to set 8 bit framebuffer mode (CTLReg read failed).\n");
return(false);
}
else if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In disable 10bpc: Readreg. ctlreg yields %lx\n", value);
// Clear 2101010 mode bit:
value = value & ~(0x1 << 8);
PsychOSKDWriteRegister(screenId, ctlreg, value, &status);
if (status) {
printf("PTB-ERROR: Failed to set 8 bit framebuffer mode (CTLReg write failed).\n");
return(false);
}
else if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In disable 10bpc: ctlreg reset\n");
// Wait 500 msecs for GPU to settle:
PsychWaitIntervalSeconds(0.5);
// Switch hardware LUT's to standard mapping mode:
// We clear bit 8 to disable "bypass LUT in 2101010 mode":
value = PsychOSKDReadRegister(screenId, lutreg, &status);
if (status) {
printf("PTB-ERROR: Failed to set 8 bit framebuffer mode (LUTReg read failed).\n");
return(false);
}
else if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In disable 10bpc: Readreg. lutreg yields %lx\n", value);
// Clear LUT bypass bit:
value = value & ~(0x1 << 8);
PsychOSKDWriteRegister(screenId, lutreg, value, &status);
if (status) {
printf("PTB-ERROR: Failed to set 8 bit framebuffer mode (LUTReg write failed).\n");
return(false);
}
else if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In disable 10bpc: lutreg reset\n");
// Pipe should be in 8 bpc mode now...
if (PsychPrefStateGet_Verbosity() > 2) printf("PTB-INFO: System framebuffer switched to standard ARGB8888 mode for screen %i [head %i].\n", i, headid);
}
// Next display head...
}
#else
// This cool stuff not supported on the uncool Windows OS:
return(FALSE);
#endif
// Done.
return(TRUE);
}
PsychError SCREENPreference(void)
{
PsychArgFormatType arg1Type;
char *preferenceName, *newFontName;
const char *tableCreator, *oldDefaultFontName;
psych_bool preferenceNameArgumentValid, booleanInput, ignoreCase, tempFlag, textAlphaBlendingFlag, suppressAllWarningsFlag;
int numInputArgs, i, newFontStyleNumber, newFontSize, tempInt, tempInt2, tempInt3, tempInt4;
double returnDoubleValue, inputDoubleValue;
double maxStddev, maxDeviation, maxDuration;
int minSamples;
double *dheads = NULL;
//all sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if(PsychIsGiveHelp()){PsychGiveHelp();return(PsychError_none);};
//check for superfluous or missing arguments
PsychErrorExit(PsychCapNumInputArgs(5));
PsychErrorExit(PsychRequireNumInputArgs(1));
PsychErrorExit(PsychCapNumOutputArgs(4));
numInputArgs=PsychGetNumInputArgs();
arg1Type=PsychGetArgType(1);
preferenceNameArgumentValid=FALSE;
//Cases which require both a window pointer or screen number and preference name. Argument 1 is the wposn and argument 2 is the preference name.
if( numInputArgs >= 2 && (PsychIsScreenNumberArg(1) || PsychIsScreenNumberArg(1)) && PsychGetArgType(2)==PsychArgType_char ){
PsychAllocInCharArg(2, kPsychArgRequired, &preferenceName);
//preferences which require window pointer or screen number argument which we DO NOT support
for(i=0;i<kPsychNumUnsupportedMacVideoPreferences;i++){
if(PsychMatch(preferenceName, unsupportedMacVideoPreferenceNames[i]))
PsychErrorExit(PsychError_unsupportedOS9Preference);
}
//insert here conditionals to act on prefernces which accept a window pointer or screen number argument which we DO support.
PsychErrorExit(PsychError_unrecognizedPreferenceName);
}
//Cases which do not require a wposn. Argument 1 is the preference name. if present Argument 2 is the new value
if(arg1Type==PsychArgType_char){
PsychAllocInCharArg(1, kPsychArgRequired, &preferenceName);
//Preferernces which we do not support and which do not require a wposn
for(i=0;i<kPsychNumUnsupportedMacNonVideoPreferences;i++){
if(PsychMatch(preferenceName, unsupportedMacNonVideoPreferenceNames[i]))
PsychErrorExit(PsychError_unsupportedOS9Preference);
}
//Preferences which we do support
if(PsychMatch(preferenceName, "IgnoreCase")){
ignoreCase=!PsychIsPsychMatchCaseSensitive();
PsychCopyOutFlagArg(1, kPsychArgOptional, ignoreCase);
if(numInputArgs==2){
PsychCopyInFlagArg(2, kPsychArgRequired, &booleanInput);
PsychSetPsychMatchCaseSenstive(!booleanInput);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "Tick0Secs")){
if(PsychCopyInDoubleArg(2, kPsychArgOptional, &inputDoubleValue) && inputDoubleValue==PsychGetNanValue())
PsychEstimateGetSecsValueAtTickCountZero();
returnDoubleValue=PsychGetEstimatedSecsValueAtTickCountZero();
PsychCopyOutDoubleArg(1, kPsychArgOptional, returnDoubleValue);
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "PsychTableVersion")){
if(numInputArgs==2)
PsychErrorExit(PsychError_extraInputArg);
PsychCopyOutDoubleArg(1, kPsychArgOptional, (double)PsychPrefStateGet_PsychTableVersion());
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "PsychTableCreator")){
if(numInputArgs==2)
PsychErrorExit(PsychError_extraInputArg);
tableCreator=PsychPrefStateGet_PsychTableCreator();
PsychCopyOutCharArg(1, kPsychArgOptional, tableCreator);
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "Process")){
if(numInputArgs==2)
PsychErrorExit(PsychError_extraInputArg);
PsychCopyOutDoubleArg(1, kPsychArgOptional, (double) (psych_int64) getpid());
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "DefaultFontName")){
PsychPrefStateGet_DefaultFontName(&oldDefaultFontName);
PsychCopyOutCharArg(1, kPsychArgOptional, oldDefaultFontName);
if(numInputArgs==2){
PsychAllocInCharArg(2, kPsychArgRequired, &newFontName);
PsychPrefStateSet_DefaultFontName(newFontName);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "TextEncodingLocale")){
PsychCopyOutCharArg(1, kPsychArgOptional, PsychGetUnicodeTextConversionLocale());
if(numInputArgs==2){
PsychAllocInCharArg(2, kPsychArgRequired, &newFontName);
if (!PsychSetUnicodeTextConversionLocale(newFontName)) PsychErrorExitMsg(PsychError_user, "Setting the 'TextEncodingLocale' failed, most likely because you provided an invalid/unknown locale setting string.");
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "DefaultFontStyle")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_DefaultTextStyle());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &newFontStyleNumber);
PsychPrefStateSet_DefaultTextStyle(newFontStyleNumber);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "OverrideMultimediaEngine")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_UseGStreamer());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_UseGStreamer(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "DefaultTextYPositionIsBaseline")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_TextYPositionIsBaseline());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_TextYPositionIsBaseline(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "TextAntiAliasing")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_TextAntiAliasing());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_TextAntiAliasing(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "TextRenderer")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_TextRenderer());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_TextRenderer(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "DefaultFontSize")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_DefaultTextSize());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &newFontSize);
PsychPrefStateSet_DefaultTextSize(newFontSize);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "DebugMakeTexture")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_DebugMakeTexture());
if(numInputArgs==2){
PsychCopyInFlagArg(2, kPsychArgRequired, &tempFlag);
PsychPrefStateSet_DebugMakeTexture(tempFlag);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "SkipSyncTests")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_SkipSyncTests());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_SkipSyncTests(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "VisualDebugLevel")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_VisualDebugLevel());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_VisualDebugLevel(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "VBLTimestampingMode")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_VBLTimestampingMode());
if(numInputArgs>=2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_VBLTimestampingMode(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "SyncTestSettings")){
PsychPrefStateGet_SynctestThresholds(&maxStddev, &minSamples, &maxDeviation, &maxDuration);
PsychCopyOutDoubleArg(1, kPsychArgOptional, maxStddev);
PsychCopyOutDoubleArg(2, kPsychArgOptional, minSamples);
PsychCopyOutDoubleArg(3, kPsychArgOptional, maxDeviation);
PsychCopyOutDoubleArg(4, kPsychArgOptional, maxDuration);
if(numInputArgs>=2){
PsychCopyInDoubleArg( 2, kPsychArgOptional, &maxStddev);
PsychCopyInIntegerArg(3, kPsychArgOptional, &minSamples);
PsychCopyInDoubleArg( 4, kPsychArgOptional, &maxDeviation);
PsychCopyInDoubleArg( 5, kPsychArgOptional, &maxDuration);
PsychPrefStateSet_SynctestThresholds(maxStddev, minSamples, maxDeviation, maxDuration);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "VBLEndlineOverride")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_VBLEndlineOverride());
if(numInputArgs>=2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_VBLEndlineOverride(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "DefaultVideocaptureEngine")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_VideoCaptureEngine());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_VideoCaptureEngine(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "WindowShieldingLevel")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_WindowShieldingLevel());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_WindowShieldingLevel(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "ConserveVRAM") || PsychMatch(preferenceName, "Workarounds1")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_ConserveVRAM());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_ConserveVRAM(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "Verbosity")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_Verbosity());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_Verbosity(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "FrameRectCorrection")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_FrameRectCorrection());
if(numInputArgs==2){
PsychCopyInDoubleArg(2, kPsychArgRequired, &inputDoubleValue);
PsychPrefStateSet_FrameRectCorrection(inputDoubleValue);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "EmulateOldPTB")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_EmulateOldPTB());
if(numInputArgs==2){
PsychCopyInFlagArg(2, kPsychArgRequired, &tempFlag);
PsychPrefStateSet_EmulateOldPTB(tempFlag);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "Enable3DGraphics")){
PsychCopyOutDoubleArg(1, kPsychArgOptional, PsychPrefStateGet_3DGfx());
if(numInputArgs==2){
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
PsychPrefStateSet_3DGfx(tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "TextAlphaBlending")){
textAlphaBlendingFlag=PsychPrefStateGet_TextAlphaBlending();
PsychCopyOutFlagArg(1, kPsychArgOptional, textAlphaBlendingFlag);
if(numInputArgs==2){
PsychCopyInFlagArg(2, kPsychArgRequired, &booleanInput);
PsychPrefStateSet_TextAlphaBlending(booleanInput);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "SuppressAllWarnings")){
suppressAllWarningsFlag=PsychPrefStateGet_SuppressAllWarnings();
PsychCopyOutFlagArg(1, kPsychArgOptional, suppressAllWarningsFlag);
if(numInputArgs==2){
PsychCopyInFlagArg(2, kPsychArgRequired, &booleanInput);
PsychPrefStateSet_SuppressAllWarnings(booleanInput);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "SynchronizeDisplays")){
if(numInputArgs >= 2) {
// This is a special call: It currently doesn't set a preference setting,
// but instead triggers an instantaneous synchronization of all available
// display heads, if possible. We may have a more clever and "standard" interface
// interface for this later on, but for first tests this will do.
// Syncmethod is hard-coded to 0 -> Use whatever's available to sync.
// timeout for retries is 5.0 seconds.
// Acceptable residual offset is +/- 2 scanlines.
// Returns the real residual offset after sync.
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
if (!PsychCopyInIntegerArg(3, kPsychArgOptional, &tempInt3)) {
// No screenId specified: Resync default screen or whatever...
tempInt2 = 0;
if (PsychSynchronizeDisplayScreens(&tempInt2, NULL, &tempInt, tempInt, 5.0, 2)!=PsychError_none) PsychErrorExitMsg(PsychError_user, "Sync failed for reasons mentioned above.");
} else {
// Specific screenId provided: Resync crtc's associated with this screenId if possible:
tempInt2 = 1;
if (PsychSynchronizeDisplayScreens(&tempInt2, &tempInt3, &tempInt, tempInt, 5.0, 2)!=PsychError_none) PsychErrorExitMsg(PsychError_user, "Sync failed for reasons mentioned above.");
}
PsychCopyOutDoubleArg(1, kPsychArgOptional, tempInt);
}
preferenceNameArgumentValid=TRUE;
}else
if(PsychMatch(preferenceName, "ScreenToHead")){
// screenId is required:
PsychCopyInIntegerArg(2, kPsychArgRequired, &tempInt);
if (tempInt < 0 || tempInt >= PsychGetNumDisplays() || tempInt >= kPsychMaxPossibleDisplays) PsychErrorExitMsg(PsychError_user, "Invalid screenId provided. Out of valid range!");
// Return old mappings for this screenId:
for (tempInt2 = 0; (tempInt2 < kPsychMaxPossibleCrtcs) && (PsychPrefStateGet_ScreenToHead(tempInt, tempInt2) >= 0); tempInt2++);
PsychAllocOutDoubleMatArg(1, kPsychArgOptional, 2, tempInt2, 1, &dheads);
tempInt4 = 0;
for (tempInt3 = 0; tempInt3 < tempInt2; tempInt3++) {
dheads[tempInt4++] = (double) PsychPrefStateGet_ScreenToHead(tempInt, tempInt3);
dheads[tempInt4++] = (double) PsychPrefStateGet_ScreenToCrtcId(tempInt, tempInt3);
}
// Optionally retrieve and set new mappings for this screenId:
if(numInputArgs>=3) {
// Set new headId for screenId:
PsychCopyInIntegerArg(3, kPsychArgRequired, &tempInt2);
if (tempInt2 < 0) PsychErrorExitMsg(PsychError_user, "Invalid negative headId provided!");
// Set new crtcId for screenId:
PsychCopyInIntegerArg(4, kPsychArgRequired, &tempInt3);
if (tempInt3 < 0) PsychErrorExitMsg(PsychError_user, "Invalid negative crtcId provided!");
// Assign primary head by default (index 0), but allow optionally others as well:
tempInt4 = 0;
PsychCopyInIntegerArg(5, kPsychArgOptional, &tempInt4);
if (tempInt4 < 0 || tempInt4 >= kPsychMaxPossibleCrtcs) PsychErrorExitMsg(PsychError_user, "Invalid rankId provided! Too many heads for one screen!");
PsychPrefStateSet_ScreenToHead(tempInt, tempInt2, tempInt3, tempInt4);
}
preferenceNameArgumentValid=TRUE;
}else
PsychErrorExit(PsychError_unrecognizedPreferenceName);
}
if(!preferenceNameArgumentValid)
PsychErrorExitMsg(PsychError_user, "Invalid arguments to preferences command");
return(PsychError_none);
}
/* PsychEnableNative10BitFramebuffer() - Enable/Disable native 10 bpc RGB framebuffer modes.
*
* This function enables or disables the native ARGB2101010 framebuffer readout mode of supported
* graphics hardware. Currently the ATI Radeon X1000/HD2000/HD3000 and later cards should allow this.
*
* This needs support from the Psychtoolbox kernel level support driver for low-level register reads
* and writes to the GPU registers.
*
* 'windowRecord' Is used to find the Id of the screen for which mode should be changed, as well as enable
* flags to see if a change is required at all, and the OpenGL context for some specific
* fixups. A value of NULL will try to apply the operation to all heads, but may only work
* for *disabling* 10 bpc mode, not for enabling it -- Mostly useful for a master reset to
* system default, e.g., as part of error handling or Screen shutdown handling.
* 'enable' True = Enable ABGR2101010 support, False = Disable ARGB2101010 support, reenable ARGB8888 support.
*
*/
psych_bool PsychEnableNative10BitFramebuffer(PsychWindowRecordType* windowRecord, psych_bool enable)
{
#if PSYCH_SYSTEM == PSYCH_OSX || PSYCH_SYSTEM == PSYCH_LINUX
int i, si, ei, headid, headiter, screenId;
unsigned int lutreg, ctlreg, value, status;
int gpuMaintype, gpuMinortype;
// Child protection:
if (windowRecord && !PsychIsOnscreenWindow(windowRecord)) PsychErrorExitMsg(PsychError_internal, "Invalid non-onscreen windowRecord provided!!!");
// Either screenid from windowRecord or our special -1 "all Screens" Id:
screenId = (windowRecord) ? windowRecord->screenNumber : -1;
// We only support Radeon GPU's, nothing else:
if (!PsychGetGPUSpecs(screenId, &gpuMaintype, &gpuMinortype, NULL, NULL) ||
(gpuMaintype != kPsychRadeon) || (gpuMinortype >= 0xffff)) {
return(FALSE);
}
// Define range of screens: Either a single specific one, or all:
si = (screenId!=-1) ? screenId : 0;
ei = (screenId!=-1) ? screenId+1 : PsychGetNumDisplays();
// Loop over all target screens:
for (i = si; i < ei; i++) {
// Iterate over range of all assigned heads for this screenId 'i' and reconfigure them:
for (headiter = 0; headiter < kPsychMaxPossibleCrtcs; headiter++) {
// Map screenid to headid for headiter'th head:
headid = PsychScreenToCrtcId(i, headiter);
// We're done as soon as we encounter invalid negative headid.
if (headid < 0) break;
// Select Radeon HW registers for corresponding heads:
if (gpuMinortype < 0x40) {
// DCE-3 and earlier:
lutreg = (headid == 0) ? RADEON_D1GRPH_LUT_SEL : RADEON_D2GRPH_LUT_SEL;
ctlreg = (headid == 0) ? RADEON_D1GRPH_CONTROL : RADEON_D2GRPH_CONTROL;
}
else {
// DCE-4 and later:
if (headid > DCE4_MAXHEADID) {
printf("PTB-ERROR: Invalid headId %i (greater than max %i) provided for DCE-4+ display engine!\n", headid, DCE4_MAXHEADID);
return(false);
}
lutreg = EVERGREEN_DC_LUT_10BIT_BYPASS + crtcoff[headid];
ctlreg = EVERGREEN_GRPH_CONTROL + crtcoff[headid];
}
// Enable or Disable?
if (enable) {
// Enable:
// Switch hardware LUT's to bypass mode:
// We set bit 8 to enable "bypass LUT in 2101010 mode":
value = PsychOSKDReadRegister(screenId, lutreg, &status);
if (status) {
printf("PTB-ERROR: Failed to set 10 bit framebuffer mode (LUTReg read failed).\n");
return(false);
}
// Set the bypass bit:
value = value | 0x1 << 8;
PsychOSKDWriteRegister(screenId, lutreg, value, &status);
if (status) {
printf("PTB-ERROR: Failed to set 10 bit framebuffer mode (LUTReg write failed).\n");
return(false);
}
// Only reconfigure framebuffer scanout if this is really our true Native10bpc hack:
// This is usually skipped on FireGL/FirePro GPU's as their drivers do it already...
if (windowRecord->specialflags & kPsychNative10bpcFBActive) {
// Switch CRTC to ABGR2101010 readout mode:
// We set bit 8 to enable that mode:
value = PsychOSKDReadRegister(screenId, ctlreg, &status);
if (status) {
printf("PTB-ERROR: Failed to set 10 bit framebuffer mode (CTLReg read failed).\n");
return(false);
}
// Set 2101010 mode bit:
value = value | 0x1 << 8;
PsychOSKDWriteRegister(screenId, ctlreg, value, &status);
if (status) {
printf("PTB-ERROR: Failed to set 10 bit framebuffer mode (CTLReg write failed).\n");
return(false);
}
}
// Pipe should be in 10 bpc mode now...
if (PsychPrefStateGet_Verbosity() > 2) printf("PTB-INFO: System framebuffer switched to ARGB2101010 mode for screen %i [head %i].\n", i, headid);
} else {
// Disable:
// Only reconfigure framebuffer scanout if this is really our true Native10bpc hack:
// This is usually skipped on FireGL/FirePro GPU's as their drivers do it already...
if (windowRecord->specialflags & kPsychNative10bpcFBActive) {
// Switch CRTC to ABGR8888 readout mode:
// We clear bit 8 to enable that mode:
value = PsychOSKDReadRegister(screenId, ctlreg, &status);
if (status) {
// This codepath gets always called in PsychCloseWindow(), so we should skip it
// silently if register read fails, as this is expected on MS-Windows and on all
// non-Radeon hardware and if kernel driver isn't loaded:
if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-ERROR: Failed to set 8 bit framebuffer mode (CTLReg read failed).\n");
return(false);
}
else if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In disable 10bpc: Readreg. ctlreg yields %lx\n", value);
// Clear 2101010 mode bit:
value = value & ~(0x1 << 8);
PsychOSKDWriteRegister(screenId, ctlreg, value, &status);
if (status) {
printf("PTB-ERROR: Failed to set 8 bit framebuffer mode (CTLReg write failed).\n");
return(false);
}
else if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In disable 10bpc: ctlreg reset\n");
// Wait 500 msecs for GPU to settle:
PsychWaitIntervalSeconds(0.5);
}
// Switch hardware LUT's to standard mapping mode:
// We clear bit 8 to disable "bypass LUT in 2101010 mode":
value = PsychOSKDReadRegister(screenId, lutreg, &status);
if (status) {
printf("PTB-ERROR: Failed to set 8 bit framebuffer mode (LUTReg read failed).\n");
return(false);
}
else if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In disable 10bpc: Readreg. lutreg yields %lx\n", value);
// Clear LUT bypass bit:
value = value & ~(0x1 << 8);
PsychOSKDWriteRegister(screenId, lutreg, value, &status);
if (status) {
printf("PTB-ERROR: Failed to set 8 bit framebuffer mode (LUTReg write failed).\n");
return(false);
}
else if (PsychPrefStateGet_Verbosity() > 5) printf("PTB-DEBUG: In disable 10bpc: lutreg reset\n");
// Pipe should be in 8 bpc mode now...
if (PsychPrefStateGet_Verbosity() > 2) printf("PTB-INFO: System framebuffer switched to standard ARGB8888 mode for screen %i [head %i].\n", i, headid);
}
} // Next display head...
} // Next screenId.
// Done.
return(TRUE);
#else
// This cool stuff not supported on the uncool Windows OS:
return(FALSE);
#endif
}
// Implement closing of all onscreen- and offscreen windows, release of all captured displays,
// releasing of all internal textures and memory buffers, stopping of internal helper threads,
// etc....
// This routine is normally called by SCREENCloseAll, but can be also called by the exit-handler,
// and diverse error-handlers for cleanup.
void ScreenCloseAllWindows(void)
{
PsychWindowRecordType **windowRecordArray;
int i, numWindows, numScreens;
static unsigned int recursionLevel = 0;
// Recursive self-call?
if (recursionLevel > 0) {
// Ohoh: We are recursively calling ourselves, probably due to some
// error condition triggered during our execution. This is bad, we need
// to break the infinite recursion. How? We output a recursion warning,
// then return as no-op:
printf("PTB-ERROR: Error during error handling! ScreenCloseAllWindows() called recursively! Trying to break out of this vicious cycle...\n");
printf("PTB-ERROR: Maybe it is a good idea to exit and restart Matlab/Octave.\n");
// Skip to the release screen routine and hope for the best:
goto critical_abort;
}
recursionLevel++;
// Cold-Reset the drawing target:
PsychColdResetDrawingTarget();
// Reset the "userspaceGL" flag which tells PTB that userspace GL rendering was active
// due to Screen('BeginOpenGL') command.
PsychSetUserspaceGLFlag(FALSE);
// Check for stale texture ressources:
PsychRessourceCheckAndReminder(TRUE);
// Shutdown Quicktime subsystems if active:
PsychExitMovieWriting();
PsychExitMovies();
PsychExitVideoCapture();
// Close the windows: We do it reverse (descending) order so textures get closed
// before the onscreen windows. In theory this shouldn't matter, but in practice,
// more stress on the PsychCloseWindow() path. If we have bugs there, chances are
// higher they get exposed this way, which long-term is a good thing(TM).
PsychCreateVolatileWindowRecordPointerList(&numWindows, &windowRecordArray);
for(i = numWindows - 1; i >= 0; i--) {
if (PsychPrefStateGet_Verbosity()>5) { printf("PTB-DEBUG: In ScreenCloseAllWindows(): Destroying window %i\n", i); fflush(NULL); }
PsychCloseWindow(windowRecordArray[i]);
}
PsychDestroyVolatileWindowRecordPointerList(windowRecordArray);
critical_abort:
// Release all captured displays, unhide the cursor on each of them:
numScreens=PsychGetNumDisplays();
for(i=0;i<numScreens;i++){
if(PsychIsScreenCaptured(i)) {
PsychRestoreScreenSettings(i);
PsychReleaseScreen(i);
}
PsychShowCursor(i, -1);
}
recursionLevel--;
return;
}
/*
PsychOSOpenOnscreenWindow()
Creates the pixel format and the context objects and then instantiates the context onto the screen.
-The pixel format and the context are stored in the target specific field of the window recored. Close
should clean up by destroying both the pixel format and the context.
-We mantain the context because it must be be made the current context by drawing functions to draw into
the specified window.
-We maintain the pixel format object because there seems to be now way to retrieve that from the context.
-To tell the caller to clean up PsychOSOpenOnscreenWindow returns FALSE if we fail to open the window. It
would be better to just issue an PsychErrorExit() and have that clean up everything allocated outside of
PsychOpenOnscreenWindow().
*/
boolean PsychOSOpenOnscreenWindow(PsychScreenSettingsType *screenSettings, PsychWindowRecordType *windowRecord, int numBuffers, int stereomode, int conserveVRAM)
{
RECT winRec;
PsychRectType screenrect;
CGDirectDisplayID cgDisplayID;
int pf;
unsigned int nNumFormats;
HDC hDC;
HWND hWnd;
WNDCLASS wc;
PIXELFORMATDESCRIPTOR pfd;
int attribs[48];
int attribcount;
float fattribs[2]={0,0};
int x, y, width, height, i, bpc;
GLenum glerr;
DWORD flags;
boolean fullscreen = FALSE;
DWORD windowStyle = WS_CLIPSIBLINGS | WS_CLIPCHILDREN;
// The WS_EX_NOACTIVATE flag prevents the window from grabbing keyboard focus. That way,
// the new Java-GetChar can do its job.
DWORD windowExtendedStyle = WS_EX_APPWINDOW | 0x08000000; // const int WS_EX_NOACTIVATE = 0x08000000;
// Init to safe default:
windowRecord->targetSpecific.glusercontextObject = NULL;
// Map the logical screen number to a device handle for the corresponding
// physical display device: CGDirectDisplayID is currently typedef'd to a
// HDC windows hardware device context handle.
PsychGetCGDisplayIDFromScreenNumber(&cgDisplayID, screenSettings->screenNumber);
// Check if this should be a fullscreen window:
PsychGetScreenRect(screenSettings->screenNumber, screenrect);
if (PsychMatchRect(screenrect, windowRecord->rect)) {
// This is supposed to be a fullscreen window with the dimensions of
// the current display/desktop:
// Switch system to fullscreen-mode without changing any settings:
fullscreen = ChangeScreenResolution(screenSettings->screenNumber, 0, 0, 0, 0);
}
else {
// Window size different from current screen size:
// A regular desktop window with borders and control icons is requested, e.g., for debugging:
fullscreen = FALSE;
}
// Special case for explicit multi-display setup under Windows when opening a window on
// screen zero. We enforce the fullscreen - flag, aka a borderless top level window. This way,
// if anything of our automatic full-desktop window emulation code goes wrong on exotic setups,
// the user can still enforce a suitably positioned and sized borderless toplevel window.
if (PsychGetNumDisplays()>2 && screenSettings->screenNumber == 0) fullscreen = TRUE;
if (fullscreen) {
windowStyle = WS_POPUP; // Set The WindowStyle To WS_POPUP (Popup Window without borders)
windowExtendedStyle |= WS_EX_TOPMOST; // Set The Extended Window Style To WS_EX_TOPMOST
}
else {
windowStyle |= WS_OVERLAPPEDWINDOW;
windowExtendedStyle |= WS_EX_TOPMOST; // Set The Extended Window Style To WS_EX_TOPMOST
}
// Define final position and size of window:
x=windowRecord->rect[kPsychLeft];
y=windowRecord->rect[kPsychTop];
width=PsychGetWidthFromRect(windowRecord->rect);
height=PsychGetHeightFromRect(windowRecord->rect);
// Register our own window class for Psychtoolbox onscreen windows:
// Only register the window class once - use hInstance as a flag.
if (!hInstance) {
hInstance = GetModuleHandle(NULL);
wc.style = CS_OWNDC;
wc.lpfnWndProc = WndProc;
wc.cbClsExtra = 0;
wc.cbWndExtra = 0;
wc.hInstance = hInstance;
wc.hIcon = LoadIcon(hInstance, IDI_WINLOGO);
wc.hCursor = LoadCursor(NULL, IDC_ARROW);
wc.hbrBackground = NULL;
wc.lpszMenuName = NULL;
wc.lpszClassName = "PTB-OpenGL";
if (!RegisterClass(&wc)) {
hInstance = 0;
printf("\nPTB-ERROR[Register Windowclass failed]: Unknown error, Win32 specific.\n\n");
return(FALSE);
}
}
//if (PSYCH_DEBUG == PSYCH_ON) printf("Creating Window...\n");
// Adjust window bounds to account for the window borders if we are in non-fullscreen mode:
if (!fullscreen) {
winRec.left=x; winRec.top=y; winRec.right=x+width; winRec.bottom=y+height;
AdjustWindowRectEx(&winRec, windowStyle, 0, windowExtendedStyle);
x=winRec.left; y=winRec.top; width=winRec.right - winRec.left; height=winRec.bottom - winRec.top;
}
// Window class registered: Create a window of this class with some specific properties:
hWnd = CreateWindowEx(windowExtendedStyle,
"PTB-OpenGL",
"PTB Onscreen window",
windowStyle,
x, y, width, height, NULL, NULL, hInstance, NULL);
if (hWnd == NULL) {
printf("\nPTB-ERROR[CreateWindow() failed]: Unknown error, Win32 specific.\n\n");
return(FALSE);
}
// Retrieve device context for the window:
hDC = GetDC(hWnd);
// Setup optional flags for pixelformat:
flags = 0;
// Init pfd to zero:
memset(&pfd, 0, sizeof(pfd));
attribcount = 0;
attribs[attribcount++]=0x2001; // WGL_DRAW_TO_WINDOW_ARB
attribs[attribcount++]=GL_TRUE;
attribs[attribcount++]=0x2010; // WGL_SUPPORT_OPENGL_ARB
attribs[attribcount++]=GL_TRUE;
attribs[attribcount++]=0x2007; // WGL_SWAP_METHOD_ARB
attribs[attribcount++]=0x2028; // WGL_SWAP_EXCHANGE_ARB
attribs[attribcount++]=0x2013; // WGL_PIXEL_TYPE_ARB
// Select either floating point or fixed point framebuffer:
if (windowRecord->depth == 64 || windowRecord->depth == 128) {
// Request a floating point drawable instead of a fixed-point one:
attribs[attribcount++]=WGL_TYPE_RGBA_FLOAT_ARB;
}
else {
// Request standard fixed point drawable:
attribs[attribcount++]=0x202B; // WGL_TYPE_RGBA_ARB
}
// Select requested depth per color component 'bpc' for each channel:
bpc = 8; // We default to 8 bpc == RGBA8
if (windowRecord->depth == 30) { bpc = 10; printf("PTB-INFO: Trying to enable at least 10 bpc fixed point framebuffer.\n"); }
if (windowRecord->depth == 64) { bpc = 16; printf("PTB-INFO: Trying to enable 16 bpc floating point framebuffer.\n"); }
if (windowRecord->depth == 128) { bpc = 32; printf("PTB-INFO: Trying to enable 32 bpc floating point framebuffer.\n"); }
// Set up color depth for each channel:
attribs[attribcount++]=WGL_RED_BITS_ARB;
attribs[attribcount++]=bpc;
attribs[attribcount++]=WGL_GREEN_BITS_ARB;
attribs[attribcount++]=bpc;
attribs[attribcount++]=WGL_BLUE_BITS_ARB;
attribs[attribcount++]=bpc;
attribs[attribcount++]=WGL_ALPHA_BITS_ARB;
// Alpha channel has only 2 bpc in the fixed point bpc=10 case, i.e. RGBA=8882.
attribs[attribcount++]=(bpc == 10) ? 2 : bpc;
// Stereo display support: If stereo display output is requested with OpenGL native stereo,
// we request a stereo-enabled rendering context.
if(stereomode==kPsychOpenGLStereo) {
flags = flags | PFD_STEREO;
attribs[attribcount++]=0x2012; // WGL_STEREO_ARB
attribs[attribcount++]=GL_TRUE;
}
// Double buffering requested?
if(numBuffers>=2) {
// Enable double-buffering:
flags = flags | PFD_DOUBLEBUFFER;
attribs[attribcount++]=0x2011; // WGL_DOUBLE_BUFFER_ARB
attribs[attribcount++]=GL_TRUE;
// AUX buffers for Flip-Operations needed?
if ((conserveVRAM & kPsychDisableAUXBuffers) == 0) {
// Allocate one or two (mono vs. stereo) AUX buffers for new "don't clear" mode of Screen('Flip'):
// Not clearing the framebuffer after "Flip" is implemented by storing a backup-copy of
// the backbuffer to AUXs before flip and restoring the content from AUXs after flip.
pfd.cAuxBuffers=(stereomode==kPsychOpenGLStereo || stereomode==kPsychCompressedTLBRStereo || stereomode==kPsychCompressedTRBLStereo) ? 2 : 1;
attribs[attribcount++]=0x2024; // WGL_AUX_BUFFERS_ARB
attribs[attribcount++]=pfd.cAuxBuffers;
}
}
//if (PSYCH_DEBUG == PSYCH_ON) printf("Device context is %p\n", hDC);
// Build pixelformat descriptor:
pfd.nSize = sizeof(pfd);
pfd.nVersion = 1;
pfd.dwFlags = PFD_DRAW_TO_WINDOW | PFD_SUPPORT_OPENGL | PFD_SWAP_EXCHANGE |flags; // Want OpenGL capable window with bufferswap via page-flipping...
pfd.iPixelType = PFD_TYPE_RGBA; // Want a RGBA pixel format.
pfd.cColorBits = 32; // 32 bpp at least...
pfd.cAlphaBits = 8; // Want a 8 bit alpha-buffer.
// Support for OpenGL 3D rendering requested?
if (PsychPrefStateGet_3DGfx()) {
// Yes. Allocate and attach a 24bit depth buffer and 8 bit stencil buffer:
pfd.cDepthBits = 24;
pfd.cStencilBits = 8;
attribs[attribcount++]=0x2022; // WGL_DEPTH_BITS_ARB
attribs[attribcount++]=24;
attribs[attribcount++]=0x2023; // WGL_STENCIL_BITS_ARB
attribs[attribcount++]=8;
}
// Multisampled Anti-Aliasing requested?
if (windowRecord->multiSample > 0) {
// Request a multisample buffer:
attribs[attribcount++]= 0x2041; // WGL_SAMPLE_BUFFERS_ARB
attribs[attribcount++]= 1;
// Request at least multiSample samples per pixel:
attribs[attribcount++]= 0x2042; // WGL_SAMPLES_ARB
attribs[attribcount++]= windowRecord->multiSample;
}
// Finalize attribs-array:
attribs[attribcount++]= 0;
//if (PSYCH_DEBUG == PSYCH_ON) printf("Choosing pixelformat\n");
// Create pixelformat:
// This is typical Microsoft brain-damage: We first need to create a window the
// conventional old way just to be able to get a handle to the new wglChoosePixelFormat
// method, which will us - after destroying and recreating the new window - allow to
// select the pixelformat we actually want!
// Step 1: Choose pixelformat old-style:
pf = ChoosePixelFormat(hDC, &pfd);
// Do we have a valid pixelformat?
if (pf == 0) {
// Nope. We give up!
ReleaseDC(hDC, hWnd);
DestroyWindow(hWnd);
printf("\nPTB-ERROR[ChoosePixelFormat() failed]: Unknown error, Win32 specific.\n\n");
return(FALSE);
}
// Yes. Set it:
if (SetPixelFormat(hDC, pf, &pfd) == FALSE) {
ReleaseDC(hDC, hWnd);
DestroyWindow(hWnd);
printf("\nPTB-ERROR[SetPixelFormat() failed]: Unknown error, Win32 specific.\n\n");
return(FALSE);
}
// Ok, create and attach the rendering context.
windowRecord->targetSpecific.contextObject = wglCreateContext(hDC);
if (windowRecord->targetSpecific.contextObject == NULL) {
ReleaseDC(hDC, hWnd);
DestroyWindow(hWnd);
printf("\nPTB-ERROR:[Context creation failed] Unknown, Win32 specific.\n\n");
return(FALSE);
}
// Store the handles...
windowRecord->targetSpecific.windowHandle = hWnd;
windowRecord->targetSpecific.deviceContext = hDC;
// Activate the rendering context:
PsychOSSetGLContext(windowRecord);
// Ok, the OpenGL rendering context is up and running. Auto-detect and bind all
// available OpenGL extensions via GLEW:
glerr = glewInit();
if (GLEW_OK != glerr)
{
/* Problem: glewInit failed, something is seriously wrong. */
printf("\nPTB-ERROR[GLEW init failed: %s]: Please report this to the forum. Will try to continue, but may crash soon!\n\n", glewGetErrorString(glerr));
fflush(NULL);
}
else {
if (PsychPrefStateGet_Verbosity()>4) printf("PTB-INFO: Using GLEW version %s for automatic detection of OpenGL extensions...\n", glewGetString(GLEW_VERSION));
}
DescribePixelFormat(hDC, pf, sizeof(PIXELFORMATDESCRIPTOR), &pfd);
if ((stereomode==kPsychOpenGLStereo) && ((pfd.dwFlags & PFD_STEREO)==0)) {
// Ooops. Couldn't get the requested stereo-context from hardware :(
ReleaseDC(hDC, hWnd);
DestroyWindow(hWnd);
printf("PTB-ERROR: OpenGL native stereo mode unavailable. Your hardware may not support it,\n"
"PTB-ERROR: or at least not on a flat-panel? Expect abortion of your script soon...");
return(FALSE);
}
// Special debug override for faulty drivers with non-working extension:
if (conserveVRAM & kPsychOverrideWglChoosePixelformat) wglChoosePixelFormatARB = NULL;
// Step 2: Ok, we have an OpenGL rendering context with all known extensions bound:
// Do we have (or want) support for wglChoosePixelFormatARB?
// We skip use of it if we can do without it, i.e., when we don't need unusual framebuffer
// configs (like non 8bpc fixed) and we don't need multisampling. This is a work-around
// for hardware that has trouble (=driver bugs) with wglChoosePixelformat() in some modes, e.g., the NVidia
// Quadro gfx card, which fails to enable quad-buffered stereo when using wglChoosePixelformat(),
// but does so perfectly well when using the old-style ChoosePixelFormat().
if ((wglChoosePixelFormatARB == NULL) || ((bpc==8) && (windowRecord->multiSample <= 0))) {
// Failed (==NULL) or disabled via override.
if ((wglChoosePixelFormatARB == NULL) && (PsychPrefStateGet_Verbosity() > 1)) printf("PTB-WARNING: Could not bind wglChoosePixelFormat - Extension. Some features will be unavailable, e.g., Anti-Aliasing and high precision framebuffers.\n");
}
else {
// Supported. We destroy the rendering context and window, then recreate it with
// the wglChoosePixelFormat - method...
wglMakeCurrent(NULL, NULL);
// Delete rendering context:
wglDeleteContext(windowRecord->targetSpecific.contextObject);
windowRecord->targetSpecific.contextObject=NULL;
// Release device context:
ReleaseDC(windowRecord->targetSpecific.deviceContext, windowRecord->targetSpecific.windowHandle);
windowRecord->targetSpecific.deviceContext=NULL;
// Close & Destroy the window:
DestroyWindow(windowRecord->targetSpecific.windowHandle);
windowRecord->targetSpecific.windowHandle=NULL;
// Ok, old window and stuff is dead. Create new window:
hWnd = CreateWindowEx(windowExtendedStyle, "PTB-OpenGL", "PTB Onscreen window", windowStyle,
x, y, width, height, NULL, NULL, hInstance, NULL);
if (hWnd == NULL) {
printf("\nPTB-ERROR[CreateWindow() - II failed]: Unknown error, Win32 specific.\n\n");
return(FALSE);
}
// Retrieve device context for the window:
hDC = GetDC(hWnd);
pf = 0;
nNumFormats=0;
wglChoosePixelFormatARB(hDC, &attribs[0], NULL, 1, &pf, &nNumFormats);
if (nNumFormats==0 && windowRecord->multiSample > 0) {
// Failed. Probably due to too demanding multisample requirements: Lets lower them...
for (i=0; i<attribcount && attribs[i]!=0x2042; i++);
// Reduce requested number of samples/pixel and retry until we get one:
while (nNumFormats==0 && windowRecord->multiSample > 0) {
// printf("Failed for multisampling level %i nNum=%i\n", windowRecord->multiSample, nNumFormats);
attribs[i+1]--;
windowRecord->multiSample--;
wglChoosePixelFormatARB(hDC, &attribs[0], NULL, 1, &pf, &nNumFormats);
}
// If we still do not get one with 0 samples per pixel, we can try to disable
// multisampling completely:
if (windowRecord->multiSample == 0 && nNumFormats==0) {
// printf("Failed for multisampling level %i nNum=%i --> Disabling multisampling...\n", windowRecord->multiSample, nNumFormats);
// We 0-Out all entries related to multi-sampling, including the
// GL_SAMPLES_ARB and GL_SAMPLE_BUFFERS_ARB enums themselves:
for (i=0; i<attribcount && attribs[i]!=0x2042; i++);
attribs[i]=0;
for (i=0; i<attribcount && attribs[i]!=0x2041; i++);
attribs[i]=0;
attribs[i+1]=0;
wglChoosePixelFormatARB(hDC, &attribs[0], NULL, 1, &pf, &nNumFormats);
}
}
if (nNumFormats==0 && numBuffers>=2) {
// We still don't have a valid pixelformat, but double-buffering is enabled.
// Let's try if we get one if we do not request any AUX-Buffers:
for (i=0; i<attribcount && attribs[i]!=0x2024; i++);
attribs[i+1] = 0; // Zero AUX-Buffers requested.
wglChoosePixelFormatARB(hDC, &attribs[0], NULL, 1, &pf, &nNumFormats);
}
if (nNumFormats==0 && numBuffers>=2) {
// We still don't have a valid pixelformat, but double-buffering is enabled.
// Let's try if we get one if we do not request SWAP_EXCHANGED double buffering anymore:
for (i=0; i<attribcount && attribs[i]!=0x2028; i++);
attribs[i] = 0x202A; // WGL_SWAP_UNDEFINED_ARB
wglChoosePixelFormatARB(hDC, &attribs[0], NULL, 1, &pf, &nNumFormats);
}
// Either we have a multisampled or non-multisampled format, or none. If we failed,
// then we can not do anything anymore about it.
// Do we have a valid pixelformat?
if (nNumFormats == 0) {
// Nope. We give up!
ReleaseDC(hDC, hWnd);
DestroyWindow(hWnd);
printf("\nPTB-ERROR[wglChoosePixelFormat() failed]: Unknown error, Win32 specific. Code: %i.\n\n", GetLastError());
return(FALSE);
}
// Yes. Set it:
if (SetPixelFormat(hDC, pf, &pfd) == FALSE) {
ReleaseDC(hDC, hWnd);
DestroyWindow(hWnd);
printf("\nPTB-ERROR[SetPixelFormat() - II failed]: Unknown error, Win32 specific.\n\n");
return(FALSE);
}
// Ok, create and attach the rendering context.
windowRecord->targetSpecific.contextObject = wglCreateContext(hDC);
if (windowRecord->targetSpecific.contextObject == NULL) {
ReleaseDC(hDC, hWnd);
DestroyWindow(hWnd);
printf("\nPTB-ERROR:[Context creation II failed] Unknown, Win32 specific.\n\n");
return(FALSE);
}
// Store the handles...
windowRecord->targetSpecific.windowHandle = hWnd;
windowRecord->targetSpecific.deviceContext = hDC;
// Activate the rendering context:
PsychOSSetGLContext(windowRecord);
DescribePixelFormat(hDC, pf, sizeof(PIXELFORMATDESCRIPTOR), &pfd);
if ((stereomode==kPsychOpenGLStereo) && ((pfd.dwFlags & PFD_STEREO)==0)) {
// Ooops. Couldn't get the requested stereo-context from hardware :(
ReleaseDC(hDC, hWnd);
DestroyWindow(hWnd);
printf("PTB-ERROR: OpenGL native stereo mode unavailable. Your hardware may not support it,\n"
"PTB-ERROR: or at least not on a flat-panel? Expect abortion of your script soon...");
return(FALSE);
}
// Done with final window and OpenGL context setup. We've got our final context enabled.
}
// Enable multisampling if this was requested:
if (windowRecord->multiSample > 0) glEnable(0x809D); // 0x809D == GL_MULTISAMPLE_ARB
// Throw away any error-state this could have created on old hardware...
glGetError();
// External 3D graphics support enabled? Or OpenGL quad-buffered stereo enabled?
// For the former, we need this code for OpenGL state isolation. For the latter we
// need this code as workaround for Windows brain-damage. For some reason it helps
// to properly shutdown stereo contexts on Windows...
if (PsychPrefStateGet_3DGfx() || stereomode == kPsychOpenGLStereo) {
// Yes. We need to create an extra OpenGL rendering context for the external
// OpenGL code to provide optimal state-isolation. The context shares all
// heavyweight ressources likes textures, FBOs, VBOs, PBOs, display lists and
// starts off as an identical copy of PTB's context as of here.
windowRecord->targetSpecific.glusercontextObject = wglCreateContext(hDC);
if (windowRecord->targetSpecific.glusercontextObject == NULL) {
ReleaseDC(hDC, hWnd);
DestroyWindow(hWnd);
printf("\nPTB-ERROR[UserContextCreation failed]: Creating a private OpenGL context for Matlab OpenGL failed for unknown reasons.\n\n");
return(FALSE);
}
wglMakeCurrent(windowRecord->targetSpecific.deviceContext, windowRecord->targetSpecific.glusercontextObject);
wglMakeCurrent(windowRecord->targetSpecific.deviceContext, windowRecord->targetSpecific.contextObject);
// Copy full state from our main context:
if(!wglCopyContext(windowRecord->targetSpecific.contextObject, windowRecord->targetSpecific.glusercontextObject, GL_ALL_ATTRIB_BITS)) {
// This is ugly, but not fatal...
if (PsychPrefStateGet_Verbosity()>1) {
printf("\nPTB-WARNING[wglCopyContext for user context failed]: Copying state to private OpenGL context for Matlab OpenGL failed for unknown reasons.\n\n");
}
}
// Enable ressource sharing with master context for this window:
if (!wglShareLists(windowRecord->targetSpecific.contextObject, windowRecord->targetSpecific.glusercontextObject)) {
// This is ugly, but not fatal...
if (PsychPrefStateGet_Verbosity()>1) {
printf("\nPTB-WARNING[wglShareLists for user context failed]: Ressource sharing with private OpenGL context for Matlab OpenGL failed for unknown reasons.\n\n");
}
}
}
// Finally, show our new window:
ShowWindow(hWnd, SW_SHOW);
// Give it higher priority than other applications windows:
// Disabled: Interferes with JAVA-GetChar: SetForegroundWindow(hWnd);
// Set the focus on it:
// Disabled: Interferes with JAVA-GetChar: SetFocus(hWnd);
// Capture the window if it is a fullscreen one: This window will receive all
// mouse move and mouse button press events. Important for GetMouse() to work
// properly...
if (fullscreen) SetCapture(hWnd);
// Increase our own open window counter:
win32_windowcount++;
// Some info for the user regarding non-fullscreen and ATI hw:
if (!fullscreen && (strstr(glGetString(GL_VENDOR), "ATI"))) {
printf("PTB-INFO: Some ATI graphics cards may not support proper syncing to vertical retrace when\n");
printf("PTB-INFO: running in windowed mode (non-fullscreen). If PTB aborts with 'Synchronization failure'\n");
printf("PTB-INFO: you can disable the sync test via call to Screen('Preference', 'SkipSyncTests', 1); .\n");
printf("PTB-INFO: You won't get proper stimulus onset timestamps though, so windowed mode may be of limited use.\n");
}
// Dynamically bind the VSYNC extension:
//if (strstr(glGetString(GL_EXTENSIONS), "WGL_EXT_swap_control")) {
// Bind it:
// wglSwapIntervalEXT=(PFNWGLEXTSWAPCONTROLPROC) wglGetProcAddress("wglSwapIntervalEXT");
//}
//else {
if (wglSwapIntervalEXT == NULL) {
wglSwapIntervalEXT = NULL;
printf("PTB-WARNING: Your graphics driver doesn't allow me to control syncing wrt. vertical retrace!\n");
printf("PTB-WARNING: Please update your display graphics driver as soon as possible to fix this.\n");
printf("PTB-WARNING: Until then, you can manually enable syncing to VBL somewhere in the display settings\n");
printf("PTB-WARNING: tab of your machine.\n");
}
// Ok, we should be ready for OS independent setup...
//printf("\nPTB-INFO: Low-level (Windoze) setup of onscreen window finished!\n");
//fflush(NULL);
// Well Done!
return(TRUE);
}
/*
IsValidScreenNumberOrUnaffiliated()
Accept a window pointer or a screen number (psychIndex) and return true iff its a valid screen
number or is the token indicating an unaffiliated window.
*/
boolean IsValidScreenNumberOrUnaffiliated(PsychNumdexType numdex)
{
return(((int)((numdex >=PSYCH_FIRST_SCREEN) && (numdex < PsychGetNumDisplays()))) || numdex == kPsychUnaffiliatedWindow);
}
/*
Accept a window pointer or a screen number (psychIndex) and return true if its a valid screen
number and false otherwise
*/
boolean IsValidScreenNumber(PsychNumdexType numdex)
{
return((int)((numdex >=PSYCH_FIRST_SCREEN) && (numdex < PsychGetNumDisplays())));
}
