Vs code windows

README.md

@@ -134,12 +134,57 @@ Place these files in the "**models**" folder.
 We highly recommend using a `venv` to avoid issues.
 
 
-For Windows:
-```bash
-python -m venv venv
-venv\Scripts\activate
-pip install -r requirements.txt
-```
+**For Windows:**
+
+It is highly recommended to use Python 3.10 for Windows for best compatibility with all features and dependencies.
+
+**Automated Setup (Recommended):**
+
+1.  **Run the setup script:**
+    Double-click `setup_windows.bat` or run it from your command prompt:
+    ```batch
+    setup_windows.bat
+    ```
+    This script will:
+    *   Check if Python is in your PATH.
+    *   Warn if `ffmpeg` is not found (see "Manual Steps / Notes" below for ffmpeg help).
+    *   Create a virtual environment named `.venv` (consistent with macOS setup).
+    *   Activate the virtual environment for the script's session.
+    *   Upgrade pip.
+    *   Install Python packages from `requirements.txt`.
+    Wait for the script to complete. It will pause at the end; press any key to close the window if you double-clicked it.
+
+2.  **Run the application:**
+    After setup, use the provided `.bat` scripts to run the application. These scripts automatically activate the correct virtual environment:
+    *   `run_windows.bat`: Runs the application with the CPU execution provider by default. This is a good starting point if you don't have a dedicated GPU or are unsure.
+    *   `run-cuda.bat`: Runs with the CUDA (NVIDIA GPU) execution provider. Requires an NVIDIA GPU and CUDA Toolkit installed (see GPU Acceleration section).
+    *   `run-directml.bat`: Runs with the DirectML (AMD/Intel GPU on Windows) execution provider.
+
+    Example: Double-click `run_windows.bat` to launch the UI, or run from a command prompt:
+    ```batch
+    run_windows.bat --source path\to\your_face.jpg --target path\to\video.mp4
+    ```
+
+**Manual Steps / Notes:**
+
+*   **Python:** Ensure Python 3.10 is installed and added to your system's PATH. You can download it from [python.org](https://www.python.org/downloads/).
+*   **ffmpeg:**
+    *   `ffmpeg` is required for video processing. The `setup_windows.bat` script will warn if it's not found in your PATH.
+    *   An easy way to install `ffmpeg` on Windows is to open PowerShell as Administrator and run:
+        ```powershell
+        Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1')); choco install ffmpeg -y
+        ```
+        Alternatively, download from [ffmpeg.org](https://ffmpeg.org/download.html), extract the files, and add the `bin` folder (containing `ffmpeg.exe`) to your system's PATH environment variable. The original README also linked to a [YouTube guide](https://www.youtube.com/watch?v=OlNWCpFdVMA) or `iex (irm ffmpeg.tc.ht)` via PowerShell.
+*   **Visual Studio Runtimes:** If you encounter errors during `pip install` for packages that compile C code (e.g., some scientific computing or image processing libraries), you might need the [Visual Studio Build Tools (or Runtimes)](https://visualstudio.microsoft.com/visual-cpp-build-tools/). Ensure "C++ build tools" (or similar workload) are selected during installation.
+*   **Virtual Environment (Manual Alternative):** If you prefer to set up the virtual environment manually instead of using `setup_windows.bat`:
+    ```batch
+    python -m venv .venv 
+    .venv\Scripts\activate.bat
+    python -m pip install --upgrade pip
+    python -m pip install -r requirements.txt
+    ```
+    (The new automated scripts use `.venv` as the folder name for consistency with the macOS setup).
+
 For Linux:
 ```bash
 # Ensure you use the installed Python 3.10
@@ -150,22 +195,64 @@ pip install -r requirements.txt
 
 **For macOS:**
 
-Apple Silicon (M1/M2/M3) requires specific setup:
-
-```bash
-# Install Python 3.10 (specific version is important)
-brew install [email protected]
-
-# Install tkinter package (required for the GUI)
-brew install [email protected]
-
-# Create and activate virtual environment with Python 3.10
-python3.10 -m venv venv
-source venv/bin/activate
-
-# Install dependencies
-pip install -r requirements.txt
-```
+For a streamlined setup on macOS, use the provided shell scripts:
+
+1.  **Make scripts executable:**
+    Open your terminal, navigate to the cloned `Deep-Live-Cam` directory, and run:
+    ```bash
+    chmod +x setup_mac.sh
+    chmod +x run_mac*.sh
+    ```
+
+2.  **Run the setup script:**
+    This will check for Python 3.9+, ffmpeg, create a virtual environment (`.venv`), and install required Python packages.
+    ```bash
+    ./setup_mac.sh
+    ```
+    If you encounter issues with specific packages during `pip install` (especially for libraries that compile C code, like some image processing libraries), you might need to install system libraries via Homebrew (e.g., `brew install jpeg libtiff ...`) or ensure Xcode Command Line Tools are installed (`xcode-select --install`).
+
+3.  **Activate the virtual environment (for manual runs):**
+    After setup, if you want to run commands manually or use developer tools from your terminal session:
+    ```bash
+    source .venv/bin/activate
+    ```
+    (To deactivate, simply type `deactivate` in the terminal.)
+
+4.  **Run the application:**
+    Use the provided run scripts for convenience. These scripts automatically activate the virtual environment.
+    *   `./run_mac.sh`: Runs the application with the CPU execution provider by default. This is a good starting point.
+    *   `./run_mac_cpu.sh`: Explicitly uses the CPU execution provider.
+    *   `./run_mac_coreml.sh`: Attempts to use the CoreML execution provider for potential hardware acceleration on Apple Silicon and Intel Macs.
+    *   `./run_mac_mps.sh`: Attempts to use the MPS (Metal Performance Shaders) execution provider, primarily for Apple Silicon Macs.
+
+    Example of running with specific source/target arguments:
+    ```bash
+    ./run_mac.sh --source path/to/your_face.jpg --target path/to/video.mp4
+    ```
+    Or, to simply launch the UI:
+    ```bash
+    ./run_mac.sh
+    ```
+
+**Important Notes for macOS GPU Acceleration (CoreML/MPS):**
+
+*   The `setup_mac.sh` script installs packages from `requirements.txt`, which typically includes a general CPU-based version of `onnxruntime`.
+*   For optimal performance on Apple Silicon (M1/M2/M3) or specific GPU acceleration, you might need to install a different `onnxruntime` package *after* running `setup_mac.sh` and while the virtual environment (`.venv`) is active.
+*   **Example for `onnxruntime-silicon` (often requires Python 3.10 for older versions like 1.13.1):**
+    The original `README` noted that `onnxruntime-silicon==1.13.1` was specific to Python 3.10. If you intend to use this exact version for CoreML:
+    ```bash
+    # Ensure you are using Python 3.10 if required by your chosen onnxruntime-silicon version
+    # After running setup_mac.sh and activating .venv:
+    # source .venv/bin/activate
+
+    pip uninstall onnxruntime onnxruntime-gpu # Uninstall any existing onnxruntime
+    pip install onnxruntime-silicon==1.13.1   # Or your desired version
+
+    # Then use ./run_mac_coreml.sh
+    ```
+    Check the ONNX Runtime documentation for the latest recommended packages for Apple Silicon.
+*   **For MPS with ONNX Runtime:** This may require a specific build or version of `onnxruntime`. Consult the ONNX Runtime documentation. For PyTorch-based operations (like the Face Enhancer or Hair Segmenter if they were PyTorch native and not ONNX), PyTorch should automatically try to use MPS on compatible Apple Silicon hardware if available.
+*   **User Interface (Tkinter):** If you encounter errors related to `_tkinter` not being found when launching the UI, ensure your Python installation supports Tk. For Python installed via Homebrew, this is usually `python-tk` (e.g., `brew install [email protected]` or `brew install [email protected]`, matching your Python version).
 
 ** In case something goes wrong and you need to reinstall the virtual environment **
 

modules/globals.py

@@ -41,3 +41,4 @@
 mask_feather_ratio = 8
 mask_down_size = 0.50
 mask_size = 1
+enable_hair_swapping = True  # Default state for enabling/disabling hair swapping

modules/hair_segmenter.py

@@ -0,0 +1,102 @@
+import torch
+import numpy as np
+from PIL import Image
+from transformers import SegformerImageProcessor, SegformerForSemanticSegmentation
+import cv2 # Imported for BGR to RGB conversion, though PIL can also do it.
+
+# Global variables for caching
+HAIR_SEGMENTER_PROCESSOR = None
+HAIR_SEGMENTER_MODEL = None
+MODEL_NAME = "isjackwild/segformer-b0-finetuned-segments-skin-hair-clothing"
+
+def segment_hair(image_np: np.ndarray, device: str = "cpu", hair_label_index: int = None) -> np.ndarray:
+    """
+    Segments hair from an image.
+
+    Args:
+        image_np: NumPy array representing the image (BGR format from OpenCV).
+        device: Device to run the model on ("cpu" or "cuda").
+        hair_label_index: Optional; index of the hair label in the segmentation map. If not provided, will use model config or default to 2.
+
+    Returns:
+        NumPy array representing the binary hair mask.
+    """
+    global HAIR_SEGMENTER_PROCESSOR, HAIR_SEGMENTER_MODEL
+
+    if HAIR_SEGMENTER_PROCESSOR is None or HAIR_SEGMENTER_MODEL is None:
+        print(f"Loading hair segmentation model and processor ({MODEL_NAME}) for the first time...")
+        try:
+            HAIR_SEGMENTER_PROCESSOR = SegformerImageProcessor.from_pretrained(MODEL_NAME)
+            HAIR_SEGMENTER_MODEL = SegformerForSemanticSegmentation.from_pretrained(MODEL_NAME)
+            HAIR_SEGMENTER_MODEL = HAIR_SEGMENTER_MODEL.to(device)
+            print(f"Hair segmentation model and processor loaded successfully. Model moved to device: {device}")
+        except Exception as e:
+            print(f"Failed to load hair segmentation model/processor: {e}")
+            return np.zeros((image_np.shape[0], image_np.shape[1]), dtype=np.uint8)
+
+    if HAIR_SEGMENTER_PROCESSOR is None or HAIR_SEGMENTER_MODEL is None:
+        print("Error: Hair segmentation models are not available.")
+        return np.zeros((image_np.shape[0], image_np.shape[1]), dtype=np.uint8)
+
+    image_rgb = cv2.cvtColor(image_np, cv2.COLOR_BGR2RGB)
+    image_pil = Image.fromarray(image_rgb)
+
+    inputs = HAIR_SEGMENTER_PROCESSOR(images=image_pil, return_tensors="pt")
+    if device == "cuda" and hasattr(HAIR_SEGMENTER_MODEL, "device") and HAIR_SEGMENTER_MODEL.device.type == "cuda":
+        inputs = {k: v.to("cuda") for k, v in inputs.items()}
+
+    with torch.no_grad():
+        outputs = HAIR_SEGMENTER_MODEL(**inputs)
+
+    logits = outputs.logits
+    upsampled_logits = torch.nn.functional.interpolate(
+        logits,
+        size=(image_np.shape[0], image_np.shape[1]),
+        mode='bilinear',
+        align_corners=False
+    )
+    segmentation_map = upsampled_logits.argmax(dim=1).squeeze().cpu().numpy().astype(np.uint8)
+
+    if hair_label_index is None:
+        hair_label_index = getattr(HAIR_SEGMENTER_MODEL, "hair_label_index", 2)
+    return np.where(segmentation_map == hair_label_index, 255, 0).astype(np.uint8)
+
+if __name__ == '__main__':
+    # This is a conceptual test.
+    # In a real scenario, you would load an image using OpenCV or Pillow.
+    # For example:
+    # sample_image_np = cv2.imread("path/to/your/image.jpg")
+    # if sample_image_np is not None:
+    #     hair_mask_output = segment_hair(sample_image_np)
+    #     cv2.imwrite("hair_mask_output.png", hair_mask_output)
+    #     print("Hair mask saved to hair_mask_output.png")
+    # else:
+    #     print("Failed to load sample image.")
+
+    print("Conceptual test: Hair segmenter module created.")
+    # Create a dummy image for a basic test run if no image is available.
+    dummy_image_np = np.zeros((100, 100, 3), dtype=np.uint8) # 100x100 BGR image
+    dummy_image_np[:, :, 1] = 255 # Make it green to distinguish from black mask
+
+    try:
+        print("Running segment_hair with a dummy image...")
+        hair_mask_output = segment_hair(dummy_image_np)
+        print(f"segment_hair returned a mask of shape: {hair_mask_output.shape}")
+        # Check if the output is a 2D array (mask) and has the same H, W as input
+        assert hair_mask_output.shape == (dummy_image_np.shape[0], dummy_image_np.shape[1])
+        # Check if the mask is binary (0 or 255)
+        assert np.all(np.isin(hair_mask_output, [0, 255]))
+        print("Dummy image test successful. Hair mask seems to be generated correctly.")
+
+        # Attempt to save the dummy mask (optional, just for visual confirmation if needed)
+        # cv2.imwrite("dummy_hair_mask_output.png", hair_mask_output)
+        # print("Dummy hair mask saved to dummy_hair_mask_output.png")
+
+    except ImportError as e:
+        print(f"An ImportError occurred: {e}. This might be due to missing dependencies like transformers, torch, or Pillow.")
+        print("Please ensure all required packages are installed by updating requirements.txt and installing them.")
+    except Exception as e:
+        print(f"An error occurred during the dummy image test: {e}")
+        print("This could be due to issues with model loading, processing, or other runtime errors.")
+
+    print("To perform a full test, replace the dummy image with a real image path.")