macrimi/hwencoderx repository overview

⁠HWEncoderX: Video Transcoder with GPU Hardware Acceleration (Intel QSV, NVENC, VAAPI)

HWEncoderX is a Docker container that allows you to automatically transcode videos to H.265 (HEVC) using your GPU with hardware acceleration, supporting VAAPI (Intel/AMD), NVENC (NVIDIA), and Intel Quick Sync (QSV). This reduces video file size while preserving audio, subtitles, and chapters intact.

⁠Features

• Support for Multiple GPUs: Compatible with Intel Quick Sync (QSV), NVIDIA NVENC, and VAAPI. If no compatible GPU is detected, the container stops and sends an error notification.
• Support for Multiple Input Formats: Compatible with .mkv, .mp4, .avi, .mov, and .mpeg files.
• Telegram Notifications: Sends welcome notifications, transcoding details (time, speed, quality), and errors during the process.
• Always Active Docker: The container remains active, constantly monitoring the input directory for new files.
• Automatic Quality Adjustment: Optimized adjustment to prioritize quality based on the input video bitrate using the global QUALITY variable.
• Error Handling and Space Verification: Checks disk space before transcoding and sends notifications if space is insufficient or if there are errors.
• Improved Transcoding Process: Fixed an issue that prevented transcoding files without defined subtitle tracks.
• Size Reduction: Transcodes to H.265 (HEVC) to reduce file size by up to 70%.
• Ideal for Media Servers: Compatible with Plex, Jellyfin, Emby, and more.
• Simple: Just mount the input and output folders, and HWEncoderX does all the work.
• Customizable Options: Manually define the quality using the QUALITY variable and select the preset to adjust speed and quality as needed.

⁠Telegram Notification Configuration

To receive Telegram notifications, configure a bot and obtain your BOT_TOKEN and CHAT_ID. Follow these steps:

1. Create a new bot on Telegram using BotFather⁠ and follow the instructions until you get your BOT_TOKEN.
2. Obtain your CHAT_ID by sending a message to your bot, then using an API call like:

   https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates
   

   Copy
   Replace <YOUR_BOT_TOKEN> with your bot token to find your CHAT_ID in the response.

⁠Requirements

You need a GPU compatible with VAAPI (Intel/AMD), NVENC (NVIDIA), or Intel Quick Sync (QSV). Without a compatible GPU, the container will not work.

⁠Parameters

Note: /path/to/input and /path/to/output can be the same folder. Transcoded files will be created with the _HEVC suffix.

⁠Usage Instructions

⁠VAAPI Usage

⁠Docker Run

docker run -d --name hwencoderx --device=/dev/dri \
  -v /path/to/input:/input \
  -v /path/to/output:/output \
  -e BOT_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxx \
  -e CHAT_ID=xxxxxxxx \
  -e QUALITY=18 \
  -e PRESET=medium \
  -e NOTIFICATIONS=all \
  macrimi/hwencoderx:latest

# Explanation of the parameters used:
# - `-e QUALITY=18`: Optional. Defines the custom quality level (recommended between 16 to 22) for transcoding.
# - `-e PRESET=medium`: Optional. Defines the custom preset for transcoding (optional).
# - `-e BOT_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxx`: Optional. Replace with your TOKEN, requires CHAT_ID.
# - `-e CHAT_ID=xxxxxxxx`: Optional. Replace with your CHAT_ID, requires BOT_TOKEN.
# - `-e NOTIFICATIONS=all`: Optional.

⁠docker-compose.yml

version: '3.3'

services:
  hwencoderx:
    image: macrimi/hwencoderx:latest 
    container_name: hwencoderx 
    restart: unless-stopped 
    devices:
      - /dev/dri:/dev/dri 
    volumes:
      - /path/to/input:/input 
      - /path/to/output:/output 
    environment:
      QUALITY: "18" # Optional
      PRESET: "medium" # Optional
      BOT_TOKEN: "xxxxxxxxxxxxxxxxxxxxxxxxxx" # Optional (replace with your TOKEN, requires CHAT_ID)
      CHAT_ID: "xxxxxxxx" # Optional (replace with your CHAT_ID, requires BOT_TOKEN)
      NOTIFICATIONS: "all" # Optional

⁠NVIDIA Usage

⁠Docker Run

docker run -d --name hwencoderx --gpus all \ 
  -v /path/to/input:/input \
  -v /path/to/output:/output \
  -e BOT_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxx \
  -e CHAT_ID=xxxxxxxx \
  -e QUALITY=18 \
  -e PRESET=medium \
  -e NOTIFICATIONS=all \
  macrimi/hwencoderx:latest

# Explanation of the parameters used:
# - `-e QUALITY=18`: Optional. Defines the custom quality level (recommended between 16 to 22) for transcoding.
# - `-e PRESET=medium`: Optional. Defines the custom preset for transcoding.
# - `-e BOT_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxx`: Optional. Replace with your TOKEN, requires CHAT_ID.
# - `-e CHAT_ID=xxxxxxxx`: Optional. Replace with your CHAT_ID, requires BOT_TOKEN.
# - `-e NOTIFICATIONS=all`: Optional.

