[вернуться к оглавлению]

# LibRaw: структуры данных и константы

Структуры данных LibRaw определены в заголовочном файле libraw/libraw_types.h
Используемые константы определены в файле libraw/libraw_const.h

## Содержание:

1. Структуры данных
   1. libraw_data_t - основная структура данных LibRaw
   2. Структура libraw_iparams_t - основные параметры изображения
   3. Структура libraw_image_sizes_t - размеры изображения
   4. Структура libraw_colordata_t - информация о цвете
   5. Структура libraw_imgother_t - прочие параметры изображения
   6. Структура libraw_rawdata_t - хранение распакованых RAW-данных
   7. Структура libraw_thumbnail_t - описание Thumbnail
   8. Структура libraw_output_params_t - управление постобработкой в стиле dcraw
   9. Структура libraw_decoder_info_t - информация о декодере RAW-изображения
   10. Структура libraw_processed_image_t - данные, выводимые функциями dcraw_make_mem_image()/dcraw_make_mem_thumb()
2. Объекты абстракции ввода данных
   - Поля данных
3. Константы
   1. enum LibRaw_errors - коды ошибок
   2. Нештатные ситуации (warnings) возникающие при обработке RAW-данных
   3. enum LibRaw_decoder_flags - описание layout данных конкретного распаковщика форматов
   4. enum LibRaw_progress - текущее состояние объекта LibRaw
   5. enum LibRaw_thumbnail_formats - форматы данных Thumbnails
   6. enum LibRaw_image_formats - описание типов данных, содержащихся в структуре libraw_processed_image_t

## Структуры данных

### libraw_data_t - основная структура данных LibRaw

Структура libraw_data_t - это "обертка" для структур данных, доступных пользователю библиотеки.
При использовании C++ API она доступна как LibRaw::imgdata (экземпляр_класса.imgdata). Данные в этой структуре появляются после открытия файла через open_file, за исключением собственно изображения (заполняется по unpack()) и данных содержащих preview-данные (заполняются по вызову unpack_thumb())
Поля данных:

unsigned int progress_flags;
  В этом поле фиксируются проведенные фазы обработки изображения.
unsigned int progress_flags;
  В этом поле фиксируются подозрительные ситуации (warnings), возникшие при обработке изображения.
libraw_iparams_t idata;
  В этой структуре описаны извлеченные из RAW-файла основные параметры изображения. Детально поля структуры описаны ниже.
libraw_image_sizes_t sizes;
  В этой структуре описаны геометрические параметры изображения. Детально поля структуры описаны ниже.
libraw_colordata_t color;
  В этой структуре находятся извлеченные из файла цветовые данные. Детально поля структуры описаны ниже.
libraw_imgother_t other;
  Информационная структура данных, в нее помещаются извлеченные из файла параметры изображения, которые не нужны при дальнейшей обработке файла. Детально поля структуры описаны ниже.
libraw_thumbnail_t thumbnail;
  Структура данных, содержащая информацию о preview и сами данные preview. Все поля структуры кроме собственно данных preview заполняются в open_file() или других вызовах открытия потока (open_buffer(),open_datastream()), само изображение-preview считывается отдельным вызовом unpack_thumb(). Детально поля структуры описаны ниже.
libraw_rawdata_t rawdata;
  Структура данных, содержащая аллоцированный буфер для RAW-данных и копии параметров, которые могут меняться при обработке. Детально поля структуры описаны ниже.
ushort (*image)[4];
  Регион памяти, содержащий собственно пиксели изображения, заполняется при вызове raw2image(); или dcraw_process().
libraw_output_params_t params;
  Структура данных, предназначенная для управления пост-обработкой изображения (при использовании эмулятора dcraw). Детально поля структуры описаны ниже.

### Структура libraw_iparams_t - основные параметры изображения

char make[64];
  Изготовитель камеры.
char model[64];
  Модель камеры.
unsigned raw_count;
  Количество RAW-изображений в файле (0 - означает что файл не распознан).
unsigned dng_version;
  Версия DNG (для DNG-формата).
unsigned is_foveon;
  1 для матриц Foveon, 0 - для остальных.
  Матрицы Foveon поддерживаются в LibRaw-demosaic-pack-GPL2
int colors;
  Количество цветов в файле.
unsigned filters;
  Битовая маска, описывающая порядок цветовых пикселей в матрице (0 - для полноцветных RAW). 32 бита поля описывают 16 пикселов (8 строк по 2 пиксела, слева направа и сверху вниз), каждые два бита имеют значения от 0 до 3, соответствующие 4-м возможным цветам. Для удобной работы с этим полем предназначена функция COLOR(row,column) возвращающая номер активного цвета для данного пиксела.

  Специальные значения данного поля:

  - 1 - Leaf Catchlight с байеровской матрицей 16x16
  - 9 - Fuji X-Trans с матрицей 6x6
