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

WebP Container API ドキュメント

WebP 画像の RIFF コンテナ操作。

Mux API

色などの機能を備えた WebP コンテナ画像の操作を許可するプロファイル、メタデータ、アニメーション、断片化された画像などです。

サンプルコード

画像データ、カラープロファイル、XMP メタデータを使用して MUX を作成する

int copy_data = 0;
WebPMux* mux = WebPMuxNew();
// ... (Prepare image data).
WebPMuxSetImage(mux, &image, copy_data);
// ... (Prepare ICCP color profile data).
WebPMuxSetChunk(mux, "ICCP", &icc_profile, copy_data);
// ... (Prepare XMP metadata).
WebPMuxSetChunk(mux, "XMP ", &xmp, copy_data);
// Get data from mux in WebP RIFF format.
WebPMuxAssemble(mux, &output_data);
WebPMuxDelete(mux);
// ... (Consume output_data; e.g. write output_data.bytes to file).
WebPDataClear(&output_data);

WebP ファイルから画像とカラープロファイルデータを取得する

int copy_data = 0;
// ... (Read data from file).
WebPMux* mux = WebPMuxCreate(&data, copy_data);
WebPMuxGetFrame(mux, 1, &image);
// ... (Consume image; e.g. call WebPDecode() to decode the data).
WebPMuxGetChunk(mux, "ICCP", &icc_profile);
// ... (Consume icc_data).
WebPMuxDelete(mux);
free(data);

Mux オブジェクトの存続期間

列挙型

// Error codes
typedef enum WebPMuxError {
  WEBP_MUX_OK                 =  1,
  WEBP_MUX_NOT_FOUND          =  0,
  WEBP_MUX_INVALID_ARGUMENT   = -1,
  WEBP_MUX_BAD_DATA           = -2,
  WEBP_MUX_MEMORY_ERROR       = -3,
  WEBP_MUX_NOT_ENOUGH_DATA    = -4
} WebPMuxError;

// IDs for different types of chunks.
typedef enum WebPChunkId {
  WEBP_CHUNK_VP8X,     // VP8X
  WEBP_CHUNK_ICCP,     // ICCP
  WEBP_CHUNK_ANIM,     // ANIM
  WEBP_CHUNK_ANMF,     // ANMF
  WEBP_CHUNK_ALPHA,    // ALPH
  WEBP_CHUNK_IMAGE,    // VP8/VP8L
  WEBP_CHUNK_EXIF,     // EXIF
  WEBP_CHUNK_XMP,      // XMP
  WEBP_CHUNK_UNKNOWN,  // Other chunks.
  WEBP_CHUNK_NIL
} WebPChunkId;

`WebPGetMuxVersion()`

mux ライブラリのバージョン番号を、メジャー/マイナー/リビジョンがそれぞれ 8 ビット。たとえば、v2.5.7 は 0x020507 です。

int WebPGetMuxVersion(void);

`WebPMuxNew()`

空の mux オブジェクトを作成します。

WebPMux* WebPMuxNew(void);

戻り値: 新しく作成された空の mux オブジェクトへのポインタ。

`WebPMuxDelete()`

mux オブジェクトを削除します。

void WebPMuxDelete(WebPMux* mux);

パラメータ: mux -- 削除される（入力/出力）オブジェクト

Mux の作成

`WebPMuxCreate()`

WebP RIFF 形式で指定された元データから mux オブジェクトを作成します。

WebPMux* WebPMuxCreate(const WebPData* bitstream, int copy_data);

パラメータ: bitstream --（入力）WebP RIFF 形式のビットストリームデータ; copy_data --（in）値 1 は、指定されたデータが mux にコピーされることを示します。値 0 は、データが mux オブジェクトにコピーされないことを示します。
戻り値: 成功した場合は、指定されたデータから作成された mux オブジェクトへのポインタ。; NULL -- 無効なデータまたはメモリエラーの場合。

非画像チャンク

`WebPMuxSetChunk()`

ID が fourcc、データが chunk_data のチャンクを mux オブジェクトに追加します。制限なし同じ ID の既存のチャンクは削除されます。

WebPMuxError WebPMuxSetChunk(WebPMux* mux,
                             const char fourcc[4],
                             const WebPData* chunk_data,
                             int copy_data);

注: チャンク API で管理できるのは、画像に関連しないチャンクのみです。（画像関連のチャンクは「ANMF」、「FRGM」、「VP8」、「VP8L」、「ALPH」です）。追加するには、イメージの取得と削除、WebPMuxSetImage() の使用 WebPMuxPushFrame(), WebPMuxGetFrame() および WebPMuxDeleteFrame()。

パラメータ: mux -- チャンクを追加する（入力/出力）オブジェクト; fourcc -- 指定された chunk;例:「ICCP」、「XMP」、「EXIF」その他; chunk_data --（）追加するチャンクデータ; copy_data --（in）値 1 は、指定されたデータが mux にコピーされることを示します。値 0 は、データが mux オブジェクトにコピーされないことを示します。
戻り値: WEBP_MUX_INVALID_ARGUMENT -- mux、fourcc、chunk_data が NULL の場合、または 4 つが画像チャンクに対応します。; WEBP_MUX_MEMORY_ERROR -- メモリ割り当てエラーの場合。; WEBP_MUX_OK -- 成功時。

`WebPMuxGetChunk()`

mux オブジェクト内で ID が fourcc のチャンクのデータへの参照を取得します。呼び出し元は返されたデータを解放してはなりません。