⁠docker-compose.yml

version: '3.3'

services:
  hwencoderx:
    image: macrimi/hwencoderx:latest 
    container_name: hwencoderx 
    restart: unless-stopped 
    deploy:
      resources:
        reservations:
          devices:
            - capabilities: [gpu] 
    volumes:
      - /path/to/input:/input 
      - /path/to/output:/output 
    environment:
      QUALITY: "18" # Optional
      PRESET: "medium" # Optional
      BOT_TOKEN: "xxxxxxxxxxxxxxxxxxxxxxxxxx" # Optional (replace with your TOKEN, requires CHAT_ID)
      CHAT_ID: "xxxxxxxx" # Optional (replace with your CHAT_ID, requires BOT_TOKEN)
      NOTIFICATIONS: "all" # Optional

⁠Additional Notes

HWEncoderX works with hardware acceleration VAAPI, NVENC, and QSV. Without a compatible Intel, AMD, or NVIDIA GPU, the container will not work. Original files are not deleted after transcoding, allowing you to keep both the original and the transcoded files with the _HEVC suffix.

⁠Synology/XPenology NAS Compatibility

Works on any NAS with a functional Intel or NVIDIA GPU.

⁠DVA Models

On DVA Synology NAS that use the NVIDIA Runtime Library for Surveillance Station, it is not possible to run this container as they do not have NVIDIA Container Toolkit.

⁠License

This project is under the MIT License. You are free to use, modify, and distribute the code as long as proper credit is given. See the LICENSE file for more details.

⁠Third-party Software

This container uses FFmpeg, licensed under LGPL 2.1 or later. See the FFmpeg documentation⁠ for more information.

-- Español

⁠HWEncoderX: Transcodificador de Video con Aceleración por Hardware GPU Intel Quick Sync (QSV), NVENC y VAAPI

HWEncoderX es un contenedor Docker diseñado para simplificar la transcodificación de videos a H.265 (HEVC), aprovechando tu GPU para una aceleración por hardware eficiente mediante VAAPI (Intel/AMD), NVENC (NVIDIA) o Intel Quick Sync (QSV). Esto permite reducir el tamaño del video manteniendo intactos los audios, subtítulos y capítulos.

⁠Características

• Soporte para Múltiples GPU: Compatible con Intel Quick Sync (QSV), NVIDIA NVENC y VAAPI. Si no se detecta una GPU compatible, el contenedor se detiene y envía una notificación de error.
• Soporte para Múltiples Formatos de Entrada: Compatible con archivos .mkv, .mp4, .avi, .mov y .mpeg.
• Notificaciones a Telegram: Envía notificaciones de bienvenida, detalles de transcodificación (tiempo, velocidad, calidad) y errores durante el proceso.
• Docker Siempre Activo: El contenedor permanece activo y supervisa constantemente el directorio de entrada para detectar nuevos archivos.
• Ajuste Automático de Calidad: Ajuste optimizado para priorizar la calidad según el bitrate del video de entrada utilizando la variable global QUALITY.
• Manejo de Errores y Verificación de Espacio: Verifica el espacio en disco antes de la transcodificación y envía notificaciones si el espacio es insuficiente o si hay errores.
• Mejoras en el Proceso de Transcodificación: Se corrigió un problema que impedía transcodificar archivos sin pistas de subtítulos definidas.
• Reducción de Tamaño: Transcodifica a H.265 (HEVC) para reducir el tamaño del archivo hasta en un 70%.
• Ideal para Servidores Multimedia: Compatible con Plex, Jellyfin, Emby y más.
• Sencillo: Solo monta las carpetas de entrada y salida, y HWEncoderX hace todo el trabajo.
• Opciones Personalizables: Define manualmente la calidad usando la variable QUALITY y selecciona el preset para ajustar la velocidad y calidad según sea necesario.

⁠Configuración de Notificaciones de Telegram

Para recibir notificaciones vía Telegram, necesitas configurar un bot y obtener tu BOT_TOKEN y CHAT_ID. Sigue estos pasos:

1. Crea un nuevo bot en Telegram usando BotFather⁠ y sigue las instrucciones hasta obtener tu BOT_TOKEN.
2. Obtén tu CHAT_ID enviando un mensaje a tu bot y utilizando una llamada a la API como:

   https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates
   

   Copy
   Reemplaza <YOUR_BOT_TOKEN> con el token de tu bot para encontrar tu CHAT_ID en la respuesta.

⁠Requisitos

Necesitas una GPU compatible con VAAPI (Intel/AMD), NVENC (NVIDIA) o Intel Quick Sync (QSV). Sin una GPU compatible, el contenedor no funcionará.

⁠Parámetros

