ecma_167.h

Go to the documentation of this file.

 /* 
  Copyright (c) 2005, 2006 Rocky Bernstein <rocky@cpan.org>
  Copyright (c) 2001-2002  Ben Fennema <bfennema@falcon.csc.calpoly.edu>
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
/*
 * Some portions taken from FreeBSD ecma167-udf.h which states:
 * Copyright (c) 2001, 2002 Scott Long <scottl@freebsd.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _ECMA_167_H
#define _ECMA_167_H 1

#include <cdio/types.h>

typedef enum {
  VSD_STD_ID_SIZE    =    5, 
  UDF_REGID_ID_SIZE  =   23, 
  UDF_VOLID_SIZE     =   32,
  UDF_FID_SIZE       =   38,
  UDF_VOLSET_ID_SIZE =  128
} ecma_167_enum1_t ;

typedef enum {
  TAGID_PRI_VOL          = 0x0001,
  TAGID_ANCHOR           = 0x0002,
  TAGID_VOL              = 0x0003,
  TAGID_IMP_VOL          = 0x0004,
  TAGID_PARTITION        = 0x0005,
  TAGID_LOGVOL           = 0x0006,
  TAGID_UNALLOC_SPACE    = 0x0007,
  TAGID_TERM             = 0x0008,
  TAGID_LOGVOL_INTEGRITY = 0x0009,
  TAGID_FSD              = 0x0100,
  TAGID_FID              = 0x0101,
  TAGID_AED              = 0x0102,
  TAGID_IE               = 0x0103,
  TAGID_TE               = 0x0104,
  TAGID_FILE_ENTRY       = 0x0105,
  TAGID_EAHD             = 0x0106,
  TAGID_USE              = 0x0107,
  TAGID_SBD              = 0x0108,
  TAGID_PIE              = 0x0109,
  TAGID_EFE              = 0x010A,
} tag_id_t ;

typedef enum {
  CHARSPEC_TYPE_CS0 = 0x00,     
  CHARSPEC_TYPE_CS1 = 0x01,     
  CHARSPEC_TYPE_CS2 = 0x02,     
  CHARSPEC_TYPE_CS3 = 0x03,     
  CHARSPEC_TYPE_CS4 = 0x04,     
  CHARSPEC_TYPE_CS5 = 0x05,     
  CHARSPEC_TYPE_CS6 = 0x06,     
  CHARSPEC_TYPE_CS7 = 0x07,     
  CHARSPEC_TYPE_CS8 = 0x08,     
} udf_charspec_enum_t;
  
typedef uint8_t  udf_Uint8_t;  
typedef uint16_t udf_Uint16_t; 
typedef uint32_t udf_Uint32_t; 
typedef uint64_t udf_Uint64_t; 
typedef char     udf_dstring;  
#define UDF_LENGTH_MASK 0x3fffffff

PRAGMA_BEGIN_PACKED

struct udf_charspec_s
{
  udf_Uint8_t   charset_type;
  udf_Uint8_t   charset_info[63];
} GNUC_PACKED;

typedef struct udf_charspec_s udf_charspec_t;

struct udf_timestamp_s
{
  udf_Uint16_t          type_tz;
  udf_Uint16_t          year;
  udf_Uint8_t           month;
  udf_Uint8_t           day;
  udf_Uint8_t           hour;
  udf_Uint8_t           minute;
  udf_Uint8_t           second;
  udf_Uint8_t           centiseconds;
  udf_Uint8_t           hundreds_of_microseconds;
  udf_Uint8_t           microseconds;
} GNUC_PACKED;

typedef struct udf_timestamp_s udf_timestamp_t;

typedef enum { 
  TIMESTAMP_TYPE_CUT        =   0x0000,
  TIMESTAMP_TYPE_LOCAL      =   0x1000,
  TIMESTAMP_TYPE_AGREEMENT  =   0x2000,
  TIMESTAMP_TYPE_MASK       =   0xF000,
  TIMESTAMP_TIMEZONE_MASK   =   0x0FFF,
} ecma_167_timezone_enum_t ;


#define TIMESTAMP_TYPE_MASK             0xF000
#define TIMESTAMP_TYPE_CUT              0x0000
#define TIMESTAMP_TYPE_LOCAL            0x1000
#define TIMESTAMP_TYPE_AGREEMENT        0x2000
#define TIMESTAMP_TIMEZONE_MASK         0x0FFF

struct udf_id_suffix_s
{
  udf_Uint16_t  udf_revision;
  udf_Uint8_t   os_class;
  udf_Uint8_t   os_identifier;
  udf_Uint8_t   reserved[4];
} GNUC_PACKED;

typedef struct udf_id_suffix_s udf_id_suffix_t;

struct udf_regid_s
{
  udf_Uint8_t           flags;
  udf_Uint8_t           id[UDF_REGID_ID_SIZE];
  udf_id_suffix_t       id_suffix;
} GNUC_PACKED;

typedef struct udf_regid_s udf_regid_t;

#define ENTITYID_FLAGS_DIRTY            0x00
#define ENTITYID_FLAGS_PROTECTED        0x01

struct vol_struct_desc_s
{
  udf_Uint8_t           struct_type;
  udf_Uint8_t           std_id[VSD_STD_ID_SIZE];
  udf_Uint8_t           struct_version;
  udf_Uint8_t           struct_data[2041];
} GNUC_PACKED;

#define VSD_STD_ID_NSR02                "NSR02" /* (3/9.1) */

