Video data conversion (multimedia formats)

Install NeuroConv with the additional dependencies necessary for reading multimedia data.

pip install "neuroconv[video]"

This interface can handle conversions from avi, mov, mp4, wmv, flv and most FFmpeg supported formats to NWB using the VideoInterface class.

>>> from datetime import datetime
>>> from zoneinfo import ZoneInfo
>>> from pathlib import Path
>>>
>>> from neuroconv.datainterfaces import VideoInterface
>>>
>>> video_file_path = BEHAVIOR_DATA_PATH / "videos" / "CFR" / "video_avi.avi"
>>> interface = VideoInterface(file_paths=[video_file_path], verbose=False)
>>>
>>> metadata = interface.get_metadata()
>>> # For data provenance we add the time zone information to the conversion
>>> session_start_time = datetime(2020, 1, 1, 12, 30, 0, tzinfo=ZoneInfo("US/Pacific"))
>>> metadata["NWBFile"].update(session_start_time=session_start_time)
>>>
>>> # Choose a path for saving the nwb file and run the conversion
>>> interface.run_conversion(nwbfile_path=path_to_save_nwbfile, metadata=metadata)