# Создание conda виртуальной среды, с использованием Python 3.8 в качестве примера
conda create -n ows python==3.8 # Имя виртуальной среды — ows
conda activate ows # Активация виртуальной среды

pip install opencv-webcam-script==0.9.1 # Пример использования версии 0.9.1

from opencv_webcam.opencv_webcam import webcam_opencv

webcam_opencv()  # Обычный вызов
webcam_opencv(is_autoSaveFrame=True)  # Автоматическое сохранение кадров
webcam_opencv(is_autoSaveFrame=True, is_compress=True)  # Сжатие кадров

webcam_opencv()  # Обычный вызов

# Пример переключения между несколькими камерами, по умолчанию используется 0
webcam_opencv(device_index=0)
webcam_opencv(device_index=1)
webcam_opencv(device_index=2)
# RTSP
webcam_opencv(device_index="rtsp://username:password@xxx.xxx.xxx")

# По умолчанию клавиша q используется для выхода
webcam_opencv(quit_key="z")  # Настройка z в качестве клавиши выхода
webcam_opencv(quit_key="k")  # Настройка k в качестве клавиши выхода

webcam_opencv(is_autoSaveFrame=True)

# Сохранение одного кадра каждые 10 кадров
webcam_opencv(is_autoSaveFrame=True, frame_nSave=10)

# По умолчанию используется клавиша a для захвата одного кадра
webcam_opencv(is_handSaveFrame=True)

# Настройка клавиши z для ручного захвата кадра, по умолчанию используется a
webcam_opencv(is_handSaveFrame=True, frame_capKey="z")

# Изменение ширины на 300 и высоты на 200
webcam_opencv(
    is_autoSaveFrame=True, is_resizeFrame=True, resize_frame="640,480"
)  # Автоматический режим, v0.5
webcam_opencv(
    is_handSaveFrame=True, is_resizeFrame=True, resize_frame="640,480"
)  # Ручной режим, v0.5

webcam_opencv(
    is_autoSaveFrame=True, is_resizeFrame=True, resize_frame=[640, 480]
)  # Автоматический режим до версии 0.4
webcam_opencv(
    is_handSaveFrame=True, is_resizeFrame=True, resize_frame=[640, 480]
)  # Ручной режим до версии 0.4

# Соотношение сторон 0,5
webcam_opencv(is_autoSaveFrame=True, is_resizeFrame=True, resizeRatio_frame=0.5)  # Автоматический режим
webcam_opencv(is_handSaveFrame=True, is_resizeFrame=True, resizeRatio_frame=0.5)  # Ручной режим

# Настраиваемый путь сохранения, по умолчанию кадры сохраняются в папку WebcamFrame
webcam_opencv(is_autoSaveFrame=True, frame_saveDir="custom_dir")  # Пример автоматического режима

# Настраиваемое название папки кадра, по умолчанию frames
webcam_opencv(is_autoSaveFrame=True, frame_dirName="frames_custom")  # Пример автоматического режима

# Настраиваемое префиксное название кадра
webcam_opencv(is_autoSaveFrame=True, frame_namePrefix="webcam")  # Пример автоматического режима

# JPG качество установлено на 100, по умолчанию 95
webcam_opencv(is_autoSaveFrame=True, frame_saveStyle="jpg", jpg_quality=100)  # Пример автоматического режима

# PNG качество установлено на 5, по умолчанию 3
webcam_opencv(is_autoSaveFrame=True, frame_saveStyle="png", png_quality=5)  # Пример автоматического режима

# Настройка w в качестве клавиши паузы, по умолчанию p
webcam_opencv(pause_key="w")  # Любая клавиша для продолжения

# Сохраняется 100 кадров
webcam_opencv(is_autoSaveFrame=True, auto_frameNum=100)

# Ручная регулировка размера окна (v0.9)
webcam_opencv(is_resizeWindow=True)

# Обычное сжатие, по умолчанию ows.zip (на примере автоматической версии)
webcam_opencv(is_autoSaveFrame=True, is_compress=True)

# Пользовательское имя файла сжатия
webcam_opencv(is_autoSaveFrame=True, is_compress=True, compressName="ows02")

# Автоматическое именование файла сжатия
webcam_opencv(
    is_autoSaveFrame=True,
    is_compress=True,
    is_autoCompressName=True
)

# Пользовательский режим сжатия, по умолчанию запись с перезаписью
webcam_opencv(
    is_autoSaveFrame=True, 
    is_compress=True, 
    compressStyle="tar", 
    compressMode="w:gz"
)  # tar сжатие
webcam_opencv(
    is_autoSaveFile=True, 
    is_compress=True, 
    compressMode="a"
)  # Режим добавления (режим a применим только к zip) 
# Примечание: эта команда доступна только в версии v0.4

# Удаление цвета фона, по умолчанию зелёный
webcam_opencv(is_autoSaveFrame=True, is_rmbgColor=True)

# Выбор режима цвета фона
webcam_opencv(is_autoSaveFrame=True, is_rmbgColor=True, rmbgColorMode="green")  # Удаление зелёного
webcam_opencv(is_autoSaveFrame=True, is_rmbgColor=True, rmbgColorMode="blue")  # Удаление синего

def webcam_opencv(
        device_index="0",  # Номер устройства
        quit_key="q",  # Клавиша выхода
        pause_key="p",  # Приостановить клавишу
        is_autoSaveFrame=False,  # Автоматически сохранять кадр
        frame_saveDir="WebcamFrame",  # Путь сохранения кадра
        frame_dirName="frames",  # Имя каталога кадров
        frame_nSave=1,  # Сохранять каждые n кадров
        auto_frameNum=0,  # Максимальное количество автоматически сохраняемых кадров
        is_handSaveFrame=False,  # Вручную сохранить кадр
        frame_capKey="a",  # Установить ключ захвата кадра
        is_resizeFrame=False,  # Изменить размер кадра
        resize_frame="640,480",  # Настроить размер кадра
        resizeRatio_frame=1.0,  # Коэффициент масштабирования кадра
        frame_namePrefix="frame",  # Префикс имени кадра
        frame_saveStyle="jpg",  # Тип сохранения кадра
        jpg_quality=95,  # Качество jpg
        png_quality=3,  # Качество png
        logName="ows.log",  # Название журнала
        logMode="a",  # Режим журнала
        is_compress=False,  # Сжать кадр
        compressStyle="zip",  # Стиль сжатия
        is_autoCompressName=False,  # Автоматическое присвоение имени сжатому файлу
        compressName="ows",  # Пользовательское название сжатого файла
        compressMode="w",  # Режим сжатия
        is_rmbgColor=False,  # Удалить цвет фона
        rmbgColorMode="green",  # Цвет фона
        is_resizeWindow=False  # Изменить размер окна):

from rich import inspect
from opencv_webcam import opencv_webcam

print(inspect(opencv_webcam, methods=True))