video-diff-checker 0.1.0__py3-none-any.whl

video_diff_checker/__init__.py

@@ -0,0 +1,3 @@
+"""Video Diff Checker — pixel-level video comparison tool."""
+
+__version__ = "0.1.0"

video_diff_checker/cli.py

@@ -0,0 +1,629 @@
+"""CLI エントリポイントとサブコマンド構造モジュール。
+
+メインパーサーの構築、6 サブコマンドの登録、引数解析、
+および検証・ディスパッチを行う。
+"""
+
+from __future__ import annotations
+
+import argparse
+import sys
+from pathlib import Path
+
+from video_diff_checker import __version__
+from video_diff_checker.common_options import create_common_parser
+from video_diff_checker.ffmpeg_utils import (
+    FFmpegNotFoundError,
+    FFmpegVersionError,
+    verify_ffmpeg,
+)
+from video_diff_checker.gpu_utils import verify_gpu
+from video_diff_checker.logger import setup_logger
+from video_diff_checker.messages import (
+    COMPARE_DETECT_STAGE_COMPLETE,
+    COMPARE_DIFF_STAGE_COMPLETE,
+    COMPARE_GRID_STAGE_COMPLETE,
+    DETECT_NO_SEGMENTS,
+    DIFF_GPU_NOT_SUPPORTED,
+    SUBCOMMAND_NOT_IMPLEMENTED,
+)
+
+SUBCOMMANDS: list[dict[str, str]] = [
+    {"name": "compare", "help": "差分検出・抽出・グリッド生成を一括実行する"},
+    {"name": "diff", "help": "フレーム単位のピクセル差分を検出する"},
+    {"name": "detect", "help": "差分スコアから変化区間を特定する"},
+    {"name": "extract", "help": "変化区間のパート動画を切り出す"},
+    {"name": "grid", "help": "2×2 グリッド比較動画を生成する"},
+    {"name": "report", "help": "変更サマリーレポートを生成する"},
+]
+
+
+def stub_handler(args: argparse.Namespace) -> int:
+    """未実装サブコマンドのスタブハンドラ。メッセージ表示後に終了コード 1 を返す。"""
+    print(SUBCOMMAND_NOT_IMPLEMENTED.format(command=args.subcommand))
+    return 1
+
+
+def diff_handler(args: argparse.Namespace) -> int:
+    """diff サブコマンドのエントリポイント。
+
+    Returns:
+        終了コード (0: 成功, 1: エラー)
+    """
+    from video_diff_checker.diff.models import DiffConfig
+    from video_diff_checker.diff.runner import DEFAULT_OUTPUT_DIR
+    from video_diff_checker.diff.runner import run_diff as _run_diff
+
+    if args.gpu:
+        print(DIFF_GPU_NOT_SUPPORTED)
+
+    output_dir = Path(args.output) if args.output else DEFAULT_OUTPUT_DIR
+    config = DiffConfig(
+        old_path=Path(args.old),
+        new_path=Path(args.new),
+        output_dir=output_dir,
+        verbose=args.verbose,
+    )
+
+    try:
+        _run_diff(config)
+    except Exception as exc:
+        print(str(exc), file=sys.stderr)
+        return 1
+
+    return 0
+
+
+def compare_handler(args: argparse.Namespace) -> int:
+    """compare サブコマンドのエントリポイント。
+
+    パイプラインの各ステージ（diff → detect → extract → grid）を順次実行する。
+    現時点では diff ステージ（F-01）のみ実装済み。
+
+    Returns:
+        終了コード (0: 成功, 1: エラー)
+    """
+    from video_diff_checker.diff.models import DiffConfig
+    from video_diff_checker.diff.runner import DEFAULT_OUTPUT_DIR
+    from video_diff_checker.diff.runner import run_diff as _run_diff
+
+    if args.gpu:
+        print(DIFF_GPU_NOT_SUPPORTED)
+
+    output_dir = Path(args.output) if args.output else DEFAULT_OUTPUT_DIR
+    config = DiffConfig(
+        old_path=Path(args.old),
+        new_path=Path(args.new),
+        output_dir=output_dir,
+        verbose=args.verbose,
+    )
+
+    try:
+        diff_result = _run_diff(config)
+    except Exception as exc:
+        print(str(exc), file=sys.stderr)
+        return 1
+
+    print(
+        COMPARE_DIFF_STAGE_COMPLETE.format(
+            diff_video=diff_result.diff_video,
+            scores_csv=diff_result.scores_csv,
+        )
+    )
+
+    # F-02: detect/extract ステージ
+    from video_diff_checker.detect.runner import run_detect_extract
+
+    try:
+        detect_result = run_detect_extract(
+            diff_result,
+            threshold=args.threshold,
+            margin=args.margin,
+            merge_gap=args.merge_gap,
+            output_dir=output_dir,
+        )
+    except Exception as exc:
+        print(str(exc), file=sys.stderr)
+        return 1
+
+    if not detect_result.segments:
+        print(DETECT_NO_SEGMENTS)
+        return 0
+
+    print(
+        COMPARE_DETECT_STAGE_COMPLETE.format(
+            segment_count=len(detect_result.segments),
+        )
+    )
+
+    # F-03: grid ステージ
+    from video_diff_checker.grid.runner import run_grid_pipeline
+
+    try:
+        grid_result = run_grid_pipeline(
+            detect_result,
+            diff_result,
+            output_dir=output_dir,
+        )
+    except Exception as exc:
+        print(str(exc), file=sys.stderr)
+        return 1
+
+    print(
+        COMPARE_GRID_STAGE_COMPLETE.format(
+            count=len(grid_result.grid_videos),
+        )
+    )
+
+    if grid_result.exit_code != 0:
+        return grid_result.exit_code
+
+    # F-04: report ステージ
+    from video_diff_checker.report.messages import COMPARE_REPORT_STAGE_COMPLETE
+    from video_diff_checker.report.runner import run_report_from_pipeline
+
+    try:
+        report_result = run_report_from_pipeline(
+            diff_result,
+            detect_result,
+            output_dir=output_dir,
+        )
+    except Exception as exc:
+        print(str(exc), file=sys.stderr)
+        return 1
+
+    print(
+        COMPARE_REPORT_STAGE_COMPLETE.format(
+            category=report_result.overall_category.value,
+            ratio=report_result.change_ratio,
+        )
+    )
+
+    return 0
+
+
+def grid_handler(args: argparse.Namespace) -> int:
+    """grid サブコマンドのエントリポイント。
+
+    Returns:
+        終了コード (0: 成功, 1: エラー)
+    """
+    from video_diff_checker.grid.models import GridConfig
+    from video_diff_checker.grid.runner import run_grid
+
+    output_dir = Path(args.output) if args.output else Path("./vdc-output/")
+    config = GridConfig(
+        old_video=Path(args.old),
+        new_video=Path(args.new),
+        diff_video=Path(args.diff),
+        segments_json=Path(args.segments),
+        output_dir=output_dir,
+        workers=args.workers,
+        verbose=args.verbose,
+    )
+
+    try:
+        result = run_grid(config)
+    except Exception as exc:
+        print(str(exc), file=sys.stderr)
+        return 1
+
+    return result.exit_code
+
+
+def extract_handler(args: argparse.Namespace) -> int:
+    """extract サブコマンドのエントリポイント。
+
+    Returns:
+        終了コード (0: 成功, 1: エラー)
+    """
+    from video_diff_checker.detect.detector import load_segments
+    from video_diff_checker.detect.models import ExtractConfig
+    from video_diff_checker.detect.runner import run_extract
+
+    output_dir = Path(args.output) if args.output else Path("./vdc-output/")
+    segments = load_segments(Path(args.segments))
+
+    config = ExtractConfig(
+        old_video=Path(args.old),
+        new_video=Path(args.new),
+        diff_video=Path(args.diff),
+        output_dir=output_dir,
+        workers=args.workers,
+        verbose=args.verbose,
+    )
+
+    try:
+        run_extract(segments, config)
+    except Exception as exc:
+        print(str(exc), file=sys.stderr)
+        return 1
+
+    return 0
+
+
+def detect_handler(args: argparse.Namespace) -> int:
+    """detect サブコマンドのエントリポイント。
+
+    Returns:
+        終了コード (0: 成功, 1: エラー)
+    """
+    from video_diff_checker.detect.models import DetectConfig
+    from video_diff_checker.detect.runner import run_detect
+
+    output_dir = Path(args.output) if args.output else Path("./vdc-output/")
+    config = DetectConfig(
+        scores_csv=Path(args.scores_csv),
+        threshold=args.threshold,
+        margin=args.margin,
+        merge_gap=args.merge_gap,
+        fps=args.fps,
+        output_dir=output_dir,
+        verbose=args.verbose,
+    )
+
+    try:
+        run_detect(config)
+    except Exception as exc:
+        print(str(exc), file=sys.stderr)
+        return 1
+
+    return 0
+
+
+def register_compare_command(
+    subparsers: argparse._SubParsersAction,
+    parent: argparse.ArgumentParser,
+) -> None:
+    """compare サブコマンドをサブパーサーに登録する。"""
+    compare_cmd = next(cmd for cmd in SUBCOMMANDS if cmd["name"] == "compare")
+    parser = subparsers.add_parser(
+        "compare",
+        parents=[parent],
+        help=compare_cmd["help"],
+    )
+    parser.add_argument(
+        "old",
+        help="旧動画ファイルのパス",
+    )
+    parser.add_argument(
+        "new",
+        help="新動画ファイルのパス",
+    )
+    parser.add_argument(
+        "--output",
+        "-o",
+        default=None,
+        help="出力ディレクトリのパス（デフォルト: ./vdc-output/）",
+    )
+    parser.add_argument(
+        "--margin",
+        type=int,
+        default=30,
+        help="セグメント前後に追加するマージン（フレーム数、デフォルト: 30）",
+    )
+    parser.add_argument(
+        "--merge-gap",
+        type=int,
+        default=15,
+        help="セグメント統合のギャップ閾値（フレーム数、デフォルト: 15）",
+    )
+    parser.set_defaults(func=compare_handler, subcommand="compare")
+
+
+def register_diff_command(
+    subparsers: argparse._SubParsersAction,
+    parent: argparse.ArgumentParser,
+) -> None:
+    """diff サブコマンドをサブパーサーに登録する。"""
+    diff_cmd = next(cmd for cmd in SUBCOMMANDS if cmd["name"] == "diff")
+    parser = subparsers.add_parser(
+        "diff",
+        parents=[parent],
+        help=diff_cmd["help"],
+    )
+    parser.add_argument(
+        "old",
+        help="旧動画ファイルのパス",
+    )
+    parser.add_argument(
+        "new",
+        help="新動画ファイルのパス",
+    )
+    parser.add_argument(
+        "--output",
+        "-o",
+        default=None,
+        help="出力ディレクトリのパス（デフォルト: ./vdc-output/）",
+    )
+    parser.set_defaults(func=diff_handler, subcommand="diff")
+
+
+def register_detect_command(
+    subparsers: argparse._SubParsersAction,
+    parent: argparse.ArgumentParser,
+) -> None:
+    """detect サブコマンドをサブパーサーに登録する。"""
+    detect_cmd = next(cmd for cmd in SUBCOMMANDS if cmd["name"] == "detect")
+    parser = subparsers.add_parser(
+        "detect",
+        parents=[parent],
+        help=detect_cmd["help"],
+    )
+    parser.add_argument(
+        "scores_csv",
+        help="スコア CSV ファイルのパス",
+    )
+    parser.add_argument(
+        "--margin",
+        type=int,
+        default=30,
+        help="セグメント前後に追加するマージン（フレーム数、デフォルト: 30）",
+    )
+    parser.add_argument(
+        "--merge-gap",
+        type=int,
+        default=15,
+        help="セグメント統合のギャップ閾値（フレーム数、デフォルト: 15）",
+    )
+    parser.add_argument(
+        "--fps",
+        type=float,
+        default=30.0,
+        help="フレームレート（時刻計算用、デフォルト: 30.0）",
+    )
+    parser.add_argument(
+        "--output",
+        "-o",
+        default=None,
+        help="出力ディレクトリのパス（デフォルト: ./vdc-output/）",
+    )
+    parser.set_defaults(func=detect_handler, subcommand="detect")
+
+
+def register_extract_command(
+    subparsers: argparse._SubParsersAction,
+    parent: argparse.ArgumentParser,
+) -> None:
+    """extract サブコマンドをサブパーサーに登録する。"""
+    import os
+
+    extract_cmd = next(cmd for cmd in SUBCOMMANDS if cmd["name"] == "extract")
+    parser = subparsers.add_parser(
+        "extract",
+        parents=[parent],
+        help=extract_cmd["help"],
+    )
+    parser.add_argument(
+        "old",
+        help="旧動画ファイルのパス",
+    )
+    parser.add_argument(
+        "new",
+        help="新動画ファイルのパス",
+    )
+    parser.add_argument(
+        "diff",
+        help="差分動画ファイルのパス",
+    )
+    parser.add_argument(
+        "--segments",
+        required=True,
+        help="segments.json ファイルのパス",
+    )
+    parser.add_argument(
+        "--output",
+        "-o",
+        default=None,
+        help="出力ディレクトリのパス（デフォルト: ./vdc-output/）",
+    )
+    parser.add_argument(
+        "--workers",
+        type=int,
+        default=os.cpu_count(),
+        help=f"並列ワーカー数の上限（デフォルト: {os.cpu_count()}）",
+    )
+    parser.set_defaults(func=extract_handler, subcommand="extract")
+
+
+def register_grid_command(
+    subparsers: argparse._SubParsersAction,
+    parent: argparse.ArgumentParser,
+) -> None:
+    """grid サブコマンドをサブパーサーに登録する。"""
+    import os
+
+    grid_cmd = next(cmd for cmd in SUBCOMMANDS if cmd["name"] == "grid")
+    parser = subparsers.add_parser(
+        "grid",
+        parents=[parent],
+        help=grid_cmd["help"],
+    )
+    parser.add_argument(
+        "old",
+        help="旧動画ファイルのパス",
+    )
+    parser.add_argument(
+        "new",
+        help="新動画ファイルのパス",
+    )
+    parser.add_argument(
+        "diff",
+        help="差分動画ファイルのパス",
+    )
+    parser.add_argument(
+        "--segments",
+        required=True,
+        help="segments.json ファイルのパス",
+    )
+    parser.add_argument(
+        "--output",
+        "-o",
+        default=None,
+        help="出力ディレクトリのパス（デフォルト: ./vdc-output/）",
+    )
+    parser.add_argument(
+        "--workers",
+        type=int,
+        default=os.cpu_count(),
+        help=f"並列ワーカー数の上限（デフォルト: {os.cpu_count()}）",
+    )
+    parser.set_defaults(func=grid_handler, subcommand="grid")
+
+
+def report_handler(args: argparse.Namespace) -> int:
+    """report サブコマンドのエントリポイント。
+
+    Returns:
+        終了コード (0: 成功, 1: エラー)
+    """
+    from video_diff_checker.report.runner import run_report
+
+    from video_diff_checker.report.models import ReportConfig
+
+    output_dir = Path(args.output) if args.output else Path("./vdc-output/")
+    config = ReportConfig(
+        scores_csv=Path(args.scores_csv),
+        segments_json=Path(args.segments_json),
+        output_dir=output_dir,
+        format=args.format,
+        verbose=args.verbose,
+    )
+
+    try:
+        run_report(config)
+    except Exception as exc:
+        print(str(exc), file=sys.stderr)
+        return 1
+
+    return 0
+
+
+def register_report_command(
+    subparsers: argparse._SubParsersAction,
+) -> None:
+    """report サブコマンドをサブパーサーに登録する。
+
+    Note: --gpu / --threshold は登録しない（DD-12）。
+          共通パーサーを継承せず、--verbose のみを直接定義する。
+    """
+    report_cmd = next(cmd for cmd in SUBCOMMANDS if cmd["name"] == "report")
+    parser = subparsers.add_parser(
+        "report",
+        help=report_cmd["help"],
+    )
+    parser.add_argument(
+        "scores_csv",
+        help="スコア CSV ファイルのパス",
+    )
+    parser.add_argument(
+        "segments_json",
+        help="segments.json ファイルのパス",
+    )
+    parser.add_argument(
+        "--output",
+        "-o",
+        default=None,
+        help="出力ディレクトリのパス（デフォルト: ./vdc-output/）",
+    )
+    parser.add_argument(
+        "--format",
+        choices=["json", "text", "all"],
+        default="all",
+        help="出力形式（json / text / all、デフォルト: all）",
+    )
+    parser.add_argument(
+        "--verbose",
+        "-v",
+        action="store_true",
+        default=False,
+        help="詳細ログを出力する",
+    )
+    parser.set_defaults(func=report_handler, subcommand="report")
+
+
+def register_subcommands(
+    subparsers: argparse._SubParsersAction,
+    parent: argparse.ArgumentParser,
+) -> None:
+    """6 サブコマンドをサブパーサーに登録する。"""
+    for cmd in SUBCOMMANDS:
+        if cmd["name"] == "compare":
+            register_compare_command(subparsers, parent)
+            continue
+        if cmd["name"] == "diff":
+            register_diff_command(subparsers, parent)
+            continue
+        if cmd["name"] == "detect":
+            register_detect_command(subparsers, parent)
+            continue
+        if cmd["name"] == "extract":
+            register_extract_command(subparsers, parent)
+            continue
+        if cmd["name"] == "grid":
+            register_grid_command(subparsers, parent)
+            continue
+        if cmd["name"] == "report":
+            register_report_command(subparsers)
+            continue
+        parser = subparsers.add_parser(
+            cmd["name"],
+            parents=[parent],
+            help=cmd["help"],
+        )
+        parser.set_defaults(func=stub_handler, subcommand=cmd["name"])
+
+
+def create_parser(common_parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
+    """メインパーサーとサブパーサーを構築する。"""
+    parser = argparse.ArgumentParser(
+        prog="video-diff-checker",
+        description="2 本の動画ファイルを比較し、差分検出・抽出・グリッド比較動画を生成するツール",
+    )
+    # --version フラグでバージョン情報を表示
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s {__version__}",
+    )
+
+    subparsers = parser.add_subparsers(dest="subcommand")
+    register_subcommands(subparsers, common_parser)
+
+    return parser
+
+
+def main() -> None:
+    """CLI エントリポイント。引数解析 → ロギング設定 → FFmpeg 検証 → GPU 検証 → ディスパッチ。"""
+    common_parser = create_common_parser()
+    parser = create_parser(common_parser)
+    args = parser.parse_args()
+
+    # サブコマンド未指定時はヘルプを表示
+    if args.subcommand is None:
+        parser.print_help()
+        sys.exit(0)
+
+    # ロギング設定
+    setup_logger(verbose=args.verbose)
+
+    # report サブコマンドは FFmpeg / GPU 不要
+    if args.subcommand != "report":
+        # FFmpeg 検証
+        try:
+            verify_ffmpeg(verbose=args.verbose)
+        except (FFmpegNotFoundError, FFmpegVersionError) as exc:
+            print(str(exc), file=sys.stderr)
+            sys.exit(1)
+
+        # GPU 検証（--gpu 指定時のみ）
+        if getattr(args, "gpu", False):
+            verify_gpu(verbose=args.verbose)
+
+    # サブコマンドディスパッチ
+    exit_code = args.func(args)
+    sys.exit(exit_code)
+
+
+if __name__ == "__main__":
+    main()