WebPMuxError WebPMuxGetChunk(const WebPMux* mux,
                             const char fourcc[4],
                             WebPData* chunk_data);

パラメータ: mux -- チャンクデータの取得元の（in）オブジェクト; fourcc --（in）チャンクの 4cc を含む文字配列。例:「ICCP」、「XMP」、「EXIF」その他; chunk_data -- （出力）返されたチャンクデータ
戻り値: WEBP_MUX_INVALID_ARGUMENT -- mux、fourcc、chunk_data が NULL の場合、または 4 つが画像チャンクに対応します。; WEBP_MUX_NOT_FOUND -- mux に、指定されたチャンクがあります。; WEBP_MUX_OK -- 成功時。

`WebPMuxDeleteChunk()`

指定された fourcc を持つチャンクを mux オブジェクトから削除します。

WebPMuxError WebPMuxDeleteChunk(WebPMux* mux, const char fourcc[4]);

パラメータ: mux -- チャンクを削除する（入出力）オブジェクト; fourcc --（in）チャンクの 4cc を含む文字配列。例:「ICCP」、「XMP」、「EXIF」その他
戻り値: WEBP_MUX_INVALID_ARGUMENT -- mux または fourcc が NULL の場合、または fourcc の場合画像チャンクに対応します。; WEBP_MUX_NOT_FOUND -- mux に、指定されたチャンクが 4 cc です。; WEBP_MUX_OK -- 成功時。

画像

単一のフレームまたはフラグメントに関するデータをカプセル化します。

struct WebPMuxFrameInfo {
  WebPData    bitstream;  // image data: can be a raw VP8/VP8L bitstream
                          // or a single-image WebP file.
  int         x_offset;   // x-offset of the frame.
  int         y_offset;   // y-offset of the frame.
  int         duration;   // duration of the frame (in milliseconds).

  WebPChunkId id;         // frame type: should be one of WEBP_CHUNK_ANMF,
                          // WEBP_CHUNK_FRGM or WEBP_CHUNK_IMAGE
  WebPMuxAnimDispose dispose_method;  // Disposal method for the frame.
  WebPMuxAnimBlend   blend_method;    // Blend operation for the frame.
};

`WebPMuxSetImage()`

mux オブジェクトに（アニメーションでもフラグメントでもない）画像を設定します。注: 既存の画像（フレームやフラグメントを含む）はすべて削除されます。

WebPMuxError WebPMuxSetImage(WebPMux* mux,
                             const WebPData* bitstream,
                             int copy_data);

パラメータ: mux -- 画像が設定される（入力と出力）オブジェクト; ビットストリーム --（入力）: 未加工の VP8/VP8L ビットストリームまたは単一画像の WebP ファイル（アニメーションなし、断片化なし）; copy_data --（in）値 1 は、指定されたデータが mux にコピーされることを示します。値 0 は、データが mux オブジェクトにコピーされないことを示します。
戻り値: WEBP_MUX_INVALID_ARGUMENT -- mux が NULL またはビットストリームが NULL の場合。; WEBP_MUX_MEMORY_ERROR -- メモリ割り当てエラーの場合。; WEBP_MUX_OK -- 成功時。

`WebPMuxPushFrame()`

mux オブジェクトの末尾にフレームを追加します。

WebPMuxError WebPMuxPushFrame(WebPMux* mux,
                              const WebPMuxFrameInfo* frame,
                              int copy_data);

注:

Frame.id は、WEBP_CHUNK_ANMF または WEBP_CHUNK_FRGM のいずれかにする必要があります。
アニメーション化されていない、フラグメント化されていない画像を設定するには、次のコマンドを使用します。 WebPMuxSetImage() をご利用ください。
プッシュされるフレームのタイプは、mux 内のフレームと同じである必要があります。
WebP は偶数のオフセットのみをサポートしているため、奇数のオフセットはスナップされますオフセット &= ~1

パラメータ: mux -- フレームを追加する（入力と出力）オブジェクト; frame --（イン）フレームデータ。; copy_data --（in）値 1 は、指定されたデータが mux にコピーされることを示します。値 0 は、データが mux オブジェクトにコピーされないことを示します。
戻り値: WEBP_MUX_INVALID_ARGUMENT -- 多重化またはフレームが NULL の場合、または frame が無効です。; WEBP_MUX_MEMORY_ERROR -- メモリ割り当てエラーの場合。; WEBP_MUX_OK -- 成功時。; WEBP_MUX_MEMORY_ERROR -- メモリ割り当てエラーの場合。

`WebPMuxGetFrame()`

mux オブジェクトから n 番目のフレームを取得します。frame->bitstream の内容は次のとおりです。 Maloc() を使用して割り当てられ、mux オブジェクトでは所有されません。しなければならない WebPDataClear() を呼び出して、呼び出し元によって割り当てが解除された。n=0 最後の位置という特別な意味を持ちます。

WebPMuxError WebPMuxGetFrame(const WebPMux* mux,
                             uint32_t nth,
                             WebPMuxFrameInfo* frame);

パラメータ: mux -- 情報を取得する（入力）オブジェクト; nth --（in）mux オブジェクト内のフレームのインデックス; frame -- 返されたフレームの（出力）データ
戻り値: WEBP_MUX_INVALID_ARGUMENT -- if mux or frame is NULL.; WEBP_MUX_NOT_FOUND -- mux が n 番目のフレーム未満の場合渡されます。; WEBP_MUX_BAD_DATA -- mux 内の n 番目のフレームチャンクが無効な場合。; WEBP_MUX_OK -- 成功時。

