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 #if FF_API_PALETTE_HAS_CHANGED
157 #endif
158  for (j = 0; j < 256; j++)
159  s->pal[j] = 0xFF000000 | AV_RL32(pal + j * 4);
160  } else if (pal) {
161  av_log(avctx, AV_LOG_ERROR,
162  "Palette size %"SIZE_SPECIFIER" is wrong\n", size);
163  }
164  memcpy(frame->data[1], s->pal, AVPALETTE_SIZE);
165  }
166 
167  ret = inflateReset(zstream);
168  if (ret != Z_OK) {
169  av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", ret);
170  return AVERROR_UNKNOWN;
171  }
172  zstream->next_out = s->decomp_buf;
173  zstream->avail_out = s->decomp_size;
174  if (avctx->codec_id == AV_CODEC_ID_MSCC) {
175  const uint8_t start = avpkt->data[2] ^ avpkt->data[0];
176 
177  zstream->next_in = &start;
178  zstream->avail_in = 1;
179  ret = inflate(zstream, Z_NO_FLUSH);
180  if (ret != Z_OK || zstream->avail_in != 0)
181  goto inflate_error;
182 
183  buf += 3;
184  buf_size -= 3;
185  }
186  zstream->next_in = buf;
187  zstream->avail_in = buf_size;
188  ret = inflate(zstream, Z_FINISH);
189  if (ret != Z_STREAM_END) {
190 inflate_error:
191  av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", ret);
192  return AVERROR_UNKNOWN;
193  }
194 
195  bytestream2_init(&gb, s->decomp_buf, zstream->total_out);
196  bytestream2_init_writer(&pb, s->uncomp_buf, s->uncomp_size);
197 
198  ret = rle_uncompress(avctx, &gb, &pb);
199  if (ret)
200  return ret;
201 
202  for (j = 0; j < avctx->height; j++) {
203  memcpy(frame->data[0] + (avctx->height - j - 1) * frame->linesize[0],
204  s->uncomp_buf + s->bpp * j * avctx->width, s->bpp * avctx->width);
205  }
206 
209 
210  *got_frame = 1;
211 
212  return avpkt->size;
213 }
214 
216 {
217  MSCCContext *s = avctx->priv_data;
218  int stride;
219 
220  switch (avctx->bits_per_coded_sample) {
221  case 8: avctx->pix_fmt = AV_PIX_FMT_PAL8; break;
222  case 16: avctx->pix_fmt = AV_PIX_FMT_RGB555; break;
223  case 24: avctx->pix_fmt = AV_PIX_FMT_BGR24; break;
224  case 32: avctx->pix_fmt = AV_PIX_FMT_BGRA; break;
225  default:
226  av_log(avctx, AV_LOG_ERROR, "Unsupported bitdepth %i\n", avctx->bits_per_coded_sample);
227  return AVERROR_INVALIDDATA;
228  }
229 
230  s->bpp = avctx->bits_per_coded_sample >> 3;
231  stride = 4 * ((avctx->width * avctx->bits_per_coded_sample + 31) / 32);
232 
233  s->decomp_size = 2 * avctx->height * stride;
234  if (!(s->decomp_buf = av_malloc(s->decomp_size)))
235  return AVERROR(ENOMEM);
236 
237  s->uncomp_size = avctx->height * stride;
238  if (!(s->uncomp_buf = av_malloc(s->uncomp_size)))
239  return AVERROR(ENOMEM);
240 
241  return ff_inflate_init(&s->zstream, avctx);
242 }
243 
245 {
246  MSCCContext *s = avctx->priv_data;
247 
248  av_freep(&s->decomp_buf);
249  s->decomp_size = 0;
250  av_freep(&s->uncomp_buf);
251  s->uncomp_size = 0;
252  ff_inflate_end(&s->zstream);
253 
254  return 0;
255 }
256 
258  .p.name = "mscc",
259  CODEC_LONG_NAME("Mandsoft Screen Capture Codec"),
260  .p.type = AVMEDIA_TYPE_VIDEO,
261  .p.id = AV_CODEC_ID_MSCC,
262  .priv_data_size = sizeof(MSCCContext),
263  .init = decode_init,
264  .close = decode_close,
266  .p.capabilities = AV_CODEC_CAP_DR1,
267  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
268 };
269 
271  .p.name = "srgc",
272  CODEC_LONG_NAME("Screen Recorder Gold Codec"),
273  .p.type = AVMEDIA_TYPE_VIDEO,
274  .p.id = AV_CODEC_ID_SRGC,
275  .priv_data_size = sizeof(MSCCContext),
276  .init = decode_init,
277  .close = decode_close,
279  .p.capabilities = AV_CODEC_CAP_DR1,
280  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
281 };
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: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
AVFrame::palette_has_changed
attribute_deprecated int palette_has_changed
Tell user application that palette has changed from previous frame.
Definition: frame.h:546
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:340
AVPacket::data
uint8_t * data
Definition: packet.h:522
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
AV_PIX_FMT_BGRA
@ AV_PIX_FMT_BGRA
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:102
AVFrame::flags
int flags
Frame flags, a combination of AV_FRAME_FLAGS.
Definition: frame.h:649
AVERROR_UNKNOWN
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:73
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:361
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:131
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: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:194
ff_srgc_decoder
const FFCodec ff_srgc_decoder
Definition: mscc.c:270
ff_mscc_decoder
const FFCodec ff_mscc_decoder
Definition: mscc.c:257
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
AV_FRAME_FLAG_KEY
#define AV_FRAME_FLAG_KEY
A flag to mark frames that are keyframes.
Definition: frame.h:628
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:306
s
#define s(width, name)
Definition: cbs_vp9.c:198
MSCCContext
Definition: mscc.c:34
decode.h
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:272
frame
static AVFrame * frame
Definition: demux_decode.c:54
AVCodecContext::codec_id
enum AVCodecID codec_id
Definition: avcodec.h:455
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:279
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
AVFrame::pict_type
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:442
ff_get_buffer
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1618
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts.c:365
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:523
copy
static void copy(const float *p1, float *p2, const int length)
Definition: vf_vaguedenoiser.c:185
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:1514
MSCCContext::decomp_size
unsigned int decomp_size
Definition: mscc.c:36
decode_close
static av_cold int decode_close(AVCodecContext *avctx)
Definition: mscc.c:244
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:252
AV_PIX_FMT_RGB555
#define AV_PIX_FMT_RGB555
Definition: pixfmt.h:470
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:625
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:662
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
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
SIZE_SPECIFIER
#define SIZE_SPECIFIER
Definition: internal.h:141
AVCodecContext
main external API structure.
Definition: avcodec.h:445
decode_init
static av_cold int decode_init(AVCodecContext *avctx)
Definition: mscc.c:215
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
AVPacket
This structure stores compressed data.
Definition: packet.h:499
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:625
bytestream.h
bytestream2_init
static av_always_inline void bytestream2_init(GetByteContext *g, const uint8_t *buf, int buf_size)
Definition: bytestream.h:137
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
Definition: frame.h:385
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