/* The below const definitions are to faciltate debugging of the
   values #define'd below. */
extern const char VSD_STD_ID_BEA01[sizeof("BEA01")-1];
extern const char VSD_STD_ID_BOOT2[sizeof("BOOT2")-1];
extern const char VSD_STD_ID_CD001[sizeof("CD001")-1];
extern const char VSD_STD_ID_CDW01[sizeof("CDW02")-1];
extern const char VSD_STD_ID_NSR03[sizeof("NSR03")-1];
extern const char VSD_STD_ID_TEA01[sizeof("TEA01")-1];

#define VSD_STD_ID_BEA01                "BEA01" 
#define VSD_STD_ID_BOOT2                "BOOT2" 
#define VSD_STD_ID_CD001                "CD001" 
#define VSD_STD_ID_CDW02                "CDW02" 
#define VSD_STD_ID_NSR02                "NSR02" 
#define VSD_STD_ID_NSR03                "NSR03" 
#define VSD_STD_ID_TEA01                "TEA01" 
struct beginning_extended_area_desc_s
{
  udf_Uint8_t           struct_type;
  udf_Uint8_t           std_id[VSD_STD_ID_SIZE];
  udf_Uint8_t           struct_version;
  udf_Uint8_t           struct_data[2041];
} GNUC_PACKED;

struct terminating_extended_area_desc_s
{
  udf_Uint8_t           struct_type;
  udf_Uint8_t           std_id[VSD_STD_ID_SIZE];
  udf_Uint8_t           struct_version;
  udf_Uint8_t           struct_data[2041];
} GNUC_PACKED;

struct boot_desc_s
{
  udf_Uint8_t           struct_type;
  udf_Uint8_t           std_ident[VSD_STD_ID_SIZE];
  udf_Uint8_t           struct_version;
  udf_Uint8_t           reserved1;
  udf_regid_t           arch_type;
  udf_regid_t           boot_ident;
  udf_Uint32_t          bool_ext_location;
  udf_Uint32_t          bool_ext_length;
  udf_Uint64_t          load_address;
  udf_Uint64_t          start_address;
  udf_timestamp_t       desc_creation_time;
  udf_Uint16_t          flags;
  udf_Uint8_t           reserved2[32];
  udf_Uint8_t           boot_use[1906];
} GNUC_PACKED;