char xtrans[6][6];
  Эта матрица содержит мэппинг цветов в блоке 6x6 сенсора Fuji X-Trans.
char cdesc[5];
  Описание цветов с номерами 0-3 (RGBG,RGBE,GMCY или GBTG).

### Структура libraw_image_sizes_t - размеры изображения

В структуру libraw_image_sizes_t собраны все данные из файла, описывающие размеры изображения.
Поля данных:

ushort raw_height, raw_width;
  Полный размер RAW-изображения (включая рамку) в пикселах.
unsigned raw_pitch;
  Полный размер строки raw-данных в байтах. Он может быть больше, чем raw_width*размер пикселя.
ushort height, width;
  Размер видимой (содержательной) части изображения (без рамки).
ushort top_margin, left_margin;
  Координаты верхнего левого угла рамки (второй угол рассчитывается исходя из полного размера изображения и размера видимой части).
ushort iheight, iwidth;
  Размер выходного изображения (может отличаться от height/width для камер, где требуется поворот изображения, либо где пиксели неквадратные).
double pixel_aspect;
  Отношение ширины пикселя к высоте. Если оно отличается от единицы, то при выводе требуется масштабирование изображения по одной из осей.
int flip;
  Ориентация изображения (0 - не требует поворота, 3 - требуется поворот на 180, 5 - 90 градусов против часовой стрелки, 6 - 90 градусов по часовой).

### Структура libraw_colordata_t - информация о цвете

В структуру libraw_colordata_t собраны все цветовые данные, как полученные из RAW-файла, так и рассчитанные на основании самого изображения. Для разных камер работают разные способы работы с цветом.
Поля данных:

ushort white[8][8];
  Блок белых пикселей, извлекаемый из файлов CIFF/CRW. Для других форматов не извлекается, используется для расчетов коэффициентов баланса белого.
float cam_mul[4];
  Коэффициенты баланса белого (as shot). Либо считывается из файла, либо рассчитывается.
float pre_mul[4];
  Коэффициенты баланса белого для дневного света (Daylight balance). Либо считывается из файла, либо рассчитывается из данных файла, либо берутся hardcoded-константы.
float cam_xyz[4][3];
  Матрица преобразования из камерного RGB в XYZ. Константная таблица, разная для разных камер, полный аналог ColorMatrix формата DNG. Последняя строка для RGB-камер как правило нулевая, для CMYG и подобных - не нулевая.
float cmatrix[3][4];
  Матрица баланса белого, для части камер считывается из файла, из остальных рассчитывается.
float rgb_cam[3][4];
  Еще одна матрица баланса белого, считывается из файла для камер Leaf и Kodak.
ushort curve[0x4001];
  Camera tone curve, считывается для камер Nikon, Sony и некоторых других.
unsigned black;
  Уровень черного. Для некоторых камер будет равен нулю (что означает, что вычитание черного проведено на этапе распаковки или самой камерой), для некоторых камер рассчитывается на этапе распаковки, для некоторых - считывается из RAW-файла, для некоторых - hardcoded.
unsigned cblack[4];
  Поканальные поправки уровня черного. Уровень черного в i-м канале равен black+cblack[i];
unsigned maximum;
  Максимальное значение пикселя. Для ряда камер рассчитывается из данных, для ряда - hardcoded. Значение maximum может меняться на стадии постпроцессинга (после вычитания черного) и автоустановкой максимума на основании поканальных максимумов в реальных данных (регулируется параметром params.adjust_maximum_thr).
unsigned data_maximum;
  Максимальное значение пикселей в видимой области файла. Рассчитывается при вызове subtract_black().
ph1_t phase_one_data;
  Блок цветовых данных, считываемый для камер Phase One.
float flash_used;
float canon_ev;
  Поля используются для расчета баланса белого (для некоторых P&S камер Canon).
char model2[64];
  Для некоторых камер - версия Firmware.
void *profile;
  Указатель на извлеченный ICC-профиль (если он есть в RAW-файле).
unsigned profile_length;
  Длина ICC-профиля в байтах.

### Структура libraw_imgother_t - прочие параметры изображения

В структуру libraw_imgother_t собраны данные, считанные из RAW-файла и не нужные для пост-обработки изображения.
Поля данных:

float iso_speed;
  Чувствительность ISO.
float shutter;
  Выдержка.
float aperture;
  Диафрагма.
float focal_len;
  Фокусное расстояние.
time_t timestamp;
  Дата съемки.
unsigned shot_order;
  Серийный номер изображения.
unsigned gpsdata[32];
  GPS-данные.
char desc[512];
  Описание изображения.
char artist[64];
  Автор изображения.

### Структура libraw_rawdata_t - хранение распакованых RAW-данных

В структуре libraw_rawdata_t хранятся следующие данные:

