このページは Cloud Translation API によって翻訳されました。

WebP API ドキュメント

このセクションでは、エンコーダとデコーダに付属する API について説明します。これは WebP ライブラリですこの API の説明は、バージョンに関する 1.4.0.

ヘッダーとライブラリ

libwebp をインストールすると、webp/ という名前のディレクトリプラットフォームの通常の場所にインストールされます。たとえば、 Unix プラットフォームでは、次のヘッダーファイルが /usr/local/include/webp/。

decode.h
encode.h
types.h

ライブラリは通常のライブラリディレクトリにあります。静的および動的ライブラリは、Unix プラットフォームでは /usr/local/lib/ にあります。

Simple Decode API

Decode API の使用を開始するには、Decoder-Decoder ライブラリファイルとヘッダーファイルが、上記をご覧ください。

次のように、デコード 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: （a）フォーマットエラーの場合に返されるエラーコード。
true: 成功時。*width と *height は、正常に返された場合にのみ有効です。
幅: 整数値。範囲は 1 ～ 16383 に制限されています。
height: 整数値。範囲は 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);

これらの関数は、data が指す WebP 画像をデコードします。

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, ...] の順序で返します。

これらの関数を呼び出すコードでは、データバッファを削除する必要があります。 WebPFree() を指定してこれらの関数から返される (uint8_t*)。

入力属性

データ: WebP 画像データへのポインタ
data_size: これは data がポイントするメモリブロックのサイズで、画像データ
幅: 整数値。範囲は現在 1 ～ 16383 に制限されています。
height: 整数値。範囲は現在 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_size: これは data がポイントするメモリブロックのサイズで、画像データ
output_buffer_size: 整数値。割り当てられたバッファのサイズ
output_stride: 整数値。スキャンライン間の距離を指定します。

戻り値

output_buffer: デコードされた WebP 画像へのポインタ。
uint8_t*: 関数が成功した場合は output_buffer。それ以外の場合は NULL。

Advanced Decode API

WebP デコードは高度な API をサポートしており、その場で切り抜きと再スケーリングは、メモリの制約がある場合にスマートフォンなどの環境に適しています基本的にメモリ使用量はクイックプレビューや極端に大きい画像の一部にズームインしてしまうことがあります。一部の CPU を節約できるこれも偶然です

WebP デコードには 2 種類（画像全体デコードと増分）デコード関数があります。ユーザーは必要に応じて外部 IP アドレス使用します。次のコードサンプルは、 Advanced Decode 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);

次に、デコードメモリのバッファを提供する場合に備えて、それをセットアップする必要があります。直接使用します。必要なのは、メモリへのポインタ、バッファの合計サイズ、ラインストライド（スキャンライン間のバイト単位の距離）。

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

これで、画像をデコードする準備ができました。デコードには 2 つのバリエーションがある表示されます。以下を使用して、一度に画像をデコードできます。

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 が返されます。です。呼び出し元は *output で WebPFree() を呼び出す必要があります。メモリを再利用するためのポインタです。

入力配列は、パックされたバイト配列でなければなりません（つまり、チャネルごとに 1 つ）。関数名が想定されます）。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 を使用したエンコードの一般的なフローは次のようになります。次のとおりです。

まず、Python や Curl など、変数を含むエンコード構成を構成します。同じ構成を複数の異なる画像を圧縮するオプションもあります

#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 を読むと役に立つ使用頻度の低いパラメータを見つけます。