FFmpeg  4.0
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 "internal.h"
27 #include "sgi.h"
28 #include "rle.h"
29 
30 #define SGI_SINGLE_CHAN 2
31 #define SGI_MULTI_CHAN 3
32 
33 typedef struct SgiContext {
34  AVClass *class;
35 
36  int rle;
37 } SgiContext;
38 
40 {
41  if (avctx->width > 65535 || avctx->height > 65535) {
42  av_log(avctx, AV_LOG_ERROR,
43  "Unsupported resolution %dx%d.\n", avctx->width, avctx->height);
44  av_log(avctx, AV_LOG_ERROR, "SGI does not support resolutions above 65535x65535\n");
45  return AVERROR_INVALIDDATA;
46  }
47 
48  return 0;
49 }
50 
51 static int sgi_rle_encode(PutByteContext *pbc, const uint8_t *src,
52  int w, int bpp)
53 {
54  int val, count, x, start = bytestream2_tell_p(pbc);
55  void (*bytestream2_put)(PutByteContext *, unsigned int);
56 
57  if (bpp == 1)
58  bytestream2_put = bytestream2_put_byte;
59  else
60  bytestream2_put = bytestream2_put_be16;
61 
62  for (x = 0; x < w; x += count) {
63  /* see if we can encode the next set of pixels with RLE */
64  count = ff_rle_count_pixels(src, w - x, bpp, 1);
65  if (count > 1) {
66  if (bytestream2_get_bytes_left_p(pbc) < bpp * 2)
67  return AVERROR_INVALIDDATA;
68 
69  val = bpp == 1 ? *src : AV_RB16(src);
70  bytestream2_put(pbc, count);
71  bytestream2_put(pbc, val);
72  } else {
73  int i;
74  /* fall back on uncompressed */
75  count = ff_rle_count_pixels(src, w - x, bpp, 0);
76  if (bytestream2_get_bytes_left_p(pbc) < bpp * (count + 1))
77  return AVERROR_INVALIDDATA;
78 
79  bytestream2_put(pbc, count + 0x80);
80  for (i = 0; i < count; i++) {
81  val = bpp == 1 ? src[i] : AV_RB16(src + i * bpp);
82  bytestream2_put(pbc, val);
83  }
84  }
85 
86  src += count * bpp;
87  }
88 
89  return bytestream2_tell_p(pbc) - start;
90 }
91 
93  const AVFrame *frame, int *got_packet)
94 {
95  SgiContext *s = avctx->priv_data;
96  const AVFrame * const p = frame;
97  PutByteContext pbc;
98  uint8_t *in_buf, *encode_buf;
99  int x, y, z, length, tablesize, ret, i;
100  unsigned int width, height, depth, dimension;
101  unsigned int bytes_per_channel, pixmax, put_be;
102 
103 #if FF_API_CODED_FRAME
106  avctx->coded_frame->key_frame = 1;
108 #endif
109 
110 #if FF_API_CODER_TYPE
112  if (avctx->coder_type == FF_CODER_TYPE_RAW)
113  s->rle = 0;
115 #endif
116 
117  width = avctx->width;
118  height = avctx->height;
119  bytes_per_channel = 1;
120  pixmax = 0xFF;
121  put_be = HAVE_BIGENDIAN;
122 
123  switch (avctx->pix_fmt) {
124  case AV_PIX_FMT_GRAY8:
125  dimension = SGI_SINGLE_CHAN;
126  depth = SGI_GRAYSCALE;
127  break;
128  case AV_PIX_FMT_RGB24:
129  dimension = SGI_MULTI_CHAN;
130  depth = SGI_RGB;
131  break;
132  case AV_PIX_FMT_RGBA:
133  dimension = SGI_MULTI_CHAN;
134  depth = SGI_RGBA;
135  break;
136  case AV_PIX_FMT_GRAY16LE:
137  put_be = !HAVE_BIGENDIAN;
138  case AV_PIX_FMT_GRAY16BE:
139  bytes_per_channel = 2;
140  pixmax = 0xFFFF;
141  dimension = SGI_SINGLE_CHAN;
142  depth = SGI_GRAYSCALE;
143  break;
144  case AV_PIX_FMT_RGB48LE:
145  put_be = !HAVE_BIGENDIAN;
146  case AV_PIX_FMT_RGB48BE:
147  bytes_per_channel = 2;
148  pixmax = 0xFFFF;
149  dimension = SGI_MULTI_CHAN;
150  depth = SGI_RGB;
151  break;
152  case AV_PIX_FMT_RGBA64LE:
153  put_be = !HAVE_BIGENDIAN;
154  case AV_PIX_FMT_RGBA64BE:
155  bytes_per_channel = 2;
156  pixmax = 0xFFFF;
157  dimension = SGI_MULTI_CHAN;
158  depth = SGI_RGBA;
159  break;
160  default:
161  return AVERROR_INVALIDDATA;
162  }
163 
164  tablesize = depth * height * 4;
165  length = SGI_HEADER_SIZE;
166  if (!s->rle)
167  length += depth * height * width;
168  else // assume sgi_rle_encode() produces at most 2x size of input
169  length += tablesize * 2 + depth * height * (2 * width + 1);
170 
171  if ((ret = ff_alloc_packet2(avctx, pkt, bytes_per_channel * length, 0)) < 0)
172  return ret;
173 
174  bytestream2_init_writer(&pbc, pkt->data, pkt->size);
175 
176  /* Encode header. */
177  bytestream2_put_be16(&pbc, SGI_MAGIC);
178  bytestream2_put_byte(&pbc, s->rle); /* RLE 1 - VERBATIM 0 */
179  bytestream2_put_byte(&pbc, bytes_per_channel);
180  bytestream2_put_be16(&pbc, dimension);
181  bytestream2_put_be16(&pbc, width);
182  bytestream2_put_be16(&pbc, height);
183  bytestream2_put_be16(&pbc, depth);
184 
185  bytestream2_put_be32(&pbc, 0L); /* pixmin */
186  bytestream2_put_be32(&pbc, pixmax);
187  bytestream2_put_be32(&pbc, 0L); /* dummy */
188 
189  /* name */
190  for (i = 0; i < 80; i++)
191  bytestream2_put_byte(&pbc, 0L);
192 
193  /* colormap */
194  bytestream2_put_be32(&pbc, 0L);
195 
196  /* The rest of the 512 byte header is unused. */
197  for (i = 0; i < 404; i++)
198  bytestream2_put_byte(&pbc, 0L);
199 
200  if (s->rle) {
201  PutByteContext taboff_pcb, tablen_pcb;
202 
203  /* Skip RLE offset table. */
204  bytestream2_init_writer(&taboff_pcb, pbc.buffer, tablesize);
205  bytestream2_skip_p(&pbc, tablesize);
206 
207  /* Skip RLE length table. */
208  bytestream2_init_writer(&tablen_pcb, pbc.buffer, tablesize);
209  bytestream2_skip_p(&pbc, tablesize);
210 
211  /* Make an intermediate consecutive buffer. */
212  if (!(encode_buf = av_malloc(width * bytes_per_channel)))
213  return AVERROR(ENOMEM);
214 
215  for (z = 0; z < depth; z++) {
216  in_buf = p->data[0] + p->linesize[0] * (height - 1) + z * bytes_per_channel;
217 
218  for (y = 0; y < height; y++) {
219  bytestream2_put_be32(&taboff_pcb, bytestream2_tell_p(&pbc));
220 
221  for (x = 0; x < width * bytes_per_channel; x += bytes_per_channel)
222  encode_buf[x] = in_buf[depth * x];
223 
224  length = sgi_rle_encode(&pbc, encode_buf, width,
225  bytes_per_channel);
226  if (length < 1) {
227  av_free(encode_buf);
228  return AVERROR_INVALIDDATA;
229  }
230 
231  bytestream2_put_be32(&tablen_pcb, length);
232  in_buf -= p->linesize[0];
233  }
234  }
235 
236  av_free(encode_buf);
237  } else {
238  for (z = 0; z < depth; z++) {
239  in_buf = p->data[0] + p->linesize[0] * (height - 1) + z * bytes_per_channel;
240 
241  for (y = 0; y < height; y++) {
242  for (x = 0; x < width * depth; x += depth)
243  if (bytes_per_channel == 1)
244  bytestream2_put_byte(&pbc, in_buf[x]);
245  else
246  if (put_be)
247  bytestream2_put_be16(&pbc, ((uint16_t *)in_buf)[x]);
248  else
249  bytestream2_put_le16(&pbc, ((uint16_t *)in_buf)[x]);
250 
251  in_buf -= p->linesize[0];
252  }
253  }
254  }
255 
256  /* total length */
257  pkt->size = bytestream2_tell_p(&pbc);
258  pkt->flags |= AV_PKT_FLAG_KEY;
259  *got_packet = 1;
260 
261  return 0;
262 }
263 
264 #define OFFSET(x) offsetof(SgiContext, x)
265 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
266 static const AVOption options[] = {
267  { "rle", "Use run-length compression", OFFSET(rle), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, VE },
268 
269  { NULL },
270 };
271 
272 static const AVClass sgi_class = {
273  .class_name = "sgi",
274  .item_name = av_default_item_name,
275  .option = options,
276  .version = LIBAVUTIL_VERSION_INT,
277 };
278 
280  .name = "sgi",
281  .long_name = NULL_IF_CONFIG_SMALL("SGI image"),
282  .type = AVMEDIA_TYPE_VIDEO,
283  .id = AV_CODEC_ID_SGI,
284  .priv_data_size = sizeof(SgiContext),
285  .priv_class = &sgi_class,
286  .init = encode_init,
287  .encode2 = encode_frame,
288  .pix_fmts = (const enum AVPixelFormat[]) {
294  },
295 };
#define NULL
Definition: coverity.c:32
const char const char void * val
Definition: avisynth_c.h:771
const char * s
Definition: avisynth_c.h:768
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
static const AVClass sgi_class
Definition: sgienc.c:272
This structure describes decoded (raw) audio or video data.
Definition: frame.h:218
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:27
AVOption.
Definition: opt.h:246
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:64
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
int size
Definition: avcodec.h:1431
static av_always_inline void bytestream2_init_writer(PutByteContext *p, uint8_t *buf, int buf_size)
Definition: bytestream.h:143
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:191
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1727
static AVPacket pkt
#define src
Definition: vp8dsp.c:254
AVCodec.
Definition: avcodec.h:3408
static const AVOption options[]
Definition: sgienc.c:266
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:72
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size)
Check AVPacket size and/or allocate data.
Definition: encode.c:32
#define SGI_MULTI_CHAN
Definition: sgienc.c:31
uint8_t
#define av_cold
Definition: attributes.h:82
#define av_malloc(s)
AVOptions.
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:99
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:201
static AVFrame * frame
#define height
static int encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
Definition: sgienc.c:92
uint8_t * data
Definition: avcodec.h:1430
int rle
Definition: sgienc.c:36
#define av_log(a,...)
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1462
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
static av_always_inline unsigned int bytestream2_get_bytes_left_p(PutByteContext *p)
Definition: bytestream.h:159
#define AV_RB16
Definition: intreadwrite.h:53
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
uint16_t width
Definition: gdv.c:47
const char * name
Name of the codec implementation.
Definition: avcodec.h:3415
static av_always_inline int bytestream2_tell_p(PutByteContext *p)
Definition: bytestream.h:193
packed RGBA 8:8:8:8, 32bpp, RGBARGBA...
Definition: pixfmt.h:89
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1436
#define SGI_RGBA
Definition: sgi.h:34
static av_always_inline void bytestream2_skip_p(PutByteContext *p, unsigned int size)
Definition: bytestream.h:176
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:301
int width
picture width / height.
Definition: avcodec.h:1690
uint8_t w
Definition: llviddspenc.c:38
AVCodec ff_sgi_encoder
Definition: sgienc.c:279
static av_cold int encode_init(AVCodecContext *avctx)
Definition: sgienc.c:39
#define L(x)
Definition: vp56_arith.h:36
attribute_deprecated int coder_type
Definition: avcodec.h:2430
uint8_t * buffer
Definition: bytestream.h:38
Libavcodec external API header.
typedef void(RENAME(mix_any_func_type))
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:249
main external API structure.
Definition: avcodec.h:1518
#define SGI_HEADER_SIZE
Definition: sgi.h:30
Describe the class of an AVClass context structure.
Definition: log.h:67
Y , 16bpp, big-endian.
Definition: pixfmt.h:93
#define SGI_GRAYSCALE
Definition: sgi.h:32
#define VE
Definition: sgienc.c:265
#define SGI_RGB
Definition: sgi.h:33
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:266
static int sgi_rle_encode(PutByteContext *pbc, const uint8_t *src, int w, int bpp)
Definition: sgienc.c:51
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:232
#define SGI_SINGLE_CHAN
Definition: sgienc.c:30
#define OFFSET(x)
Definition: sgienc.c:264
#define SGI_MAGIC
SGI image file signature.
Definition: sgi.h:28
int
Y , 8bpp.
Definition: pixfmt.h:70
#define FF_DISABLE_DEPRECATION_WARNINGS
Definition: internal.h:84
common internal api header.
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:98
#define FF_CODER_TYPE_RAW
Definition: avcodec.h:2424
attribute_deprecated AVFrame * coded_frame
the picture in the bitstream
Definition: avcodec.h:2760
void * priv_data
Definition: avcodec.h:1545
#define av_free(p)
#define FF_ENABLE_DEPRECATION_WARNINGS
Definition: internal.h:85
Y , 16bpp, little-endian.
Definition: pixfmt.h:94
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:296
void INT64 INT64 count
Definition: avisynth_c.h:690
void INT64 start
Definition: avisynth_c.h:690
const char int length
Definition: avisynth_c.h:768
#define HAVE_BIGENDIAN
Definition: config.h:196
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60
This structure stores compressed data.
Definition: avcodec.h:1407
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:202