- RAW-данные с сенсора, получаемые на этапе чтения и распаковки данных камеры вызовом unpack().
- Резервная копия данных о размерах, цветах и ряде других параметров, которые могут модифицироваться на этапе постобработки данных.

Поля данных:

void *raw_alloc;
  Буфер, аллоцированный для хранения RAW-данных.
unsigned short *raw_image;
  Указатель на буфер для хранения 1-компонентных (байеровских) данных.
unsigned short (*color3_image)[3] ;
  Указатель на буфер для хранение 3-компонентных (полноцветных) raw-данных.
unsigned short (*color4_image)[4] ;
  Указатель на буфер для хранение 4-компонентных (полноцветных) raw-данных.

Все прочие поля являются служебными и не предназначены для использования в пользовательских программах.

После вызова unpack() только одно из полей raw_image/color3_image/color4_image будет ненулевым.

### Структура libraw_thumbnail_t - описание Thumbnail

Структура libraw_thumbnail_t описывает все параметры, связанные с сохраненным в RAW-файле preview.
Поля данных:

LibRaw_thumbnail_formats tformat;
  Формат данных thumbnail. Одно из значений enum LibRaw_thumbnail_formats.
ushort twidth, theight;
  Размер preview-изображения в пикселах.
unsigned tlength;
  Длина thumbnail в байтах.
int tcolors;
  Количество цветов preview.
char *thumb;
  Указатель на thumbmail, извлеченный из файла данных.

### Структура libraw_output_params_t - управление постобработкой в стиле dcraw

Структура libraw_output_params_t используется для управления dcraw-совместимыми вызовами dcraw_process(), dcraw_ppm_tiff_writer(), dcraw_thumb_writer(). Поля этой структуры соответствуют ключам командной строки программы dcraw.
Поля данных:

unsigned greybox[4];
  Ключи dcraw: -A x1 y1 width height
  4 числа, отвечающие координатам (в пикселах) прямоугольника по которому рассчитывается баланс белого: верхний левый угол, ширина и высота. Координаты задаются для неповернутого изображения.
unsigned cropbox[4];
  Ключи dcraw:нет
  4 числа, отвечающие координатам (в пикселах) прямоугольника, до которого будет обрезано результирующее изображение: верхний левый угол, ширина и высота. Координаты задаются для неповернутого изображения. Результат обрезания затем может быть повернут в соответствии со значениями flip и user_flip.
double aber[4];
  Ключи dcraw: -C
  Исправление хроматических аббераций, задаются только
  aber[0] - множитель красного
  aber[2] - множитель зеленого. Для ряда форматов влияет на чтение RAW-данных т.к. при коррекции аберраций выходной размер меняется.
double gamm[6];
  Ключи dcraw: -g
  Задание пользовательской гамма-кривой. Должны быть установлены первые два поля в массиве:
  gamm[0] - инвертированный (1.0/g) показатель степени
  gamm[1] - наклон для начальной линейной части. Для получения чистой степенной функции должно быть установлено в 0.
  Остальные 4 значения в этом поле заполняются автоматически.

  По-умолчанию используются настройки спецификации BT.709: степень 2.222, наклон 4.5. Для задания sRGB-кривой нужно ставить значения gamm[0]=1/2.4 и gamm[1]=12.92. Для простой степенной функции без линейного участка наклон линейной части задается нулевым, для линейной кривой нужно устанавливать gamm[0]=gamm[1]=1.

float user_mul[4];
  Ключи dcraw: -r mul0 mul1 mul2 mul3
  4 множителя (r,g,b,g) пользовательского баланса белого
unsigned shot_select;
  Ключи dcraw: -s
  выбор номера изображения для обработки (для форматов, содержащих несколько RAW-изображений в одном файле)
float bright;
  Ключи dcraw: -b
  Яркость (умолчание 1.0)
float threshold;
  Ключи dcraw: -n
  Параметр для подавления шума через wavelet denoising.
int half_size;
  Ключи dcraw: -h
  Выводить изображение в половинном размере. Для ряда форматов влияет на чтение RAW-данных.
int four_color_rgb;
  Ключи dcraw: -f
  Включает отдельную интерполяцию для двух зеленых компонент.
int highlight;
  Ключи dcraw: -H
  0-9 - Highlight mode (0=clip, 1=unclip, 2=blend, 3+=rebuild)
int use_auto_wb;
  Ключи dcraw: -a
  Использовать автобаланс белого, полученный после усреднения всего изображения.
int use_camera_wb;
  Ключи dcraw: -w
  Использовать баланс белого полученный из камеры, если это возможно.
int use_camera_matrix;
  Ключи dcraw: +M/-M
  Использовать (1)/не использовать(0) camera color matrix.
int output_color;
  Ключи dcraw: -o число
  [0-5] Output colorspace (raw,sRGB,Adobe,Wide,ProPhoto,XYZ)
