modules/demux/avi/libavi.h

   1 /*****************************************************************************
   2  * libavi.h : LibAVI library
   3  ******************************************************************************
   4  * Copyright (C) 2001-2003 VLC authors and VideoLAN
   5  * $Id$
   6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License as published by
  10  * the Free Software Foundation; either version 2.1 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program 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
  16  * GNU Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 /* flags for use in <dwFlags> in AVIFileHdr */
  24 #define AVIF_HASINDEX       0x00000010  /* Index at end of file? */
  25 #define AVIF_MUSTUSEINDEX   0x00000020
  26 #define AVIF_ISINTERLEAVED  0x00000100
  27 #define AVIF_TRUSTCKTYPE    0x00000800  /* Use CKType to find key frames? */
  28 #define AVIF_WASCAPTUREFILE 0x00010000
  29 #define AVIF_COPYRIGHTED    0x00020000
  30
  31 /* Flags for index */
  32 #define AVIIF_LIST          0x00000001L /* chunk is a 'LIST' */
  33 #define AVIIF_KEYFRAME      0x00000010L /* this frame is a key frame.*/
  34 #define AVIIF_NOTIME        0x00000100L /* this frame doesn't take any time */
  35 #define AVIIF_COMPUSE       0x0FFF0000L /* these bits are for compressor use */
  36
  37 #define AVIIF_FIXKEYFRAME   0x00001000L /* invented; used to say that */
  38                                         /* the keyframe flag isn't a true flag */
  39                                         /* but have to be verified */
  40
  41 #define AVI_CHUNK_COMMON           \
  42     vlc_fourcc_t i_chunk_fourcc;   \
  43     uint64_t i_chunk_size;         \
  44     uint64_t i_chunk_pos;          \
  45     union  avi_chunk_u *p_next;    \
  46     union  avi_chunk_u *p_father;  \
  47     union  avi_chunk_u *p_first;   \
  48     union  avi_chunk_u *p_last;
  49
  50 #define AVI_CHUNK( p_chk ) (avi_chunk_t*)(p_chk)
  51
  52 typedef struct idx1_entry_s
  53 {
  54     vlc_fourcc_t i_fourcc;
  55     uint32_t i_flags;
  56     uint32_t i_pos;
  57     uint32_t i_length;
  58
  59 } idx1_entry_t;
  60
  61 typedef struct avi_chunk_common_s
  62 {
  63     AVI_CHUNK_COMMON
  64 } avi_chunk_common_t;
  65
  66 typedef struct avi_chunk_list_s
  67 {
  68     AVI_CHUNK_COMMON
  69     vlc_fourcc_t i_type;
  70 } avi_chunk_list_t;
  71
  72 typedef struct avi_chunk_idx1_s
  73 {
  74     AVI_CHUNK_COMMON
  75     unsigned int i_entry_count;
  76     unsigned int i_entry_max;
  77     idx1_entry_t *entry;
  78
  79 } avi_chunk_idx1_t;
  80
  81 typedef struct avi_chunk_avih_s
  82 {
  83     AVI_CHUNK_COMMON
  84     uint32_t i_microsecperframe;
  85     uint32_t i_maxbytespersec;
  86     uint32_t i_reserved1; /* dwPaddingGranularity;    pad to multiples of this
  87                              size; normally 2K */
  88     uint32_t i_flags;
  89     uint32_t i_totalframes;
  90     uint32_t i_initialframes;
  91     uint32_t i_streams;
  92     uint32_t i_suggestedbuffersize;
  93     uint32_t i_width;
  94     uint32_t i_height;
  95     uint32_t i_scale;
  96     uint32_t i_rate;
  97     uint32_t i_start;
  98     uint32_t i_length;
  99 } avi_chunk_avih_t;
 100
 101 typedef struct avi_chunk_strh_s
 102 {
 103     AVI_CHUNK_COMMON
 104     vlc_fourcc_t i_type;
 105     uint32_t i_handler;
 106     uint32_t i_flags;
 107     uint32_t i_reserved1;    /* wPriority wLanguage */
 108     uint32_t i_initialframes;
 109     uint32_t i_scale;
 110     uint32_t i_rate;
 111     uint32_t i_start;
 112     uint32_t i_length;       /* In units above... */
 113     uint32_t i_suggestedbuffersize;
 114     uint32_t i_quality;
 115     uint32_t i_samplesize;
 116 } avi_chunk_strh_t;
 117
 118 typedef struct avi_chunk_strf_auds_s
 119 {
 120     AVI_CHUNK_COMMON
 121     int             i_cat;
 122     WAVEFORMATEX    *p_wf;
 123 } avi_chunk_strf_auds_t;
 124
 125 typedef struct avi_chunk_strf_vids_s
 126 {
 127     AVI_CHUNK_COMMON
 128     int                     i_cat;
 129     VLC_BITMAPINFOHEADER    *p_bih;
 130 } avi_chunk_strf_vids_t;
 131
 132 typedef union avi_chunk_strf_u
 133 {
 134     avi_chunk_strf_auds_t   auds;
 135     avi_chunk_strf_vids_t   vids;
 136     struct
 137     {
 138         AVI_CHUNK_COMMON
 139         int i_cat;
 140     }                       common;
 141 } avi_chunk_strf_t;
 142
 143 typedef struct avi_chunk_strd_s
 144 {
 145     AVI_CHUNK_COMMON
 146     uint8_t  *p_data;
 147 } avi_chunk_strd_t;
 148
 149 typedef struct avi_chunk_vprp_s
 150 {
 151     AVI_CHUNK_COMMON
 152     uint32_t i_video_format_token;
 153     uint32_t i_video_standard;
 154     uint32_t i_vertical_refresh;
 155     uint32_t i_h_total_in_t;
 156     uint32_t i_v_total_in_lines;
 157     uint32_t i_frame_aspect_ratio;
 158     uint32_t i_frame_width_in_pixels;
 159     uint32_t i_frame_height_in_pixels;
 160     uint32_t i_nb_fields_per_frame;
 161     struct
 162     {
 163         uint32_t i_compressed_bm_height;
 164         uint32_t i_compressed_bm_width;
 165         uint32_t i_valid_bm_height;
 166         uint32_t i_valid_bm_width;
 167         uint32_t i_valid_bm_x_offset;
 168         uint32_t i_valid_bm_y_offset;
 169         uint32_t i_video_x_offset_in_t;
 170         uint32_t i_video_y_valid_start_line;
 171     } field_info[2];
 172
 173 } avi_chunk_vprp_t;
 174
 175 typedef struct avi_chunk_dmlh_s
 176 {
 177     AVI_CHUNK_COMMON
 178     uint32_t dwTotalFrames;
 179 } avi_chunk_dmlh_t;
 180
 181 #define AVI_ZEROSIZED_CHUNK     0xFF
 182 #define AVI_ZERO_FOURCC         0xFE
 183
 184 #define AVI_INDEX_OF_INDEXES    0x00
 185 #define AVI_INDEX_OF_CHUNKS     0x01
 186 #define AVI_INDEX_IS_DATA       0x80
 187
 188 #define AVI_INDEX_2FIELD        0x01
 189 typedef struct
 190 {
 191     uint32_t i_offset;
 192     uint32_t i_size;
 193 } indx_std_entry_t;
 194
 195 typedef struct
 196 {
 197     uint32_t i_offset;
 198     uint32_t i_size;
 199     uint32_t i_offsetfield2;
 200 } indx_field_entry_t;
 201
 202 typedef struct
 203 {
 204     uint64_t i_offset;
 205     uint32_t i_size;
 206     uint32_t i_duration;
 207 } indx_super_entry_t;
 208
 209 typedef struct avi_chunk_indx_s
 210 {
 211     AVI_CHUNK_COMMON
 212     int16_t  i_longsperentry;
 213     int8_t   i_indexsubtype;
 214     int8_t   i_indextype;
 215     uint32_t i_entriesinuse;
 216     vlc_fourcc_t i_id;
 217
 218     int64_t i_baseoffset;
 219
 220     union
 221     {
 222         indx_std_entry_t    *std;
 223         indx_field_entry_t  *field;
 224         indx_super_entry_t  *super;
 225     } idx;
 226 } avi_chunk_indx_t;
 227
 228 typedef struct avi_chunk_STRING_s
 229 {
 230     AVI_CHUNK_COMMON
 231     char *p_type;
 232     char *p_str;
 233 } avi_chunk_STRING_t;
 234
 235 typedef union avi_chunk_u
 236 {
 237     avi_chunk_common_t  common;
 238     avi_chunk_list_t    list;
 239     avi_chunk_idx1_t    idx1;
 240     avi_chunk_avih_t    avih;
 241     avi_chunk_strh_t    strh;
 242     avi_chunk_strf_t    strf;
 243     avi_chunk_strd_t    strd;
 244     avi_chunk_vprp_t    vprp;
 245     avi_chunk_indx_t    indx;
 246     avi_chunk_STRING_t  strz;
 247 } avi_chunk_t;
 248
 249 /****************************************************************************
 250  * Stream(input) access functions
 251  ****************************************************************************/
 252 int     AVI_ChunkRead( stream_t *,
 253                        avi_chunk_t *p_chk,
 254                        avi_chunk_t *p_father );
 255 void    AVI_ChunkClean( stream_t *, avi_chunk_t * );
 256
 257 int     AVI_ChunkCount_( avi_chunk_t *, vlc_fourcc_t, bool );
 258 void   *AVI_ChunkFind_ ( avi_chunk_t *, vlc_fourcc_t, int, bool );
 259
 260 int     AVI_ChunkReadRoot( stream_t *, avi_chunk_t *p_root );
 261 void    AVI_ChunkFreeRoot( stream_t *, avi_chunk_t *p_chk  );
 262 int     AVI_ChunkFetchIndexes( stream_t *, avi_chunk_t *p_riff );
 263
 264 #define AVI_ChunkCount( p_chk, i_fourcc, b_list ) \
 265     AVI_ChunkCount_( AVI_CHUNK(p_chk), i_fourcc, b_list )
 266 #define AVI_ChunkFind( p_chk, i_fourcc, i_number, b_list ) \
 267     AVI_ChunkFind_( AVI_CHUNK(p_chk), i_fourcc, i_number, b_list )
 268
 269 /* *** avi stuff *** */
 270
 271 #define AVIFOURCC_RIFF         VLC_FOURCC('R','I','F','F')
 272 #define AVIFOURCC_ON2          VLC_FOURCC('O','N','2',' ')
 273 #define AVIFOURCC_LIST         VLC_FOURCC('L','I','S','T')
 274 #define AVIFOURCC_JUNK         VLC_FOURCC('J','U','N','K')
 275 #define AVIFOURCC_AVI          VLC_FOURCC('A','V','I',' ')
 276 #define AVIFOURCC_AVIX         VLC_FOURCC('A','V','I','X')
 277 #define AVIFOURCC_ON2f         VLC_FOURCC('O','N','2','f')
 278 #define AVIFOURCC_WAVE         VLC_FOURCC('W','A','V','E')
 279 #define AVIFOURCC_INFO         VLC_FOURCC('I','N','F','O')
 280
 281 #define AVIFOURCC_avih         VLC_FOURCC('a','v','i','h')
 282 #define AVIFOURCC_ON2h         VLC_FOURCC('O','N','2','h')
 283 #define AVIFOURCC_hdrl         VLC_FOURCC('h','d','r','l')
 284 #define AVIFOURCC_movi         VLC_FOURCC('m','o','v','i')
 285 #define AVIFOURCC_idx1         VLC_FOURCC('i','d','x','1')
 286
 287 #define AVIFOURCC_strl         VLC_FOURCC('s','t','r','l')
 288 #define AVIFOURCC_strh         VLC_FOURCC('s','t','r','h')
 289 #define AVIFOURCC_strf         VLC_FOURCC('s','t','r','f')
 290 #define AVIFOURCC_strd         VLC_FOURCC('s','t','r','d')
 291 #define AVIFOURCC_strn         VLC_FOURCC('s','t','r','n')
 292 #define AVIFOURCC_indx         VLC_FOURCC('i','n','d','x')
 293 #define AVIFOURCC_vprp         VLC_FOURCC('v','p','r','p')
 294 #define AVIFOURCC_dmlh         VLC_FOURCC('d','m','l','h')
 295
 296 #define AVIFOURCC_rec          VLC_FOURCC('r','e','c',' ')
 297 #define AVIFOURCC_auds         VLC_FOURCC('a','u','d','s')
 298 #define AVIFOURCC_vids         VLC_FOURCC('v','i','d','s')
 299 #define AVIFOURCC_txts         VLC_FOURCC('t','x','t','s')
 300 #define AVIFOURCC_mids         VLC_FOURCC('m','i','d','s')
 301 #define AVIFOURCC_iavs         VLC_FOURCC('i','a','v','s')
 302 #define AVIFOURCC_ivas         VLC_FOURCC('i','v','a','s')
 303
 304 #define AVIFOURCC_IARL         VLC_FOURCC('I','A','R','L')
 305 #define AVIFOURCC_IART         VLC_FOURCC('I','A','R','T')
 306 #define AVIFOURCC_ICMS         VLC_FOURCC('I','C','M','S')
 307 #define AVIFOURCC_ICMT         VLC_FOURCC('I','C','M','T')
 308 #define AVIFOURCC_ICOP         VLC_FOURCC('I','C','O','P')
 309 #define AVIFOURCC_ICRD         VLC_FOURCC('I','C','R','D')
 310 #define AVIFOURCC_ICRP         VLC_FOURCC('I','C','R','P')
 311 #define AVIFOURCC_IDIM         VLC_FOURCC('I','D','I','M')
 312 #define AVIFOURCC_IDPI         VLC_FOURCC('I','D','P','I')
 313 #define AVIFOURCC_IENG         VLC_FOURCC('I','E','N','G')
 314 #define AVIFOURCC_IGNR         VLC_FOURCC('I','G','N','R')
 315 #define AVIFOURCC_ISGN         VLC_FOURCC('I','S','G','N')
 316 #define AVIFOURCC_IKEY         VLC_FOURCC('I','K','E','Y')
 317 #define AVIFOURCC_ILGT         VLC_FOURCC('I','L','G','T')
 318 #define AVIFOURCC_IMED         VLC_FOURCC('I','M','E','D')
 319 #define AVIFOURCC_INAM         VLC_FOURCC('I','N','A','M')
 320 #define AVIFOURCC_IPLT         VLC_FOURCC('I','P','L','T')
 321 #define AVIFOURCC_IPRD         VLC_FOURCC('I','P','R','D')
 322 #define AVIFOURCC_ISBJ         VLC_FOURCC('I','S','B','J')
 323 #define AVIFOURCC_ISFT         VLC_FOURCC('I','S','F','T')
 324 #define AVIFOURCC_ISHP         VLC_FOURCC('I','S','H','P')
 325 #define AVIFOURCC_ISRC         VLC_FOURCC('I','S','R','C')
 326 #define AVIFOURCC_ISRF         VLC_FOURCC('I','S','R','F')
 327 #define AVIFOURCC_ITCH         VLC_FOURCC('I','T','C','H')
 328 #define AVIFOURCC_ISMP         VLC_FOURCC('I','S','M','P')
 329 #define AVIFOURCC_IDIT         VLC_FOURCC('I','D','I','T')
 330 #define AVIFOURCC_ILNG         VLC_FOURCC('I','L','N','G')
 331 #define AVIFOURCC_IRTD         VLC_FOURCC('I','R','T','D')
 332 #define AVIFOURCC_IWEB         VLC_FOURCC('I','W','E','B')
 333 #define AVIFOURCC_IPRT         VLC_FOURCC('I','P','R','T')
 334 #define AVIFOURCC_IWRI         VLC_FOURCC('I','W','R','I')
 335 #define AVIFOURCC_IPRO         VLC_FOURCC('I','P','R','O')
 336 #define AVIFOURCC_ICNM         VLC_FOURCC('I','C','N','M')
 337 #define AVIFOURCC_IPDS         VLC_FOURCC('I','P','D','S')
 338 #define AVIFOURCC_IEDT         VLC_FOURCC('I','E','D','T')
 339 #define AVIFOURCC_ICDS         VLC_FOURCC('I','C','D','S')
 340 #define AVIFOURCC_IMUS         VLC_FOURCC('I','M','U','S')
 341 #define AVIFOURCC_ISTD         VLC_FOURCC('I','S','T','D')
 342 #define AVIFOURCC_IDST         VLC_FOURCC('I','D','S','T')
 343 #define AVIFOURCC_ICNT         VLC_FOURCC('I','C','N','T')
 344 #define AVIFOURCC_ISTR         VLC_FOURCC('I','S','T','R')
 345 #define AVIFOURCC_IFRM         VLC_FOURCC('I','F','R','M')
 346
 347 #define AVIFOURCC_IAS1         VLC_FOURCC('I','A','S','1')
 348 #define AVIFOURCC_IAS2         VLC_FOURCC('I','A','S','2')
 349 #define AVIFOURCC_IAS3         VLC_FOURCC('I','A','S','3')
 350 #define AVIFOURCC_IAS4         VLC_FOURCC('I','A','S','4')
 351 #define AVIFOURCC_IAS5         VLC_FOURCC('I','A','S','5')
 352 #define AVIFOURCC_IAS6         VLC_FOURCC('I','A','S','6')
 353 #define AVIFOURCC_IAS7         VLC_FOURCC('I','A','S','7')
 354 #define AVIFOURCC_IAS8         VLC_FOURCC('I','A','S','8')
 355 #define AVIFOURCC_IAS9         VLC_FOURCC('I','A','S','9')
 356
 357 #define AVITWOCC_wb            VLC_TWOCC('w','b')
 358 #define AVITWOCC_db            VLC_TWOCC('d','b')
 359 #define AVITWOCC_dc            VLC_TWOCC('d','c')
 360 #define AVITWOCC_pc            VLC_TWOCC('p','c')
 361 #define AVITWOCC_AC            VLC_TWOCC('A','C')
 362 #define AVITWOCC_tx            VLC_TWOCC('t','x')
 363 #define AVITWOCC_sb            VLC_TWOCC('s','b')
 364
 365 /* *** codex stuff ***  */
 366
 367 /* DV */
 368 #define FOURCC_dvsd         VLC_FOURCC('d','v','s','d')
 369 #define FOURCC_dvhd         VLC_FOURCC('d','v','h','d')
 370 #define FOURCC_dvsl         VLC_FOURCC('d','v','s','l')
 371 #define FOURCC_dv25         VLC_FOURCC('d','v','2','5')
 372 #define FOURCC_dv50         VLC_FOURCC('d','v','5','0')