Nota: /path/to/input y /path/to/output pueden ser la misma carpeta. Los archivos transcodificados se crearán con el sufijo _HEVC.

⁠Instrucciones de Uso

⁠Uso de VAAPI

⁠Docker Run

docker run -d --name hwencoderx --device=/dev/dri \
  -v /path/to/input:/input \ 
  -v /path/to/output:/output \
  -e QUALITY=18 \
  -e PRESET=medium \
  -e BOT_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxx \
  -e CHAT_ID=xxxxxxxx \
  -e NOTIFICATIONS=all \
  macrimi/hwencoderx:latest

# Explicación de los parámetros usados:
# - `-e QUALITY=18`: Opcional. Define el nivel de calidad personalizado (recomendado de 16 a 22) para la transcodificación. 
# - `-e PRESET=medium`: Opcional. Define el preset personalizado de la transcodificación (opcional).
# - `-e BOT_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxx`: opcional. Cambia por tu TOKEN, requiere CHAT_ID).
# - `-e CHAT_ID=xxxxxxxx`: Opcional. Cambia por tu CHAT_ID, requiere BOT_TOKEN).
# - `-e NOTIFICATIONS=all`: Opcional.

⁠docker-compose.yml

version: '3.3'

services:
  hwencoderx:
    image: macrimi/hwencoderx:latest 
    container_name: hwencoderx 
    restart: unless-stopped 
    devices:
      - /dev/dri:/dev/dri 
    volumes:
      - /path/to/input:/input
      - /path/to/output:/output 
    environment:
      QUALITY: "18" # Opcional
      PRESET: "medium" # Opcional
      BOT_TOKEN: "xxxxxxxxxxxxxxxxxxxxxxxxxx" # Opcional (cambia por tu TOKEN, requiere CHAT_ID)
      CHAT_ID: "xxxxxxxx" # Opcional (requiere BOT_TOKEN)
      NOTIFICATIONS: "all" # Opcional

⁠Uso de NVIDIA

⁠Docker Run

docker run -d --name hwencoderx --gpus all \ 
  -v /path/to/input:/input \ 
  -v /path/to/output:/output \
  -e QUALITY=18 \
  -e PRESET=medium \
  -e BOT_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxx \
  -e CHAT_ID=xxxxxxxx \
  -e NOTIFICATIONS=all \
  macrimi/hwencoderx:latest

# Explicación de los parámetros usados:
# - `-e QUALITY=18`: Opcional. Define el nivel de calidad personalizado (recomendado de 16 a 22) para la transcodificación. 
# - `-e PRESET=medium`: Opcional. Define el preset personalizado de la transcodificación (opcional).
# - `-e BOT_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxx`: opcional. Cambia por tu TOKEN, requiere CHAT_ID).
# - `-e CHAT_ID=xxxxxxxx`: Opcional. Cambia por tu CHAT_ID, requiere BOT_TOKEN).
# - `-e NOTIFICATIONS=all`: Opcional.

⁠docker-compose.yml

version: '3.3'

services:
  hwencoderx:
    image: macrimi/hwencoderx:latest 
    container_name: hwencoderx 
    restart: unless-stopped 
    deploy:
      resources:
        reservations:
          devices:
            - capabilities: [gpu]
    volumes:
      - /path/to/input:/input
      - /path/to/output:/output
    environment:
      QUALITY: "18" # Opcional
      PRESET: "medium" # Opcional
      BOT_TOKEN: "xxxxxxxxxxxxxxxxxxxxxxxxxx" # Opcional (cambia por tu TOKEN, requiere CHAT_ID)
      CHAT_ID: "xxxxxxxx" # Opcional (requiere BOT_TOKEN)
      NOTIFICATIONS: "all" # Opcional

⁠Notas Adicionales

HWEncoderX funciona con aceleración por hardware VAAPI, NVENC y QSV. Sin una GPU compatible Intel, AMD o NVIDIA, el contenedor no funcionará. Los archivos originales no se eliminan tras la transcodificación, permitiendo tener ambos: el archivo original y el transcodificado con el sufijo _HEVC.

⁠Compatibilidad con NAS Synology/XPenology

Funciona en cualquier NAS con una GPU Intel o NVIDIA funcional.

⁠Modelos DVA

En los NAS DVA de Synology que usan la NVIDIA Runtime Library para Surveillance Station, no es posible ejecutar este contenedor ya que no tienen NVIDIA Container Toolkit.

⁠Licencia

Este proyecto está bajo la Licencia MIT. Puedes usar, modificar y distribuir el código siempre que se dé el crédito correspondiente. Consulta el archivo LICENSE para más detalles.

⁠Software de Terceros

Este contenedor usa FFmpeg, licenciado bajo LGPL 2.1 o posterior. Consulta la documentación de FFmpeg⁠ para más información.

⁠

Si este proyecto te ha sido útil, ¡puedes invitarme a un Ko-fi! ¡Gracias! 😊