`WebPMuxDeleteFrame()`

mux オブジェクトからフレームを削除します。nth=0 は特別な意味を持つ - last なります。

WebPMuxError WebPMuxDeleteFrame(WebPMux* mux, uint32_t nth);

パラメータ: mux -- フレームを削除する（入力と出力）オブジェクト; nth --（in）フレームを削除する位置
戻り値: WEBP_MUX_INVALID_ARGUMENT -- if mux is NULL.; WEBP_MUX_NOT_FOUND -- mux が n 番目のフレーム未満の場合削除前のオブジェクトです。; WEBP_MUX_OK -- 成功時。

アニメーション

アニメーションパラメータ

struct WebPMuxAnimParams {
  uint32_t bgcolor;  // Background color of the canvas stored (in MSB order) as:
                     // Bits 00 to 07: Alpha.
                     // Bits 08 to 15: Red.
                     // Bits 16 to 23: Green.
                     // Bits 24 to 31: Blue.
  int loop_count;    // Number of times to repeat the animation [0 = infinite].
};

`WebPMuxSetAnimationParams()`

mux オブジェクトにアニメーションパラメータを設定します。既存の ANIM チャンクは削除されます。

WebPMuxError WebPMuxSetAnimationParams(WebPMux* mux,
                                       const WebPMuxAnimParams* params);

パラメータ: mux -- ANIM チャンクを設定または追加する（入力 / 出力）オブジェクト; params --（in）アニメーションパラメータ。
戻り値: WEBP_MUX_INVALID_ARGUMENT -- mux または params が NULL の場合。; WEBP_MUX_MEMORY_ERROR -- メモリ割り当てエラーの場合。; WEBP_MUX_OK -- 成功時。

`WebPMuxGetAnimationParams()`

mux オブジェクトからアニメーションパラメータを取得します。

WebPMuxError WebPMuxGetAnimationParams(const WebPMux* mux,
                                       WebPMuxAnimParams* params);

パラメータ: mux -- 取得するアニメーションパラメータの（in）オブジェクト; params -- ANIM チャンクから抽出された（出力）アニメーションパラメータ
戻り値: WEBP_MUX_INVALID_ARGUMENT -- mux または params が NULL の場合。; WEBP_MUX_NOT_FOUND -- ANIM チャンクが mux オブジェクトに存在しない場合。; WEBP_MUX_OK -- 成功時。

その他公益

`WebPMuxGetCanvasSize()`

mux オブジェクトからキャンバスサイズを取得します。

WebPMuxError WebPMuxGetCanvasSize(const WebPMux* mux,
                                  int* width,
                                  int* height);

注: このメソッドは、VP8X チャンクが存在する場合は、そのチャンクが最新であることを前提としています。つまり、mux オブジェクトは、 WebPMuxAssemble() または WebPMuxCreate()。

パラメータ: mux -- キャンバスサイズの取得元となる（in）オブジェクト; width -- （範囲外）キャンバスの幅; height -- （外部）キャンバスの高さ
戻り値: WEBP_MUX_INVALID_ARGUMENT -- if mux, width or height is NULL.; WEBP_MUX_BAD_DATA -- VP8X/VP8/VP8L のチャンクサイズまたはキャンバスサイズが無効な場合。; WEBP_MUX_OK -- 成功時。

`WebPMuxGetFeatures()`

mux オブジェクトからフィーチャートグルを取得します。

WebPMuxError WebPMuxGetFeatures(const WebPMux* mux, uint32_t* flags);

パラメータ: mux -- 特徴のフェッチ元となる（in）オブジェクト; flags --（出力）mux に存在する特徴を指定するフラグ渡されます。これは、さまざまなフラグ値の OR になります。列挙型 WebPFeatureFlags 個々のフラグ値をテストできます。
戻り値: WEBP_MUX_INVALID_ARGUMENT -- if mux or flags is NULL.; WEBP_MUX_BAD_DATA -- VP8X/VP8/VP8L のチャンクサイズまたはキャンバスサイズが無効な場合。; WEBP_MUX_OK -- 成功時。

`WebPMuxNumChunks()`

mux オブジェクト内で指定されたタグ値を持つチャンクの数を取得します。

WebPMuxError WebPMuxNumChunks(const WebPMux* mux,
                              WebPChunkId id,
                              int* num_elements);

パラメータ: mux -- 情報を取得する（入力）オブジェクト; id --（in）チャンクのタイプを指定するチャンク ID; num_elements --（出力）指定されたチャンク ID を持つチャンク数
戻り値: WEBP_MUX_INVALID_ARGUMENT -- if mux, or num_elements is NULL.; WEBP_MUX_OK -- 成功時。

`WebPMuxAssemble()`

WebP RIFF 形式ですべてのチャンクをアセンブルし、assembled_dataで返します。この関数は、mux オブジェクトも検証します。

WebPMuxError WebPMuxAssemble(WebPMux* mux, WebPData* assembled_data);

注: compiled_data の内容は無視され、上書きされます。また、assembled_data の内容は、malloc() を使用して割り当てられ、 mux オブジェクトと呼ばれます。次の呼び出しによって、呼び出し元によって割り当てが解除されなければなりません。 WebPDataClear()。

パラメータ: mux -- チャンクを構成する（入出力）オブジェクト。; assembled_data -- （アウト）アセンブルされた WebP データ
戻り値: WEBP_MUX_BAD_DATA -- mux オブジェクトが無効な場合。; WEBP_MUX_INVALID_ARGUMENT -- if mux or assembled_data is NULL.; WEBP_MUX_MEMORY_ERROR -- メモリ割り当てエラーの場合。; WEBP_MUX_OK -- 成功時。

