Difference between revisions of "TotalRecall"

From Computational Memory Lab
Jump to: navigation, search
(Talk)
Line 2: Line 2:
 
<!-- #acl yuvi:read,write Known:read -->
 
<!-- #acl yuvi:read,write Known:read -->
  
<<html(<h1>Penn [[TotalRecall]]</h1>)>>
+
<<html(<h1>[[TotalRecall]]</h1>)>>
  
An easy-to-use tool for quickly annotating audio files.
+
An open-source, multi-platform graphical tool for marking word onsets
  
<<html(<img src="http://memory.psych.upenn.edu/files/software/TotalRecall/images/mac_screenshot.png" alt="screenshot" width=800>)>>
+
[[Media:TotalRecall$totalrecall_screen_shot.jpg|Screenshot|height=400]]
  
 
<<[[TableOfContents]](3)>>
 
<<[[TableOfContents]](3)>>
Line 13: Line 13:
 
TotalRecall is designed for precise scoring and timing of participant responses during verbal tasks, especially Free Recall. However, it can be used for many kinds of audio annotation. TotalRecall displays an audio recording as a self-scrolling waveform that automatically keeps up with audio playback.
 
TotalRecall is designed for precise scoring and timing of participant responses during verbal tasks, especially Free Recall. However, it can be used for many kinds of audio annotation. TotalRecall displays an audio recording as a self-scrolling waveform that automatically keeps up with audio playback.
  
TotalRecall is used on a daily basis by many in the Computational Memory Lab. Support and maintenance will continue indefinitely with new features being added as needed.
+
= Obtaining =
  
= Download =
+
== Launch with Java Web Start ==
{| border="1" cellpadding="2" cellspacing="0"
+
/* <<html(<a href="http://memory.psych.upenn.edu/files/software/TotalRecall/JavaWebStartAppPage.html"> <img src="http://memory.psych.upenn.edu/files/software/TotalRecall/webstart.png"/></a>)>> */
+
| '''Operating System'''
+
| '''Type'''
+
|}
+
  
 +
== Download ==
 
