תיעוד של WebP API

בקטע הזה מתוארים ממשקי ה-API של המקודד והפעמון שכלולים בספריית WebP. תיאור ה-API הזה רלוונטי לגרסה 1.5.0.

כותרות וספריות

כשמתקינים את libwebp, מתבצעת התקנה של ספרייה בשם webp/ במיקום הרגיל בפלטפורמה. לדוגמה, בפלטפורמות Unix, קבצי הכותרות הבאים יועתקו אל /usr/local/include/webp/.

decode.h
encode.h
types.h

הספריות נמצאות בספריות הרגילות. הספריות הסטטיות והדינמיות נמצאות ב-/usr/local/lib/ בפלטפורמות Unix.

Simple Decoding API

כדי להתחיל להשתמש ב-API לפענוח, צריך לוודא שהספרייה וקובצי הכותרות מותקנים כפי שמתואר למעלה.

מוסיפים את הכותרת של API לפענוח לקוד C/C++ באופן הבא:

#include "webp/decode.h"
int WebPGetInfo(const uint8_t* data, size_t data_size, int* width, int* height);

הפונקציה הזו תאמת את הכותרת של קובץ התמונה בפורמט WebP ותאחזר את רוחב התמונה ואת גובהה. אפשר להעביר את ההפניות *width ו-*height אל NULL אם הן נחשבות לא רלוונטיות.

מאפייני קלט

נתונים
הפניה לנתוני תמונה בפורמט WebP
data_size
הגודל של בלוק הזיכרון ש-data מפנה אליו, ומכיל את נתוני התמונה.

החזרות

FALSE
קוד השגיאה שהוחזר במקרה של שגיאת פורמט.
TRUE
במקרה של הצלחה. *width ו-*height תקפים רק אם ההחזרה בוצעה בהצלחה.
רוחב
ערך של מספר שלם. הטווח מוגבל ל-1 עד 16383.
גובה
ערך של מספר שלם. הטווח מוגבל מ-1 עד 16383.
struct WebPBitstreamFeatures {
  int width;          // Width in pixels.
  int height;         // Height in pixels.
  int has_alpha;      // True if the bitstream contains an alpha channel.
  int has_animation;  // True if the bitstream is an animation.
  int format;         // 0 = undefined (/mixed), 1 = lossy, 2 = lossless
}

VP8StatusCode WebPGetFeatures(const uint8_t* data,
                              size_t data_size,
                              WebPBitstreamFeatures* features);

הפונקציה הזו תאחזר תכונות מזרם הביטים. המבנה *features ממלא במידע שנאסף מזרם הביט:

מאפייני קלט

נתונים
הפניה לנתוני תמונה בפורמט WebP
data_size
הגודל של בלוק הזיכרון ש-data מפנה אליו, ומכיל את נתוני התמונה.

החזרות

VP8_STATUS_OK
כשהתכונות מאוחזרות בהצלחה.
VP8_STATUS_NOT_ENOUGH_DATA
כשנדרשים נתונים נוספים כדי לאחזר את התכונות מהכותרות.

ערכים נוספים של שגיאות VP8StatusCode במקרים אחרים.

תכונות
הצבען למבנה WebPBitstreamFeatures.
uint8_t* WebPDecodeRGBA(const uint8_t* data, size_t data_size, int* width, int* height);
uint8_t* WebPDecodeARGB(const uint8_t* data, size_t data_size, int* width, int* height);
uint8_t* WebPDecodeBGRA(const uint8_t* data, size_t data_size, int* width, int* height);
uint8_t* WebPDecodeRGB(const uint8_t* data, size_t data_size, int* width, int* height);
uint8_t* WebPDecodeBGR(const uint8_t* data, size_t data_size, int* width, int* height);

הפונקציות האלה מפענחות תמונה בפורמט WebP ש-data מפנה אליה.

  • הפונקציה WebPDecodeRGBA מחזירה דוגמאות של תמונות RGBA לפי הסדר [r0, g0, b0, a0, r1, g1, b1, a1, ...].
  • הפונקציה WebPDecodeARGB מחזירה דוגמיות של תמונות ARGB בסדר [a0, r0, g0, b0, a1, r1, g1, b1, ...].
  • הפונקציה WebPDecodeBGRA מחזירה דוגמאות של תמונות BGRA בסדר [b0, g0, r0, a0, b1, g1, r1, a1, ...].
  • הפונקציה WebPDecodeRGB מחזירה דוגמיות של תמונות RGB בסדר [r0, g0, b0, r1, g1, b1, ...].
  • הפונקציה WebPDecodeBGR מחזירה דוגמאות של תמונות BGR בסדר [b0, g0, r0, b1, g1, r1, ...].

