git.sesse.net Git - vlc/blob - modules/demux/avi/libavi.h

   1 /*****************************************************************************
   2  * libavi.h : LibAVI library
   3  ******************************************************************************
   4  * Copyright (C) 2001-2003 the VideoLAN team
   5  * $Id$
   6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 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 General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, 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 typedef struct avi_chunk_common_s
  61 {
  62     AVI_CHUNK_COMMON
  63 } avi_chunk_common_t;
  64
  65 typedef struct avi_chunk_list_s
  66 {
  67     AVI_CHUNK_COMMON
  68     vlc_fourcc_t i_type;
  69 } avi_chunk_list_t;
  70
  71 typedef struct avi_chunk_idx1_s
  72 {
  73     AVI_CHUNK_COMMON
  74     unsigned int i_entry_count;
  75     unsigned int i_entry_max;
  76     idx1_entry_t *entry;
  77
  78 } avi_chunk_idx1_t;
  79
  80 typedef struct avi_chunk_avih_s
  81 {
  82     AVI_CHUNK_COMMON
  83     uint32_t i_microsecperframe;
  84     uint32_t i_maxbytespersec;
  85     uint32_t i_reserved1; /* dwPaddingGranularity;    pad to multiples of this
  86                              size; normally 2K */
  87     uint32_t i_flags;
  88     uint32_t i_totalframes;
  89     uint32_t i_initialframes;
  90     uint32_t i_streams;
  91     uint32_t i_suggestedbuffersize;
  92     uint32_t i_width;
  93     uint32_t i_height;
  94     uint32_t i_scale;
  95     uint32_t i_rate;
  96     uint32_t i_start;
  97     uint32_t i_length;
  98 } avi_chunk_avih_t;
  99
 100 typedef struct avi_chunk_strh_s
 101 {
 102     AVI_CHUNK_COMMON
 103     vlc_fourcc_t i_type;
 104     uint32_t i_handler;
 105     uint32_t i_flags;
 106     uint32_t i_reserved1;    /* wPriority wLanguage */
 107     uint32_t i_initialframes;
 108     uint32_t i_scale;
 109     uint32_t i_rate;
 110     uint32_t i_start;
 111     uint32_t i_length;       /* In units above... */
 112     uint32_t i_suggestedbuffersize;
 113     uint32_t i_quality;
 114     uint32_t i_samplesize;
 115 } avi_chunk_strh_t;
 116
 117 typedef struct avi_chunk_strf_auds_s
 118 {
 119     AVI_CHUNK_COMMON
 120     int             i_cat;
 121     WAVEFORMATEX    *p_wf;
 122 } avi_chunk_strf_auds_t;
 123
 124 typedef struct avi_chunk_strf_vids_s
 125 {
 126     AVI_CHUNK_COMMON
 127     int                     i_cat;
 128     VLC_BITMAPINFOHEADER    *p_bih;
 129 } avi_chunk_strf_vids_t;
 130
 131 typedef union avi_chunk_strf_u
 132 {
 133     avi_chunk_strf_auds_t   auds;
 134     avi_chunk_strf_vids_t   vids;
 135     struct
 136     {
 137         AVI_CHUNK_COMMON
 138         int i_cat;
 139     }                       common;
 140 } avi_chunk_strf_t;
 141
 142 typedef struct avi_chunk_strd_s
 143 {
 144     AVI_CHUNK_COMMON
 145     uint8_t  *p_data;
 146 } avi_chunk_strd_t;
 147
 148 typedef struct avi_chunk_vprp_s
 149 {
 150     AVI_CHUNK_COMMON
 151     uint32_t i_video_format_token;
 152     uint32_t i_video_standard;
 153     uint32_t i_vertical_refresh;
 154     uint32_t i_h_total_in_t;
 155     uint32_t i_v_total_in_lines;
 156     uint32_t i_frame_aspect_ratio;
 157     uint32_t i_frame_width_in_pixels;
 158     uint32_t i_frame_height_in_pixels;
 159     uint32_t i_nb_fields_per_frame;
 160     struct
 161     {
 162         uint32_t i_compressed_bm_height;
 163         uint32_t i_compressed_bm_width;
 164         uint32_t i_valid_bm_height;
 165         uint32_t i_valid_bm_width;
 166         uint32_t i_valid_bm_x_offset;
 167         uint32_t i_valid_bm_y_offset;
 168         uint32_t i_video_x_offset_in_t;
 169         uint32_t i_video_y_valid_start_line;
 170     } field_info[2];
 171
 172 } avi_chunk_vprp_t;
 173
 174
 175 #define AVI_INDEX_OF_INDEXES    0x00
 176 #define AVI_INDEX_OF_CHUNKS     0x01
 177 #define AVI_INDEX_IS_DATA       0x80
 178
 179 #define AVI_INDEX_2FIELD        0x01
 180 typedef struct
 181 {
 182     uint32_t i_offset;
 183     uint32_t i_size;
 184 } indx_std_entry_t;
 185
 186 typedef struct
 187 {
 188     uint32_t i_offset;
 189     uint32_t i_size;
 190     uint32_t i_offsetfield2;
 191 } indx_field_entry_t;
 192
 193 typedef struct
 194 {
 195     uint64_t i_offset;
 196     uint32_t i_size;
 197     uint32_t i_duration;
 198 } indx_super_entry_t;
 199
 200 typedef struct avi_chunk_indx_s
 201 {
 202     AVI_CHUNK_COMMON
 203     int16_t  i_longsperentry;
 204     int8_t   i_indexsubtype;
 205     int8_t   i_indextype;
 206     uint32_t i_entriesinuse;
 207     vlc_fourcc_t i_id;
 208
 209     int64_t i_baseoffset;
 210
 211     union
 212     {
 213         indx_std_entry_t    *std;
 214         indx_field_entry_t  *field;
 215         indx_super_entry_t  *super;
 216     } idx;
 217 } avi_chunk_indx_t;
 218
 219 typedef struct avi_chunk_STRING_s
 220 {
 221     AVI_CHUNK_COMMON
 222     char *p_type;
 223     char *p_str;
 224 } avi_chunk_STRING_t;
 225
 226 typedef union avi_chunk_u
 227 {
 228     avi_chunk_common_t  common;
 229     avi_chunk_list_t    list;
 230     avi_chunk_idx1_t    idx1;
 231     avi_chunk_avih_t    avih;
 232     avi_chunk_strh_t    strh;
 233     avi_chunk_strf_t    strf;
 234     avi_chunk_strd_t    strd;
 235     avi_chunk_vprp_t    vprp;
 236     avi_chunk_indx_t    indx;
 237     avi_chunk_STRING_t  strz;
 238 } avi_chunk_t;
 239
 240 /****************************************************************************
 241  * Stream(input) access functions
 242  ****************************************************************************/
 243 int     _AVI_ChunkRead( stream_t *,
 244                         avi_chunk_t *p_chk,
 245                         avi_chunk_t *p_father );
 246 void    _AVI_ChunkFree( stream_t *, avi_chunk_t * );
 247
 248 int     _AVI_ChunkCount( avi_chunk_t *, vlc_fourcc_t );
 249 void   *_AVI_ChunkFind ( avi_chunk_t *, vlc_fourcc_t, int );
 250
 251 int     AVI_ChunkReadRoot( stream_t *, avi_chunk_t *p_root );
 252 void    AVI_ChunkFreeRoot( stream_t *, avi_chunk_t  *p_chk );
 253
 254 #define AVI_ChunkRead( s, p_chk, p_father ) \
 255     _AVI_ChunkRead( s, p_chk, (avi_chunk_t*)p_father )
 256 #define AVI_ChunkCount( p_chk, i_fourcc ) \
 257     _AVI_ChunkCount( (avi_chunk_t*)p_chk, i_fourcc )
 258 #define AVI_ChunkFind( p_chk, i_fourcc, i_number ) \
 259     _AVI_ChunkFind( (avi_chunk_t*)p_chk, i_fourcc, i_number )
 260 #define AVI_ChunkFree( a, b ) \
 261     _AVI_ChunkFree( (a), (avi_chunk_t*)(b) )
 262
 263
 264     /* *** avi stuff *** */
 265
 266 #define AVIFOURCC_RIFF         VLC_FOURCC('R','I','F','F')
 267 #define AVIFOURCC_ON2          VLC_FOURCC('O','N','2',' ')
 268 #define AVIFOURCC_LIST         VLC_FOURCC('L','I','S','T')
 269 #define AVIFOURCC_JUNK         VLC_FOURCC('J','U','N','K')
 270 #define AVIFOURCC_AVI          VLC_FOURCC('A','V','I',' ')
 271 #define AVIFOURCC_AVIX         VLC_FOURCC('A','V','I','X')
 272 #define AVIFOURCC_ON2f         VLC_FOURCC('O','N','2','f')
 273 #define AVIFOURCC_WAVE         VLC_FOURCC('W','A','V','E')
 274 #define AVIFOURCC_INFO         VLC_FOURCC('I','N','F','O')
 275
 276 #define AVIFOURCC_avih         VLC_FOURCC('a','v','i','h')
 277 #define AVIFOURCC_ON2h         VLC_FOURCC('O','N','2','h')
 278 #define AVIFOURCC_hdrl         VLC_FOURCC('h','d','r','l')
 279 #define AVIFOURCC_movi         VLC_FOURCC('m','o','v','i')
 280 #define AVIFOURCC_idx1         VLC_FOURCC('i','d','x','1')
 281
 282 #define AVIFOURCC_strl         VLC_FOURCC('s','t','r','l')
 283 #define AVIFOURCC_strh         VLC_FOURCC('s','t','r','h')
 284 #define AVIFOURCC_strf         VLC_FOURCC('s','t','r','f')
 285 #define AVIFOURCC_strd         VLC_FOURCC('s','t','r','d')
 286 #define AVIFOURCC_strn         VLC_FOURCC('s','t','r','n')
 287 #define AVIFOURCC_indx         VLC_FOURCC('i','n','d','x')
 288 #define AVIFOURCC_vprp         VLC_FOURCC('v','p','r','p')
 289
 290 #define AVIFOURCC_rec          VLC_FOURCC('r','e','c',' ')
 291 #define AVIFOURCC_auds         VLC_FOURCC('a','u','d','s')
 292 #define AVIFOURCC_vids         VLC_FOURCC('v','i','d','s')
 293 #define AVIFOURCC_txts         VLC_FOURCC('t','x','t','s')
 294 #define AVIFOURCC_mids         VLC_FOURCC('m','i','d','s')
 295 #define AVIFOURCC_iavs         VLC_FOURCC('i','a','v','s')
 296 #define AVIFOURCC_ivas         VLC_FOURCC('i','v','a','s')
 297
 298 #define AVIFOURCC_IARL         VLC_FOURCC('I','A','R','L')
 299 #define AVIFOURCC_IART         VLC_FOURCC('I','A','R','T')
 300 #define AVIFOURCC_ICMS         VLC_FOURCC('I','C','M','S')
 301 #define AVIFOURCC_ICMT         VLC_FOURCC('I','C','M','T')
 302 #define AVIFOURCC_ICOP         VLC_FOURCC('I','C','O','P')
 303 #define AVIFOURCC_ICRD         VLC_FOURCC('I','C','R','D')
 304 #define AVIFOURCC_ICRP         VLC_FOURCC('I','C','R','P')
 305 #define AVIFOURCC_IDIM         VLC_FOURCC('I','D','I','M')
 306 #define AVIFOURCC_IDPI         VLC_FOURCC('I','D','P','I')
 307 #define AVIFOURCC_IENG         VLC_FOURCC('I','E','N','G')
 308 #define AVIFOURCC_IGNR         VLC_FOURCC('I','G','N','R')
 309 #define AVIFOURCC_IKEY         VLC_FOURCC('I','K','E','Y')
 310 #define AVIFOURCC_ILGT         VLC_FOURCC('I','L','G','T')
 311 #define AVIFOURCC_IMED         VLC_FOURCC('I','M','E','D')
 312 #define AVIFOURCC_INAM         VLC_FOURCC('I','N','A','M')
 313 #define AVIFOURCC_IPLT         VLC_FOURCC('I','P','L','T')
 314 #define AVIFOURCC_IPRD         VLC_FOURCC('I','P','R','D')
 315 #define AVIFOURCC_ISBJ         VLC_FOURCC('I','S','B','J')
 316 #define AVIFOURCC_ISFT         VLC_FOURCC('I','S','F','T')
 317 #define AVIFOURCC_ISHP         VLC_FOURCC('I','S','H','P')
 318 #define AVIFOURCC_ISRC         VLC_FOURCC('I','S','R','C')
 319 #define AVIFOURCC_ISRF         VLC_FOURCC('I','S','R','F')
 320 #define AVIFOURCC_ITCH         VLC_FOURCC('I','T','C','H')
 321 #define AVIFOURCC_ISMP         VLC_FOURCC('I','S','M','P')
 322 #define AVIFOURCC_IDIT         VLC_FOURCC('I','D','I','T')
 323
 324
 325 #define AVITWOCC_wb            VLC_TWOCC('w','b')
 326 #define AVITWOCC_db            VLC_TWOCC('d','b')
 327 #define AVITWOCC_dc            VLC_TWOCC('d','c')
 328 #define AVITWOCC_pc            VLC_TWOCC('p','c')
 329 #define AVITWOCC_AC            VLC_TWOCC('A','C')
 330 #define AVITWOCC_tx            VLC_TWOCC('t','x')
 331 #define AVITWOCC_sb            VLC_TWOCC('s','b')
 332
 333     /* *** codex stuff ***  */
 334
 335     /* DV */
 336 #define FOURCC_dvsd         VLC_FOURCC('d','v','s','d')
 337 #define FOURCC_dvhd         VLC_FOURCC('d','v','h','d')
 338 #define FOURCC_dvsl         VLC_FOURCC('d','v','s','l')
 339 #define FOURCC_dv25         VLC_FOURCC('d','v','2','5')
 340 #define FOURCC_dv50         VLC_FOURCC('d','v','5','0')