Руководство пользователя

Для версии 0.2.6

Введение
Установка, удаление и обновление
Настройка
Работа с программой
Использование Профилей
Введение
В настоящее время сложилось два основных подхода к процессу перекодировки мультимедийной информации.
Первый подход это использование скриптов. Он не заменим когда нужно автоматизировать весь процесс кодирования, но у него есть некоторые недостатки. К примеру практически невозможно при помощи скрипта точно подстроить параметры кодеков под определённый видеоматериал, человеку не знакомому с программированием сложно изменить алгоритм его работы, затруднена настройка видеофильтров (к примеру фильтра образки) и т.д.

Вторым подходом является использование фронтэндов. Этот способ хорошо подходит неопытным пользователям, но большинство фронтэндов малофункционально, рассчитаны на поддержку только одного кодировщика и неспособны при завершении работы сохранять свои настройки. Иногда последний недостаток частично компенсируется поддержкой шаблонов.

Хризопея это не просто ещё один фронтэнд-перекодировщик, а полностью новый подход ко всему процессу перекодировки. По принципу работы Хризопея схожа со скриптом, но все пользовательские действия выполняются в графической оболочки. В результате удалось избавися от большинства вышеперечисленных недостатков. Хризопея имеет модульную архитектуру т.е. её функциональность не привязана к определённой программе, а полностью зависит от установленных модулей и может быть легко расширен за счёт добавления новых. В свою очередь модуль имеет простую структуру и может быть создан даже начинающим программистом.

Хризопея состоит из трёх основных частей:
1) Собственно Хризопея. Её задача предоставить интерфейс для настройки и запуска профиля. Она также предоставляет ряд сервисных функций: Установку модулей и профилей, поддержку шаблонов, просмотр команды запуска кодировщика и т.п.
2) Профиль. Это цепочка последовательно выполняемых действий которая служит для описания технологического процесса перекодировки. Вся информация о настройках хранится в профили. При запуске кодирования Хризопея последовательно запускает модули настройки которых включены в состав профиля.
3) Модули. Они добавляют поддержку кодировщиков. Модули могут быть настроены при помощи Субмодулей. Субмодуль это функционально связанный с модулем компонент который предоставляет графический интерфейс для настройки. Субмодуль может отсутствовать у модулей не требующих специальных настроек.

Установка, удаление и обновление
Системные требования: Хризопея проверялась на системе Debian Linux 5.0, но должна работать практически на любой современной UNIX системе. Обязательно должны быть установлены: Python не ниже 2.3 (желательно 2.4 или 2.5) и PyQt4.4 или выше (пакет в зависимости от дистрибутива может называться qt-python или python-qt). Желательно присутствие библиотеки PIL.

Установка и удаление: Для установки или удаление Хризопеи необходимо перейти в папку с программой и от имени пользователя root запустить инсталлятор "install.py". Инсталлятор имеет следующий синтаксис:

install.py --install(--uninstall) [каталог_установки]

Если первым параметром является "--install", то произойдёт установка, если "--uninstall" удаление. При помощи второго параметра указывают каталог для установки. Если он не указан, то каталогом установки будет считаться "/usr". Пример:

#./install.py --install Установка в каталог /usr
#./install.py --install /usr/local Установка в каталог /usr/local
#./install.py --uninstall /usr/local Удаление из каталога /usr/local

Для запуска программы служит команда $ hrizopea.
Начиная с версии 0.2 программа не требует обязательной установки и может быть запущена непосредственно из текущего каталога. Для этого нужно перейти в каталог с программой и выполнить команду $./hrizopea. Если Хризопея была запущена в "портативном" варианте и в её состав были внесены изменения (установлены модули, созданы профили и т.п), то при дальнейшей установки эти изменения будут перенесены в установленную программу.

Обновление: Если у вас установлена предыдущая версия Хризопеи, то для её обновления запустите процесс установки как это было описано выше. Обнаружив установленную Хризопею инсталлятор запросит подтверждение обновления, после чего надо нажать клавишу "1". После обновления установленной программы необходимо обновить пользовательскую конфигурацию. Для этого перейдите в каталог "~/.hrizopea" и удалить всё кроме каталога профилей ("~/.hrizopea/profili") и запустите Хризопею.
Настройка

