refactor ptbSoundDeviceTest and add cpp_ptb init and uninit function

Author: Remi-Gau

cpp_ptb.m

@@ -0,0 +1,174 @@
+function cpp_ptb(varargin)
+    %
+    % General intro function for CPP SPM
+    %
+    % USAGE::
+    %
+    %   cpp_ptb
+    %   cpp_ptb('init')
+    %   cpp_ptb('uninit')
+    %   cpp_ptb('dev')
+    %
+    % :param action:
+    % :type action: string
+    %
+    % :returns: - :action: (type) (dimension)
+    %
+    % Example::
+    %
+    % (C) Copyright 2022 CPP_PTB developers
+
+    p = inputParser;
+
+    defaultAction = 'init';
+
+    addOptional(p, 'action', defaultAction, @ischar);
+
+    parse(p, varargin{:});
+
+    action = p.Results.action;
+
+    switch lower(action)
+
+        case 'init'
+
+            initCppPtb();
+
+        case 'uninit'
+
+            uninitCppPtb();
+
+        case 'run_tests'
+
+            runTests();
+
+    end
+
+end
+
+function initCppPtb()
+    %
+    % Adds the relevant folders to the path for a given session.
+    % Has to be run to be able to use CPP_PTB.
+    %
+    % USAGE::
+    %
+    %   initCppPtb()
+    %
+    % (C) Copyright 2021 CPP_PTB developers
+
+    thisDirectory = fileparts(mfilename('fullpath'));
+
+    global CPP_PTB_INITIALIZED
+    global CPP_PTB_PATHS
+
+    if isempty(CPP_PTB_INITIALIZED)
+
+        pathSep = ':';
+        if ~isunix
+            pathSep = ';';
+        end
+
+        CPP_PTB_PATHS = fullfile(thisDirectory);
+        CPP_PTB_PATHS = cat(2, CPP_PTB_PATHS, ...
+                            pathSep, ...
+                            genpath(fullfile(thisDirectory, 'src')));
+        CPP_PTB_PATHS = cat(2, CPP_PTB_PATHS, pathSep, ...
+                            genpath(fullfile(thisDirectory, 'lib')));
+
+        addpath(CPP_PTB_PATHS, '-begin');
+
+        checkPtbVersion();
+
+        CPP_PTB_INITIALIZED = true();
+
+        detectCppPtb();
+
+    else
+        fprintf('\n\nCPP_PTB already initialized\n\n');
+
+    end
+
+end
+
+function detectCppPtb()
+
+    workflowsDir = cellstr(which('initPTB.m', '-ALL'));
+
+    if isempty(workflowsDir)
+        error('CPP_PTB is not in your MATLAB / Octave path.\n');
+
+    elseif numel(workflowsDir) > 1
+        fprintf('CPP_PTB seems to appear in several different folders:\n');
+        for i = 1:numel(workflowsDir)
+            fprintf('  * %s\n', fullfile(workflowsDir{i}, '..', '..'));
+        end
+        error('Remove all but one with ''pathtool''' .\ n'); % or ''spm_rmpath
+
+    end
+end
+
+function uninitCppPtb()
+    %
+    % Removes the added folders from the path for a given session.
+    %
+    % USAGE::
+    %
+    %   uninitCppPtb()
+    %
+    % (C) Copyright 2021 CPP_PTB developers
+
+    thisDirectory = fileparts(mfilename('fullpath'));
+
+    global CPP_PTB_INITIALIZED
+    global CPP_PTB_PATHS
+
+    if isempty(CPP_PTB_INITIALIZED) || ~CPP_PTB_INITIALIZED
+        fprintf('\n\nCPP_PTB not initialized\n\n');
+        return
+
+    else
+        rmpath(CPP_PTB_PATHS);
+
+        if IsOctave
+            clear -g;
+        else
+            clearvars -GLOBAL;
+        end
+
+    end
+
+end
+
+function runTests()
+    %
+    % (C) Copyright 2019 CPP_PTB developers
+
+    tic;
+
+    cpp_ptb();
+
+    cd(fileparts(mfilename('fullpath')));
+
+    fprintf(sprintf('\nHome is %s\n', getenv('HOME')));
+
+    warning('OFF');
+
+    folderToCover = fullfile(pwd, 'src');
+    testFolder = fullfile(pwd, 'tests');
+
+    success = moxunit_runtests(testFolder, ...
+                               '-verbose', '-recursive', '-with_coverage', ...
+                               '-cover', folderToCover, ...
+                               '-cover_xml_file', 'coverage.xml', ...
+                               '-cover_html_dir', fullfile(pwd, 'coverage_html'));
+
+    if success
+        system('echo 0 > test_report.log');
+    else
+        system('echo 1 > test_report.log');
+    end
+
+    toc;
+
+end

miss_hit.cfg

@@ -2,7 +2,7 @@
 project_root
 
 line_length: 100
-regex_function_name: "[a-z]+(([A-Z]){1}[A-Za-z]+)*"
+regex_function_name: "[a-z]+(_*[a-zA-Z0-9]+[a-z]*)*"
 regex_script_name: "[a-z]+(([A-Z]){1}[A-Za-z]+)*"
 regex_parameter_name: "[A-Z]{2,}|[a-z]+([A-Z]+[a-z]*)*"
 copyright_entity: "Sam Schwarzkopf"

runTests.m

@@ -0,0 +1,2 @@
+# camelCase
+regex_function_name: "[a-z]+([A-Z0-9]+[a-z]*)*"

src/miss_hit.cfg

@@ -0,0 +1,64 @@
+%
+% Small script to loop through all the devices
+% and try to play some white noise on it to see which one actually works.
+%
+% (C) Copyright 2022 CPP_PTB developers
+
+sca;
+clear;
+clc;
+
+% init CPP PTB
+rootDir = cd(fullfile(fileparts(mfilename('fullpath')), '..', '..'));
+cpp_ptb;
+
+% PsychPortAudio('Close');
+
+cfg.audio.playbackMode = 1;
+cfg.audio.channels = 2;
+cfg.audio.requestedLatency = 3;
+
+InitializePsychSound(1);
+
+% Get a list of all the audio devices connected
+audioDev = PsychPortAudio('GetDevices');
+
+% Here we can decide to test just a few (value must be between 1 and numel(audioDev))
+tmp = 10;
+
+% Here we loop through all the devices and try to play some white noise on it
+% to see which one actually works.
+for idx = 10
+
+    fprintf(1, '\n%i: %s\n', idx, audioDev(idx).DeviceName);
+
+    cfg.audio.devIdx = audioDev(idx).DeviceIndex;
+
+    % get device's sampling rate
+    cfg.audio.fs = audioDev(idx).DefaultSampleRate;
+
+    try
+        cfg.audio.pahandle = PsychPortAudio('Open', ...
+                                            cfg.audio.devIdx, ...
+                                            cfg.audio.playbackMode, ...
+                                            cfg.audio.requestedLatency, ...
+                                            cfg.audio.fs, ...
+                                            cfg.audio.channels);
+
+        clear sound;
+        sound = rand(cfg.audio.channels, cfg.audio.fs);
+
+        PsychPortAudio('FillBuffer', cfg.audio.pahandle, sound);
+        PsychPortAudio('Start', cfg.audio.pahandle);
+
+        WaitSecs(1.5);
+
+        PsychPortAudio('Close');
+
+        WaitSecs(1);
+    catch
+    end
+
+    pressSpaceForMe;
+
+end