Libav
libwebpenc.c
Go to the documentation of this file.
1 /*
2  * WebP encoding support via libwebp
3  * Copyright (c) 2013 Justin Ruggles <justin.ruggles@gmail.com>
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
27 #include <webp/encode.h>
28 
29 #include "libavutil/common.h"
30 #include "libavutil/frame.h"
31 #include "libavutil/imgutils.h"
32 #include "libavutil/opt.h"
33 #include "avcodec.h"
34 #include "internal.h"
35 
36 typedef struct LibWebPContext {
37  AVClass *class; // class for AVOptions
38  float quality; // lossy quality 0 - 100
39  int lossless; // use lossless encoding
40  int preset; // configuration preset
41  int chroma_warning; // chroma linesize mismatch warning has been printed
42  int conversion_warning; // pixel format conversion warning has been printed
43  WebPConfig config; // libwebp configuration
45 
46 static int libwebp_error_to_averror(int err)
47 {
48  switch (err) {
49  case VP8_ENC_ERROR_OUT_OF_MEMORY:
50  case VP8_ENC_ERROR_BITSTREAM_OUT_OF_MEMORY:
51  return AVERROR(ENOMEM);
52  case VP8_ENC_ERROR_NULL_PARAMETER:
53  case VP8_ENC_ERROR_INVALID_CONFIGURATION:
54  case VP8_ENC_ERROR_BAD_DIMENSION:
55  return AVERROR(EINVAL);
56  }
57  return AVERROR_UNKNOWN;
58 }
59 
61 {
62  LibWebPContext *s = avctx->priv_data;
63  int ret;
64 
65  if (avctx->global_quality < 0)
66  avctx->global_quality = 75 * FF_QP2LAMBDA;
67  s->quality = av_clipf(avctx->global_quality / (float)FF_QP2LAMBDA,
68  0.0f, 100.0f);
69 
70  if (avctx->compression_level < 0 || avctx->compression_level > 6) {
71  av_log(avctx, AV_LOG_WARNING, "invalid compression level: %d\n",
72  avctx->compression_level);
73  avctx->compression_level = av_clip(avctx->compression_level, 0, 6);
74  }
75 
76  if (s->preset >= WEBP_PRESET_DEFAULT) {
77  ret = WebPConfigPreset(&s->config, s->preset, s->quality);
78  if (!ret)
79  return AVERROR_UNKNOWN;
80  s->lossless = s->config.lossless;
81  s->quality = s->config.quality;
82  avctx->compression_level = s->config.method;
83  } else {
84  ret = WebPConfigInit(&s->config);
85  if (!ret)
86  return AVERROR_UNKNOWN;
87 
88  s->config.lossless = s->lossless;
89  s->config.quality = s->quality;
90  s->config.method = avctx->compression_level;
91 
92  ret = WebPValidateConfig(&s->config);
93  if (!ret)
94  return AVERROR(EINVAL);
95  }
96 
97  av_log(avctx, AV_LOG_DEBUG, "%s - quality=%.1f method=%d\n",
98  s->lossless ? "Lossless" : "Lossy", s->quality,
99  avctx->compression_level);
100 
101  return 0;
102 }
103 
105  const AVFrame *frame, int *got_packet)
106 {
107  LibWebPContext *s = avctx->priv_data;
108  AVFrame *alt_frame = NULL;
109  WebPPicture *pic = NULL;
110  WebPMemoryWriter mw = { 0 };
111  int ret;
112 
113  if (avctx->width > WEBP_MAX_DIMENSION || avctx->height > WEBP_MAX_DIMENSION) {
114  av_log(avctx, AV_LOG_ERROR, "Picture size is too large. Max is %dx%d.\n",
115  WEBP_MAX_DIMENSION, WEBP_MAX_DIMENSION);
116  return AVERROR(EINVAL);
117  }
118 
119  pic = av_malloc(sizeof(*pic));
120  if (!pic)
121  return AVERROR(ENOMEM);
122 
123  ret = WebPPictureInit(pic);
124  if (!ret) {
125  ret = AVERROR_UNKNOWN;
126  goto end;
127  }
128  pic->width = avctx->width;
129  pic->height = avctx->height;
130 
131  if (avctx->pix_fmt == AV_PIX_FMT_RGB32) {
132  if (!s->lossless) {
133  /* libwebp will automatically convert RGB input to YUV when
134  encoding lossy. */
135  if (!s->conversion_warning) {
136  av_log(avctx, AV_LOG_WARNING,
137  "Using libwebp for RGB-to-YUV conversion. You may want "
138  "to consider passing in YUV instead for lossy "
139  "encoding.\n");
140  s->conversion_warning = 1;
141  }
142  }
143  pic->use_argb = 1;
144  pic->argb = (uint32_t *)frame->data[0];
145  pic->argb_stride = frame->linesize[0] / 4;
146  } else {
147  if (frame->linesize[1] != frame->linesize[2]) {
148  if (!s->chroma_warning) {
149  av_log(avctx, AV_LOG_WARNING,
150  "Copying frame due to differing chroma linesizes.\n");
151  s->chroma_warning = 1;
152  }
153  alt_frame = av_frame_alloc();
154  if (!alt_frame) {
155  ret = AVERROR(ENOMEM);
156  goto end;
157  }
158  alt_frame->width = frame->width;
159  alt_frame->height = frame->height;
160  alt_frame->format = frame->format;
161  ret = av_frame_get_buffer(alt_frame, 32);
162  if (ret < 0)
163  goto end;
164  av_frame_copy(alt_frame, frame);
165  frame = alt_frame;
166  }
167  pic->use_argb = 0;
168  pic->y = frame->data[0];
169  pic->u = frame->data[1];
170  pic->v = frame->data[2];
171  pic->y_stride = frame->linesize[0];
172  pic->uv_stride = frame->linesize[1];
173  if (avctx->pix_fmt == AV_PIX_FMT_YUVA420P) {
174  pic->colorspace = WEBP_YUV420A;
175  pic->a = frame->data[3];
176  pic->a_stride = frame->linesize[3];
177  } else {
178  pic->colorspace = WEBP_YUV420;
179  }
180 
181  if (s->lossless) {
182  /* We do not have a way to automatically prioritize RGB over YUV
183  in automatic pixel format conversion based on whether we're
184  encoding lossless or lossy, so we do conversion with libwebp as
185  a convenience. */
186  if (!s->conversion_warning) {
187  av_log(avctx, AV_LOG_WARNING,
188  "Using libwebp for YUV-to-RGB conversion. You may want "
189  "to consider passing in RGB instead for lossless "
190  "encoding.\n");
191  s->conversion_warning = 1;
192  }
193 
194 #if (WEBP_ENCODER_ABI_VERSION <= 0x201)
195  /* libwebp should do the conversion automatically, but there is a
196  bug that causes it to return an error instead, so a work-around
197  is required.
198  See https://code.google.com/p/webp/issues/detail?id=178 */
199  pic->memory_ = (void*)1; /* something non-null */
200  ret = WebPPictureYUVAToARGB(pic);
201  if (!ret) {
202  av_log(avctx, AV_LOG_ERROR,
203  "WebPPictureYUVAToARGB() failed with error: %d\n",
204  pic->error_code);
205  ret = libwebp_error_to_averror(pic->error_code);
206  goto end;
207  }
208  pic->memory_ = NULL; /* restore pointer */
209 #endif
210  }
211  }
212 
213  WebPMemoryWriterInit(&mw);
214  pic->custom_ptr = &mw;
215  pic->writer = WebPMemoryWrite;
216 
217  ret = WebPEncode(&s->config, pic);
218  if (!ret) {
219  av_log(avctx, AV_LOG_ERROR, "WebPEncode() failed with error: %d\n",
220  pic->error_code);
221  ret = libwebp_error_to_averror(pic->error_code);
222  goto end;
223  }
224 
225  ret = ff_alloc_packet(pkt, mw.size);
226  if (ret < 0)
227  goto end;
228  memcpy(pkt->data, mw.mem, mw.size);
229 
230  pkt->flags |= AV_PKT_FLAG_KEY;
231  *got_packet = 1;
232 
233 end:
234  free(mw.mem); /* must use free() according to libwebp documentation */
235  WebPPictureFree(pic);
236  av_freep(&pic);
237  av_frame_free(&alt_frame);
238 
239  return ret;
240 }
241 
242 #define OFFSET(x) offsetof(LibWebPContext, x)
243 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
244 static const AVOption options[] = {
245  { "lossless", "Use lossless mode", OFFSET(lossless), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
246  { "preset", "Configuration preset", OFFSET(preset), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, WEBP_PRESET_TEXT, VE, "preset" },
247  { "none", "do not use a preset", 0, AV_OPT_TYPE_CONST, { .i64 = -1 }, 0, 0, VE, "preset" },
248  { "default", "default preset", 0, AV_OPT_TYPE_CONST, { .i64 = WEBP_PRESET_DEFAULT }, 0, 0, VE, "preset" },
249  { "picture", "digital picture, like portrait, inner shot", 0, AV_OPT_TYPE_CONST, { .i64 = WEBP_PRESET_PICTURE }, 0, 0, VE, "preset" },
250  { "photo", "outdoor photograph, with natural lighting", 0, AV_OPT_TYPE_CONST, { .i64 = WEBP_PRESET_PHOTO }, 0, 0, VE, "preset" },
251  { "drawing", "hand or line drawing, with high-contrast details", 0, AV_OPT_TYPE_CONST, { .i64 = WEBP_PRESET_DRAWING }, 0, 0, VE, "preset" },
252  { "icon", "small-sized colorful images", 0, AV_OPT_TYPE_CONST, { .i64 = WEBP_PRESET_ICON }, 0, 0, VE, "preset" },
253  { "text", "text-like", 0, AV_OPT_TYPE_CONST, { .i64 = WEBP_PRESET_TEXT }, 0, 0, VE, "preset" },
254  { NULL },
255 };
256 
257 static const AVClass class = {
258  .class_name = "libwebp",
259  .item_name = av_default_item_name,
260  .option = options,
262 };
263 
265  { "compression_level", "4" },
266  { "global_quality", "-1" },
267  { NULL },
268 };
269 
271  .name = "libwebp",
272  .long_name = NULL_IF_CONFIG_SMALL("libwebp WebP image"),
273  .type = AVMEDIA_TYPE_VIDEO,
274  .id = AV_CODEC_ID_WEBP,
275  .priv_data_size = sizeof(LibWebPContext),
277  .encode2 = libwebp_encode_frame,
278  .pix_fmts = (const enum AVPixelFormat[]) {
282  },
283  .priv_class = &class,
284  .defaults = libwebp_defaults,
285 };
void * av_malloc(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:62
This structure describes decoded (raw) audio or video data.
Definition: frame.h:135
AVOption.
Definition: opt.h:234
misc image utilities
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:129
static int libwebp_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
Definition: libwebpenc.c:104
int size
Definition: avcodec.h:974
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1270
#define OFFSET(x)
Definition: libwebpenc.c:242
AVCodec.
Definition: avcodec.h:2812
#define VE
Definition: libwebpenc.c:243
void av_freep(void *arg)
Free a memory block which has been allocated with av_malloc(z)() or av_realloc() and set the pointer ...
Definition: mem.c:198
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:38
planar YUV 4:2:0, 20bpp, (1 Cr & Cb sample per 2x2 Y & A samples)
Definition: pixfmt.h:104
#define av_cold
Definition: attributes.h:66
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:57
AVOptions.
uint8_t * data
Definition: avcodec.h:973
static const AVCodecDefault libwebp_defaults[]
Definition: libwebpenc.c:264
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1019
int width
width and height of the video frame
Definition: frame.h:174
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:123
#define AVERROR(e)
Definition: error.h:43
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:69
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:145
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:144
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:169
const char * name
Name of the codec implementation.
Definition: avcodec.h:2819
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:532
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:979
reference-counted frame API
int chroma_warning
Definition: libwebpenc.c:41
int width
picture width / height.
Definition: avcodec.h:1229
int ff_alloc_packet(AVPacket *avpkt, int size)
Check AVPacket size and/or allocate data.
Definition: utils.c:1266
static av_cold int libwebp_encode_init(AVCodecContext *avctx)
Definition: libwebpenc.c:60
LIBAVUTIL_VERSION_INT
Definition: eval.c:55
WebPConfig config
Definition: libwebpenc.c:43
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames...
Definition: frame.h:186
NULL
Definition: eval.c:55
Libavcodec external API header.
int compression_level
Definition: avcodec.h:1136
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:153
static const AVOption options[]
Definition: libwebpenc.c:244
av_default_item_name
Definition: dnxhdenc.c:52
main external API structure.
Definition: avcodec.h:1050
#define AV_PIX_FMT_RGB32
Definition: pixfmt.h:222
Describe the class of an AVClass context structure.
Definition: log.h:33
int av_frame_get_buffer(AVFrame *frame, int align)
Allocate new buffer(s) for audio or video data.
Definition: frame.c:175
int global_quality
Global quality for codecs which cannot change it per frame.
Definition: avcodec.h:1130
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:141
static int libwebp_error_to_averror(int err)
Definition: libwebpenc.c:46
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:65
common internal api header.
common internal and external API header
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:61
static av_cold int init(AVCodecParserContext *s)
Definition: h264_parser.c:499
void * priv_data
Definition: avcodec.h:1092
#define FF_QP2LAMBDA
factor to convert from H.263 QP to lambda
Definition: avutil.h:207
int height
Definition: frame.h:174
int conversion_warning
Definition: libwebpenc.c:42
AVPixelFormat
Pixel format.
Definition: pixfmt.h:63
This structure stores compressed data.
Definition: avcodec.h:950
AVCodec ff_libwebp_encoder
Definition: libwebpenc.c:270