# video-vocal-RT
A minimal package to record vocal response to video stimuli. Useful for vocal reaction time research with video stimuli instead of pictures. Uses open CV for video playing, among other things.
# Usage
I will provide more information soon 😉
## Installation with pip
```
pip install video-vocal-rt
```
## Installation with poetry
First, clone the repository
```
git clone https://github.com/LoonanChauvette/video-vocal-RT.git
```
Then, inside the package folder, install the dependencies with poetry
```
cd video-vocal-RT
poetry install
```
Poetry creates a virtual environment, you should be able to activate it using :
```
poetry shell
```
Then you can run the script using :
```
poetry run python video_vocal_rt/main.py
```
## How-to
Place your video files in the VIDEO_FILES directory (only supports .avi files for now). For the moment, you need to go inside video_vocal_rt/main.py before running the experiement. There you should make sure to set the audio recording duration in seconds (default is 6 seconds, but should be the typical length of your videos). You also need to set the PARTICIPANT_ID to the desired value.
You can also set fixation parameters with FIXATION_DUR for the duration (default is 1000 ms). You can provide change the file "fixation.png" to customize the fixation. By default, there is a whiteout period after the video, its duration can be changed with WHITEN_DUR (default is 1000 ms).
# Citation
```
Chauvette, L. (2023). Video-Vocal-RT: a minimal package for vocal response to video.
https://github.com/LoonanChauvette/video-vocal-RT
````
Bibtex:
```
@manual{Video-Vocal-RT,
title={{Video-Vocal-RT: a minimal package for vocal response to video}},
author={{Chauvette, Loonan}},
year={2023},
url={https://github.com/LoonanChauvette/video-vocal-RT},
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/LoonanChauvette/video-vocal-RT",
"name": "video-vocal-rt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<3.12",
"maintainer_email": "",
"keywords": "video,audio,psychology,reaction time",
"author": "Loonan Chauvette",
"author_email": "loonan.chauvette@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fd/ca/ce41b1421dbfc2d88e3a4a74abfecaf099ed349c7ef799de4c775a7c3df1/video_vocal_rt-0.4.0.tar.gz",
"platform": null,
"description": "# video-vocal-RT\nA minimal package to record vocal response to video stimuli. Useful for vocal reaction time research with video stimuli instead of pictures. Uses open CV for video playing, among other things.\n\n# Usage\nI will provide more information soon \ud83d\ude09\n\n## Installation with pip\n```\npip install video-vocal-rt\n```\n\n## Installation with poetry\nFirst, clone the repository\n```\ngit clone https://github.com/LoonanChauvette/video-vocal-RT.git\n```\nThen, inside the package folder, install the dependencies with poetry\n```\ncd video-vocal-RT\npoetry install\n```\nPoetry creates a virtual environment, you should be able to activate it using : \n```\npoetry shell\n```\nThen you can run the script using : \n```\npoetry run python video_vocal_rt/main.py\n```\n\n## How-to \nPlace your video files in the VIDEO_FILES directory (only supports .avi files for now). For the moment, you need to go inside video_vocal_rt/main.py before running the experiement. There you should make sure to set the audio recording duration in seconds (default is 6 seconds, but should be the typical length of your videos). You also need to set the PARTICIPANT_ID to the desired value. \n\nYou can also set fixation parameters with FIXATION_DUR for the duration (default is 1000 ms). You can provide change the file \"fixation.png\" to customize the fixation. By default, there is a whiteout period after the video, its duration can be changed with WHITEN_DUR (default is 1000 ms).\n\n# Citation\n \n```\nChauvette, L. (2023). Video-Vocal-RT: a minimal package for vocal response to video.\nhttps://github.com/LoonanChauvette/video-vocal-RT\n````\n\nBibtex:\n```\n@manual{Video-Vocal-RT,\n title={{Video-Vocal-RT: a minimal package for vocal response to video}},\n author={{Chauvette, Loonan}},\n year={2023},\n url={https://github.com/LoonanChauvette/video-vocal-RT},\n}\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": "Video-Vocal-RT: a minimal package for vocal response to video",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/LoonanChauvette/video-vocal-RT",
"Repository": "https://github.com/LoonanChauvette/video-vocal-RT"
},
"split_keywords": [
"video",
"audio",
"psychology",
"reaction time"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94e5ede6397e806037e9a4b2bac4fd03a11768dc38b30e2b0745fa45b935c0c1",
"md5": "15dfb765a07d39df0918403f5861b77b",
"sha256": "cb2592c0b59502da485c7a1bcac00d96c03f667bac04d94c4786489cdc3283ce"
},
"downloads": -1,
"filename": "video_vocal_rt-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15dfb765a07d39df0918403f5861b77b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<3.12",
"size": 6393,
"upload_time": "2023-07-05T18:33:13",
"upload_time_iso_8601": "2023-07-05T18:33:13.381131Z",
"url": "https://files.pythonhosted.org/packages/94/e5/ede6397e806037e9a4b2bac4fd03a11768dc38b30e2b0745fa45b935c0c1/video_vocal_rt-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fdcace41b1421dbfc2d88e3a4a74abfecaf099ed349c7ef799de4c775a7c3df1",
"md5": "847daea728e266b0efe3b3b319b5f130",
"sha256": "46e0a3fa571cc83e9ba872886ac0e9606ddd0b37d5c873d5ac8866f19ce67c4b"
},
"downloads": -1,
"filename": "video_vocal_rt-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "847daea728e266b0efe3b3b319b5f130",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<3.12",
"size": 6033,
"upload_time": "2023-07-05T18:33:14",
"upload_time_iso_8601": "2023-07-05T18:33:14.906061Z",
"url": "https://files.pythonhosted.org/packages/fd/ca/ce41b1421dbfc2d88e3a4a74abfecaf099ed349c7ef799de4c775a7c3df1/video_vocal_rt-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-05 18:33:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LoonanChauvette",
"github_project": "video-vocal-RT",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "video-vocal-rt"
}
JSON