video_diff_checker/common_options.py

@@ -0,0 +1,64 @@
+"""共通 CLI オプション定義モジュール。
+
+全サブコマンド共通の CLI オプション（--verbose, --threshold, --gpu）を
+親パーサーとして一箇所で定義し、各サブコマンドから parents= 引数で再利用する。
+"""
+
+import argparse
+
+from video_diff_checker.messages import THRESHOLD_OUT_OF_RANGE
+
+
+def validate_threshold(value: str) -> float:
+    """threshold 値を float に変換し、0.0〜1.0 の範囲を検証する。
+
+    Args:
+        value: コマンドライン引数として渡された文字列。
+
+    Returns:
+        検証済みの float 値。
+
+    Raises:
+        argparse.ArgumentTypeError: 数値変換に失敗した場合、または範囲外の場合。
+    """
+    try:
+        fvalue = float(value)
+    except ValueError:
+        raise argparse.ArgumentTypeError(
+            THRESHOLD_OUT_OF_RANGE.format(value=value)
+        )
+    if fvalue < 0.0 or fvalue > 1.0:
+        raise argparse.ArgumentTypeError(
+            THRESHOLD_OUT_OF_RANGE.format(value=value)
+        )
+    return fvalue
+
+
+def create_common_parser() -> argparse.ArgumentParser:
+    """共通オプション付き親パーサーを返す。add_help=False で作成する。
+
+    Returns:
+        --verbose, --threshold, --gpu を含む親パーサー。
+    """
+    parser = argparse.ArgumentParser(add_help=False)
+    parser.add_argument(
+        "--verbose",
+        "-v",
+        action="store_true",
+        default=False,
+        help="詳細ログを出力する",
+    )
+    parser.add_argument(
+        "--threshold",
+        "-t",
+        type=validate_threshold,
+        default=0.95,
+        help="SSIM ベースの閾値（0.0〜1.0、デフォルト: 0.95）",
+    )
+    parser.add_argument(
+        "--gpu",
+        action="store_true",
+        default=False,
+        help="GPU アクセラレーションを使用する",
+    )
+    return parser