3 * Copyright (C) 2015 Vittorio Giovara <vittorio.giovara@gmail.com>
5 * This file is part of FFmpeg.
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.
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.
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
24 #include "libavutil/imgutils.h"
27 #include "bytestream.h"
30 #include "texturedsp.h"
33 typedef struct DXVContext {
34 TextureDSPContext texdsp;
37 uint8_t *tex_data; // Compressed texture
38 int tex_rat; // Compression ratio
39 int tex_step; // Distance between blocks
40 int64_t tex_size; // Texture size
42 /* Optimal number of slices for parallel decoding */
45 /* Pointer to the selected decompression function */
46 int (*tex_funct)(uint8_t *dst, ptrdiff_t stride, const uint8_t *block);
49 static int decompress_texture_thread(AVCodecContext *avctx, void *arg,
50 int slice, int thread_nb)
52 DXVContext *ctx = avctx->priv_data;
54 const uint8_t *d = ctx->tex_data;
55 int w_block = avctx->coded_width / TEXTURE_BLOCK_W;
56 int h_block = avctx->coded_height / TEXTURE_BLOCK_H;
58 int start_slice, end_slice;
59 int base_blocks_per_slice = h_block / ctx->slice_count;
60 int remainder_blocks = h_block % ctx->slice_count;
62 /* When the frame height (in blocks) doesn't divide evenly between the
63 * number of slices, spread the remaining blocks evenly between the first
65 start_slice = slice * base_blocks_per_slice;
66 /* Add any extra blocks (one per slice) that have been added
67 * before this slice */
68 start_slice += FFMIN(slice, remainder_blocks);
70 end_slice = start_slice + base_blocks_per_slice;
71 /* Add an extra block if there are remainder blocks to be accounted for */
72 if (slice < remainder_blocks)
75 for (y = start_slice; y < end_slice; y++) {
76 uint8_t *p = frame->data[0] + y * frame->linesize[0] * TEXTURE_BLOCK_H;
77 int off = y * w_block;
78 for (x = 0; x < w_block; x++) {
79 ctx->tex_funct(p + x * 16, frame->linesize[0],
80 d + (off + x) * ctx->tex_step);
87 /* This scheme addresses already decoded elements depending on 2-bit status:
88 * 0 -> copy new element
89 * 1 -> copy one element from position -x
90 * 2 -> copy one element from position -(get_byte() + 2) * x
91 * 3 -> copy one element from position -(get_16le() + 0x102) * x
92 * x is always 2 for dxt1 and 4 for dxt5. */
93 #define CHECKPOINT(x) \
96 value = bytestream2_get_le32(gbc); \
107 idx = (bytestream2_get_byte(gbc) + 2) * x; \
109 av_log(avctx, AV_LOG_ERROR, "idx %d > %d\n", idx, pos); \
110 return AVERROR_INVALIDDATA; \
114 idx = (bytestream2_get_le16(gbc) + 0x102) * x; \
116 av_log(avctx, AV_LOG_ERROR, "idx %d > %d\n", idx, pos); \
117 return AVERROR_INVALIDDATA; \
123 static int dxv_decompress_dxt1(AVCodecContext *avctx)
125 DXVContext *ctx = avctx->priv_data;
126 GetByteContext *gbc = &ctx->gbc;
127 uint32_t value, prev, op;
128 int idx = 0, state = 0;
131 /* Copy the first two elements */
132 AV_WL32(ctx->tex_data, bytestream2_get_le32(gbc));
133 AV_WL32(ctx->tex_data + 4, bytestream2_get_le32(gbc));
135 /* Process input until the whole texture has been filled */
136 while (pos + 2 <= ctx->tex_size / 4) {
139 /* Copy two elements from a previous offset or from the input buffer */
141 prev = AV_RL32(ctx->tex_data + 4 * (pos - idx));
142 AV_WL32(ctx->tex_data + 4 * pos, prev);
145 prev = AV_RL32(ctx->tex_data + 4 * (pos - idx));
146 AV_WL32(ctx->tex_data + 4 * pos, prev);
152 prev = AV_RL32(ctx->tex_data + 4 * (pos - idx));
154 prev = bytestream2_get_le32(gbc);
155 AV_WL32(ctx->tex_data + 4 * pos, prev);
161 prev = AV_RL32(ctx->tex_data + 4 * (pos - idx));
163 prev = bytestream2_get_le32(gbc);
164 AV_WL32(ctx->tex_data + 4 * pos, prev);
172 static int dxv_decompress_dxt5(AVCodecContext *avctx)
174 DXVContext *ctx = avctx->priv_data;
175 GetByteContext *gbc = &ctx->gbc;
177 int idx, prev, state = 0;
182 /* Copy the first four elements */
183 AV_WL32(ctx->tex_data + 0, bytestream2_get_le32(gbc));
184 AV_WL32(ctx->tex_data + 4, bytestream2_get_le32(gbc));
185 AV_WL32(ctx->tex_data + 8, bytestream2_get_le32(gbc));
186 AV_WL32(ctx->tex_data + 12, bytestream2_get_le32(gbc));
188 /* Process input until the whole texture has been filled */
189 while (pos + 2 <= ctx->tex_size / 4) {
193 prev = AV_RL32(ctx->tex_data + 4 * (pos - 4));
194 AV_WL32(ctx->tex_data + 4 * pos, prev);
196 prev = AV_RL32(ctx->tex_data + 4 * (pos - 4));
197 AV_WL32(ctx->tex_data + 4 * pos, prev);
201 value = bytestream2_get_le32(gbc);
211 check = bytestream2_get_byte(gbc) + 1;
214 probe = bytestream2_get_le16(gbc);
216 } while (probe == 0xFFFF);
218 while (check && pos + 4 <= ctx->tex_size / 4) {
219 prev = AV_RL32(ctx->tex_data + 4 * (pos - 4));
220 AV_WL32(ctx->tex_data + 4 * pos, prev);
223 prev = AV_RL32(ctx->tex_data + 4 * (pos - 4));
224 AV_WL32(ctx->tex_data + 4 * pos, prev);
227 prev = AV_RL32(ctx->tex_data + 4 * (pos - 4));
228 AV_WL32(ctx->tex_data + 4 * pos, prev);
231 prev = AV_RL32(ctx->tex_data + 4 * (pos - 4));
232 AV_WL32(ctx->tex_data + 4 * pos, prev);
238 /* Restart (or exit) the loop */
242 /* Load new run value */
243 run = bytestream2_get_byte(gbc);
246 probe = bytestream2_get_le16(gbc);
248 } while (probe == 0xFFFF);
251 /* Copy two dwords from previous data */
252 prev = AV_RL32(ctx->tex_data + 4 * (pos - 4));
253 AV_WL32(ctx->tex_data + 4 * pos, prev);
256 prev = AV_RL32(ctx->tex_data + 4 * (pos - 4));
257 AV_WL32(ctx->tex_data + 4 * pos, prev);
261 /* Copy two dwords from a previous index */
262 idx = 8 + bytestream2_get_le16(gbc);
263 if (idx > pos || (unsigned int)(pos - idx) + 2 > ctx->tex_size / 4)
264 return AVERROR_INVALIDDATA;
265 prev = AV_RL32(ctx->tex_data + 4 * (pos - idx));
266 AV_WL32(ctx->tex_data + 4 * pos, prev);
269 prev = AV_RL32(ctx->tex_data + 4 * (pos - idx));
270 AV_WL32(ctx->tex_data + 4 * pos, prev);
274 /* Copy two dwords from input */
275 prev = bytestream2_get_le32(gbc);
276 AV_WL32(ctx->tex_data + 4 * pos, prev);
279 prev = bytestream2_get_le32(gbc);
280 AV_WL32(ctx->tex_data + 4 * pos, prev);
287 if (pos + 2 > ctx->tex_size / 4)
288 return AVERROR_INVALIDDATA;
290 /* Copy two elements from a previous offset or from the input buffer */
292 if (idx > pos || (unsigned int)(pos - idx) + 2 > ctx->tex_size / 4)
293 return AVERROR_INVALIDDATA;
294 prev = AV_RL32(ctx->tex_data + 4 * (pos - idx));
295 AV_WL32(ctx->tex_data + 4 * pos, prev);
298 prev = AV_RL32(ctx->tex_data + 4 * (pos - idx));
299 AV_WL32(ctx->tex_data + 4 * pos, prev);
304 if (op && (idx > pos || (unsigned int)(pos - idx) + 2 > ctx->tex_size / 4))
305 return AVERROR_INVALIDDATA;
307 prev = AV_RL32(ctx->tex_data + 4 * (pos - idx));
309 prev = bytestream2_get_le32(gbc);
310 AV_WL32(ctx->tex_data + 4 * pos, prev);
316 prev = AV_RL32(ctx->tex_data + 4 * (pos - idx));
318 prev = bytestream2_get_le32(gbc);
319 AV_WL32(ctx->tex_data + 4 * pos, prev);
327 static int dxv_decompress_lzf(AVCodecContext *avctx)
329 DXVContext *ctx = avctx->priv_data;
330 return ff_lzf_uncompress(&ctx->gbc, &ctx->tex_data, &ctx->tex_size);
333 static int dxv_decompress_raw(AVCodecContext *avctx)
335 DXVContext *ctx = avctx->priv_data;
336 GetByteContext *gbc = &ctx->gbc;
338 bytestream2_get_buffer(gbc, ctx->tex_data, ctx->tex_size);
342 static int dxv_decode(AVCodecContext *avctx, void *data,
343 int *got_frame, AVPacket *avpkt)
345 DXVContext *ctx = avctx->priv_data;
347 GetByteContext *gbc = &ctx->gbc;
348 int (*decompress_tex)(AVCodecContext *avctx);
349 const char *msgcomp, *msgtext;
351 int version_major, version_minor = 0;
352 int size = 0, old_type = 0;
355 bytestream2_init(gbc, avpkt->data, avpkt->size);
357 tag = bytestream2_get_le32(gbc);
359 case MKBETAG('D', 'X', 'T', '1'):
360 decompress_tex = dxv_decompress_dxt1;
361 ctx->tex_funct = ctx->texdsp.dxt1_block;
367 case MKBETAG('D', 'X', 'T', '5'):
368 decompress_tex = dxv_decompress_dxt5;
369 ctx->tex_funct = ctx->texdsp.dxt5_block;
375 case MKBETAG('Y', 'C', 'G', '6'):
376 case MKBETAG('Y', 'G', '1', '0'):
377 avpriv_report_missing_feature(avctx, "Tag 0x%08X", tag);
378 return AVERROR_PATCHWELCOME;
380 /* Old version does not have a real header, just size and type. */
381 size = tag & 0x00FFFFFF;
382 old_type = tag >> 24;
383 version_major = (old_type & 0x0F) - 1;
385 if (old_type & 0x80) {
387 decompress_tex = dxv_decompress_raw;
390 decompress_tex = dxv_decompress_lzf;
393 if (old_type & 0x40) {
396 ctx->tex_funct = ctx->texdsp.dxt5_block;
398 } else if (old_type & 0x20 || version_major == 1) {
401 ctx->tex_funct = ctx->texdsp.dxt1_block;
404 av_log(avctx, AV_LOG_ERROR, "Unsupported header (0x%08X)\n.", tag);
405 return AVERROR_INVALIDDATA;
411 /* New header is 12 bytes long. */
413 version_major = bytestream2_get_byte(gbc) - 1;
414 version_minor = bytestream2_get_byte(gbc);
416 /* Encoder copies texture data when compression is not advantageous. */
417 if (bytestream2_get_byte(gbc)) {
420 decompress_tex = dxv_decompress_raw;
423 bytestream2_skip(gbc, 1); // unknown
424 size = bytestream2_get_le32(gbc);
426 av_log(avctx, AV_LOG_DEBUG,
427 "%s compression with %s texture (version %d.%d)\n",
428 msgcomp, msgtext, version_major, version_minor);
430 if (size != bytestream2_get_bytes_left(gbc)) {
431 av_log(avctx, AV_LOG_ERROR,
432 "Incomplete or invalid file (header %d, left %d).\n",
433 size, bytestream2_get_bytes_left(gbc));
434 return AVERROR_INVALIDDATA;
437 ctx->tex_size = avctx->coded_width * avctx->coded_height * 4 / ctx->tex_rat;
438 ret = av_reallocp(&ctx->tex_data, ctx->tex_size);
442 /* Decompress texture out of the intermediate compression. */
443 ret = decompress_tex(avctx);
448 ret = ff_thread_get_buffer(avctx, &tframe, 0);
452 /* Now decompress the texture with the standard functions. */
453 avctx->execute2(avctx, decompress_texture_thread,
454 tframe.f, NULL, ctx->slice_count);
456 /* Frame is ready to be output. */
457 tframe.f->pict_type = AV_PICTURE_TYPE_I;
458 tframe.f->key_frame = 1;
464 static int dxv_init(AVCodecContext *avctx)
466 DXVContext *ctx = avctx->priv_data;
467 int ret = av_image_check_size(avctx->width, avctx->height, 0, avctx);
470 av_log(avctx, AV_LOG_ERROR, "Invalid image size %dx%d.\n",
471 avctx->width, avctx->height);
475 /* Codec requires 16x16 alignment. */
476 avctx->coded_width = FFALIGN(avctx->width, 16);
477 avctx->coded_height = FFALIGN(avctx->height, 16);
479 ff_texturedsp_init(&ctx->texdsp);
480 avctx->pix_fmt = AV_PIX_FMT_RGBA;
482 ctx->slice_count = av_clip(avctx->thread_count, 1,
483 avctx->coded_height / TEXTURE_BLOCK_H);
488 static int dxv_close(AVCodecContext *avctx)
490 DXVContext *ctx = avctx->priv_data;
492 av_freep(&ctx->tex_data);
497 AVCodec ff_dxv_decoder = {
499 .long_name = NULL_IF_CONFIG_SMALL("Resolume DXV"),
500 .type = AVMEDIA_TYPE_VIDEO,
501 .id = AV_CODEC_ID_DXV,
503 .decode = dxv_decode,
505 .priv_data_size = sizeof(DXVContext),
506 .capabilities = AV_CODEC_CAP_DR1 |
507 AV_CODEC_CAP_SLICE_THREADS |
508 AV_CODEC_CAP_FRAME_THREADS,
509 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
510 FF_CODEC_CAP_INIT_CLEANUP,