WebPAnimEncoder API

この API を使用すると、（場合によっては）アニメーションの WebP 画像をエンコードできます。

サンプルコード

WebPAnimEncoderOptions enc_options;
WebPAnimEncoderOptionsInit(&enc_options);
// Tune 'enc_options' as needed.
WebPAnimEncoder* enc = WebPAnimEncoderNew(width, height, &enc_options);
while(<there are more frames>) {
  WebPConfig config;
  WebPConfigInit(&config);
  // Tune 'config' as needed.
  WebPAnimEncoderAdd(enc, frame, timestamp_ms, &config);
}
WebPAnimEncoderAdd(enc, NULL, timestamp_ms, NULL);
WebPAnimEncoderAssemble(enc, webp_data);
WebPAnimEncoderDelete(enc);
// Write the 'webp_data' to a file, or re-mux it further.

typedef struct WebPAnimEncoder WebPAnimEncoder;  // Main opaque object.

グローバルオプション

struct WebPAnimEncoderOptions {
  WebPMuxAnimParams anim_params;  // Animation parameters.
  int minimize_size;    // If true, minimize the output size (slow). Implicitly
                        // disables key-frame insertion.
  int kmin;
  int kmax;             // Minimum and maximum distance between consecutive key
                        // frames in the output. The library may insert some key
                        // frames as needed to satisfy this criteria.
                        // Note that these conditions should hold: kmax > kmin
                        // and kmin >= kmax / 2 + 1. Also, if kmax <= 0, then
                        // key-frame insertion is disabled; and if kmax == 1,
                        // then all frames will be key-frames (kmin value does
                        // not matter for these special cases).
  int allow_mixed;      // If true, use mixed compression mode; may choose
                        // either lossy and lossless for each frame.
  int verbose;          // If true, print info and warning messages to stderr.
};

`WebPAnimEncoderOptionsInit()`

新しい WebPAnimEncoderOptions を初期化するために、常に呼び出す必要があります。必要があります。バージョンが一致しない場合は false を返します。 WebPAnimEncoderOptionsInit() が成功しなければ、 enc_options オブジェクト。

パラメータ: enc_options -- アニメーションのエンコードに使用する（入力と出力）オプション
戻り値: 成功した場合は正しい。

int WebPAnimEncoderOptionsInit(
    WebPAnimEncoderOptions* enc_options);

`WebPAnimEncoderNew()`

WebPAnimEncoder オブジェクトを作成して初期化します。

パラメータ: 幅/高さ --（インチ）アニメーションのキャンバスの幅と高さ。; enc_options --（in）エンコードオプションNULL を渡してデフォルト値を設定します。
戻り値: 新しく作成された WebPAnimEncoder オブジェクトへのポインタ。それ以外の場合は NULL メモリエラーになります

WebPAnimEncoder* WebPAnimEncoderNew(
    int width, int height, const WebPAnimEncoderOptions* enc_options);

`WebPAnimEncoderAdd()`

指定されたフレームを WebP 用に最適化し、エンコードして WebPAnimEncoder オブジェクトに対して行います。

最後の WebPAnimEncoderAdd の呼び出しでは、frame = NULL を使用します。は、これ以上追加するフレームがないことを示します。この呼び出しは最後のフレームの継続時間を判別します。

パラメータ: enc -- フレームを追加する（入力/出力）オブジェクト。; frame -- ARGB または YUV(A) 形式のフレームデータ（入出力）。地域 YUV(A) 形式では ARGB に変換されるため、わずかな損失が発生します。; timestamp_ms --（イン）このフレームのタイムスタンプ（ミリ秒単位）。継続時間フレームのタイムスタンプは、「timestamp of next frame（次のフレームのタイムスタンプ - タイムスタンプをこのフレーム」が表示されます。そのため、タイムスタンプは降順にする必要があります。; config --（in）エンコードオプションNULL を渡して妥当な値を選択するできます。
戻り値: エラー発生時には false を返し、frame->error_code が適切に設定される。それ以外の場合は true を返します。

int WebPAnimEncoderAdd(
    WebPAnimEncoder* enc, struct WebPPicture* frame, int timestamp_ms,
    const struct WebPConfig* config);

`WebPAnimEncoderAssemble()`

これまでに追加されたすべてのフレームを WebP ビットストリームにアセンブルします。この呼び出しは前に frame = NULL を指定して WebPAnimEncoderAdd を呼び出し、そうでない場合、最後のフレームの長さは内部的に推定されます。

パラメータ: enc -- フレームの作成元となる（入力と出力）オブジェクト。; webp_data -- （出力）生成された WebP ビットストリーム。
戻り値: 成功の場合は正しい。

int WebPAnimEncoderAssemble(WebPAnimEncoder* enc, WebPData* webp_data);

`WebPAnimEncoderGetError()`

enc を使用して、最新の呼び出しに対応するエラー文字列を取得します。「返された文字列は enc によって所有され、次の呼び出しが行われるまでのみ有効です。 WebPAnimEncoderAdd() または WebPAnimEncoderAssemble() または WebPAnimEncoderDelete() を選択します。

パラメータ: enc -- エラー文字列の取得元となる（入力と出力）オブジェクト。
戻り値: NULL if enc is NULL.それ以外の場合は、最後の enc の呼び出しでエラーが発生したか、最後の呼び出しがあります。

