HwCodecDetect 0.0.9__tar.gz → 0.1.0__tar.gz

{hwcodecdetect-0.0.9/src/HwCodecDetect.egg-info → hwcodecdetect-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: HwCodecDetect
-Version: 0.0.9
+Version: 0.1.0
 Summary: A cross-platform tool to automatically detect and test hardware video decoders/encoders using FFmpeg.
 Home-page: https://github.com/whyb/HwCodecDetect
 Author: whyb
@@ -25,6 +25,9 @@ Dynamic: requires-python
 
 # FFmpeg Hardware Codec Test Script(HwCodecDetect)
 <p align="center">
+    <a href="https://github.com/whyb/HwCodecDetect/actions/workflows/run-test.yml">
+        <img src="https://github.com/whyb/HwCodecDetect/actions/workflows/run-test.yml/badge.svg" />
+    </a>
     <a href="https://pypi.org/project/hwcodecdetect">
         <img src="https://badgen.net/pypi/v/hwcodecdetect?color=yellow" />
     </a>
@@ -35,7 +38,7 @@ Dynamic: requires-python
 
 [中文版](https://github.com/whyb/HwCodecDetect/blob/main/README.zh.md)
 
-Today's hardware-accelerated video codec landscape is a "field of a hundred schools of thought." To leverage the immense power of GPUs, hardware manufacturers have introduced their own acceleration frameworks and encoding standards, such as NVIDIA's NVEnc/NVDec, Intel's QSV, and AMD's AMF. Additionally, operating systems provide universal APIs like Microsoft's Media Foundation, DXVA, and D3D12VA, while the open-source community has developed cross-platform standards like VAAPI and Vulkan.
+Today's hardware-accelerated video codec landscape is a "field of a hundred schools of thought." To leverage the immense power of GPUs, hardware manufacturers have introduced their own acceleration frameworks and encoding standards, such as NVIDIA's NVEnc/NVDec, Intel's QSV, and AMD's AMF. Additionally, operating systems provide universal APIs like Microsoft's Media Foundation, DXVA2, and D3D12VA, while the open-source community has developed cross-platform standards like VAAPI and Vulkan.
 
 While this diversity drives technological progress, it also presents a challenge for users and developers. Due to historical issues and compatibility quirks, a single piece of hardware might support multiple encoders, but they can differ significantly in performance, supported formats, and resolutions. As a result, when using FFmpeg for hardware acceleration, it's not always clear which encoder is best suited for a specific device.
 
@@ -69,20 +72,39 @@ The script automatically tests and reports on the following major hardware decod
 
 
 ## How to Use
+You can install and use HwCodecDetect in two ways.
+### Method 1: Install via PyPI (Recommended)
+This is the easiest method if you just want to use the tool quickly.
+
+1. Install: Use pip to install HwCodecDetect from the official PyPI repository.
+    ```bash
+    pip install HwCodecDetect
+    ```
+
+2. Run: After installation, run the HwCodecDetect command directly from your terminal.
+    ```bash
+    HwCodecDetect
+    ```
 
-### 1. Install via PyPI
-```bash
-pip install HwCodecDetect
-```
+### Method 2: Install from Source
+Use this method if you have cloned the project source code from GitHub and want to run it locally.
 
-### 2. Run the Test
-```bash
-HwCodecDetect
-```
+1. Clone the repository: First, clone the project source code to your local machine.
+    ```bash
+    git clone https://github.com/whyb/HwCodecDetect.git
+    ```
 
+2. Install dependencies: Navigate into the project's root directory and use pip to install the required dependencies.
+    ```bash
+    cd HwCodecDetect
+    pip install .
+    ```
+
+3. Run: After the installation is complete, run the HwCodecDetect command directly.
+    ```bash
+    HwCodecDetect
+    ```
 
 ## Demo
 Here are some possible results from a local test run:
-![decoder test result](https://raw.githubusercontent.com/whyb/HwCodecDetect/main/imgs/decoder.png)
-
-![encoder test result](https://raw.githubusercontent.com/whyb/HwCodecDetect/main/imgs/encoder.png)
+![test result](https://raw.githubusercontent.com/whyb/HwCodecDetect/main/imgs/run_tests.png)

{hwcodecdetect-0.0.9 → hwcodecdetect-0.1.0}/README.md

@@ -1,5 +1,8 @@
 # FFmpeg Hardware Codec Test Script(HwCodecDetect)
 <p align="center">
+    <a href="https://github.com/whyb/HwCodecDetect/actions/workflows/run-test.yml">
+        <img src="https://github.com/whyb/HwCodecDetect/actions/workflows/run-test.yml/badge.svg" />
+    </a>
     <a href="https://pypi.org/project/hwcodecdetect">
         <img src="https://badgen.net/pypi/v/hwcodecdetect?color=yellow" />
     </a>
@@ -10,7 +13,7 @@
 
 [中文版](https://github.com/whyb/HwCodecDetect/blob/main/README.zh.md)
 
-Today's hardware-accelerated video codec landscape is a "field of a hundred schools of thought." To leverage the immense power of GPUs, hardware manufacturers have introduced their own acceleration frameworks and encoding standards, such as NVIDIA's NVEnc/NVDec, Intel's QSV, and AMD's AMF. Additionally, operating systems provide universal APIs like Microsoft's Media Foundation, DXVA, and D3D12VA, while the open-source community has developed cross-platform standards like VAAPI and Vulkan.
+Today's hardware-accelerated video codec landscape is a "field of a hundred schools of thought." To leverage the immense power of GPUs, hardware manufacturers have introduced their own acceleration frameworks and encoding standards, such as NVIDIA's NVEnc/NVDec, Intel's QSV, and AMD's AMF. Additionally, operating systems provide universal APIs like Microsoft's Media Foundation, DXVA2, and D3D12VA, while the open-source community has developed cross-platform standards like VAAPI and Vulkan.
 
 While this diversity drives technological progress, it also presents a challenge for users and developers. Due to historical issues and compatibility quirks, a single piece of hardware might support multiple encoders, but they can differ significantly in performance, supported formats, and resolutions. As a result, when using FFmpeg for hardware acceleration, it's not always clear which encoder is best suited for a specific device.
 
@@ -44,20 +47,39 @@ The script automatically tests and reports on the following major hardware decod
 
 
 ## How to Use
+You can install and use HwCodecDetect in two ways.
+### Method 1: Install via PyPI (Recommended)
+This is the easiest method if you just want to use the tool quickly.
+
+1. Install: Use pip to install HwCodecDetect from the official PyPI repository.
+    ```bash
+    pip install HwCodecDetect
+    ```
+
+2. Run: After installation, run the HwCodecDetect command directly from your terminal.
+    ```bash
+    HwCodecDetect
+    ```
 
-### 1. Install via PyPI
-```bash
-pip install HwCodecDetect
-```
+### Method 2: Install from Source
+Use this method if you have cloned the project source code from GitHub and want to run it locally.
 
-### 2. Run the Test
-```bash
-HwCodecDetect
-```
+1. Clone the repository: First, clone the project source code to your local machine.
+    ```bash
+    git clone https://github.com/whyb/HwCodecDetect.git
+    ```
 
+2. Install dependencies: Navigate into the project's root directory and use pip to install the required dependencies.
+    ```bash
+    cd HwCodecDetect
+    pip install .
+    ```
+
+3. Run: After the installation is complete, run the HwCodecDetect command directly.
+    ```bash
+    HwCodecDetect
+    ```
 
 ## Demo
 Here are some possible results from a local test run:
-![decoder test result](https://raw.githubusercontent.com/whyb/HwCodecDetect/main/imgs/decoder.png)
-
-![encoder test result](https://raw.githubusercontent.com/whyb/HwCodecDetect/main/imgs/encoder.png)
+![test result](https://raw.githubusercontent.com/whyb/HwCodecDetect/main/imgs/run_tests.png)

hwcodecdetect-0.1.0/VERSION

@@ -0,0 +1 @@
+0.1.0

{hwcodecdetect-0.0.9 → hwcodecdetect-0.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "HwCodecDetect"
-version = "0.0.9"
+version = "0.1.0"
 authors = [
   { name="whyb", email="whyber@outlook.com" },
 ]
@@ -28,7 +28,7 @@ classifiers = [
 ]
 
 [project.scripts]
-hwcodecdetect = "HwCodecDetect.run_tests:run_all_tests"
+hwcodecdetect = "HwCodecDetect.run_tests:main"
 
 [project.urls]
 Homepage = "https://github.com/whyb/HwCodecDetect"

{hwcodecdetect-0.0.9 → hwcodecdetect-0.1.0}/setup.py

@@ -37,7 +37,7 @@ setup(
     package_dir={"": "src"},
     entry_points={
         "console_scripts": [
-            "hwcodecdetect=HwCodecDetect.run_tests:run_all_tests"
+            "hwcodecdetect=HwCodecDetect.run_tests:main"
         ]
     },
     include_package_data=True,

hwcodecdetect-0.1.0/src/HwCodecDetect/__init__.py

@@ -0,0 +1,17 @@
+# HwCodecDetect/__init__.py
+import os
+from .install_ffmpeg_if_needed import install_ffmpeg_if_needed
+
+def _read_version():
+    try:
+        version_path = os.path.join(os.path.dirname(__file__), '..', '..', 'VERSION')
+        with open(version_path, encoding='utf-8') as f:
+            return f.read().strip()
+    except Exception:
+        return "0.0.0"
+
+__version__ = _read_version()
+__author__ = "whyb"
+__email__ = "whyber@outlook.com"
+__license__ = "BSD-3-Clause"
+__url__ = "https://github.com/whyb/HwCodecDetect"

{hwcodecdetect-0.0.9 → hwcodecdetect-0.1.0}/src/HwCodecDetect/run_tests.py

@@ -60,7 +60,7 @@ DECODER_TITLES = {
     ("d3d11va", "mpeg1"): "Microsoft Direct3D 11 Video Acceleration MPEG-1 Decoder(D3D11VA)",
     ("d3d11va", "mpeg2"): "Microsoft Direct3D 11 Video Acceleration MPEG-2 Decoder(D3D11VA)",
     ("d3d11va", "mpeg4"): "Microsoft Direct3D 11 Video Acceleration MPEG-4 Decoder(D3D11VA)",
-    ("d3d11va", "vp8"): "Microsoft Direct3D 11 Video Acceleration VP8 Decoder(DXVA2)",
+    ("d3d11va", "vp8"): "Microsoft Direct3D 11 Video Acceleration VP8 Decoder(D3D11VA)",
     ("d3d11va", "vp9"): "Microsoft Direct3D 11 Video Acceleration VP9 Decoder(D3D11VA)",
     ("vulkan", "h264"): "Vulkan Hardware H264 Decoder(Vulkan)",
     ("vulkan", "h265"): "Vulkan Hardware H265 Decoder(Vulkan)",
@@ -134,22 +134,27 @@ ALL_CODECS = {
 CONCURRENT_ENCODER_COUNT = 8
 CONCURRENT_DECODER_COUNT = 16
 
-def _run_ffmpeg_command(command):
+def _run_ffmpeg_command(command, verbose):
     """Executes an FFmpeg command and returns True on success, False on failure."""
     try:
+        stdout = subprocess.PIPE if verbose else subprocess.DEVNULL
+        stderr = subprocess.PIPE if verbose else subprocess.DEVNULL
         result = subprocess.run(
             command,
             check=True,
-            stdout=subprocess.DEVNULL,
-            stderr=subprocess.DEVNULL,
+            stdout=stdout,
+            stderr=stderr,
+            text=True
         )
-        return result.returncode == 0
-    except (subprocess.CalledProcessError, FileNotFoundError):
-        return False
+        return (result.returncode == 0, result.stdout, result.stderr)
+    except subprocess.CalledProcessError as e:
+        return (False, e.stdout, e.stderr)
+    except FileNotFoundError:
+        return (False, "", "FFmpeg executable not found")
 
 def _run_encoder_test_single(test_data):
     """Runs a single encoder test and returns the result."""
-    codec, encoder, res_name, res_size, test_dir = test_data
+    codec, encoder, res_name, res_size, test_dir, verbose = test_data
     file_ext = ".webm" if codec in ["vp8", "vp9"] else ".mp4"
     output_file = os.path.join(test_dir, f"{encoder}_{res_name}{file_ext}")
 
@@ -170,11 +175,24 @@ def _run_encoder_test_single(test_data):
         command.insert(9, "-dual_gfx")
         command.insert(10, "0")
 
-    status = "succeeded" if _run_ffmpeg_command(command) else "failed"
+    if verbose: # if verbose then replace loglevel to verbose
+        command[2] = "error"
+
+    success, stdout, stderr = _run_ffmpeg_command(command, verbose)
+    status = "succeeded" if success else "failed"
+
+    if verbose:
+        if stdout:
+            print(f"Output:\n{stdout}")
+        if stderr:
+            print(f"Error Output:\n{stderr}")
+        print(f"Test Result: {status}")
+
     title = ENCODER_TITLES.get((encoder, codec), f"{encoder.upper()} Encoder:")
     return title, res_name, status
 
-def _run_encoder_tests(test_dir, max_workers):
+
+def _run_encoder_tests(test_dir, max_workers, verbose):
     """Runs hardware encoder tests using a thread pool."""
     results = defaultdict(dict)
     
@@ -184,7 +202,7 @@ def _run_encoder_tests(test_dir, max_workers):
     for codec, info in ENCODERS.items():
         for encoder in info['hw_encoders']:
             for res_name, res_size in RESOLUTIONS.items():
-                tasks.append((codec, encoder, res_name, res_size, test_dir))
+                tasks.append((codec, encoder, res_name, res_size, test_dir, verbose))
 
     with ThreadPoolExecutor(max_workers=max_workers) as executor:
         futures = [executor.submit(_run_encoder_test_single, task) for task in tasks]
@@ -197,7 +215,7 @@ def _run_encoder_tests(test_dir, max_workers):
 
 def _run_decoder_test_single(test_data):
     """Runs a single decoder test and returns the result."""
-    codec, hw_decoder, res_name, res_size, test_dir = test_data
+    codec, hw_decoder, res_name, res_size, test_dir, verbose = test_data
     file_ext = ".webm" if codec in ["vp8", "vp9"] else ".mp4"
     test_file_path = os.path.join(test_dir, f"{codec}_{res_name}{file_ext}")
 
@@ -216,7 +234,7 @@ def _run_decoder_test_single(test_data):
             "-frames:v", "1", "-c:v", cpu_lib, "-pixel_format", "yuv420p",
             test_file_path,
         ]
-        if not _run_ffmpeg_command(command):
+        if not _run_ffmpeg_command(command, verbose):
             title = DECODER_TITLES.get((hw_decoder, codec), f"{hw_decoder.upper()} Decoder:")
             return title, res_name, "skipped"
 
@@ -250,13 +268,25 @@ def _run_decoder_test_single(test_data):
             "-c:v", "libx264", "-preset", "ultrafast",
             "-f", "null", "null",
         ]
-    
-    status = "succeeded" if _run_ffmpeg_command(command) else "failed"
+
+    if verbose: # if verbose then replace loglevel to verbose
+        command[2] = "error"
+
+    success, stdout, stderr = _run_ffmpeg_command(command, verbose)
+    status = "succeeded" if success else "failed"
+
+    if verbose:
+        if stdout:
+            print(f"Output:\n{stdout}")
+        if stderr:
+            print(f"Error Output:\n{stderr}")
+        print(f"Test Result: {status}")
+
     title = DECODER_TITLES.get((hw_decoder, codec), f"{hw_decoder.upper()} Decoder:")
     return title, res_name, status
 
 
-def _run_decoder_tests(test_dir, max_workers):
+def _run_decoder_tests(test_dir, max_workers, verbose):
     """Runs hardware decoder tests using a thread pool."""
     results = defaultdict(dict)
 
@@ -266,8 +296,8 @@ def _run_decoder_tests(test_dir, max_workers):
     for codec, info in DECODERS.items():
         for hw_decoder in info['hw_decoders']:
             for res_name, res_size in RESOLUTIONS.items():
-                tasks.append((codec, hw_decoder, res_name, res_size, test_dir))
-    
+                tasks.append((codec, hw_decoder, res_name, res_size, test_dir, verbose))
+
     with ThreadPoolExecutor(max_workers=max_workers) as executor:
         futures = [executor.submit(_run_decoder_test_single, task) for task in tasks]
 
@@ -297,7 +327,7 @@ def _print_summary_table(results):
 
     res_width = max(len(res) for res in resolutions)
     row_header_width = max([_get_display_width(t) for t in results.keys()] + [20, _get_display_width("Decoder"), _get_display_width("Encoder")])
-    
+
     if decoder_titles:
         print("\n" + "-" * (row_header_width + 3 + (res_width + 3) * len(resolutions)))
         header_text = "Decoder"
@@ -308,7 +338,7 @@ def _print_summary_table(results):
             header_row += f" {res.center(res_width)} |"
         print(header_row)
         print("-" * (row_header_width + 3 + (res_width + 3) * len(resolutions)))
-        
+
         for title in decoder_titles:
             padding_needed = row_header_width - _get_display_width(title)
             row_string = f"| {title}{' ' * padding_needed} |"
@@ -332,7 +362,7 @@ def _print_summary_table(results):
             header_row += f" {res.center(res_width)} |"
         print(header_row)
         print("-" * (row_header_width + 3 + (res_width + 3) * len(resolutions)))
-        
+
         for title in encoder_titles:
             padding_needed = row_header_width - _get_display_width(title)
             row_string = f"| {title}{' ' * padding_needed} |"
@@ -361,8 +391,8 @@ def run_all_tests(args):
         shutil.rmtree(temp_dir)
     os.makedirs(temp_dir)
         
-    encoder_results = _run_encoder_tests(temp_dir, args.encoder_count)
-    decoder_results = _run_decoder_tests(temp_dir, args.decoder_count)
+    encoder_results = _run_encoder_tests(temp_dir, args.encoder_count, args.verbose)
+    decoder_results = _run_decoder_tests(temp_dir, args.decoder_count, args.verbose)
 
     all_results = {}
     all_results.update(encoder_results)
@@ -424,6 +454,12 @@ def main():
         help="Show program's version number and exit."
     )
 
+    parser.add_argument(
+        '--verbose', 
+        action='store_true', 
+        help='Print detailed information for each test'
+    )
+
     args = parser.parse_args()
     run_all_tests(args)
 

hwcodecdetect-0.1.0/src/HwCodecDetect/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

{hwcodecdetect-0.0.9 → hwcodecdetect-0.1.0/src/HwCodecDetect.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: HwCodecDetect
-Version: 0.0.9
+Version: 0.1.0
 Summary: A cross-platform tool to automatically detect and test hardware video decoders/encoders using FFmpeg.
 Home-page: https://github.com/whyb/HwCodecDetect
 Author: whyb
@@ -25,6 +25,9 @@ Dynamic: requires-python
 
 # FFmpeg Hardware Codec Test Script(HwCodecDetect)
 <p align="center">
+    <a href="https://github.com/whyb/HwCodecDetect/actions/workflows/run-test.yml">
+        <img src="https://github.com/whyb/HwCodecDetect/actions/workflows/run-test.yml/badge.svg" />
+    </a>
     <a href="https://pypi.org/project/hwcodecdetect">
         <img src="https://badgen.net/pypi/v/hwcodecdetect?color=yellow" />
     </a>
@@ -35,7 +38,7 @@ Dynamic: requires-python
 
 [中文版](https://github.com/whyb/HwCodecDetect/blob/main/README.zh.md)
 
-Today's hardware-accelerated video codec landscape is a "field of a hundred schools of thought." To leverage the immense power of GPUs, hardware manufacturers have introduced their own acceleration frameworks and encoding standards, such as NVIDIA's NVEnc/NVDec, Intel's QSV, and AMD's AMF. Additionally, operating systems provide universal APIs like Microsoft's Media Foundation, DXVA, and D3D12VA, while the open-source community has developed cross-platform standards like VAAPI and Vulkan.
+Today's hardware-accelerated video codec landscape is a "field of a hundred schools of thought." To leverage the immense power of GPUs, hardware manufacturers have introduced their own acceleration frameworks and encoding standards, such as NVIDIA's NVEnc/NVDec, Intel's QSV, and AMD's AMF. Additionally, operating systems provide universal APIs like Microsoft's Media Foundation, DXVA2, and D3D12VA, while the open-source community has developed cross-platform standards like VAAPI and Vulkan.
 
 While this diversity drives technological progress, it also presents a challenge for users and developers. Due to historical issues and compatibility quirks, a single piece of hardware might support multiple encoders, but they can differ significantly in performance, supported formats, and resolutions. As a result, when using FFmpeg for hardware acceleration, it's not always clear which encoder is best suited for a specific device.
 
@@ -69,20 +72,39 @@ The script automatically tests and reports on the following major hardware decod
 
 
 ## How to Use
+You can install and use HwCodecDetect in two ways.
+### Method 1: Install via PyPI (Recommended)
+This is the easiest method if you just want to use the tool quickly.
+
+1. Install: Use pip to install HwCodecDetect from the official PyPI repository.
+    ```bash
+    pip install HwCodecDetect
+    ```
+
+2. Run: After installation, run the HwCodecDetect command directly from your terminal.
+    ```bash
+    HwCodecDetect
+    ```
 
-### 1. Install via PyPI
-```bash
-pip install HwCodecDetect
-```
+### Method 2: Install from Source
+Use this method if you have cloned the project source code from GitHub and want to run it locally.
 
-### 2. Run the Test
-```bash
-HwCodecDetect
-```
+1. Clone the repository: First, clone the project source code to your local machine.
+    ```bash
+    git clone https://github.com/whyb/HwCodecDetect.git
+    ```
 
+2. Install dependencies: Navigate into the project's root directory and use pip to install the required dependencies.
+    ```bash
+    cd HwCodecDetect
+    pip install .
+    ```
+
+3. Run: After the installation is complete, run the HwCodecDetect command directly.
+    ```bash
+    HwCodecDetect
+    ```
 
 ## Demo
 Here are some possible results from a local test run:
-![decoder test result](https://raw.githubusercontent.com/whyb/HwCodecDetect/main/imgs/decoder.png)
-
-![encoder test result](https://raw.githubusercontent.com/whyb/HwCodecDetect/main/imgs/encoder.png)
+![test result](https://raw.githubusercontent.com/whyb/HwCodecDetect/main/imgs/run_tests.png)

hwcodecdetect-0.1.0/src/HwCodecDetect.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+hwcodecdetect = HwCodecDetect.run_tests:main

hwcodecdetect-0.0.9/VERSION

@@ -1 +0,0 @@
-0.0.9

hwcodecdetect-0.0.9/src/HwCodecDetect/__init__.py

@@ -1,9 +0,0 @@
-# HwCodecDetect/__init__.py
-
-from .install_ffmpeg_if_needed import install_ffmpeg_if_needed
-from .version import __version__
-
-__author__ = "whyb"
-__email__ = "whyber@outlook.com"
-__license__ = "BSD-3-Clause"
-__url__ = "https://github.com/whyb/HwCodecDetect"

hwcodecdetect-0.0.9/src/HwCodecDetect/version.py

@@ -1 +0,0 @@
-__version__ = "0.0.9"

hwcodecdetect-0.0.9/src/HwCodecDetect.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-hwcodecdetect = HwCodecDetect.run_tests:run_all_tests