Generate Iris Report

This application is to be used in conjunction with IRIS to generate a report that identifies video footage that could potentially cause photosensitive epileptic risks. The IRIS report states that it is not intended to guarantee, certify or otherwise validate visual content's compliance with legal, regulatory or other requirements, so the same applies with this report as well.

This project currently generates a report, similar to the one generated by PEAT to tell non-technical users where there are issues with the video they are testing in a nice tabular format. This report currently is rendered as a tagged PDF using openHTMLtoPDF so that it can be read by screen reader users.

How to install:

Currently, you should be comfortable with compiling and building code to use this tool. In future, we hope to include an install program so non-technical users will be able to install this without any programming knowledge.

1. Install Java from the Oracle Java Downloads page You must use Java 8 or higher. Note that we have also been able to run this application with openJDK.

2. Install Maven from the Apache Maven Download page. You must use Maven 3.9.9 or higher.

3. Install both IRIS and generate-iris-report in the same directory:

   git clone [email protected]:electronicarts/IRIS.git
   git clone [email protected]:PublicisSapient/generate-iris-report.git
   

   or use https urls:

   git clone https://github.com/electronicarts/IRIS.git
   git clone https://github.com/PublicisSapient/generate-iris-report.git
   

4. Go into the IRIS directory and install IRIS according to the instructions in the IRIS README.md file. If you are having difficulty building IRIS, please read our IRIS-gotchas.md file.

5. Go into the generate-iris-report directory and run mvn install. This will install and build the generate-iris-report Java code.

6. If you have done all of the above, you should be able to run the generate-iris-report application (see below):

Running a Report

If you are running Linux or Mac OSX, you should be

./generate-iris-report.sh _input-video_ _output-pdf_

You can run this command without any arguments. It will prompt you for the values it needs to run a report.

If you prefer a GUI, you can use:

./generate-iris-report-gui.sh

Acknowledgements

• Original development and architecture: Samantha Cattani
• Architecture, project management and further development: Zoltan Hawryluk.

This application was made with the kind support of the Publicis Sapient Accessibility Centre of Excellence.

IRIS was develeped by Electronic Arts and no endorsement or cooperation with them is claimed or implied.

License

This application is released under the MIT Licence.