Difference between revisions of "TotalRecall"

From Computational Memory Lab
Jump to: navigation, search
 
(202 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__
+
[[File:TotalRecall_screenshot.png|thumb|400px|TotalRecall in action. Click to embiggen.]]
<!-- #acl yuvi:read,write Known:read -->
+
An easy-to-use tool for quickly annotating audio files
  
<<html(<h1>[[TotalRecall]]</h1>)>>
+
== Overview ==
 +
Penn 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.
  
An open-source, multi-platform graphical tool for marking word onsets
+
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.
 
+
<<html(<img src="http://memory.psych.upenn.edu/files/software/TotalRecall/screenshot.png" alt="screenshot" width=800>)>>
+
 
+
<<[[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="http://memory.psych.upenn.edu/files/software/TotalRecall/webstart.png"/></a>)>> */
+
  
 
== Download ==
 
== Download ==
{| border="1" cellpadding="2" cellspacing="0"
+
{| cellpadding="5" cellspacing="0"
| '''File'''
+
 +
| '''Operating System'''
 
| '''Type'''
 
| '''Type'''
 
|-
 
|-
| [http://memory.psych.upenn.edu/files/software/TotalRecall/TotalRecall_OSX.zip TotalRecall_OSX.zip]
+
|[[File:mac_icon.png]]
| Mac OSX app
+
| [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/PTR.app.tar.gz Mac OSX]
 +
| Mac OSX App
 
|-
 
|-
| [http://memory.psych.upenn.edu/files/software/TotalRecall/TotalRecall_Windows.zip TotalRecall_Windows.zip]
+
|[[File:ubuntu_icon.png]]
| Windows executable
+
| [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/PennTotalRecall.deb Linux]
 +
| Debian Package
 
|-
 
|-
| TotalRecall_Multi.zip
+
|[[File:windows_icon.png]]
| Multi-platform executable
+
| [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/PennTotalRecall_Setup.exe Windows]
| soon
+
| Windows Installer
 
|-
 
|-
| [http://memory.psych.upenn.edu/files/software/TotalRecall/TotalRecall_Source.zip TotalRecall_Source.zip]
+
|[[File:github_icon.png|32px]]
| Multi-platform executable
+
| [http://github.com/memlab/Penn-TotalRecall Source Code]
| 0.31
+
 
|}
 
|}
  
= Getting Started =
+
== 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.
+
Download the file for your platform.
  
= Tutorial Videos and Help =
+
Install:
Please visit our [http://memory.psych.upenn.edu/TotalRecall/tutorials tutorial page] for screencasts and tips for using TotalRecall.
+
  
= System Requirements =
+
* Mac: Unzip PTR.app.tar.gz. This should automatically happen when you click it in your downloads. Then move PTR.app into the Applications folder.
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).
+
** [[#10.7_.28Lion.29_and_later|See below]] for special Gatekeeper issues.
 +
* Linux: Double click the .deb file and click Install Package.
 +
* Windows: Double click the .exe file and follow the instructions.
  
However, keep in mind we only have the resources to support [https://memory.psych.upenn.edu/TotalRecall#SupportedConfigurations these] configurations.
+
Now try running the program:
  
Most computers come with Java pre-installed, so you can probably download and run the program without worrying about system requirements.
+
* Mac: search for Penn TotalRecall in Spotlight, or double click PennTotalRecall.app in Finder by going to the Applications folder.
If it turns out you don't have Java, you can download it free [http://www.java.com/getjava/ here].
+
* Linux: on Ubuntu you can find Penn TotalRecall in the Applications --> Accessories menu.
 +
* Windows: you can find Penn TotalRecall in the start menu as usual. There should also be an icon on your desktop.
  
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`. OpenJDK support is in progress.
+
Try opening the wave file provided in this [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/sample.zip samples folder].
  
= Bugs and Feature Requests =
+
Check the menu items for actions and keybindings available to the user. Also check Help --> Key Bindings.
Please report all bugs to: memory-software@psych.upenn.edu
+
  
You can also email that address to request that new features be incorporated into the next release of the program.
+
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
 +
=== 10.7 (Lion) and later ===
 +
<div class="mw-collapsible-content">
 +
The [http://support.apple.com/kb/ht5290 "Gatekeeper"] function in OS X is designed to keep your system safe from potentially harmful software. Unfortunately, they may also prevent you from opening "unsigned" applications like TotalRecall.
  
= Development =
+
If you are unable to open TotalRecall on your Mac OS X system, please do the following:
  
== License ==
+
# Go into '''System Preferences''', then click '''Security & Privacy'''.
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.
+
#; [[File:Gatekeeper1.png|300px]]''(click to enlarge)''
 +
# Click the '''General''' tab, and select '''Anywhere''' under '''Allow applications downloaded from'''.
 +
#; [[File:Gatekeeper2.png|300px]]''(click to enlarge)''
 +
#: '''Note:''' You may need to authenticate as an administrator.
 +
# Open the TotalRecall application package. You may be warned about opening it for the first time.
 +
# After it opens for the first time, you may return the setting that you changed in Step 2 above to its previous selection if desired.
  
== Dependencies ==
+
''Special thanks to [http://psych.colorado.edu/~mollison/ '''Matt Mollison'''] for noticing this problem, and finding a solution.''
TotalRecall uses the [http://mary.dfki.de/ OpenMary TTS] signal processing library (`signalproc.jar`) for bandpass filtering (BSD).
+
</div>
The default audio playback implementation is derived from JavaZOOM.net's [http://www.javazoom.net/jlgui/developerguide.html BasicPlayer] (GPL).
+
</div>
Drag and drop support in Linux thanks to [http://iharder.sourceforge.net/current/java/filedrop/ FileDrop] (Public Domain).
+
  
== Developer Documentation ==
+
== Video tutorials and written annotation guide ==
Documentation can be found in the source jar above, and online here.
+
Additionally, a development guide can be found here.
+
  
== Supported Configurations ==
+
Our [[AnnotationGuide|full guide to annotation]] and [[Annotation tutorial videos|video tutorials]] explain proper use of TotalRecall, along with our internal annotation methods.
  
{| border="1" cellpadding="2" cellspacing="0"
+
== System requirements ==
| '''Operating System'''
+
TotalRecall currently runs on Mac OSX, Linux and Windows. We plan to test and support [[TotalRecall_Development#Supported_configurations|these]] configurations, but the program may work on others.
| '''Java versions'''
+
 
|-
+
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.
| Mac OS 10.6 (64-bit)
+
If it turns out you don't have Java, you can download it free [http://www.java.com/getjava/ here].
| Java 6 (64-bit)
+
 
|-
+
== Support, contact, and bug reports ==
| Mac OS 10.5 (64-bit)
+
Please feel free to contact us at: memory - software @ psych . upenn . edu (remove all the spaces).
| Java 5 (64-bit), 6 (64-bit)
+
 
|-
+
'''Thank you for taking the time to improve Penn TotalRecall!'''
| Ubuntu Linux 10.11 (64-bit)
+
 
| Java 6 (64-bit)
+
== Data analysis ==
|-
+
We also provide our [[behavioral_toolbox|Behavioral Toolbox]], a collection of MATLAB functions useful for analyzing the output of TotalRecall.
| Kubuntu Linux 10.11 (64-bit)
+
 
| Java 6 (64-bit)
+
== Development ==
|-
+
Please visit our [[TotalRecall_Development|development page]].
| Windows 7 (64-bit)
+
 
| Java 6 (64-bit)
+
For developers, please also visit our [[TotalRecall/Build]] page.
|-
+
 
| Windows XP (32-bit)
+
[[Category:TotalRecall]]
| Java 5 (32-bit), 6 (32-bit)
+

Latest revision as of 19:05, 26 March 2019

TotalRecall in action. Click to embiggen.

An easy-to-use tool for quickly annotating audio files

Overview

Penn 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.

Download

Operating System Type
Mac icon.png Mac OSX Mac OSX App
Ubuntu icon.png Linux Debian Package
Windows icon.png Windows Windows Installer
Github icon.png Source Code

Getting started

Download the file for your platform.

Install:

  • Mac: Unzip PTR.app.tar.gz. This should automatically happen when you click it in your downloads. Then move PTR.app into the Applications folder.
  • Linux: Double click the .deb file and click Install Package.
  • Windows: Double click the .exe file and follow the instructions.

Now try running the program:

  • Mac: search for Penn TotalRecall in Spotlight, or double click PennTotalRecall.app in Finder by going to the Applications folder.
  • Linux: on Ubuntu you can find Penn TotalRecall in the Applications --> Accessories menu.
  • 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 samples folder.

Check the menu items for actions and keybindings available to the user. Also check Help --> Key Bindings.

10.7 (Lion) and later

The "Gatekeeper" function in OS X is designed to keep your system safe from potentially harmful software. Unfortunately, they may also prevent you from opening "unsigned" applications like TotalRecall.

If you are unable to open TotalRecall on your Mac OS X system, please do the following:

  1. Go into System Preferences, then click Security & Privacy.
    Gatekeeper1.png(click to enlarge)
  2. Click the General tab, and select Anywhere under Allow applications downloaded from.
    Gatekeeper2.png(click to enlarge)
    Note: You may need to authenticate as an administrator.
  3. Open the TotalRecall application package. You may be warned about opening it for the first time.
  4. After it opens for the first time, you may return the setting that you changed in Step 2 above to its previous selection if desired.

Special thanks to Matt Mollison for noticing this problem, and finding a solution.

Video tutorials and written annotation guide

Our full guide to annotation and video tutorials explain proper use of TotalRecall, along with our internal annotation methods.

System requirements

TotalRecall currently runs on Mac OSX, Linux and Windows. We plan to test and support these configurations, but the program may work on others.

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. If it turns out you don't have Java, you can download it free here.

Support, contact, and bug reports

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!

Data analysis

We also provide our Behavioral Toolbox, a collection of MATLAB functions useful for analyzing the output of TotalRecall.

Development

Please visit our development page.

For developers, please also visit our TotalRecall/Build page.