char* output_profile;
  Ключи dcraw: -o имя файла
  Путь к ICC-файлу выходного профиля (используется только если библиотека собрана с поддержкой LCMS)
char* camera_profile;
  Ключи dcraw: -p имя файла
  Путь к ICC-файлу профиля камеры (используется только если библиотека собрана с поддержкой LCMS)
char* bad_pixels;
  Ключи dcraw: -P имя файла
  Путь к файлу с картой плохих пикселов (в формате "столбец строка дата-появления в unix-формате", по одной записи на строку).
char* dark_frame;
  Ключи dcraw: -K имя файла
  Путь к файлу с темновым кадром (16-битный PGM-файл, полученный, например, запуском dcraw -D).
int output_bps;
  Ключи dcraw: -4
  8 bit (default)/ 16 bit (ключ -4)
int output_tiff;
  Ключи dcraw: -T
  0/1 - выводить PPM/TIFF
int user_flip;
  Ключи dcraw: -t
  [0-7] Flip image (0=none, 3=180, 5=90CCW, 6=90CW) Умолчание -1, означает брать из RAW.
  Для ряда форматов влияет на чтение RAW-данных, в частности на распаковку thumbnails от камер Kodak.
int user_qual;
  Ключи dcraw: -q
  0-10: качество и вид интерполяции (дебайеризации):
  - 0 - линейная интерполяция
  - 1 - VNG-интерполяция
  - 2 - PPG-интерполяция
  - 3 - AHD-интерполяция
  - 4 - DCB-интерполяция
  - 5 - Модифицированная AHD-интерполяция
  - 6 - AFD-интерполяция (5-проходов)
  - 7 - VCD-интерполяция
  - 8 - Смешанная VCD/измененная AHD
  - 9 - LMMSE-интерполяция
  - 10 - AMaZE-интерполяция
  - 11 - DHT-интерполяция
  - 12 - Еще одна модицифицированная AHD
  Значения 5-9 имеют смысл только если LibRaw скомпилирована с "LibRaw demosaic pack GPL2" (файл README.demosaic-packs в вашем дистрибутиве LibRaw описывает это в подробностях). Значение 10 (AMaZe-интерполяция) имеет смысл только если LibRaw скомпилирована с "LibRaw demosaic pack GPL3".
  Если задан неподдерживаемый LibRaw вариант (например, demosaic pack не вкомпилирован), будет выполнена AHD-интерполяция.
int user_black;
  Ключи dcraw: -k
  Пользовательский уровень черного.
int user_cblack;
  Ключи dcraw: нет
  Пользовательские поканальные поправки к уровню черного.
int sony_arw2_hack;
  Ключи dcraw: нет
  Выключает деление данных, полученных из файлов Sony ARW (вторая версия: современные камеры NEX и SLT) на 4, увеличивая количество значащих битов в теневой части изображения.
int user_sat;
  Ключи dcraw: -S
  Регулировка насыщенности.
int med_passes;
  Ключи dcraw: -m
  Количество проходов median filter
int no_auto_bright;
  Ключи dcraw: -W
  Не использовать автоматическое повышение яркости по гистограмме.
float auto_bright_thr;
  Ключи dcraw:нет
  Доля пикселов, которые будут насыщены при использовании автоматического повышения яркости. Значение по-умолчанию 0.01 (для совместимости с dcraw), рекомендованное стартовое значение для современных многомегапиксельных малошумных камер 0.001-0.00003.
float adjust_maximum_thr;
  Ключи dcraw:нет
  Этот параметр управляет авто-установкой значения maximum, используемого на стадии постпроцессинга. Если поканальный максимум (data_maximum) больше чем maximum*adjust_maximum_thr, то поле maximum будет установлено в значение, рассчитанное по данным конкретного снимка.
  Стандартное значение поля: 0.75. Если вы установите его больше чем 0.99999, то будет использовано стандартное значение. Если вы установите adjust_maximum_thr меньше чем 0.00001, то корректировка максимума будет выключена.
  Автокорректировка максимума не должна повреждать снимки (особенно если используется стандартное значение), но очень полезна при обработке снимков с выбитыми (пересвеченными) участками и позволяет автоматически бороться с "розовыми облаками" (для дневного света) и с "сине-зелеными светами" (для освещения лампами накаливания).
int use_fuji_rotate;
  Ключи dcraw: -j
  Умолчание - 1 (использовать), 0 - отключает поворот для камер на сенсоре Fuji.
int green_matching;
  Включает подавление разбаланса чувствительности зеленых каналов. Ключи dcraw: нет
  Умолчание - 0 (не использовать), 1 - включает этот этап обработки. Включение этого режима требует удвоенного количества памяти под bitmap.
int dcb_iterations
  Ключи dcraw: нет
  Количество циклов коррекции после DCB-алгоритма. Умолчание - нет коррекции.
