مستندات WebP API

يصف هذا القسم واجهة برمجة التطبيقات لبرنامج الترميز وفك الترميز المضمّنين في مكتبة WebP. يرتبط وصف واجهة برمجة التطبيقات هذا بالإصدار 1.5.0.

العناوين والمكتبات

عند تثبيت libwebp، سيتم تثبيت دليل باسم webp/ في الموقع المعتاد لمنصتك. على سبيل المثال، على منصّات Unix، سيتم نسخ ملفات الرأس التالية إلى /usr/local/include/webp/.

decode.h
encode.h
types.h

يمكن العثور على المكتبات في أدلة المكتبات المعتادة. تتوفّر المكتبات الثابتة والدينية في /usr/local/lib/ على منصات Unix.

Simple Decoding 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 والتي تحتوي على data الصورة.

المرتجعات

خطأ
رمز الخطأ الذي يتم عرضه في حال حدوث (أ) أخطاء في التنسيق
صحيح
عند النجاح: لا تكون *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 والتي تحتوي على 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 إلى 16383.

المرتجعات

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 استخدام واجهة برمجة تطبيقات متقدّمة لتوفير إمكانية اقتصاص الصور وإعادة قياسها أثناء التشغيل، ما يُعدّ أمرًا مفيدًا للغاية في البيئات التي تواجه قيودًا في الذاكرة، مثل الهواتف الجوّالة. بشكل أساسي، سيزداد استخدام الذاكرة مع حجم الإخراج، وليس حجم الإدخال عندما يحتاج المستخدم إلى معاينة سريعة فقط أو جزء مكبَّر من صورة كبيرة جدًا. يمكن أيضًا توفير بعض موارد وحدة المعالجة المركزية.

يتوفّر فك ترميز WebP بنُسختَين، وهما فك ترميز الصورة بالكامل وفك الترميز المتزايد على وحدات تخزين مؤقت صغير للدخل. يمكن للمستخدمين اختياريًا توفير ملف تخزين مؤقت للذاكرة الخارجية لفك ترميز الصورة. سيتناول نموذج الرمز البرمجي التالي خطوات استخدام واجهة برمجة التطبيقات لفك التشفير المتقدّم.

نحتاج أولاً إلى بدء كائن الضبط:

#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);

بعد ذلك، نحتاج إلى إعداد ذاكرة التخزين المؤقت لفك التشفير في حال أردنا إرسالها مباشرةً بدلاً من الاعتماد على وحدة فك التشفير لتخصيصها. ما عليك سوى تقديم المؤشر إلى الذاكرة بالإضافة إلى الحجم الإجمالي للمخازن المؤقتة و مسافة الخطوة (المسافة بالبايت بين خطوط المسح).

// 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);

باستخدام واجهة برمجة التطبيقات هذه، يمكن أيضًا فك ترميز الصورة إلى تنسيقَي 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 للحصول على مثال على ذلك).

تبدو العملية العامة لتشفير البيانات باستخدام واجهة برمجة التطبيقات المتقدّمة على النحو التالي:

أولاً، نحتاج إلى إعداد إعدادات ترميز تحتوي على مَعلمات الضغط. يُرجى العِلم أنّه يمكن استخدام الإعدادات نفسها لضغط عدة صور مختلفة بعد ذلك.

#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.

لبثّ البايتات المضغوطة، يتمّ استدعاء عنصر ربط في كلّ مرّة تصبح فيها البايتات الجديدة متوفرة. في ما يلي مثال بسيط تم فيه الإعلان عن كاتب الذاكرة في 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);
}

لاستخدام واجهة برمجة التطبيقات والبنية بشكل أكثر تقدمًا، ننصحك بالاطّلاع على مستندات webp/encode.h. يمكن أن تكون قراءة مثال الرمز البرمجي examples/cwebp.c مفيدة لاكتشاف المَعلمات الأقل استخدامًا.