Merge pull request #63 from lab-neuro-comp/Deploy_Config

Deploy config

Author: gabrielalbino

CONTRIBUTING.md

@@ -0,0 +1,68 @@
+
+# How to contribute
+
+This project is development as result of a university program for Neuroscience and Behaviour Laboratory in Biology Department of Universidade de Brasília (UnB),
+students are responsible for this code, but is built so that anyone willing to contribute can modify and help with development using github. In this file, that are some instructions and suggestions upon how to make your contribution, please read it before sending your changes.
+ 
+
+# Prerequisites
+
+* Microsoft Visual Studio 2015+
+* [ResXManager](https://marketplace.visualstudio.com/items?itemName=TomEnglert.ResXManager) extension for VS
+
+
+
+# Getting Started
+
+To have access to our project you just have to clone this repository and open the .sln file (Microsoft Visual Studio Solution).
+
+# Globalization
+
+This program is currently available on:
+* English
+* Portuguese
+
+Releases are made with separate versions of each language.
+There are texts needing translation to spanish [here](https://drive.google.com/open?id=174o9u04dX0g0KubeW1F5CiOCXC9EoPJ1hs0i8ae4fMU) so that it can also be available in spanish.
+
+Localization is made by the use of resx files, managed on [ResXManager](https://marketplace.visualstudio.com/items?itemName=TomEnglert.ResXManager) a VS extension. 
+Winform forms and usercontrols can be localizated only when their property "Localizable" is set true. Which of these files have a .resx for available languages that is used for static elements.
+
+For dynamic elements, such as error messages displayed during run time, that are global resources located in:
+
+![Localization Resources](https://raw.githubusercontent.com/wiki/lab-neuro-comp/Test-Platform/images/localization_resources.png)
+
+To use resources in global files 
+
+
+```
+// properties used to localize strings during runtime
+private ResourceManager LocRM = new ResourceManager("TestPlatform.Resources.Localizations.LocalizedResources", typeof(FormMain).Assembly);
+private CultureInfo currentCulture = CultureInfo.CurrentUICulture;
+
+// getting string "reactionTest" from resources in current culture
+LocRM.GetString("reactionTest", currentCulture)
+```
+
+
+# Data structure
+
+There is no database in this application, instead files are used. Below there is an image of the directory tree created for the program.
+
+![Data structure](https://raw.githubusercontent.com/wiki/lab-neuro-comp/Test-Platform/images/data_structure.png)
+
+
+# Testing
+
+Unit tests are kept in their own project inside solution. Until now, that are only tests for model classes.
+
+![Tests project](https://raw.githubusercontent.com/wiki/lab-neuro-comp/Test-Platform/images/test_project.png)
+
+You can run tests using visual studio default configurations.
+
+![Running tests](https://raw.githubusercontent.com/wiki/lab-neuro-comp/Test-Platform/images/run_tests.png)
+
+# Submitting changes
+
+Please send a [GitHub Pull Request to TestPlatform](https://github.com/lab-neuro-comp/Test-Platform/pull/new/master) stating what you've done. 
+The Pull Request will only be accepted if the contribution works in all cultures (en-US and pt-BR).

README.md

@@ -1,33 +1,46 @@
-# TestPlatform
+
+# TestPlatform
 [![Build status](https://ci.appveyor.com/api/projects/status/ldpimyp67n2c14mh?svg=true)](https://ci.appveyor.com/project/fabiolamfleury/test-platform)
+![Available for Windows](https://img.shields.io/badge/Available%20for-Windows-blue.svg)
+![Open source](https://camo.githubusercontent.com/d9ce827af4ec2b7b3c52ce4595bbb354d8b21405/68747470733a2f2f6261646765732e66726170736f66742e636f6d2f6f732f76312f6f70656e2d736f757263652e7376673f763d313032)
 
-TestPlatform is a project developed inside University of Brasilia Behavioral and Neuroscience Laboratory. It continuous the work initialized by https://github.com/lab-neuro-comp/StroopTest, including now ReactionTest and Experiments, and soon it will include another set of cognitive tests. This is a desktop application built to be used on Windows systems.
+Create executive function tests for your research with plenty customization.
 
-## Getting Started
+TestPlatform is a platform used in scientific research in Neuroscience and Behaviour fields. project for various executive functions tests paradigms. It continuous the work initialized by [StroopTest](https://github.com/lab-neuro-comp/StroopTest), including now ReactionTest and Experiments, and soon it will include another set of cognitive tests. This is a desktop application built to be used on Windows systems.
 
-To contribute to our project you just have to clone this repository and open the .sln file (Microsoft Visual Studio Solution).
+## Key features
 
-### Prerequisites
+* Create customized Stroop Test 
+* Create customized Reaction Time Test
+* Create customized lists for your tests with images, words, colors and audios
+* Record audios
+* Record tests response from participant
+* Extensive results generated, that can be exported to .csv file
+* Create Experiment susing as many tests as needed of any paradigms in program
+
+### Examples of executing tests
+
+![Stroop Example Portuguese](https://raw.githubusercontent.com/wiki/lab-neuro-comp/Test-Platform/images/stroop_example_pt-BR.gif)
 
+![Stroop Example English](https://raw.githubusercontent.com/wiki/lab-neuro-comp/Test-Platform/images/stroop_example_en-US.gif)
 
+![Stroop Image Example](https://raw.githubusercontent.com/wiki/lab-neuro-comp/Test-Platform/images/stroop_example_image.gif)
 
-```
-Microsoft Visual Studio 2015+
-TestDriven extension for VS
-```
+## Download
 
+### Prerequisites
+
+* .NET Framework 4.5.2 or greater
 
-## Running the tests
+You can download latest installable version of TestPlatform for Windows [here](https://github.com/lab-neuro-comp/Test-Platform/releases/latest).
 
-Unit tests are kept in their own project inside solution.
-![Testes unitários](https://raw.githubusercontent.com/wiki/lab-neuro-comp/StroopTest/img/unittest.png)
+## How to use it
 
-You can run tests using visual studio default configurations.
-![Testes unitários](https://raw.githubusercontent.com/wiki/lab-neuro-comp/StroopTest/img/unittest2.png)
-Or you can rigth click on unit test project and select "Test with" and select NCover for coverage.
+After downloading the program you need to install it, just follow the installing wizard and a shortcut will be created in your Desktop area. And you are all set!
 
+![Installing Program](https://raw.githubusercontent.com/wiki/lab-neuro-comp/Test-Platform/images/installing_program.png)
 
-## Authors
+## Contributors
 
 * **Hugo Honda Ferreira** - *Initial work with StroopTest* - [StroopTest](https://github.com/lab-neuro-comp/StroopTest)
 
@@ -40,3 +53,6 @@ Or you can rigth click on unit test project and select "Test with" and select NC
 
 This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
 
+## Contributing
+
+Want to now more about the project and perhaps contribute to it? - check our [CONTRIBUTING.md](CONTRIBUTING.md) file for details

StroopTest/Models/Audio.cs

@@ -3,24 +3,45 @@
     using System.Runtime.InteropServices;
     using CSCore.Codecs.WAV;
     using CSCore.SoundIn;
+    using CSCore.CoreAudioAPI;
+    using System;
+    using System.Globalization;
+    using System.Windows.Forms;
+    using CSCore.Win32;
+    using CSCore;
+    using System.Collections.Generic;
+    using System.Resources;
 
     public class Audio
     {
         private WasapiCapture capture;
         private WaveWriter writer;
-        
+        private const CaptureMode CaptureMode = Models.CaptureMode.Capture;
+
+        private ResourceManager LocRM = new ResourceManager("TestPlatform.Resources.Localizations.LocalizedResources", typeof(FormMain).Assembly);
+        private CultureInfo currentCulture = CultureInfo.CurrentUICulture;
+
         public bool StartRecording(string path)
         {
-            this.capture = new WasapiCapture();
-            this.capture.Initialize();
-            this.writer = new WaveWriter(path, this.capture.WaveFormat);
-            this.capture.DataAvailable += (s, e) =>
+            if (isDeviceAvailable())
             {
+
+
+                this.capture = new WasapiCapture();
+                this.capture.Initialize();
+                this.writer = new WaveWriter(path, this.capture.WaveFormat);
+                this.capture.DataAvailable += (s, e) =>
+                {
                 // save the recorded audio
                 this.writer.Write(e.Data, e.Offset, e.ByteCount);
-            };
-            this.capture.Start();
-            return true;
+                };
+                this.capture.Start();
+                return true;
+            }
+            else
+            {
+                throw new Exception(LocRM.GetString("audioDeviceNotAvailable",currentCulture));
+            }
         }
 
         public bool PauseRecording()
@@ -49,7 +70,51 @@ public void PlayAudio(string file)
             MciSendString("play " + file, null, 0, 0);
         }
 
+        private bool isDeviceAvailable()
+        {
+            List<object> deviceList = new List<object>();
+            using (var deviceEnumerator = new MMDeviceEnumerator())
+            using (var deviceCollection = deviceEnumerator.EnumAudioEndpoints(
+                CaptureMode == CaptureMode.Capture ? DataFlow.Capture : DataFlow.Render, DeviceState.Active))
+            {
+                foreach (var device in deviceCollection)
+                {
+                    var deviceFormat = WaveFormatFromBlob(device.PropertyStore[
+                        new PropertyKey(new Guid(0xf19f064d, 0x82c, 0x4e27, 0xbc, 0x73, 0x68, 0x82, 0xa1, 0xbb, 0x8e, 0x4c), 0)].BlobValue);
+
+                    var item = new ListViewItem(device.FriendlyName) { Tag = device };
+                    item.SubItems.Add(deviceFormat.Channels.ToString(CultureInfo.InvariantCulture));
+
+                    deviceList.Add(item);
+                }
+            }
+            if (deviceList.Count > 0)
+            {
+                return true;
+            }
+            else
+            {
+                return false;
+            }
+        }
+
+        private static WaveFormat WaveFormatFromBlob(Blob blob)
+        {
+            if (blob.Length == 40)
+                return (WaveFormat)Marshal.PtrToStructure(blob.Data, typeof(WaveFormatExtensible));
+            return (WaveFormat)Marshal.PtrToStructure(blob.Data, typeof(WaveFormat));
+        }
+
+
+
         [DllImport("winmm.dll")]
         private static extern int MciSendString(string mciComando, string mciRetorno, int mciRetornoLeng, int callBack);
+
+    
+    }
+    public enum CaptureMode
+    {
+        Capture,
+        LoopbackCapture
     }
 }

StroopTest/Properties/AssemblyInfo.cs

@@ -1,4 +1,5 @@
-using System.Reflection;
+using System.Resources;
+using System.Reflection;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 
@@ -10,7 +11,7 @@
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("Laboratório de Neurociências e Comportamento")]
 [assembly: AssemblyProduct("TestPlatform")]
-[assembly: AssemblyCopyright("Copyright © Universidade de Brasília 2017")]
+[assembly: AssemblyCopyright("Copyright © Universidade de Brasília 2018")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 [assembly: InternalsVisibleTo("StroopUnitTestProject")]
@@ -32,5 +33,6 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.1.*")]
-[assembly: AssemblyFileVersion("1.1.0.0")]
+[assembly: AssemblyVersion("2.0")]
+[assembly: AssemblyFileVersion("2.0")]
+

StroopTest/README.txt

@@ -2208,8 +2208,11 @@ user to the stimulus or if there is no reaction to the stimulus(ms)</td>
   </data>
   <data name="training" xml:space="preserve">
     <value>Training</value>
-    </data>
+  </data>
   <data name="removeProgramFromExperiment" xml:space="preserve">
     <value>Wish to remove the program from the experiment?</value>
   </data>
+  <data name="audioDeviceNotAvailable" xml:space="preserve">
+    <value>There are no devices available to record audio.</value>
+  </data>
 </root>

StroopTest/Resources/Localizations/LocalizedResources.en-US.resx

@@ -2203,4 +2203,7 @@ Mais informações: https://github.com/lab-neuro-comp/Test-Platform</value>
   <data name="removeProgramFromExperiment" xml:space="preserve">
     <value>Deseja remover o programa do experimento?</value>
   </data>
+  <data name="audioDeviceNotAvailable" xml:space="preserve">
+    <value>Não existe nenhum dispositivo disponível para gravação de aúdio.</value>
+  </data>
 </root>