Diese Seite wurde von der Cloud Translation API übersetzt.

WebP API-Dokumentation

In diesem Abschnitt wird die API für den Encoder und Decoder beschrieben, die in der WebP-Bibliothek enthalten sind. Diese API-Beschreibung bezieht sich auf Version 1.4.0.

Header und Bibliotheken

Beim Installieren von libwebp wird ein Verzeichnis namens webp/ am typischen Speicherort für Ihre Plattform installiert. Auf Unix-Plattformen werden beispielsweise die folgenden Headerdateien in /usr/local/include/webp/ kopiert.

decode.h
encode.h
types.h

Die Bibliotheken befinden sich in den üblichen Bibliotheksverzeichnissen. Die statischen und dynamischen Bibliotheken befinden sich auf Unix-Plattformen unter /usr/local/lib/.

Simple Decoding API

Wenn Sie die Decoding API verwenden möchten, müssen Sie zuerst dafür sorgen, dass die Bibliotheks- und Headerdateien wie oben beschrieben installiert sind.

Fügen Sie den Decoding API-Header wie folgt in Ihren C/C++-Code ein:

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

Diese Funktion validiert den WebP-Bildheader und ruft die Bildbreite und -höhe ab. Die Mauszeiger *width und *height können mit NULL übergeben werden, wenn sie als irrelevant eingestuft werden.

Eingabeattribute

Daten: Zeiger auf WebP-Bilddaten
data_size: Die Größe des Arbeitsspeicherblocks, auf den data mit den Bilddaten verweist.

Returns

false: Fehlercode, der bei (a) Formatierungsfehlern zurückgegeben wird
true: Bei Erfolg. *width und *height sind nur bei erfolgreicher Rückgabe gültig.
Breite: Ganzzahl. Der Bereich ist auf 1 bis 16.383 begrenzt.
Höhe: Ganzzahl. Der Bereich ist auf 1 bis 16.383 begrenzt.

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

Diese Funktion ruft Features aus dem Bitstream ab. Die *features-Struktur ist mit Informationen gefüllt, die aus dem Bitstream stammen:

Eingabeattribute

Daten: Zeiger auf WebP-Bilddaten
data_size: Die Größe des Arbeitsspeicherblocks, auf den data mit den Bilddaten verweist.

Returns

VP8_STATUS_OK: Wenn die Features erfolgreich abgerufen wurden.
VP8_STATUS_NOT_ENOUGH_DATA: Wenn mehr Daten erforderlich sind, um die Features aus den Headern abzurufen.

Zusätzliche VP8StatusCode-Fehlerwerte in anderen Fällen.

Features: Zeiger auf die WebPBitstreamFeatures-Struktur.

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

Mit diesen Funktionen wird ein WebP-Bild decodiert, auf das data verweist.

WebPDecodeRGBA gibt RGBA-Bildbeispiele in der Reihenfolge [r0, g0, b0, a0, r1, g1, b1, a1, ...] zurück.
WebPDecodeARGB gibt ARGB-Bildbeispiele in der Reihenfolge [a0, r0, g0, b0, a1, r1, g1, b1, ...] zurück.
WebPDecodeBGRA gibt BGRA-Bildbeispiele in der Reihenfolge [b0, g0, r0, a0, b1, g1, r1, a1, ...] zurück.
WebPDecodeRGB gibt RGB-Bildbeispiele in der Reihenfolge [r0, g0, b0, r1, g1, b1, ...] zurück.
WebPDecodeBGR gibt BGR-Bildbeispiele in der Reihenfolge [b0, g0, r0, b1, g1, r1, ...] zurück.

Der Code, mit dem eine dieser Funktionen aufgerufen wird, muss den von diesen Funktionen mit WebPFree() zurückgegebenen Datenpuffer (uint8_t*) löschen.

Eingabeattribute

Daten: Zeiger auf WebP-Bilddaten
data_size: Die Größe des Arbeitsspeicherblocks, auf den data mit den Bilddaten verweist.
Breite: Ganzzahl. Der Bereich ist derzeit auf 1 bis 16.383 begrenzt.
Höhe: Ganzzahl. Der Bereich ist derzeit auf 1 bis 16.383 begrenzt.

Returns

