-----ABOUT SignStream® is a software tool designed to facilitate the linguistic annotation of video language data. Copyright © 2017-2022 Trustees of Boston University; distributed by the American Sign Language Linguistic Research Project (ASLLRP). SignStream® is licensed under the MIT license. See LICENSE.txt in this directory. SignStream® users must be aware that all external files distributed by the American Sign Language Linguistic 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: --- Java AdoptOpenJDK https://adoptopenjdk.net/index.html --- GStreamer - Erik Walthinsen https://gstreamer.freedesktop.org/ --- GStreamer-Java gst1-java-core https://github.com/gstreamer-java/gst1-java-core --- JTransforms (FFT) https://github.com/wendykierp/JTransforms --- 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/ -----SYSTEM REQUIREMENTS Operating Systems: - macOS Monterey (12), Big Sur (11), Catalina (10.15), or Mojave (10.14), High Sierra (10.13), Sierra (10.12), or El Capitan (10.11). Hardware: - Mac computer with 64-bit Intel or ARM (Apple Silicon) processor - Note that SignStream® 3.0.4 has not yet been extensively tested with the new ARM hardware. There may be some differences in how the program works with this hardware. - 2 GB of RAM - 250 MB of hard drive space -----INSTALL/USAGE Before launching the SignStream application from the SignStream folder: 1) You will need to allow the launch of the SignStream® 3 application, despite the fact that it is not provided by Apple or certified developers (to get around security features that have been implemented in Mac Operating Systems since OS 10.8). 2) You will also be offered the opportunity to download the latest Sign Bank, which consists of a repertoire of signs, with gloss labels and annotations of other properties, as well as images and video illustration of those signs, to assist in the process of annotating new video files. This Global Sign Bank is not required for use of SignStream®. If you download the Sign Bank, you are agreeing to the terms of use below (which will also be downloaded to your SignStream folder). Open a Finder window, and double-click on the SignStream folder (the folder you downloaded, which includes the application and related files). Do the following, in the order listed: 1) [Required] You will see a file called “DisableQuarantine.command”. Double-click on that. You may get a message asking if you want to open the file even though it is from an unidentified developer. If so, say YES. If you get a message that the file cannot be opened because it is from an unidentified developer: a. Go into System Preferences > Security & Privacy > General b. Under the section "Allow apps downloaded from" click "Open Anyway" for this file. This will open in the Terminal application and run immediately, then close itself when finished. 2) [Optional] If you wish to download the ASLLRP Global Sign Bank, double-click on "GetSignBank.command". You will be asked whether you wish to download the Sign Bank and agree to abide by the terms of use. If you click ‘yes’, the download of the ASLLRP Sign Bank materials (and of the Sign Bank terms of use) will commence. Close the Terminal window. You will then be ready to launch SignStream® by double-clicking on the "SignStream3" file. Do not move this file out of its enclosing folder. The first time you click on the SignStream® application on ARM hardware, you will be asked to install Rosetta (which emulates the Intel instruction set), if it is not already installed. Click "Install" if asked. Once that is done, double-click again on the SignStream® application to launch it. -----UPGRADING Upgrading the ASLLRP Global Sign Bank file: When a new version of the Sign Bank becomes available, the next time you open up SignStream it will automatically begin the file update process for you. Be sure to follow the instructions and questions given. This will download the latest version of the Global Sign Bank (once you have reaffirmed that you agree to abide by the terms of use) and put it in the proper location within the folder from which the command had been launched. signbank/globalSignBank.xml Aside from these updates, please do not modify any of the files and folders that come with SignStream®. -----FILES/SUBDIRECTORIES The following folders are included with SignStream®. Please do not manipulate these folders or their contents as they will prevent SignStream® from running correctly. 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® is a macOS 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® from running correctly. -----VIDEO CODECS Video codecs and containers that work with the application; if your video is in a different format, you should first convert it to one of these: * MPEG-4 (.mp4, .mov) * H.264 (.mp4, .mov) * AVC1 (.mp4, .mov) -----KNOWN ISSUES 1) During a search, closing the window displaying an utterance from the search results will quit the program, with no option to open a new search result. 2) Closing the main SignStream window at any point will also quit the program. 3) Adding multiple segment tiers to the utterance view at once, or switching between temporal partitions from the dropdowns, could both cause minor display issues. 4) It is no longer possible to repeat the same search (as configured) across multiple collections. 5) When two segment tiers are displayed, changing the order of fields in one is not reflected in real time in the field ordering of the display of the other: https://github.com/DCS-LCSR/SignStream3/issues/513 6) In the utterance view, the up/down arrow keys may not correctly move to the previous/next utterance. To activate the arrow key functionality in the left-most utterance index area, click once within the utterance display on the right. 7) In the utterance view, double clicking on a nonmanual field label will temporarily trigger the up/down arrow keys to move the highlighted nonmanual field label instead of moving to the previous/next utterance. 8) In the utterarnce view, editing a nonmanual field value by double-clicking it to open the field value selection list and selecting a value will result in the utterance preview list incorrectly highlighting only the selected utterance (in blue) while not highlighting the visible utterances (in gray). 9) In the utterance view, when the green slider is near to the end of the video, some visual glitches may occur while the zoom level slider is being actively dragged. After the slider is released, the zoom level will be set correctly. 10) On MacOS 12 with ARM processors: When the user clicks into an utterance for the first time from the database view, the zoom level will pan out to display the entire length of the video. After that, the zoom level will pan out to display just the length of the selected utterance. 11) https://github.com/DCS-LCSR/SignStream3/issues/517 12) https://github.com/DCS-LCSR/SignStream3/issues/518 13) https://github.com/DCS-LCSR/SignStream3/issues/519 14) https://github.com/DCS-LCSR/SignStream3/issues/520 15) https://github.com/DCS-LCSR/SignStream3/issues/521 16) https://github.com/DCS-LCSR/SignStream3/issues/522 17) https://github.com/DCS-LCSR/SignStream3/issues/523 18) https://github.com/DCS-LCSR/SignStream3/issues/524 19) https://github.com/DCS-LCSR/SignStream3/issues/526 20) https://github.com/DCS-LCSR/SignStream3/issues/527 21) https://github.com/DCS-LCSR/SignStream3/issues/529 -----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) Ability to save searches. -----RELEASE NOTES FOR VERSION 3.4.0 * On opening an existing collection in this new version, an automatic validation and conversion process will occur. The validation will ensure that no errors exist and auto-modify any simple things which can be fixed. The conversion will take the existing collection and upgrade its format to the new database scheme of this new SignStream version. * Collection files will be saved going forward in a new file extension: ".ssc" instead of the old ".ss3" * Various changes have been made to the toolbar at the top of the main SignStream window: * A single right arrow indicates a 'play' action, where as a double right arrow indicates a 'play-next' action - e.g. play next entity * Adjacent to the zoom slider is now an icon which can be toggled between "L" (Locked) and "U" (Unlocked). The setting determines whether the zoom level is locked when flipping between utterance and database views. * Buttons related to the field specification editor have changed: * The "Display Graphical Fields" button was removed from the utterance view button panel, but is now viewable within the main "Field Editor" window. * A new button was added: "Refresh Default Display" -- this will set (in)visible those fields configured in the "Field Editor" window to be visible for the current view. This button is purple, and sits to the right of the red minus sign. * The "Field Editor" window contains some changes which relate to the "Refresh Default Display" button. Whichever fields have their values marked under the columns "Utterance", "Tier", and "Global" will have those fields made visible by default, or when "Refresh Default Display" is clicked. "Utterance" refers to the currently selected utterance. "Tier" refers to the segment tier which is being annotated. And "Global" means that the field will always be visible. * Entities can now exist outside of utterance boundaries. * Nonmanual field "role shift" had value "rs:other" changed to just "other" to remove the prefix. * Nonmanual field "body movement" had value "down" missing its label of "down", so it was added going forward.