FFmpeg
vc1_parser.c
Go to the documentation of this file.
1 /*
2  * VC-1 and WMV3 parser
3  * Copyright (c) 2006-2007 Konstantin Shishkov
4  * Partly based on vc9.c (c) 2005 Anonymous, Alex Beregszaszi, Michael Niedermayer
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 /**
24  * @file
25  * VC-1 and WMV3 parser
26  */
27 
28 #include "libavutil/attributes.h"
29 #include "parser.h"
30 #include "vc1.h"
31 #include "get_bits.h"
32 #include "vc1dsp.h"
33 
34 /** The maximum number of bytes of a sequence, entry point or
35  * frame header whose values we pay any attention to */
36 #define UNESCAPED_THRESHOLD 37
37 
38 /** The maximum number of bytes of a sequence, entry point or
39  * frame header which must be valid memory (because they are
40  * used to update the bitstream cache in skip_bits() calls)
41  */
42 #define UNESCAPED_LIMIT 144
43 
44 typedef enum {
50 
51 typedef struct VC1ParseContext {
54  uint8_t prev_start_code;
55  size_t bytes_to_skip;
57  size_t unesc_index;
60 
62  const uint8_t *buf, int buf_size)
63 {
64  /* Parse the header we just finished unescaping */
65  VC1ParseContext *vpc = s->priv_data;
66  GetBitContext gb;
67  int ret;
68  vpc->v.s.avctx = avctx;
69  init_get_bits8(&gb, buf, buf_size);
70  switch (vpc->prev_start_code) {
71  case VC1_CODE_SEQHDR & 0xFF:
72  ff_vc1_decode_sequence_header(avctx, &vpc->v, &gb);
73  break;
74  case VC1_CODE_ENTRYPOINT & 0xFF:
75  ff_vc1_decode_entry_point(avctx, &vpc->v, &gb);
76  break;
77  case VC1_CODE_FRAME & 0xFF:
78  if(vpc->v.profile < PROFILE_ADVANCED)
79  ret = ff_vc1_parse_frame_header (&vpc->v, &gb);
80  else
81  ret = ff_vc1_parse_frame_header_adv(&vpc->v, &gb);
82 
83  if (ret < 0)
84  break;
85 
86  /* keep AV_PICTURE_TYPE_BI internal to VC1 */
87  if (vpc->v.s.pict_type == AV_PICTURE_TYPE_BI)
88  s->pict_type = AV_PICTURE_TYPE_B;
89  else
90  s->pict_type = vpc->v.s.pict_type;
91 
92  if (avctx->ticks_per_frame > 1){
93  // process pulldown flags
94  s->repeat_pict = 1;
95  // Pulldown flags are only valid when 'broadcast' has been set.
96  // So ticks_per_frame will be 2
97  if (vpc->v.rff){
98  // repeat field
99  s->repeat_pict = 2;
100  }else if (vpc->v.rptfrm){
101  // repeat frames
102  s->repeat_pict = vpc->v.rptfrm * 2 + 1;
103  }
104  }else{
105  s->repeat_pict = 0;
106  }
107 
108  if (vpc->v.broadcast && vpc->v.interlace && !vpc->v.psf)
109  s->field_order = vpc->v.tff ? AV_FIELD_TT : AV_FIELD_BB;
110  else
111  s->field_order = AV_FIELD_PROGRESSIVE;
112 
113  break;
114  }
115  if (avctx->framerate.num)
116  avctx->time_base = av_inv_q(av_mul_q(avctx->framerate, (AVRational){avctx->ticks_per_frame, 1}));
117  s->format = vpc->v.chromaformat == 1 ? AV_PIX_FMT_YUV420P
118  : AV_PIX_FMT_NONE;
119  if (avctx->width && avctx->height) {
120  s->width = avctx->width;
121  s->height = avctx->height;
122  s->coded_width = FFALIGN(avctx->coded_width, 16);
123  s->coded_height = FFALIGN(avctx->coded_height, 16);
124  }
125 }
126 
128  AVCodecContext *avctx,
129  const uint8_t **poutbuf, int *poutbuf_size,
130  const uint8_t *buf, int buf_size)
131 {
132  /* Here we do the searching for frame boundaries and headers at
133  * the same time. Only a minimal amount at the start of each
134  * header is unescaped. */
135  VC1ParseContext *vpc = s->priv_data;
136  int pic_found = vpc->pc.frame_start_found;
137  uint8_t *unesc_buffer = vpc->unesc_buffer;
138  size_t unesc_index = vpc->unesc_index;
139  VC1ParseSearchState search_state = vpc->search_state;
140  int start_code_found = 0;
141  int next = END_NOT_FOUND;
142  int i = vpc->bytes_to_skip;
143 
144  if (pic_found && buf_size == 0) {
145  /* EOF considered as end of frame */
146  memset(unesc_buffer + unesc_index, 0, UNESCAPED_THRESHOLD - unesc_index);
147  vc1_extract_header(s, avctx, unesc_buffer, unesc_index);
148  next = 0;
149  }
150  while (i < buf_size) {
151  uint8_t b;
152  start_code_found = 0;
153  while (i < buf_size && unesc_index < UNESCAPED_THRESHOLD) {
154  b = buf[i++];
155  unesc_buffer[unesc_index++] = b;
156  if (search_state <= ONE_ZERO)
157  search_state = b ? NO_MATCH : search_state + 1;
158  else if (search_state == TWO_ZEROS) {
159  if (b == 1)
160  search_state = ONE;
161  else if (b > 1) {
162  if (b == 3)
163  unesc_index--; // swallow emulation prevention byte
164  search_state = NO_MATCH;
165  }
166  }
167  else { // search_state == ONE
168  // Header unescaping terminates early due to detection of next start code
169  search_state = NO_MATCH;
170  start_code_found = 1;
171  break;
172  }
173  }
174  if ((s->flags & PARSER_FLAG_COMPLETE_FRAMES) &&
175  unesc_index >= UNESCAPED_THRESHOLD &&
176  vpc->prev_start_code == (VC1_CODE_FRAME & 0xFF))
177  {
178  // No need to keep scanning the rest of the buffer for
179  // start codes if we know it contains a complete frame and
180  // we've already unescaped all we need of the frame header
181  vc1_extract_header(s, avctx, unesc_buffer, unesc_index);
182  break;
183  }
184  if (unesc_index >= UNESCAPED_THRESHOLD && !start_code_found) {
185  while (i < buf_size) {
186  if (search_state == NO_MATCH) {
187  i += vpc->v.vc1dsp.startcode_find_candidate(buf + i, buf_size - i);
188  if (i < buf_size) {
189  search_state = ONE_ZERO;
190  }
191  i++;
192  } else {
193  b = buf[i++];
194  if (search_state == ONE_ZERO)
195  search_state = b ? NO_MATCH : TWO_ZEROS;
196  else if (search_state == TWO_ZEROS) {
197  if (b >= 1)
198  search_state = b == 1 ? ONE : NO_MATCH;
199  }
200  else { // search_state == ONE
201  search_state = NO_MATCH;
202  start_code_found = 1;
203  break;
204  }
205  }
206  }
207  }
208  if (start_code_found) {
209  vc1_extract_header(s, avctx, unesc_buffer, unesc_index);
210 
211  vpc->prev_start_code = b;
212  unesc_index = 0;
213 
214  if (!(s->flags & PARSER_FLAG_COMPLETE_FRAMES)) {
215  if (!pic_found && (b == (VC1_CODE_FRAME & 0xFF) || b == (VC1_CODE_FIELD & 0xFF))) {
216  pic_found = 1;
217  }
218  else if (pic_found && b != (VC1_CODE_FIELD & 0xFF) && b != (VC1_CODE_SLICE & 0xFF)) {
219  next = i - 4;
220  pic_found = b == (VC1_CODE_FRAME & 0xFF);
221  break;
222  }
223  }
224  }
225  }
226 
227  vpc->pc.frame_start_found = pic_found;
228  vpc->unesc_index = unesc_index;
229  vpc->search_state = search_state;
230 
231  if (s->flags & PARSER_FLAG_COMPLETE_FRAMES) {
232  next = buf_size;
233  } else {
234  if (ff_combine_frame(&vpc->pc, next, &buf, &buf_size) < 0) {
235  vpc->bytes_to_skip = 0;
236  *poutbuf = NULL;
237  *poutbuf_size = 0;
238  return buf_size;
239  }
240  }
241 
242  /* If we return with a valid pointer to a combined frame buffer
243  * then on the next call then we'll have been unhelpfully rewound
244  * by up to 4 bytes (depending upon whether the start code
245  * overlapped the input buffer, and if so by how much). We don't
246  * want this: it will either cause spurious second detections of
247  * the start code we've already seen, or cause extra bytes to be
248  * inserted at the start of the unescaped buffer. */
249  vpc->bytes_to_skip = 4;
250  if (next < 0 && next != END_NOT_FOUND)
251  vpc->bytes_to_skip += next;
252 
253  *poutbuf = buf;
254  *poutbuf_size = buf_size;
255  return next;
256 }
257 
259 {
260  VC1ParseContext *vpc = s->priv_data;
261  vpc->v.s.slice_context_count = 1;
262  vpc->v.first_pic_header_flag = 1;
263  vpc->v.parse_only = 1;
264  vpc->prev_start_code = 0;
265  vpc->bytes_to_skip = 0;
266  vpc->unesc_index = 0;
267  vpc->search_state = NO_MATCH;
268  ff_vc1dsp_init(&vpc->v.vc1dsp); /* startcode_find_candidate */
269  return 0;
270 }
271 
273  .codec_ids = { AV_CODEC_ID_VC1 },
274  .priv_data_size = sizeof(VC1ParseContext),
275  .parser_init = vc1_parse_init,
276  .parser_parse = vc1_parse,
277  .parser_close = ff_parse_close,
278 };
AV_FIELD_PROGRESSIVE
@ AV_FIELD_PROGRESSIVE
Definition: codec_par.h:40
VC1Context
The VC1 Context.
Definition: vc1.h:173
VC1ParseContext::search_state
VC1ParseSearchState search_state
Definition: vc1_parser.c:58
VC1Context::interlace
int interlace
Progressive/interlaced (RPTFTM syntax element)
Definition: vc1.h:199
vc1dsp.h
vc1.h
VC1ParseContext::bytes_to_skip
size_t bytes_to_skip
Definition: vc1_parser.c:55
ff_parse_close
void ff_parse_close(AVCodecParserContext *s)
Definition: parser.c:284
b
#define b
Definition: input.c:41
VC1ParseContext::prev_start_code
uint8_t prev_start_code
Definition: vc1_parser.c:54
VC1ParseSearchState
VC1ParseSearchState
Definition: vc1_parser.c:44
MpegEncContext::avctx
struct AVCodecContext * avctx
Definition: mpegvideo.h:88
NO_MATCH
@ NO_MATCH
Definition: vc1_parser.c:45
VC1Context::rptfrm
uint8_t rptfrm
Definition: vc1.h:310
ff_vc1_parse_frame_header
int ff_vc1_parse_frame_header(VC1Context *v, GetBitContext *gb)
Definition: vc1.c:617
AVCodecContext::framerate
AVRational framerate
Definition: avcodec.h:1735
ParseContext
Definition: parser.h:28
MpegEncContext::pict_type
int pict_type
AV_PICTURE_TYPE_I, AV_PICTURE_TYPE_P, AV_PICTURE_TYPE_B, ...
Definition: mpegvideo.h:203
ff_vc1_parser
const AVCodecParser ff_vc1_parser
Definition: vc1_parser.c:272
GetBitContext
Definition: get_bits.h:61
ONE
@ ONE
Definition: vc1_parser.c:48
VC1Context::first_pic_header_flag
int first_pic_header_flag
Definition: vc1.h:365
ff_vc1_decode_sequence_header
int ff_vc1_decode_sequence_header(AVCodecContext *avctx, VC1Context *v, GetBitContext *gb)
Decode Simple/Main Profiles sequence header.
Definition: vc1.c:274
AVCodecContext::coded_height
int coded_height
Definition: avcodec.h:586
AVRational::num
int num
Numerator.
Definition: rational.h:59
av_cold
#define av_cold
Definition: attributes.h:90
init_get_bits8
static int init_get_bits8(GetBitContext *s, const uint8_t *buffer, int byte_size)
Initialize GetBitContext.
Definition: get_bits.h:667
VC1_CODE_SLICE
@ VC1_CODE_SLICE
Definition: vc1_common.h:36
s
#define s(width, name)
Definition: cbs_vp9.c:256
VC1ParseContext
Definition: vc1_parser.c:51
AVCodecContext::ticks_per_frame
int ticks_per_frame
For some codecs, the time base is closer to the field rate than the frame rate.
Definition: avcodec.h:530
PROFILE_ADVANCED
@ PROFILE_ADVANCED
Definition: vc1_common.h:52
vc1_parse_init
static av_cold int vc1_parse_init(AVCodecParserContext *s)
Definition: vc1_parser.c:258
get_bits.h
VC1ParseContext::unesc_buffer
uint8_t unesc_buffer[UNESCAPED_LIMIT]
Definition: vc1_parser.c:56
AV_PIX_FMT_YUV420P
@ AV_PIX_FMT_YUV420P
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:66
NULL
#define NULL
Definition: coverity.c:32
VC1ParseContext::unesc_index
size_t unesc_index
Definition: vc1_parser.c:57
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
VC1_CODE_SEQHDR
@ VC1_CODE_SEQHDR
Definition: vc1_common.h:40
UNESCAPED_LIMIT
#define UNESCAPED_LIMIT
The maximum number of bytes of a sequence, entry point or frame header which must be valid memory (be...
Definition: vc1_parser.c:42
ParseContext::frame_start_found
int frame_start_found
Definition: parser.h:34
vc1_parse
static int vc1_parse(AVCodecParserContext *s, AVCodecContext *avctx, const uint8_t **poutbuf, int *poutbuf_size, const uint8_t *buf, int buf_size)
Definition: vc1_parser.c:127
VC1_CODE_FIELD
@ VC1_CODE_FIELD
Definition: vc1_common.h:37
VC1_CODE_ENTRYPOINT
@ VC1_CODE_ENTRYPOINT
Definition: vc1_common.h:39
VC1Context::vc1dsp
VC1DSPContext vc1dsp
Definition: vc1.h:177
MpegEncContext::slice_context_count
int slice_context_count
number of used thread_contexts
Definition: mpegvideo.h:148
VC1_CODE_FRAME
@ VC1_CODE_FRAME
Definition: vc1_common.h:38
ff_vc1dsp_init
av_cold void ff_vc1dsp_init(VC1DSPContext *dsp)
Definition: vc1dsp.c:974
AVCodecContext::time_base
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avcodec.h:521
AVCodecParser::codec_ids
int codec_ids[7]
Definition: avcodec.h:2960
VC1Context::parse_only
int parse_only
Context is used within parser.
Definition: vc1.h:397
VC1Context::chromaformat
int chromaformat
2 bits, 2=4:2:0, only defined
Definition: vc1.h:196
ONE_ZERO
@ ONE_ZERO
Definition: vc1_parser.c:46
AV_FIELD_TT
@ AV_FIELD_TT
Top coded_first, top displayed first.
Definition: codec_par.h:41
attributes.h
ff_combine_frame
int ff_combine_frame(ParseContext *pc, int next, const uint8_t **buf, int *buf_size)
Combine the (truncated) bitstream to a complete frame.
Definition: parser.c:199
VC1DSPContext::startcode_find_candidate
int(* startcode_find_candidate)(const uint8_t *buf, int size)
Search buf from the start for up to size bytes.
Definition: vc1dsp.h:82
PARSER_FLAG_COMPLETE_FRAMES
#define PARSER_FLAG_COMPLETE_FRAMES
Definition: avcodec.h:2834
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
TWO_ZEROS
@ TWO_ZEROS
Definition: vc1_parser.c:47
ff_vc1_decode_entry_point
int ff_vc1_decode_entry_point(AVCodecContext *avctx, VC1Context *v, GetBitContext *gb)
Definition: vc1.c:496
ff_vc1_parse_frame_header_adv
int ff_vc1_parse_frame_header_adv(VC1Context *v, GetBitContext *gb)
Definition: vc1.c:839
VC1Context::s
MpegEncContext s
Definition: vc1.h:174
av_inv_q
static av_always_inline AVRational av_inv_q(AVRational q)
Invert a rational.
Definition: rational.h:159
AV_CODEC_ID_VC1
@ AV_CODEC_ID_VC1
Definition: codec_id.h:122
parser.h
AVCodecContext::height
int height
Definition: avcodec.h:571
AVCodecParserContext
Definition: avcodec.h:2800
ret
ret
Definition: filter_design.txt:187
UNESCAPED_THRESHOLD
#define UNESCAPED_THRESHOLD
The maximum number of bytes of a sequence, entry point or frame header whose values we pay any attent...
Definition: vc1_parser.c:36
AVCodecContext
main external API structure.
Definition: avcodec.h:398
VC1ParseContext::v
VC1Context v
Definition: vc1_parser.c:53
AV_PICTURE_TYPE_B
@ AV_PICTURE_TYPE_B
Bi-dir predicted.
Definition: avutil.h:276
VC1Context::tff
uint8_t tff
Definition: vc1.h:310
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
VC1Context::profile
int profile
Sequence header data for all Profiles TODO: choose between ints, uint8_ts and monobit flags.
Definition: vc1.h:216
av_mul_q
AVRational av_mul_q(AVRational b, AVRational c)
Multiply two rationals.
Definition: rational.c:80
AVCodecContext::coded_width
int coded_width
Bitstream width / height, may be different from width/height e.g.
Definition: avcodec.h:586
VC1Context::psf
int psf
Progressive Segmented Frame.
Definition: vc1.h:209
VC1Context::broadcast
int broadcast
TFF/RFF present.
Definition: vc1.h:198
END_NOT_FOUND
#define END_NOT_FOUND
Definition: parser.h:40
FFALIGN
#define FFALIGN(x, a)
Definition: macros.h:78
AVCodecParser
Definition: avcodec.h:2959
AV_PICTURE_TYPE_BI
@ AV_PICTURE_TYPE_BI
BI type.
Definition: avutil.h:280
AV_FIELD_BB
@ AV_FIELD_BB
Bottom coded first, bottom displayed first.
Definition: codec_par.h:42
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:571
vc1_extract_header
static void vc1_extract_header(AVCodecParserContext *s, AVCodecContext *avctx, const uint8_t *buf, int buf_size)
Definition: vc1_parser.c:61
VC1ParseContext::pc
ParseContext pc
Definition: vc1_parser.c:52
VC1Context::rff
uint8_t rff
Definition: vc1.h:310