int dcb_enhance_fl
  Ключи dcraw: нет
  ненулевое значение: усиливать цвета после DCB-интерполяции.
int fbdd_noiserd
  Ключи dcraw: нет
  Управляет алгоритмом подавления шума FBDD перед демозаикой (интерполяцией)
  - 0 - не использовать FBDD
  - 1 - легкое подавление шума
  - 2 - полное подавление шума
int eeci_refine
  Ключи dcraw: нет
  ненулевое значение - Использовать алгоритм EECI refine после VCD+AHD-интерполяции.
int es_med_passes
  Ключи dcraw: нет
  Количество проходов медианного фильтра, чувствительного к границам для подавления артефактов VCD+AHD интерполяции. Значения больше 1 не рекомендуются.
int ca_correc
  Ключи dcraw: нет
  положительное значение - подавлять хроматическую аберрацию перед интерполяцией.
float cared,cablue
  Ключи dcraw: нет
  Если одно из этих полей имеет отличное от нуля значение, то автоматическая подборка параметров коррекции аберрации производиться не будет. Диапазон значений обеих полей: +-0.1..+-4.
int cfaline; float linenoise;
  Подавление полосатости (banding).
  cfaline - положительное значение включает подавление.
  linenoise - степень подавления, разумный диапазон параметра от 0.001 до 0.02.
int cfa_clean; float lclean,cclean;
  Подавляет импульсный (высокочастотный) шум.
  cfa_clean: положительное значение включает подавление.
  lclean,cclean - Степень подавления для яркостного (lclean) и цветового (cclean) шумов. Разумное значение от 0.005 до 0.05.
int cfa_green; float green_thresh;
  Подавление "лабиринтных" артефактов, возникающих из-за неравенства каналов зеленого.
  cfa_green - положительное значение включает подавление.
  green_thresh - максимальное различие междк каналами при котором происходит выравнивание. Разумные значения от 0.01 до 0.1.
int exp_correc; float exp_shift,exp_preser;
  Экспокоррекция перед байеровской интерполяцией.
  - exp_correc: положительное значение включает экспокоррекцию (умолчание: выключено).
  - exp_shift: экспозиционный сдвиг в линейной шкале. Нормально обрабатываются значения от 0.25 (затемнение на 2 ступени экспозиции) до 8.0 (осветление на 3 ступени). Умолчание: 1.0 (нет экспокоррекции).
  - exp_preser: степень сохранения деталей в светах при осветлении изображения. Диапазон значений от 0.0 (линейный сдвиг экспозиции с вылетом светов) до 1.0 (максимальное сохранение деталей в светах). Умолчание: 0.0.
int wf_debanding; float wf_deband_treshold[4];
  wf_debanding: 1 включает подавление полосатости, 0 - выключает.

  wf_deband_treshold[] - поканальные пороги подавления.

int use_rawspeed;
  Включает использование библиотеки RawSpeed (только если LibRaw собрана с поддержкой этой библиотеки)
int no_auto_scale;
  Запрещает масштабирование значений пикселов (LibRaw::scale_colors()) при обработке в LibRaw::dcraw_process()
int no_interpolation;
  Запрещает вызов демозаики при обработке в LibRaw::dcraw_process()
int sraw_ycc;
  Запрещает преобразование из YCbCr в RGB для файлов Canon sRAW/mRAW.

### Структура libraw_decoder_info_t - информация о декодере RAW-изображения

Данная структура описывает декодер RAW-формата и включает два поля данных:

const char *decoder_name
  Имя декодирующей функции (в информационных целях)
unsigned decoder_flags
  Флаги декодера, описывающие формат выдаваемых им данных. См список LibRaw_decoder_flags.

### Структура libraw_processed_image_t - данные, выводимые функциями dcraw_make_mem_image()/dcraw_make_mem_thumb()

Структура libraw_processed_image_t - порождается в результате работы функций dcraw_make_mem_image()/dcraw_make_mem_thumb() и содержит образ данных изображения или preview.
Поля данных:

LibRaw_image_formats type
  Тип данных, содержащихся в структуре:
  - LIBRAW_IMAGE_BITMAP - структура содержит обычный RGB или серый bitmap, размеры которого и прочие характеристики описываются параметрами данной структуры (см. ниже).
  - LIBRAW_IMAGE_JPEG - структура содержит значимые поля data_size и data, в поле data находится структура данных JPEG-файла.
ushort height,width
  Размер изображения в пикселах. Эти поля данных валидны только если type==LIBRAW_IMAGE_BITMAP.
ushort colors, bits
  Количество цветов (3 или 1) и глубина цвета в битах (8 или 16). Эти поля валидны только если type==LIBRAW_IMAGE_BITMAP