const char* WebPAnimEncoderGetError(WebPAnimEncoder* enc);

`WebPAnimEncoderDelete()`

WebPAnimEncoder オブジェクトを削除します。

パラメータ: enc -- 削除されるオブジェクト（入力/出力）

void WebPAnimEncoderDelete(WebPAnimEncoder* enc);

Demux API

WebP ファイルから画像データや拡張形式のデータを抽出できるようにします。

サンプルコード

WebP データを分離してすべてのフレーム、ICC プロファイル、EXIF/XMP メタデータを抽出する

WebPDemuxer* demux = WebPDemux(&webp_data);

uint32_t width = WebPDemuxGetI(demux, WEBP_FF_CANVAS_WIDTH);
uint32_t height = WebPDemuxGetI(demux, WEBP_FF_CANVAS_HEIGHT);
// ... (Get information about the features present in the WebP file).
uint32_t flags = WebPDemuxGetI(demux, WEBP_FF_FORMAT_FLAGS);

// ... (Iterate over all frames).
WebPIterator iter;
if (WebPDemuxGetFrame(demux, 1, &iter)) {
  do {
    // ... (Consume 'iter'; e.g. Decode 'iter.fragment' with WebPDecode(),
    // ... and get other frame properties like width, height, offsets etc.
    // ... see 'struct WebPIterator' below for more info).
  } while (WebPDemuxNextFrame(&iter));
  WebPDemuxReleaseIterator(&iter);
}

// ... (Extract metadata).
WebPChunkIterator chunk_iter;
if (flags & ICCP_FLAG) WebPDemuxGetChunk(demux, "ICCP", 1, &chunk_iter);
// ... (Consume the ICC profile in 'chunk_iter.chunk').
WebPDemuxReleaseChunkIterator(&chunk_iter);
if (flags & EXIF_FLAG) WebPDemuxGetChunk(demux, "EXIF", 1, &chunk_iter);
// ... (Consume the EXIF metadata in 'chunk_iter.chunk').
WebPDemuxReleaseChunkIterator(&chunk_iter);
if (flags & XMP_FLAG) WebPDemuxGetChunk(demux, "XMP ", 1, &chunk_iter);
// ... (Consume the XMP metadata in 'chunk_iter.chunk').
WebPDemuxReleaseChunkIterator(&chunk_iter);
WebPDemuxDelete(demux);

Demux オブジェクトのライフサイクル

列挙型

typedef enum WebPDemuxState {
  WEBP_DEMUX_PARSE_ERROR    = -1,  // An error occurred while parsing.
  WEBP_DEMUX_PARSING_HEADER =  0,  // Not enough data to parse full header.
  WEBP_DEMUX_PARSED_HEADER  =  1,  // Header parsing complete,
                                   // data may be available.
  WEBP_DEMUX_DONE           =  2   // Entire file has been parsed.
} WebPDemuxState;

`WebPGetDemuxVersion()`

demux ライブラリのバージョン番号をメジャー/マイナー/リビジョンがそれぞれ 8 ビット。たとえば、v2.5.7 は 0x020507 です。

int WebPGetDemuxVersion(void);

`WebPDemux()`

data で指定された完全な WebP ファイルを解析します。

WebPDemuxer WebPDemux(const WebPData* data);

解析が成功した場合は WebPDemuxer オブジェクトを返し、それ以外の場合は NULL を返します。

`WebPDemuxPartial()`

data で指定された不完全な WebP ファイルを解析します。state がデマルチプレクサのステータスを示すように設定されます。

WebPDemuxer WebPDemuxPartial(const WebPData* data, WebPDemuxState* state);

エラーが発生した場合、または解析を開始するのに十分なデータがない場合は NULL を返します。成功した場合は WebPDemuxer オブジェクトを返します。

WebPDemuxer はデータメモリセグメントへの内部ポインタを保持します。条件このデータが揮発性である場合、demuxer オブジェクトを削除する必要があります（ WebPDemuxDelete()）および WebPDemuxPartial() が新しいデータに対して再度呼び出されました。これは、費用を抑えられるオペレーションです

`WebPDemuxDelete()`

dmux に関連付けられたメモリを解放します。

void WebPDemuxDelete(WebPDemuxer* dmux);

データ/情報の抽出

typedef enum WebPFormatFeature {
  WEBP_FF_FORMAT_FLAGS,      // bit-wise combination of WebPFeatureFlags
                             // corresponding to the 'VP8X' chunk (if present).
  WEBP_FF_CANVAS_WIDTH,
  WEBP_FF_CANVAS_HEIGHT,
  WEBP_FF_LOOP_COUNT,        // only relevant for animated file
  WEBP_FF_BACKGROUND_COLOR,  // idem.
  WEBP_FF_FRAME_COUNT        // Number of frames present in the demux object.
                             // In case of a partial demux, this is the number
                             // of frames seen so far, with the last frame
                             // possibly being partial.
} WebPFormatFeature;

`WebPDemuxGetI()`

dmux から feature の値を取得します。

uint32_t WebPDemuxGetI(const WebPDemuxer* dmux, WebPFormatFeature feature);

注: 値は、WebPDemux() が使用されている場合にのみ有効です。 WebPDemuxPartial() からステータスが返されました > WEBP_DEMUX_PARSING_HEADER。

フレームの反復

