FFmpeg
mscc.c
Go to the documentation of this file.
1 /*
2  * Mandsoft Screen Capture Codec decoder
3  *
4  * Copyright (c) 2017 Paul B Mahol
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 #include <stdio.h>
24 #include <string.h>
25 
26 #include "avcodec.h"
27 #include "bytestream.h"
28 #include "codec_internal.h"
29 #include "decode.h"
30 #include "zlib_wrapper.h"
31 
32 #include <zlib.h>
33 
34 typedef struct MSCCContext {
35  unsigned bpp;
36  unsigned int decomp_size;
37  uint8_t *decomp_buf;
38  unsigned int uncomp_size;
39  uint8_t *uncomp_buf;
41 
42  uint32_t pal[256];
43 } MSCCContext;
44 
46 {
47  MSCCContext *s = avctx->priv_data;
48  unsigned x = 0, y = 0;
49 
50  while (bytestream2_get_bytes_left(gb) > 0) {
51  uint32_t fill;
52  int j;
53  unsigned run = bytestream2_get_byte(gb);
54 
55  if (run) {
56  switch (avctx->bits_per_coded_sample) {
57  case 8:
58  fill = bytestream2_get_byte(gb);
59  break;
60  case 16:
61  fill = bytestream2_get_le16(gb);
62  break;
63  case 24:
64  fill = bytestream2_get_le24(gb);
65  break;
66  case 32:
67  fill = bytestream2_get_le32(gb);
68  break;
69  }
70 
71  for (j = 0; j < run; j++) {
72  switch (avctx->bits_per_coded_sample) {
73  case 8:
74  bytestream2_put_byte(pb, fill);
75  break;
76  case 16:
77  bytestream2_put_le16(pb, fill);
78  break;
79  case 24:
80  bytestream2_put_le24(pb, fill);
81  break;
82  case 32:
83  bytestream2_put_le32(pb, fill);
84  break;
85  }
86  }
87  x += run;
88  } else {
89  unsigned copy = bytestream2_get_byte(gb);
90 
91  if (copy == 0) {
92  x = 0;
93  y++;
94  bytestream2_seek_p(pb, y * avctx->width * s->bpp, SEEK_SET);
95  } else if (copy == 1) {
96  return 0;
97  } else if (copy == 2) {
98 
99  x += bytestream2_get_byte(gb);
100  y += bytestream2_get_byte(gb);
101 
102  bytestream2_seek_p(pb, y * avctx->width * s->bpp + x * s->bpp, SEEK_SET);
103  } else {
104  for (j = 0; j < copy; j++) {
105  switch (avctx->bits_per_coded_sample) {
106  case 8:
107  bytestream2_put_byte(pb, bytestream2_get_byte(gb));
108  break;
109  case 16:
110  bytestream2_put_le16(pb, bytestream2_get_le16(gb));
111  break;
112  case 24:
113  bytestream2_put_le24(pb, bytestream2_get_le24(gb));
114  break;
115  case 32:
116  bytestream2_put_le32(pb, bytestream2_get_le32(gb));
117  break;
118  }
119  }
120 
121  if (s->bpp == 1 && (copy & 1))
122  bytestream2_skip(gb, 1);
123  x += copy;
124  }
125  }
126  }
127 
128  return AVERROR_INVALIDDATA;
129 }
130 
132  int *got_frame, AVPacket *avpkt)
133 {
134  MSCCContext *s = avctx->priv_data;
135  z_stream *const zstream = &s->zstream.zstream;
136  const uint8_t *buf = avpkt->data;
137  int buf_size = avpkt->size;
138  GetByteContext gb;
139  PutByteContext pb;
140  int ret, j;
141 
142  if (avpkt->size < 3)
143  return buf_size;
144 
145  if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
146  return ret;
147 
148  if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
149  size_t size;
150  const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, &size);
151 
152  if (pal && size == AVPALETTE_SIZE) {
153  frame->palette_has_changed = 1;
154  for (j = 0; j < 256; j++)
155  s->pal[j] = 0xFF000000 | AV_RL32(pal + j * 4);
156  } else if (pal) {
157  av_log(avctx, AV_LOG_ERROR,
158  "Palette size %"SIZE_SPECIFIER" is wrong\n", size);
159  }
160  memcpy(frame->data[1], s->pal, AVPALETTE_SIZE);
161  }
162 
163  ret = inflateReset(zstream);
164  if (ret != Z_OK) {
165  av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", ret);
166  return AVERROR_UNKNOWN;
167  }
168  zstream->next_out = s->decomp_buf;
169  zstream->avail_out = s->decomp_size;
170  if (avctx->codec_id == AV_CODEC_ID_MSCC) {
171  const uint8_t start = avpkt->data[2] ^ avpkt->data[0];
172 
173  zstream->next_in = &start;
174  zstream->avail_in = 1;
175  ret = inflate(zstream, Z_NO_FLUSH);
176  if (ret != Z_OK || zstream->avail_in != 0)
177  goto inflate_error;
178 
179  buf += 3;
180  buf_size -= 3;
181  }
182  zstream->next_in = buf;
183  zstream->avail_in = buf_size;
184  ret = inflate(zstream, Z_FINISH);
185  if (ret != Z_STREAM_END) {
186 inflate_error:
187  av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", ret);
188  return AVERROR_UNKNOWN;
189  }
190 
191  bytestream2_init(&gb, s->decomp_buf, zstream->total_out);
192  bytestream2_init_writer(&pb, s->uncomp_buf, s->uncomp_size);
193 
194  ret = rle_uncompress(avctx, &gb, &pb);
195  if (ret)
196  return ret;
197 
198  for (j = 0; j < avctx->height; j++) {
199  memcpy(frame->data[0] + (avctx->height - j - 1) * frame->linesize[0],
200  s->uncomp_buf + s->bpp * j * avctx->width, s->bpp * avctx->width);
201  }
202 
203  frame->key_frame = 1;
204  frame->pict_type = AV_PICTURE_TYPE_I;
205 
206  *got_frame = 1;
207 
208  return avpkt->size;
209 }
210 
212 {
213  MSCCContext *s = avctx->priv_data;
214  int stride;
215 
216  switch (avctx->bits_per_coded_sample) {
217  case 8: avctx->pix_fmt = AV_PIX_FMT_PAL8; break;
218  case 16: avctx->pix_fmt = AV_PIX_FMT_RGB555; break;
219  case 24: avctx->pix_fmt = AV_PIX_FMT_BGR24; break;
220  case 32: avctx->pix_fmt = AV_PIX_FMT_BGRA; break;
221  default:
222  av_log(avctx, AV_LOG_ERROR, "Unsupported bitdepth %i\n", avctx->bits_per_coded_sample);
223  return AVERROR_INVALIDDATA;
224  }
225 
226  s->bpp = avctx->bits_per_coded_sample >> 3;
227  stride = 4 * ((avctx->width * avctx->bits_per_coded_sample + 31) / 32);
228 
229  s->decomp_size = 2 * avctx->height * stride;
230  if (!(s->decomp_buf = av_malloc(s->decomp_size)))
231  return AVERROR(ENOMEM);
232 
233  s->uncomp_size = avctx->height * stride;
234  if (!(s->uncomp_buf = av_malloc(s->uncomp_size)))
235  return AVERROR(ENOMEM);
236 
237  return ff_inflate_init(&s->zstream, avctx);
238 }
239 
241 {
242  MSCCContext *s = avctx->priv_data;
243 
244  av_freep(&s->decomp_buf);
245  s->decomp_size = 0;
246  av_freep(&s->uncomp_buf);
247  s->uncomp_size = 0;
248  ff_inflate_end(&s->zstream);
249 
250  return 0;
251 }
252 
254  .p.name = "mscc",
255  CODEC_LONG_NAME("Mandsoft Screen Capture Codec"),
256  .p.type = AVMEDIA_TYPE_VIDEO,
257  .p.id = AV_CODEC_ID_MSCC,
258  .priv_data_size = sizeof(MSCCContext),
259  .init = decode_init,
260  .close = decode_close,
262  .p.capabilities = AV_CODEC_CAP_DR1,
263  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
264 };
265 
267  .p.name = "srgc",
268  CODEC_LONG_NAME("Screen Recorder Gold Codec"),
269  .p.type = AVMEDIA_TYPE_VIDEO,
270  .p.id = AV_CODEC_ID_SRGC,
271  .priv_data_size = sizeof(MSCCContext),
272  .init = decode_init,
273  .close = decode_close,
275  .p.capabilities = AV_CODEC_CAP_DR1,
276  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
277 };
AV_CODEC_ID_MSCC
@ AV_CODEC_ID_MSCC
Definition: codec_id.h:285
FF_CODEC_CAP_INIT_CLEANUP
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: codec_internal.h:42
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
MSCCContext::uncomp_buf
uint8_t * uncomp_buf
Definition: mscc.c:39
GetByteContext
Definition: bytestream.h:33
AV_CODEC_ID_SRGC
@ AV_CODEC_ID_SRGC
Definition: codec_id.h:286
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
AVPacket::data
uint8_t * data
Definition: packet.h:374
AV_PKT_DATA_PALETTE
@ AV_PKT_DATA_PALETTE
An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE bytes worth of palette.
Definition: packet.h:47
FFCodec
Definition: codec_internal.h:119
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
AVERROR_UNKNOWN
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:73
av_malloc
#define av_malloc(s)
Definition: tableprint_vlc.h:30
bytestream2_skip
static av_always_inline void bytestream2_skip(GetByteContext *g, unsigned int size)
Definition: bytestream.h:168
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:123
decode_frame
static int decode_frame(AVCodecContext *avctx, AVFrame *frame, int *got_frame, AVPacket *avpkt)
Definition: mscc.c:131
inflate
static void inflate(uint8_t *dst, const uint8_t *p1, int width, int threshold, const uint8_t *coordinates[], int coord, int maxc)
Definition: vf_neighbor.c:195
ff_srgc_decoder
const FFCodec ff_srgc_decoder
Definition: mscc.c:266
ff_mscc_decoder
const FFCodec ff_mscc_decoder
Definition: mscc.c:253
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
zlib_wrapper.h
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
FF_CODEC_DECODE_CB
#define FF_CODEC_DECODE_CB(func)
Definition: codec_internal.h:298
s
#define s(width, name)
Definition: cbs_vp9.c:256
MSCCContext
Definition: mscc.c:34
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts_bsf.c:363
decode.h
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:264
AVCodecContext::codec_id
enum AVCodecID codec_id
Definition: avcodec.h:408
run
uint8_t run
Definition: svq3.c:203
MSCCContext::bpp
unsigned bpp
Definition: mscc.c:35
AVPALETTE_SIZE
#define AVPALETTE_SIZE
Definition: pixfmt.h:32
AV_PICTURE_TYPE_I
@ AV_PICTURE_TYPE_I
Intra.
Definition: avutil.h:274
MSCCContext::decomp_buf
uint8_t * decomp_buf
Definition: mscc.c:37
bytestream2_get_bytes_left
static av_always_inline int bytestream2_get_bytes_left(GetByteContext *g)
Definition: bytestream.h:158
MSCCContext::pal
uint32_t pal[256]
Definition: mscc.c:42
PutByteContext
Definition: bytestream.h:37
ff_get_buffer
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1450
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:375
copy
static void copy(const float *p1, float *p2, const int length)
Definition: vf_vaguedenoiser.c:187
rle_uncompress
static int rle_uncompress(AVCodecContext *avctx, GetByteContext *gb, PutByteContext *pb)
Definition: mscc.c:45
codec_internal.h
size
int size
Definition: twinvq_data.h:10344
MSCCContext::uncomp_size
unsigned int uncomp_size
Definition: mscc.c:38
MSCCContext::zstream
FFZStream zstream
Definition: mscc.c:40
AVCodecContext::bits_per_coded_sample
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:1444
MSCCContext::decomp_size
unsigned int decomp_size
Definition: mscc.c:36
decode_close
static av_cold int decode_close(AVCodecContext *avctx)
Definition: mscc.c:240
av_packet_get_side_data
uint8_t * av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type, size_t *size)
Get side information from packet.
Definition: avpacket.c:251
AV_PIX_FMT_RGB555
#define AV_PIX_FMT_RGB555
Definition: pixfmt.h:447
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:211
ff_inflate_end
void ff_inflate_end(FFZStream *zstream)
Wrapper around inflateEnd().
AVCodecContext::height
int height
Definition: avcodec.h:571
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:608
avcodec.h
stride
#define stride
Definition: h264pred_template.c:537
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
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
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
SIZE_SPECIFIER
#define SIZE_SPECIFIER
Definition: internal.h:150
AVCodecContext
main external API structure.
Definition: avcodec.h:398
decode_init
static av_cold int decode_init(AVCodecContext *avctx)
Definition: mscc.c:211
bytestream2_seek_p
static av_always_inline int bytestream2_seek_p(PutByteContext *p, int offset, int whence)
Definition: bytestream.h:236
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
FFZStream
Definition: zlib_wrapper.h:27
AVPacket
This structure stores compressed data.
Definition: packet.h:351
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:425
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
ff_inflate_init
int ff_inflate_init(FFZStream *zstream, void *logctx)
Wrapper around inflateInit().
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:571
bytestream.h
bytestream2_init
static av_always_inline void bytestream2_init(GetByteContext *g, const uint8_t *buf, int buf_size)
Definition: bytestream.h:137
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61