FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
sunrastenc.c
Go to the documentation of this file.
1 /*
2  * Sun Rasterfile (.sun/.ras/im{1,8,24}/.sunras) image encoder
3  * Copyright (c) 2012 Aneesh Dogra (lionaneesh) <lionaneesh@gmail.com>
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 "sunrast.h"
28 
29 typedef struct SUNRASTContext {
30  AVClass *class;
31 
33  int depth; ///< depth of pixel
34  int length; ///< length (bytes) of image
35  int type; ///< type of file
36  int maptype; ///< type of colormap
37  int maplength; ///< length (bytes) of colormap
38  int size;
40 
42 {
43  SUNRASTContext *s = avctx->priv_data;
44 
45  bytestream2_put_be32u(&s->p, RAS_MAGIC);
46  bytestream2_put_be32u(&s->p, avctx->width);
47  bytestream2_put_be32u(&s->p, avctx->height);
48  bytestream2_put_be32u(&s->p, s->depth);
49  bytestream2_put_be32u(&s->p, s->length);
50  bytestream2_put_be32u(&s->p, s->type);
51  bytestream2_put_be32u(&s->p, s->maptype);
52  bytestream2_put_be32u(&s->p, s->maplength);
53 }
54 
56  const uint8_t *pixels,
57  const uint32_t *palette_data,
58  int linesize)
59 {
60  SUNRASTContext *s = avctx->priv_data;
61  const uint8_t *ptr;
62  int len, alen, x, y;
63 
64  if (s->maplength) { // palettized
65  PutByteContext pb_r, pb_g;
66  int len = s->maplength / 3;
67 
68  pb_r = s->p;
69  bytestream2_skip_p(&s->p, len);
70  pb_g = s->p;
71  bytestream2_skip_p(&s->p, len);
72 
73  for (x = 0; x < len; x++) {
74  uint32_t pixel = palette_data[x];
75 
76  bytestream2_put_byteu(&pb_r, (pixel >> 16) & 0xFF);
77  bytestream2_put_byteu(&pb_g, (pixel >> 8) & 0xFF);
78  bytestream2_put_byteu(&s->p, pixel & 0xFF);
79  }
80  }
81 
82  len = (s->depth * avctx->width + 7) >> 3;
83  alen = len + (len & 1);
84  ptr = pixels;
85 
86  if (s->type == RT_BYTE_ENCODED) {
87  uint8_t value, value2;
88  int run;
89 
90  ptr = pixels;
91 
92 #define GET_VALUE y >= avctx->height ? 0 : x >= len ? ptr[len-1] : ptr[x]
93 
94  x = 0, y = 0;
95  value2 = GET_VALUE;
96  while (y < avctx->height) {
97  run = 1;
98  value = value2;
99  x++;
100  if (x >= alen) {
101  x = 0;
102  ptr += linesize, y++;
103  }
104 
105  value2 = GET_VALUE;
106  while (value2 == value && run < 256 && y < avctx->height) {
107  x++;
108  run++;
109  if (x >= alen) {
110  x = 0;
111  ptr += linesize, y++;
112  }
113  value2 = GET_VALUE;
114  }
115 
116  if (run > 2 || value == RLE_TRIGGER) {
117  bytestream2_put_byteu(&s->p, RLE_TRIGGER);
118  bytestream2_put_byteu(&s->p, run - 1);
119  if (run > 1)
120  bytestream2_put_byteu(&s->p, value);
121  } else if (run == 1) {
122  bytestream2_put_byteu(&s->p, value);
123  } else
124  bytestream2_put_be16u(&s->p, (value << 8) | value);
125  }
126 
127  // update data length for header
128  s->length = bytestream2_tell_p(&s->p) - 32 - s->maplength;
129  } else {
130  for (y = 0; y < avctx->height; y++) {
131  bytestream2_put_buffer(&s->p, ptr, len);
132  if (len < alen)
133  bytestream2_put_byteu(&s->p, 0);
134  ptr += linesize;
135  }
136  }
137 }
138 
140 {
141  SUNRASTContext *s = avctx->priv_data;
142 
143 #if FF_API_CODER_TYPE
145  switch (avctx->coder_type) {
146  case FF_CODER_TYPE_RLE:
147  s->type = RT_BYTE_ENCODED;
148  break;
149  case FF_CODER_TYPE_RAW:
150  s->type = RT_STANDARD;
151  break;
152  default:
153  av_log(avctx, AV_LOG_ERROR, "invalid coder_type\n");
154  return AVERROR(EINVAL);
155  }
157  if (s->type != RT_BYTE_ENCODED && s->type != RT_STANDARD)
158 #endif
159  // adjust boolean option to RT equivalent
160  s->type++;
161 
162  s->maptype = RMT_NONE;
163  s->maplength = 0;
164 
165  switch (avctx->pix_fmt) {
167  s->depth = 1;
168  break;
169  case AV_PIX_FMT_PAL8 :
170  s->maptype = RMT_EQUAL_RGB;
171  s->maplength = 3 * 256;
172  /* fall-through */
173  case AV_PIX_FMT_GRAY8:
174  s->depth = 8;
175  break;
176  case AV_PIX_FMT_BGR24:
177  s->depth = 24;
178  break;
179  default:
180  return AVERROR_BUG;
181  }
182  s->length = avctx->height * (FFALIGN(avctx->width * s->depth, 16) >> 3);
183  s->size = 32 + s->maplength + s->length * s->type;
184 
185  return 0;
186 }
187 
188 static int sunrast_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
189  const AVFrame *frame, int *got_packet_ptr)
190 {
191  SUNRASTContext *s = avctx->priv_data;
192  int ret;
193 
194  if ((ret = ff_alloc_packet2(avctx, avpkt, s->size, 0)) < 0)
195  return ret;
196 
197  bytestream2_init_writer(&s->p, avpkt->data, avpkt->size);
199  sunrast_image_write_image(avctx, frame->data[0],
200  (const uint32_t *)frame->data[1],
201  frame->linesize[0]);
202  // update data length in header after RLE
203  if (s->type == RT_BYTE_ENCODED)
204  AV_WB32(&avpkt->data[16], s->length);
205 
206  *got_packet_ptr = 1;
207  avpkt->flags |= AV_PKT_FLAG_KEY;
208  avpkt->size = bytestream2_tell_p(&s->p);
209  return 0;
210 }
211 
212 #define OFFSET(x) offsetof(SUNRASTContext, x)
213 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
214 static const AVOption options[] = {
215  { "rle", "Use run-length compression", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, VE },
216 
217  { NULL },
218 };
219 
220 static const AVClass sunrast_class = {
221  .class_name = "sunrast",
222  .item_name = av_default_item_name,
223  .option = options,
224  .version = LIBAVUTIL_VERSION_INT,
225 };
226 
227 #if FF_API_CODER_TYPE
229  { "coder", "rle" },
230  { NULL },
231 };
232 #endif
233 
235  .name = "sunrast",
236  .long_name = NULL_IF_CONFIG_SMALL("Sun Rasterfile image"),
237  .type = AVMEDIA_TYPE_VIDEO,
238  .id = AV_CODEC_ID_SUNRAST,
239  .priv_data_size = sizeof(SUNRASTContext),
241  .encode2 = sunrast_encode_frame,
243  .defaults = sunrast_defaults,
244 #endif
245  .priv_class = &sunrast_class,
246  .pix_fmts = (const enum AVPixelFormat[]){ AV_PIX_FMT_BGR24,
250  AV_PIX_FMT_NONE },
251 };
#define RMT_EQUAL_RGB
Definition: sunrast.h:28
#define NULL
Definition: coverity.c:32
const char * s
Definition: avisynth_c.h:768
This structure describes decoded (raw) audio or video data.
Definition: frame.h:184
AVOption.
Definition: opt.h:245
static const AVCodecDefault sunrast_defaults[]
Definition: sunrastenc.c:228
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
int size
Definition: avcodec.h:1601
static av_always_inline void bytestream2_init_writer(PutByteContext *p, uint8_t *buf, int buf_size)
Definition: bytestream.h:143
#define VE
Definition: sunrastenc.c:213
#define FF_API_CODER_TYPE
Definition: version.h:206
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1903
int length
length (bytes) of image
Definition: sunrastenc.c:34
uint8_t run
Definition: svq3.c:206
AVCodec.
Definition: avcodec.h:3589
static int sunrast_encode_frame(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Definition: sunrastenc.c:188
int depth
depth of pixel
Definition: sunrastenc.c:33
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
uint8_t
#define av_cold
Definition: attributes.h:82
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:73
AVOptions.
PutByteContext p
Definition: sunrastenc.c:32
static AVFrame * frame
#define height
uint8_t * data
Definition: avcodec.h:1600
#define RT_STANDARD
Definition: sunrast.h:34
int maplength
length (bytes) of colormap
Definition: sunrastenc.c:37
#define FFALIGN(x, a)
Definition: macros.h:48
#define av_log(a,...)
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1632
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
av_default_item_name
#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:176
int maptype
type of colormap
Definition: sunrastenc.c:36
const char * name
Name of the codec implementation.
Definition: avcodec.h:3596
static av_always_inline int bytestream2_tell_p(PutByteContext *p)
Definition: bytestream.h:193
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1606
#define RLE_TRIGGER
Definition: sunrast.h:39
static av_always_inline void bytestream2_skip_p(PutByteContext *p, unsigned int size)
Definition: bytestream.h:176
int width
picture width / height.
Definition: avcodec.h:1862
GLsizei GLboolean const GLfloat * value
Definition: opengl_enc.c:109
static const AVOption options[]
Definition: sunrastenc.c:214
int type
type of file
Definition: sunrastenc.c:35
#define RMT_NONE
Definition: sunrast.h:27
AVCodec ff_sunrast_encoder
Definition: sunrastenc.c:234
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:65
static av_always_inline unsigned int bytestream2_put_buffer(PutByteContext *p, const uint8_t *src, unsigned int size)
Definition: bytestream.h:282
attribute_deprecated int coder_type
Definition: avcodec.h:2728
Libavcodec external API header.
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:215
main external API structure.
Definition: avcodec.h:1675
GLint GLenum type
Definition: opengl_enc.c:105
static void sunrast_image_write_image(AVCodecContext *avctx, const uint8_t *pixels, const uint32_t *palette_data, int linesize)
Definition: sunrastenc.c:55
#define AVERROR_BUG
Internal bug, also see AVERROR_BUG2.
Definition: error.h:50
Describe the class of an AVClass context structure.
Definition: log.h:67
#define AV_WB32(p, v)
Definition: intreadwrite.h:419
static void sunrast_image_write_header(AVCodecContext *avctx)
Definition: sunrastenc.c:41
static av_cold int sunrast_encode_init(AVCodecContext *avctx)
Definition: sunrastenc.c:139
#define RT_BYTE_ENCODED
Definition: sunrast.h:38
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size)
Check AVPacket size and/or allocate data.
Definition: utils.c:1695
#define OFFSET(x)
Definition: sunrastenc.c:212
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:262
uint8_t pixel
Definition: tiny_ssim.c:42
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:198
Y , 8bpp.
Definition: pixfmt.h:70
#define FF_DISABLE_DEPRECATION_WARNINGS
Definition: internal.h:80
common internal api header.
Y , 1bpp, 0 is white, 1 is black, in each byte pixels are ordered from the msb to the lsb...
Definition: pixfmt.h:71
#define FF_CODER_TYPE_RAW
Definition: avcodec.h:2719
void * priv_data
Definition: avcodec.h:1717
int pixels
Definition: avisynth_c.h:429
#define FF_ENABLE_DEPRECATION_WARNINGS
Definition: internal.h:81
int len
#define FF_CODER_TYPE_RLE
Definition: avcodec.h:2720
static const AVClass sunrast_class
Definition: sunrastenc.c:220
#define RAS_MAGIC
Definition: sunrast.h:25
static const AVCodecDefault defaults[]
Definition: dcaenc.c:975
#define GET_VALUE
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60
This structure stores compressed data.
Definition: avcodec.h:1577