-----ABOUT SignStream(R) is a software tool designed to facilitate the linguistic annotation of video language data. Copyright (c) 2017 Trustees of Boston University; distributed by the American Sign Language Linguistic Research Project (ASLLRP). SignStream(R) is licensed under the MIT license. See LICENSE.txt in this directory. SignStream(R) users must be aware that all external files distributed by the American Sign Language Liguistic Project (ASLLRP) (including Collection, video, and Sign Bank files) may have their own distinct end-user license agreements, which may put additional restrictions on SignStream's usage. External Libraries Used: --- Xuggler - Arthur Clarke http://www.xuggle.com/ --- Swingx - Sun Microsystems https://mvnrepository.com/artifact/org.swinglabs/swingx --- Logback - Ceki Gulcu https://logback.qos.ch/ --- SLF4J - Ceki Gulcu https://www.slf4j.org/ --- Commons CLI - Apache Software Foundation http://commons.apache.org/proper/commons-cli/ --- For more details, see LICENSES-3RD-PARTY, NOTICES and dep/ -----REQUIREMENTS SignStream(R) will only work on Mac OS X computers. It is known to work on OS X 10.8 (Mountain Lion) and above. For users of OS X 10.12 (Sierra) and above, you must follow the steps in the Install/Usage section below before opening the application. -----DEPENDENCIES In order to use SignStream(R), you must have Java 1.6 or later installed. If you do not have Java installed, you can find the latest version of Java at the following URL: https://www.java.com/en/download/ -----INSTALL/USAGE After installing Java, you will be able to run the application. To do so, open SignStream(R) by clicking the file of the same name (it is an application file). If any of the below messages display... 1) It says this is an application downloaded from the Internet. 2) It says the app is damaged and can't be opened and suggests moving to the trash. 3) It says you must install the legacy Java SE 6 runtime. ...Open a Finder window, and double-click on the SignStream folder (the folder you downloaded, which includes the application and related files). You will see a file called “DisableQuarantine.scpt”. Double-click on that. An editor will open, with a ‘play' (triangle) button in the toolbar - click this to run the script. Then close the editor and attempt to reopen SignStream, which should now work. -----UPGRADING When installing the latest version, deploy the package to a new directory distinct from your old one. Then copy the following files over from your old SignStream(R) directory to the new directory: signbank/localSignBank.xml newXMLfiles/localAnnotators.xml newXMLfiles/localParticipants.xml These directories contain information about your local annotators, participants, and sign banks. Copying them will ensure that you still have access to this data on the newest version of SignStream(R). When downloading a new copy of the globalSignBank.xml file (which comes from the online DAI), first make sure to stop SignStream3 before proceeding, then simply overwrite the new file in place of the file of the same name at here, or insert it for the first time: signbank/globalSignBank.xml Aside from these updates, please do not modify any of the files and folders that come with SignStream(R). -----FILES/SUBDIRECTORIES The following folders are included with SignStream(R). Please do not manipulate these folders or their contents as they will prevent SignStream(R) from running correctly. handShapes/ This directory stores images of the various hand shapes used to identify signs in SignStream(R). icons/ This directory contains several icons used by SignStream(R). newXMLfiles/ This directory stores data about participants, annotators, as well as important information about the structure of utterances, glosses, and non manual entries. signbank/ This directory stores the sign banks that contain a large number of different words used in American Sign Language. SignStreamDatabases/ This directory is where collections created by the user are saved to by default. As SignStream(R) is a OS X Application, it can be opened like a directory through the terminal or by right-clicking on it and clicking "Show Package Contents". Again, we highly recommend against manipulating the contents of these files and directories as it will prevent SignStream(R) from running correctly. -----KNOWN ISSUES 1) Attempting to save the collection while still on the Macro Unit window will result in an error. 2) Certain windows in the application open up but display behind other windows instead of on top. Annotator Selection windows, in particular. 3) Advancing video frames (using the right arrow key) at the end of the video causes frame cycles or frame skipping. 4) When the window is zoomed out to a certain perspective, the green slider may not advance all the way to the end of the video. 5) Color selection of nonmanual fields may not work as expected. 6) When creating a new nonmanual field, many of the options to edit field parameters do not work. 7) Macro Unit window will ask to save changes even when no changes were made. 8) Search window - a) Clicking on the listing of sentences in the search results does not always open the correct sentence. - b) “Return to Original State” in the Search window does not work properly. - c) Warning to users: Closing the window displaying an utterance from the search results will quit the program, with no option to open a new search result. 9) Closing the main SignStream window at any point will also quit the program. 10) The display for the proper time scale at the top of the Database View and Utterance windows is not currently correct. -----FEATURES TO BE IMPLEMENTED 1) Ability to create and have more than one Macro Unit per Collection. 2) Functionality for Display Time Period in the Database View Window. 3) Functionalities for editing field types and properties in the Field Specifications Editor. 4) Parameters other than hand shapes in the Morph-Phon Info window. 5) Ability to save searches. 6) Automatic selection of participant when the Collection contains only one. 7) Warning about existence of unsaved data when quitting the application.