Rename begin/endStreamSecondsFromContent to begin/endStreamPtsSecondsFromContent to retain PTS in variable name

Author: Dan-Flores

src/torchcodec/_core/Metadata.h

@@ -37,8 +37,8 @@ struct StreamMetadata {
   std::optional<int64_t> beginStreamPtsFromContent;
   std::optional<int64_t> endStreamPtsFromContent;
   // These presentation timestamps are in seconds.
-  std::optional<double> beginStreamSecondsFromContent;
-  std::optional<double> endStreamSecondsFromContent;
+  std::optional<double> beginStreamPtsSecondsFromContent;
+  std::optional<double> endStreamPtsSecondsFromContent;
   // This can be useful for index-based seeking.
   std::optional<int64_t> numFramesFromContent;
 

src/torchcodec/_core/SingleStreamDecoder.cpp

@@ -267,12 +267,12 @@ void SingleStreamDecoder::scanFileAndUpdateMetadataAndIndex() {
         streamInfos_[streamIndex].allFrames.size();
 
     if (streamMetadata.beginStreamPtsFromContent.has_value()) {
-      streamMetadata.beginStreamSecondsFromContent =
+      streamMetadata.beginStreamPtsSecondsFromContent =
           *streamMetadata.beginStreamPtsFromContent *
           av_q2d(avStream->time_base);
     }
     if (streamMetadata.endStreamPtsFromContent.has_value()) {
-      streamMetadata.endStreamSecondsFromContent =
+      streamMetadata.endStreamPtsSecondsFromContent =
           *streamMetadata.endStreamPtsFromContent * av_q2d(avStream->time_base);
     }
   }
@@ -1479,7 +1479,7 @@ double SingleStreamDecoder::getMinSeconds(
     const StreamMetadata& streamMetadata) {
   switch (seekMode_) {
     case SeekMode::exact:
-      return streamMetadata.beginStreamSecondsFromContent.value();
+      return streamMetadata.beginStreamPtsSecondsFromContent.value();
     case SeekMode::approximate:
       return 0;
     default:
@@ -1491,7 +1491,7 @@ double SingleStreamDecoder::getMaxSeconds(
     const StreamMetadata& streamMetadata) {
   switch (seekMode_) {
     case SeekMode::exact:
-      return streamMetadata.endStreamSecondsFromContent.value();
+      return streamMetadata.endStreamPtsSecondsFromContent.value();
     case SeekMode::approximate: {
       TORCH_CHECK(
           streamMetadata.durationSecondsFromHeader.has_value(),

src/torchcodec/_core/SingleStreamDecoder.h

@@ -121,7 +121,7 @@ class SingleStreamDecoder {
   //
   // Valid values for startSeconds and stopSeconds are:
   //
-  //   [beginStreamSecondsFromContent, endStreamSecondsFromContent)
+  //   [beginStreamPtsSecondsFromContent, endStreamPtsSecondsFromContent)
   FrameBatchOutput getFramesPlayedInRange(
       double startSeconds,
       double stopSeconds);

src/torchcodec/_core/custom_ops.cpp

@@ -485,13 +485,13 @@ std::string get_json_metadata(at::Tensor& decoder) {
       metadataMap["numFramesFromHeader"] =
           std::to_string(*streamMetadata.numFramesFromHeader);
     }
-    if (streamMetadata.beginStreamSecondsFromContent.has_value()) {
+    if (streamMetadata.beginStreamPtsSecondsFromContent.has_value()) {
       metadataMap["beginStreamSecondsFromContent"] =
-          std::to_string(*streamMetadata.beginStreamSecondsFromContent);
+          std::to_string(*streamMetadata.beginStreamPtsSecondsFromContent);
     }
-    if (streamMetadata.endStreamSecondsFromContent.has_value()) {
+    if (streamMetadata.endStreamPtsSecondsFromContent.has_value()) {
       metadataMap["endStreamSecondsFromContent"] =
-          std::to_string(*streamMetadata.endStreamSecondsFromContent);
+          std::to_string(*streamMetadata.endStreamPtsSecondsFromContent);
     }
     if (streamMetadata.codecName.has_value()) {
       metadataMap["codec"] = quoteValue(streamMetadata.codecName.value());
@@ -586,13 +586,13 @@ std::string get_stream_json_metadata(
     map["beginStreamSecondsFromHeader"] =
         std::to_string(*streamMetadata.beginStreamSecondsFromHeader);
   }
-  if (streamMetadata.beginStreamSecondsFromContent.has_value()) {
+  if (streamMetadata.beginStreamPtsSecondsFromContent.has_value()) {
     map["beginStreamSecondsFromContent"] =
-        std::to_string(*streamMetadata.beginStreamSecondsFromContent);
+        std::to_string(*streamMetadata.beginStreamPtsSecondsFromContent);
   }
-  if (streamMetadata.endStreamSecondsFromContent.has_value()) {
+  if (streamMetadata.endStreamPtsSecondsFromContent.has_value()) {
     map["endStreamSecondsFromContent"] =
-        std::to_string(*streamMetadata.endStreamSecondsFromContent);
+        std::to_string(*streamMetadata.endStreamPtsSecondsFromContent);
   }
   if (streamMetadata.codecName.has_value()) {
     map["codec"] = quoteValue(streamMetadata.codecName.value());

test/VideoDecoderTest.cpp

@@ -84,14 +84,14 @@ TEST_P(SingleStreamDecoderTest, ReturnsFpsAndDurationForVideoInMetadata) {
   EXPECT_NEAR(*videoStream.bitRate, 128783, 1e-1);
   EXPECT_NEAR(*videoStream.durationSecondsFromHeader, 13.013, 1e-1);
   EXPECT_EQ(videoStream.numFramesFromHeader, 390);
-  EXPECT_FALSE(videoStream.beginStreamSecondsFromContent.has_value());
-  EXPECT_FALSE(videoStream.endStreamSecondsFromContent.has_value());
+  EXPECT_FALSE(videoStream.beginStreamPtsSecondsFromContent.has_value());
+  EXPECT_FALSE(videoStream.endStreamPtsSecondsFromContent.has_value());
   EXPECT_FALSE(videoStream.numFramesFromContent.has_value());
   decoder->scanFileAndUpdateMetadataAndIndex();
   metadata = decoder->getContainerMetadata();
   const auto& videoStream1 = metadata.allStreamMetadata[3];
-  EXPECT_EQ(*videoStream1.beginStreamSecondsFromContent, 0);
-  EXPECT_EQ(*videoStream1.endStreamSecondsFromContent, 13.013);
+  EXPECT_EQ(*videoStream1.beginStreamPtsSecondsFromContent, 0);
+  EXPECT_EQ(*videoStream1.endStreamPtsSecondsFromContent, 13.013);
   EXPECT_EQ(*videoStream1.numFramesFromContent, 390);
 }