Documentazione dell'API WebP

Questa sezione descrive l'API per l'encoder e il decoder inclusi nella libreria WebP. Questa descrizione dell'API riguarda la versione 1.4.0.

Intestazioni e librerie

Quando installi libwebp, la directory denominata webp/ verrà installato nella posizione tipica della tua piattaforma. Ad esempio, su piattaforme Unix, i seguenti file di intestazione verrebbero copiati /usr/local/include/webp/.

decode.h
encode.h
types.h

Le librerie si trovano nelle solite directory delle librerie. Le statistiche le librerie dinamiche si trovano in /usr/local/lib/ sulle piattaforme Unix.

API Simple Decoding

Per iniziare a utilizzare l'API di decodifica, devi assicurarti di disporre del i file di libreria e intestazione installati come descritto sopra.

Includi l'intestazione dell'API di decodifica nel codice C/C++ come segue:

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

Questa funzione convaliderà l'intestazione dell'immagine WebP e recupererà la larghezza dell'immagine e altezza. I puntatori *width e *height possono essere superati NULL se considerati irrilevante.

Attributi di input

dati
Link ai dati immagine WebP
data_size
Questa è la dimensione del blocco di memoria a cui punta data contenente il come immagini.

Resi

falso
Codice di errore restituito in caso di (a) errore di formattazione.
true
Al successo. *width e *height sono validi solo per resi con esito positivo.
larghezza
Valore intero. L'intervallo è limitato da 1 a 16.383.
altezza
Valore intero. L'intervallo è limitato da 1 a 16.383.
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);

Questa funzione recupererà le caratteristiche dal flusso di bit. *features struttura è piena di informazioni raccolte dal flusso di bit:

Attributi di input

dati
Link ai dati immagine WebP
data_size
Questa è la dimensione del blocco di memoria a cui punta data contenente il come immagini.

Resi

VP8_STATUS_OK
Una volta recuperate le funzionalità.
VP8_STATUS_NOT_ENOUGH_DATA
Quando sono necessari più dati per recuperare le caratteristiche dalle intestazioni.

Altri valori di errore di VP8StatusCode in altri casi.

funzioni
Link alla struttura di 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);

Queste funzioni decodificano un'immagine WebP che punta da data.

  • WebPDecodeRGBA restituisce i campioni di immagini RGBA in [r0, g0, b0, a0, r1, g1, b1, a1, ...] ordine.
  • WebPDecodeARGB restituisce campioni di immagini ARGB in [a0, r0, g0, b0, a1, r1, g1, b1, ...] ordine.
  • WebPDecodeBGRA restituisce i campioni di immagini BGRA in [b0, g0, r0, a0, b1, g1, r1, a1, ...] ordine.
  • WebPDecodeRGB restituisce campioni di immagini RGB in [r0, g0, b0, r1, g1, b1, ...] ordine.
  • WebPDecodeBGR restituisce i campioni di immagini BGR in [b0, g0, r0, b1, g1, r1, ...] ordine.

Il codice che chiama una di queste funzioni deve eliminare il buffer di dati (uint8_t*) restituito da queste funzioni con WebPFree().

Attributi di input

dati
Link ai dati immagine WebP
data_size
Questa è la dimensione del blocco di memoria a cui punta data contenente il dati di immagine
larghezza
Valore intero. Al momento l'intervallo è limitato da 1 a 16.383.
altezza
Valore intero. Al momento l'intervallo è limitato da 1 a 16.383.

Resi

uint8_t*
Suggerimento per decodificare i campioni di immagini WebP nelle versioni RGBA/ARGB/BGRA/RGB/BGR lineari dell'ordine.
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);

Queste funzioni sono varianti di quelle precedenti e decodificano direttamente l'immagine in un buffer preallocato output_buffer. Lo spazio di archiviazione massimo disponibile questo buffer è indicato da output_buffer_size. Se questo spazio di archiviazione non è sufficiente (o si è verificato un errore), viene restituito NULL. Altrimenti, output_buffer viene restituito, per praticità.

Il parametro output_stride specifica la distanza (in byte) tra linee di scansione. Di conseguenza, si prevede che il valore di output_buffer_size sia output_stride * picture - height.

Attributi di input

dati
Link ai dati immagine WebP
data_size
Questa è la dimensione del blocco di memoria a cui punta data contenente il dati di immagine
output_buffer_size
Valore intero. Dimensione del buffer allocato
output_stride
Valore intero. Specifica la distanza tra le linee di scansione.

Resi

output_buffer
Puntatore all'immagine WebP decodificata.
uint8_t*
output_buffer se la funzione ha esito positivo; NULL negli altri casi.

API Advanced Decoding

La decodifica WebP supporta un'API avanzata per offrire la possibilità di avere subito ritaglio e ridimensionamento, un aspetto di grande utilità per i video con limiti di memoria in ambienti come i telefoni cellulari. In sostanza, la memoria utilizzata verrà scalata la dimensione dell'output, non quella dell'input quando è necessaria solo un'anteprima rapida o ingrandito una parte di un'immagine altrimenti troppo grande. Parte della CPU può essere salvata anche in modo accidentale.

La decodifica WebP è disponibile in due varianti, ovvero la decodifica dell'immagine completa e la la decodifica su piccoli buffer di input. Gli utenti possono facoltativamente fornire un indirizzo buffer di memoria per la decodifica dell'immagine. Il seguente esempio di codice passerà a i passaggi per utilizzare l'API Advanced Decoding.