{| border="1" cellpadding="2" cellspacing="0"
 
{| border="1" cellpadding="2" cellspacing="0"
|<<html(<img src="http://memory.psych.upenn.edu/files/software/TotalRecall/images/mac_icon.png" alt="mac icon">|)>>
+
| '''File'''
| [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/PennTotalRecall.dmg Mac OSX]
+
| '''Type'''
| Mac OSX App
+
 
|-
 
|-
|<<html(<img src="http://memory.psych.upenn.edu/files/software/TotalRecall/images/ubuntu_icon.png" alt="ubuntu icon">|)>>
+
| [http://memory.psych.upenn.edu/files/software/TotalRecall/TotalRecall_OSX.zip TotalRecall_OSX.zip]
| [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/PennTotalRecall.deb Linux]
+
| Mac OSX executable
| Debian Package
+
 
|-
 
|-
|<<html(<img src="http://memory.psych.upenn.edu/files/software/TotalRecall/images/windows_icon.png" alt="windows icon">|)>>
+
| TotalRecall_Windows.zip
| Windows
+
| Windows executable
| Windows Installer
+
 
|-
 
|-
|<<html(<img src="http://memory.psych.upenn.edu/files/software/TotalRecall/images/github_icon.png" alt="zip icon" width=32>|)>>
+
| TotalRecall_Multi.zip
| [http://github.com/ymasory/Penn-TotalRecall Source code]
+
| Multi-platform executable
| GitHub repository
+
| not available
 +
|-
 +
| TotalRecall_Source.zip
 +
| Multi-platform executable
 +
| 0.24
 
|}
 
|}
  
Experimental nightly snapshots can be found [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/nightly here].
+
= Getting Started =
 +
Download the file for your platform and unzip it. After launching the program try opening the sample audio file and wordpool file in the examples directory. Check the menu items for actions and keybindings available to the user. Also check Help->Key Bindings.
  
/* == Launch with Java Web Start == */
+
= Tutorial Videos and Help =
/* <<html(<a href="http://memory.psych.upenn.edu/files/software/TotalRecall/JavaWebStartAppPage.html"> <img src="http://memory.psych.upenn.edu/files/software/TotalRecall/webstart.png"/></a>)>> */
+
Please visit our [http://memory.psych.upenn.edu/TotalRecall/tutorials tutorial page] for screencasts and tips for using TotalRecall.
  
= Getting started =
+
= System Requirements =
Download the file for your platform.
+
TotalRecall is written in pure Java, and should run on all platforms with a Java SE Runtime Environment, version 5 or higher (including Mac, Linux, Windows, Solaris, and others).
  
Install:
+
However, keep in mind we only have the resources to test [http://memory.psych.upenn.edu/Totalrecall#TestingConfigurations these] configurations.
  
* Mac: double click the .dmg file and drag PennTotalRecall.app into the Applications folder.
+
Most computers come with Java pre-installed, so you can probably download and run the program without worrying about system requirements.
* Linux: double click the .deb file and click Install Package.
+
If it turns out you don't have Java, you can download it free [http://www.java.com/getjava/ here].
* Windows: double click the .exe file and follow the instructions.
+
  
Now try running the program:
+
If you are running [[TotalRecall]] on Linux, make sure you are using Sun Java. It is available on Ubuntu by installing the packages `sun-java6-jre` and `sun-java6-plugin`.
  
* Mac: search for Penn [[TotalRecall]] in Spotlight, or double click PennTotalRecall.app in Finder by going to the Applications folder.
+
= Bugs and Feature Requests =
* Linux: on Ubuntu you can find Penn [[TotalRecall]] in the Applications --> Accessories menu.
+
Please report all bugs to: masory@sas.upenn.edu
* Windows: you can find Penn [[TotalRecall]] in the start menu as usual. There should also be an icon on your desktop.
+
  
Try opening the wave file provided in this [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/sample.zip samples folder].
+
You can also email that address to request that new features be incorporated into the next release of the program.
  
Check the menu items for actions and keybindings available to the user. Also check Help --> Key Bindings.
+
= Development =
  
= Annotation guide =
+
== License ==
 +
TotalRecall is free and open-source software, released under the [http://www.gnu.org/licenses/gpl-3.0.txt GNU General Public License], version 3. We encourage other groups to modify and improve the program.
  
A [http://memory.psych.upenn.edu/TotalRecall/AnnotationGuide full guide to annotation] provided. It explains proper use of the program along with our internal annotation standards.
+
== Dependencies ==
 +
TotalRecall uses the [http://mary.dfki.de/ OpenMary TTS] signal processing library (`signalproc.jar`) for bandpass filtering (BSD).
 +
The default audio playback implementation is derived from JavaZOOM.net's [http://www.javazoom.net/jlgui/developerguide.html BasicPlayer] (GPL).
 +
Drag and drop support in Linux thanks to [http://iharder.sourceforge.net/current/java/filedrop/ FileDrop] (Public Domain).
  
= System requirements =
+
== Developer Documentation ==
TotalRecall currently runs on Mac OSX, Linux and Windows. We plan to test and support [http://memory.psych.upenn.edu/TotalRecall/Development#Supportedconfigurations these] configurations, but the program may work on others.
+
Documentation can be found in the source jar above, and online here.
 +
Additionally, a development guide can be found here.
  
TotalRecall requires a Java Runtime Environment, version 5 or higher. Most computers come with Java pre-installed, so you can probably download and run the program without worrying about system requirements.
+
== Testing Configurations ==
If it turns out you don't have Java, you can download it free [http://www.java.com/getjava/ here].
+
  
= Support, contact, and bug reports =
+
The following configurations are regularly used in testing:
Please feel free to contact us at: memory - software @ psych . upenn . edu (remove all the spaces).
+
  
'''Thank you for taking the time to improve Penn TotalRecall!'''
+
{| border="1" cellpadding="2" cellspacing="0"
 
+
| '''Operating System'''
= Data analysis =
+
| '''Java versions'''
We also provide our [http://memory.psych.upenn.edu/behavioral_toolbox Behavioral Toolbox], a collection of MATLAB functions useful for analyzing the output of TotalRecall.
+
|-
 
+
| Mac OS 10.6 (64-bit)
= Development =
+
| Java 6 (64-bit)
Please visit our [http://memory.psych.upenn.edu/TotalRecall/Development development page].
+
|-
 +
| Mac OS 10.5 (64-bit)
 +
| Java 5 (64-bit), 6 (64-bit)
 +
|-
 +
| Ubuntu Linux 10.11 (64-bit)
 +
| Java 6 (64-bit)
 +
|-
 +
| Kubuntu Linux 10.11 (64-bit)
 +
| Java 6 (64-bit)
 +
|-
 +
| Windows 7 (64-bit)
 +
| Java 6 (64-bit)
 +
|-
 +
| Windows XP (32-bit)
 +
| Java 5 (32-bit), 6 (32-bit)

Revision as of 16:13, 24 January 2010


<<html(

TotalRecall

)>>

An open-source, multi-platform graphical tool for marking word onsets

Screenshot|height=400

<<TableOfContents(3)>>

Overview

TotalRecall is designed for precise scoring and timing of participant responses during verbal tasks, especially Free Recall. However, it can be used for many kinds of audio annotation. TotalRecall displays an audio recording as a self-scrolling waveform that automatically keeps up with audio playback.

Obtaining

Launch with Java Web Start

/* <<html(<a href="http://memory.psych.upenn.edu/files/software/TotalRecall/JavaWebStartAppPage.html"> <img src="webstart.png"/></a>)>> */

Download

File Type
TotalRecall_OSX.zip Mac OSX executable
TotalRecall_Windows.zip Windows executable
TotalRecall_Multi.zip Multi-platform executable not available
TotalRecall_Source.zip Multi-platform executable 0.24

Getting Started

Download the file for your platform and unzip it. After launching the program try opening the sample audio file and wordpool file in the examples directory. Check the menu items for actions and keybindings available to the user. Also check Help->Key Bindings.

Tutorial Videos and Help

Please visit our tutorial page for screencasts and tips for using TotalRecall.

System Requirements

TotalRecall is written in pure Java, and should run on all platforms with a Java SE Runtime Environment, version 5 or higher (including Mac, Linux, Windows, Solaris, and others).

However, keep in mind we only have the resources to test these configurations.

Most computers come with Java pre-installed, so you can probably download and run the program without worrying about system requirements. If it turns out you don't have Java, you can download it free here.

If you are running TotalRecall on Linux, make sure you are using Sun Java. It is available on Ubuntu by installing the packages `sun-java6-jre` and `sun-java6-plugin`.

Bugs and Feature Requests

Please report all bugs to: masory@sas.upenn.edu

You can also email that address to request that new features be incorporated into the next release of the program.

Development

License

TotalRecall is free and open-source software, released under the GNU General Public License, version 3. We encourage other groups to modify and improve the program.

Dependencies

TotalRecall uses the OpenMary TTS signal processing library (`signalproc.jar`) for bandpass filtering (BSD). The default audio playback implementation is derived from JavaZOOM.net's BasicPlayer (GPL). Drag and drop support in Linux thanks to FileDrop (Public Domain).

Developer Documentation

Documentation can be found in the source jar above, and online here. Additionally, a development guide can be found here.

Testing Configurations

The following configurations are regularly used in testing:

Operating System Java versions
Mac OS 10.6 (64-bit) Java 6 (64-bit)
Mac OS 10.5 (64-bit) Java 5 (64-bit), 6 (64-bit)
Ubuntu Linux 10.11 (64-bit) Java 6 (64-bit)
Kubuntu Linux 10.11 (64-bit) Java 6 (64-bit)
Windows 7 (64-bit) Java 6 (64-bit)
Windows XP (32-bit) Java 5 (32-bit), 6 (32-bit)