הקוד שמפעיל כל אחת מהפונקציות האלה צריך למחוק את מאגר הנתונים (uint8_t*) שהפונקציות האלה מחזירות באמצעות WebPFree().

מאפייני קלט

נתונים
הפניה לנתוני תמונה בפורמט WebP
data_size
זהו הגודל של בלוק הזיכרון ש-data מפנה אליו, ומכיל את נתוני התמונה
רוחב
ערך של מספר שלם. הטווח מוגבל כרגע מ-1 עד 16383.
גובה
ערך של מספר שלם. הטווח מוגבל כרגע ל-1 עד 16,383.

החזרות

uint8_t*
הצבע של צבעים מוצפנים בתמונות WebP לפי הסדר הלינארי RGBA/ARGB/BGRA/RGB/BGR, בהתאמה.
uint8_t* WebPDecodeRGBAInto(const uint8_t* data, size_t data_size,
                            uint8_t* output_buffer, int output_buffer_size, int output_stride);
uint8_t* WebPDecodeARGBInto(const uint8_t* data, size_t data_size,
                            uint8_t* output_buffer, int output_buffer_size, int output_stride);
uint8_t* WebPDecodeBGRAInto(const uint8_t* data, size_t data_size,
                            uint8_t* output_buffer, int output_buffer_size, int output_stride);
uint8_t* WebPDecodeRGBInto(const uint8_t* data, size_t data_size,
                           uint8_t* output_buffer, int output_buffer_size, int output_stride);
uint8_t* WebPDecodeBGRInto(const uint8_t* data, size_t data_size,
                           uint8_t* output_buffer, int output_buffer_size, int output_stride);

הפונקציות האלה הן וריאציות של הפונקציות שלמעלה, והן מפענחות את התמונה ישירות למאגר נתונים זמני output_buffer שהוקצה מראש. נפח האחסון המקסימלי שזמין במאגר הזה מצוין ב-output_buffer_size. אם נפח האחסון הזה לא מספיק (או אם אירעה שגיאה), תוחזר הערך NULL. אחרת, מוחזר הערך output_buffer, למען הנוחות.

הפרמטר output_stride מציין את המרחק (בייטים) בין שורות סריקת התמונה. לכן, הערך של output_buffer_size צפוי להיות לפחות output_stride * picture - height.

מאפייני קלט

נתונים
הפניה לנתוני תמונה בפורמט WebP
data_size
זהו הגודל של בלוק הזיכרון ש-data מפנה אליו, שמכיל את נתוני התמונה
output_buffer_size
ערך של מספר שלם. גודל המאגר שהוקצה
output_stride
ערך של מספר שלם. מציין את המרחק בין שורות הסריקה.

החזרות

output_buffer
הצבען לתמונה WebP מפענחת.
uint8_t*
output_buffer אם הפונקציה מצליחה, NULL אחרת.

Advanced Decoding API

פענוח WebP תומך ב-API מתקדם שמאפשר חיתוך ושינוי קנה מידה בזמן אמת, דבר שמאוד שימושי בסביבות עם מגבלות זיכרון כמו טלפונים ניידים. באופן כללי, כשצריך רק תצוגה מקדימה מהירה או קטע עם זום של תמונה גדולה מדי, צריכת הזיכרון תשתנה בהתאם לגודל הפלט, ולא לגודל הקלט. דרך אגב, אפשר לחסוך גם בחלק מעוצמת המעבד.

פענוח WebP מגיע בשתי גרסאות: פענוח תמונה מלא ופענוח מצטבר במאגרי קלט קטנים. המשתמשים יכולים לספק מאגר זיכרון חיצוני לצורך פענוח התמונה. בדוגמת הקוד הבאה מוסבר איך משתמשים ב-Advanced Decoding API.

קודם כול צריך לאתחל אובייקט תצורה:

#include "webp/decode.h"

WebPDecoderConfig config;
CHECK(WebPInitDecoderConfig(&config));

// One can adjust some additional decoding options:
config.options.no_fancy_upsampling = 1;
config.options.use_scaling = 1;
config.options.scaled_width = scaledWidth();
config.options.scaled_height = scaledHeight();
// etc.

אפשרויות הפענוח נאספות במבנה WebPDecoderConfig:

