Move torchcodec/decoders/_core into torchcodec/_core (#609)

NicolasHug · web-flow · commit 0eb7eb02b911 · 2025-04-02T09:56:10.000+01:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.18)
 project(TorchCodec)
 
-add_subdirectory(src/torchcodec/decoders/_core)
+add_subdirectory(src/torchcodec/_core)
 
 
 option(BUILD_TESTS "Build tests" OFF)
diff --git a/benchmarks/decoders/benchmark_decoders_library.py b/benchmarks/decoders/benchmark_decoders_library.py
@@ -13,9 +13,8 @@
 
 import torch
 import torch.utils.benchmark as benchmark
-from torchcodec.decoders import VideoDecoder, VideoStreamMetadata
 
-from torchcodec.decoders._core import (
+from torchcodec._core import (
     _add_video_stream,
     create_from_file,
     get_frames_at_indices,
@@ -24,6 +23,7 @@
     get_next_frame,
     seek_to_pts,
 )
+from torchcodec.decoders import VideoDecoder, VideoStreamMetadata
 
 torch._dynamo.config.cache_size_limit = 100
 torch._dynamo.config.capture_dynamic_output_shape_ops = True
diff --git a/benchmarks/decoders/gpu_benchmark.py b/benchmarks/decoders/gpu_benchmark.py
@@ -25,7 +25,7 @@ def decode_full_video(video_path, decode_device_string, resize_device_string):
     # We use the core API instead of SimpleVideoDecoder because the core API
     # allows us to natively resize as part of the decode step.
     print(f"{decode_device_string=} {resize_device_string=}")
-    decoder = torchcodec.decoders._core.create_from_file(video_path)
+    decoder = torchcodec._core.create_from_file(video_path)
     num_threads = None
     if "cuda" in decode_device_string:
         num_threads = 1
@@ -34,7 +34,7 @@ def decode_full_video(video_path, decode_device_string, resize_device_string):
     if "native" in resize_device_string:
         width = RESIZED_WIDTH
         height = RESIZED_HEIGHT
-    torchcodec.decoders._core._add_video_stream(
+    torchcodec._core._add_video_stream(
         decoder,
         stream_index=-1,
         device=decode_device_string,
@@ -47,7 +47,7 @@ def decode_full_video(video_path, decode_device_string, resize_device_string):
     frame_count = 0
     while True:
         try:
-            frame, *_ = torchcodec.decoders._core.get_next_frame(decoder)
+            frame, *_ = torchcodec._core.get_next_frame(decoder)
             if resize_device_string != "none" and "native" not in resize_device_string:
                 frame = transfer_and_resize_frame(frame, resize_device_string)
 
diff --git a/benchmarks/decoders/memprofile_decoders.py b/benchmarks/decoders/memprofile_decoders.py
@@ -9,7 +9,7 @@
 
 import torch
 from memory_profiler import profile
-from torchcodec.decoders._core import add_video_stream, create_from_file, get_next_frame
+from torchcodec._core import add_video_stream, create_from_file, get_next_frame
 
 torch._dynamo.config.cache_size_limit = 100
 torch._dynamo.config.capture_dynamic_output_shape_ops = True
diff --git a/src/torchcodec/_core/AVIOBytesContext.cpp b/src/torchcodec/_core/AVIOBytesContext.cpp
@@ -4,7 +4,7 @@
 // This source code is licensed under the BSD-style license found in the
 // LICENSE file in the root directory of this source tree.
 
-#include "src/torchcodec/decoders/_core/AVIOBytesContext.h"
+#include "src/torchcodec/_core/AVIOBytesContext.h"
 #include <torch/types.h>
 
 namespace facebook::torchcodec {
diff --git a/src/torchcodec/_core/AVIOBytesContext.h b/src/torchcodec/_core/AVIOBytesContext.h
@@ -6,7 +6,7 @@
 
 #pragma once
 
-#include "src/torchcodec/decoders/_core/AVIOContextHolder.h"
+#include "src/torchcodec/_core/AVIOContextHolder.h"
 
 namespace facebook::torchcodec {
 
diff --git a/src/torchcodec/_core/AVIOContextHolder.cpp b/src/torchcodec/_core/AVIOContextHolder.cpp
@@ -4,7 +4,7 @@
 // This source code is licensed under the BSD-style license found in the
 // LICENSE file in the root directory of this source tree.
 
-#include "src/torchcodec/decoders/_core/AVIOContextHolder.h"
+#include "src/torchcodec/_core/AVIOContextHolder.h"
 #include <torch/types.h>
 
 namespace facebook::torchcodec {
diff --git a/src/torchcodec/_core/AVIOContextHolder.h b/src/torchcodec/_core/AVIOContextHolder.h
@@ -6,7 +6,7 @@
 
 #pragma once
 
-#include "src/torchcodec/decoders/_core/FFMPEGCommon.h"
+#include "src/torchcodec/_core/FFMPEGCommon.h"
 
 namespace facebook::torchcodec {
 
diff --git a/src/torchcodec/_core/AVIOFileLikeContext.cpp b/src/torchcodec/_core/AVIOFileLikeContext.cpp
@@ -4,7 +4,7 @@
 // This source code is licensed under the BSD-style license found in the
 // LICENSE file in the root directory of this source tree.
 
-#include "src/torchcodec/decoders/_core/AVIOFileLikeContext.h"
+#include "src/torchcodec/_core/AVIOFileLikeContext.h"
 #include <torch/types.h>
 
 namespace facebook::torchcodec {
diff --git a/src/torchcodec/_core/AVIOFileLikeContext.h b/src/torchcodec/_core/AVIOFileLikeContext.h
@@ -9,7 +9,7 @@
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>
 
-#include "src/torchcodec/decoders/_core/AVIOContextHolder.h"
+#include "src/torchcodec/_core/AVIOContextHolder.h"
 
 namespace py = pybind11;
 
diff --git a/src/torchcodec/_core/CMakeLists.txt b/src/torchcodec/_core/CMakeLists.txt
@@ -20,7 +20,7 @@ function(make_torchcodec_sublibrary
     set_target_properties(${library_name} PROPERTIES CXX_STANDARD 17)
     target_include_directories(${library_name}
         PRIVATE
-        ./../../../../
+        ./../../../
         "${TORCH_INSTALL_PREFIX}/include"
         ${Python3_INCLUDE_DIRS}
     )
diff --git a/src/torchcodec/_core/CPUOnlyDevice.cpp b/src/torchcodec/_core/CPUOnlyDevice.cpp
@@ -1,5 +1,5 @@
 #include <torch/types.h>
-#include "src/torchcodec/decoders/_core/DeviceInterface.h"
+#include "src/torchcodec/_core/DeviceInterface.h"
 
 namespace facebook::torchcodec {
 
diff --git a/src/torchcodec/_core/CudaDevice.cpp b/src/torchcodec/_core/CudaDevice.cpp
@@ -4,9 +4,9 @@
 #include <torch/types.h>
 #include <mutex>
 
-#include "src/torchcodec/decoders/_core/DeviceInterface.h"
-#include "src/torchcodec/decoders/_core/FFMPEGCommon.h"
-#include "src/torchcodec/decoders/_core/VideoDecoder.h"
+#include "src/torchcodec/_core/DeviceInterface.h"
+#include "src/torchcodec/_core/FFMPEGCommon.h"
+#include "src/torchcodec/_core/VideoDecoder.h"
 
 extern "C" {
 #include <libavutil/hwcontext_cuda.h>
diff --git a/src/torchcodec/_core/DeviceInterface.h b/src/torchcodec/_core/DeviceInterface.h
@@ -11,7 +11,7 @@
 #include <stdexcept>
 #include <string>
 #include "FFMPEGCommon.h"
-#include "src/torchcodec/decoders/_core/VideoDecoder.h"
+#include "src/torchcodec/_core/VideoDecoder.h"
 
 namespace facebook::torchcodec {
 
diff --git a/src/torchcodec/_core/FFMPEGCommon.cpp b/src/torchcodec/_core/FFMPEGCommon.cpp
@@ -4,7 +4,7 @@
 // This source code is licensed under the BSD-style license found in the
 // LICENSE file in the root directory of this source tree.
 
-#include "src/torchcodec/decoders/_core/FFMPEGCommon.h"
+#include "src/torchcodec/_core/FFMPEGCommon.h"
 
 #include <c10/util/Exception.h>
 
diff --git a/src/torchcodec/_core/FFMPEGCommon.h b/src/torchcodec/_core/FFMPEGCommon.h
diff --git a/src/torchcodec/_core/VideoDecoder.cpp b/src/torchcodec/_core/VideoDecoder.cpp
@@ -4,7 +4,7 @@
 // This source code is licensed under the BSD-style license found in the
 // LICENSE file in the root directory of this source tree.
 
-#include "src/torchcodec/decoders/_core/VideoDecoder.h"
+#include "src/torchcodec/_core/VideoDecoder.h"
 #include <cstdint>
 #include <cstdio>
 #include <cstdlib>
@@ -13,7 +13,7 @@
 #include <sstream>
 #include <stdexcept>
 #include <string_view>
-#include "src/torchcodec/decoders/_core/DeviceInterface.h"
+#include "src/torchcodec/_core/DeviceInterface.h"
 #include "torch/types.h"
 
 extern "C" {
diff --git a/src/torchcodec/_core/VideoDecoder.h b/src/torchcodec/_core/VideoDecoder.h
@@ -12,8 +12,8 @@
 #include <ostream>
 #include <string_view>
 
-#include "src/torchcodec/decoders/_core/AVIOContextHolder.h"
-#include "src/torchcodec/decoders/_core/FFMPEGCommon.h"
+#include "src/torchcodec/_core/AVIOContextHolder.h"
+#include "src/torchcodec/_core/FFMPEGCommon.h"
 
 namespace facebook::torchcodec {
 
diff --git a/src/torchcodec/_core/__init__.py b/src/torchcodec/_core/__init__.py
diff --git a/src/torchcodec/_core/_metadata.py b/src/torchcodec/_core/_metadata.py
@@ -12,7 +12,7 @@
 
 import torch
 
-from torchcodec.decoders._core.ops import (
+from torchcodec._core.ops import (
     _get_container_json_metadata,
     _get_stream_json_metadata,
     create_from_file,
diff --git a/src/torchcodec/_core/custom_ops.cpp b/src/torchcodec/_core/custom_ops.cpp
@@ -10,8 +10,8 @@
 #include <string>
 #include "c10/core/SymIntArrayRef.h"
 #include "c10/util/Exception.h"
-#include "src/torchcodec/decoders/_core/AVIOBytesContext.h"
-#include "src/torchcodec/decoders/_core/VideoDecoder.h"
+#include "src/torchcodec/_core/AVIOBytesContext.h"
+#include "src/torchcodec/_core/VideoDecoder.h"
 
 namespace facebook::torchcodec {
 
@@ -25,7 +25,7 @@ namespace facebook::torchcodec {
 //   https://github.com/pytorch/pytorch/tree/main/aten/src/ATen/native#readme
 TORCH_LIBRARY(torchcodec_ns, m) {
   m.impl_abstract_pystub(
-      "torchcodec.decoders._core.ops", "//pytorch/torchcodec:torchcodec");
+      "torchcodec._core.ops", "//pytorch/torchcodec:torchcodec");
   m.def("create_from_file(str filename, str? seek_mode=None) -> Tensor");
   m.def(
       "create_from_tensor(Tensor video_tensor, str? seek_mode=None) -> Tensor");
diff --git a/src/torchcodec/_core/fetch_and_expose_non_gpl_ffmpeg_libs.cmake b/src/torchcodec/_core/fetch_and_expose_non_gpl_ffmpeg_libs.cmake
diff --git a/src/torchcodec/_core/ops.py b/src/torchcodec/_core/ops.py
diff --git a/src/torchcodec/_core/pybind_ops.cpp b/src/torchcodec/_core/pybind_ops.cpp
@@ -9,8 +9,8 @@
 #include <cstdint>
 #include <string>
 
-#include "src/torchcodec/decoders/_core/AVIOFileLikeContext.h"
-#include "src/torchcodec/decoders/_core/VideoDecoder.h"
+#include "src/torchcodec/_core/AVIOFileLikeContext.h"
+#include "src/torchcodec/_core/VideoDecoder.h"
 
 namespace py = pybind11;
 
diff --git a/src/torchcodec/_samplers/video_clip_sampler.py b/src/torchcodec/_samplers/video_clip_sampler.py
@@ -13,7 +13,7 @@
 import torch
 from torch import nn, Tensor
 
-from torchcodec.decoders._core import (
+from torchcodec._core import (
     add_video_stream,
     create_from_tensor,
     get_frames_at_indices,
diff --git a/src/torchcodec/decoders/__init__.py b/src/torchcodec/decoders/__init__.py
@@ -4,8 +4,8 @@
 # This source code is licensed under the BSD-style license found in the
 # LICENSE file in the root directory of this source tree.
 
+from .._core import AudioStreamMetadata, VideoStreamMetadata
 from ._audio_decoder import AudioDecoder  # noqa
-from ._core import AudioStreamMetadata, VideoStreamMetadata
 from ._video_decoder import VideoDecoder  # noqa
 
 SimpleVideoDecoder = VideoDecoder
diff --git a/src/torchcodec/decoders/_audio_decoder.py b/src/torchcodec/decoders/_audio_decoder.py
@@ -9,8 +9,7 @@
 
 from torch import Tensor
 
-from torchcodec import AudioSamples
-from torchcodec.decoders import _core as core
+from torchcodec import _core as core, AudioSamples
 from torchcodec.decoders._decoder_utils import (
     create_decoder,
     ERROR_REPORTING_INSTRUCTIONS,
diff --git a/src/torchcodec/decoders/_decoder_utils.py b/src/torchcodec/decoders/_decoder_utils.py
@@ -9,7 +9,7 @@
 from typing import Union
 
 from torch import Tensor
-from torchcodec.decoders import _core as core
+from torchcodec import _core as core
 
 ERROR_REPORTING_INSTRUCTIONS = """
 This should never happen. Please report an issue following the steps in
diff --git a/src/torchcodec/decoders/_video_decoder.py b/src/torchcodec/decoders/_video_decoder.py
@@ -10,8 +10,7 @@
 
 from torch import device, Tensor
 
-from torchcodec import Frame, FrameBatch
-from torchcodec.decoders import _core as core
+from torchcodec import _core as core, Frame, FrameBatch
 from torchcodec.decoders._decoder_utils import (
     create_decoder,
     ERROR_REPORTING_INSTRUCTIONS,
diff --git a/test/decoders/VideoDecoderTest.cpp b/test/decoders/VideoDecoderTest.cpp
@@ -4,8 +4,8 @@
 // This source code is licensed under the BSD-style license found in the
 // LICENSE file in the root directory of this source tree.
 
-#include "src/torchcodec/decoders/_core/VideoDecoder.h"
-#include "src/torchcodec/decoders/_core/AVIOBytesContext.h"
+#include "src/torchcodec/_core/VideoDecoder.h"
+#include "src/torchcodec/_core/AVIOBytesContext.h"
 
 #include <c10/util/Flags.h>
 #include <gtest/gtest.h>
diff --git a/test/decoders/manual_smoke_test.py b/test/decoders/manual_smoke_test.py
@@ -11,10 +11,10 @@
 
 print(f"{torchcodec.__version__ = }")
 
-decoder = torchcodec.decoders._core.create_from_file(
+decoder = torchcodec._core.create_from_file(
     str(Path(__file__).parent / "../resources/nasa_13013.mp4")
 )
-torchcodec.decoders._core.scan_all_streams_to_update_metadata(decoder)
-torchcodec.decoders._core.add_video_stream(decoder, stream_index=3)
-frame, _, _ = torchcodec.decoders._core.get_frame_at_index(decoder, frame_index=180)
+torchcodec._core.scan_all_streams_to_update_metadata(decoder)
+torchcodec._core.add_video_stream(decoder, stream_index=3)
+frame, _, _ = torchcodec._core.get_frame_at_index(decoder, frame_index=180)
 write_png(frame, "frame180.png")
diff --git a/test/decoders/test_decoders.py b/test/decoders/test_decoders.py
@@ -9,11 +9,14 @@
 import numpy
 import pytest
 import torch
-from torchcodec import FrameBatch
 
-from torchcodec.decoders import _core, VideoDecoder, VideoStreamMetadata
-from torchcodec.decoders._audio_decoder import AudioDecoder
-from torchcodec.decoders._core._metadata import AudioStreamMetadata
+from torchcodec import _core, FrameBatch
+from torchcodec.decoders import (
+    AudioDecoder,
+    AudioStreamMetadata,
+    VideoDecoder,
+    VideoStreamMetadata,
+)
 
 from ..utils import (
     assert_frames_equal,
diff --git a/test/decoders/test_metadata.py b/test/decoders/test_metadata.py
@@ -7,16 +7,16 @@
 import functools
 
 import pytest
-from torchcodec.decoders import AudioDecoder, VideoDecoder
 
-from torchcodec.decoders._core import (
+from torchcodec._core import (
     AudioStreamMetadata,
     create_from_file,
     get_container_metadata,
     get_container_metadata_from_header,
     get_ffmpeg_library_versions,
     VideoStreamMetadata,
 )
+from torchcodec.decoders import AudioDecoder, VideoDecoder
 
 from ..utils import NASA_AUDIO_MP3, NASA_VIDEO
 
diff --git a/test/decoders/test_ops.py b/test/decoders/test_ops.py
@@ -16,7 +16,7 @@
 
 import torch
 
-from torchcodec.decoders._core import (
+from torchcodec._core import (
     _add_video_stream,
     _test_frame_pts_equality,
     add_audio_stream,
diff --git a/test/utils.py b/test/utils.py
@@ -12,7 +12,7 @@
 
 import torch
 
-from torchcodec.decoders._core import get_ffmpeg_library_versions
+from torchcodec._core import get_ffmpeg_library_versions
 
 
 # Decorator for skipping CUDA tests when CUDA isn't available. The tests are
