Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add option for the user to pass in ffmpeg thread count #291

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add option for the user to pass in ffmpeg thread count #291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e7c614d
Add option for the user to pass in ffmpeg thread count
ahmadsharif1 Oct 24, 2024
fcf2e91
.
ahmadsharif1 Oct 24, 2024
2d3fab9
Update src/torchcodec/decoders/_video_decoder.py
ahmadsharif1 Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion src/torchcodec/decoders/_video_decoder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ class VideoDecoder:
This can be either "NCHW" (default) or "NHWC", where N is the batch
size, C is the number of channels, H is the height, and W is the
width of the frames.
num_ffmpeg_threads (int, optional): The number of threads to use for decoding.
Use 1 for single-threaded decoding which may be best if you are running multiple
instances of ``VideoDecoder`` in parallel. Use a higher number for multi-threaded
decoding which is best if you are running a single instance of ``VideoDecoder``.
Default: 1.

.. note::

Expand All @@ -58,6 +63,7 @@ def __init__(
*,
stream_index: Optional[int] = None,
dimension_order: Literal["NCHW", "NHWC"] = "NCHW",
num_ffmpeg_threads: int = 1,
):
if isinstance(source, str):
self._decoder = core.create_from_file(source)
Expand All @@ -82,7 +88,10 @@ def __init__(

core.scan_all_streams_to_update_metadata(self._decoder)
core.add_video_stream(
self._decoder, stream_index=stream_index, dimension_order=dimension_order
self._decoder,
stream_index=stream_index,
dimension_order=dimension_order,
num_threads=num_ffmpeg_threads,
)

self.metadata, self.stream_index = _get_and_validate_stream_metadata(
Expand Down
5 changes: 3 additions & 2 deletions test/decoders/test_video_decoder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,9 @@ def test_create_fails(self):
with pytest.raises(ValueError, match="No valid stream found"):
decoder = VideoDecoder(NASA_VIDEO.path, stream_index=1) # noqa

def test_getitem_int(self):
decoder = VideoDecoder(NASA_VIDEO.path)
@pytest.mark.parametrize("num_ffmpeg_threads", (1, 4))
def test_getitem_int(self, num_ffmpeg_threads):
decoder = VideoDecoder(NASA_VIDEO.path, num_ffmpeg_threads=num_ffmpeg_threads)

ref_frame0 = NASA_VIDEO.get_frame_data_by_index(0)
ref_frame1 = NASA_VIDEO.get_frame_data_by_index(1)
Expand Down
Loading