#define BOOT_FLAGS_ERASE                0x01

struct udf_extent_ad_s
{
  udf_Uint32_t          len;
  udf_Uint32_t          loc;
} GNUC_PACKED;

typedef struct udf_extent_ad_s udf_extent_ad_t;

struct udf_tag_s
{
  udf_Uint16_t          id;
  udf_Uint16_t          desc_version;
  udf_Uint8_t           cksum;
  udf_Uint8_t           reserved;
  udf_Uint16_t          i_serial;
  udf_Uint16_t          desc_CRC;
  udf_Uint16_t          desc_CRC_len;
  udf_Uint32_t          loc;
} GNUC_PACKED;

typedef struct udf_tag_s udf_tag_t;

struct NSR_desc_s
{
  udf_Uint8_t   struct_type;
  udf_Uint8_t   std_id[VSD_STD_ID_SIZE];
  udf_Uint8_t   struct_version;
  udf_Uint8_t   reserved;
  udf_Uint8_t   struct_data[2040];
} GNUC_PACKED;

struct udf_pvd_s
{
  udf_tag_t       tag;
  udf_Uint32_t    vol_desc_seq_num;
  udf_Uint32_t    primary_vol_desc_num;
  udf_dstring     vol_ident[UDF_VOLID_SIZE];
  udf_Uint16_t    vol_seq_num;
  udf_Uint16_t    max_vol_seqnum;
  udf_Uint16_t    interchange_lvl;
  udf_Uint16_t    max_interchange_lvl;
  udf_Uint32_t    charset_list;
  udf_Uint32_t    max_charset_list;
  udf_dstring     volset_id[UDF_VOLSET_ID_SIZE];
  udf_charspec_t  desc_charset;
  udf_charspec_t  explanatory_charset;
  udf_extent_ad_t vol_abstract;
  udf_extent_ad_t vol_copyright;
  udf_regid_t     app_ident;
  udf_timestamp_t recording_time;
  udf_regid_t     imp_ident;
  udf_Uint8_t     imp_use[64];
  udf_Uint32_t    predecessor_vol_desc_seq_location;
  udf_Uint16_t    flags;
  udf_Uint8_t     reserved[22];
} GNUC_PACKED;

typedef struct udf_pvd_s udf_pvd_t;

#define PVD_FLAGS_VSID_COMMON           0x0001

struct anchor_vol_desc_ptr_s
{
  udf_tag_t       tag;
  udf_extent_ad_t main_vol_desc_seq_ext;
  udf_extent_ad_t reserve_vol_desc_seq_ext;
  udf_Uint8_t     reserved[480];
} GNUC_PACKED;

typedef struct anchor_vol_desc_ptr_s anchor_vol_desc_ptr_t;

struct vol_desc_ptr_s
{
  udf_tag_t       tag;
  udf_Uint32_t    vol_desc_seq_num;
  udf_extent_ad_t next_vol_desc_set_ext;
  udf_Uint8_t     reserved[484];
} GNUC_PACKED;

struct imp_use_vol_desc_s
{
  udf_tag_t    tag;
  udf_Uint32_t vol_desc_seq_num;
  udf_regid_t  imp_id;
  udf_Uint8_t  imp_use[460];
} GNUC_PACKED;

struct partition_desc_s
{
  udf_tag_t     tag;
  udf_Uint32_t  vol_desc_seq_num;
  udf_Uint16_t  flags;
  udf_Uint16_t  number;             
  udf_regid_t   contents;
  udf_Uint8_t   contents_use[128];
  udf_Uint32_t  access_type;
  udf_Uint32_t  start_loc;
  udf_Uint32_t  part_len;
  udf_regid_t   imp_id;
  udf_Uint8_t   imp_use[128];
  udf_Uint8_t   reserved[156];
} GNUC_PACKED;