struct WebPDecoderOptions {
  int bypass_filtering;             // if true, skip the in-loop filtering
  int no_fancy_upsampling;          // if true, use faster pointwise upsampler
  int use_cropping;                 // if true, cropping is applied first 
  int crop_left, crop_top;          // top-left position for cropping.
                                    // Will be snapped to even values.
  int crop_width, crop_height;      // dimension of the cropping area
  int use_scaling;                  // if true, scaling is applied afterward
  int scaled_width, scaled_height;  // final resolution
  int use_threads;                  // if true, use multi-threaded decoding
  int dithering_strength;           // dithering strength (0=Off, 100=full)
  int flip;                         // if true, flip output vertically
  int alpha_dithering_strength;     // alpha dithering strength in [0..100]
};

אם צריך לדעת אותם מראש, אפשר לקרוא את מאפייני מקור הנתונים ל-config.input. לדוגמה, כדאי לדעת אם יש בתמונה שקיפות כלשהי. שימו לב שהפעולה הזו תנתח גם את הכותרת של מקור הנתונים, ולכן היא דרך טובה לדעת אם מקור הנתונים נראה כמו מקור נתונים תקין של WebP.

CHECK(WebPGetFeatures(data, data_size, &config.input) == VP8_STATUS_OK);

לאחר מכן, צריך להגדיר את מאגר הזיכרון לפענוח למקרה שרוצים לספק אותו ישירות במקום להסתמך על המפענח להקצאה שלו. אנחנו צריכים רק לספק את הפונקציה של המצביע לזיכרון, את הגודל הכולל של המאגר ואת ה-line stride (המרחק בבייט בין שורות הסריקה).

// Specify the desired output colorspace:
config.output.colorspace = MODE_BGRA;
// Have config.output point to an external buffer:
config.output.u.RGBA.rgba = (uint8_t*)memory_buffer;
config.output.u.RGBA.stride = scanline_stride;
config.output.u.RGBA.size = total_size_of_the_memory_buffer;
config.output.is_external_memory = 1;

התמונה מוכנה לפענוח. יש שתי אפשרויות אפשריות לפענוח התמונה. אפשר לפענח את התמונה בבת אחת באמצעות:

CHECK(WebPDecode(data, data_size, &config) == VP8_STATUS_OK);

לחלופין, אפשר להשתמש בשיטה המצטברת כדי לפענוח הדרגתי של התמונה כשבייטים חדשים יהיו זמינים:

WebPIDecoder* idec = WebPINewDecoder(&config.output);
CHECK(idec != NULL);
while (additional_data_is_available) {
  // ... (get additional data in some new_data[] buffer)
  VP8StatusCode status = WebPIAppend(idec, new_data, new_data_size);
  if (status != VP8_STATUS_OK && status != VP8_STATUS_SUSPENDED) {
    break;
  }
  // The above call decodes the current available buffer.
  // Part of the image can now be refreshed by calling
  // WebPIDecGetRGB()/WebPIDecGetYUVA() etc.
}
WebPIDelete(idec);  // the object doesn't own the image memory, so it can
                    // now be deleted. config.output memory is preserved.

התמונה שעברתה פענוח נמצאת עכשיו ב-config.output (או ב-config.output.u.RGBA במקרה הזה, כי מרחב הצבעים המבוקש של הפלט היה MODE_BGRA). אפשר לשמור את התמונה, להציג אותה או לעבד אותה בדרכים אחרות. לאחר מכן, צריך רק למחוק את הזיכרון שהוקצה באובייקט של config. אפשר להפעיל את הפונקציה הזו בבטחה גם אם הזיכרון הוא חיצוני ולא הוקצה על ידי WebPDecode():

WebPFreeDecBuffer(&config.output);

באמצעות ה-API הזה אפשר גם לפענח את התמונה לפורמטים YUV ו-YUVA, באמצעות MODE_YUV ו-MODE_YUVA, בהתאמה. הפורמט הזה נקרא גם Y'CbCr.

Simple Encoding API

יש כמה פונקציות פשוטות מאוד לקידוד מערכי דגימות RGBA בפריסות הנפוצות ביותר. הם מפורטים בכותרת webp/encode.h כך:

size_t WebPEncodeRGB(const uint8_t* rgb, int width, int height, int stride, float quality_factor, uint8_t** output);
size_t WebPEncodeBGR(const uint8_t* bgr, int width, int height, int stride, float quality_factor, uint8_t** output);
size_t WebPEncodeRGBA(const uint8_t* rgba, int width, int height, int stride, float quality_factor, uint8_t** output);
size_t WebPEncodeBGRA(const uint8_t* bgra, int width, int height, int stride, float quality_factor, uint8_t** output);

