Update names

Author: NicolasHug

src/torchcodec/decoders/_core/FFMPEGCommon.cpp

@@ -10,22 +10,22 @@
 
 namespace facebook::torchcodec {
 
-AutoFreedAVPacket::AutoFreedAVPacket() : avPacket_(av_packet_alloc()) {
+AutoAVPacket::AutoAVPacket() : avPacket_(av_packet_alloc()) {
   TORCH_CHECK(avPacket_ != nullptr, "Couldn't allocate avPacket.");
 }
-AutoFreedAVPacket::~AutoFreedAVPacket() {
+AutoAVPacket::~AutoAVPacket() {
   av_packet_free(&avPacket_);
 }
 
-AutoUnrefedAVPacket::AutoUnrefedAVPacket(AutoFreedAVPacket& shared)
+ReferenceAVPacket::ReferenceAVPacket(AutoAVPacket& shared)
     : avPacket_(shared.avPacket_) {}
-AutoUnrefedAVPacket::~AutoUnrefedAVPacket() {
+ReferenceAVPacket::~ReferenceAVPacket() {
   av_packet_unref(avPacket_);
 }
-AVPacket* AutoUnrefedAVPacket::get() {
+AVPacket* ReferenceAVPacket::get() {
   return avPacket_;
 }
-AVPacket* AutoUnrefedAVPacket::operator->() {
+AVPacket* ReferenceAVPacket::operator->() {
   return avPacket_;
 }
 

src/torchcodec/decoders/_core/FFMPEGCommon.h

@@ -71,37 +71,37 @@ using UniqueSwsContext =
 // These 2 classes share the same underlying AVPacket object. They are meant to
 // be used in tandem, like so:
 //
-// AutoFreedAVPacket autoFreedAVPacket; // <-- malloc for AVPacket happens here
+// AutoAVPacket autoAVPacket; // <-- malloc for AVPacket happens here
 // while(...){
-//   AutoUnrefedAVPacket packet(autoFreedAVPacket);
+//   ReferenceAVPacket packet(autoAVPacket);
 //   av_read_frame(..., packet.get());  <-- av_packet_ref() called by FFmpeg
 // } <-- av_packet_unref() called here
 //
 // This achieves a few desirable things:
 // - Memory allocation of the underlying AVPacket happens only once, when
-//   autoFreedAVPacket is created.
-// - av_packet_free() is called when autoFreedAVPacket gets out of scope
+//   autoAVPacket is created.
+// - av_packet_free() is called when autoAVPacket gets out of scope
 // - av_packet_unref() is automatically called when needed, i.e. at the end of
 //   each loop iteration (or when hitting break / continue). This prevents the
 //   risk of us forgetting to call it.
-class AutoFreedAVPacket {
-  friend class AutoUnrefedAVPacket;
+class AutoAVPacket {
+  friend class ReferenceAVPacket;
 
  private:
   AVPacket* avPacket_;
 
  public:
-  AutoFreedAVPacket();
-  ~AutoFreedAVPacket();
+  AutoAVPacket();
+  ~AutoAVPacket();
 };
 
-class AutoUnrefedAVPacket {
+class ReferenceAVPacket {
  private:
   AVPacket* avPacket_;
 
  public:
-  AutoUnrefedAVPacket(AutoFreedAVPacket& shared);
-  ~AutoUnrefedAVPacket();
+  ReferenceAVPacket(AutoAVPacket& shared);
+  ~ReferenceAVPacket();
   AVPacket* get();
   AVPacket* operator->();
 };

src/torchcodec/decoders/_core/VideoDecoder.cpp

@@ -573,9 +573,9 @@ void VideoDecoder::scanFileAndUpdateMetadataAndIndex() {
     return;
   }
 
-  AutoFreedAVPacket autoFreedAVPacket;
+  AutoAVPacket autoAVPacket;
   while (true) {
-    AutoUnrefedAVPacket packet(autoFreedAVPacket);
+    ReferenceAVPacket packet(autoAVPacket);
 
     // av_read_frame is a misleading name: it gets the next **packet**.
     int ffmpegStatus = av_read_frame(formatContext_.get(), packet.get());
@@ -806,7 +806,7 @@ VideoDecoder::RawDecodedOutput VideoDecoder::getDecodedOutputWithFilter(
   }
   // Need to get the next frame or error from PopFrame.
   UniqueAVFrame frame(av_frame_alloc());
-  AutoFreedAVPacket autoFreedAVPacket;
+  AutoAVPacket autoAVPacket;
   int ffmpegStatus = AVSUCCESS;
   bool reachedEOF = false;
   int frameStreamIndex = -1;
@@ -846,7 +846,7 @@ VideoDecoder::RawDecodedOutput VideoDecoder::getDecodedOutputWithFilter(
       // pulling frames from its internal buffers.
       continue;
     }
-    AutoUnrefedAVPacket packet(autoFreedAVPacket);
+    ReferenceAVPacket packet(autoAVPacket);
     ffmpegStatus = av_read_frame(formatContext_.get(), packet.get());
     decodeStats_.numPacketsRead++;
     if (ffmpegStatus == AVERROR_EOF) {