FFmpeg
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/attributes.h"
23 #include "libavutil/opt.h"
24 
25 #include "avcodec.h"
26 #include "bytestream.h"
27 #include "codec_internal.h"
28 #include "encode.h"
29 #include "sunrast.h"
30 
31 typedef struct SUNRASTContext {
32  AVClass *class;
33 
35  int depth; ///< depth of pixel
36  int length; ///< length (bytes) of image
37  int type; ///< type of file
38  int maptype; ///< type of colormap
39  int maplength; ///< length (bytes) of colormap
40  int size;
42 
44 {
45  SUNRASTContext *s = avctx->priv_data;
46 
47  bytestream2_put_be32u(&s->p, RAS_MAGIC);
48  bytestream2_put_be32u(&s->p, avctx->width);
49  bytestream2_put_be32u(&s->p, avctx->height);
50  bytestream2_put_be32u(&s->p, s->depth);
51  bytestream2_put_be32u(&s->p, s->length);
52  bytestream2_put_be32u(&s->p, s->type);
53  bytestream2_put_be32u(&s->p, s->maptype);
54  bytestream2_put_be32u(&s->p, s->maplength);
55 }
56 
58  const uint8_t *pixels,
59  const uint32_t *palette_data,
60  int linesize)
61 {
62  SUNRASTContext *s = avctx->priv_data;
63  const uint8_t *ptr;
64  int len, alen, x, y;
65 
66  if (s->maplength) { // palettized
67  PutByteContext pb_r, pb_g;
68  int len = s->maplength / 3;
69 
70  pb_r = s->p;
71  bytestream2_skip_p(&s->p, len);
72  pb_g = s->p;
73  bytestream2_skip_p(&s->p, len);
74 
75  for (x = 0; x < len; x++) {
76  uint32_t pixel = palette_data[x];
77 
78  bytestream2_put_byteu(&pb_r, (pixel >> 16) & 0xFF);
79  bytestream2_put_byteu(&pb_g, (pixel >> 8) & 0xFF);
80  bytestream2_put_byteu(&s->p, pixel & 0xFF);
81  }
82  }
83 
84  len = (s->depth * avctx->width + 7) >> 3;
85  alen = len + (len & 1);
86  ptr = pixels;
87 
88  if (s->type == RT_BYTE_ENCODED) {
89  uint8_t value, value2;
90  int run;
91 
92  ptr = pixels;
93 
94 #define GET_VALUE y >= avctx->height ? 0 : x >= len ? ptr[len-1] : ptr[x]
95 
96  x = 0, y = 0;
97  value2 = GET_VALUE;
98  while (y < avctx->height) {
99  run = 1;
100  value = value2;
101  x++;
102  if (x >= alen) {
103  x = 0;
104  ptr += linesize, y++;
105  }
106 
107  value2 = GET_VALUE;
108  while (value2 == value && run < 256 && y < avctx->height) {
109  x++;
110  run++;
111  if (x >= alen) {
112  x = 0;
113  ptr += linesize, y++;
114  }
115  value2 = GET_VALUE;
116  }
117 
118  if (run > 2 || value == RLE_TRIGGER) {
119  bytestream2_put_byteu(&s->p, RLE_TRIGGER);
120  bytestream2_put_byteu(&s->p, run - 1);
121  if (run > 1)
122  bytestream2_put_byteu(&s->p, value);
123  } else if (run == 1) {
124  bytestream2_put_byteu(&s->p, value);
125  } else
126  bytestream2_put_be16u(&s->p, (value << 8) | value);
127  }
128 
129  // update data length for header
130  s->length = bytestream2_tell_p(&s->p) - 32 - s->maplength;
131  } else {
132  for (y = 0; y < avctx->height; y++) {
133  bytestream2_put_buffer(&s->p, ptr, len);
134  if (len < alen)
135  bytestream2_put_byteu(&s->p, 0);
136  ptr += linesize;
137  }
138  }
139 }
140 
142 {
143  SUNRASTContext *s = avctx->priv_data;
144 
145  // adjust boolean option to RT equivalent
146  s->type++;
147 
148  s->maptype = RMT_NONE;
149  s->maplength = 0;
150 
151  switch (avctx->pix_fmt) {
153  s->depth = 1;
154  break;
155  case AV_PIX_FMT_PAL8 :
156  s->maptype = RMT_EQUAL_RGB;
157  s->maplength = 3 * 256;
159  case AV_PIX_FMT_GRAY8:
160  s->depth = 8;
161  break;
162  case AV_PIX_FMT_BGR24:
163  s->depth = 24;
164  break;
165  default:
166  return AVERROR_BUG;
167  }
168  s->length = avctx->height * (FFALIGN(avctx->width * s->depth, 16) >> 3);
169  s->size = 32 + s->maplength + s->length * s->type;
170 
171  return 0;
172 }
173 
174 static int sunrast_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
175  const AVFrame *frame, int *got_packet_ptr)
176 {
177  SUNRASTContext *s = avctx->priv_data;
178  int ret;
179 
180  if ((ret = ff_alloc_packet(avctx, avpkt, s->size)) < 0)
181  return ret;
182 
183  bytestream2_init_writer(&s->p, avpkt->data, avpkt->size);
185  sunrast_image_write_image(avctx, frame->data[0],
186  (const uint32_t *)frame->data[1],
187  frame->linesize[0]);
188  // update data length in header after RLE
189  if (s->type == RT_BYTE_ENCODED)
190  AV_WB32(&avpkt->data[16], s->length);
191 
192  *got_packet_ptr = 1;
193  avpkt->size = bytestream2_tell_p(&s->p);
194  return 0;
195 }
196 
197 #define OFFSET(x) offsetof(SUNRASTContext, x)
198 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
199 static const AVOption options[] = {
200  { "rle", "Use run-length compression", OFFSET(type), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, 1, VE },
201 
202  { NULL },
203 };
204 
205 static const AVClass sunrast_class = {
206  .class_name = "sunrast",
207  .item_name = av_default_item_name,
208  .option = options,
209  .version = LIBAVUTIL_VERSION_INT,
210 };
211 
213  .p.name = "sunrast",
214  CODEC_LONG_NAME("Sun Rasterfile image"),
215  .p.type = AVMEDIA_TYPE_VIDEO,
216  .p.id = AV_CODEC_ID_SUNRAST,
218  .priv_data_size = sizeof(SUNRASTContext),
221  .p.priv_class = &sunrast_class,
226 };
CODEC_PIXFMTS
#define CODEC_PIXFMTS(...)
Definition: codec_internal.h:392
SUNRASTContext::p
PutByteContext p
Definition: sunrastenc.c:34
opt.h
RMT_EQUAL_RGB
#define RMT_EQUAL_RGB
Definition: sunrast.h:28
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:435
ff_sunrast_encoder
const FFCodec ff_sunrast_encoder
Definition: sunrastenc.c:212
SUNRASTContext::length
int length
length (bytes) of image
Definition: sunrastenc.c:36
AVPacket::data
uint8_t * data
Definition: packet.h:595
AVOption
AVOption.
Definition: opt.h:429
encode.h
AV_PIX_FMT_MONOWHITE
@ AV_PIX_FMT_MONOWHITE
Y , 1bpp, 0 is white, 1 is black, in each byte pixels are ordered from the msb to the lsb.
Definition: pixfmt.h:82
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
sunrast_image_write_header
static void sunrast_image_write_header(AVCodecContext *avctx)
Definition: sunrastenc.c:43
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:131
options
static const AVOption options[]
Definition: sunrastenc.c:199
SUNRASTContext::type
int type
type of file
Definition: sunrastenc.c:37
type
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf type
Definition: writing_filters.txt:86
FF_CODEC_ENCODE_CB
#define FF_CODEC_ENCODE_CB(func)
Definition: codec_internal.h:359
av_cold
#define av_cold
Definition: attributes.h:119
sunrast_image_write_image
static void sunrast_image_write_image(AVCodecContext *avctx, const uint8_t *pixels, const uint32_t *palette_data, int linesize)
Definition: sunrastenc.c:57
bytestream2_init_writer
static av_always_inline void bytestream2_init_writer(PutByteContext *p, uint8_t *buf, int buf_size)
Definition: bytestream.h:147
GET_VALUE
#define GET_VALUE
s
#define s(width, name)
Definition: cbs_vp9.c:198
SUNRASTContext
Definition: sunrastenc.c:31
bytestream2_tell_p
static av_always_inline int bytestream2_tell_p(const PutByteContext *p)
Definition: bytestream.h:197
bytestream2_put_buffer
static av_always_inline unsigned int bytestream2_put_buffer(PutByteContext *p, const uint8_t *src, unsigned int size)
Definition: bytestream.h:286
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:144
av_fallthrough
#define av_fallthrough
Definition: attributes.h:67
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:332
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:76
NULL
#define NULL
Definition: coverity.c:32
run
uint8_t run
Definition: svq3.c:207
pixel
uint8_t pixel
Definition: tiny_ssim.c:41
SUNRASTContext::depth
int depth
depth of pixel
Definition: sunrastenc.c:35
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:242
options
Definition: swscale.c:45
sunrast.h
sunrast_encode_init
static av_cold int sunrast_encode_init(AVCodecContext *avctx)
Definition: sunrastenc.c:141
AV_PIX_FMT_GRAY8
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:81
RMT_NONE
#define RMT_NONE
Definition: sunrast.h:27
OFFSET
#define OFFSET(x)
Definition: sunrastenc.c:197
AV_WB32
#define AV_WB32(p, v)
Definition: intreadwrite.h:415
PutByteContext
Definition: bytestream.h:37
VE
#define VE
Definition: sunrastenc.c:198
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts.c:551
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:596
height
#define height
Definition: dsp.h:89
codec_internal.h
RLE_TRIGGER
#define RLE_TRIGGER
Definition: sunrast.h:39
attributes.h
sunrast_encode_frame
static int sunrast_encode_frame(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Definition: sunrastenc.c:174
bytestream2_skip_p
static av_always_inline void bytestream2_skip_p(PutByteContext *p, unsigned int size)
Definition: bytestream.h:180
value
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default value
Definition: writing_filters.txt:86
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:179
len
int len
Definition: vorbis_enc_data.h:426
AVCodecContext::height
int height
Definition: avcodec.h:600
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:639
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:81
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:265
sunrast_class
static const AVClass sunrast_class
Definition: sunrastenc.c:205
SUNRASTContext::maptype
int maptype
type of colormap
Definition: sunrastenc.c:38
AVCodecContext
main external API structure.
Definition: avcodec.h:439
SUNRASTContext::size
int size
Definition: sunrastenc.c:40
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:200
RT_BYTE_ENCODED
#define RT_BYTE_ENCODED
Definition: sunrast.h:38
FFALIGN
#define FFALIGN(x, a)
Definition: macros.h:78
AVPacket
This structure stores compressed data.
Definition: packet.h:572
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:466
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:600
bytestream.h
AVERROR_BUG
#define AVERROR_BUG
Internal bug, also see AVERROR_BUG2.
Definition: error.h:52
AV_CODEC_ID_SUNRAST
@ AV_CODEC_ID_SUNRAST
Definition: codec_id.h:162
RAS_MAGIC
#define RAS_MAGIC
Definition: sunrast.h:25
SUNRASTContext::maplength
int maplength
length (bytes) of colormap
Definition: sunrastenc.c:39
ff_alloc_packet
int ff_alloc_packet(AVCodecContext *avctx, AVPacket *avpkt, int64_t size)
Check AVPacket size and allocate data.
Definition: encode.c:61