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 "libavutil/mem.h"
27 #include "avcodec.h"
28 #include "bytestream.h"
29 #include "codec_internal.h"
30 #include "decode.h"
31 #include "zlib_wrapper.h"
32 
33 #include <zlib.h>
34 
35 typedef struct MSCCContext {
36  unsigned bpp;
37  unsigned int decomp_size;
38  uint8_t *decomp_buf;
39  unsigned int uncomp_size;
40  uint8_t *uncomp_buf;
42 
43  uint32_t pal[256];
44 } MSCCContext;
45 
47 {
48  MSCCContext *s = avctx->priv_data;
49  unsigned x = 0, y = 0;
50 
51  while (bytestream2_get_bytes_left(gb) > 0) {
52  uint32_t fill;
53  int j;
54  unsigned run = bytestream2_get_byte(gb);
55 
56  if (run) {
57  if (bytestream2_get_bytes_left_p(pb) < run * s->bpp)
58  return AVERROR_INVALIDDATA;
59 
60  switch (avctx->bits_per_coded_sample) {
61  case 8:
62  fill = bytestream2_get_byte(gb);
63  break;
64  case 16:
65  fill = bytestream2_get_le16(gb);
66  break;
67  case 24:
68  fill = bytestream2_get_le24(gb);
69  break;
70  case 32:
71  fill = bytestream2_get_le32(gb);
72  break;
73  }
74 
75  for (j = 0; j < run; j++) {
76  switch (avctx->bits_per_coded_sample) {
77  case 8:
78  bytestream2_put_byte(pb, fill);
79  break;
80  case 16:
81  bytestream2_put_le16(pb, fill);
82  break;
83  case 24:
84  bytestream2_put_le24(pb, fill);
85  break;
86  case 32:
87  bytestream2_put_le32(pb, fill);
88  break;
89  }
90  }
91  x += run;
92  } else {
93  unsigned copy = bytestream2_get_byte(gb);
94 
95  if (copy == 0) {
96  x = 0;
97  y++;
98  bytestream2_seek_p(pb, y * avctx->width * s->bpp, SEEK_SET);
99  } else if (copy == 1) {
100  return 0;
101  } else if (copy == 2) {
102 
103  x += bytestream2_get_byte(gb);
104  y += bytestream2_get_byte(gb);
105 
106  bytestream2_seek_p(pb, y * avctx->width * s->bpp + x * s->bpp, SEEK_SET);
107  } else {
108  if (bytestream2_get_bytes_left_p(pb) < copy * s->bpp)
109  return AVERROR_INVALIDDATA;
110 
111  for (j = 0; j < copy; j++) {
112  switch (avctx->bits_per_coded_sample) {
113  case 8:
114  bytestream2_put_byte(pb, bytestream2_get_byte(gb));
115  break;
116  case 16:
117  bytestream2_put_le16(pb, bytestream2_get_le16(gb));
118  break;
119  case 24:
120  bytestream2_put_le24(pb, bytestream2_get_le24(gb));
121  break;
122  case 32:
123  bytestream2_put_le32(pb, bytestream2_get_le32(gb));
124  break;
125  }
126  }
127 
128  if (s->bpp == 1 && (copy & 1))
129  bytestream2_skip(gb, 1);
130  x += copy;
131  }
132  }
133  }
134 
135  return AVERROR_INVALIDDATA;
136 }
137 
139  int *got_frame, AVPacket *avpkt)
140 {
141  MSCCContext *s = avctx->priv_data;
142  z_stream *const zstream = &s->zstream.zstream;
143  const uint8_t *buf = avpkt->data;
144  int buf_size = avpkt->size;
145  GetByteContext gb;
146  PutByteContext pb;
147  int ret, j;
148 
149  if (avpkt->size < 3)
150  return buf_size;
151 
152  ret = inflateReset(zstream);
153  if (ret != Z_OK) {
154  av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", ret);
155  return AVERROR_UNKNOWN;
156  }
157  zstream->next_out = s->decomp_buf;
158  zstream->avail_out = s->decomp_size;
159  if (avctx->codec_id == AV_CODEC_ID_MSCC) {
160  const uint8_t start = avpkt->data[2] ^ avpkt->data[0];
161 
162  zstream->next_in = &start;
163  zstream->avail_in = 1;
164  ret = inflate(zstream, Z_NO_FLUSH);
165  if (ret != Z_OK || zstream->avail_in != 0)
166  goto inflate_error;
167 
168  buf += 3;
169  buf_size -= 3;
170  }
171  zstream->next_in = buf;
172  zstream->avail_in = buf_size;
173  ret = inflate(zstream, Z_FINISH);
174  if (ret != Z_STREAM_END) {
175 inflate_error:
176  av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", ret);
177  return AVERROR_UNKNOWN;
178  }
179  if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
180  return ret;
181 
182  if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
183  size_t size;
184  const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, &size);
185 
186  if (pal && size == AVPALETTE_SIZE) {
187 #if FF_API_PALETTE_HAS_CHANGED
189  frame->palette_has_changed = 1;
191 #endif
192  for (j = 0; j < 256; j++)
193  s->pal[j] = 0xFF000000 | AV_RL32(pal + j * 4);
194  } else if (pal) {
195  av_log(avctx, AV_LOG_ERROR,
196  "Palette size %"SIZE_SPECIFIER" is wrong\n", size);
197  }
198  memcpy(frame->data[1], s->pal, AVPALETTE_SIZE);
199  }
200 
201  bytestream2_init(&gb, s->decomp_buf, zstream->total_out);
202  bytestream2_init_writer(&pb, s->uncomp_buf, s->uncomp_size);
203 
204  ret = rle_uncompress(avctx, &gb, &pb);
205  if (ret)
206  return ret;
207 
208  for (j = 0; j < avctx->height; j++) {
209  memcpy(frame->data[0] + (avctx->height - j - 1) * frame->linesize[0],
210  s->uncomp_buf + s->bpp * j * avctx->width, s->bpp * avctx->width);
211  }
212 
213  *got_frame = 1;
214 
215  return avpkt->size;
216 }
217 
219 {
220  MSCCContext *s = avctx->priv_data;
221  int stride;
222 
223  switch (avctx->bits_per_coded_sample) {
224  case 8: avctx->pix_fmt = AV_PIX_FMT_PAL8; break;
225  case 16: avctx->pix_fmt = AV_PIX_FMT_RGB555; break;
226  case 24: avctx->pix_fmt = AV_PIX_FMT_BGR24; break;
227  case 32: avctx->pix_fmt = AV_PIX_FMT_BGRA; break;
228  default:
229  av_log(avctx, AV_LOG_ERROR, "Unsupported bitdepth %i\n", avctx->bits_per_coded_sample);
230  return AVERROR_INVALIDDATA;
231  }
232 
233  s->bpp = avctx->bits_per_coded_sample >> 3;
234  stride = 4 * ((avctx->width * avctx->bits_per_coded_sample + 31) / 32);
235 
236  s->decomp_size = 2 * avctx->height * stride;
237  if (!(s->decomp_buf = av_malloc(s->decomp_size)))
238  return AVERROR(ENOMEM);
239 
240  s->uncomp_size = avctx->height * stride;
241  if (!(s->uncomp_buf = av_malloc(s->uncomp_size)))
242  return AVERROR(ENOMEM);
243 
244  return ff_inflate_init(&s->zstream, avctx);
245 }
246 
248 {
249  MSCCContext *s = avctx->priv_data;
250 
251  av_freep(&s->decomp_buf);
252  s->decomp_size = 0;
253  av_freep(&s->uncomp_buf);
254  s->uncomp_size = 0;
255  ff_inflate_end(&s->zstream);
256 
257  return 0;
258 }
259 
261  .p.name = "mscc",
262  CODEC_LONG_NAME("Mandsoft Screen Capture Codec"),
263  .p.type = AVMEDIA_TYPE_VIDEO,
264  .p.id = AV_CODEC_ID_MSCC,
265  .priv_data_size = sizeof(MSCCContext),
266  .init = decode_init,
267  .close = decode_close,
269  .p.capabilities = AV_CODEC_CAP_DR1,
270  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
271 };
272 
274  .p.name = "srgc",
275  CODEC_LONG_NAME("Screen Recorder Gold Codec"),
276  .p.type = AVMEDIA_TYPE_VIDEO,
277  .p.id = AV_CODEC_ID_SRGC,
278  .priv_data_size = sizeof(MSCCContext),
279  .init = decode_init,
280  .close = decode_close,
282  .p.capabilities = AV_CODEC_CAP_DR1,
283  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
284 };
FF_ENABLE_DEPRECATION_WARNINGS
#define FF_ENABLE_DEPRECATION_WARNINGS
Definition: internal.h:73
AV_CODEC_ID_MSCC
@ AV_CODEC_ID_MSCC
Definition: codec_id.h:282
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:40
GetByteContext
Definition: bytestream.h:33
AV_CODEC_ID_SRGC
@ AV_CODEC_ID_SRGC
Definition: codec_id.h:283
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:374
AVPacket::data
uint8_t * data
Definition: packet.h:533
FFCodec
Definition: codec_internal.h:126
AV_PIX_FMT_BGR24
@ AV_PIX_FMT_BGR24
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:76
AV_PIX_FMT_BGRA
@ AV_PIX_FMT_BGRA
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:102
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:130
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
decode_frame
static int decode_frame(AVCodecContext *avctx, AVFrame *frame, int *got_frame, AVPacket *avpkt)
Definition: mscc.c:138
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:194
ff_srgc_decoder
const FFCodec ff_srgc_decoder
Definition: mscc.c:273
ff_mscc_decoder
const FFCodec ff_mscc_decoder
Definition: mscc.c:260
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
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:286
s
#define s(width, name)
Definition: cbs_vp9.c:198
MSCCContext
Definition: mscc.c:35
decode.h
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:271
AVCodecContext::codec_id
enum AVCodecID codec_id
Definition: avcodec.h:455
run
uint8_t run
Definition: svq3.c:204
MSCCContext::bpp
unsigned bpp
Definition: mscc.c:36
AVPALETTE_SIZE
#define AVPALETTE_SIZE
Definition: pixfmt.h:32
MSCCContext::decomp_buf
uint8_t * decomp_buf
Definition: mscc.c:38
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:43
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:1575
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts.c:366
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:534
copy
static void copy(const float *p1, float *p2, const int length)
Definition: vf_vaguedenoiser.c:186
rle_uncompress
static int rle_uncompress(AVCodecContext *avctx, GetByteContext *gb, PutByteContext *pb)
Definition: mscc.c:46
codec_internal.h
size
int size
Definition: twinvq_data.h:10344
MSCCContext::uncomp_size
unsigned int uncomp_size
Definition: mscc.c:39
MSCCContext::zstream
FFZStream zstream
Definition: mscc.c:41
AVCodecContext::bits_per_coded_sample
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:1568
MSCCContext::decomp_size
unsigned int decomp_size
Definition: mscc.c:37
decode_close
static av_cold int decode_close(AVCodecContext *avctx)
Definition: mscc.c:247
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: packet.c:252
AV_PIX_FMT_RGB555
#define AV_PIX_FMT_RGB555
Definition: pixfmt.h:466
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:194
ff_inflate_end
void ff_inflate_end(FFZStream *zstream)
Wrapper around inflateEnd().
AVCodecContext::height
int height
Definition: avcodec.h:618
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:657
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:84
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:129
AVCodecContext
main external API structure.
Definition: avcodec.h:445
decode_init
static av_cold int decode_init(AVCodecContext *avctx)
Definition: mscc.c:218
bytestream2_seek_p
static av_always_inline int bytestream2_seek_p(PutByteContext *p, int offset, int whence)
Definition: bytestream.h:236
FF_DISABLE_DEPRECATION_WARNINGS
#define FF_DISABLE_DEPRECATION_WARNINGS
Definition: internal.h:72
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
FFZStream
Definition: zlib_wrapper.h:27
mem.h
AVPacket
This structure stores compressed data.
Definition: packet.h:510
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:472
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:618
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