גורם האיכות quality_factor נע בין 0 ל-100, והוא קובע את ההפסד ואת האיכות במהלך הדחיסה. הערך 0 מתאים לאיכות נמוכה ולגודל פלט קטן, ואילו הערך 100 מתאים לאיכות הגבוהה ביותר ולגודל הפלט הגדול ביותר. אם הפעולה תצליח, הבייטים המודחסים יוצבו ב-*output והגודל בבייטים יוחזר (אחרת, 0 יוחזר במקרה של כישלון). מבצע הקריאה צריך להפעיל את WebPFree() על ההצבעה *output כדי לפנות את הזיכרון.

מערך הקלט צריך להיות מערך בייטים דחוס (אחד לכל ערוץ, כפי שמצופה מהשם של הפונקציה). הערך של stride תואם למספר הבייטים הנדרשים כדי לקפוץ משורה אחת לשורה הבאה. לדוגמה, הפריסה של BGRA היא:

יש פונקציות מקבילות לקידוד ללא אובדן נתונים, עם חתימות:

size_t WebPEncodeLosslessRGB(const uint8_t* rgb, int width, int height, int stride, uint8_t** output);
size_t WebPEncodeLosslessBGR(const uint8_t* bgr, int width, int height, int stride, uint8_t** output);
size_t WebPEncodeLosslessRGBA(const uint8_t* rgba, int width, int height, int stride, uint8_t** output);
size_t WebPEncodeLosslessBGRA(const uint8_t* bgra, int width, int height, int stride, uint8_t** output);

חשוב לזכור שהפונקציות האלה, כמו הגרסאות עם אובדן נתונים, משתמשות בהגדרות ברירת המחדל של הספרייה. בקודק ללא אובדן נתונים, המשמעות היא שהאפשרות 'מדויק' מושבתת. ערכי RGB באזורים שקופים ישתנו כדי לשפר את הדחיסה. כדי למנוע זאת, צריך להשתמש ב-WebPEncode() ולהגדיר את WebPConfig::exact לערך 1.

Advanced Encoding API

מתחת לפני השטח, המקודד כולל מספר רב של פרמטרים מתקדמים לקידוד. הם יכולים לעזור לכם למצוא את האיזון הנכון בין יעילות הדחיסה לבין זמן העיבוד. הפרמטרים האלה נאספים במבנה WebPConfig. השדות הנפוצים ביותר במבנה הזה הם:

struct WebPConfig {
  int lossless;           // Lossless encoding (0=lossy(default), 1=lossless).
  float quality;          // between 0 and 100. For lossy, 0 gives the smallest
                          // size and 100 the largest. For lossless, this
                          // parameter is the amount of effort put into the
                          // compression: 0 is the fastest but gives larger
                          // files compared to the slowest, but best, 100.
  int method;             // quality/speed trade-off (0=fast, 6=slower-better)

  WebPImageHint image_hint;  // Hint for image type (lossless only for now).

  // Parameters related to lossy compression only:
  int target_size;        // if non-zero, set the desired target size in bytes.
                          // Takes precedence over the 'compression' parameter.
  float target_PSNR;      // if non-zero, specifies the minimal distortion to
                          // try to achieve. Takes precedence over target_size.
  int segments;           // maximum number of segments to use, in [1..4]
  int sns_strength;       // Spatial Noise Shaping. 0=off, 100=maximum.
  int filter_strength;    // range: [0 = off .. 100 = strongest]
  int filter_sharpness;   // range: [0 = off .. 7 = least sharp]
  int filter_type;        // filtering type: 0 = simple, 1 = strong (only used
                          // if filter_strength > 0 or autofilter > 0)
  int autofilter;         // Auto adjust filter's strength [0 = off, 1 = on]
  int alpha_compression;  // Algorithm for encoding the alpha plane (0 = none,
                          // 1 = compressed with WebP lossless). Default is 1.
  int alpha_filtering;    // Predictive filtering method for alpha plane.
                          //  0: none, 1: fast, 2: best. Default if 1.
  int alpha_quality;      // Between 0 (smallest size) and 100 (lossless).
                          // Default is 100.
  int pass;               // number of entropy-analysis passes (in [1..10]).

  int show_compressed;    // if true, export the compressed picture back.
                          // In-loop filtering is not applied.
  int preprocessing;      // preprocessing filter (0=none, 1=segment-smooth)
  int partitions;         // log2(number of token partitions) in [0..3]
                          // Default is set to 0 for easier progressive decoding.
  int partition_limit;    // quality degradation allowed to fit the 512k limit on
                          // prediction modes coding (0: no degradation,
                          // 100: maximum possible degradation).
  int use_sharp_yuv;      // if needed, use sharp (and slow) RGB->YUV conversion
};

חשוב לזכור שרוב הפרמטרים האלה זמינים לניסוי באמצעות הכלי לשורת הפקודה cwebp.

