mne-videobrowser 0.2.0

Python package for browsing video and audio time-synchronized to MEG/EEG data

Video and audio browser extension for MNE-Python's Qt data browser

This is an open-source Python package for browsing video and audio time-synchronized to MEG/EEG data. It serves as an add-on for mne-qt-browser, which is part of MNE-Python, an open-source Python package for exploring, visualizing, and analyzing human neurophysiological data.

This project also complements Helsinki VideoMEG project by supporting video and audio files recorded with their software.

Screenshot of the browser extension showing a black video frame and a test audio file synchronized with MNE-Python's sample MEG data.

Features

• Time-synchronized video browsing and playback with MEG/EEG data
• Time-synchronized audio browsing and playback with MEG/EEG data
• Support for multiple video and MEG files simultaneously (only one audio file with multiple channels at a time)
• Support for Helsinki VideoMEG project format files
• Standard video format support (MP4, AVI, etc.) via OpenCV (for audio only Helsinki VideoMEG format is currently supported)

Documentation

Documentation contains installation instructions (same as below), public API reference, and some of the usage examples available in the GitHub. A bit of the code structure and implementation details are also documented.

Installation

In addition to MNE-Python, this project requires package OpenCV for standard video file (such as .mp4) reading and sounddevice for audio playback. Recommended way to install MNE-Python and thus this package is using conda.

Using conda (recommended)

1. Create a new conda environment (named mne-videobrowser) with this package and all dependencies installed:

   conda create --channel=conda-forge --strict-channel-priority --name=mne-videobrowser mne-videobrowser
   

2. Activate the environment:

   conda activate mne-videobrowser
   

3. Only on linux: If you do not have PortAudio library, which is dependency of sounddevice installed, install it. For example on Ubuntu/Debian:

   sudo apt install libportaudio2
   

Using pip

1. Activate your desired Python environment (documentation for virtual environments).

2. Install this package, all dependencies will be installed automatically, except for a Qt binding, so you need to specify that in the command line as well if you don't have one (we recommend PySide6):

   pip install mne-videobrowser PySide6
   

3. Only on linux: If you do not have PortAudio library, which is dependency of sounddevice installed, install it. For example on Ubuntu/Debian:

   sudo apt install libportaudio2
   

See usage examples in GitHub.

For developers

Installation for development

1. Clone this repository and navigate to project root.

2. Run

   conda env create -f environment.yml
   

   This will create a conda environment mne-videobrowser-dev, that has development dependencies and the package installed in editable mode, which ensures that changes in source code are reflected to the installed package.

3. Activate the environment:

   conda activate mne-videobrowser-dev
   

4. Only on linux: If you do not have PortAudio library, which is dependency of sounddevice installed, install it. For example on Ubuntu/Debian:

   sudo apt install libportaudio2
   

Running tests

Tests are located in directory tests/ and they run using package pytest (included in development dependencies).

You can run all the tests with:

pytest

You can also selectively run tests in a specific file/class/method. See pytest documentation for details.

Building documentation

Documentation source files are located in docs/source/ and built documentation in docs/build/. Documentation is mostly automatically generated from the source code docstrings using sphinx. To build the documentation:

cd docs
make html  # on Windows use 'make.bat html'

Then view the built html documentation by opening file docs/build/html/index.html in a web browser.