Первые 2 пункта в диалоге настройки включают или отключают отображение пиктограмм для модулей и профилей. Пункт "Открывать Диалог Настройки Модуля после его добавления" включает вызов диалога субмодуля после добавления действия в профиль.
Пункт "Понижать приоритет у выполняемых программ" является аналогом системной команды nice. С его помощью можно понизить приоритет у всех программ которые будут запускаться Хризопией во время выполнения профиля.
Важным является список "Пути Поиска Программ и их приоритет". В нём указывают каталоги в которых Хризопея будет производить поиск кодировщиков. Каталоги распологаются в порядки своего приоритета. Т.е. если следовать рисунку то Хризопея будет искать нужную программу сначала в каталоге "/usr/local/bin", если она не будет там найдена, то поиск перейдёт в каталог "/usr/bin", а затем в "/bin". Если ни в одном из путей указанных в списке поиск не принесёт результата то Хризопея сообщит о том что программа не обнаружена. Такой механизм поиска может быть полезен если в системе установлено белее одного экземпляра одной и той же программы.

Работа с программой

Работу с программой начинают с создания или выбора нужного профиля. Для выбора текущего профиля служит выпадающей список находящимся в верху окна. После нажатия на кнопку "Профиль" откроется диалог "Управление профилями". При помощи которого можно создавать, удалять, или переименовывать профили.


Для создания нового профиля необходимо ввести его имя в текстовом поле диалога управления профилями и нажать на кнопку "Создать". Любой профиль может быть переименован для этого надо выбрать из выпадающего списка название нужного профиля и ввести новое имя в текстовом поле. После нажатия на кнопку "Переименовать" профиль получит новое имя. Для удаления ненужного профиля надо выбрать профиль в выпадающем списке и нажать на кнопку "Удалить".
Профили могут быть сохранены в отдельные файлы и установлены из них. Для этого служат кнопки "Установить" и "Сохранить". Профиль находящийся в файле может быть открыт без установки. Для этого нужно выполнить команду:

$hrizopea полный_путь_к файлу_профиля

Вновый профиль нужно добавить те действия которые необходимо выполнить в ходе перекодировки. Вся последовательность действий (модули) входящая в состав профиля отображаются в списке модулей. Кнопка "Удалить модуль" удаляет действие из профиля, а кнопки с стрелками меняют порядок их выполнения.

Для добавления действия в профиль нужно при помощи кнопки "Модуль" вызвать диалог "Управление модулями". После нажатия на кнопку "Выбрать" в состав профиля будет добавлен модуль название которого выбрано в верхнем выпадающем списке. Если необходимо сделать копию модуля идентичную текущему (к примеру это может быть полезно при многопроходном кодировании), то нужно воспользоваться кнопкой "Клонирование". Кнопки "Установить" и "Удалить" имеют такое же значение как и в диалоге "Управление профилями".
Хризопея поддерживает механизм шаблонов. Т.е. после добавления модуль может быть переведён в предустановленное состояние которое было заранее определено пользователем или разработчиком. Для добавления предустановленного модуля в списке шаблонов должен быть выбран необходимый шаблон. Для создания нового шаблона нужно добавить модуль, настроить его нужным образом, а затем нажать кнопку "Создать Шаблон" и в открывшемся диалоге ввести имя нового шаблона. Начиная с версии 0.2.1 появилась возможность загружать параметры шаблона непосредственно во время настройки модуля. Для этого надо в окне субмодуля нажать кнопку "Сброс" и в появившемся диалоговом окне выбрать необходимый шаблон из которого и будут загружены настройки для модуля.
Кнопка "Удалить" удаляет установленные модули. Если в списке шаблонов выбран шаблонов, то будет удалён выбранный шаблон, а не модуль.
Обычно после добавления нового действия автоматически запускается его субмодуль. Субмодуль может быть вызван из главного окна при помощи кнопки "Настроить Модуль".

