| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | /* | ||
| 2 | * APNG muxer | ||
| 3 | * Copyright (c) 2015 Donny Yang | ||
| 4 | * | ||
| 5 | * first version by Donny Yang <work@kota.moe> | ||
| 6 | * | ||
| 7 | * This file is part of FFmpeg. | ||
| 8 | * | ||
| 9 | * FFmpeg is free software; you can redistribute it and/or | ||
| 10 | * modify it under the terms of the GNU Lesser General Public | ||
| 11 | * License as published by the Free Software Foundation; either | ||
| 12 | * version 2.1 of the License, or (at your option) any later version. | ||
| 13 | * | ||
| 14 | * FFmpeg is distributed in the hope that it will be useful, | ||
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| 17 | * Lesser General Public License for more details. | ||
| 18 | * | ||
| 19 | * You should have received a copy of the GNU Lesser General Public | ||
| 20 | * License along with FFmpeg; if not, write to the Free Software | ||
| 21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | ||
| 22 | */ | ||
| 23 | |||
| 24 | #include "avformat.h" | ||
| 25 | #include "mux.h" | ||
| 26 | #include "libavutil/avassert.h" | ||
| 27 | #include "libavutil/crc.h" | ||
| 28 | #include "libavutil/intreadwrite.h" | ||
| 29 | #include "libavutil/log.h" | ||
| 30 | #include "libavutil/mem.h" | ||
| 31 | #include "libavutil/opt.h" | ||
| 32 | #include "libavcodec/apng.h" | ||
| 33 | #include "libavcodec/png.h" | ||
| 34 | |||
| 35 | typedef struct APNGMuxContext { | ||
| 36 | AVClass *class; | ||
| 37 | |||
| 38 | uint32_t plays; | ||
| 39 | AVRational last_delay; | ||
| 40 | |||
| 41 | uint64_t acTL_offset; | ||
| 42 | uint32_t frame_number; | ||
| 43 | |||
| 44 | AVPacket *prev_packet; | ||
| 45 | AVRational prev_delay; | ||
| 46 | |||
| 47 | int framerate_warned; | ||
| 48 | |||
| 49 | uint8_t *extra_data; | ||
| 50 | int extra_data_size; | ||
| 51 | } APNGMuxContext; | ||
| 52 | |||
| 53 | 54 | static const uint8_t *apng_find_chunk(uint32_t tag, const uint8_t *buf, | |
| 54 | size_t length) | ||
| 55 | { | ||
| 56 | size_t b; | ||
| 57 |
2/2✓ Branch 0 taken 58 times.
✓ Branch 1 taken 2 times.
|
60 | for (b = 0; AV_RB32(buf + b) + 12ULL <= length - b; b += AV_RB32(buf + b) + 12ULL) |
| 58 |
2/2✓ Branch 0 taken 52 times.
✓ Branch 1 taken 6 times.
|
58 | if (AV_RB32(&buf[b + 4]) == tag) |
| 59 | 52 | return &buf[b]; | |
| 60 | 2 | return NULL; | |
| 61 | } | ||
| 62 | |||
| 63 | 30 | static void apng_write_chunk(AVIOContext *io_context, uint32_t tag, | |
| 64 | uint8_t *buf, size_t length) | ||
| 65 | { | ||
| 66 | 30 | const AVCRC *crc_table = av_crc_get_table(AV_CRC_32_IEEE_LE); | |
| 67 | 30 | uint32_t crc = ~0U; | |
| 68 | uint8_t tagbuf[4]; | ||
| 69 | |||
| 70 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 30 times.
|
30 | av_assert0(crc_table); |
| 71 | |||
| 72 | 30 | avio_wb32(io_context, length); | |
| 73 | 30 | AV_WB32(tagbuf, tag); | |
| 74 | 30 | crc = av_crc(crc_table, crc, tagbuf, 4); | |
| 75 | 30 | avio_wb32(io_context, tag); | |
| 76 |
2/2✓ Branch 0 taken 27 times.
✓ Branch 1 taken 3 times.
|
30 | if (length > 0) { |
| 77 | 27 | crc = av_crc(crc_table, crc, buf, length); | |
| 78 | 27 | avio_write(io_context, buf, length); | |
| 79 | } | ||
| 80 | 30 | avio_wb32(io_context, ~crc); | |
| 81 | 30 | } | |
| 82 | |||
| 83 | 3 | static int apng_write_header(AVFormatContext *format_context) | |
| 84 | { | ||
| 85 | 3 | APNGMuxContext *apng = format_context->priv_data; | |
| 86 | 3 | AVCodecParameters *par = format_context->streams[0]->codecpar; | |
| 87 | |||
| 88 |
2/4✓ Branch 0 taken 3 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 3 times.
|
3 | if (apng->last_delay.num > UINT16_MAX || apng->last_delay.den > UINT16_MAX) { |
| 89 | ✗ | av_reduce(&apng->last_delay.num, &apng->last_delay.den, | |
| 90 | ✗ | apng->last_delay.num, apng->last_delay.den, UINT16_MAX); | |
| 91 | ✗ | av_log(format_context, AV_LOG_WARNING, | |
| 92 | "Last frame delay is too precise. Reducing to %d/%d (%f).\n", | ||
| 93 | ✗ | apng->last_delay.num, apng->last_delay.den, (double)apng->last_delay.num / apng->last_delay.den); | |
| 94 | } | ||
| 95 | |||
| 96 | 3 | avio_wb64(format_context->pb, PNGSIG); | |
| 97 | // Remaining headers are written when they are copied from the encoder | ||
| 98 | |||
| 99 |
2/2✓ Branch 0 taken 1 times.
✓ Branch 1 taken 2 times.
|
3 | if (par->extradata_size) { |
| 100 | 1 | apng->extra_data = av_mallocz(par->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE); | |
| 101 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
|
1 | if (!apng->extra_data) |
| 102 | ✗ | return AVERROR(ENOMEM); | |
| 103 | 1 | apng->extra_data_size = par->extradata_size; | |
| 104 | 1 | memcpy(apng->extra_data, par->extradata, par->extradata_size); | |
| 105 | } | ||
| 106 | |||
| 107 | 3 | return 0; | |
| 108 | } | ||
| 109 | |||
| 110 | 51 | static int flush_packet(AVFormatContext *format_context, AVPacket *packet) | |
| 111 | { | ||
| 112 | 51 | APNGMuxContext *apng = format_context->priv_data; | |
| 113 | 51 | AVIOContext *io_context = format_context->pb; | |
| 114 | 51 | AVStream *codec_stream = format_context->streams[0]; | |
| 115 | 51 | uint8_t *side_data = NULL; | |
| 116 | size_t side_data_size; | ||
| 117 | |||
| 118 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 51 times.
|
51 | av_assert0(apng->prev_packet); |
| 119 | |||
| 120 | 51 | side_data = av_packet_get_side_data(apng->prev_packet, AV_PKT_DATA_NEW_EXTRADATA, &side_data_size); | |
| 121 | |||
| 122 |
2/2✓ Branch 0 taken 2 times.
✓ Branch 1 taken 49 times.
|
51 | if (side_data_size) { |
| 123 | 2 | av_freep(&apng->extra_data); | |
| 124 | 2 | apng->extra_data = av_mallocz(side_data_size + AV_INPUT_BUFFER_PADDING_SIZE); | |
| 125 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
|
2 | if (!apng->extra_data) |
| 126 | ✗ | return AVERROR(ENOMEM); | |
| 127 | 2 | apng->extra_data_size = side_data_size; | |
| 128 | 2 | memcpy(apng->extra_data, side_data, apng->extra_data_size); | |
| 129 | } | ||
| 130 | |||
| 131 |
4/4✓ Branch 0 taken 3 times.
✓ Branch 1 taken 48 times.
✓ Branch 2 taken 1 times.
✓ Branch 3 taken 2 times.
|
52 | if (apng->frame_number == 0 && !packet) { |
| 132 | const uint8_t *existing_acTL_chunk; | ||
| 133 | const uint8_t *existing_fcTL_chunk; | ||
| 134 | |||
| 135 | 1 | av_log(format_context, AV_LOG_INFO, "Only a single frame so saving as a normal PNG.\n"); | |
| 136 | |||
| 137 | // Write normal PNG headers without acTL chunk | ||
| 138 | 1 | existing_acTL_chunk = apng_find_chunk(MKBETAG('a', 'c', 'T', 'L'), apng->extra_data, apng->extra_data_size); | |
| 139 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
|
1 | if (existing_acTL_chunk) { |
| 140 | ✗ | const uint8_t *chunk_after_acTL = existing_acTL_chunk + AV_RB32(existing_acTL_chunk) + 12; | |
| 141 | ✗ | avio_write(io_context, apng->extra_data, existing_acTL_chunk - apng->extra_data); | |
| 142 | ✗ | avio_write(io_context, chunk_after_acTL, apng->extra_data + apng->extra_data_size - chunk_after_acTL); | |
| 143 | } else { | ||
| 144 | 1 | avio_write(io_context, apng->extra_data, apng->extra_data_size); | |
| 145 | } | ||
| 146 | |||
| 147 | // Write frame data without fcTL chunk | ||
| 148 | 1 | existing_fcTL_chunk = apng_find_chunk(MKBETAG('f', 'c', 'T', 'L'), apng->prev_packet->data, apng->prev_packet->size); | |
| 149 |
1/2✓ Branch 0 taken 1 times.
✗ Branch 1 not taken.
|
1 | if (existing_fcTL_chunk) { |
| 150 | 1 | const uint8_t *chunk_after_fcTL = existing_fcTL_chunk + AV_RB32(existing_fcTL_chunk) + 12; | |
| 151 | 1 | avio_write(io_context, apng->prev_packet->data, existing_fcTL_chunk - apng->prev_packet->data); | |
| 152 | 1 | avio_write(io_context, chunk_after_fcTL, apng->prev_packet->data + apng->prev_packet->size - chunk_after_fcTL); | |
| 153 | } else { | ||
| 154 | ✗ | avio_write(io_context, apng->prev_packet->data, apng->prev_packet->size); | |
| 155 | } | ||
| 156 | } else { | ||
| 157 | const uint8_t *data, *data_end; | ||
| 158 | const uint8_t *existing_fcTL_chunk; | ||
| 159 | |||
| 160 |
2/2✓ Branch 0 taken 2 times.
✓ Branch 1 taken 48 times.
|
50 | if (apng->frame_number == 0) { |
| 161 | const uint8_t *existing_acTL_chunk; | ||
| 162 | |||
| 163 | // Write normal PNG headers | ||
| 164 | 2 | avio_write(io_context, apng->extra_data, apng->extra_data_size); | |
| 165 | |||
| 166 | 2 | existing_acTL_chunk = apng_find_chunk(MKBETAG('a', 'c', 'T', 'L'), apng->extra_data, apng->extra_data_size); | |
| 167 |
2/2✓ Branch 0 taken 1 times.
✓ Branch 1 taken 1 times.
|
2 | if (!existing_acTL_chunk) { |
| 168 | uint8_t buf[8]; | ||
| 169 | // Write animation control header | ||
| 170 | 1 | apng->acTL_offset = avio_tell(io_context); | |
| 171 | 1 | AV_WB32(buf, UINT_MAX); // number of frames (filled in later) | |
| 172 | 1 | AV_WB32(buf + 4, apng->plays); | |
| 173 | 1 | apng_write_chunk(io_context, MKBETAG('a', 'c', 'T', 'L'), buf, 8); | |
| 174 | } | ||
| 175 | } | ||
| 176 | |||
| 177 | 50 | data = apng->prev_packet->data; | |
| 178 | 50 | data_end = data + apng->prev_packet->size; | |
| 179 | 50 | existing_fcTL_chunk = apng_find_chunk(MKBETAG('f', 'c', 'T', 'L'), apng->prev_packet->data, apng->prev_packet->size); | |
| 180 |
1/2✓ Branch 0 taken 50 times.
✗ Branch 1 not taken.
|
50 | if (existing_fcTL_chunk) { |
| 181 | AVRational delay; | ||
| 182 | |||
| 183 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 50 times.
|
50 | if (AV_RB32(existing_fcTL_chunk) != APNG_FCTL_CHUNK_SIZE) |
| 184 | ✗ | return AVERROR_INVALIDDATA; | |
| 185 | |||
| 186 | 50 | existing_fcTL_chunk += 8; | |
| 187 | 50 | delay.num = AV_RB16(existing_fcTL_chunk + 20); | |
| 188 | 50 | delay.den = AV_RB16(existing_fcTL_chunk + 22); | |
| 189 | |||
| 190 |
3/4✓ Branch 0 taken 25 times.
✓ Branch 1 taken 25 times.
✓ Branch 2 taken 25 times.
✗ Branch 3 not taken.
|
50 | if (delay.num == 0 && delay.den == 0) { |
| 191 | uint8_t new_fcTL_chunk[APNG_FCTL_CHUNK_SIZE]; | ||
| 192 | |||
| 193 |
2/2✓ Branch 0 taken 24 times.
✓ Branch 1 taken 1 times.
|
25 | if (packet) { |
| 194 | 24 | int64_t delay_num_raw = (packet->dts - apng->prev_packet->dts) * codec_stream->time_base.num; | |
| 195 | 24 | int64_t delay_den_raw = codec_stream->time_base.den; | |
| 196 |
1/2✗ Branch 1 not taken.
✓ Branch 2 taken 24 times.
|
24 | if (!av_reduce(&delay.num, &delay.den, delay_num_raw, delay_den_raw, UINT16_MAX) && |
| 197 | ✗ | !apng->framerate_warned) { | |
| 198 | ✗ | av_log(format_context, AV_LOG_WARNING, | |
| 199 | "Frame rate is too high or specified too precisely. Unable to copy losslessly.\n"); | ||
| 200 | ✗ | apng->framerate_warned = 1; | |
| 201 | } | ||
| 202 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
|
1 | } else if (apng->last_delay.num > 0) { |
| 203 | ✗ | delay = apng->last_delay; | |
| 204 | } else { | ||
| 205 | 1 | delay = apng->prev_delay; | |
| 206 | } | ||
| 207 | |||
| 208 | 25 | avio_write(io_context, data, (existing_fcTL_chunk - 8) - data); | |
| 209 | 25 | data = existing_fcTL_chunk + APNG_FCTL_CHUNK_SIZE + 4 /* CRC-32 */; | |
| 210 | // Update frame control header with new delay | ||
| 211 | 25 | memcpy(new_fcTL_chunk, existing_fcTL_chunk, sizeof(new_fcTL_chunk)); | |
| 212 | 25 | AV_WB16(new_fcTL_chunk + 20, delay.num); | |
| 213 | 25 | AV_WB16(new_fcTL_chunk + 22, delay.den); | |
| 214 | 25 | apng_write_chunk(io_context, MKBETAG('f', 'c', 'T', 'L'), | |
| 215 | new_fcTL_chunk, sizeof(new_fcTL_chunk)); | ||
| 216 | } | ||
| 217 | 50 | apng->prev_delay = delay; | |
| 218 | } | ||
| 219 | |||
| 220 | // Write frame data | ||
| 221 | 50 | avio_write(io_context, data, data_end - data); | |
| 222 | } | ||
| 223 | 51 | ++apng->frame_number; | |
| 224 | |||
| 225 | 51 | av_packet_unref(apng->prev_packet); | |
| 226 |
2/2✓ Branch 0 taken 48 times.
✓ Branch 1 taken 3 times.
|
51 | if (packet) |
| 227 | 48 | av_packet_ref(apng->prev_packet, packet); | |
| 228 | 51 | return 0; | |
| 229 | } | ||
| 230 | |||
| 231 | 51 | static int apng_write_packet(AVFormatContext *format_context, AVPacket *packet) | |
| 232 | { | ||
| 233 | 51 | APNGMuxContext *apng = format_context->priv_data; | |
| 234 | int ret; | ||
| 235 | |||
| 236 |
2/2✓ Branch 0 taken 3 times.
✓ Branch 1 taken 48 times.
|
51 | if (!apng->prev_packet) { |
| 237 | 3 | apng->prev_packet = av_packet_alloc(); | |
| 238 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
|
3 | if (!apng->prev_packet) |
| 239 | ✗ | return AVERROR(ENOMEM); | |
| 240 | |||
| 241 | 3 | av_packet_ref(apng->prev_packet, packet); | |
| 242 | } else { | ||
| 243 | 48 | ret = flush_packet(format_context, packet); | |
| 244 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 48 times.
|
48 | if (ret < 0) |
| 245 | ✗ | return ret; | |
| 246 | } | ||
| 247 | |||
| 248 | 51 | return 0; | |
| 249 | } | ||
| 250 | |||
| 251 | 3 | static int apng_write_trailer(AVFormatContext *format_context) | |
| 252 | { | ||
| 253 | 3 | APNGMuxContext *apng = format_context->priv_data; | |
| 254 | 3 | AVIOContext *io_context = format_context->pb; | |
| 255 | uint8_t buf[8]; | ||
| 256 | int ret; | ||
| 257 | |||
| 258 |
1/2✓ Branch 0 taken 3 times.
✗ Branch 1 not taken.
|
3 | if (apng->prev_packet) { |
| 259 | 3 | ret = flush_packet(format_context, NULL); | |
| 260 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
|
3 | if (ret < 0) |
| 261 | ✗ | return ret; | |
| 262 | } | ||
| 263 | |||
| 264 | 3 | apng_write_chunk(io_context, MKBETAG('I', 'E', 'N', 'D'), NULL, 0); | |
| 265 | |||
| 266 |
3/4✓ Branch 0 taken 1 times.
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 1 times.
✗ Branch 3 not taken.
|
3 | if (apng->acTL_offset && (io_context->seekable & AVIO_SEEKABLE_NORMAL)) { |
| 267 | 1 | avio_seek(io_context, apng->acTL_offset, SEEK_SET); | |
| 268 | |||
| 269 | 1 | AV_WB32(buf, apng->frame_number); | |
| 270 | 1 | AV_WB32(buf + 4, apng->plays); | |
| 271 | 1 | apng_write_chunk(io_context, MKBETAG('a', 'c', 'T', 'L'), buf, 8); | |
| 272 | } | ||
| 273 | |||
| 274 | 3 | return 0; | |
| 275 | } | ||
| 276 | |||
| 277 | 3 | static void apng_deinit(AVFormatContext *s) | |
| 278 | { | ||
| 279 | 3 | APNGMuxContext *apng = s->priv_data; | |
| 280 | |||
| 281 | 3 | av_packet_free(&apng->prev_packet); | |
| 282 | 3 | av_freep(&apng->extra_data); | |
| 283 | 3 | apng->extra_data_size = 0; | |
| 284 | 3 | } | |
| 285 | |||
| 286 | #define OFFSET(x) offsetof(APNGMuxContext, x) | ||
| 287 | #define ENC AV_OPT_FLAG_ENCODING_PARAM | ||
| 288 | static const AVOption options[] = { | ||
| 289 | { "plays", "Number of times to play the output: 0 - infinite loop, 1 - no loop", OFFSET(plays), | ||
| 290 | AV_OPT_TYPE_INT, { .i64 = 1 }, 0, UINT16_MAX, ENC }, | ||
| 291 | { "final_delay", "Force delay after the last frame", OFFSET(last_delay), | ||
| 292 | AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, UINT16_MAX, ENC }, | ||
| 293 | { NULL }, | ||
| 294 | }; | ||
| 295 | |||
| 296 | static const AVClass apng_muxer_class = { | ||
| 297 | .class_name = "APNG muxer", | ||
| 298 | .item_name = av_default_item_name, | ||
| 299 | .version = LIBAVUTIL_VERSION_INT, | ||
| 300 | .option = options, | ||
| 301 | }; | ||
| 302 | |||
| 303 | const FFOutputFormat ff_apng_muxer = { | ||
| 304 | .p.name = "apng", | ||
| 305 | .p.long_name = NULL_IF_CONFIG_SMALL("Animated Portable Network Graphics"), | ||
| 306 | .p.mime_type = "image/png", | ||
| 307 | .p.extensions = "apng", | ||
| 308 | .priv_data_size = sizeof(APNGMuxContext), | ||
| 309 | .p.audio_codec = AV_CODEC_ID_NONE, | ||
| 310 | .p.video_codec = AV_CODEC_ID_APNG, | ||
| 311 | .p.subtitle_codec = AV_CODEC_ID_NONE, | ||
| 312 | .flags_internal = FF_OFMT_FLAG_MAX_ONE_OF_EACH | | ||
| 313 | FF_OFMT_FLAG_ONLY_DEFAULT_CODECS, | ||
| 314 | .write_header = apng_write_header, | ||
| 315 | .write_packet = apng_write_packet, | ||
| 316 | .write_trailer = apng_write_trailer, | ||
| 317 | .deinit = apng_deinit, | ||
| 318 | .p.priv_class = &apng_muxer_class, | ||
| 319 | .p.flags = AVFMT_VARIABLE_FPS, | ||
| 320 | }; | ||
| 321 |