dany/libwebp
1
0
Fork 0
mirror of https://github.com/webmproject/libwebp.git synced 2025-02-13 15:32:53 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

WebPDemuxGetI: add doc details around WebPFormatFeature

Browse Source 
Change-Id: Id5f17686a8dbd6a6a0ba354d9216a8b89a51597c
This commit is contained in:
Pascal Massimino 2017-10-17 19:25:53 +02:00
parent 0a17f4712c
commit 30042faa9a
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/webp/demux.h
View File

@ -115,20 +115,25 @@ WEBP_EXTERN void WebPDemuxDelete(WebPDemuxer* dmux);
// Data/information extraction. // Data/information extraction.
typedef enum WebPFormatFeature { typedef enum WebPFormatFeature {
WEBP_FF_FORMAT_FLAGS, // Extended format flags present in the 'VP8X' chunk. WEBP_FF_FORMAT_FLAGS, // bit-wise combination of WebPFeatureFlags
// corresponding to the 'VP8X' chunk (if present).
WEBP_FF_CANVAS_WIDTH, WEBP_FF_CANVAS_WIDTH,
WEBP_FF_CANVAS_HEIGHT, WEBP_FF_CANVAS_HEIGHT,
WEBP_FF_LOOP_COUNT, WEBP_FF_LOOP_COUNT, // only relevant for animated file
WEBP_FF_BACKGROUND_COLOR, WEBP_FF_BACKGROUND_COLOR, // idem.
WEBP_FF_FRAME_COUNT // Number of frames present in the demux object. WEBP_FF_FRAME_COUNT // Number of frames present in the demux object.
// In case of a partial demux, this is the number of // In case of a partial demux, this is the number
// frames seen so far, with the last frame possibly // of frames seen so far, with the last frame
// being partial. // possibly being partial.
} WebPFormatFeature; } WebPFormatFeature;
// Get the 'feature' value from the 'dmux'. // Get the 'feature' value from the 'dmux'.
// NOTE: values are only valid if WebPDemux() was used or WebPDemuxPartial() // NOTE: values are only valid if WebPDemux() was used or WebPDemuxPartial()
// returned a state > WEBP_DEMUX_PARSING_HEADER. // returned a state > WEBP_DEMUX_PARSING_HEADER.
// If 'feature' is WEBP_FF_FORMAT_FLAGS, the returned value is a bit-wise
// combination of WebPFeatureFlags values.
// If 'feature' is WEBP_FF_LOOP_COUNT, WEBP_FF_BACKGROUND_COLOR, the returned
// value is only meaningful if the bitstream is animated.
WEBP_EXTERN uint32_t WebPDemuxGetI( WEBP_EXTERN uint32_t WebPDemuxGetI(
const WebPDemuxer* dmux, WebPFormatFeature feature); const WebPDemuxer* dmux, WebPFormatFeature feature);