xref: /third_party/ffmpeg/libavcodec/vbndec.c (revision cabdff1a)
1/*
2 * Vizrt Binary Image decoder
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21/**
22 * @file
23 * Vizrt Binary Image decoder
24 */
25
26#include "avcodec.h"
27#include "bytestream.h"
28#include "codec_internal.h"
29#include "internal.h"
30#include "texturedsp.h"
31#include "vbn.h"
32#include "libavutil/imgutils.h"
33
34typedef struct VBNContext {
35    TextureDSPContext texdsp;
36    TextureDSPThreadContext dec;
37} VBNContext;
38
39static av_cold int vbn_init(AVCodecContext *avctx)
40{
41    VBNContext *ctx = avctx->priv_data;
42    ff_texturedsp_init(&ctx->texdsp);
43    return 0;
44}
45
46static int decompress(AVCodecContext *avctx, GetByteContext *gb,
47                      int compression, uint8_t **outbuf)
48{
49    if (compression == VBN_COMPRESSION_NONE) // outbuf is left NULL because gb->buf can be used directly
50        return bytestream2_get_bytes_left(gb);
51
52    av_log(avctx, AV_LOG_ERROR, "Unsupported VBN compression: 0x%08x\n", compression);
53    return AVERROR_PATCHWELCOME;
54}
55
56static int vbn_decode_frame(AVCodecContext *avctx,
57                            AVFrame *frame, int *got_frame,
58                            AVPacket *avpkt)
59{
60    VBNContext *ctx    = avctx->priv_data;
61    GetByteContext gb0, *const gb = &gb0;
62    uint8_t *image_buf = NULL;
63    int      image_len;
64    int width, height, components, format, compression, pix_fmt, linesize, data_size;
65    int ret;
66
67    bytestream2_init(gb, avpkt->data, avpkt->size);
68
69    if (bytestream2_get_bytes_left(gb) < VBN_HEADER_SIZE) {
70        av_log(avctx, AV_LOG_ERROR, "VBN header truncated\n");
71        return AVERROR_INVALIDDATA;
72    }
73
74    if (bytestream2_get_le32u(gb) != VBN_MAGIC ||
75        bytestream2_get_le32u(gb) != VBN_MAJOR ||
76        bytestream2_get_le32u(gb) != VBN_MINOR) {
77        av_log(avctx, AV_LOG_ERROR, "Invalid VBN header\n");
78        return AVERROR_INVALIDDATA;
79    }
80
81    width       = bytestream2_get_le32u(gb);
82    height      = bytestream2_get_le32u(gb);
83    components  = bytestream2_get_le32u(gb);
84    format      = bytestream2_get_le32u(gb);
85    pix_fmt     = bytestream2_get_le32u(gb);
86    bytestream2_get_le32u(gb); // mipmaps
87    data_size   = bytestream2_get_le32u(gb);
88    bytestream2_seek(gb, VBN_HEADER_SIZE, SEEK_SET);
89
90    compression = format & 0xffffff00;
91    format      = format & 0xff;
92
93    if (data_size != bytestream2_get_bytes_left(gb)) {
94        av_log(avctx, AV_LOG_ERROR, "Truncated packet\n");
95        return AVERROR_INVALIDDATA;
96    }
97
98    if (pix_fmt != VBN_PIX_RGBA && pix_fmt != VBN_PIX_RGB) {
99        av_log(avctx, AV_LOG_ERROR, "Unsupported pixel format: 0x%08x\n", pix_fmt);
100        return AVERROR_PATCHWELCOME;
101    }
102
103    ret = ff_set_dimensions(avctx, width, height);
104    if (ret < 0)
105        return ret;
106
107    if (format == VBN_FORMAT_RAW) {
108        if (pix_fmt == VBN_PIX_RGB && components == 3) {
109             avctx->pix_fmt = AV_PIX_FMT_RGB24;
110             linesize = avctx->width * 3;
111        } else if (pix_fmt == VBN_PIX_RGBA && components == 4) {
112             avctx->pix_fmt = AV_PIX_FMT_RGBA;
113             linesize = avctx->width * 4;
114        } else {
115            av_log(avctx, AV_LOG_ERROR, "Unsupported number of components: %d\n", components);
116            return AVERROR_PATCHWELCOME;
117        }
118    } else if (format == VBN_FORMAT_DXT1 || format == VBN_FORMAT_DXT5)  {
119        if (avctx->width % TEXTURE_BLOCK_W || avctx->height % TEXTURE_BLOCK_H) {
120            av_log(avctx, AV_LOG_ERROR, "DXTx compression only supports 4 pixel aligned resolutions\n");
121            return AVERROR_INVALIDDATA;
122        }
123
124        avctx->pix_fmt = AV_PIX_FMT_RGBA;
125        if (format == VBN_FORMAT_DXT1) {
126            ctx->dec.tex_funct = ctx->texdsp.dxt1_block;
127            ctx->dec.tex_ratio = 8;
128            linesize = avctx->coded_width / 2;
129        } else {
130            ctx->dec.tex_funct = ctx->texdsp.dxt5_block;
131            ctx->dec.tex_ratio = 16;
132            linesize = avctx->coded_width;
133        }
134    } else {
135        av_log(avctx, AV_LOG_ERROR, "Unsupported VBN format: 0x%02x\n", format);
136        return AVERROR_PATCHWELCOME;
137    }
138
139    image_len = decompress(avctx, gb, compression, &image_buf);
140    if (image_len < 0)
141        return image_len;
142
143    if (image_len < linesize * avctx->coded_height) {
144        av_log(avctx, AV_LOG_ERROR, "Insufficent data\n");
145        ret = AVERROR_INVALIDDATA;
146        goto out;
147    }
148
149    ret = ff_get_buffer(avctx, frame, 0);
150    if (ret < 0)
151        goto out;
152
153    frame->pict_type = AV_PICTURE_TYPE_I;
154    frame->key_frame = 1;
155
156    if (format == VBN_FORMAT_RAW) {
157        uint8_t *flipped = frame->data[0] + frame->linesize[0] * (frame->height - 1);
158        av_image_copy_plane(flipped, -frame->linesize[0], image_buf ? image_buf : gb->buffer, linesize, linesize, frame->height);
159    } else {
160        ctx->dec.slice_count = av_clip(avctx->thread_count, 1, avctx->coded_height / TEXTURE_BLOCK_H);
161        ctx->dec.tex_data.in = image_buf ? image_buf : gb->buffer;
162        ctx->dec.raw_ratio = 16;
163        ctx->dec.frame_data.out = frame->data[0] + frame->linesize[0] * (frame->height - 1);
164        ctx->dec.stride = -frame->linesize[0];
165        avctx->execute2(avctx, ff_texturedsp_decompress_thread, &ctx->dec, NULL, ctx->dec.slice_count);
166    }
167
168    *got_frame = 1;
169    ret = avpkt->size;
170
171out:
172    av_freep(&image_buf);
173    return ret;
174}
175
176const FFCodec ff_vbn_decoder = {
177    .p.name         = "vbn",
178    .p.long_name    = NULL_IF_CONFIG_SMALL("Vizrt Binary Image"),
179    .p.type         = AVMEDIA_TYPE_VIDEO,
180    .p.id           = AV_CODEC_ID_VBN,
181    .init           = vbn_init,
182    FF_CODEC_DECODE_CB(vbn_decode_frame),
183    .priv_data_size = sizeof(VBNContext),
184    .p.capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_SLICE_THREADS,
185    .caps_internal  = FF_CODEC_CAP_INIT_THREADSAFE
186};
187