StreamMetadata.pixel_aspect_ratio: rename from sample_aspect_ratio

Author: carandraug

src/torchcodec/_core/_metadata.py

@@ -81,9 +81,10 @@ class VideoStreamMetadata(StreamMetadata):
     average_fps_from_header: Optional[float]
     """Averate fps of the stream, obtained from the header (float or None).
     We recommend using the ``average_fps`` attribute instead."""
-    sample_aspect_ratio: Optional[Fraction]
-    """Sample Aspect Ratio (SAR), also known as Pixel Aspect Ratio
-    (PAR), is the ratio between the width and height of each pixel
+    pixel_aspect_ratio: Optional[Fraction]
+    """Pixel Aspect Ratio (PAR), also known as Sample Aspect Ratio
+    (SAR --- not to be confused with Sample Aspect Ratio, also SAR),
+    is the ratio between the width and height of each pixel
     (``fractions.Fraction`` or None)."""
 
     @property
@@ -262,7 +263,7 @@ def get_container_metadata(decoder: torch.Tensor) -> ContainerMetadata:
                     num_frames_from_header=stream_dict.get("numFramesFromHeader"),
                     num_frames_from_content=stream_dict.get("numFramesFromContent"),
                     average_fps_from_header=stream_dict.get("averageFpsFromHeader"),
-                    sample_aspect_ratio=_get_optional_sar_fraction(stream_dict),
+                    pixel_aspect_ratio=_get_optional_par_fraction(stream_dict),
                     **common_meta,
                 )
             )

test/test_metadata.py

@@ -82,7 +82,7 @@ def test_get_metadata(metadata_getter):
     assert best_video_stream_metadata.begin_stream_seconds_from_header == 0
     assert best_video_stream_metadata.bit_rate == 128783
     assert best_video_stream_metadata.average_fps == pytest.approx(29.97, abs=0.001)
-    assert best_video_stream_metadata.sample_aspect_ratio is None
+    assert best_video_stream_metadata.pixel_aspect_ratio is None
     assert best_video_stream_metadata.codec == "h264"
     assert best_video_stream_metadata.num_frames_from_content == (
         390 if with_scan else None
@@ -139,7 +139,7 @@ def test_num_frames_fallback(
         width=123,
         height=321,
         average_fps_from_header=30,
-        sample_aspect_ratio=Fraction(1, 1),
+        pixel_aspect_ratio=Fraction(1, 1),
         stream_index=0,
     )
 
@@ -164,7 +164,7 @@ def test_repr():
   num_frames_from_header: 390
   num_frames_from_content: 390
   average_fps_from_header: 29.97003
-  sample_aspect_ratio: 1
+  pixel_aspect_ratio: 1
   duration_seconds: 13.013
   begin_stream_seconds: 0.0
   end_stream_seconds: 13.013