本節將說明 。這份 API 說明與版本相關 1.4.0.
標頭與程式庫
您在「安裝」libwebp (名為 webp/ 的目錄) 時
安裝在您平台的一般位置。例如，在
Unix 平台時，系統會將下列標頭檔案複製到
/usr/local/include/webp/。
decode.h
encode.h
types.h
程式庫位於一般程式庫目錄中。靜態和
Unix 平台上的 /usr/local/lib/ 提供動態程式庫。
簡易解碼 API
如要開始使用解碼 API，您必須確認您已具備 按照上述說明安裝程式庫和標頭檔案 上述。
在 C/C++ 程式碼中加入解碼 API 標頭，如下所示：
#include "webp/decode.h"
int WebPGetInfo(const uint8_t* data, size_t data_size, int* width, int* height);
這個函式會驗證 WebP 圖片標頭，並擷取圖片寬度
以及高度如果系統判定指標 *width 和 *height 指標，可以傳遞 NULL
無關緊要。
輸入屬性
- 資料
- WebP 圖片資料的指標
- 資料大小
- 這是由
data指向的記憶體區塊大小，其中包含 映像檔資料
傳回
- false
- 發生 (a) 格式錯誤時傳回的錯誤代碼。
- 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指向的記憶體區塊大小，其中包含 映像檔資料
傳回
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);
這些函式會將 data 指向的 WebP 圖片解碼。
WebPDecodeRGBA會以[r0, g0, b0, a0, r1, g1, b1, a1, ...]順序傳回 RGBA 圖片樣本。WebPDecodeARGB會以[a0, r0, g0, b0, a1, r1, g1, b1, ...]順序傳回 ARGB 圖片範例。WebPDecodeBGRA會以[b0, g0, r0, a0, b1, g1, r1, a1, ...]順序傳回 BGRA 圖片樣本。WebPDecodeRGB會以[r0, g0, b0, r1, g1, b1, ...]順序傳回 RGB 圖片範例。WebPDecodeBGR會以[b0, g0, r0, b1, g1, r1, ...]順序傳回 BGR 圖片樣本。
呼叫上述任何函式的程式碼必須刪除資料緩衝區
這些含有 WebPFree() 的函式傳回的 (uint8_t*)。
輸入屬性
- 資料
- WebP 圖片資料的指標
- 資料大小
- 這是由
data指向的記憶體區塊大小，其中包含 圖片資料 - 寬度
- 整數值。目前範圍限制在 1 至 16383 個。
- 高度
- 整數值。目前範圍限制在 1 到 16383。
傳回
- uint8_t*
- 以線性 RGBA/ARGB/BGRA/RGB/BGR 解碼 WebP 圖片樣本的指標 順序。
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指向的記憶體區塊大小，其中包含 圖片資料 - output_buffer_size
- 整數值。分配的緩衝區大小
- output_stride
- 整數值。指定掃描線之間的距離。
傳回
- output_buffer
- 已解碼 WebP 圖片的指標。
- uint8_t*
output_buffer表示函式成功；否則為NULL。
進階解碼 API
WebP 解碼支援先進的 API 裁剪及調整大小，這對記憶體有限而言非常實用 手機等環境基本上，記憶體用量 無法確定輸出結果的大小；如果只需要快速預覽或 其他圖片太大。可儲存部分 CPU 於是難免
WebP 解碼提供兩種版本的 viz 完整圖片解碼，以及漸進式 解碼器會針對小型輸入緩衝區進行解碼使用者可以選擇提供外部 IP 位址 記憶體緩衝區，以便用於解碼圖片以下程式碼範例將逐步說明 瞭解使用進階解碼 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，
以備不時之需舉例來說
相片是否具備透明度請注意，這將
也會剖析 Bitstream 的標頭，因此很適合用來瞭解
如果 Bitstream 看起來是有效的 WebP 1
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)。圖片 儲存、顯示或以其他方式處理。 之後，我們只需收回設定物件中分配的記憶體。 即使記憶體是外部儲存空間， 是由 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，
失敗時)。呼叫端必須在 *output 上呼叫 WebPFree()
即可取回記憶體的指標。
輸入陣列應為封裝的位元組陣列 (每個通道各有一個，如
預期由函式名稱所預期)。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。
進階編碼 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.
為了輸出壓縮的位元組，每次有新位元組時，都會呼叫掛鉤
廣告。以下是在
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 一定很有幫助
來找出較少用的參數