AcademySoftwareFoundation / AcademySoftwareFoundation/OpenTimelineIO
Progress callbacks on long running adapters
- Dominant language
- C++
- Stars
- 2k
- Forks
- 351
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 1
Description
Some adapter operations are time consuming, and tool authors would like to provide progress estimations. A progress callback, presumably with a percentage or other measure would enable this.
Specifically, we are looking for a proposal for an optional argument to the standard `read_from_file` and `write_to_file` functions that specifies a callback function. The callback function could take a % done amount, and maybe an informational string.
The slowest adapter we have currently is the AAF adapter, so that would be a good use case to ensure this is working as intended.
Contributor guide
Research direction
Start by reviewing the standard `read_from_file` and `write_to_file` adapter entry points, then examine the AAF adapter as the stated slow-operation use case. Done would be an agreed proposal for an optional progress callback, including its progress measure and informational data.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100