Per prima cosa dobbiamo inizializzare un oggetto di configurazione:

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

Le opzioni di decodifica sono raccolte all'interno di WebPDecoderConfig struttura:

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

Facoltativamente, le funzionalità bitstream possono essere lette in config.input, nel caso in cui avessimo bisogno di conoscerli in anticipo. Ad esempio, può essere utile sapere se l'immagine ha una certa trasparenza. Tieni presente che analizzano anche l'header del bitstream, ed è quindi un buon modo per sapere se il bitstream appare come un WebP valido.

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

Dobbiamo quindi impostare il buffer di memoria di decodifica nel caso volessi fornirlo. direttamente dal decoder per la sua allocazione. Dobbiamo solo fornisce il puntatore alla memoria, nonché la dimensione totale del buffer il passo di linea (distanza in byte tra le linee di scansione).

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

L'immagine è pronta per essere decodificata. Esistono due possibili varianti per la decodifica dell'immagine. Possiamo decodificare l'immagine in una volta sola utilizzando:

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

In alternativa, possiamo utilizzare il metodo incrementale per decodificare progressivamente l'immagine man mano che diventano disponibili nuovi byte:

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.

L'immagine decodificata è ora in config.output (o meglio, in config.output.u.RGBA) in questo caso, poiché lo spazio colore di output richiesto era MODE_BGRA). L'immagine può salvare, visualizzare o elaborare in altro modo. In seguito, dobbiamo solo rivendicare la memoria allocata nell'oggetto della configurazione. Puoi chiamare questa funzione anche se la memoria è esterna e non è stata allocati da WebPDecode():

WebPFreeDecBuffer(&config.output);

Utilizzando questa API l'immagine può anche essere decodificata nei formati YUV e YUVA, utilizzando MODE_YUV e MODE_YUVA rispettivamente. Questo formato è chiamato anche Y'CbCr.

API Simple Encoding

Vengono fornite alcune funzioni molto semplici per la codifica di array di campioni RGBA nei layout più comuni. Sono dichiarate nel webp/encode.h come:

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

Il fattore di qualità quality_factor va da 0 a 100 e controlla la perdita e la qualità durante la compressione. Il valore 0 corrisponde a un valore basso di alta qualità e dimensioni di output ridotte, mentre 100 è la dimensione massima e la dimensione dell'output. Se l'operazione riesce, i byte compressi vengono inseriti nel campo *output e viene restituita la dimensione in byte (altrimenti viene restituito 0, se di errore). Il chiamante deve chiamare WebPFree() sul *output per recuperare memoria.

L'array di input deve essere un array di byte pacchettizzati (uno per ogni canale, previsto dal nome della funzione). stride corrisponde alla di byte necessari per passare da una riga all'altra. Ad esempio, Layout BGRA:

Esistono funzioni equivalenti per la codifica senza perdita di dati, con le firme:

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

Tieni presente che queste funzioni, come le versioni con perdita di dati, utilizzano il valore predefinito della libreria impostazioni. Per i dati senza perdita di dati significa "esatto" è disabilitata. valori RGB in le aree trasparenti verranno modificate per migliorare la compressione. Per evitare che ciò accada, utilizza WebPEncode() e impostare WebPConfig::exact su 1.

API Advanced Encoding

Di base, l'encoder dispone di numerosi parametri di codifica avanzati. Possono essere utili per bilanciare meglio il compromesso tra compressione l'efficienza e i tempi di elaborazione. Questi parametri vengono raccolti all'interno della struttura WebPConfig. I campi più utilizzati di questa struttura sono:

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

Tieni presente che la maggior parte di questi parametri è accessibile per la sperimentazione utilizzando lo strumento a riga di comando cwebp.

Gli esempi di input devono essere aggregati in una struttura WebPPicture. Questa struttura può memorizzare campioni di input in formato RGBA o YUVA, a seconda sul valore del flag use_argb.

La struttura è organizzata come segue:

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

Questa struttura ha anche la funzione di emettere i byte compressi mentre disponibili. Di seguito è riportato un esempio con un writer in memoria. Altri autori possono archiviare direttamente i dati in un file (vedi examples/cwebp.c per questo esempio).

Il flusso generale per la codifica mediante l'API avanzata è simile a seguenti:

Per prima cosa dobbiamo impostare una configurazione di codifica contenente parametri di compressione. Tieni presente che è possibile usare la stessa configurazione per comprimere successivamente più immagini diverse.

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

Quindi, è necessario fare riferimento agli esempi di input in un WebPPicture per riferimento o per copia. Ecco un esempio di allocazione del buffer per la conservazione dei campioni. Ma è possibile impostare facilmente una "visualizzazione" a un modello già allocato un array di esempio. Vedi la funzione 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.

Per emettere i byte compressi, viene chiamato un hook ogni volta che vengono disponibili. Ecco un semplice esempio con il valore "memory-writer" dichiarato in webp/encode.h. È probabile che questa inizializzazione sia necessaria ciascuna immagine da comprimere:

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

Ora siamo pronti per comprimere i campioni di input (e liberare la relativa memoria in seguito):

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

Per un uso più avanzato dell'API e della struttura, ti consigliamo di consultare alla documentazione disponibile nell'intestazione webp/encode.h. La lettura del codice di esempio examples/cwebp.c può essere utile per scoprire i parametri meno usati.