common.h 5.17 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2
 * common.h: common definitions
3
 * Collection of useful common types and macros definitions
4
 *****************************************************************************
5 6
 * Copyright (C) 1998, 1999, 2000 VideoLAN
 *
7 8
 * Authors: Samuel Hocevar <sam@via.ecp.fr>
 *          Vincent Seguin <seguin@via.ecp.fr>
9 10 11 12 13
 *
 * 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.
14
 * 
15 16
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
19
 *
20 21 22
 * 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, USA.
23 24 25
 *****************************************************************************/

/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
26 27
 * required headers:
 *  config.h
28
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
29

30
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
31
 * Basic types definitions
32
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
33

Michel Lespinasse's avatar
 
Michel Lespinasse committed
34
#include "int_types.h"
Michel Kaempf's avatar
Michel Kaempf committed
35 36

typedef u8                  byte_t;
37

Michel Kaempf's avatar
Michel Kaempf committed
38 39
/* Boolean type */
typedef int                 boolean_t;
40 41 42
#ifdef SYS_GNU
#define _MACH_I386_BOOLEAN_H_
#endif
Michel Kaempf's avatar
Michel Kaempf committed
43 44 45 46

/* Counter for statistics and profiling */
typedef unsigned long       count_t;

47
/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
48
 * Classes declaration
49
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
50

51 52 53 54 55 56 57 58 59 60 61 62
/* Plugins */
struct plugin_bank_s;
struct plugin_info_s;

typedef struct plugin_bank_s *          p_plugin_bank_t;
typedef struct plugin_info_s *          p_plugin_info_t;

/* Playlist */
struct playlist_s;

typedef struct playlist_s *             p_playlist_t;

Vincent Seguin's avatar
Vincent Seguin committed
63 64 65 66 67
/* Interface */
struct intf_thread_s;
struct intf_sys_s;
struct intf_console_s;
struct intf_msg_s;
68
struct intf_channel_s;
Vincent Seguin's avatar
Vincent Seguin committed
69 70 71 72 73

typedef struct intf_thread_s *          p_intf_thread_t;
typedef struct intf_sys_s *             p_intf_sys_t;
typedef struct intf_console_s *         p_intf_console_t;
typedef struct intf_msg_s *             p_intf_msg_t;
74
typedef struct intf_channel_s *         p_intf_channel_t;
Vincent Seguin's avatar
Vincent Seguin committed
75 76 77

/* Input */
struct input_thread_s;
78
struct input_vlan_s;
Vincent Seguin's avatar
Vincent Seguin committed
79 80 81
struct input_cfg_s;

typedef struct input_thread_s *         p_input_thread_t;
82
typedef struct input_vlan_s *           p_input_vlan_t;
Vincent Seguin's avatar
Vincent Seguin committed
83 84 85 86
typedef struct input_cfg_s *            p_input_cfg_t;

/* Audio */
struct aout_thread_s;
87
struct aout_sys_s;
Vincent Seguin's avatar
Vincent Seguin committed
88 89

typedef struct aout_thread_s *          p_aout_thread_t;
90
typedef struct aout_sys_s *             p_aout_sys_t;
Vincent Seguin's avatar
Vincent Seguin committed
91 92 93

/* Video */
struct vout_thread_s;
Vincent Seguin's avatar
Vincent Seguin committed
94
struct vout_font_s;
Vincent Seguin's avatar
Vincent Seguin committed
95 96 97 98 99 100
struct vout_sys_s;
struct vdec_thread_s;
struct vpar_thread_s;
struct video_parser_s;

typedef struct vout_thread_s *          p_vout_thread_t;
Vincent Seguin's avatar
Vincent Seguin committed
101
typedef struct vout_font_s *            p_vout_font_t;
Vincent Seguin's avatar
Vincent Seguin committed
102 103 104 105 106
typedef struct vout_sys_s *             p_vout_sys_t;
typedef struct vdec_thread_s *          p_vdec_thread_t;
typedef struct vpar_thread_s *          p_vpar_thread_t;
typedef struct video_parser_s *         p_video_parser_t;

107
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
108
 * Macros and inline functions
109
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
110 111 112 113 114 115 116 117

/* CEIL: division with round to nearest greater integer */
#define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )

/* PAD: PAD(n, d) = CEIL(n ,d) * d */
#define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )

/* MAX and MIN: self explanatory */
118
#ifndef MAX
Michel Kaempf's avatar
Michel Kaempf committed
119
#define MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
120 121
#endif
#ifndef MIN
Michel Kaempf's avatar
Michel Kaempf committed
122
#define MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
123
#endif
Michel Kaempf's avatar
Michel Kaempf committed
124

125
/* MSB (big endian)/LSB (little endian) convertions - network order is always
Michel Kaempf's avatar
Michel Kaempf committed
126 127 128 129
 * MSB, and should be used for both network communications and files. Note that
 * byte orders other than little and big endians are not supported, but only
 * the VAX seems to have such exotic properties - note that these 'functions'
 * needs <netinet/in.h> or the local equivalent. */
130
/* FIXME??: hton64 should be declared as an extern inline function to avoid border
Michel Kaempf's avatar
Michel Kaempf committed
131 132 133 134 135
 * effects (see byteorder.h) */
#if __BYTE_ORDER == __LITTLE_ENDIAN
#define hton16      htons
#define hton32      htonl
#define hton64(i)   ( ((u64)(htonl((i) & 0xffffffff)) << 32) | htonl(((i) >> 32) & 0xffffffff ) )
136
#define ntoh16      ntohs
Michel Kaempf's avatar
Michel Kaempf committed
137 138 139 140 141
#define ntoh32      ntohl
#define ntoh64      hton64
#elif __BYTE_ORDER == __BIG_ENDIAN
#define hton16      htons
#define hton32      htonl
142
#define hton64(i)   ( i )
Michel Kaempf's avatar
Michel Kaempf committed
143 144 145 146
#define ntoh16      ntohs
#define ntoh32      ntohl
#define ntoh64(i)   ( i )
#else
147
/* XXX??: cause a compilation error */
Michel Kaempf's avatar
Michel Kaempf committed
148 149 150 151 152
#endif

/* Macros used by input to access the TS buffer */
#define U32_AT(p)   ( ntohl ( *( (u32 *)(p) ) ) )
#define U16_AT(p)   ( ntohs ( *( (u16 *)(p) ) ) )