typedef struct partition_desc_s partition_desc_t;

#define PD_PARTITION_FLAGS_ALLOC        0x0001

#define PD_PARTITION_CONTENTS_NSR02     "+NSR02"

#define PD_PARTITION_CONTENTS_FDC01     "+FDC01"
#define PD_PARTITION_CONTENTS_CD001     "+CD001"
#define PD_PARTITION_CONTENTS_CDW02     "+CDW02"
#define PD_PARTITION_CONTENTS_NSR03     "+NSR03"

#define PD_ACCESS_TYPE_NONE             0x00000000
#define PD_ACCESS_TYPE_READ_ONLY        0x00000001
#define PD_ACCESS_TYPE_WRITE_ONCE       0x00000002
#define PD_ACCESS_TYPE_REWRITABLE       0x00000003
#define PD_ACCESS_TYPE_OVERWRITABLE     0x00000004

struct udf_lb_addr_s
{
  udf_Uint32_t  lba;
  udf_Uint16_t  partitionReferenceNum;
} GNUC_PACKED;

typedef struct udf_lb_addr_s udf_lb_addr_t;

struct udf_short_ad_s
{
  udf_Uint32_t  len;
  udf_Uint32_t  pos;
} GNUC_PACKED;

typedef struct udf_short_ad_s udf_short_ad_t;

struct udf_long_ad_s
{
  udf_Uint32_t  len;
  udf_lb_addr_t loc;
  udf_Uint8_t   imp_use[6];
} GNUC_PACKED;

typedef struct udf_long_ad_s udf_long_ad_t;

struct logical_vol_desc_s
{
  udf_tag_t       tag;
  udf_Uint32_t    seq_num;
  udf_charspec_t  desc_charset;
  udf_dstring     logvol_id[128];
  udf_Uint32_t    logical_blocksize;
  udf_regid_t     domain_id;
  union {
    udf_long_ad_t fsd_loc;
    udf_Uint8_t   logvol_content_use[16];
  } lvd_use;
  udf_Uint8_t     logvol_contents_use[16];
  udf_Uint32_t    maptable_len;
  udf_Uint32_t    i_partition_maps;
  udf_regid_t     imp_id;
  udf_Uint8_t     imp_use[128];
  udf_extent_ad_t integrity_seq_ext;
  udf_Uint8_t     partition_maps[0];
} GNUC_PACKED;

typedef struct logical_vol_desc_s logical_vol_desc_t;

struct generic_partition_map
{
  udf_Uint8_t   partition_map_type;
  udf_Uint8_t   partition_map_length;
  udf_Uint8_t   partition_mapping[0];
} GNUC_PACKED;

#define GP_PARTITION_MAP_TYPE_UNDEF     0x00
#define GP_PARTIITON_MAP_TYPE_1         0x01
#define GP_PARTITION_MAP_TYPE_2         0x02

struct generic_partition_map1
{
  udf_Uint8_t   partition_map_type;
  udf_Uint8_t   partition_map_length;
  udf_Uint16_t  vol_seq_num;
  udf_Uint16_t  i_partition;
} GNUC_PACKED;

struct generic_partition_map2
{
  udf_Uint8_t   partition_map_type;
  udf_Uint8_t   partition_map_length; 
  udf_Uint8_t   partition_id[62];
} GNUC_PACKED;

struct unalloc_space_desc_s
{
  udf_tag_t       tag;
  udf_Uint32_t    vol_desc_seq_num;
  udf_Uint32_t    i_alloc_descs;
  udf_extent_ad_t allocDescs[0];
} GNUC_PACKED;

struct terminating_desc_s
{
  udf_tag_t    tag;
  udf_Uint8_t   reserved[496];
} GNUC_PACKED;