צריך לעטוף את דגימות הקלט במבנה WebPPicture. המבנה הזה יכול לאחסן דגימות קלט בפורמט RGBA או YUVA, בהתאם לערך הדגל use_argb.

המבנה מחולק כך:

struct WebPPicture {
  int use_argb;              // To select between ARGB and YUVA input.

  // YUV input, recommended for lossy compression.
  // Used if use_argb = 0.
  WebPEncCSP colorspace;     // colorspace: should be YUVA420 or YUV420 for now (=Y'CbCr).
  int width, height;         // dimensions (less or equal to WEBP_MAX_DIMENSION)
  uint8_t *y, *u, *v;        // pointers to luma/chroma planes.
  int y_stride, uv_stride;   // luma/chroma strides.
  uint8_t* a;                // pointer to the alpha plane
  int a_stride;              // stride of the alpha plane

  // Alternate ARGB input, recommended for lossless compression.
  // Used if use_argb = 1.
  uint32_t* argb;            // Pointer to argb (32 bit) plane.
  int argb_stride;           // This is stride in pixels units, not bytes.

  // Byte-emission hook, to store compressed bytes as they are ready.
  WebPWriterFunction writer;  // can be NULL
  void* custom_ptr;           // can be used by the writer.

  // Error code for the latest error encountered during encoding
  WebPEncodingError error_code;
};

למבנה הזה יש גם פונקציה להעברת הבייטים הנדחסים כשהם זמינים. בהמשך מופיעה דוגמה עם כותב בזיכרון. כותבים אחרים יכולים לאחסן נתונים ישירות בקובץ (דוגמה כזו מופיעה בקטע examples/cwebp.c).

התהליך הכללי לקידוד באמצעות ה-API המתקדם נראה כך:

קודם כול, צריך להגדיר הגדרות קידוד שמכילות את פרמטרי הדחיסה. חשוב לזכור שאפשר להשתמש באותה הגדרה כדי לדחוס כמה תמונות שונות לאחר מכן.

#include "webp/encode.h"

WebPConfig config;
if (!WebPConfigPreset(&config, WEBP_PRESET_PHOTO, quality_factor)) return 0;   // version error

// Add additional tuning:
config.sns_strength = 90;
config.filter_sharpness = 6;
config.alpha_quality = 90;
config_error = WebPValidateConfig(&config);  // will verify parameter ranges (always a good habit)

לאחר מכן, צריך להפנות את דגימות הקלט ל-WebPPicture באמצעות הפניה או העתקה. דוגמה להקצאת מאגר לצורך אחסון הדגימות. אבל אפשר להגדיר בקלות 'תצוגה' למערך דוגמאות שכבר הוקצה. פונקציית WebPPictureView().

// Setup the input data, allocating a picture of width x height dimension
WebPPicture pic;
if (!WebPPictureInit(&pic)) return 0;  // version error
pic.width = width;
pic.height = height;
if (!WebPPictureAlloc(&pic)) return 0;   // memory error

// At this point, 'pic' has been initialized as a container, and can receive the YUVA or RGBA samples.
// Alternatively, one could use ready-made import functions like WebPPictureImportRGBA(), which will take
// care of memory allocation. In any case, past this point, one will have to call WebPPictureFree(&pic)
// to reclaim allocated memory.

כדי להפיק את הבייטים הנדחסים, נקרא הוק בכל פעם שזמינים ביטים חדשים. הנה דוגמה פשוטה שבה ה-memory-writer מוגדר ב-webp/encode.h. סביר להניח שתצטרכו לבצע את האיניציאליזציה הזו לכל תמונה כדי לדחוס אותה:

// Set up a byte-writing method (write-to-memory, in this case):
WebPMemoryWriter writer;
WebPMemoryWriterInit(&writer);
pic.writer = WebPMemoryWrite;
pic.custom_ptr = &writer;

עכשיו אנחנו מוכנים לדחוס את דגימות הקלט (ולשחרר את הזיכרון שלהן לאחר מכן):

int ok = WebPEncode(&config, &pic);
WebPPictureFree(&pic);   // Always free the memory associated with the input.
if (!ok) {
  printf("Encoding error: %d\n", pic.error_code);
} else {
  printf("Output size: %d\n", writer.size);
}

לשימוש מתקדם יותר בממשק ה-API ובמבנה, מומלץ לעיין במסמכי העזרה שזמינים בכותרת webp/encode.h. כדאי לקרוא את קוד הדוגמה examples/cwebp.c כדי לגלות פרמטרים שבהם נעשה שימוש פחות.