libmpeg2/mpeg2.h

   1 /*
   2  * mpeg2.h
   3  * Copyright (C) 2000-2004 Michel Lespinasse <walken@zoy.org>
   4  * Copyright (C) 1999-2000 Aaron Holtzman <aholtzma@ess.engr.uvic.ca>
   5  *
   6  * This file is part of mpeg2dec, a free MPEG-2 video stream decoder.
   7  * See http://libmpeg2.sourceforge.net/ for updates.
   8  *
   9  * mpeg2dec is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * mpeg2dec is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  *
  23  * Modified for use with MPlayer, see libmpeg2_changes.diff for the exact changes.
  24  * detailed changelog at http://svn.mplayerhq.hu/mplayer/trunk/
  25  * $Id$
  26  */
  27
  28 #ifndef LIBMPEG2_MPEG2_H
  29 #define LIBMPEG2_MPEG2_H
  30
  31 #define MPEG2_VERSION(a,b,c) (((a)<<16)|((b)<<8)|(c))
  32 #define MPEG2_RELEASE MPEG2_VERSION (0, 5, 1)   /* 0.5.1 */
  33
  34 #define SEQ_FLAG_MPEG2 1
  35 #define SEQ_FLAG_CONSTRAINED_PARAMETERS 2
  36 #define SEQ_FLAG_PROGRESSIVE_SEQUENCE 4
  37 #define SEQ_FLAG_LOW_DELAY 8
  38 #define SEQ_FLAG_COLOUR_DESCRIPTION 16
  39
  40 #define SEQ_MASK_VIDEO_FORMAT 0xe0
  41 #define SEQ_VIDEO_FORMAT_COMPONENT 0
  42 #define SEQ_VIDEO_FORMAT_PAL 0x20
  43 #define SEQ_VIDEO_FORMAT_NTSC 0x40
  44 #define SEQ_VIDEO_FORMAT_SECAM 0x60
  45 #define SEQ_VIDEO_FORMAT_MAC 0x80
  46 #define SEQ_VIDEO_FORMAT_UNSPECIFIED 0xa0
  47
  48 typedef struct mpeg2_sequence_s {
  49     unsigned int width, height;
  50     unsigned int chroma_width, chroma_height;
  51     unsigned int byte_rate;
  52     unsigned int vbv_buffer_size;
  53     uint32_t flags;
  54
  55     unsigned int picture_width, picture_height;
  56     unsigned int display_width, display_height;
  57     unsigned int pixel_width, pixel_height;
  58     unsigned int frame_period;
  59
  60     uint8_t profile_level_id;
  61     uint8_t colour_primaries;
  62     uint8_t transfer_characteristics;
  63     uint8_t matrix_coefficients;
  64 } mpeg2_sequence_t;
  65
  66 #define GOP_FLAG_DROP_FRAME 1
  67 #define GOP_FLAG_BROKEN_LINK 2
  68 #define GOP_FLAG_CLOSED_GOP 4
  69
  70 typedef struct mpeg2_gop_s {
  71     uint8_t hours;
  72     uint8_t minutes;
  73     uint8_t seconds;
  74     uint8_t pictures;
  75     uint32_t flags;
  76 } mpeg2_gop_t;
  77
  78 #define PIC_MASK_CODING_TYPE 7
  79 #define PIC_FLAG_CODING_TYPE_I 1
  80 #define PIC_FLAG_CODING_TYPE_P 2
  81 #define PIC_FLAG_CODING_TYPE_B 3
  82 #define PIC_FLAG_CODING_TYPE_D 4
  83
  84 #define PIC_FLAG_TOP_FIELD_FIRST 8
  85 #define PIC_FLAG_PROGRESSIVE_FRAME 16
  86 #define PIC_FLAG_COMPOSITE_DISPLAY 32
  87 #define PIC_FLAG_SKIP 64
  88 #define PIC_FLAG_TAGS 128
  89 #define PIC_FLAG_REPEAT_FIRST_FIELD 256
  90 #define PIC_MASK_COMPOSITE_DISPLAY 0xfffff000
  91
  92 typedef struct mpeg2_picture_s {
  93     unsigned int temporal_reference;
  94     unsigned int nb_fields;
  95     uint32_t tag, tag2;
  96     uint32_t flags;
  97     struct {
  98         int x, y;
  99     } display_offset[3];
 100 } mpeg2_picture_t;
 101
 102 typedef struct mpeg2_fbuf_s {
 103     uint8_t * buf[3];
 104     void * id;
 105 } mpeg2_fbuf_t;
 106
 107 typedef struct mpeg2_info_s {
 108     const mpeg2_sequence_t * sequence;
 109     const mpeg2_gop_t * gop;
 110     const mpeg2_picture_t * current_picture;
 111     const mpeg2_picture_t * current_picture_2nd;
 112     const mpeg2_fbuf_t * current_fbuf;
 113     const mpeg2_picture_t * display_picture;
 114     const mpeg2_picture_t * display_picture_2nd;
 115     const mpeg2_fbuf_t * display_fbuf;
 116     const mpeg2_fbuf_t * discard_fbuf;
 117     const uint8_t * user_data;
 118     unsigned int user_data_len;
 119 } mpeg2_info_t;
 120
 121 typedef struct mpeg2dec_s mpeg2dec_t;
 122 typedef struct mpeg2_decoder_s mpeg2_decoder_t;
 123
 124 typedef enum {
 125     STATE_BUFFER = 0,
 126     STATE_SEQUENCE = 1,
 127     STATE_SEQUENCE_REPEATED = 2,
 128     STATE_GOP = 3,
 129     STATE_PICTURE = 4,
 130     STATE_SLICE_1ST = 5,
 131     STATE_PICTURE_2ND = 6,
 132     STATE_SLICE = 7,
 133     STATE_END = 8,
 134     STATE_INVALID = 9,
 135     STATE_INVALID_END = 10,
 136     STATE_SEQUENCE_MODIFIED = 11
 137 } mpeg2_state_t;
 138
 139 typedef struct mpeg2_convert_init_s {
 140     unsigned int id_size;
 141     unsigned int buf_size[3];
 142     void (* start) (void * id, const mpeg2_fbuf_t * fbuf,
 143                     const mpeg2_picture_t * picture, const mpeg2_gop_t * gop);
 144     void (* copy) (void * id, uint8_t * const * src, unsigned int v_offset);
 145 } mpeg2_convert_init_t;
 146 typedef enum {
 147     MPEG2_CONVERT_SET = 0,
 148     MPEG2_CONVERT_STRIDE = 1,
 149     MPEG2_CONVERT_START = 2
 150 } mpeg2_convert_stage_t;
 151 typedef int mpeg2_convert_t (int stage, void * id,
 152                              const mpeg2_sequence_t * sequence, int stride,
 153                              uint32_t accel, void * arg,
 154                              mpeg2_convert_init_t * result);
 155 int mpeg2_convert (mpeg2dec_t * mpeg2dec, mpeg2_convert_t convert, void * arg);
 156 int mpeg2_stride (mpeg2dec_t * mpeg2dec, int stride);
 157 void mpeg2_set_buf (mpeg2dec_t * mpeg2dec, uint8_t * buf[3], void * id);
 158 void mpeg2_custom_fbuf (mpeg2dec_t * mpeg2dec, int custom_fbuf);
 159
 160 #define MPEG2_ACCEL_X86_MMX 1
 161 #define MPEG2_ACCEL_X86_3DNOW 2
 162 #define MPEG2_ACCEL_X86_MMXEXT 4
 163 #define MPEG2_ACCEL_X86_SSE2 8
 164 #define MPEG2_ACCEL_X86_SSE3 16
 165 #define MPEG2_ACCEL_PPC_ALTIVEC 1
 166 #define MPEG2_ACCEL_ALPHA 1
 167 #define MPEG2_ACCEL_ALPHA_MVI 2
 168 #define MPEG2_ACCEL_SPARC_VIS 1
 169 #define MPEG2_ACCEL_SPARC_VIS2 2
 170 #define MPEG2_ACCEL_ARM 1
 171 #define MPEG2_ACCEL_DETECT 0x80000000
 172
 173 uint32_t mpeg2_accel (uint32_t accel);
 174 mpeg2dec_t * mpeg2_init (void);
 175 const mpeg2_info_t * mpeg2_info (mpeg2dec_t * mpeg2dec);
 176 void mpeg2_close (mpeg2dec_t * mpeg2dec);
 177
 178 void mpeg2_buffer (mpeg2dec_t * mpeg2dec, uint8_t * start, uint8_t * end);
 179 int mpeg2_getpos (mpeg2dec_t * mpeg2dec);
 180 mpeg2_state_t mpeg2_parse (mpeg2dec_t * mpeg2dec);
 181
 182 void mpeg2_reset (mpeg2dec_t * mpeg2dec, int full_reset);
 183 void mpeg2_skip (mpeg2dec_t * mpeg2dec, int skip);
 184 void mpeg2_slice_region (mpeg2dec_t * mpeg2dec, int start, int end);
 185
 186 void mpeg2_tag_picture (mpeg2dec_t * mpeg2dec, uint32_t tag, uint32_t tag2);
 187
 188 void mpeg2_init_fbuf (mpeg2_decoder_t * decoder, uint8_t * current_fbuf[3],
 189                       uint8_t * forward_fbuf[3], uint8_t * backward_fbuf[3]);
 190 void mpeg2_slice (mpeg2_decoder_t * decoder, int code, const uint8_t * buffer);
 191 int mpeg2_guess_aspect (const mpeg2_sequence_t * sequence,
 192                         unsigned int * pixel_width,
 193                         unsigned int * pixel_height);
 194
 195 typedef enum {
 196     MPEG2_ALLOC_MPEG2DEC = 0,
 197     MPEG2_ALLOC_CHUNK = 1,
 198     MPEG2_ALLOC_YUV = 2,
 199     MPEG2_ALLOC_CONVERT_ID = 3,
 200     MPEG2_ALLOC_CONVERTED = 4
 201 } mpeg2_alloc_t;
 202
 203 void * mpeg2_malloc (unsigned size, mpeg2_alloc_t reason);
 204 void mpeg2_free (void * buf);
 205 void mpeg2_malloc_hooks (void * malloc (unsigned, mpeg2_alloc_t),
 206                          int free (void *));
 207
 208 #endif /* LIBMPEG2_MPEG2_H */