ushort gamma_corrected
  Являются ли значения данных гамма-корректироваными (0 или 1).Эти поля данных валидны только если type==LIBRAW_IMAGE_BITMAP.
unsigned int data_size
  Размер следующего поля (data) в байтах. В случае type==LIBRAW_IMAGE_BITMAP его, конечно, несложно вычислить как (height*width*colors * (bits/8)). В случае type==LIBRAW_IMAGE_JPEG - вычислить никак нельзя, а размер данных может быть нужен.
unsigned char data[]
  Массив данных, содержащий либо RGB-битмэп, либо JPEG-файл (в памяти), в зависимости от значения поля type.

## Объекты абстракции ввода данных

Ввод (чтение) RAW-данных в LibRaw обеспечивается объектом, производным от класса LibRaw_abstract_datastream. Функциональность этих объектов подробно описана в описании C++ API.

LibRaw предлагает две готовых реализации объектов datastream:

- LibRaw_file_datastream - ввод из файла (объект создается для файла с заданным именем).
- LibRaw_buffer_datastream - ввод из буфера в памяти (это может быть mmap()-ed файл или буфер со считанными RAW-данными).

Пользователь библиотеки может запрограмировать свой объект, производный от LibRaw_abstract_datastream, реализующий, например, чтение RAW-файла через интерфейс удаленного управления камерой, и использовать LibRaw c этим объектом через интерфейс LibRaw::open_datastream().

Входящие в библиотеку реализации потока данных могут быть использованы как через посредство интерфейса LibRaw::open_datastream(), так и через shortcuts LibRaw::open_file() и LibRaw::open_buffer().

Переопределение интерфейса ввода и интерфейс LibRaw::open_datastream() доступны только пользователям C++ API, пользователи C API могут использовать только встроенные интерфейсы libraw_open_file()/libraw_open_buffer().

### Поля данных

Определение:

    class LibRaw_abstract_datastream {
    ...
    protected:
        LibRaw_abstract_datastream *substream;
    }

Описание: Объекты производные от LibRaw_abstract_datastream всегда содержат указатель на вторичный поток данных (substream), этот поток данных инициализируется при необходимости временно переключить ввод на расшифрованные метаданные, считанные из файла во временный буфер (актуально только для камер Sony).

Подробнее работа с вторичным потоком данных описана в описании реализации собственных объектов ввода данных.

## Константы

### enum LibRaw_errors - коды ошибок

Все функции, возвращающие целые числа, возвращают либо errno, либо один из следующих кодов ошибок (см. также соглашения о кодах ошибок)

Фатальные ошибки (получение такого кода ошибки означает безусловное прекращение обработки файла, ибо структуры данных находятся в неизвестном состоянии).

LIBRAW_UNSUFFICIENT_MEMORY
  Попытка получения памяти от системы закончилась неудачей.
  Все аллоцированные ресурсы будут освобождены, вызвана функция recycle(), объект LibRaw приведен в состояние "сразу после создания".
LIBRAW_DATA_ERROR
  При распаковке данных возникла фатальная ошибка.
  Все аллоцированные ресурсы будут освобождены, вызвана функция recycle(), объект LibRaw приведен в состояние "сразу после создания".
LIBRAW_IO_ERROR
  При чтении файла возникла фатальная ошибка (файл закончился раньше времени, либо поврежден).
  Все аллоцированные ресурсы будут освобождены, вызвана функция recycle(), объект LibRaw приведен в состояние "сразу после создания".
