libavcodec/xwddec.c
27ed027b
 /*
  * XWD image format
  *
  * Copyright (c) 2012 Paul B Mahol
  *
8fbe11e6
  * This file is part of FFmpeg.
27ed027b
  *
8fbe11e6
  * FFmpeg is free software; you can redistribute it and/or
27ed027b
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
8fbe11e6
  * FFmpeg is distributed in the hope that it will be useful,
27ed027b
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
8fbe11e6
  * License along with FFmpeg; if not, write to the Free Software
27ed027b
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
cc8163e1
 #include <inttypes.h>
 
27ed027b
 #include "libavutil/imgutils.h"
 #include "avcodec.h"
 #include "bytestream.h"
594d4d5d
 #include "internal.h"
27ed027b
 #include "xwd.h"
 
 static int xwd_decode_frame(AVCodecContext *avctx, void *data,
df9b9567
                             int *got_frame, AVPacket *avpkt)
27ed027b
 {
759001c5
     AVFrame *p = data;
27ed027b
     const uint8_t *buf = avpkt->data;
     int i, ret, buf_size = avpkt->size;
     uint32_t version, header_size, vclass, ncolors;
     uint32_t xoffset, be, bpp, lsize, rsize;
     uint32_t pixformat, pixdepth, bunit, bitorder, bpad;
     uint32_t rgb[3];
     uint8_t *ptr;
5d6d0d20
     int width, height;
abe3c697
     GetByteContext gb;
27ed027b
 
     if (buf_size < XWD_HEADER_SIZE)
         return AVERROR_INVALIDDATA;
 
abe3c697
     bytestream2_init(&gb, buf, buf_size);
     header_size = bytestream2_get_be32u(&gb);
27ed027b
 
abe3c697
     version = bytestream2_get_be32u(&gb);
27ed027b
     if (version != XWD_VERSION) {
         av_log(avctx, AV_LOG_ERROR, "unsupported version\n");
         return AVERROR_INVALIDDATA;
     }
 
abe3c697
     if (buf_size < header_size || header_size < XWD_HEADER_SIZE) {
27ed027b
         av_log(avctx, AV_LOG_ERROR, "invalid header size\n");
         return AVERROR_INVALIDDATA;
     }
 
abe3c697
     pixformat     = bytestream2_get_be32u(&gb);
     pixdepth      = bytestream2_get_be32u(&gb);
5d6d0d20
     width         = bytestream2_get_be32u(&gb);
     height        = bytestream2_get_be32u(&gb);
abe3c697
     xoffset       = bytestream2_get_be32u(&gb);
     be            = bytestream2_get_be32u(&gb);
     bunit         = bytestream2_get_be32u(&gb);
     bitorder      = bytestream2_get_be32u(&gb);
     bpad          = bytestream2_get_be32u(&gb);
     bpp           = bytestream2_get_be32u(&gb);
     lsize         = bytestream2_get_be32u(&gb);
     vclass        = bytestream2_get_be32u(&gb);
     rgb[0]        = bytestream2_get_be32u(&gb);
     rgb[1]        = bytestream2_get_be32u(&gb);
     rgb[2]        = bytestream2_get_be32u(&gb);
     bytestream2_skipu(&gb, 8);
     ncolors       = bytestream2_get_be32u(&gb);
     bytestream2_skipu(&gb, header_size - (XWD_HEADER_SIZE - 20));
27ed027b
 
5d6d0d20
     if ((ret = ff_set_dimensions(avctx, width, height)) < 0)
         return ret;
 
cc8163e1
     av_log(avctx, AV_LOG_DEBUG,
            "pixformat %"PRIu32", pixdepth %"PRIu32", bunit %"PRIu32", bitorder %"PRIu32", bpad %"PRIu32"\n",
27ed027b
            pixformat, pixdepth, bunit, bitorder, bpad);
cc8163e1
     av_log(avctx, AV_LOG_DEBUG,
            "vclass %"PRIu32", ncolors %"PRIu32", bpp %"PRIu32", be %"PRIu32", lsize %"PRIu32", xoffset %"PRIu32"\n",
27ed027b
            vclass, ncolors, bpp, be, lsize, xoffset);
cba4e606
     av_log(avctx, AV_LOG_DEBUG,
            "red %0"PRIx32", green %0"PRIx32", blue %0"PRIx32"\n",
            rgb[0], rgb[1], rgb[2]);
27ed027b
 
     if (pixformat > XWD_Z_PIXMAP) {
         av_log(avctx, AV_LOG_ERROR, "invalid pixmap format\n");
         return AVERROR_INVALIDDATA;
     }
 
     if (pixdepth == 0 || pixdepth > 32) {
         av_log(avctx, AV_LOG_ERROR, "invalid pixmap depth\n");
         return AVERROR_INVALIDDATA;
     }
 
     if (xoffset) {
cc8163e1
         avpriv_request_sample(avctx, "xoffset %"PRIu32"", xoffset);
27ed027b
         return AVERROR_PATCHWELCOME;
     }
 
     if (be > 1) {
         av_log(avctx, AV_LOG_ERROR, "invalid byte order\n");
         return AVERROR_INVALIDDATA;
     }
 
     if (bitorder > 1) {
         av_log(avctx, AV_LOG_ERROR, "invalid bitmap bit order\n");
         return AVERROR_INVALIDDATA;
     }
 
     if (bunit != 8 && bunit != 16 && bunit != 32) {
         av_log(avctx, AV_LOG_ERROR, "invalid bitmap unit\n");
         return AVERROR_INVALIDDATA;
     }
 
     if (bpad != 8 && bpad != 16 && bpad != 32) {
         av_log(avctx, AV_LOG_ERROR, "invalid bitmap scan-line pad\n");
         return AVERROR_INVALIDDATA;
     }
 
     if (bpp == 0 || bpp > 32) {
         av_log(avctx, AV_LOG_ERROR, "invalid bits per pixel\n");
         return AVERROR_INVALIDDATA;
     }
 
     if (ncolors > 256) {
         av_log(avctx, AV_LOG_ERROR, "invalid number of entries in colormap\n");
         return AVERROR_INVALIDDATA;
     }
 
     if ((ret = av_image_check_size(avctx->width, avctx->height, 0, NULL)) < 0)
         return ret;
 
     rsize = FFALIGN(avctx->width * bpp, bpad) / 8;
     if (lsize < rsize) {
         av_log(avctx, AV_LOG_ERROR, "invalid bytes per scan-line\n");
         return AVERROR_INVALIDDATA;
     }
 
9d38f06d
     if (bytestream2_get_bytes_left(&gb) < ncolors * XWD_CMAP_SIZE + (uint64_t)avctx->height * lsize) {
27ed027b
         av_log(avctx, AV_LOG_ERROR, "input buffer too small\n");
         return AVERROR_INVALIDDATA;
     }
 
     if (pixformat != XWD_Z_PIXMAP) {
8d024c51
         avpriv_report_missing_feature(avctx, "Pixmap format %"PRIu32, pixformat);
27ed027b
         return AVERROR_PATCHWELCOME;
     }
 
716d413c
     avctx->pix_fmt = AV_PIX_FMT_NONE;
27ed027b
     switch (vclass) {
     case XWD_STATIC_GRAY:
     case XWD_GRAY_SCALE:
b9c94e82
         if (bpp != 1 && bpp != 8)
27ed027b
             return AVERROR_INVALIDDATA;
441026fc
         if (bpp == 1 && pixdepth == 1) {
716d413c
             avctx->pix_fmt = AV_PIX_FMT_MONOWHITE;
441026fc
         } else if (bpp == 8 && pixdepth == 8) {
ac627b3d
             avctx->pix_fmt = AV_PIX_FMT_GRAY8;
b9c94e82
         }
27ed027b
         break;
     case XWD_STATIC_COLOR:
     case XWD_PSEUDO_COLOR:
         if (bpp == 8)
716d413c
             avctx->pix_fmt = AV_PIX_FMT_PAL8;
27ed027b
         break;
     case XWD_TRUE_COLOR:
     case XWD_DIRECT_COLOR:
         if (bpp != 16 && bpp != 24 && bpp != 32)
             return AVERROR_INVALIDDATA;
         if (bpp == 16 && pixdepth == 15) {
             if (rgb[0] == 0x7C00 && rgb[1] == 0x3E0 && rgb[2] == 0x1F)
716d413c
                 avctx->pix_fmt = be ? AV_PIX_FMT_RGB555BE : AV_PIX_FMT_RGB555LE;
27ed027b
             else if (rgb[0] == 0x1F && rgb[1] == 0x3E0 && rgb[2] == 0x7C00)
716d413c
                 avctx->pix_fmt = be ? AV_PIX_FMT_BGR555BE : AV_PIX_FMT_BGR555LE;
27ed027b
         } else if (bpp == 16 && pixdepth == 16) {
             if (rgb[0] == 0xF800 && rgb[1] == 0x7E0 && rgb[2] == 0x1F)
716d413c
                 avctx->pix_fmt = be ? AV_PIX_FMT_RGB565BE : AV_PIX_FMT_RGB565LE;
27ed027b
             else if (rgb[0] == 0x1F && rgb[1] == 0x7E0 && rgb[2] == 0xF800)
716d413c
                 avctx->pix_fmt = be ? AV_PIX_FMT_BGR565BE : AV_PIX_FMT_BGR565LE;
27ed027b
         } else if (bpp == 24) {
             if (rgb[0] == 0xFF0000 && rgb[1] == 0xFF00 && rgb[2] == 0xFF)
716d413c
                 avctx->pix_fmt = be ? AV_PIX_FMT_RGB24 : AV_PIX_FMT_BGR24;
27ed027b
             else if (rgb[0] == 0xFF && rgb[1] == 0xFF00 && rgb[2] == 0xFF0000)
716d413c
                 avctx->pix_fmt = be ? AV_PIX_FMT_BGR24 : AV_PIX_FMT_RGB24;
27ed027b
         } else if (bpp == 32) {
             if (rgb[0] == 0xFF0000 && rgb[1] == 0xFF00 && rgb[2] == 0xFF)
716d413c
                 avctx->pix_fmt = be ? AV_PIX_FMT_ARGB : AV_PIX_FMT_BGRA;
27ed027b
             else if (rgb[0] == 0xFF && rgb[1] == 0xFF00 && rgb[2] == 0xFF0000)
716d413c
                 avctx->pix_fmt = be ? AV_PIX_FMT_ABGR : AV_PIX_FMT_RGBA;
27ed027b
         }
abe3c697
         bytestream2_skipu(&gb, ncolors * XWD_CMAP_SIZE);
27ed027b
         break;
     default:
         av_log(avctx, AV_LOG_ERROR, "invalid visual class\n");
         return AVERROR_INVALIDDATA;
     }
 
716d413c
     if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
6d97484d
         avpriv_request_sample(avctx,
cc8163e1
                               "Unknown file: bpp %"PRIu32", pixdepth %"PRIu32", vclass %"PRIu32"",
6d97484d
                               bpp, pixdepth, vclass);
27ed027b
         return AVERROR_PATCHWELCOME;
     }
 
1ec94b0f
     if ((ret = ff_get_buffer(avctx, p, 0)) < 0)
27ed027b
         return ret;
 
     p->key_frame = 1;
     p->pict_type = AV_PICTURE_TYPE_I;
 
716d413c
     if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
27ed027b
         uint32_t *dst = (uint32_t *)p->data[1];
         uint8_t red, green, blue;
 
         for (i = 0; i < ncolors; i++) {
 
abe3c697
             bytestream2_skipu(&gb, 4); // skip colormap entry number
             red    = bytestream2_get_byteu(&gb);
             bytestream2_skipu(&gb, 1);
             green  = bytestream2_get_byteu(&gb);
             bytestream2_skipu(&gb, 1);
             blue   = bytestream2_get_byteu(&gb);
             bytestream2_skipu(&gb, 3); // skip bitmask flag and padding
27ed027b
 
             dst[i] = red << 16 | green << 8 | blue;
         }
     }
 
     ptr = p->data[0];
     for (i = 0; i < avctx->height; i++) {
abe3c697
         bytestream2_get_bufferu(&gb, ptr, rsize);
         bytestream2_skipu(&gb, lsize - rsize);
27ed027b
         ptr += p->linesize[0];
     }
 
df9b9567
     *got_frame       = 1;
27ed027b
 
     return buf_size;
 }
 
 AVCodec ff_xwd_decoder = {
     .name           = "xwd",
b2bed932
     .long_name      = NULL_IF_CONFIG_SMALL("XWD (X Window Dump) image"),
27ed027b
     .type           = AVMEDIA_TYPE_VIDEO,
36ef5369
     .id             = AV_CODEC_ID_XWD,
27ed027b
     .decode         = xwd_decode_frame,
def97856
     .capabilities   = AV_CODEC_CAP_DR1,
27ed027b
 };