mtg / similarity-annotator Goto Github PK

An annotation tool for sound segmentation and similarity

License: Other

Python 49.40% HTML 8.82% JavaScript 39.44% CSS 1.78% Shell 0.38% Dockerfile 0.18%

python3 wavesurfer-js docker docker-composer libav annotations sound similarity-annotation django

similarity-annotator's Introduction

Similarity Annotation Tool

A web based tool to annotate similarity of sounds regarding a target sound. The web application is written in django framework and the interface for annotation is based on CrowdCurio audio annotator

Installation

First of all you should clone this repository

1. Install ffmpeg

You may use libav or ffmpeg.

Mac (using homebrew):

# libav
brew install libav --with-libvorbis --with-sdl --with-theora

####    OR    #####

# ffmpeg
brew install ffmpeg --with-libvorbis --with-ffplay --with-theora

Linux (using aptitude):

# libav
apt-get install libav-tools libavcodec-extra-53

####    OR    #####

# ffmpeg
apt-get install ffmpeg libavcodec-extra-53

Windows:

Download and extract libav from Windows binaries provided here.
Add the libav /bin folder to your PATH envvar
pip install pydub

2. Setup DB

2.1 Installation

We recommend using postgreSQL database.

On Linux:

sudo apt-get update
sudo apt-get install postgresql postgresql-contrib

On Mac using HomeBrew follow this

2.2 Create DB

createdb _data_base_name_

3. Install requirements

We recommend using virtualenv. Once on your python virtual environment run:

pip install -r requirements.txt

4. Setup development settings

Copy the file simannotator/development_settings.py.dist to the same directory but with the file extension .py Add your data_base_name into DATABASES['NAME'] and the user of the database into DATABASES['USER']

5. Run the project

5.1 Migrate

To apply the Django migrations to the DB run:

python manage.py migrate

5.2 Run Django

python manage.py runserver

License

All the software is distributed with the Affero GPL v3 license except the CrowdCurio files that are licensed under BSD-2 clause.

similarity-annotator's People

Contributors

Stargazers

Watchers

Forkers

dogacavdir ruohoruotsi

similarity-annotator's Issues

Create an upper level of exercise

We could have a level above exercise, e.g. "dataset", in case we have different people working on it

Style interface to not have to scroll down to see submit buttons

All tiers appear in parent tier selection list

In the Creation Tier form all tiers appear in the parent tier selection. Only the tiers from the corresponding exercise should appear.

Zoom on the interface

A slider to zoom into the waveform, something similar to this.
It would ideal to have both an slider and the option of doing it with mouse scroll wheel

Add annotation name by selecting pre-defined labels

As it is in the original interface we should be able to add annotations names by clicking predefined labels.

Segment created close to previous one with drag and drop links both segments

When you create a segment using drag and drop there is a threshold below which the segments are linked, similar to what happens when you create a segment with the shortcut 'i'.
This shouldn't happen with the drag and drop option

Segments are created when writing the name of the annotation

When filling the name of the segment in the interface, if 'i' is hitted a segment is created.
The creation of segment swith this shortcut should be restricted to when the user is not writing down the name of the annotation

List of exercises ordered by uploaded date and add uploaded date

Flag to discard sounds

The sound objects in the database should have a flag "discard". Then in the interface an option will appear to mark them as discarded

Show annotations only for the logged user

Remove segment button removes all segments

Zoom doesn't get back to original size

After zooming in, when you zoom out to original position the waveform doesn't come back to the original size

Tool to upload annotations from Praat files

For this we'll need exmaple files from @sankalpg

Define or upload Rubric

Handle uploading of same file name

Not redirect to other tier when submitting annotations

Make annotations editable

Allow the user to add a tag/name to each annotation

Pagination in sounds list doesn't work

When you click the link to the second page of the list of sounds the filters are played again so you don't see the second page of sounds

Select cursor place in audio with mouse

Consider Repovizz2 as a backend service for sounds and annotations

Make annotation name not mandatory

Remove exercise name from sound filename

Having the exercise name in the sound filename is redundant so it should be removed.

Allow user change the state of the sound

Add some message when clicking Done in the interface

Display "map" of the sound only once

Link to get back to exercises from sound list

Functionality to add a Tier from sound detail

Copy new annotations in a tier into its related tiers

An undo button is necessary!

As there is the scope of discarding files wrongly due to human error, an undo button is necessary!

Get Exercise objects by exercise_id and not name

Check if a new version of audiowaveform has been released

Cursor doesn't stay in place

When selecting a place in the tier the cursors goes to the beginning of the audio

Sounds with annotations appear red in the sounds list

All Tiers should be visible on the same page.

In Indian Music, the lyrics and notes are interdependent. It would be nice to see all the tiers on the same page!

gearman stopped working

py3gearman.errors.ServerUnavailable: Found no valid connections in list: []

API to upload sounds from the CAMUT data structure

AnnotationSimilarity are only shown for the user who creates them

We should be able to see the annotation similarities created by another user in order to check them. This could be solved by allowing the staff members see all annotation similarities and not the other users.

Remove/fix donwload button in sound list page

Validate annotations

Visualise the boundaries of the segments

In order to see fast if the segmentation is well done, it would be good to see the boundaries of the segments

Add created_data of Annotation in the admin page

Visualise which sounds are already annotated

In the sounds_list we should show which sounds already have annotations

Functionality to add similarity annotations

Allow the user to create an annotation and then link it to another annotation from the reference sound and add a similarity value

Do not show logout in registration page

Discarded sounds are also visible in the sound list

Create segments with shortcut that start at the end of previous segment

The drap-and-drop tool for creating segments is useful for isolated annotations but for the case of riyaz content we need something more similar to Praat.
We discussed on having a shortcut to create segments. This tool will work this way; when pressing the shortcut a segment will bre created having start time on the previous segment end time. The segments won't overlap. We should be able to edit those segments afterwards as we do now, but edtiting end time or start time of a segment will implie to move both the end/start of consecutive segments.

red: the sound doesn't have a single annotation (segments) or similarityannotation
orange: the sound has less segments than the reference sound of the exercise or, still having all of them, doesn't have similarityannotations
green: the sound has as many segments as the reference sound and at least one similarityannotation