LIBRAW_CANCELLED_BY_CALLBACK
  Обработка завершена досрочно по требованию вызывающего приложения (путем возврата ненулевого кода из progress callback.
  Все аллоцированные ресурсы будут освобождены, вызвана функция recycle(), объект LibRaw приведен в состояние "сразу после создания".
LIBRAW_BAD_CROP
  Заданы неверные координаты прямоугольника обрезания выходного изображения (cropbox): левый верхний угол находится вне изображения. Обработка не может быть продолжена и завершена досрочно. Все аллоцированные ресурсы будут освобождены, вызвана функция recycle(), объект LibRaw приведен в состояние "сразу после создания".

Нефатальные ошибки

LIBRAW_SUCCESS=0
  Нет ошибки, функция завершилась успешно.
LIBRAW_UNSPECIFIED_ERROR
  Произошла неизвестная ошибка. Этот код не должен выдаваться никогда.
LIBRAW_FILE_UNSUPPORTED
  Не поддерживаемый формат файла (попытка открыть RAW-файл неизвестного программе формата).
LIBRAW_REQUEST_FOR_NONEXISTENT_IMAGE
  Попытка извлечь RAW-изображение с номером, не существующим в файле данных (только для форматов, поддерживающих хранение нескольких изображений в одном файле).
LIBRAW_OUT_OF_ORDER_CALL
  Функции API вызывались в неправильном порядке (например, unpack() до open_file()), либо предыдущая стадия завершилась с ошибкой (например, вызываем unpack() если open_file() вернула ошибку).
LIBRAW_NO_THUMBNAIL
  Возвращается при попытке получить thumbnail из файла, не содержащего preview.
LIBRAW_UNSUPPORTED_THUMBNAIL
  RAW-файл содержит preview неподдерживаемого формата.
LIBRAW_INPUT_CLOSED
  Была сделана попытка вызвать unpack() или unpack_thumb() при уже закрытом потоке данных.

### enum LibRaw_decoder_flags - описание layout данных конкретного распаковщика форматов

В зависимости от свойств конкретного формата RAW-данных, распаковщик использует различные форматы буфера под raw-данные. Существуют такие типы буферов:

LIBRAW_DECODER_FLATFIELD
  "Плоский" буфер, одно 16-битное значение на пиксел. Этот формат используется для всех байеровских матриц. Маскированная (черная) рамка хранится вместе с изображением, размер буфера [raw_width*raw_height];
LIBRAW_DECODER_4COMPONENT
  Хранится четыре 16-битных значений на пиксел. Этот формат используется для большинства полноцветных изображений (sRAW, multishot MF backs, DNG с проведенной демозаикой).
LIBRAW_DECODER_LEGACY
  Аналогичен LIBRAW_DECODER_4COMPONENT, но черная рамка отсутствует. Размер буфера [width*height].
LIBRAW_DECODER_HASCURVE
  Флаг выставляется, если в декодере используется тоновая кривая, данные для которой можно изменить до вызова декодера (т.е. кривая не считываются внутри декодера).

### enum LibRaw_progress - текущее состояние объекта LibRaw

В LibRaw::imgdata.progress_flags содержится битовая маска, описывающая все стадии обработки, уже проведенные над файлом.

Фаза открытия файла и извлечения RAW-данных.

LIBRAW_PROGRESS_START=0
  Объект только создан, никакой обработки не проводилось.
LIBRAW_PROGRESS_OPEN
  Обрабатываемый файл открыт
LIBRAW_PROGRESS_IDENTIFY
  Проведена идентификация данных, формат опознан, извлечены метаданные.
LIBRAW_PROGRESS_SIZE_ADJUST
  Проведено выравнивание размеров данных (для тех файлов, которым это нужно, а это некоторые файлы с камер Kodak).
LIBRAW_PROGRESS_LOAD_RAW
  Загружены RAW-данные.

Следующие флаги выставляются при использовании обработки изображений, позаимствованной у dcraw.

LIBRAW_PROGRESS_RAW2_IMAGE
  Аллоцирован и заполнен массив imgdata.image
LIBRAW_PROGRESS_REMOVE_ZEROES
  Удалены нулевые значения для тех камер, для которых это нужно (камеры Panasonic).
LIBRAW_PROGRESS_BAD_PIXELS
  Удалены плохие пикселы (если включена соотв. опция)
LIBRAW_PROGRESS_DARK_FRAME
  Проведено вычитание темнового кадра (если включена соотв. опция)
LIBRAW_PROGRESS_FOVEON_INTERPOLATE
  Проведена интерполяция для камер с сенсором Foveon.
LIBRAW_PROGRESS_SCALE_COLORS
  Произведена балансировка белого.
LIBRAW_PROGRESS_PRE_INTERPOLATE
  Проведено удаление плохих пикселов (если соответствующий режим задан в настройках).
  Проведено вычитание темнового кадра (если соответствующий режим задан в настройках).
  Проведено уменьшение изображения (для режима half_size) и копирование 2-го канала зеленого в первый в тех точках, где 2-й канал есть, а первого - нет.
LIBRAW_PROGRESS_INTERPOLATE
  Проведена интерполяция (де-байеризация).
LIBRAW_PROGRESS_MIX_GREEN
  Проведено усреднение каналов зеленого.
LIBRAW_PROGRESS_MEDIAN_FILTER
  Проведена медианная фильтрация.
LIBRAW_PROGRESS_HIGHLIGHTS
  Проведена работа со светами.
LIBRAW_PROGRESS_FUJI_ROTATE
  Для изображений с камер Fuji проведен поворот (либо вызвана adjust_sizes_info_only()).
LIBRAW_PROGRESS_FLIP
  Для изображений, снятых повернутой камерой, произведен пересчет размеров (sizes.iwidth/sizes.iheight поменяли местами).
LIBRAW_PROGRESS_CONVERT_RGB
  Проведена конверсия в выходное RGB-пространство.
LIBRAW_PROGRESS_STRETCH
  Произведено изменение размеров изображения для камер с неквадратными пикселами.
LIBRAW_PROGRESS_STAGE17 - LIBRAW_PROGRESS_STAGE27
  Зарезервировано на случай появления других стадий обработки.

Следующие флаги выставляются при загрузке thumbnails.

LIBRAW_PROGRESS_THUMB_LOAD
  Произведена загрузка данных Thumbnail (для камер Kodak - еще сделаны необходимые преобразования).
LIBRAW_PROGRESS_TRESERVED1 - LIBRAW_PROGRESS_TRESERVED3
  Зарезервировано на случай появления других стадий обработки.

### enum LibRaw_thumbnail_formats - форматы данных Thumbnails

Формат данных thumbnail записывается в поле данных imgdata.thumbnail.tformat.
На сегодняшний день LibRaw знает о четырех форматах thumbnail из которых распаковываются два:

LIBRAW_THUMBNAIL_UNKNOWN
  Формат неизвестен или thumbnail еще не читался.
LIBRAW_THUMBNAIL_JPEG
  В буфере thumbnail лежит JPEG-файл (считанный as-is из RAW-файла, каких-либо манипуляций над ним не проводится).
LIBRAW_THUMBNAIL_BITMAP
  В буфере для thumbnaill лежит гамма-скорректированный RGB-bitmaip (для камер Kodak гамма-коррекция проводится с учетом максимальных значений, а баланс белого выставляется в соответствии с настройками камеры)
  В этом формате каждый пиксель изображения представлен 8-битным RGB-триплетом.
LIBRAW_THUMBNAIL_LAYER
  Формат данных в настоящее время распознается при открытии RAW-файла, но не поддерживается: не распаковывается в LibRaw::unpack_thumb.
LIBRAW_THUMBNAIL_ROLLEI
  Формат данных в настоящее время распознается при открытии RAW-файла, но не поддерживается: не распаковывается в LibRaw::unpack_thumb.

### Нештатные ситуации (warnings) возникающие при обработке RAW-данных

При обработке изображений могут возникнуть сомнительные ситуации, не являющиеся фатальными, но возможно влияющие на результат извлечения данных или их постобработки. Индикация таких состояний производится путем установки бита в поле imgdata.process_warnings

LIBRAW_WARN_FOVEON_NOMATRIX
  Только для камер на Foveon: не удалось извлечь одну из матриц данных.
LIBRAW_WARN_FOVEON_INVALIDWB
  Только для камер на Foveon: не удалось извлечь данные о балансе белого.
LIBRAW_WARN_BAD_CAMERA_WB
  При постобработке задано использовать баланс белого камеры, а он непригоден для использования.
LIBRAW_WARN_NO_METADATA
  Только для камер, где метаданные берутся из внешнего jpeg: не удалось извлечь метаданные.
LIBRAW_WARN_NO_JPEGLIB
  Только для P&S камер Kodak: данные в формате JPEG. Одновременно open_file() вернет LIBRAW_FILE_UNSUPPORTED.
LIBRAW_WARN_NO_EMBEDDED_PROFILE
  (Только при включенной поддержке ICC). Задано использование вложенного профиля камеры, но в RAW-файле нет профиля.
LIBRAW_WARN_NO_INPUT_PROFILE
  (Только при включенной поддержке ICC). Заданный файл с профилем входных данных не удалось открыть.
LIBRAW_WARN_BAD_OUTPUT_PROFILE
  (Только при включенной поддержке ICC). Заданный файл с выходным профилем не удалось открыть.
LIBRAW_WARN_NO_BADPIXELMAP
  Заданный файл с картой плохих пикселов не удалось открыть.
LIBRAW_WARN_BAD_DARKFRAME_FILE
  Заданный файл с темновым кадром не удалось открыть.
LIBRAW_WARN_BAD_DARKFRAME_DIM
  Темновой кадр либо имеет размеры, отличающиеся от обрабатываемого кадра, либо имеет неверный формат (нужен 16-bit PGM, можно сгенерировать запуском примера simple_dcraw -4 -D)
LIBRAW_WARN_RAWSPEED_PROBLEM
  При декодировании файла библиотекой RawSpeed возникла проблема. Файл был декодирован собственным декодером LibRaw
LIBRAW_WARN_RAWSPEED_UNSUPPORTED
  Файл не поддерживается RawSpeed и был декодирован декодером LibRaw
LIBRAW_WARN_RAWSPEED_PROCESSED
  (не warning, информационный флаг) Файл был декодирован библиотекой RawSpeed

### enum LibRaw_image_formats - описание типов данных, содержащихся в структуре libraw_processed_image_t

Поле type структуры libraw_processed_image_t может принимать одно из следующих значений:

LIBRAW_IMAGE_BITMAP
  В структуре данных находится обычный RGB-bitmap (его параметры определены в прочих полях структуры).
LIBRAW_IMAGE_JPEG
  В структуре данных находится образ JPEG-файла, в метаданных определена только его длина.

[вернуться к оглавлению]

Last modified: Wed Oct 19 13:09:51 MSD 2011