FFmpeg  4.3
webpenc.c
Go to the documentation of this file.
1 /*
2  * webp muxer
3  * Copyright (c) 2014 Michael Niedermayer
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 #include "libavutil/intreadwrite.h"
23 #include "libavutil/opt.h"
24 #include "avformat.h"
25 #include "internal.h"
26 
27 typedef struct WebpContext{
28  AVClass *class;
31  int loop;
34 } WebpContext;
35 
37 {
38  AVStream *st;
39 
40  if (s->nb_streams != 1) {
41  av_log(s, AV_LOG_ERROR, "Only exactly 1 stream is supported\n");
42  return AVERROR(EINVAL);
43  }
44  st = s->streams[0];
45  if (st->codecpar->codec_id != AV_CODEC_ID_WEBP) {
46  av_log(s, AV_LOG_ERROR, "Only WebP is supported\n");
47  return AVERROR(EINVAL);
48  }
49  avpriv_set_pts_info(st, 24, 1, 1000);
50 
51  return 0;
52 }
53 
55 {
56  if (pkt->size) {
57  int skip = 0;
58  unsigned flags = 0;
59 
60  if (pkt->size < 4)
61  return 0;
62  if (AV_RL32(pkt->data) == AV_RL32("RIFF"))
63  skip = 12;
64 
65  if (pkt->size < skip + 4)
66  return 0;
67  if (AV_RL32(pkt->data + skip) == AV_RL32("VP8X")) {
68  flags |= pkt->data[skip + 4 + 4];
69  }
70 
71  if (flags & 2) // ANIMATION_FLAG is on
72  return 1;
73  }
74  return 0;
75 }
76 
77 static int flush(AVFormatContext *s, int trailer, int64_t pts)
78 {
79  WebpContext *w = s->priv_data;
80  AVStream *st = s->streams[0];
81 
82  if (w->last_pkt.size) {
83  int skip = 0;
84  unsigned flags = 0;
85  int vp8x = 0;
86 
87  if (w->last_pkt.size < 4)
88  return 0;
89  if (AV_RL32(w->last_pkt.data) == AV_RL32("RIFF"))
90  skip = 12;
91 
92  if (w->last_pkt.size < skip + 4)
93  return 0; // Safe to do this as a valid WebP bitstream is >=30 bytes.
94  if (AV_RL32(w->last_pkt.data + skip) == AV_RL32("VP8X")) {
95  flags |= w->last_pkt.data[skip + 4 + 4];
96  vp8x = 1;
97  skip += AV_RL32(w->last_pkt.data + skip + 4) + 8;
98  }
99 
100  if (!w->wrote_webp_header) {
101  avio_write(s->pb, "RIFF\0\0\0\0WEBP", 12);
102  w->wrote_webp_header = 1;
103  if (w->frame_count > 1) // first non-empty packet
104  w->frame_count = 1; // so we don't count previous empty packets.
105  }
106 
107  if (w->frame_count == 1) {
108  if (!trailer) {
109  vp8x = 1;
110  flags |= 2 + 16;
111  }
112 
113  if (vp8x) {
114  avio_write(s->pb, "VP8X", 4);
115  avio_wl32(s->pb, 10);
116  avio_w8(s->pb, flags);
117  avio_wl24(s->pb, 0);
118  avio_wl24(s->pb, st->codecpar->width - 1);
119  avio_wl24(s->pb, st->codecpar->height - 1);
120  }
121  if (!trailer) {
122  avio_write(s->pb, "ANIM", 4);
123  avio_wl32(s->pb, 6);
124  avio_wl32(s->pb, 0xFFFFFFFF);
125  avio_wl16(s->pb, w->loop);
126  }
127  }
128 
129  if (w->frame_count > trailer) {
130  avio_write(s->pb, "ANMF", 4);
131  avio_wl32(s->pb, 16 + w->last_pkt.size - skip);
132  avio_wl24(s->pb, 0);
133  avio_wl24(s->pb, 0);
134  avio_wl24(s->pb, st->codecpar->width - 1);
135  avio_wl24(s->pb, st->codecpar->height - 1);
136  if (w->last_pkt.pts != AV_NOPTS_VALUE && pts != AV_NOPTS_VALUE) {
137  avio_wl24(s->pb, pts - w->last_pkt.pts);
138  } else
139  avio_wl24(s->pb, w->last_pkt.duration);
140  avio_w8(s->pb, 0);
141  }
142  avio_write(s->pb, w->last_pkt.data + skip, w->last_pkt.size - skip);
143  av_packet_unref(&w->last_pkt);
144  }
145 
146  return 0;
147 }
148 
150 {
151  WebpContext *w = s->priv_data;
152  w->using_webp_anim_encoder |= is_animated_webp_packet(pkt);
153 
154  if (w->using_webp_anim_encoder) {
155  avio_write(s->pb, pkt->data, pkt->size);
156  w->wrote_webp_header = 1; // for good measure
157  } else {
158  int ret;
159  if ((ret = flush(s, 0, pkt->pts)) < 0)
160  return ret;
161  av_packet_ref(&w->last_pkt, pkt);
162  }
163  ++w->frame_count;
164 
165  return 0;
166 }
167 
169 {
170  unsigned filesize;
171  WebpContext *w = s->priv_data;
172 
173  if (w->using_webp_anim_encoder) {
174  if ((w->frame_count > 1) && w->loop) { // Write loop count.
175  avio_seek(s->pb, 42, SEEK_SET);
176  avio_wl16(s->pb, w->loop);
177  }
178  } else {
179  int ret;
180  if ((ret = flush(s, 1, AV_NOPTS_VALUE)) < 0)
181  return ret;
182 
183  filesize = avio_tell(s->pb);
184  avio_seek(s->pb, 4, SEEK_SET);
185  avio_wl32(s->pb, filesize - 8);
186  // Note: without the following, avio only writes 8 bytes to the file.
187  avio_seek(s->pb, filesize, SEEK_SET);
188  }
189 
190  return 0;
191 }
192 
193 #define OFFSET(x) offsetof(WebpContext, x)
194 #define ENC AV_OPT_FLAG_ENCODING_PARAM
195 static const AVOption options[] = {
196  { "loop", "Number of times to loop the output: 0 - infinite loop", OFFSET(loop),
197  AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 65535, ENC },
198  { NULL },
199 };
200 
201 static const AVClass webp_muxer_class = {
202  .class_name = "WebP muxer",
203  .item_name = av_default_item_name,
204  .version = LIBAVUTIL_VERSION_INT,
205  .option = options,
206 };
208  .name = "webp",
209  .long_name = NULL_IF_CONFIG_SMALL("WebP"),
210  .extensions = "webp",
211  .priv_data_size = sizeof(WebpContext),
212  .video_codec = AV_CODEC_ID_WEBP,
216  .priv_class = &webp_muxer_class,
218 };
ENC
#define ENC
Definition: webpenc.c:194
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:605
AVOutputFormat::name
const char * name
Definition: avformat.h:491
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
opt.h
WebpContext::using_webp_anim_encoder
int using_webp_anim_encoder
Definition: webpenc.c:33
AVFMT_VARIABLE_FPS
#define AVFMT_VARIABLE_FPS
Format allows variable fps.
Definition: avformat.h:465
WebpContext::frame_count
int frame_count
Definition: webpenc.c:29
WebpContext::wrote_webp_header
int wrote_webp_header
Definition: webpenc.c:32
AVPacket::data
uint8_t * data
Definition: packet.h:355
AVOption
AVOption.
Definition: opt.h:246
avio_wl16
void avio_wl16(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:447
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:557
pts
static int64_t pts
Definition: transcode_aac.c:647
loop
static int loop
Definition: ffplay.c:341
options
static const AVOption options[]
Definition: webpenc.c:195
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
AVCodecParameters::width
int width
Video only.
Definition: codec_par.h:126
AVFormatContext
Format I/O context.
Definition: avformat.h:1335
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1012
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:67
NULL
#define NULL
Definition: coverity.c:32
write_trailer
static int write_trailer(AVFormatContext *s1)
Definition: v4l2enc.c:98
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:235
avio_w8
void avio_w8(AVIOContext *s, int b)
Definition: aviobuf.c:191
av_packet_ref
int av_packet_ref(AVPacket *dst, const AVPacket *src)
Setup a new reference to the data described by a given packet.
Definition: avpacket.c:614
AVPacket::size
int size
Definition: packet.h:356
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:186
avpriv_set_pts_info
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4938
is_animated_webp_packet
static int is_animated_webp_packet(AVPacket *pkt)
Definition: webpenc.c:54
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
webp_write_header
static int webp_write_header(AVFormatContext *s)
Definition: webpenc.c:36
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:213
avio_wl32
void avio_wl32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:367
webp_muxer_class
static const AVClass webp_muxer_class
Definition: webpenc.c:201
write_packet
static void write_packet(OutputFile *of, AVPacket *pkt, OutputStream *ost, int unqueue)
Definition: ffmpeg.c:701
AVOutputFormat
Definition: avformat.h:490
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:348
AVCodecParameters::height
int height
Definition: codec_par.h:127
flush
static int flush(AVFormatContext *s, int trailer, int64_t pts)
Definition: webpenc.c:77
webp_write_packet
static int webp_write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: webpenc.c:149
WebpContext::loop
int loop
Definition: webpenc.c:31
AV_CODEC_ID_WEBP
@ AV_CODEC_ID_WEBP
Definition: codec_id.h:221
ff_webp_muxer
AVOutputFormat ff_webp_muxer
Definition: webpenc.c:207
WebpContext::last_pkt
AVPacket last_pkt
Definition: webpenc.c:30
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:865
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:241
AVClass::class_name
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:72
w
FFmpeg Automated Testing Environment ************************************Introduction Using FATE from your FFmpeg source directory Submitting the results to the FFmpeg result aggregation server Uploading new samples to the fate suite FATE makefile targets and variables Makefile targets Makefile variables Examples Introduction **************FATE is an extended regression suite on the client side and a means for results aggregation and presentation on the server side The first part of this document explains how you can use FATE from your FFmpeg source directory to test your ffmpeg binary The second part describes how you can run FATE to submit the results to FFmpeg’s FATE server In any way you can have a look at the publicly viewable FATE results by visiting this as it can be seen if some test on some platform broke with their recent contribution This usually happens on the platforms the developers could not test on The second part of this document describes how you can run FATE to submit your results to FFmpeg’s FATE server If you want to submit your results be sure to check that your combination of OS and compiler is not already listed on the above mentioned website In the third part you can find a comprehensive listing of FATE makefile targets and variables Using FATE from your FFmpeg source directory **********************************************If you want to run FATE on your machine you need to have the samples in place You can get the samples via the build target fate rsync Use this command from the top level source this will cause FATE to fail NOTE To use a custom wrapper to run the pass ‘ target exec’ to ‘configure’ or set the TARGET_EXEC Make variable Submitting the results to the FFmpeg result aggregation server ****************************************************************To submit your results to the server you should run fate through the shell script ‘tests fate sh’ from the FFmpeg sources This script needs to be invoked with a configuration file as its first argument tests fate sh path to fate_config A configuration file template with comments describing the individual configuration variables can be found at ‘doc fate_config sh template’ Create a configuration that suits your based on the configuration template The ‘slot’ configuration variable can be any string that is not yet but it is suggested that you name it adhering to the following pattern ‘ARCH OS COMPILER COMPILER VERSION’ The configuration file itself will be sourced in a shell therefore all shell features may be used This enables you to setup the environment as you need it for your build For your first test runs the ‘fate_recv’ variable should be empty or commented out This will run everything as normal except that it will omit the submission of the results to the server The following files should be present in $workdir as specified in the configuration it may help to try out the ‘ssh’ command with one or more ‘ v’ options You should get detailed output concerning your SSH configuration and the authentication process The only thing left is to automate the execution of the fate sh script and the synchronisation of the samples directory Uploading new samples to the fate suite *****************************************If you need a sample uploaded send a mail to samples request This is for developers who have an account on the fate suite server If you upload new please make sure they are as small as space on each network bandwidth and so on benefit from smaller test cases Also keep in mind older checkouts use existing sample that means in practice generally do not remove or overwrite files as it likely would break older checkouts or releases Also all needed samples for a commit should be ideally before the push If you need an account for frequently uploading samples or you wish to help others by doing that send a mail to ffmpeg devel rsync vauL Duo ug o o w
Definition: fate.txt:150
avformat.h
pkt
static AVPacket pkt
Definition: demuxing_decoding.c:54
AV_RL32
#define AV_RL32
Definition: intreadwrite.h:146
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:223
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
AVPacket
This structure stores compressed data.
Definition: packet.h:332
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:564
WebpContext
Definition: webpenc.c:27
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
avio_wl24
void avio_wl24(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:459
write_header
static void write_header(FFV1Context *f)
Definition: ffv1enc.c:346
OFFSET
#define OFFSET(x)
Definition: webpenc.c:193
webp_write_trailer
static int webp_write_trailer(AVFormatContext *s)
Definition: webpenc.c:168