uint8_t*: Zeiger auf decodierte WebP-Bildbeispiele in linearer RGBA-/ARGB-/BGRA-/RGB-/BGR-Reihenfolge.

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

Diese Funktionen sind Varianten der obigen Funktionen und decodieren das Bild direkt in einen vorab zugewiesenen Zwischenspeicher output_buffer. Der maximal in diesem Zwischenspeicher verfügbare Speicher wird durch output_buffer_size angegeben. Wenn dieser Speicherplatz nicht ausreicht oder ein Fehler aufgetreten ist, wird NULL zurückgegeben. Andernfalls wird output_buffer zurückgegeben.

Der Parameter output_stride gibt den Abstand (in Byte) zwischen den Scanlinien an. Daher muss output_buffer_size mindestens output_stride * picture - height sein.

Eingabeattribute

Daten: Zeiger auf WebP-Bilddaten
data_size: Die Größe des Arbeitsspeicherblocks, auf den data mit den Bilddaten verweist.
output_buffer_size: Ganzzahl. Größe des zugewiesenen Zwischenspeichers
output_stride: Ganzzahl. Gibt den Abstand zwischen Scanlinien an.

Returns

output_buffer: Zeiger auf das decodierte WebP-Bild.
uint8_t*: output_buffer, wenn die Funktion erfolgreich ist; andernfalls NULL.

Erweiterte Decoding API

Die WebP-Decodierung unterstützt eine moderne API, die ein schnelles Zuschneiden und Aktualisieren ermöglicht. Dies ist in Umgebungen mit beschränktem Arbeitsspeicher wie Smartphones von großem Nutzen. Im Grunde wächst die Arbeitsspeichernutzung mit der Größe der Ausgabe, nicht mit der Eingabe, wenn nur eine schnelle Vorschau oder ein herangezoomter Teil eines ansonsten zu großen Bilds benötigt wird. Auch ein Teil der CPU kann zukünftig eingespart werden.

Die WebP-Decodierung besteht in zwei Varianten: vollständige Bilddecodierung und inkrementelle Decodierung über kleine Eingabepuffer. Nutzer können optional einen externen Speicherpuffer zum Decodieren des Bildes bereitstellen. Das folgende Codebeispiel veranschaulicht die Schritte zur Verwendung der Advanced Decoding API.

Zuerst müssen wir ein Konfigurationsobjekt initialisieren:

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

Die Decodierungsoptionen sind in der WebPDecoderConfig-Struktur enthalten:

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]
};

Optional können die Bitstream-Features in config.input eingelesen werden, falls wir sie im Voraus kennen müssen. Zum Beispiel kann es hilfreich sein zu wissen, ob das Bild überhaupt transparent ist. Beachten Sie, dass dabei auch der Header des Bitstreams geparst wird. Daher können Sie gut feststellen, ob der Bitstream wie ein gültiger WebP-Header aussieht.

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

Dann müssen wir den Decodierungs-Speicherzwischenspeicher einrichten, falls wir ihn direkt bereitstellen möchten, anstatt uns für seine Zuweisung auf den Decoder zu verlassen. Wir müssen nur den Zeiger an den Speicher sowie die Gesamtgröße des Zwischenspeichers und den Linienschritt (Distanz in Byte zwischen den Scanzeilen) angeben.

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

Das Bild kann jetzt decodiert werden. Es gibt zwei mögliche Varianten für die Decodierung des Bildes. Wir können das Bild in einem Durchlauf decodieren:

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

Alternativ können Sie die inkrementelle Methode verwenden, um das Bild schrittweise zu decodieren, wenn neue Bytes verfügbar werden:

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.

Das decodierte Bild befindet sich jetzt in config.output (bzw. in diesem Fall in config.output.u.RGBA, da der angeforderte Ausgabefarbraum MODE_BGRA war). Das Bild kann gespeichert, angezeigt oder anderweitig verarbeitet werden. Danach muss nur der im config-Objekt zugewiesene Arbeitsspeicher freigegeben werden. Sie können diese Funktion auch dann aufrufen, wenn der Arbeitsspeicher extern ist und nicht von WebPDecode() zugewiesen wurde:

WebPFreeDecBuffer(&config.output);

Mit dieser API kann das Bild auch mit MODE_YUV bzw. MODE_YUVA in YUV- und YUVA-Formate decodiert werden. Dieses Format wird auch Y'CbCr genannt.