struct WebPIterator {
  int frame_num;
  int num_frames;          // equivalent to WEBP_FF_FRAME_COUNT.
  int fragment_num;
  int num_fragments;
  int x_offset, y_offset;  // offset relative to the canvas.
  int width, height;       // dimensions of this frame or fragment.
  int duration;            // display duration in milliseconds.
  WebPMuxAnimDispose dispose_method;  // dispose method for the frame.
  int complete;   // true if 'fragment' contains a full frame. partial images
                  // may still be decoded with the WebP incremental decoder.
  WebPData fragment;  // The frame or fragment given by 'frame_num' and
                      // 'fragment_num'.
  int has_alpha;      // True if the frame or fragment contains transparency.
  WebPMuxAnimBlend blend_method;  // Blend operation for the frame.
};

`WebPDemuxGetFrame()`

dmux からフレーム frame_number を取得します。

int WebPDemuxGetFrame(const WebPDemuxer* dmux,
                      int frame_number,
                      WebPIterator* iter);

iter->fragment は、この関数から返された最初のフラグメントを指します。個々のフラグメントは、 WebPDemuxSelectFragment()。設定 frame_number が 0 に等しい場合は、画像の最後のフレームが返されます。

dmux が NULL の場合、またはフレーム dmux が存在しない場合は false を返します。次の値を使用する場合は、WebPDemuxReleaseIterator() を呼び出します。イテレータが完成します。

注: dmux は iter の存続期間中に保持される必要があります。

`WebPDemuxNextFrame()`、`WebPDemuxPrevFrame()`

次の（iter->fragment + 1）を指すように iter->fragment を設定します。または、前の (iter->frame_num - 1) フレームです。これらの関数はループしません。

int WebPDemuxNextFrame(WebPIterator* iter);
int WebPDemuxPrevFrame(WebPIterator* iter);

成功した場合は true、それ以外の場合は false を返します。

`WebPDemuxSelectFragment()`

フラグメント番号 iter->fragment を反映するように iter->fragment を設定します。

int WebPDemuxSelectFragment(WebPIterator* iter, int fragment_num);

フラグメント fragment_num が存在する場合は true を返し、存在しない場合は false を返します。

`WebPDemuxReleaseIterator()`

iter に関連付けられたメモリを解放します。

void WebPDemuxReleaseIterator(WebPIterator* iter);

後続の呼び出しでは、この関数を呼び出す必要があります。同じイテレーションに対する WebPDemuxGetChunk()。また、関連する WebPDemuxer を破棄する前に呼び出されます。 WebPDemuxDelete()。

チャンクの反復処理

struct WebPChunkIterator {
  // The current and total number of chunks with the fourcc given to
  // WebPDemuxGetChunk().
  int chunk_num;
  int num_chunks;
  WebPData chunk;    // The payload of the chunk.
};

`WebPDemuxGetChunk()`

ID が fourcc のチャンクの chunk_number インスタンスを取得します。 dmux。

int WebPDemuxGetChunk(const WebPDemuxer* dmux,
                      const char fourcc[4], int chunk_number,
                      WebPChunkIterator* iter);

fourcc は、返されるチャンクの 4cc を含む文字配列です。例:「ICCP」、「XMP」、「EXIF」など

chunk_number を 0 に設定すると、セット内の最後のチャンクが返されます。

チャンクが見つかった場合は true を返し、それ以外の場合は false を返します。画像関連のチャンクペイロードには WebPDemuxGetFrame() を介してアクセス関連する関数が含まれます。発信 WebPDemuxReleaseChunkIterator()（使用する場合）完了しています。

注: dmux は、イテレータの存続期間中は存続する必要があります。

`WebPDemuxNextChunk()`、`WebPDemuxPrevChunk()`

次の（iter->chunk_num + 1）を指すように iter->chunk を設定します。または（iter->chunk_num - 1）チャンクを返します。これらの関数はループしません。

int WebPDemuxNextChunk(WebPChunkIterator* iter);
int WebPDemuxPrevChunk(WebPChunkIterator* iter);

成功した場合は true、それ以外の場合は false を返します。

`WebPDemuxReleaseChunkIterator()`

iter に関連付けられたメモリを解放します。

void WebPDemuxReleaseChunkIterator(WebPChunkIterator* iter);

関連付けられている WebPDemuxer を破棄する前に呼び出す必要があります。 WebPDemuxDelete()。

WebPAnimDecoder API

この API を使用すると、（場合によっては）アニメーションの WebP 画像をデコードできます。

サンプルコード

WebPAnimDecoderOptions dec_options;
WebPAnimDecoderOptionsInit(&dec_options);
// Tune 'dec_options' as needed.
WebPAnimDecoder* dec = WebPAnimDecoderNew(webp_data, &dec_options);
WebPAnimInfo anim_info;
WebPAnimDecoderGetInfo(dec, &anim_info);
for (uint32_t i = 0; i < anim_info.loop_count; ++i) {
  while (WebPAnimDecoderHasMoreFrames(dec)) {
    uint8_t* buf;
    int timestamp;
    WebPAnimDecoderGetNext(dec, &buf, &timestamp);
    // ... (Render 'buf' based on 'timestamp').
    // ... (Do NOT free 'buf', as it is owned by 'dec').
  }
  WebPAnimDecoderReset(dec);
}
const WebPDemuxer* demuxer = WebPAnimDecoderGetDemuxer(dec);
// ... (Do something using 'demuxer'; e.g. get EXIF/XMP/ICC data).
WebPAnimDecoderDelete(dec);

typedef struct WebPAnimDecoder WebPAnimDecoder;  // Main opaque object.

グローバルオプション

