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/imgutils.h"
25 #include "libavutil/internal.h"
26 #include "libavutil/intreadwrite.h"
27 #include "libavutil/opt.h"
28 #include "libavutil/pixdesc.h"
29 #include "avcodec.h"
30 #include "encode.h"
31 #include "internal.h"
32 #include "rle.h"
33 #include "targa.h"
34 
35 typedef struct TargaContext {
36  AVClass *class;
37 
38  int rle;
39 } TargaContext;
40 
41 /**
42  * RLE compress the image, with maximum size of out_size
43  * @param outbuf Output buffer
44  * @param out_size Maximum output size
45  * @param pic Image to compress
46  * @param bpp Bytes per pixel
47  * @param w Image width
48  * @param h Image height
49  * @return Size of output in bytes, or -1 if larger than out_size
50  */
51 static int targa_encode_rle(uint8_t *outbuf, int out_size, const AVFrame *pic,
52  int bpp, int w, int h)
53 {
54  int y,ret;
55  uint8_t *out;
56 
57  out = outbuf;
58 
59  for(y = 0; y < h; y ++) {
60  ret = ff_rle_encode(out, out_size, pic->data[0] + pic->linesize[0] * y, bpp, w, 0x7f, 0, -1, 0);
61  if(ret == -1){
62  return -1;
63  }
64  out+= ret;
65  out_size -= ret;
66  }
67 
68  return out - outbuf;
69 }
70 
71 static int targa_encode_normal(uint8_t *outbuf, const AVFrame *pic, int bpp, int w, int h)
72 {
73  int i, n = bpp * w;
74  uint8_t *out = outbuf;
75  uint8_t *ptr = pic->data[0];
76 
77  for(i=0; i < h; i++) {
78  memcpy(out, ptr, n);
79  out += n;
80  ptr += pic->linesize[0];
81  }
82 
83  return out - outbuf;
84 }
85 
87  const AVFrame *p, int *got_packet)
88 {
89  TargaContext *s = avctx->priv_data;
90  int bpp, picsize, datasize = -1, ret, i;
91  uint8_t *out;
92 
93  picsize = av_image_get_buffer_size(avctx->pix_fmt,
94  avctx->width, avctx->height, 1);
95  if ((ret = ff_alloc_packet(avctx, pkt, picsize + 45)) < 0)
96  return ret;
97 
98  /* zero out the header and only set applicable fields */
99  memset(pkt->data, 0, 12);
100  AV_WL16(pkt->data+12, avctx->width);
101  AV_WL16(pkt->data+14, avctx->height);
102  /* image descriptor byte: origin is always top-left, bits 0-3 specify alpha */
103  pkt->data[17] = 0x20 | (avctx->pix_fmt == AV_PIX_FMT_BGRA ? 8 : 0);
104 
105  out = pkt->data + 18; /* skip past the header we write */
106 
108  switch(avctx->pix_fmt) {
109  case AV_PIX_FMT_PAL8: {
110  int pal_bpp = 24; /* Only write 32bit palette if there is transparency information */
111  for (i = 0; i < 256; i++)
112  if (AV_RN32(p->data[1] + 4 * i) >> 24 != 0xFF) {
113  pal_bpp = 32;
114  break;
115  }
116  pkt->data[1] = 1; /* palette present */
117  pkt->data[2] = TGA_PAL; /* uncompressed palettised image */
118  pkt->data[6] = 1; /* palette contains 256 entries */
119  pkt->data[7] = pal_bpp; /* palette contains pal_bpp bit entries */
120  pkt->data[16] = 8; /* bpp */
121  for (i = 0; i < 256; i++)
122  if (pal_bpp == 32) {
123  AV_WL32(pkt->data + 18 + 4 * i, *(uint32_t *)(p->data[1] + i * 4));
124  } else {
125  AV_WL24(pkt->data + 18 + 3 * i, *(uint32_t *)(p->data[1] + i * 4));
126  }
127  out += 32 * pal_bpp; /* skip past the palette we just output */
128  break;
129  }
130  case AV_PIX_FMT_GRAY8:
131  pkt->data[2] = TGA_BW; /* uncompressed grayscale image */
132  avctx->bits_per_coded_sample = 0x28;
133  pkt->data[16] = 8; /* bpp */
134  break;
135  case AV_PIX_FMT_RGB555LE:
136  pkt->data[2] = TGA_RGB; /* uncompressed true-color image */
137  avctx->bits_per_coded_sample =
138  pkt->data[16] = 16; /* bpp */
139  break;
140  case AV_PIX_FMT_BGR24:
141  pkt->data[2] = TGA_RGB; /* uncompressed true-color image */
142  pkt->data[16] = 24; /* bpp */
143  break;
144  case AV_PIX_FMT_BGRA:
145  pkt->data[2] = TGA_RGB; /* uncompressed true-color image */
146  pkt->data[16] = 32; /* bpp */
147  break;
148  default:
149  av_log(avctx, AV_LOG_ERROR, "Pixel format '%s' not supported.\n",
150  av_get_pix_fmt_name(avctx->pix_fmt));
151  return AVERROR(EINVAL);
152  }
153  bpp = pkt->data[16] >> 3;
154 
155 
156  /* try RLE compression */
157  if (s->rle)
158  datasize = targa_encode_rle(out, picsize, p, bpp, avctx->width, avctx->height);
159 
160  /* if that worked well, mark the picture as RLE compressed */
161  if(datasize >= 0)
162  pkt->data[2] |= TGA_RLE;
163 
164  /* if RLE didn't make it smaller, go back to no compression */
165  else datasize = targa_encode_normal(out, p, bpp, avctx->width, avctx->height);
166 
167  out += datasize;
168 
169  /* The standard recommends including this section, even if we don't use
170  * any of the features it affords. TODO: take advantage of the pixel
171  * aspect ratio and encoder ID fields available? */
172  memcpy(out, "\0\0\0\0\0\0\0\0TRUEVISION-XFILE.", 26);
173 
174  pkt->size = out + 26 - pkt->data;
175  *got_packet = 1;
176 
177  return 0;
178 }
179 
181 {
182  if (avctx->width > 0xffff || avctx->height > 0xffff) {
183  av_log(avctx, AV_LOG_ERROR, "image dimensions too large\n");
184  return AVERROR(EINVAL);
185  }
186 
187  return 0;
188 }
189 
190 #define OFFSET(x) offsetof(TargaContext, x)
191 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
192 static const AVOption options[] = {
193  { "rle", "Use run-length compression", OFFSET(rle), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, VE },
194 
195  { NULL },
196 };
197 
198 static const AVClass targa_class = {
199  .class_name = "targa",
200  .item_name = av_default_item_name,
201  .option = options,
202  .version = LIBAVUTIL_VERSION_INT,
203 };
204 
206  .name = "targa",
207  .long_name = NULL_IF_CONFIG_SMALL("Truevision Targa image"),
208  .type = AVMEDIA_TYPE_VIDEO,
209  .id = AV_CODEC_ID_TARGA,
210  .priv_data_size = sizeof(TargaContext),
211  .priv_class = &targa_class,
213  .encode2 = targa_encode_frame,
214  .pix_fmts = (const enum AVPixelFormat[]){
217  },
218  .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,
219 };
AVCodec
AVCodec.
Definition: codec.h:202
FF_CODEC_CAP_INIT_THREADSAFE
#define FF_CODEC_CAP_INIT_THREADSAFE
The codec does not modify any global variables in the init function, allowing to call the init functi...
Definition: internal.h:42
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
TGA_RGB
@ TGA_RGB
Definition: targa.h:36
init
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:31
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:198
AV_WL32
#define AV_WL32(p, v)
Definition: intreadwrite.h:426
rle.h
out
FILE * out
Definition: movenc.c:54
OFFSET
#define OFFSET(x)
Definition: targaenc.c:190
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2564
out_size
int out_size
Definition: movenc.c:55
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
pixdesc.h
w
uint8_t w
Definition: llviddspenc.c:38
internal.h
AVPacket::data
uint8_t * data
Definition: packet.h:373
AVOption
AVOption.
Definition: opt.h:247
encode.h
ff_targa_encoder
const AVCodec ff_targa_encoder
Definition: targaenc.c:205
AV_PIX_FMT_BGR24
@ AV_PIX_FMT_BGR24
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:69
AV_PIX_FMT_BGRA
@ AV_PIX_FMT_BGRA
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:95
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:2516
targa.h
rle
static int rle(uint8_t *dst, const uint8_t *src, int compressed_size, int uncompressed_size)
Definition: exr.c:215
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:317
VE
#define VE
Definition: targaenc.c:191
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:51
pkt
AVPacket * pkt
Definition: movenc.c:59
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
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:257
TGA_BW
@ TGA_BW
Definition: targa.h:37
pix_fmts
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:290
TargaContext::rle
int rle
Definition: targaenc.c:38
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
targa_encode_init
static av_cold int targa_encode_init(AVCodecContext *avctx)
Definition: targaenc.c:180
TargaContext
Definition: targa.c:29
AV_WL24
#define AV_WL24(p, d)
Definition: intreadwrite.h:464
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:235
AV_RN32
#define AV_RN32(p)
Definition: intreadwrite.h:364
AV_PIX_FMT_GRAY8
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:74
AVPacket::size
int size
Definition: packet.h:374
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
targa_encode_frame
static int targa_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *p, int *got_packet)
Definition: targaenc.c:86
AV_WL16
#define AV_WL16(p, v)
Definition: intreadwrite.h:412
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:1418
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:108
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:271
internal.h
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:209
AVCodecContext::height
int height
Definition: avcodec.h:556
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:593
avcodec.h
AV_PIX_FMT_PAL8
@ AV_PIX_FMT_PAL8
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:77
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:71
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:383
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
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:71
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:410
AVPacket
This structure stores compressed data.
Definition: packet.h:350
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:556
imgutils.h
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:334
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
h
h
Definition: vp9dsp_template.c:2038
AV_CODEC_ID_TARGA
@ AV_CODEC_ID_TARGA
Definition: codec_id.h:143
ff_alloc_packet
int ff_alloc_packet(AVCodecContext *avctx, AVPacket *avpkt, int64_t size)
Check AVPacket size and allocate data.
Definition: encode.c:34
options
static const AVOption options[]
Definition: targaenc.c:192
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:2484