Einfache Codierungs-API

Für die Codierung von Arrays von RGBA-Beispielen in den meisten gängigen Layouts stehen einige sehr einfache Funktionen zur Verfügung. Sie werden im webp/encode.h-Header so deklariert:

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

Der Qualitätsfaktor quality_factor reicht von 0 bis 100 und steuert den Verlust und die Qualität bei der Komprimierung. Der Wert 0 steht für geringe Qualität und kleine Ausgabegrößen, während 100 für die höchste Qualität und die größte Ausgabegröße steht. Bei Erfolg werden die komprimierten Byte im Zeiger *output platziert und die Größe in Byte wird zurückgegeben. Andernfalls wird 0 zurückgegeben, falls ein Fehler auftritt. Der Aufrufer muss WebPFree() für den *output-Zeiger aufrufen, um Arbeitsspeicher freizugeben.

Das Eingabearray sollte ein gepacktes Array von Byte sein (eines für jeden Kanal, wie der Name der Funktion erwartet). stride entspricht der Anzahl von Byte, die erforderlich sind, um von einer Zeile zur nächsten zu springen. Das BGRA-Layout ist beispielsweise:

Für die verlustfreie Codierung gibt es äquivalente Funktionen mit Signaturen:

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

Beachten Sie, dass diese Funktionen, wie die verlustbehafteten Versionen, die Standardeinstellungen der Bibliothek verwenden. Bei verlustfreien Materialien ist „Genau passend“ deaktiviert. RGB-Werte in transparenten Bereichen werden geändert, um die Komprimierung zu verbessern. Um dies zu vermeiden, verwenden Sie WebPEncode() und setzen WebPConfig::exact auf 1.

Erweiterte Codierungs-API

Der Encoder ist mit zahlreichen erweiterten Codierungsparametern ausgestattet. Sie können nützlich sein, um den Kompromiss zwischen Komprimierungseffizienz und Verarbeitungszeit besser auszugleichen. Diese Parameter werden in der WebPConfig-Struktur zusammengefasst. Die am häufigsten verwendeten Felder in dieser Struktur sind:

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

Beachten Sie, dass Sie mit dem cwebp-Befehlszeilentool auf die meisten dieser Parameter experimentieren können.

Die Eingabebeispiele sollten in eine WebPPicture-Struktur eingebunden sein. Diese Struktur kann Eingabeproben abhängig vom Wert des Flags use_argb entweder im RGBA- oder YUVA-Format speichern.

Die Struktur ist wie folgt aufgebaut:

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

Diese Struktur hat auch eine Funktion, um die komprimierten Byte auszugeben, sobald sie verfügbar sind. Unten finden Sie ein Beispiel mit einem In-Memory-Writer. Andere Autoren können Daten direkt in einer Datei speichern. Ein solches Beispiel finden Sie unter examples/cwebp.c.

Der allgemeine Ablauf zur Codierung mit der erweiterten API sieht so aus:

Zuerst müssen wir eine Codierungskonfiguration mit den Komprimierungsparametern einrichten. Beachten Sie, dass dieselbe Konfiguration anschließend verwendet werden kann, um mehrere verschiedene Images zu komprimieren.

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

Anschließend muss durch einen Verweis oder eine Kopie auf die Eingabebeispiele in einer WebPPicture verwiesen werden. Hier ist ein Beispiel für die Zuweisung des Puffers für die Proben. Sie können jedoch problemlos eine „Ansicht“ für ein bereits zugewiesenes Beispielarray einrichten. Siehe Funktion 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.

Jedes Mal, wenn neue Byte verfügbar sind, wird ein Hook aufgerufen, um die komprimierten Byte auszugeben. Hier ist ein einfaches Beispiel mit dem in webp/encode.h deklarierten Memory Writer. Diese Initialisierung ist wahrscheinlich für jedes zu komprimierende Bild erforderlich:

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

Wir sind jetzt bereit, die Eingabe-Samples zu komprimieren (und danach Speicherplatz freizugeben):

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

Für eine erweiterte Verwendung der API und der Struktur empfiehlt es sich, die im webp/encode.h-Header verfügbare Dokumentation zu lesen. Der Beispielcode examples/cwebp.c kann sich zum Erkennen weniger verwendeter Parameter als nützlich erweisen.