struct WebPAnimDecoderOptions {
  // Output colorspace. Only the following modes are supported:
  // MODE_RGBA, MODE_BGRA, MODE_rgbA and MODE_bgrA.
  WEBP_CSP_MODE color_mode;
  int use_threads;           // If true, use multi-threaded decoding.
};

`WebPAnimDecoderOptionsInit()`

新しい WebPAnimDecoderOptions を初期化するため、常に呼び出す必要があります。必要があります。バージョンが一致しない場合は false を返します。 WebPAnimDecoderOptionsInit() が成功しなければ、 dec_options オブジェクト。

パラメータ

dec_options -- アニメーションのデコードに使用する（入力と出力）オプション

戻り値: 成功の場合は正しい

int WebPAnimDecoderOptionsInit(
    WebPAnimDecoderOptions* dec_options);

`WebPAnimDecoderNew()`

WebPAnimDecoder オブジェクトを作成して初期化します。

パラメータ: webp_data --（内）WebP ビットストリーム。この値は、出力 WebPAnimDecoder オブジェクトのライフタイム。; dec_options -- （in）デコードオプション。NULL を渡して選択することも可能（特に、カラーモード MODE_RGBA が選択されます）。
戻り値: 新しく作成された WebPAnimDecoder オブジェクトへのポインタ。それ以外の場合は NULL （解析エラー、無効なオプション、メモリエラーなど）が含まれます。

WebPAnimDecoder* WebPAnimDecoderNew(
    const WebPData* webp_data, const WebPAnimDecoderOptions* dec_options);

アニメーションに関するグローバル情報。

struct WebPAnimInfo {
  uint32_t canvas_width;
  uint32_t canvas_height;
  uint32_t loop_count;
  uint32_t bgcolor;
  uint32_t frame_count;
};

`WebPAnimDecoderGetInfo()`

アニメーションに関するグローバル情報を取得します。

パラメータ: dec -- （in）情報を取得するデコーダインスタンス。; info --（出力）アニメーションから取得されたグローバル情報。
戻り値: 成功の場合は正しい。

int WebPAnimDecoderGetInfo(const WebPAnimDecoder* dec,
                           WebPAnimInfo* info);

`WebPAnimDecoderGetNext()`

指定されたオプションに基づいて、dec から次のフレームを取得します。 WebPAnimDecoderNew()。これは完全なサイズ canvas_width * 4 * canvas_height の再構築されたキャンバスをサブ長方形を作成します。返されたバッファの buf は、 WebPAnimDecoderGetNext() への次の呼び出し、 WebPAnimDecoderReset() または WebPAnimDecoderDelete()。

パラメータ: dec -- 次のフレームが発生する（入出力）デコーダインスタンスあります。; buf --（出力）デコードされたフレーム。; timestamp -- フレームの（出力）タイムスタンプ（ミリ秒単位）。
戻り値: いずれかの引数が NULL の場合、または解析結果またはデコーディングエラー、またはそれ以上のフレームがないことが通知されます。それ以外の場合は true を返します。

int WebPAnimDecoderGetNext(WebPAnimDecoder* dec,
                           uint8_t** buf, int* timestamp);

`WebPAnimDecoderHasMoreFrames()`

デコードするフレームが残っているかどうかを確認します。

パラメータ: dec -- チェック対象の（in）デコーダインスタンス。
戻り値: dec が NULL でなく、一部のフレームがまだデコードされていない場合は true。それ以外の場合は false を返します。

int WebPAnimDecoderHasMoreFrames(const WebPAnimDecoder* dec);

`WebPAnimDecoderReset()`

WebPAnimDecoder オブジェクトをリセットして、次の呼び出しを WebPAnimDecoderGetNext() でデコードを再開します取得されます。すべてのフレームをデコードする必要がある場合に便利破棄して再作成せずに複数回（たとえば info.loop_count 回）実行される dec オブジェクト。

パラメータ: dec -- リセットする（入出力）デコーダインスタンス

void WebPAnimDecoderReset(WebPAnimDecoder* dec);

`WebPAnimDecoderGetDemuxer()`

内部デマルチプレクサーオブジェクトを取得します。

デマルチプレクサーオブジェクトの取得は、オペレーションのみを使用する場合に役立ちます。使用できます。例:XMP/EXIF/ICC メタデータを取得できます返される demuxer オブジェクトは dec によって所有され、次の呼び出しまでのみ有効です。 WebPAnimDecoderDelete()。

パラメータ: dec -- デコーダオブジェクトの追加元となる（in）デコーダインスタンスあります。

const WebPDemuxer* WebPAnimDecoderGetDemuxer(const WebPAnimDecoder* dec);

`WebPAnimDecoderDelete()`

WebPAnimDecoder オブジェクトを削除します。

パラメータ: dec -- 削除される（入出力）デコーダインスタンス。
戻り値: 成功した場合は正しい。

void WebPAnimDecoderDelete(WebPAnimDecoder* dec);

一般的なデータ型

列挙型

typedef enum WebPFeatureFlags {
  FRAGMENTS_FLAG  = 0x00000001,
  ANIMATION_FLAG  = 0x00000002,
  XMP_FLAG        = 0x00000004,
  EXIF_FLAG       = 0x00000008,
  ALPHA_FLAG      = 0x00000010,
  ICCP_FLAG       = 0x00000020
} WebPFeatureFlags;

// Dispose method (animation only). Indicates how the area used by the current
// frame is to be treated before rendering the next frame on the canvas.
typedef enum WebPMuxAnimDispose {
  WEBP_MUX_DISPOSE_NONE,       // Do not dispose.
  WEBP_MUX_DISPOSE_BACKGROUND  // Dispose to background color.
} WebPMuxAnimDispose;

