refactor defaults

Author: Remi-Gau

src/defaults/checkDefaultsPTB.m renamed to src/defaults/checkCppPtbCfg.m

@@ -1,4 +1,4 @@
-function cfg = checkDefaultsPTB(cfg)
+function cfg = checkCppPtbCfg(cfg)
     % Set some defaults values if none have been set before.
     %
     % USAGE::
@@ -19,35 +19,10 @@
     fieldsToSet = cppPtbDefaults('all');
 
     if isfield(cfg, 'audio') && cfg.audio.do
-
-        fieldsToSet.audio.devIdx = [];
-        fieldsToSet.audio.playbackMode = 1;
-
-        fieldsToSet.audio.fs = 44100;
-        fieldsToSet.audio.channels = 2;
-        fieldsToSet.audio.initVolume = 1;
-        fieldsToSet.audio.requestedLatency = 3;
-
-        % playing parameters
-        % sound repetition
-        fieldsToSet.audio.repeat = 1;
-
-        % Start immediately (0 = immediately)
-        fieldsToSet.audio.startCue = 0;
-
-        % Should we wait for the device to really start?
-        fieldsToSet.audio.waitForDevice = 1;
-
-        fieldsToSet.audio.pushSize  = fieldsToSet.audio.fs * 0.010; % ! push N ms only
-
-        fieldsToSet.audio.requestOffsetTime = 1; % offset 1 sec
-        fieldsToSet.audio.reqsSampleOffset = fieldsToSet.audio.requestOffsetTime * ...
-                                             fieldsToSet.audio.fs;
-
+      fieldsToSet.audio = cppPtbDefaults('audio');
     end
 
     if isfield(cfg, 'eyeTracker') && cfg.eyeTracker.do
-        % Calibration environment
         fieldsToSet.eyeTracker = cppPtbDefaults('eyeTracker');
     end
 
@@ -69,7 +44,7 @@
     elseif cfg.skipSyncTests == true
         cfg.skipSyncTests = 1;
     end
-    
+
     if ~ismember(cfg.fixation.type, {'cross', 'dot', 'bestFixation'})
       error('cfg.fixation.type must be one of ''cross'', ''dot'', ''bestFixation''');
     end

src/defaults/cppPtbDefaults.m

@@ -5,53 +5,75 @@
   %   value = cppPtbDefaults(type)
   %
   % (C) Copyright 2022 CPP_PTB developers
-  
+
   value = [];
-  
+
   switch lower(type)
-    
+
     case 'all'
       value =  struct('testingDevice', 'pc', ...
         'color',  struct('background', [0 0 0]), ...
         'skipSyncTests', 0);
-      
+
       value.aperture.type = 'none';
-      
+
       value.debug = cppPtbDefaults('debug');
       value.text = cppPtbDefaults('text');
       value.screen = cppPtbDefaults('screen');
       value.fixation = cppPtbDefaults('fixation');
       value.keyboard = cppPtbDefaults('keyboard');
-      
+
     case 'debug'
       value.do = true;
       value.transpWin = true;
       value.smallWin = true;
-      
+
     case 'keyboard'
       value.keyboard = [];
       value.responseBox = [];
       value.responseKey = {};
       value.escapeKey = 'ESCAPE';
-      
+
     case 'text'
       value.font = 'Courier New';
       value.size = 18;
       value.style = 1;
-      
+
     case 'fixation'
       value.type = 'cross';
       value.xDisplacement = 0;
       value.yDisplacement = 0;
       value.color = [255 255 255];
       value.width = 1;
       value.lineWidthPix = 5;
-      
+
     case 'screen'
       value.monitorWidth = 42;
       value.monitorDistance = 134;
       value.resolution = {[], [], []};
-      
+
+    case 'audio'
+      value.devIdx = [];
+      value.playbackMode = 1;
+
+      value.fs = 44100;
+      value.channels = 2;
+      value.initVolume = 1;
+      value.requestedLatency = 3;
+
+      value.repeat = 1;
+
+      % Start immediately (0 = immediately)
+      value.startCue = 0;
+
+      % Should we wait for the device to really start?
+      value.waitForDevice = 1;
+
+      value.pushSize  =value.fs * 0.010; % ! push N ms only
+
+      value.requestOffsetTime = 1; % offset 1 sec
+      value.reqsSampleOffset = value.requestOffsetTime * value.fs;
+
     case 'eyetracker'
       value.defaultCalibration = true;
       value.backgroundColor = [192 192 192];
