git.sesse.net Git - vlc/blob - include/common.h

   1 /*****************************************************************************
   2  * common.h: common definitions
   3  * (c)1998 VideoLAN
   4  *****************************************************************************
   5  * Collection of usefull common types and macros definitions
   6  *****************************************************************************
   7  * required headers:
   8  *  config.h
   9  *****************************************************************************/
  10
  11 /*****************************************************************************
  12  * Basic types definitions
  13  *****************************************************************************/
  14
  15 /* Basic types definitions */
  16 typedef signed char         s8;
  17 typedef signed short        s16;
  18 typedef signed int          s32;
  19 typedef signed long long    s64;
  20 typedef unsigned char       u8;
  21 typedef unsigned short      u16;
  22 typedef unsigned int        u32;
  23 typedef unsigned long long  u64;
  24
  25 typedef u8                  byte_t;
  26
  27 /* Boolean type */
  28 typedef int                 boolean_t;
  29
  30 /* Counter for statistics and profiling */
  31 typedef unsigned long       count_t;
  32
  33 /*****************************************************************************
  34  * Classes declaration
  35  *****************************************************************************/
  36
  37 /* Interface */
  38 struct intf_thread_s;
  39 struct intf_sys_s;
  40 struct intf_console_s;
  41 struct intf_msg_s;
  42 struct intf_channel_s;
  43
  44 typedef struct intf_thread_s *          p_intf_thread_t;
  45 typedef struct intf_sys_s *             p_intf_sys_t;
  46 typedef struct intf_console_s *         p_intf_console_t;
  47 typedef struct intf_msg_s *             p_intf_msg_t;
  48 typedef struct intf_channel_s *         p_intf_channel_t;
  49
  50 /* Input */
  51 struct input_thread_s;
  52 struct input_vlan_s;
  53 struct input_cfg_s;
  54
  55 typedef struct input_thread_s *         p_input_thread_t;
  56 typedef struct input_vlan_s *           p_input_vlan_t;
  57 typedef struct input_cfg_s *            p_input_cfg_t;
  58
  59 /* Audio */
  60 struct aout_thread_s;
  61
  62 typedef struct aout_thread_s *          p_aout_thread_t;
  63
  64 /* Video */
  65 struct vout_thread_s;
  66 struct vout_font_s;
  67 struct vout_sys_s;
  68 struct vdec_thread_s;
  69 struct vpar_thread_s;
  70 struct video_parser_s;
  71
  72 typedef struct vout_thread_s *          p_vout_thread_t;
  73 typedef struct vout_font_s *            p_vout_font_t;
  74 typedef struct vout_sys_s *             p_vout_sys_t;
  75 typedef struct vdec_thread_s *          p_vdec_thread_t;
  76 typedef struct vpar_thread_s *          p_vpar_thread_t;
  77 typedef struct video_parser_s *         p_video_parser_t;
  78
  79 /*****************************************************************************
  80  * Macros and inline functions
  81  *****************************************************************************/
  82
  83 /* CEIL: division with round to nearest greater integer */
  84 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
  85
  86 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
  87 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
  88
  89 /* MAX and MIN: self explanatory */
  90 #define MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
  91 #define MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
  92
  93 /* MSB (big endian)/LSB (little endian) convertions - network order is always
  94  * MSB, and should be used for both network communications and files. Note that
  95  * byte orders other than little and big endians are not supported, but only
  96  * the VAX seems to have such exotic properties - note that these 'functions'
  97  * needs <netinet/in.h> or the local equivalent. */
  98 /* ?? hton64 should be declared as an extern inline function to avoid border
  99  * effects (see byteorder.h) */
 100 #if __BYTE_ORDER == __LITTLE_ENDIAN
 101 #define hton16      htons
 102 #define hton32      htonl
 103 #define hton64(i)   ( ((u64)(htonl((i) & 0xffffffff)) << 32) | htonl(((i) >> 32) & 0xffffffff ) )
 104 #define ntoh16      ntohs
 105 #define ntoh32      ntohl
 106 #define ntoh64      hton64
 107 #elif __BYTE_ORDER == __BIG_ENDIAN
 108 #define hton16      htons
 109 #define hton32      htonl
 110 #define hton64(i)   ( i )
 111 #define ntoh16      ntohs
 112 #define ntoh32      ntohl
 113 #define ntoh64(i)   ( i )
 114 #else
 115 /* ?? cause a compilation error */
 116 #endif
 117
 118 /* Macros used by input to access the TS buffer */
 119 #define U32_AT(p)   ( ntohl ( *( (u32 *)(p) ) ) )
 120 #define U16_AT(p)   ( ntohs ( *( (u16 *)(p) ) ) )