FFmpeg
targaenc.c
Go to the documentation of this file.
1 /*
2  * Targa (.tga) image encoder
3  * Copyright (c) 2007 Bobby Bingham
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 <string.h>
23 
24 #include "libavutil/avassert.h"
25 #include "libavutil/imgutils.h"
26 #include "libavutil/internal.h"
27 #include "libavutil/intreadwrite.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/pixdesc.h"
30 #include "avcodec.h"
31 #include "codec_internal.h"
32 #include "encode.h"
33 #include "rle.h"
34 #include "targa.h"
35 
36 typedef struct TargaContext {
37  AVClass *class;
38 
39  int rle;
40 } TargaContext;
41 
42 /**
43  * RLE compress the image, with maximum size of out_size
44  * @param outbuf Output buffer
45  * @param out_size Maximum output size
46  * @param pic Image to compress
47  * @param bpp Bytes per pixel
48  * @param w Image width
49  * @param h Image height
50  * @return Size of output in bytes, or -1 if larger than out_size
51  */
52 static int targa_encode_rle(uint8_t *outbuf, int out_size, const AVFrame *pic,
53  int bpp, int w, int h)
54 {
55  int y,ret;
56  uint8_t *out;
57 
58  out = outbuf;
59 
60  for(y = 0; y < h; y ++) {
61  ret = ff_rle_encode(out, out_size, pic->data[0] + pic->linesize[0] * y, bpp, w, 0x7f, 0, -1, 0);
62  if(ret == -1){
63  return -1;
64  }
65  out+= ret;
66  out_size -= ret;
67  }
68 
69  return out - outbuf;
70 }
71 
72 static int targa_encode_normal(uint8_t *outbuf, const AVFrame *pic, int bpp, int w, int h)
73 {
74  int i, n = bpp * w;
75  uint8_t *out = outbuf;
76  const uint8_t *ptr = pic->data[0];
77 
78  for(i=0; i < h; i++) {
79  memcpy(out, ptr, n);
80  out += n;
81  ptr += pic->linesize[0];
82  }
83 
84  return out - outbuf;
85 }
86 
88  const AVFrame *p, int *got_packet)
89 {
90  TargaContext *s = avctx->priv_data;
91  int bpp, picsize, datasize = -1, ret, i;
92  uint8_t *out;
93  int maxpal = 32*32;
94 
95  picsize = av_image_get_buffer_size(avctx->pix_fmt,
96  avctx->width, avctx->height, 1);
97  if ((ret = ff_alloc_packet(avctx, pkt, picsize + 45 + maxpal)) < 0)
98  return ret;
99 
100  /* zero out the header and only set applicable fields */
101  memset(pkt->data, 0, 12);
102  AV_WL16(pkt->data+12, avctx->width);
103  AV_WL16(pkt->data+14, avctx->height);
104  /* image descriptor byte: origin is always top-left, bits 0-3 specify alpha */
105  pkt->data[17] = 0x20 | (avctx->pix_fmt == AV_PIX_FMT_BGRA ? 8 : 0);
106 
107  out = pkt->data + 18; /* skip past the header we write */
108 
110  switch(avctx->pix_fmt) {
111  case AV_PIX_FMT_PAL8: {
112  int pal_bpp = 24; /* Only write 32bit palette if there is transparency information */
113  for (i = 0; i < 256; i++)
114  if (AV_RN32(p->data[1] + 4 * i) >> 24 != 0xFF) {
115  pal_bpp = 32;
116  break;
117  }
118  pkt->data[1] = 1; /* palette present */
119  pkt->data[2] = TGA_PAL; /* uncompressed palettised image */
120  pkt->data[6] = 1; /* palette contains 256 entries */
121  pkt->data[7] = pal_bpp; /* palette contains pal_bpp bit entries */
122  pkt->data[16] = 8; /* bpp */
123  for (i = 0; i < 256; i++)
124  if (pal_bpp == 32) {
125  AV_WL32(pkt->data + 18 + 4 * i, *(uint32_t *)(p->data[1] + i * 4));
126  } else {
127  AV_WL24(pkt->data + 18 + 3 * i, *(uint32_t *)(p->data[1] + i * 4));
128  }
129  out += 32 * pal_bpp; /* skip past the palette we just output */
130  av_assert0(32 * pal_bpp <= maxpal);
131  break;
132  }
133  case AV_PIX_FMT_GRAY8:
134  pkt->data[2] = TGA_BW; /* uncompressed grayscale image */
135  avctx->bits_per_coded_sample = 0x28;
136  pkt->data[16] = 8; /* bpp */
137  break;
138  case AV_PIX_FMT_RGB555LE:
139  pkt->data[2] = TGA_RGB; /* uncompressed true-color image */
140  avctx->bits_per_coded_sample =
141  pkt->data[16] = 16; /* bpp */
142  break;
143  case AV_PIX_FMT_BGR24:
144  pkt->data[2] = TGA_RGB; /* uncompressed true-color image */
145  pkt->data[16] = 24; /* bpp */
146  break;
147  case AV_PIX_FMT_BGRA:
148  pkt->data[2] = TGA_RGB; /* uncompressed true-color image */
149  pkt->data[16] = 32; /* bpp */
150  break;
151  default:
152  av_log(avctx, AV_LOG_ERROR, "Pixel format '%s' not supported.\n",
153  av_get_pix_fmt_name(avctx->pix_fmt));
154  return AVERROR(EINVAL);
155  }
156  bpp = pkt->data[16] >> 3;
157 
158 
159  /* try RLE compression */
160  if (s->rle)
161  datasize = targa_encode_rle(out, picsize, p, bpp, avctx->width, avctx->height);
162 
163  /* if that worked well, mark the picture as RLE compressed */
164  if(datasize >= 0)
165  pkt->data[2] |= TGA_RLE;
166 
167  /* if RLE didn't make it smaller, go back to no compression */
168  else datasize = targa_encode_normal(out, p, bpp, avctx->width, avctx->height);
169 
170  out += datasize;
171 
172  /* The standard recommends including this section, even if we don't use
173  * any of the features it affords. TODO: take advantage of the pixel
174  * aspect ratio and encoder ID fields available? */
175  memcpy(out, "\0\0\0\0\0\0\0\0TRUEVISION-XFILE.", 26);
176 
177  pkt->size = out + 26 - pkt->data;
178  *got_packet = 1;
179 
180  return 0;
181 }
182 
184 {
185  if (avctx->width > 0xffff || avctx->height > 0xffff) {
186  av_log(avctx, AV_LOG_ERROR, "image dimensions too large\n");
187  return AVERROR(EINVAL);
188  }
189 
190  return 0;
191 }
192 
193 #define OFFSET(x) offsetof(TargaContext, x)
194 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
195 static const AVOption options[] = {
196  { "rle", "Use run-length compression", OFFSET(rle), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, VE },
197 
198  { NULL },
199 };
200 
201 static const AVClass targa_class = {
202  .class_name = "targa",
203  .item_name = av_default_item_name,
204  .option = options,
205  .version = LIBAVUTIL_VERSION_INT,
206 };
207 
209  .p.name = "targa",
210  CODEC_LONG_NAME("Truevision Targa image"),
211  .p.type = AVMEDIA_TYPE_VIDEO,
212  .p.id = AV_CODEC_ID_TARGA,
214  .priv_data_size = sizeof(TargaContext),
215  .p.priv_class = &targa_class,
216  .init = targa_encode_init,
218  .p.pix_fmts = (const enum AVPixelFormat[]){
221  },
222 };
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:71
TGA_RGB
@ TGA_RGB
Definition: targa.h:36
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
targa_class
static const AVClass targa_class
Definition: targaenc.c:201
AV_WL32
#define AV_WL32(p, v)
Definition: intreadwrite.h:422
rle.h
out
FILE * out
Definition: movenc.c:55
OFFSET
#define OFFSET(x)
Definition: targaenc.c:193
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:3170
out_size
int out_size
Definition: movenc.c:56
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:389
pixdesc.h
w
uint8_t w
Definition: llviddspenc.c:38
AVPacket::data
uint8_t * data
Definition: packet.h:539
AVOption
AVOption.
Definition: opt.h:429
encode.h
FFCodec
Definition: codec_internal.h:127
AV_PIX_FMT_BGR24
@ AV_PIX_FMT_BGR24
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:76
AV_PIX_FMT_BGRA
@ AV_PIX_FMT_BGRA
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:102
av_get_bits_per_pixel
int av_get_bits_per_pixel(const AVPixFmtDescriptor *pixdesc)
Return the number of bits per pixel used by the pixel format described by pixdesc.
Definition: pixdesc.c:3122
targa.h
rle
static int rle(uint8_t *dst, const uint8_t *src, int compressed_size, int uncompressed_size)
Definition: exr.c:217
TGA_PAL
@ TGA_PAL
Definition: targa.h:35
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:410
VE
#define VE
Definition: targaenc.c:194
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:131
FF_CODEC_ENCODE_CB
#define FF_CODEC_ENCODE_CB(func)
Definition: codec_internal.h:320
targa_encode_rle
static int targa_encode_rle(uint8_t *outbuf, int out_size, const AVFrame *pic, int bpp, int w, int h)
RLE compress the image, with maximum size of out_size.
Definition: targaenc.c:52
avassert.h
pkt
AVPacket * pkt
Definition: movenc.c:60
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:209
av_cold
#define av_cold
Definition: attributes.h:90
TGA_RLE
@ TGA_RLE
Definition: targa.h:38
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:198
ff_targa_encoder
const FFCodec ff_targa_encoder
Definition: targaenc.c:208
TGA_BW
@ TGA_BW
Definition: targa.h:37
AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE
#define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE
This encoder can reorder user opaque values from input AVFrames and return them with corresponding ou...
Definition: codec.h:159
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:40
TargaContext::rle
int rle
Definition: targaenc.c:39
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:296
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:75
NULL
#define NULL
Definition: coverity.c:32
targa_encode_init
static av_cold int targa_encode_init(AVCodecContext *avctx)
Definition: targaenc.c:183
TargaContext
Definition: targa.c:28
AV_WL24
#define AV_WL24(p, d)
Definition: intreadwrite.h:460
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:237
AV_RN32
#define AV_RN32(p)
Definition: intreadwrite.h:360
options
Definition: swscale.c:42
AV_PIX_FMT_GRAY8
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:81
AV_CODEC_CAP_DR1
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() or get_encode_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:52
AVPacket::size
int size
Definition: packet.h:540
codec_internal.h
targa_encode_frame
static int targa_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *p, int *got_packet)
Definition: targaenc.c:87
AV_WL16
#define AV_WL16(p, v)
Definition: intreadwrite.h:408
av_image_get_buffer_size
int av_image_get_buffer_size(enum AVPixelFormat pix_fmt, int width, int height, int align)
Return the size in bytes of the amount of data required to store an image with the given parameters.
Definition: imgutils.c:466
AVCodecContext::bits_per_coded_sample
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:1578
AV_PIX_FMT_RGB555LE
@ AV_PIX_FMT_RGB555LE
packed RGB 5:5:5, 16bpp, (msb)1X 5R 5G 5B(lsb), little-endian, X=unused/undefined
Definition: pixfmt.h:115
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
internal.h
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:194
AVCodecContext::height
int height
Definition: avcodec.h:624
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:663
avcodec.h
AV_PIX_FMT_PAL8
@ AV_PIX_FMT_PAL8
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:84
ret
ret
Definition: filter_design.txt:187
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:80
ff_rle_encode
int ff_rle_encode(uint8_t *outbuf, int out_size, const uint8_t *ptr, int bpp, int w, int add_rep, int xor_rep, int add_raw, int xor_raw)
RLE compress the row, with maximum size of out_size.
Definition: rle.c:53
AVCodecContext
main external API structure.
Definition: avcodec.h:451
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:72
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Underlying C type is int.
Definition: opt.h:259
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
targa_encode_normal
static int targa_encode_normal(uint8_t *outbuf, const AVFrame *pic, int bpp, int w, int h)
Definition: targaenc.c:72
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:478
AVPacket
This structure stores compressed data.
Definition: packet.h:516
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:624
imgutils.h
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
Definition: frame.h:434
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
h
h
Definition: vp9dsp_template.c:2070
AV_CODEC_ID_TARGA
@ AV_CODEC_ID_TARGA
Definition: codec_id.h:145
ff_alloc_packet
int ff_alloc_packet(AVCodecContext *avctx, AVPacket *avpkt, int64_t size)
Check AVPacket size and allocate data.
Definition: encode.c:62
options
static const AVOption options[]
Definition: targaenc.c:195
av_get_pix_fmt_name
const char * av_get_pix_fmt_name(enum AVPixelFormat pix_fmt)
Return the short name for a pixel format, NULL in case pix_fmt is unknown.
Definition: pixdesc.c:3090