Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 14 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ beatStation - an openFrameworks tapping recorder

This work is licensed under the Creative Commons Attribution-NonCommercial 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/3.0/.

This work is partly-funded by the ERDF - European Regional Development Fund through the COMPETE Programme (operational programme for competitiveness) and by National Funds through the FCT- Fundacao para a Ciencia e a Tecnologia (Portuguese Foundation for Science and Technology) within project "PTDC/EAT-MMU/112255/2009-(FCOM-01-0124-FEDER-014732)"
This work is partly-funded by the ERDF - European Regional Development Fund through the COMPETE Programme (operational program for competitiveness) and by National Funds through the FCT- Fundacao para a Ciencia e a Tecnologia (Portuguese Foundation for Science and Technology) within project "PTDC/EAT-MMU/112255/2009-(FCOM-01-0124-FEDER-014732)"

========================
USAGE
========================

The already build binaries can be download from: http://github.com/SMC-INESC/beatStation/releases
The already build binaries can be download from http://github.com/SMC-INESC/beatStation/releases

Download the archive and extract/copy the directory on your local hard drive.

Before starting the app you need to copy 2 or more sound files to annotate in the data/sounds/ subdirectory.

You can also adjust different settings from the settings file. Take a look at the wiki page for more info. For instance, you can choose to tap with a midi interface or just use the keyboard.

beatStation was designed as a game with a purpose application in which users can compete between each other in tapping various songs. In this setup, you need to have Octave or Matlab installed in order to compute the score for each user.
beatStation was designed as a game with a purpose application in which users can compete against each other in tapping various songs. In this setup, you need to have Octave or Matlab installed in order to compute the score for each user.

beatStation can be used by researchers to annotate audio, conduct experiments, or as an inspiration for future apps.

Expand All @@ -30,7 +30,7 @@ Contact me at miron.marius [at] gmail [dot] com for future questions
BUILDING
========================

These are the MAC OSX and Windows versions. for the linux version go at: https://github.com/nkundiushuti/beatStationLinux
These are the MAC OSX and Windows versions. for the Linux version go at https://github.com/nkundiushuti/beatStationLinux

========================
MACOS BUILD
Expand All @@ -45,16 +45,16 @@ WINDOWS BUILD
========================

You will need to have Codeblocks 10 installed.
Download and install openframeworks 0.7.1 for linux and Codeblocks as specified on the website.
Download and install openframeworks 0.7.1 for Linux and Codeblocks as specified on the website.
Building DOES NOT work with later versions of Openframeworks or Codeblocks
Unpack addons.zip or download from github and copy in the openframeworks addons directory(not the project addons!), the following addons:
Unpack addons.zip or download from GitHub and copy in the openframeworks addons directory(not the project addons!), the following addons:
- ofxUI
- ofxXMLSettings
- ofxDirList
- ofxTextSuite
- ofxNetwork

Copy the beatStation directory in the apps/myapps directory, open the codeblocks project(beatStation.cbp) and CLEAN then BUILD.
Copy the beatStation directory in the apps/myapps directory, open the code blocks project(beatStation.cbp) and CLEAN then BUILD.


IMPORTANT - you must copy some audio files in the sounds directory before starting the app
Expand All @@ -64,30 +64,30 @@ IMPORTANT - you must copy some audio files in the sounds directory before starti
FUNCTIONALITIES
========================

The app has an user management system and a tapping recording system, as well as an ability to run tests on different machines connected in a client-server architecture.
The app has a user management system and a tapping recording system, as well as an ability to run tests on different machines connected in a client-server architecture.

USER MANAGEMENT
- recorded in the data/users.xml folder
- each new user is required to enter the name, then a new ID is generated based on the name(ex: john doe - jd1 - the first user with the jd initials), plus an unique index id for each user.
- each new user is required to enter the name, then a new ID is generated based on the name(ex: john doe - jd1 - the first user with the jd initials), plus a unique index id for each user.
- an existing user can log-in using the ID
- all the tappings will be stored in the data directory, in filenames corresponding to the user id, e.g. jd1.xml

TAP RECORDING
- once logged an user can listen to a song with PLAY, move to the next song with NEXT
- tappings are recorded in a vector for each song
- an user can always quit pressing QUIT button
- tappings are saved in an xml named with the user's ID each time an user hits quit or he finishes the tapping
- a user can always quit pressing QUIT button
- tappings are saved in an XML named with the user's ID each time a user hits quit or he finishes the tapping
- instructions are displayed with the INSTRUCTIONS button
- volume can be adjusted with the VOL slider
- the percentage played from a song can be seen in the rotary slider POS

CLIENT - SERVER ARCHITECTURE
- an user can log-in with the same id on the server and all clients machines
- a user can log-in with the same id on the server and all clients machines
- by default, an app runs as a server if not changed from the settings.xml (isClient=1)
- if server, all users are stored on the users.xml file
- if the server, all users are stored on the users.xml file
- if client, the authentication happens on the server machine
- the server must be started in order for the clients to connect and authentication to take place
- tappings are stored locally for clients and server
- tappings are stored locally on clients and server

THE SETTINGS FILE
Several parameters can be modified using the settings.xml file
Expand Down Expand Up @@ -138,4 +138,3 @@ INSTRUCTIONS
- the app description from the first page can be changed from description.txt
- the instructions can be changed from instructions.txt
- the <> sequence is used for a new line