// Blend operation (animation only). Indicates how transparent pixels of the
// current frame are blended with those of the previous canvas.
typedef enum WebPMuxAnimBlend {
  WEBP_MUX_BLEND,              // Blend.
  WEBP_MUX_NO_BLEND            // Do not blend.
} WebPMuxAnimBlend;

`WebPDataInit()`

webp_data オブジェクトの内容をデフォルト値で初期化します。

void WebPDataInit(WebPData* webp_data);

`WebPDataClear()`

free() を呼び出して webp_data オブジェクトの内容をクリアします。含まれないオブジェクト自体の割り当てを解除します

void WebPDataClear(WebPData* webp_data);

`WebPDataCopy()`

dst に必要なストレージを割り当て、src の内容をコピーします。成功した場合は true を返します。

int WebPDataCopy(const WebPData* src, WebPData* dst);

WebP Container API ドキュメント

Mux API

サンプルコード

画像データ、カラー プロファイル、XMP メタデータを使用して MUX を作成する

WebP ファイルから画像とカラー プロファイル データを取得する

Mux オブジェクトの存続期間

列挙型

WebPGetMuxVersion()

WebPMuxNew()

WebPMuxDelete()

Mux の作成

WebPMuxCreate()

非画像チャンク

WebPMuxSetChunk()

WebPMuxGetChunk()

WebPMuxDeleteChunk()

画像

WebPMuxSetImage()

WebPMuxPushFrame()

WebPMuxGetFrame()

WebPMuxDeleteFrame()

アニメーション

アニメーション パラメータ

WebPMuxSetAnimationParams()

WebPMuxGetAnimationParams()

その他公益

WebPMuxGetCanvasSize()

WebPMuxGetFeatures()

WebPMuxNumChunks()

WebPMuxAssemble()

WebPAnimEncoder API

WebPAnimEncoderOptionsInit()

WebPAnimEncoderNew()

WebPAnimEncoderAdd()

WebPAnimEncoderAssemble()

WebPAnimEncoderGetError()

WebPAnimEncoderDelete()

Demux API

サンプルコード

WebP データを分離してすべてのフレーム、ICC プロファイル、EXIF/XMP メタデータを抽出する

Demux オブジェクトのライフサイクル

列挙型

WebPGetDemuxVersion()

WebPDemux()

WebPDemuxPartial()

WebPDemuxDelete()

データ/情報の抽出

WebPDemuxGetI()

フレームの反復

WebPDemuxGetFrame()

WebPDemuxNextFrame()、WebPDemuxPrevFrame()

WebPDemuxSelectFragment()

WebPDemuxReleaseIterator()

チャンクの反復処理

WebPDemuxGetChunk()

WebPDemuxNextChunk()、WebPDemuxPrevChunk()

WebPDemuxReleaseChunkIterator()

WebPAnimDecoder API

WebPAnimDecoderOptionsInit()

WebPAnimDecoderNew()

WebPAnimDecoderGetInfo()

WebPAnimDecoderGetNext()

WebPAnimDecoderHasMoreFrames()

WebPAnimDecoderReset()

WebPAnimDecoderGetDemuxer()

WebPAnimDecoderDelete()

一般的なデータ型

列挙型

WebPDataInit()

WebPDataClear()

WebPDataCopy()

画像データ、カラープロファイル、XMP メタデータを使用して MUX を作成する

WebP ファイルから画像とカラープロファイルデータを取得する

`WebPGetMuxVersion()`

`WebPMuxNew()`

`WebPMuxDelete()`

`WebPMuxCreate()`

`WebPMuxSetChunk()`

`WebPMuxGetChunk()`

`WebPMuxDeleteChunk()`

`WebPMuxSetImage()`

`WebPMuxPushFrame()`

`WebPMuxGetFrame()`

`WebPMuxDeleteFrame()`

アニメーションパラメータ

`WebPMuxSetAnimationParams()`

`WebPMuxGetAnimationParams()`

`WebPMuxGetCanvasSize()`

`WebPMuxGetFeatures()`

`WebPMuxNumChunks()`

`WebPMuxAssemble()`

`WebPAnimEncoderOptionsInit()`

`WebPAnimEncoderNew()`

`WebPAnimEncoderAdd()`

`WebPAnimEncoderAssemble()`

`WebPAnimEncoderGetError()`

`WebPAnimEncoderDelete()`

`WebPGetDemuxVersion()`

`WebPDemux()`

`WebPDemuxPartial()`

`WebPDemuxDelete()`

`WebPDemuxGetI()`

`WebPDemuxGetFrame()`

`WebPDemuxNextFrame()`、`WebPDemuxPrevFrame()`

`WebPDemuxSelectFragment()`

`WebPDemuxReleaseIterator()`

`WebPDemuxGetChunk()`

`WebPDemuxNextChunk()`、`WebPDemuxPrevChunk()`

`WebPDemuxReleaseChunkIterator()`

`WebPAnimDecoderOptionsInit()`

`WebPAnimDecoderNew()`

`WebPAnimDecoderGetInfo()`

`WebPAnimDecoderGetNext()`

`WebPAnimDecoderHasMoreFrames()`

`WebPAnimDecoderReset()`

`WebPAnimDecoderGetDemuxer()`

`WebPAnimDecoderDelete()`

`WebPDataInit()`

`WebPDataClear()`

`WebPDataCopy()`