struct logvol_integrity_desc_s
{
  udf_tag_t       tag;
  udf_timestamp_t recording_time;
  udf_Uint32_t    integrity_type;
  udf_extent_ad_t next_integrity_ext;
  udf_Uint8_t     logvol_contents_use[32];
  udf_Uint32_t    i_partitions;
  udf_Uint32_t    imp_use_len;
  udf_Uint32_t    freespace_table[0];
  udf_Uint32_t    size_table[0];
  udf_Uint8_t     imp_use[0];
} GNUC_PACKED;

#define LVID_INTEGRITY_TYPE_OPEN        0x00000000
#define LVID_INTEGRITY_TYPE_CLOSE       0x00000001

struct udf_ext_ad_s
{
  udf_Uint32_t  len;
  udf_Uint32_t  recorded_len;
  udf_Uint32_t  information_len;
  udf_lb_addr_t ext_loc;
} GNUC_PACKED;

typedef struct udf_ext_ad_s udf_ext_ad_t;

struct udf_fsd_s
{
  udf_tag_t       tag;
  udf_timestamp_t recording_time;
  udf_Uint16_t    interchange_lvl;
  udf_Uint16_t    maxInterchange_lvl;
  udf_Uint32_t    charset_list;
  udf_Uint32_t    max_charset_list;
  udf_Uint32_t    fileset_num;
  udf_Uint32_t    udf_fsd_num;
  udf_charspec_t  logical_vol_id_charset;
  udf_dstring     logical_vol_id[128];
  udf_charspec_t  fileset_charset;
  udf_dstring     fileSet_id[32];
  udf_dstring     copyright_file_id[32];
  udf_dstring     abstract_file_id[32];
  udf_long_ad_t   root_icb;
  udf_regid_t     domain_id;
  udf_long_ad_t   next_ext;
  udf_long_ad_t   stream_directory_ICB;
  udf_Uint8_t     reserved[32];
} GNUC_PACKED;

typedef struct udf_fsd_s udf_fsd_t;

struct partition_header_desc_s
{
  udf_short_ad_t unalloc_space_table;
  udf_short_ad_t unalloc_space_bitmap;
  udf_short_ad_t partition_integrity_table;
  udf_short_ad_t freed_space_table;
  udf_short_ad_t freed_space_bitmap;
  udf_Uint8_t    reserved[88];
} GNUC_PACKED;

typedef struct partition_header_desc_s partition_header_desc_t;

struct udf_fileid_desc_s
{
  udf_tag_t     tag;
  udf_Uint16_t  file_version_num;
  udf_Uint8_t   file_characteristics;
  udf_Uint8_t   i_file_id;
  udf_long_ad_t icb;
  udf_Uint16_t  i_imp_use;
  udf_Uint8_t   imp_use[0];
  udf_Uint8_t   file_id[0];
  udf_Uint8_t   padding[0];
} GNUC_PACKED;

typedef struct udf_fileid_desc_s udf_fileid_desc_t;

typedef enum {
  UDF_FILE_HIDDEN       = (1 << 0),
  UDF_FILE_DIRECTORY    = (1 << 1),
  UDF_FILE_DELETED      = (1 << 2),
  UDF_FILE_PARENT       = (1 << 3),
  UDF_FILE_METADATA     = (1 << 4)
} file_characteristics_t;

struct allocExtDesc
{
  udf_tag_t    tag;
  udf_Uint32_t previous_alloc_ext_loc;
  udf_Uint32_t i_alloc_descs;
} GNUC_PACKED;

struct udf_icbtag_s
{
  udf_Uint32_t  prev_num_dirs;
  udf_Uint16_t  strat_type;
  udf_Uint16_t  strat_param;
  udf_Uint16_t  max_num_entries;
  udf_Uint8_t   reserved;
  udf_Uint8_t   file_type;
  udf_lb_addr_t parent_ICB;
  udf_Uint16_t  flags;
} GNUC_PACKED;

typedef struct udf_icbtag_s udf_icbtag_t;

