FFmpeg
sgienc.c
Go to the documentation of this file.
1 /*
2  * SGI image encoder
3  * Todd Kirby <doubleshot@pacbell.net>
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 "libavutil/opt.h"
23 
24 #include "avcodec.h"
25 #include "bytestream.h"
26 #include "encode.h"
27 #include "internal.h"
28 #include "sgi.h"
29 #include "rle.h"
30 
31 #define SGI_SINGLE_CHAN 2
32 #define SGI_MULTI_CHAN 3
33 
34 typedef struct SgiContext {
35  AVClass *class;
36 
37  int rle;
38 } SgiContext;
39 
41 {
42  if (avctx->width > 65535 || avctx->height > 65535) {
43  av_log(avctx, AV_LOG_ERROR, "Unsupported resolution %dx%d. "
44  "SGI does not support resolutions above 65535x65535\n",
45  avctx->width, avctx->height);
46  return AVERROR_INVALIDDATA;
47  }
48 
49  return 0;
50 }
51 
52 static int sgi_rle_encode(PutByteContext *pbc, const uint8_t *src,
53  int w, int bpp)
54 {
55  int val, count, x, start = bytestream2_tell_p(pbc);
56  void (*bytestream2_put)(PutByteContext *, unsigned int);
57 
58  if (bpp == 1)
59  bytestream2_put = bytestream2_put_byte;
60  else
61  bytestream2_put = bytestream2_put_be16;
62 
63  for (x = 0; x < w; x += count) {
64  /* see if we can encode the next set of pixels with RLE */
65  count = ff_rle_count_pixels(src, w - x, bpp, 1);
66  if (count > 1) {
67  if (bytestream2_get_bytes_left_p(pbc) < bpp * 2)
68  return AVERROR_INVALIDDATA;
69 
70  val = bpp == 1 ? *src : AV_RB16(src);
71  bytestream2_put(pbc, count);
72  bytestream2_put(pbc, val);
73  } else {
74  int i;
75  /* fall back on uncompressed */
76  count = ff_rle_count_pixels(src, w - x, bpp, 0);
77  if (bytestream2_get_bytes_left_p(pbc) < bpp * (count + 1))
78  return AVERROR_INVALIDDATA;
79 
80  bytestream2_put(pbc, count + 0x80);
81  for (i = 0; i < count; i++) {
82  val = bpp == 1 ? src[i] : AV_RB16(src + i * bpp);
83  bytestream2_put(pbc, val);
84  }
85  }
86 
87  src += count * bpp;
88  }
89 
90  return bytestream2_tell_p(pbc) - start;
91 }
92 
94  const AVFrame *frame, int *got_packet)
95 {
96  SgiContext *s = avctx->priv_data;
97  const AVFrame * const p = frame;
98  PutByteContext pbc;
99  uint8_t *in_buf, *encode_buf;
100  int x, y, z, length, tablesize, ret, i;
101  unsigned int width, height, depth, dimension;
102  unsigned int bytes_per_channel, pixmax, put_be;
103 
104  width = avctx->width;
105  height = avctx->height;
106  bytes_per_channel = 1;
107  pixmax = 0xFF;
108  put_be = HAVE_BIGENDIAN;
109 
110  switch (avctx->pix_fmt) {
111  case AV_PIX_FMT_GRAY8:
113  depth = SGI_GRAYSCALE;
114  break;
115  case AV_PIX_FMT_RGB24:
117  depth = SGI_RGB;
118  break;
119  case AV_PIX_FMT_RGBA:
121  depth = SGI_RGBA;
122  break;
123  case AV_PIX_FMT_GRAY16LE:
124  put_be = !HAVE_BIGENDIAN;
125  case AV_PIX_FMT_GRAY16BE:
126  bytes_per_channel = 2;
127  pixmax = 0xFFFF;
129  depth = SGI_GRAYSCALE;
130  break;
131  case AV_PIX_FMT_RGB48LE:
132  put_be = !HAVE_BIGENDIAN;
133  case AV_PIX_FMT_RGB48BE:
134  bytes_per_channel = 2;
135  pixmax = 0xFFFF;
137  depth = SGI_RGB;
138  break;
139  case AV_PIX_FMT_RGBA64LE:
140  put_be = !HAVE_BIGENDIAN;
141  case AV_PIX_FMT_RGBA64BE:
142  bytes_per_channel = 2;
143  pixmax = 0xFFFF;
145  depth = SGI_RGBA;
146  break;
147  default:
148  return AVERROR_INVALIDDATA;
149  }
150 
151  tablesize = depth * height * 4;
152  length = SGI_HEADER_SIZE;
153  if (!s->rle)
154  length += depth * height * width;
155  else // assume sgi_rle_encode() produces at most 2x size of input
156  length += tablesize * 2 + depth * height * (2 * width + 1);
157 
158  if ((ret = ff_alloc_packet(avctx, pkt, bytes_per_channel * length)) < 0)
159  return ret;
160 
162 
163  /* Encode header. */
164  bytestream2_put_be16(&pbc, SGI_MAGIC);
165  bytestream2_put_byte(&pbc, s->rle); /* RLE 1 - VERBATIM 0 */
166  bytestream2_put_byte(&pbc, bytes_per_channel);
167  bytestream2_put_be16(&pbc, dimension);
168  bytestream2_put_be16(&pbc, width);
169  bytestream2_put_be16(&pbc, height);
170  bytestream2_put_be16(&pbc, depth);
171 
172  bytestream2_put_be32(&pbc, 0L); /* pixmin */
173  bytestream2_put_be32(&pbc, pixmax);
174  bytestream2_put_be32(&pbc, 0L); /* dummy */
175 
176  /* name */
177  for (i = 0; i < 80; i++)
178  bytestream2_put_byte(&pbc, 0L);
179 
180  /* colormap */
181  bytestream2_put_be32(&pbc, 0L);
182 
183  /* The rest of the 512 byte header is unused. */
184  for (i = 0; i < 404; i++)
185  bytestream2_put_byte(&pbc, 0L);
186 
187  if (s->rle) {
188  PutByteContext taboff_pcb, tablen_pcb;
189 
190  /* Skip RLE offset table. */
191  bytestream2_init_writer(&taboff_pcb, pbc.buffer, tablesize);
192  bytestream2_skip_p(&pbc, tablesize);
193 
194  /* Skip RLE length table. */
195  bytestream2_init_writer(&tablen_pcb, pbc.buffer, tablesize);
196  bytestream2_skip_p(&pbc, tablesize);
197 
198  /* Make an intermediate consecutive buffer. */
199  if (!(encode_buf = av_malloc(width * bytes_per_channel)))
200  return AVERROR(ENOMEM);
201 
202  for (z = 0; z < depth; z++) {
203  in_buf = p->data[0] + p->linesize[0] * (height - 1) + z * bytes_per_channel;
204 
205  for (y = 0; y < height; y++) {
206  bytestream2_put_be32(&taboff_pcb, bytestream2_tell_p(&pbc));
207 
208  for (x = 0; x < width * bytes_per_channel; x += bytes_per_channel)
209  if (bytes_per_channel == 1) {
210  encode_buf[x] = in_buf[depth * x];
211  } else if (HAVE_BIGENDIAN ^ put_be) {
212  encode_buf[x + 1] = in_buf[depth * x];
213  encode_buf[x] = in_buf[depth * x + 1];
214  } else {
215  encode_buf[x] = in_buf[depth * x];
216  encode_buf[x + 1] = in_buf[depth * x + 1];
217  }
218 
219  length = sgi_rle_encode(&pbc, encode_buf, width,
220  bytes_per_channel);
221  if (length < 1) {
222  av_free(encode_buf);
223  return AVERROR_INVALIDDATA;
224  }
225 
226  bytestream2_put_be32(&tablen_pcb, length);
227  in_buf -= p->linesize[0];
228  }
229  }
230 
231  av_free(encode_buf);
232  } else {
233  for (z = 0; z < depth; z++) {
234  in_buf = p->data[0] + p->linesize[0] * (height - 1) + z * bytes_per_channel;
235 
236  for (y = 0; y < height; y++) {
237  for (x = 0; x < width * depth; x += depth)
238  if (bytes_per_channel == 1)
239  bytestream2_put_byte(&pbc, in_buf[x]);
240  else
241  if (put_be)
242  bytestream2_put_be16(&pbc, ((uint16_t *)in_buf)[x]);
243  else
244  bytestream2_put_le16(&pbc, ((uint16_t *)in_buf)[x]);
245 
246  in_buf -= p->linesize[0];
247  }
248  }
249  }
250 
251  /* total length */
252  pkt->size = bytestream2_tell_p(&pbc);
254  *got_packet = 1;
255 
256  return 0;
257 }
258 
259 #define OFFSET(x) offsetof(SgiContext, x)
260 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
261 static const AVOption options[] = {
262  { "rle", "Use run-length compression", OFFSET(rle), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, VE },
263 
264  { NULL },
265 };
266 
267 static const AVClass sgi_class = {
268  .class_name = "sgi",
269  .item_name = av_default_item_name,
270  .option = options,
271  .version = LIBAVUTIL_VERSION_INT,
272 };
273 
275  .name = "sgi",
276  .long_name = NULL_IF_CONFIG_SMALL("SGI image"),
277  .type = AVMEDIA_TYPE_VIDEO,
278  .id = AV_CODEC_ID_SGI,
279  .priv_data_size = sizeof(SgiContext),
280  .priv_class = &sgi_class,
281  .init = encode_init,
282  .encode2 = encode_frame,
283  .pix_fmts = (const enum AVPixelFormat[]) {
289  },
290  .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,
291 };
AVCodec
AVCodec.
Definition: codec.h:197
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
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
rle.h
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
AV_PIX_FMT_RGBA64BE
@ AV_PIX_FMT_RGBA64BE
packed RGBA 16:16:16:16, 64bpp, 16R, 16G, 16B, 16A, the 2-byte value for each R/G/B/A component is st...
Definition: pixfmt.h:195
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
bytestream2_tell_p
static av_always_inline int bytestream2_tell_p(PutByteContext *p)
Definition: bytestream.h:197
AV_PKT_FLAG_KEY
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: packet.h:425
rle
static int rle(uint8_t *dst, const uint8_t *src, int compressed_size, int uncompressed_size)
Definition: exr.c:215
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:317
av_malloc
#define av_malloc(s)
Definition: tableprint_vlc.h:31
OFFSET
#define OFFSET(x)
Definition: sgienc.c:259
AV_PIX_FMT_GRAY16BE
@ AV_PIX_FMT_GRAY16BE
Y , 16bpp, big-endian.
Definition: pixfmt.h:97
val
static double val(void *priv, double ch)
Definition: aeval.c:76
encode_init
static av_cold int encode_init(AVCodecContext *avctx)
Definition: sgienc.c:40
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
bytestream2_get_bytes_left_p
static av_always_inline int bytestream2_get_bytes_left_p(PutByteContext *p)
Definition: bytestream.h:163
av_cold
#define av_cold
Definition: attributes.h:90
bytestream2_init_writer
static av_always_inline void bytestream2_init_writer(PutByteContext *p, uint8_t *buf, int buf_size)
Definition: bytestream.h:147
width
#define width
s
#define s(width, name)
Definition: cbs_vp9.c:257
options
static const AVOption options[]
Definition: sgienc.c:261
pix_fmts
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:290
sgi_class
static const AVClass sgi_class
Definition: sgienc.c:267
SGI_MAGIC
#define SGI_MAGIC
SGI image file signature.
Definition: sgi.h:28
SGI_SINGLE_CHAN
#define SGI_SINGLE_CHAN
Definition: sgienc.c:31
AV_PIX_FMT_RGBA
@ AV_PIX_FMT_RGBA
packed RGBA 8:8:8:8, 32bpp, RGBARGBA...
Definition: pixfmt.h:93
SGI_RGBA
#define SGI_RGBA
Definition: sgi.h:34
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
AV_PIX_FMT_RGB48LE
@ AV_PIX_FMT_RGB48LE
packed RGB 16:16:16, 48bpp, 16R, 16G, 16B, the 2-byte value for each R/G/B component is stored as lit...
Definition: pixfmt.h:103
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:235
AV_PIX_FMT_RGBA64LE
@ AV_PIX_FMT_RGBA64LE
packed RGBA 16:16:16:16, 64bpp, 16R, 16G, 16B, 16A, the 2-byte value for each R/G/B/A component is st...
Definition: pixfmt.h:196
src
#define src
Definition: vp8dsp.c:255
AV_PIX_FMT_GRAY8
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:74
SgiContext
Definition: sgienc.c:34
PutByteContext
Definition: bytestream.h:37
AV_PIX_FMT_RGB24
@ AV_PIX_FMT_RGB24
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:68
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
PutByteContext::buffer
uint8_t * buffer
Definition: bytestream.h:38
SgiContext::rle
int rle
Definition: sgienc.c:37
height
#define height
AVPacket::flags
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:379
encode_frame
static int encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
Definition: sgienc.c:93
sgi.h
SGI_RGB
#define SGI_RGB
Definition: sgi.h:33
i
int i
Definition: input.c:406
AV_PIX_FMT_RGB48BE
@ AV_PIX_FMT_RGB48BE
packed RGB 16:16:16, 48bpp, 16R, 16G, 16B, the 2-byte value for each R/G/B component is stored as big...
Definition: pixfmt.h:102
SGI_MULTI_CHAN
#define SGI_MULTI_CHAN
Definition: sgienc.c:32
ff_sgi_encoder
const AVCodec ff_sgi_encoder
Definition: sgienc.c:274
bytestream2_skip_p
static av_always_inline void bytestream2_skip_p(PutByteContext *p, unsigned int size)
Definition: bytestream.h:180
ff_rle_count_pixels
int ff_rle_count_pixels(const uint8_t *start, int len, int bpp, int same)
Count up to 127 consecutive pixels which are either all the same or all differ from the previous and ...
Definition: rle.c:28
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:204
AVCodecContext::height
int height
Definition: avcodec.h:552
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:589
avcodec.h
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
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
L
#define L(x)
Definition: vp56_arith.h:36
AVCodecContext
main external API structure.
Definition: avcodec.h:379
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
AV_PIX_FMT_GRAY16LE
@ AV_PIX_FMT_GRAY16LE
Y , 16bpp, little-endian.
Definition: pixfmt.h:98
SGI_HEADER_SIZE
#define SGI_HEADER_SIZE
Definition: sgi.h:30
av_free
#define av_free(p)
Definition: tableprint_vlc.h:34
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:406
AVPacket
This structure stores compressed data.
Definition: packet.h:350
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:552
bytestream.h
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:334
sgi_rle_encode
static int sgi_rle_encode(PutByteContext *pbc, const uint8_t *src, int w, int bpp)
Definition: sgienc.c:52
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
AV_CODEC_ID_SGI
@ AV_CODEC_ID_SGI
Definition: codec_id.h:151
dimension
The official guide to swscale for confused that consecutive non overlapping rectangles of dimension(0, slice_top) -(picture_width
SGI_GRAYSCALE
#define SGI_GRAYSCALE
Definition: sgi.h:32
int
int
Definition: ffmpeg_filter.c:156
ff_alloc_packet
int ff_alloc_packet(AVCodecContext *avctx, AVPacket *avpkt, int64_t size)
Check AVPacket size and allocate data.
Definition: encode.c:34
VE
#define VE
Definition: sgienc.c:260
AV_RB16
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_WB32 unsigned int_TMPL AV_WB24 unsigned int_TMPL AV_RB16
Definition: bytestream.h:98