FFmpeg
libwebpenc_animencoder.c
Go to the documentation of this file.
1 /*
2  * WebP encoding support via libwebp
3  * Copyright (c) 2015 Urvang Joshi
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 /**
23  * @file
24  * WebP encoder using libwebp (WebPAnimEncoder API)
25  */
26 
27 #include "config.h"
28 #include "codec_internal.h"
29 #include "encode.h"
30 #include "libwebpenc_common.h"
31 
32 #include <webp/mux.h>
33 
34 typedef struct LibWebPAnimContext {
36  WebPAnimEncoder *enc; // the main AnimEncoder object
37  int64_t first_frame_pts; // pts of the first encoded frame.
38  int done; // If true, we have assembled the bitstream already
40 
42 {
44  if (!ret) {
45  LibWebPAnimContext *s = avctx->priv_data;
46  WebPAnimEncoderOptions enc_options = { { 0 } };
47  WebPAnimEncoderOptionsInit(&enc_options);
48  enc_options.verbose = av_log_get_level() >= AV_LOG_VERBOSE;
49  // TODO(urvang): Expose some options on command-line perhaps.
50  s->enc = WebPAnimEncoderNew(avctx->width, avctx->height, &enc_options);
51  if (!s->enc)
52  return AVERROR(EINVAL);
53  s->first_frame_pts = AV_NOPTS_VALUE;
54  s->done = 0;
55  }
56  return ret;
57 }
58 
60  const AVFrame *frame, int *got_packet) {
61  LibWebPAnimContext *s = avctx->priv_data;
62  int ret;
63 
64  if (!frame) {
65  if (s->done) { // Second flush: return empty package to denote finish.
66  *got_packet = 0;
67  return 0;
68  } else { // First flush: assemble bitstream and return it.
69  WebPData assembled_data = { 0 };
70  ret = WebPAnimEncoderAssemble(s->enc, &assembled_data);
71  if (ret) {
72  ret = ff_get_encode_buffer(avctx, pkt, assembled_data.size, 0);
73  if (ret < 0) {
74  WebPDataClear(&assembled_data);
75  return ret;
76  }
77  memcpy(pkt->data, assembled_data.bytes, assembled_data.size);
78  WebPDataClear(&assembled_data);
79  s->done = 1;
80  pkt->pts = pkt->dts = s->first_frame_pts;
81  *got_packet = 1;
82  return 0;
83  } else {
84  WebPDataClear(&assembled_data);
86  "WebPAnimEncoderAssemble() failed with error: %d\n",
87  VP8_ENC_ERROR_OUT_OF_MEMORY);
88  return AVERROR(ENOMEM);
89  }
90  }
91  } else {
92  int timestamp_ms;
93  WebPPicture *pic = NULL;
94  AVFrame *alt_frame = NULL;
95  ret = ff_libwebp_get_frame(avctx, &s->cc, frame, &alt_frame, &pic);
96  if (ret < 0)
97  goto end;
98 
99  timestamp_ms =
100  avctx->time_base.num * frame->pts * 1000 / avctx->time_base.den;
101  ret = WebPAnimEncoderAdd(s->enc, pic, timestamp_ms, &s->cc.config);
102  if (!ret) {
103  av_log(avctx, AV_LOG_ERROR,
104  "Encoding WebP frame failed with error: %d\n",
105  pic->error_code);
106  ret = ff_libwebp_error_to_averror(pic->error_code);
107  goto end;
108  }
109 
110  if (!avctx->frame_number)
111  s->first_frame_pts = frame->pts;
112  ret = 0;
113  *got_packet = 0;
114 
115 end:
116  WebPPictureFree(pic);
117  av_freep(&pic);
118  av_frame_free(&alt_frame);
119  return ret;
120  }
121 }
122 
124 {
125  LibWebPAnimContext *s = avctx->priv_data;
126  av_frame_free(&s->cc.ref);
127  WebPAnimEncoderDelete(s->enc);
128 
129  return 0;
130 }
131 
133  .p.name = "libwebp_anim",
134  CODEC_LONG_NAME("libwebp WebP image"),
135  .p.type = AVMEDIA_TYPE_VIDEO,
136  .p.id = AV_CODEC_ID_WEBP,
137  .p.capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_DELAY,
138  .p.pix_fmts = ff_libwebpenc_pix_fmts,
139  .p.priv_class = &ff_libwebpenc_class,
140  .p.wrapper_name = "libwebp",
141  .caps_internal = FF_CODEC_CAP_NOT_INIT_THREADSAFE,
142  .priv_data_size = sizeof(LibWebPAnimContext),
146  .close = libwebp_anim_encode_close,
147 };
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
ff_libwebp_error_to_averror
int ff_libwebp_error_to_averror(int err)
Definition: libwebpenc_common.c:67
ff_libwebp_anim_encoder
const FFCodec ff_libwebp_anim_encoder
Definition: libwebpenc_animencoder.c:132
ff_libwebp_encode_init_common
av_cold int ff_libwebp_encode_init_common(AVCodecContext *avctx)
Definition: libwebpenc_common.c:81
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:116
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
AVPacket::data
uint8_t * data
Definition: packet.h:374
encode.h
FF_CODEC_CAP_NOT_INIT_THREADSAFE
#define FF_CODEC_CAP_NOT_INIT_THREADSAFE
The codec is not known to be init-threadsafe (i.e.
Definition: codec_internal.h:34
FFCodec
Definition: codec_internal.h:119
AV_LOG_VERBOSE
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:196
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:123
LibWebPAnimContext::done
int done
Definition: libwebpenc_animencoder.c:38
libwebp_anim_encode_init
static av_cold int libwebp_anim_encode_init(AVCodecContext *avctx)
Definition: libwebpenc_animencoder.c:41
FF_CODEC_ENCODE_CB
#define FF_CODEC_ENCODE_CB(func)
Definition: codec_internal.h:307
AVRational::num
int num
Numerator.
Definition: rational.h:59
pkt
AVPacket * pkt
Definition: movenc.c:59
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
s
#define s(width, name)
Definition: cbs_vp9.c:256
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts_bsf.c:363
libwebp_anim_encode_close
static int libwebp_anim_encode_close(AVCodecContext *avctx)
Definition: libwebpenc_animencoder.c:123
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:264
av_log_get_level
int av_log_get_level(void)
Get the current log level.
Definition: log.c:437
NULL
#define NULL
Definition: coverity.c:32
ff_libwebp_defaults
const FFCodecDefault ff_libwebp_defaults[]
Definition: libwebpenc_common.c:30
LibWebPAnimContext
Definition: libwebpenc_animencoder.c:34
AVCodecContext::time_base
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avcodec.h:521
AV_CODEC_CAP_DR1
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() or get_encode_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:52
AVPacket::size
int size
Definition: packet.h:375
defaults
static const FFCodecDefault defaults[]
Definition: amfenc_h264.c:362
codec_internal.h
LibWebPAnimContext::enc
WebPAnimEncoder * enc
Definition: libwebpenc_animencoder.c:36
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
AVPacket::dts
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed.
Definition: packet.h:373
LibWebPContextCommon
Definition: libwebpenc_common.h:39
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:367
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:211
AV_CODEC_ID_WEBP
@ AV_CODEC_ID_WEBP
Definition: codec_id.h:224
AVCodecContext::height
int height
Definition: avcodec.h:571
ret
ret
Definition: filter_design.txt:187
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
AVCodecContext
main external API structure.
Definition: avcodec.h:398
ff_get_encode_buffer
int ff_get_encode_buffer(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int flags)
Get a buffer for a packet.
Definition: encode.c:79
AVRational::den
int den
Denominator.
Definition: rational.h:60
ff_libwebp_get_frame
int ff_libwebp_get_frame(AVCodecContext *avctx, LibWebPContextCommon *s, const AVFrame *frame, AVFrame **alt_frame_ptr, WebPPicture **pic_ptr)
Definition: libwebpenc_common.c:124
AV_CODEC_CAP_DELAY
#define AV_CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
Definition: codec.h:82
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVCodecContext::frame_number
int frame_number
Frame counter, set by libavcodec.
Definition: avcodec.h:1046
AVPacket
This structure stores compressed data.
Definition: packet.h:351
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:425
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
ff_libwebpenc_pix_fmts
enum AVPixelFormat ff_libwebpenc_pix_fmts[]
Definition: libwebpenc_common.c:61
libwebpenc_common.h
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:571
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
LibWebPAnimContext::cc
LibWebPContextCommon cc
Definition: libwebpenc_animencoder.c:35
LibWebPAnimContext::first_frame_pts
int64_t first_frame_pts
Definition: libwebpenc_animencoder.c:37
libwebp_anim_encode_frame
static int libwebp_anim_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
Definition: libwebpenc_animencoder.c:59
ff_libwebpenc_class
const AVClass ff_libwebpenc_class
Definition: libwebpenc_common.c:54