[keighrim]

Overview

This release adds text and audio document helpers utils package.

Additions

• audio_document_helper (add audio_document_helper for windowed audio reads #416)
  • mmif.utils.audio_document_helper.iter_audio_windows(): decodes an AudioDocument, or the audio track of a VideoDocument, into fixed-length windows of mono float32 samples with millisecond start and end times.
  • mmif.utils.timeunit_helper.iter_time_windows(): windows over a time interval in integer milliseconds, with a stride for overlapping windows or gaps
  • mmif-python[av] extra: PyAV and NumPy only, for apps that read audio without needing OpenCV or Pillow. mmif-python[cv] now builds on top of av extras
  • PyAV operations are shared with video_document_helper through the new mmif.utils.av_helper (with this, open_container(), get_framerate() and capture() now raise FileNotFoundError instead of ValueError when no document is given)

Changes

• Mmif.get_annotations_between_time() (Incorporate app-text-slicer functionality into text_document_helper as the app is discontinued #417, also partially addresses Expand on time-based filtering of annotations #330)
  • fixed a bug where views that contain only TimePoints raised a TypeError
  • an annotation now counts when it overlaps the range at all; annotations that only touch the range at one end are not included, and an annotation aligned to more than one time anchor is returned once
  • every TimeFrame and TimePoint in the MMIF must now be in integer milliseconds, otherwise a ValueError is raised. Note: this also applies to MMIF files produced by years-older apps that wrote seconds or frames.
  • the time_unit argument is deprecated and will be removed in 2.0.0. Give start and end in milliseconds
• text_document_helper.slice_text() is deprecated, to be removed in 2.0.0. Use Mmif.get_annotations_between_time(start, end, at_types=[AnnotationTypes.Token]) instead (Incorporate app-text-slicer functionality into text_document_helper as the app is discontinued #417)

[codecov]

Codecov Report

❌ Patch coverage is 97.09544% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 81.15%. Comparing base (23ef841) to head (97e0b12).
⚠️ Report is 18 commits behind head on main.

Files with missing lines	Patch %	Lines
mmif/utils/audio_document_helper.py	96.87%	4 Missing ⚠️
mmif/utils/av_helper.py	95.23%	2 Missing ⚠️
mmif/serialize/mmif.py	97.29%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #420      +/-   ##
==========================================
+ Coverage   80.13%   81.15%   +1.01%     
==========================================
  Files          28       30       +2     
  Lines        3630     3815     +185     
==========================================
+ Hits         2909     3096     +187     
+ Misses        721      719       -2     

Flag	Coverage Δ
unittests	81.15% <97.09%> (+1.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.