@@ -60,7 +82,7 @@
       value.calibrationTargetSize = 1;
       value.calibrationTargetWidth = 0.5;
       value.displayCalResults = 1;
-      
+
   end
-  
-end
+
+end

src/initPTB.m

@@ -42,7 +42,7 @@
     % check for OpenGL compatibility, abort otherwise:
     AssertOpenGL;
 
-    cfg = setDefaultsPTB(cfg);
+    cfg = checkCppPtbCfg(cfg);
 
     Screen('Preference', 'SkipSyncTests', cfg.skipSyncTests);
 

tests/test_setDefaultsPTB.m renamed to tests/test_checkCppPtbCfg.m

@@ -1,4 +1,4 @@
-function test_suite = test_setDefaultsPTB %#ok<*STOUT>
+function test_suite = test_checkCppPtbCfg %#ok<*STOUT>
     %
     % (C) Copyright 2020 CPP_PTB developers
     try % assignment of 'localfunctions' is necessary in Matlab >= 2016
@@ -8,10 +8,10 @@
     initTestSuite;
 end
 
-function test_setDefaultsPtb_basic()
+function test_checkCppPtbCfg_basic()
 
     % set up
-    cfg = checkDefaultsPTB();
+    cfg = checkCppPtbCfg();
 
     % test data
     expectedCfg = cppPtbDefaults('all');
@@ -26,7 +26,7 @@ function test_setDefaultsPtb_basic()
 function test_setDefaultsPtb_no_debug()
 
     % set up
-    cfg = checkDefaultsPTB();
+    cfg = checkCppPtbCfg();
 
     % test data
     expectedCfg = cppPtbDefaults('all');
@@ -42,7 +42,7 @@ function test_setDefaultsPtb_overwrite()
 
     % set up
     cfg.screen.monitorWidth = 36;
-    cfg = checkDefaultsPTB(cfg);
+    cfg = checkCppPtbCfg(cfg);
 
     % test data
     expectedCfg = cppPtbDefaults('all');
@@ -59,7 +59,7 @@ function test_setDefaultsPtb_audio()
 
     % set up
     cfg.audio.do = 1;
-    cfg = checkDefaultsPTB(cfg);
+    cfg = checkCppPtbCfg(cfg);
 
     % test data
     expectedCfg = cppPtbDefaults('all');
@@ -92,7 +92,7 @@ function test_setDefaultsPtb_mri()
 
     % set up
     cfg.testingDevice = 'mri';
-    cfg = checkDefaultsPTB(cfg);
+    cfg = checkCppPtbCfg(cfg);
 
     % test data
     expectedCfg = cppPtbDefaults('all');

tests/test_setDefaults.m renamed to tests/test_setDefaultFields.m

@@ -1,4 +1,4 @@
-function test_suite = test_setDefaults %#ok<*STOUT>
+function test_suite = test_setDefaultFields %#ok<*STOUT>
     %
     % (C) Copyright 2020 CPP_PTB developers
     try % assignment of 'localfunctions' is necessary in Matlab >= 2016
@@ -15,7 +15,7 @@ function test_setDefaultsWrite()
 
     fieldsToSet.field = 1;
 
-    structure = setDefaults(structure, fieldsToSet);
+    structure = setDefaultFields(structure, fieldsToSet);
 
     %% data to test against
     expectedStructure.field = 1;
@@ -33,7 +33,7 @@ function test_setDefaultsNoOverwrite()
     fieldsToSet.field.subfield_1 = 1;
     fieldsToSet.field.subfield_2 = 1;
 
-    structure = setDefaults(structure, fieldsToSet);
+    structure = setDefaultFields(structure, fieldsToSet);
 
     % data to test against
     expectedStructure.field.subfield_1 = 3;