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 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
|
/*
* PsychToolbox/Source/Common/PsychOpenHMDVRCore/PsychOpenHMDVRCore.c
*
* PROJECTS: PsychOpenHMDVRCore only.
*
* AUTHORS:
*
* mario.kleiner.de@gmail.com mk
*
* PLATFORMS: All.
*
* HISTORY:
*
* 30.07.2017 mk Created. Derived from the PsychOculusVRCore driver for the v0.5 Oculus SDK.
*
* DESCRIPTION:
*
* A Psychtoolbox driver for the virtual reality head sets supported via OpenHMD.
*
* TODO:
*
* - Support for enumeration of OpenHMD devices with their properties (vendor, model, path, properties).
* - Support for filtering out emulated HMD devices and non-HMD's for 'Open' function, unless dummy
* device is requested.
* - Support for input controllers and buttons.
*
*/
#include "PsychOpenHMDVRCore.h"
// Need this _USE_MATH_DEFINES so MSVC 2010 knows M_PI
#define _USE_MATH_DEFINES
#include <math.h>
// Includes from OpenHMD:
#include "openhmd.h"
// Number of maximum simultaneously open VR devices:
#define MAX_PSYCH_OPENHMD_DEVS 10
#define MAX_SYNOPSIS_STRINGS 40
//declare variables local to this file.
static const char *synopsisSYNOPSIS[MAX_SYNOPSIS_STRINGS];
// Our device record:
typedef struct PsychOpenHMDDevice {
ohmd_device* hmd;
psych_bool isTracking;
unsigned int panelSize[2];
unsigned int texSize[2][2];
double ofov[2][4];
uint32_t frameIndex;
} PsychOpenHMDDevice;
PsychOpenHMDDevice openhmddevices[MAX_PSYCH_OPENHMD_DEVS];
static int available_devices = 0;
static unsigned int devicecount = 0;
static int verbosity = 3;
static psych_bool initialized = FALSE;
// The global operation context of OpenHMD:
struct ohmd_context *ctx;
void InitializeSynopsis(void)
{
int i = 0;
const char **synopsis = synopsisSYNOPSIS;
synopsis[i++] = "PsychOpenHMDVRCore - A Psychtoolbox driver for VR hardware supported by OpenHMD.\n";
synopsis[i++] = "This driver allows to control OpenHMD supported hardware like Rift DK1/DK2/CV1, HTC Vive, PSVR.\n";
synopsis[i++] = "The PsychOpenHMDVRCore driver is licensed to you under the terms of the MIT license.";
synopsis[i++] = "See 'help License.txt' in the Psychtoolbox root folder for more details.\n";
synopsis[i++] = "The driver requires the OpenHMD library version 0.3+ to work, which is";
synopsis[i++] = "distributed under the Boost 1.0 license: http://www.openhmd.net\n";
synopsis[i++] = "Usage:";
synopsis[i++] = "\n";
synopsis[i++] = "oldVerbosity = PsychOpenHMDVRCore('Verbosity' [, verbosity]);";
synopsis[i++] = "numHMDs = PsychOpenHMDVRCore('GetCount');";
synopsis[i++] = "[openhmdPtr, modelName] = PsychOpenHMDVRCore('Open' [, deviceIndex=0]);";
synopsis[i++] = "PsychOpenHMDVRCore('Close' [, openhmdPtr]);";
synopsis[i++] = "oldPersistence = PsychOpenHMDVRCore('SetLowPersistence', openhmdPtr [, lowPersistence]);";
synopsis[i++] = "PsychOpenHMDVRCore('Start', openhmdPtr);";
synopsis[i++] = "PsychOpenHMDVRCore('Stop', openhmdPtr);";
synopsis[i++] = "state = PsychOpenHMDVRCore('GetTrackingState', openhmdPtr [, predictionTime=0]);";
synopsis[i++] = "[projL, projR, ipd] = PsychOpenHMDVRCore('GetStaticRenderParameters', openhmdPtr [, clipNear=0.01][, clipFar=10000.0]);";
synopsis[i++] = "[eyePose, eyeIndex, glModelviewMatrix] = PsychOpenHMDVRCore('GetEyePose', openhmdPtr, renderPass);";
synopsis[i++] = "[width, height, fovPort] = PsychOpenHMDVRCore('GetFovTextureSize', openhmdPtr, eye, metersPerTanAngleAtCenter [, fov=[HMDRecommended]]);";
synopsis[i++] = "[width, height, hmdShiftx, hmdShifty, hmdShiftz, abberation, distortion, scrnHorSize, scrnVertSize] = PsychOpenHMDVRCore('GetUndistortionParameters', openhmdPtr, eye [, inputWidth][, inputHeight][, fov]);";
synopsis[i++] = "[vertexShaderSrc, fragmentShaderSrc] = PsychOpenHMDVRCore('GetCorrectionShaders', openhmdPtr);";
synopsis[i++] = NULL; //this tells PsychOpenHMDVRDisplaySynopsis where to stop
if (i > MAX_SYNOPSIS_STRINGS) {
PrintfExit("%s: Increase dimension of synopsis[] from %ld to at least %ld and recompile.", __FILE__, (long) MAX_SYNOPSIS_STRINGS, (long) i);
}
}
PsychError PsychOpenHMDVRDisplaySynopsis(void)
{
int i;
for (i = 0; synopsisSYNOPSIS[i] != NULL; i++)
printf("%s\n",synopsisSYNOPSIS[i]);
return(PsychError_none);
}
static double deg2rad(double deg)
{
return deg / 180.0 * M_PI;
}
static double rad2deg(double rad)
{
return rad / M_PI * 180.0;
}
PsychOpenHMDDevice* PsychGetOpenHMD(int handle, psych_bool dontfail)
{
if (handle < 1 || handle > MAX_PSYCH_OPENHMD_DEVS || openhmddevices[handle-1].hmd == NULL) {
if (!dontfail) {
printf("PTB-ERROR: Invalid OpenHMD device handle %i passed. No such device open.\n", handle);
PsychErrorExitMsg(PsychError_user, "Invalid OpenHMD handle.");
}
return(NULL);
}
return(&(openhmddevices[handle-1]));
}
void PsychOpenHMDVRCheckInit(psych_bool dontfail)
{
// Already initialized? No op then.
if (initialized) return;
// Initialize OpenHMD VR runtime with default parameters:
if ((ctx = ohmd_ctx_create()) != NULL) {
if (verbosity >= 3) printf("PsychOpenHMDVRCore-INFO: OpenHMD VR runtime initialized.\n");
// Get count of available devices:
available_devices = ohmd_ctx_probe(ctx);;
if (available_devices < 0) {
available_devices = 0;
if (verbosity >= 2) printf("PsychOpenHMDVRCore-WARNING: Failed to probe available OpenHMD VR devices: %s\n", ohmd_ctx_get_error(ctx));
}
if (verbosity >= 3) printf("PsychOpenHMDVRCore-INFO: At startup there are %i OpenHMD HMDs available.\n", available_devices);
initialized = TRUE;
}
else {
if (!dontfail)
PsychErrorExitMsg(PsychError_system, "PsychOpenHMDVRCore-ERROR: Initialization of VR runtime failed. Driver disabled!");
}
}
void PsychOpenHMDStop(int handle)
{
PsychOpenHMDDevice* openhmd;
openhmd = PsychGetOpenHMD(handle, TRUE);
if (NULL == openhmd || !openhmd->isTracking) return;
if (verbosity >= 4) printf("PsychOpenHMDVRCore-INFO: Tracking stopped on device with handle %i.\n", handle);
openhmd->isTracking = FALSE;
return;
}
void PsychOpenHMDClose(int handle)
{
PsychOpenHMDDevice* openhmd;
openhmd = PsychGetOpenHMD(handle, TRUE);
if (NULL == openhmd) return;
// Stop device:
PsychOpenHMDStop(handle);
// Close the HMD:
ohmd_close_device(openhmd->hmd);
openhmd->hmd = NULL;
if (verbosity >= 4) printf("PsychOpenHMDVRCore-INFO: Closed OpenHMD HMD with handle %i.\n", handle);
// Done with this device:
devicecount--;
}
void PsychOpenHMDVRInit(void) {
int handle;
for (handle = 0 ; handle < MAX_PSYCH_OPENHMD_DEVS; handle++)
openhmddevices[handle].hmd = NULL;
available_devices = 0;
devicecount = 0;
ctx = NULL;
initialized = FALSE;
}
PsychError PsychOpenHMDVRShutDown(void) {
int handle;
if (initialized) {
for (handle = 0 ; handle < MAX_PSYCH_OPENHMD_DEVS; handle++)
PsychOpenHMDClose(handle);
// Shutdown runtime:
ohmd_ctx_destroy(ctx);
ctx = NULL;
if (verbosity >= 4) printf("PsychOpenHMDVRCore-INFO: OpenHMD VR runtime shutdown complete.\n");
}
initialized = FALSE;
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRVerbosity(void)
{
static char useString[] = "oldVerbosity = PsychOpenHMDVRCore('Verbosity' [, verbosity]);";
static char synopsisString[] = "Returns and optionally sets level of 'verbosity' for driver debug output.\n"
"'verbosity' = New level of verbosity: 0 = Silent, 1 = Errors only, 2 = Warnings, 3 = Info, 4 = Debug.\n";
static char seeAlsoString[] = "";
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if (PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
// Check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(1));
PsychErrorExit(PsychCapNumInputArgs(1));
// Return optional old verbosity setting:
PsychCopyOutDoubleArg(1, kPsychArgOptional, verbosity);
// Get optional new verbosity setting:
PsychCopyInIntegerArg(1, kPsychArgOptional, &verbosity);
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRGetCount(void)
{
static char useString[] = "numHMDs = PsychOpenHMDVRCore('GetCount');";
static char synopsisString[] = "Returns count of currently connected HMDs.\n"
"Returns -1 if the runtime couldn't get initialized.\n";
static char seeAlsoString[] = "Open";
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if( PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
// Check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(1));
PsychErrorExit(PsychCapNumInputArgs(0));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(TRUE);
if (!initialized) {
available_devices = -1;
}
else {
// Only reprobe if context does not have any devices open already:
available_devices = (devicecount == 0) ? ohmd_ctx_probe(ctx) : available_devices;
if (available_devices < 0) {
available_devices = -1;
if (verbosity >= 2) printf("PsychOpenHMDVRCore-WARNING: Could not probe OpenHMD devices.\n");
}
}
PsychCopyOutDoubleArg(1, kPsychArgOptional, available_devices);
return(PsychError_none);
}
PsychError PSYCHOPENHMDVROpen(void)
{
static char useString[] = "[openhmdPtr, modelName, panelSizeX, panelSizeY] = PsychOpenHMDVRCore('Open' [, deviceIndex=0]);";
// 1 2 3 4 1
static char synopsisString[] =
"Open connection to OpenHMD controlled VR HMD, return a 'openhmdPtr' handle to it.\n\n"
"The call tries to open the HMD with index 'deviceIndex', or the "
"first detected HMD, if 'deviceIndex' is omitted. You can pass in a 'deviceIndex' "
"of -1 to open an emulated HMD. It doesn't provide any sensor input, but allows "
"some basic testing and debugging of VR software nonetheless.\n"
"The returned handle can be passed to the other subfunctions to operate the device.\n"
"A second return argument 'modelName' returns the model name string of the OpenHMD device.\n"
"'panelSizeX' is the horizontal panel resolution in pixels.\n"
"'panelSizeY' is the vertical panel resolution in pixels.\n";
static char seeAlsoString[] = "GetCount Close";
PsychOpenHMDDevice* openhmd;
int trycount;
int deviceIndex = 0;
int handle = 0;
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if (PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
// Check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(4));
PsychErrorExit(PsychCapNumInputArgs(1));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(FALSE);
// Find a free device slot:
for (handle = 0; (handle < MAX_PSYCH_OPENHMD_DEVS) && openhmddevices[handle].hmd; handle++);
if ((handle >= MAX_PSYCH_OPENHMD_DEVS) || openhmddevices[handle].hmd) PsychErrorExitMsg(PsychError_internal, "Maximum number of simultaneously open OpenHMD VR devices reached.");
// Get optional OpenHMD device index:
PsychCopyInIntegerArg(1, kPsychArgOptional, &deviceIndex);
if (deviceIndex < -1) PsychErrorExitMsg(PsychError_user, "Invalid 'deviceIndex' provided. Must be greater or equal to zero!");
if (available_devices < 0) {
available_devices = 0;
if (verbosity >= 2) printf("PsychOpenHMDVRCore-WARNING: Could not find any OpenHMD supported devices.\n");
}
if ((deviceIndex >= 0) && (deviceIndex >= available_devices)) {
if (verbosity >= 0) printf("PsychOpenHMDVRCore-ERROR: Invalid deviceIndex %i >= number of available HMDs %i.\n", deviceIndex, available_devices);
PsychErrorExitMsg(PsychError_user, "Invalid 'deviceIndex' provided. Not enough HMDs available!");
}
// Zero init device structure:
memset(&openhmddevices[handle], 0, sizeof(PsychOpenHMDDevice));
openhmd = &openhmddevices[handle];
// Try to open real or emulated HMD with deviceIndex:
if (deviceIndex >= 0) {
// The real thing: Try open 5 times, in case we collide with the openhmdkeepalive
// daemon having the device opened for its keep-alive cycle at just this time:
for (trycount = 0; trycount < 5; trycount++) {
openhmddevices[handle].hmd = ohmd_list_open_device(ctx, deviceIndex);
// Worked?
if (openhmddevices[handle].hmd)
break;
// Nope. Wait a few milliseconds before retry, so the keeep alive daemon
// can release the HMD if that is what keeps it from opening up to us:
PsychWaitIntervalSeconds(0.5);
}
if (NULL == openhmddevices[handle].hmd) {
if (verbosity >= 0) {
printf("PsychOpenHMDVRCore-ERROR: Failed to connect to OpenHMD device with deviceIndex %i. This could mean that the device\n", deviceIndex);
printf("PsychOpenHMDVRCore-ERROR: is already in use by another application or driver.\n");
}
PsychErrorExitMsg(PsychError_user, "Could not connect to OpenHMD device with given 'deviceIndex'! [ohmd_list_open_device() failed]");
}
else if (verbosity >= 3) {
printf("PsychOpenHMDVRCore-INFO: Opened OpenHMD device with deviceIndex %i as handle %i.\n", deviceIndex, handle + 1);
}
}
else {
// Emulated:
for (deviceIndex = 0; (deviceIndex < available_devices) && strcmp(ohmd_list_gets(ctx, deviceIndex, OHMD_PRODUCT), "Dummy Device"); deviceIndex++);
if (deviceIndex == available_devices)
PsychErrorExitMsg(PsychError_user, "Could not find OpenHMD dummy device!");
openhmddevices[handle].hmd = ohmd_list_open_device(ctx, deviceIndex);
if (verbosity >= 3) printf("PsychOpenHMDVRCore-INFO: Opened an emulated OpenHMD HMD as handle %i.\n", handle + 1);
}
// Get panel size in pixels:
ohmd_device_geti(openhmd->hmd, OHMD_SCREEN_HORIZONTAL_RESOLUTION, &openhmd->panelSize[0]);
ohmd_device_geti(openhmd->hmd, OHMD_SCREEN_VERTICAL_RESOLUTION, &openhmd->panelSize[1]);
// Stats for nerds:
if (verbosity >= 3) {
printf("PsychOpenHMDVRCore-INFO: Product: %s - Manufacturer: %s - Path: %s\n",
ohmd_list_gets(ctx, deviceIndex, OHMD_PRODUCT), ohmd_list_gets(ctx, deviceIndex, OHMD_VENDOR), ohmd_list_gets(ctx, deviceIndex, OHMD_PATH));
printf("PsychOpenHMDVRCore-INFO: Panel size in pixels w x h = %i x %i\n", openhmd->panelSize[0], openhmd->panelSize[1]);
printf("PsychOpenHMDVRCore-INFO: ----------------------------------------------------------------------------------\n");
}
// Increment count of open devices:
devicecount++;
// Return device handle: We use 1-based handle indexing to make life easier for Octave/Matlab:
PsychCopyOutDoubleArg(1, kPsychArgOptional, handle + 1);
// Return product name:
PsychCopyOutCharArg(2, kPsychArgOptional, (const char*) ohmd_list_gets(ctx, deviceIndex, OHMD_PRODUCT));
// Display size h x v:
PsychCopyOutDoubleArg(3, kPsychArgOptional, openhmd->panelSize[0]);
PsychCopyOutDoubleArg(4, kPsychArgOptional, openhmd->panelSize[1]);
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRClose(void)
{
static char useString[] = "PsychOpenHMDVRCore('Close' [, openhmdPtr]);";
// 1
static char synopsisString[] =
"Close connection to OpenHMD device 'openhmdPtr'. Do nothing if no such device is open.\n"
"If the optional 'openhmdPtr' is omitted, then close all open devices and shutdown the driver, "
"ie. perform the same cleanup as if 'clear PsychOpenHMDVRCore' would be executed.\n";
static char seeAlsoString[] = "Open";
int handle = -1;
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if(PsychIsGiveHelp()){PsychGiveHelp();return(PsychError_none);};
//check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(0));
PsychErrorExit(PsychCapNumInputArgs(1));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(FALSE);
// Get optional device handle:
PsychCopyInIntegerArg(1, kPsychArgOptional, &handle);
if (handle >= 1) {
// Close device:
PsychOpenHMDClose(handle);
}
else {
// No handle provided: Close all devices, shutdown driver.
PsychOpenHMDVRShutDown();
}
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRSetDynamicPrediction(void)
{
static char useString[] = "oldDynamicPrediction = PsychOpenHMDVRCore('SetDynamicPrediction', openhmdPtr [, dynamicPrediction]);";
// 1 2
static char synopsisString[] =
"Enable or disable dynamic prediction mode on OpenHMD device 'openhmdPtr'.\n"
"DOES NOTHING AT THE MOMENT!\n"
"'dynamicPrediction' 1 = Enable dynamic prediction, 0 = Disable dynamic prediction.\n"
"Returns previous 'dynamic prediction ' setting.\n";
static char seeAlsoString[] = "";
int handle, dynamicPrediction;
PsychOpenHMDDevice *openhmd;
unsigned int oldCaps;
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if (PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
// Check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(1));
PsychErrorExit(PsychCapNumInputArgs(2));
PsychErrorExit(PsychRequireNumInputArgs(1));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(FALSE);
// Get device handle:
PsychCopyInIntegerArg(1, kPsychArgRequired, &handle);
openhmd = PsychGetOpenHMD(handle, FALSE);
// Query current enabled caps:
oldCaps = 0;
PsychCopyOutDoubleArg(1, kPsychArgOptional, (double) oldCaps);
// Set new enabled HMD caps:
if (PsychCopyInIntegerArg(2, kPsychArgOptional, &dynamicPrediction)) {
// Does nothing so far.
}
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRSetLowPersistence(void)
{
static char useString[] = "oldPersistence = PsychOpenHMDVRCore('SetLowPersistence', openhmdPtr [, lowPersistence]);";
// 1 2
static char synopsisString[] =
"Enable or disable low persistence mode on display panel of OpenHMD device 'openhmdPtr'.\n"
"DOES NOTHING AT THE MOMENT!\n"
"'lowPersistence' 1 = Enable low persistence, 0 = Disable low persistence.\n"
"In low persistence mode, the pixels will only light up for a fraction of a video "
"refresh duration, thereby reducing motion blur due to smooth pursuit eye movements "
"or other shuttering effects. Brightness of the display will be reduced though, and "
"flicker sensitive people may perceive more flicker.\n"
"Returns previous 'oldPersistence' setting.\n";
static char seeAlsoString[] = "";
int handle, lowPersistence;
PsychOpenHMDDevice *openhmd;
unsigned int oldCaps;
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if (PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
// Check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(1));
PsychErrorExit(PsychCapNumInputArgs(2));
PsychErrorExit(PsychRequireNumInputArgs(1));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(FALSE);
// Get device handle:
PsychCopyInIntegerArg(1, kPsychArgRequired, &handle);
openhmd = PsychGetOpenHMD(handle, FALSE);
// Query current enabled caps:
oldCaps = 0;
PsychCopyOutDoubleArg(1, kPsychArgOptional, (double) oldCaps);
// Set new enabled HMD caps:
if (PsychCopyInIntegerArg(2, kPsychArgOptional, &lowPersistence)) {
// Does nothing so far.
}
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRStart(void)
{
static char useString[] = "PsychOpenHMDVRCore('Start', openhmdPtr);";
// 1
static char synopsisString[] =
"Start head orientation and position tracking operation on OpenHMD device 'openhmdPtr'.\n\n";
static char seeAlsoString[] = "Stop";
int handle;
PsychOpenHMDDevice *openhmd;
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if (PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
// Check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(0));
PsychErrorExit(PsychCapNumInputArgs(1));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(FALSE);
// Get device handle:
PsychCopyInIntegerArg(1, kPsychArgRequired, &handle);
openhmd = PsychGetOpenHMD(handle, FALSE);
if (openhmd->isTracking) {
if (verbosity >= 0) printf("PsychOpenHMDVRCore-ERROR: Tried to start tracking on device %i, but tracking is already started.\n", handle);
PsychErrorExitMsg(PsychError_user, "Tried to start tracking on HMD, but tracking already active.");
}
if (verbosity >= 4) printf("PsychOpenHMDVRCore-INFO: Tracking started on device with handle %i.\n", handle);
openhmd->frameIndex = 0;
openhmd->isTracking = TRUE;
// Tracking is running.
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRStop(void)
{
static char useString[] = "PsychOpenHMDVRCore('Stop', openhmdPtr);";
static char synopsisString[] =
"Stop head tracking operation on OpenHMD device 'openhmdPtr'.\n\n";
static char seeAlsoString[] = "Start";
int handle;
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if (PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
// Check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(0));
PsychErrorExit(PsychCapNumInputArgs(1));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(FALSE);
PsychCopyInIntegerArg(1, kPsychArgRequired, &handle);
// Stop device:
PsychOpenHMDStop(handle);
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRGetTrackingState(void)
{
static char useString[] = "state = PsychOpenHMDVRCore('GetTrackingState', openhmdPtr [, predictionTime=0]);";
// 1 1 2
static char synopsisString[] =
"Return current state of head position and orientation tracking for OpenHMD device 'openhmdPtr'.\n"
"Head position and orientation is predicted for target time 'predictionTime' in seconds if provided, "
"based on the latest measurements from the tracking hardware. If 'predictionTime' is omitted or set "
"to zero, then no prediction is performed and the current state based on latest measurements is returned. "
"NOTE: predictionTime is not yet implemented and silently ignored.\n\n"
"'state' is a struct with fields reporting the following values:\n"
"'Time' = Time in seconds of predicted tracking state.\n"
"'Status' = Tracking status flags. +1 = Head orientation tracked, +2 = Head position tracked, +4 = Camera pose tracked "
"+32 = Position tracking hardware connected, +128 = HMD display is connected and available.\n"
"'HeadPose' = Head position [x, y, z] in meters and rotation as quaternion [rx, ry, rz, rw], all as a vector [x,y,z,rx,ry,rz,rw].\n"
// "'HeadLinearSpeed' = Linear velocity [vx,vy,vz] in meters/sec.\n"
// "'HeadAngularSpeed' = Angular velocity [rx,ry,rz] in radians/sec.\n"
// "'HeadLinearAcceleration' = Linear acceleration [ax,ay,az] in meters/sec^2.\n"
// "'HeadAngularAcceleration' = Angular acceleration [rax,ray,raz] in radians/sec^2.\n"
// "'CameraPose' as vector with position and orientation quaternion, like 'HeadPose'.\n"
// "'LeveledCameraPose' Like 'CameraPose' but aligned to the gravity vector of the world.\n"
// "'CameraFrustumHVFov' Horizontal and vertical field of view of the tracking camera in radians.\n"
// "'CameraFrustumNearFarZInMeters' Near and far limit of the camera view frustum in meters.\n"
// "'LastCameraFrameCounter' Last camera framecounter value of tracking camera.\n"
// "'RawSensorAcceleration' = Raw measured accelerometer reading in m/sec^2.\n"
// "'RawSensorGyroRate' = Raw gyrometer reading in rad/s.\n"
// "'RawMagnetometer' = Raw magnetic field in gauss.\n"
// "'SensorTemperature' = Sensor temperature in degrees Celsius.\n"
// "'IMUReadoutTime' = Readout time of the last IMU sample in seconds.\n"
"\n";
static char seeAlsoString[] = "Start Stop";
PsychGenericScriptType *status;
const char *FieldNames[] = {"Time", "Status", "HeadPose", "HeadLinearSpeed", "HeadAngularSpeed", "HeadLinearAcceleration", "HeadAngularAcceleration",
"CameraPose", "LeveledCameraPose", "LastCameraFrameCounter", "RawSensorAcceleration", "RawSensorGyroRate", "RawMagnetometer",
"SensorTemperature", "IMUReadoutTime", "CameraFrustumHVFov", "CameraFrustumNearFarZInMeters"};
const int FieldCount = 17;
PsychGenericScriptType *outMat;
double *v;
int handle, hmdstatus = 0;
double tNow, predictionTime = 0.0;
PsychOpenHMDDevice *openhmd;
float state[7];
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if (PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
//check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(1));
PsychErrorExit(PsychCapNumInputArgs(2));
PsychErrorExit(PsychRequireNumInputArgs(1));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(FALSE);
PsychCopyInIntegerArg(1, kPsychArgRequired, &handle);
openhmd = PsychGetOpenHMD(handle, FALSE);
PsychCopyInDoubleArg(2, kPsychArgOptional, &predictionTime);
// Trigger update of device driver-private state into queryable device state:
ohmd_ctx_update(ctx);
PsychGetAdjustedPrecisionTimerSeconds(&tNow);
// Get current tracked position and orientation measurements:
ohmd_device_getf(openhmd->hmd, OHMD_POSITION_VECTOR, &state[0]);
ohmd_device_getf(openhmd->hmd, OHMD_ROTATION_QUAT, &state[3]);
// Print out tracking status:
if (verbosity >= 4) {
printf("PsychOpenHMDVRCore-INFO: Tracking state predicted for device %i at time %f.\n", handle, tNow);
printf("PsychOpenHMDVRCore-INFO: HeadPose: Position [x,y,z] = [%f, %f, %f]\n", state[0], state[1], state[2]);
printf("PsychOpenHMDVRCore-INFO: HeadPose: Orientation [x,y,z,w] = [%f, %f, %f, %f]\n", state[3], state[4], state[5], state[6]);
}
PsychAllocOutStructArray(1, kPsychArgOptional, -1, FieldCount, FieldNames, &status);
PsychSetStructArrayDoubleElement("Time", 0, tNow, status);
// Hard-code status to + 128 for "HMD connected and online":
hmdstatus = 128;
// Set +1 "orientation tracked" if the Quaternion is not a (0,0,0,0) or (0,0,0,1) quaternion,
// which would hint to use of the dummy device:
if (!(state[3] == 0 && state[4] == 0 && state[5] == 0 && (state[6] == 0 || state[6] == 1)))
hmdstatus += 1;
PsychSetStructArrayDoubleElement("Status", 0, hmdstatus, status);
// Head pose:
v = NULL;
PsychAllocateNativeDoubleMat(1, 7, 1, &v, &outMat);
v[0] = state[0];
v[1] = state[1];
v[2] = state[2];
v[3] = state[3];
v[4] = state[4];
v[5] = state[5];
v[6] = state[6];
PsychSetStructArrayNativeElement("HeadPose", 0, outMat, status);
/*
// Linear velocity:
v = NULL;
PsychAllocateNativeDoubleMat(1, 3, 1, &v, &outMat);
v[0] = state.HeadPose.LinearVelocity.x;
v[1] = state.HeadPose.LinearVelocity.y;
v[2] = state.HeadPose.LinearVelocity.z;
PsychSetStructArrayNativeElement("HeadLinearSpeed", 0, outMat, status);
// Angular velocity:
v = NULL;
PsychAllocateNativeDoubleMat(1, 3, 1, &v, &outMat);
v[0] = state.HeadPose.AngularVelocity.x;
v[1] = state.HeadPose.AngularVelocity.y;
v[2] = state.HeadPose.AngularVelocity.z;
PsychSetStructArrayNativeElement("HeadAngularSpeed", 0, outMat, status);
// Linear acceleration:
v = NULL;
PsychAllocateNativeDoubleMat(1, 3, 1, &v, &outMat);
v[0] = state.HeadPose.LinearAcceleration.x;
v[1] = state.HeadPose.LinearAcceleration.y;
v[2] = state.HeadPose.LinearAcceleration.z;
PsychSetStructArrayNativeElement("HeadLinearAcceleration", 0, outMat, status);
// Angular acceleration:
v = NULL;
PsychAllocateNativeDoubleMat(1, 3, 1, &v, &outMat);
v[0] = state.HeadPose.AngularAcceleration.x;
v[1] = state.HeadPose.AngularAcceleration.y;
v[2] = state.HeadPose.AngularAcceleration.z;
PsychSetStructArrayNativeElement("HeadAngularAcceleration", 0, outMat, status);
// Camera pose:
v = NULL;
PsychAllocateNativeDoubleMat(1, 7, 1, &v, &outMat);
v[0] = state.CameraPose.Position.x;
v[1] = state.CameraPose.Position.y;
v[2] = state.CameraPose.Position.z;
v[3] = state.CameraPose.Orientation.x;
v[4] = state.CameraPose.Orientation.y;
v[5] = state.CameraPose.Orientation.z;
v[6] = state.CameraPose.Orientation.w;
PsychSetStructArrayNativeElement("CameraPose", 0, outMat, status);
// Camera leveled pose:
v = NULL;
PsychAllocateNativeDoubleMat(1, 7, 1, &v, &outMat);
v[0] = state.LeveledCameraPose.Position.x;
v[1] = state.LeveledCameraPose.Position.y;
v[2] = state.LeveledCameraPose.Position.z;
v[3] = state.LeveledCameraPose.Orientation.x;
v[4] = state.LeveledCameraPose.Orientation.y;
v[5] = state.LeveledCameraPose.Orientation.z;
v[6] = state.LeveledCameraPose.Orientation.w;
PsychSetStructArrayNativeElement("LeveledCameraPose", 0, outMat, status);
// LastCameraFrameCounter:
PsychSetStructArrayDoubleElement("LastCameraFrameCounter", 0, (double) state.LastCameraFrameCounter, status);
// RawSensorAcceleration:
v = NULL;
PsychAllocateNativeDoubleMat(1, 3, 1, &v, &outMat);
v[0] = state.RawSensorData.Accelerometer.x;
v[1] = state.RawSensorData.Accelerometer.y;
v[2] = state.RawSensorData.Accelerometer.z;
PsychSetStructArrayNativeElement("RawSensorAcceleration", 0, outMat, status);
// RawSensorGyroRate:
v = NULL;
PsychAllocateNativeDoubleMat(1, 3, 1, &v, &outMat);
v[0] = state.RawSensorData.Gyro.x;
v[1] = state.RawSensorData.Gyro.y;
v[2] = state.RawSensorData.Gyro.z;
PsychSetStructArrayNativeElement("RawSensorGyroRate", 0, outMat, status);
// RawMagnetometer:
v = NULL;
PsychAllocateNativeDoubleMat(1, 3, 1, &v, &outMat);
v[0] = state.RawSensorData.Magnetometer.x;
v[1] = state.RawSensorData.Magnetometer.y;
v[2] = state.RawSensorData.Magnetometer.z;
PsychSetStructArrayNativeElement("RawMagnetometer", 0, outMat, status);
// SensorTemperature:
PsychSetStructArrayDoubleElement("SensorTemperature", 0, (double) state.RawSensorData.Temperature, status);
// IMU readout time:
PsychSetStructArrayDoubleElement("IMUReadoutTime", 0, (double) state.RawSensorData.TimeInSeconds, status);
// Camera frustum HFov and VFov in radians:
v = NULL;
PsychAllocateNativeDoubleMat(1, 2, 1, &v, &outMat);
v[0] = openhmd->hmd->CameraFrustumHFovInRadians;
v[1] = openhmd->hmd->CameraFrustumVFovInRadians;
PsychSetStructArrayNativeElement("CameraFrustumHVFov", 0, outMat, status);
// Camera frustum near and far clip plane in meters:
v = NULL;
PsychAllocateNativeDoubleMat(1, 2, 1, &v, &outMat);
v[0] = openhmd->hmd->CameraFrustumNearZInMeters;
v[1] = openhmd->hmd->CameraFrustumFarZInMeters;
PsychSetStructArrayNativeElement("CameraFrustumNearFarZInMeters", 0, outMat, status);
*/
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRGetFovTextureSize(void)
{
static char useString[] = "[width, height, fovPort] = PsychOpenHMDVRCore('GetFovTextureSize', openhmdPtr, eye, metersPerTanAngleAtCenter [, fov=[HMDRecommended]]);";
// 1 2 3 1 2 3 4
static char synopsisString[] =
"Return recommended size of client renderbuffers for OpenHMD device 'openhmdPtr'.\n"
"'eye' which eye to provide the size for: 0 = Left, 1 = Right.\n"
"'metersPerTanAngleAtCenter' Meters per radians tan angle at the optical center of the display. "
"Multiply by a factor > 1 to improve quality at lower performance, < 1 to reduce quality at higher performance.\n"
"'fov' Optional field of view in degrees, from line of sight: [leftdeg, rightdeg, updeg, downdeg]. "
"If 'fov' is omitted, the OpenHMD runtime will be asked for a good default field of view and that "
"will be used.\n"
"Return values are 'width' for minimum recommended width of framebuffer in pixels and "
"'height' for minimum recommended height of framebuffer in pixels. 'fovPort' is the field of view "
"in degrees finally used for calculation of 'width' x 'height'.\n";
static char seeAlsoString[] = "GetUndistortionParameters";
int handle, eyeIndex;
int n, m, p;
PsychOpenHMDDevice *openhmd;
double *fov;
double metersPerTanAngleAtCenter;
double *outFov;
float factor;
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if (PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
//check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(3));
PsychErrorExit(PsychCapNumInputArgs(4));
PsychErrorExit(PsychRequireNumInputArgs(3));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(FALSE);
// Get device handle:
PsychCopyInIntegerArg(1, kPsychArgRequired, &handle);
openhmd = PsychGetOpenHMD(handle, FALSE);
// Get eye index - left = 0, right = 1:
PsychCopyInIntegerArg(2, kPsychArgRequired, &eyeIndex);
if (eyeIndex < 0 || eyeIndex > 1) PsychErrorExitMsg(PsychError_user, "Invalid 'eye' specified. Must be 0 or 1 for left- or right eye.");
// Get required 'metersPerTanAngleAtCenter' parameter:
PsychCopyInDoubleArg(3, kPsychArgRequired, &metersPerTanAngleAtCenter);
if (metersPerTanAngleAtCenter <= 0.0) PsychErrorExitMsg(PsychError_user, "Invalid 'metersPerTanAngleAtCenter' specified. Must be greater than zero.");
// Get optional field of view in degrees in left,right,up,down direction from line of sight:
if (PsychAllocInDoubleMatArg(4, kPsychArgOptional, &n, &m, &p, &fov)) {
// Validate and assign:
if (n * m * p != 4) PsychErrorExitMsg(PsychError_user, "Invalid 'fov' specified. Must be a 4-component vector of form [leftdeg, rightdeg, updeg, downdeg].");
openhmd->ofov[eyeIndex][0] = deg2rad(fov[0]);
openhmd->ofov[eyeIndex][1] = deg2rad(fov[1]);
openhmd->ofov[eyeIndex][2] = deg2rad(fov[2]);
openhmd->ofov[eyeIndex][3] = deg2rad(fov[3]);
}
else {
// None specified: Ask the runtime for good defaults.
float f, a;
ohmd_device_getf(openhmd->hmd, (eyeIndex == 0) ? OHMD_LEFT_EYE_FOV : OHMD_RIGHT_EYE_FOV, &f);
ohmd_device_getf(openhmd->hmd, (eyeIndex == 0) ? OHMD_LEFT_EYE_ASPECT_RATIO : OHMD_RIGHT_EYE_ASPECT_RATIO, &a);
openhmd->ofov[eyeIndex][0] = f * a / 2.0;
openhmd->ofov[eyeIndex][1] = f * a / 2.0;
openhmd->ofov[eyeIndex][2] = f / 2.0;
openhmd->ofov[eyeIndex][3] = f / 2.0;
}
// Ask the api for optimal texture size, aka the size of the client draw buffer:
// Original PsychOculusVRCore driver would have called ovrHmd_GetFovTextureSize(openhmd->hmd, (ovrEyeType) eyeIndex, openhmd->ofov[eyeIndex], (float) pixelsPerDisplay);
//
// This approximates that approach. However, as input value metersPerTanAngleAtCenter we need a caller provided value
// which is the distance (in meters) covered by 1 radians of visual angle at the center of the screen (meters per tan-angle at center)
// multiplied by a pixelsPerDisplay scaling factor for quality vs. performance tradeoff:
ohmd_device_getf(openhmd->hmd, OHMD_SCREEN_HORIZONTAL_SIZE, &factor);
factor = ((float) openhmd->panelSize[0]) / factor;
openhmd->texSize[eyeIndex][0] = (int) (0.5 + metersPerTanAngleAtCenter * (openhmd->ofov[eyeIndex][0] + openhmd->ofov[eyeIndex][1]) * factor);
ohmd_device_getf(openhmd->hmd, OHMD_SCREEN_VERTICAL_SIZE, &factor);
factor = ((float) openhmd->panelSize[1]) / factor;
openhmd->texSize[eyeIndex][1] = (int) (0.5 + metersPerTanAngleAtCenter * (openhmd->ofov[eyeIndex][2] + openhmd->ofov[eyeIndex][3]) * factor);
// Return recommended width and height of drawBuffer:
PsychCopyOutDoubleArg(1, kPsychArgOptional, openhmd->texSize[eyeIndex][0]);
PsychCopyOutDoubleArg(2, kPsychArgOptional, openhmd->texSize[eyeIndex][1]);
PsychAllocOutDoubleMatArg(3, kPsychArgOptional, 4, 1, 1, &outFov);
outFov[0] = rad2deg(openhmd->ofov[eyeIndex][0]);
outFov[1] = rad2deg(openhmd->ofov[eyeIndex][1]);
outFov[2] = rad2deg(openhmd->ofov[eyeIndex][2]);
outFov[3] = rad2deg(openhmd->ofov[eyeIndex][3]);
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRGetUndistortionParameters(void)
{
static char useString[] = "[width, height, hmdShiftx, hmdShifty, hmdShiftz, abberation, distortion, scrnHorSize, scrnVertSize] = PsychOpenHMDVRCore('GetUndistortionParameters', openhmdPtr, eye [, inputWidth][, inputHeight][, fov]);";
// 1 2 3 4 5 6 7 8 9 1 2 3 4 5
static char synopsisString[] =
"Return parameters needed for rendering and undistortion for OpenHMD device 'openhmdPtr'.\n"
"'eye' which eye to provide the data: 0 = Left, 1 = Right.\n"
"'inputWidth' = Width of the rendered input image buffer in pixels.\n"
"'inputHeight' = Height of the rendered input image buffer in pixels.\n"
"'fov' Optional field of view in degrees, from line of sight: [leftdeg, rightdeg, updeg, downdeg]. "
"You can pass in the 'fovPort' value returned from PsychOpenHMDVR('GetFovTextureSize'); "
"Defaults to whatever has been set for the given eye in the last call to PsychOpenHMDVR('GetFovTextureSize'); if omitted.\n"
"\n"
"Return values:\n"
"[width, height] = Width and height of client renderbuffers in pixels. Same as the provided 'inputWidth' and 'inputHeight'.\n"
"[hmdShiftx, hmdShifty, hmdShiftz] = HmdToEyeViewOffset 3D translation vector. Defines the location of the optical center of the eye "
"relative to the origin of the local head reference frame, ie. the tracked head position.\n"
"abberation = 3-component vector with optical lens color abberation correction coefficients.\n"
"distortion = 4-component vector with optical lens geometric distortion correction coefficients.\n"
"scrnHorSize = Horizontal screen size in meters.\n"
"scrnVertSize = Vertical screen size in meters.\n"
"\n";
static char seeAlsoString[] = "GetFovTextureSize";
int handle, eyeIndex;
PsychOpenHMDDevice *openhmd;
int n, m, p, i;
double *fov;
double *out;
float sep_h, sep_v, ssize;
float distortion_coeffs[4];
float aberr_scale[3];
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if (PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
//check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(9));
PsychErrorExit(PsychCapNumInputArgs(5));
PsychErrorExit(PsychRequireNumInputArgs(2));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(FALSE);
// Get device handle:
PsychCopyInIntegerArg(1, kPsychArgRequired, &handle);
openhmd = PsychGetOpenHMD(handle, FALSE);
// Get eye index - left = 0, right = 1:
PsychCopyInIntegerArg(2, kPsychArgRequired, &eyeIndex);
if (eyeIndex < 0 || eyeIndex > 1) PsychErrorExitMsg(PsychError_user, "Invalid 'eye' specified. Must be 0 or 1 for left- or right eye.");
// Get input texture width:
if (PsychCopyInIntegerArg(3, kPsychArgOptional, &(openhmd->texSize[eyeIndex][0]))) {
if (openhmd->texSize[eyeIndex][0] < 1) PsychErrorExitMsg(PsychError_user, "Invalid 'inputWidth' specified. Must be greater than zero.");
}
// Get input texture height:
if (PsychCopyInIntegerArg(4, kPsychArgOptional, &(openhmd->texSize[eyeIndex][1]))) {
if (openhmd->texSize[eyeIndex][1] < 1) PsychErrorExitMsg(PsychError_user, "Invalid 'inputHeight' specified. Must be greater than zero.");
}
// Get optional field of view in degrees in left,right,up,down direction from line of sight:
if (PsychAllocInDoubleMatArg(5, kPsychArgOptional, &n, &m, &p, &fov)) {
// Validate and assign:
if (n * m * p != 4) PsychErrorExitMsg(PsychError_user, "Invalid 'fov' specified. Must be a 4-component vector of form [leftdeg, rightdeg, updeg, downdeg].");
openhmd->ofov[eyeIndex][0] = deg2rad(fov[0]);
openhmd->ofov[eyeIndex][1] = deg2rad(fov[1]);
openhmd->ofov[eyeIndex][2] = deg2rad(fov[2]);
openhmd->ofov[eyeIndex][3] = deg2rad(fov[3]);
}
// Return width and height of input texture - Just mirror out what we got:
PsychCopyOutDoubleArg(1, kPsychArgOptional, openhmd->texSize[eyeIndex][0]);
PsychCopyOutDoubleArg(2, kPsychArgOptional, openhmd->texSize[eyeIndex][1]);
// HmdToEyeViewOffset: [x,y,z]:
ohmd_device_getf(openhmd->hmd, OHMD_LENS_HORIZONTAL_SEPARATION, &sep_h);
ohmd_device_getf(openhmd->hmd, OHMD_LENS_VERTICAL_POSITION, &sep_v);
PsychCopyOutDoubleArg(3, kPsychArgOptional, (double) ((eyeIndex == 0) ? -sep_h / 2 : +sep_h / 2));
PsychCopyOutDoubleArg(4, kPsychArgOptional, (double) sep_v);
PsychCopyOutDoubleArg(5, kPsychArgOptional, 0.0);
ohmd_device_getf(openhmd->hmd, OHMD_UNIVERSAL_ABERRATION_K, &(aberr_scale[0]));
PsychAllocOutDoubleMatArg(6, kPsychArgOptional, 1, 3, 1, &out);
out[0] = aberr_scale[0];
out[1] = aberr_scale[1];
out[2] = aberr_scale[2];
ohmd_device_getf(openhmd->hmd, OHMD_UNIVERSAL_DISTORTION_K, &(distortion_coeffs[0]));
PsychAllocOutDoubleMatArg(7, kPsychArgOptional, 1, 4, 1, &out);
out[0] = distortion_coeffs[0];
out[1] = distortion_coeffs[1];
out[2] = distortion_coeffs[2];
out[3] = distortion_coeffs[3];
ohmd_device_getf(openhmd->hmd, OHMD_SCREEN_HORIZONTAL_SIZE, &ssize);
PsychCopyOutDoubleArg(8, kPsychArgOptional, ssize);
ohmd_device_getf(openhmd->hmd, OHMD_SCREEN_VERTICAL_SIZE, &ssize);
PsychCopyOutDoubleArg(9, kPsychArgOptional, ssize);
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRGetCorrectionShaders(void)
{
static char useString[] = "[vertexShaderSrc, fragmentShaderSrc] = PsychOpenHMDVRCore('GetCorrectionShaders', openhmdPtr);";
// 1 2 1
static char synopsisString[] =
"Return source code for GLSL shaders for VR warp pass for OpenHMD device 'openhmdPtr'.\n"
"'vertexShaderSrc' The source code of the vertex shader to use.\n";
"'fragmentShaderSrc' The source code of the fragment shader to use.\n";
static char seeAlsoString[] = "";
int handle;
const char* vertex;
const char* fragment;
PsychOpenHMDDevice *openhmd;
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if (PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
//check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(2));
PsychErrorExit(PsychCapNumInputArgs(1));
PsychErrorExit(PsychRequireNumInputArgs(1));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(FALSE);
// Get device handle:
PsychCopyInIntegerArg(1, kPsychArgRequired, &handle);
openhmd = PsychGetOpenHMD(handle, FALSE);
ohmd_gets(OHMD_GLSL_DISTORTION_VERT_SRC, &vertex);
ohmd_gets(OHMD_GLSL_DISTORTION_FRAG_SRC, &fragment);
PsychCopyOutCharArg(1, kPsychArgOptional, vertex);
PsychCopyOutCharArg(2, kPsychArgOptional, fragment);
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRGetStaticRenderParameters(void)
{
static char useString[] = "[projL, projR, ipd] = PsychOpenHMDVRCore('GetStaticRenderParameters', openhmdPtr [, clipNear=0.01][, clipFar=10000.0]);";
// 1 2 3 1 2 3
static char synopsisString[] =
"Retrieve static rendering parameters for OpenHMD device 'openhmdPtr' at current settings.\n"
"'clipNear' Optional near clipping plane for OpenGL. Defaults to 0.01.\n"
"'clipFar' Optional far clipping plane for OpenGL. Defaults to 10000.0.\n"
"\nReturn arguments:\n\n"
"'projL' is the 4x4 OpenGL projection matrix for the left eye rendering.\n"
"'projR' is the 4x4 OpenGL projection matrix for the right eye rendering.\n"
"'ipd' is estimated inter-pupillar distance.\n"
"Please note that projL and projR are usually identical for typical rendering scenarios.\n";
static char seeAlsoString[] = "";
int handle;
PsychOpenHMDDevice *openhmd;
float M[4][4];
int i, j;
double clip_near, clip_far;
float f_clip_near, f_clip_far, ipd;
double *outM;
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if (PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
//check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(3));
PsychErrorExit(PsychCapNumInputArgs(3));
PsychErrorExit(PsychRequireNumInputArgs(1));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(FALSE);
// Get device handle:
PsychCopyInIntegerArg(1, kPsychArgRequired, &handle);
openhmd = PsychGetOpenHMD(handle, FALSE);
// Get optional near clipping plane:
clip_near = 0.01;
PsychCopyInDoubleArg(2, kPsychArgOptional, &clip_near);
f_clip_near = (float) clip_near;
ohmd_device_setf(openhmd->hmd, OHMD_PROJECTION_ZNEAR, &f_clip_near);
// Get optional far clipping plane:
clip_far = 10000.0;
PsychCopyInDoubleArg(3, kPsychArgOptional, &clip_far);
f_clip_far = (float) clip_far;
ohmd_device_setf(openhmd->hmd, OHMD_PROJECTION_ZFAR, &f_clip_far);
// Return left projection matrix as return argument 1:
ohmd_device_getf(openhmd->hmd, OHMD_LEFT_EYE_GL_PROJECTION_MATRIX, &M[0][0]);
PsychAllocOutDoubleMatArg(1, kPsychArgOptional, 4, 4, 1, &outM);
for (i = 0; i < 4; i++)
for (j = 0; j < 4; j++)
*(outM++) = (double) M[i][j];
// Return right projection matrix as return argument 2:
ohmd_device_getf(openhmd->hmd, OHMD_RIGHT_EYE_GL_PROJECTION_MATRIX, &M[0][0]);
PsychAllocOutDoubleMatArg(2, kPsychArgOptional, 4, 4, 1, &outM);
for (i = 0; i < 4; i++)
for (j = 0; j < 4; j++)
*(outM++) = (double) M[i][j];
// Inter-pupillar distance:
ohmd_device_getf(openhmd->hmd, OHMD_EYE_IPD, &ipd);
PsychCopyOutDoubleArg(3, kPsychArgOptional, ipd);
return(PsychError_none);
}
PsychError PSYCHOPENHMDVRGetEyePose(void)
{
static char useString[] = "[eyePose, eyeIndex, glModelviewMatrix] = PsychOpenHMDVRCore('GetEyePose', openhmdPtr, renderPass);";
// 1 2 3 1 2
static char synopsisString[] =
"Return current predicted pose vector for an eye for OpenHMD device 'openhmdPtr'.\n"
"NOTE: As of August 2017, this function does not provide optimized predicted pose and is here just "
"for backwards compatibility, as OpenHMD does not provide such per-eye tracking info.\n\n"
"'renderPass' is the view render pass for which to provide the data: 0 = First pass, 1 = Second pass.\n"
"Return value is the vector 'eyePose' which defines the position and orientation for the eye corresponding "
"to the requested renderPass ie. 'eyePose' = [posX, posY, posZ, rotX, rotY, rotZ, rotW].\n"
"The second return value is the 'eyeIndex', the index of the eye whose view should be rendered. This would "
"be 0 for left eye, and 1 for right eye, and could be used to select the target render view via, e.g.,\n"
"Screen('SelectStereoDrawBuffer', window, eyeIndex);\n"
"Which 'eyeIndex' corresponds to the first or second 'renderPass', ie., if the left eye should be rendered "
"first, or if the right eye should be rendered first, depends on the visual scanning order of the HMD "
"display panel - is it top to bottom, left to right, or right to left? This function provides that optimized "
"mapping. Using this function to query the parameters for render setup of an eye can provide a bit more "
"accuracy in rendering, at the expense of more complex usercode.\n"
"'glModelviewMatrix' OpenGL modelview matrix, as computed by OpenHMD from tracking data.\n";
static char seeAlsoString[] = "";
int handle, renderPass;
PsychOpenHMDDevice *openhmd;
float state[7];
float M[4][4];
int i, j;
double *outM;
// All sub functions should have these two lines
PsychPushHelp(useString, synopsisString,seeAlsoString);
if (PsychIsGiveHelp()) {PsychGiveHelp(); return(PsychError_none);};
// Check to see if the user supplied superfluous arguments
PsychErrorExit(PsychCapNumOutputArgs(3));
PsychErrorExit(PsychCapNumInputArgs(2));
PsychErrorExit(PsychRequireNumInputArgs(2));
// Make sure driver is initialized:
PsychOpenHMDVRCheckInit(FALSE);
// Get device handle:
PsychCopyInIntegerArg(1, kPsychArgRequired, &handle);
openhmd = PsychGetOpenHMD(handle, FALSE);
// Get renderPass:
PsychCopyInIntegerArg(2, kPsychArgRequired, &renderPass);
if (renderPass < 0 || renderPass > 1) PsychErrorExitMsg(PsychError_user, "Invalid 'renderPass' specified. Must be 0 or 1 for first or second pass.");
// Trigger update of device driver-private state into queryable device state:
ohmd_ctx_update(ctx);
// Get current tracked position and orientation measurements:
ohmd_device_getf(openhmd->hmd, OHMD_POSITION_VECTOR, &state[0]);
ohmd_device_getf(openhmd->hmd, OHMD_ROTATION_QUAT, &state[3]);
// Eye pose as raw data:
PsychAllocOutDoubleMatArg(1, kPsychArgOptional, 1, 7, 1, &outM);
outM[0] = state[0];
outM[1] = state[1];
outM[2] = state[2];
outM[3] = state[3];
outM[4] = state[4];
outM[5] = state[5];
outM[6] = state[6];
// Copy out preferred eye render order for info:
PsychCopyOutDoubleArg(2, kPsychArgOptional, (double) renderPass);
// Return modelview matrix as computed by OpenHMD:
ohmd_device_getf(openhmd->hmd, (renderPass == 0) ? OHMD_LEFT_EYE_GL_MODELVIEW_MATRIX : OHMD_RIGHT_EYE_GL_MODELVIEW_MATRIX, &M[0][0]);
PsychAllocOutDoubleMatArg(3, kPsychArgOptional, 4, 4, 1, &outM);
for (i = 0; i < 4; i++)
for (j = 0; j < 4; j++)
*(outM++) = (double) M[i][j];
return(PsychError_none);
}
|