Очень важными параметрами для модулей является "Вход" и "Выход". Они определяют какие файлы будут переданы модулю и какие будут образованы во время его работы. В качестве входа модулю может быть передан выход предшествующего модуля.
Если входом модуля является каталог, то модуль будет запущен в пакетном режиме. Т.е. будут обработаны все файлы которые соответствуют отбору и находятся в указанном каталоге. Если нужно обрабатывать несколько каталогов или файлы разных типов, то клонируете уже настроенный модуль и соответствующем образом измените его вход.
В качестве выхода может быть выбран каталог для файлов или уже существующий файл.
Слева от выпадающих списков входа и выхода расположены список фильтра входных файлов (верхний) и список формата файлов (нижний). Первый из них определяет тип файлов на входе модуля при пакетном режиме его работы, а второй устанавливает формат файлов на выходе модуля.

Если "выводной" файл уже существует и он не указан явно в качестве вывода модуля, то в зависимости от выбранного параметра "Если файл уже существует" в диалоге настройки будет производится:
1) Переименовывать. Будет формироваться новый файл с именем оканчивающимся на "_n", где n это номер дубликата.
2) Перезаписывать. Старый файл заменяется новым.
3) Пропускать. Текущее действие будет пропущено.

Большинству модулей могут быть переданы дополнительные параметры. Для передачи этих параметров служит текстовое поля которое расположено ниже ввода и вывода модулей. Просмотреть команду с помощью которой будет запущен перекодировщик можно нажав кнопку "Команда". Текст команды как и вся служебная информация высвечивается в Информационном поле находящемся под строкой дополнительных параметров.

У профиля или отдельного модуля может быть собственное примечание. Примечание профиля отображается в Информационном поле до информации о модуле, а примечание модуля после. Оба примечания могут быть отформатированы при помощи html тегов. У профиля может быть установлена пиктограмма для этого надо нажать кнопку "Картинка профиля" и выбрать файл пиктограммы. Если файл не будет выбран, то существующая пиктограмма будет удалена.


Начиная с версии 0.2 доступны два режима кодирования. В первом режиме (активируется нажатием на кнопку "Запуск") обрабатывается весь профиль т.е. после запуска будут последовательно выполнены все действия входящие в состав профиля, а во втором режиме (активируется нажатием на кнопку "Текущий") можно выполнить отдельное действие включённое в профиль. В версии 0.2.5 был добавлен "Пакетный" режим запуска, он описан ниже.
После запуска кодирования за выводом кодировщиков можно наблюдать в основном окне программы, в самом низу показан лог кодирования в котором указано когда и какие файлы были перекодированы. Процесс кодирования может быть приостановлен или завершён при нажатии на кнопки "Пауза" или "Стоп". Кнопка "Пропустить" служит для пропуска текущего действия.

Использование Профилей
Как уже говорилось выше профиль служит для описания процесса перекодировки и состоит из отдельных действий причём каждое действие как правило имеет свой вход и выход.
Например нам надо выполнить следующие действия:
1) Разложить видео на кадры.
2) Обработать каждый кадр утилитой mogrify.
3) Заново создать из кадров видеофайл.
4) Удалить файлы кадров.

Это можно реализовать следующим образом:
1) Kadrator  - Раскладывает видео на кадры. (Вход - исходный файл, Выход - Каталог для кадров)
2) Convert - Обработка кадров при помощи mogrify. (Вход - Каталог для кадров, поскольку модуль не создаёт новых файлов то Выход отсутствует)
3) MEncoder_x264 - "Собирает" видео из кадров + наложение звука. (Вход - Каталог для кадров, Выход - результирующий файл). Если установить флажок возле этого модуля, то каталог кадров будет автоматически очищен после завершения работы модуля.
После запуска профиля  Kadrator разложит видео на кадры, Convert из обработает, а MEncoder_x264 сформирует окончательный видеофайл. Такой профиль будет правильно работать если нам нужно перекодировать только один файл. Но если мы попытаемся обработать несколько видеофайлов то в результате получим один файл который будет содержать кадры из всех исходных файлов. Для решения этой проблемы нужно использовать пакетный режим обработки профиля который активируется нажатием кнопки "Пакетный". В этом режиме файлы на входе первого модуля будут обрабатываться последовательно. Т.е. вышеперечисленная операция будет применена сначала к первому файлу, затем ко второму и т.д. Надо отметить что для правильной работы пакетного режима обязательно удаление промежуточных файлов.