#define UDF_ICB_TAG_FLAGS_SETUID        0x40
#define UDF_ICB_TAG_FLAGS_SETGID        0x80
#define UDF_ICB_TAG_FLAGS_STICKY        0x100

#define ICBTAG_STRATEGY_TYPE_UNDEF 0x0000 
#define ICBTAG_STRATEGY_TYPE_1     0x0001 
#define ICBTAG_STRATEGY_TYPE_2     0x0002 
#define ICBTAG_STRATEGY_TYPE_3     0x0003 
#define ICBTAG_STRATEGY_TYPE_4     0x0004 
typedef enum {
  ICBTAG_FILE_TYPE_UNDEF =      0x00,
  ICBTAG_FILE_TYPE_USE =        0x01,
  ICBTAG_FILE_TYPE_PIE =        0x02,
  ICBTAG_FILE_TYPE_IE =         0x03,
  ICBTAG_FILE_TYPE_DIRECTORY =  0x04,
  ICBTAG_FILE_TYPE_REGULAR =    0x05,
  ICBTAG_FILE_TYPE_BLOCK =      0x06,
  ICBTAG_FILE_TYPE_CHAR =       0x07,
  ICBTAG_FILE_TYPE_EA =         0x08,
  ICBTAG_FILE_TYPE_FIFO =       0x09,
  ICBTAG_FILE_TYPE_SOCKET =     0x0A,
  ICBTAG_FILE_TYPE_TE =         0x0B,
  ICBTAG_FILE_TYPE_SYMLINK =    0x0C,
  ICBTAG_FILE_TYPE_STREAMDIR =  0x0D
} icbtag_file_type_enum_t;

typedef enum {
  ICBTAG_FLAG_AD_MASK        =  0x0007, 
  ICBTAG_FLAG_AD_SHORT       =  0x0000, 
  ICBTAG_FLAG_AD_LONG        =  0x0001, 
  ICBTAG_FLAG_AD_EXTENDED    =  0x0002,
  ICBTAG_FLAG_AD_IN_ICB      =  0x0003, 
  ICBTAG_FLAG_SORTED         =  0x0008,
  ICBTAG_FLAG_NONRELOCATABLE =  0x0010,
  ICBTAG_FLAG_ARCHIVE        =  0x0020,
  ICBTAG_FLAG_SETUID         =  0x0040,
  ICBTAG_FLAG_SETGID         =  0x0080,
  ICBTAG_FLAG_STICKY         =  0x0100,
  ICBTAG_FLAG_CONTIGUOUS     =  0x0200,
  ICBTAG_FLAG_SYSTEM         =  0x0400,
  ICBTAG_FLAG_TRANSFORMED    =  0x0800,
  ICBTAG_FLAG_MULTIVERSIONS  =  0x1000,
  ICBTAG_FLAG_STREAM =          0x2000
} icbtag_flag_enum_t;
  
struct indirect_entry_s
{
  udf_tag_t       tag;
  udf_icbtag_t    icb_tag;
  udf_long_ad_t   indirect_ICB;
} GNUC_PACKED;

struct terminal_entry_s
{
  udf_tag_t       tag;
  udf_icbtag_t    icb_tag;
} GNUC_PACKED;

struct udf_file_entry_s
{
  udf_tag_t       tag;                   
  udf_icbtag_t    icb_tag;                
  udf_Uint32_t    uid;                    
  udf_Uint32_t    gid;                    
  udf_Uint32_t    permissions;            
  udf_Uint16_t    link_count;             
  udf_Uint8_t     rec_format;             
  udf_Uint8_t     rec_disp_attr;          
  udf_Uint32_t    rec_len;                
  udf_Uint64_t    info_len;               
  udf_Uint64_t    logblks_recorded;       
  udf_timestamp_t access_time;            
  udf_timestamp_t modification_time;      
  udf_timestamp_t attribute_time;
  udf_Uint32_t    checkpoint;