vlc_common.h 28.6 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3 4
/*****************************************************************************
 * common.h: common definitions
 * Collection of useful common types and macros definitions
 *****************************************************************************
5
 * Copyright (C) 1998-2005 the VideoLAN team
6
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
7 8 9
 *
 * Authors: Samuel Hocevar <sam@via.ecp.fr>
 *          Vincent Seguin <seguin@via.ecp.fr>
10
 *          Gildas Bazin <gbazin@videolan.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
11 12 13 14 15
 *
 * 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.
16
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
17 18 19 20 21 22 23
 * 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
Antoine Cellerier's avatar
Antoine Cellerier committed
24
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
25 26
 *****************************************************************************/

Clément Stenac's avatar
Clément Stenac committed
27
/**
Sam Hocevar's avatar
Sam Hocevar committed
28
 * \file
Clément Stenac's avatar
Clément Stenac committed
29 30 31
 * This file is a collection of common definitions and types
 */

32 33 34
#ifndef VLC_COMMON_H
# define VLC_COMMON_H 1

35
/*****************************************************************************
36
 * Required vlc headers
37
 *****************************************************************************/
38
#if defined( _MSC_VER )
Gildas Bazin's avatar
 
Gildas Bazin committed
39
#   pragma warning( disable : 4244 )
40 41
#endif

42 43
#include "vlc_config.h"

Sam Hocevar's avatar
 
Sam Hocevar committed
44 45 46
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
47
#include <stdlib.h>
48 49
#include <stdarg.h>

50
#include <string.h>
51
#include <stdio.h>
52
#include <inttypes.h>
53
#include <stddef.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
54

55 56 57 58
#ifndef __cplusplus
# include <stdbool.h>
#endif

59 60 61
/* Format string sanity checks */
#ifdef __GNUC__
#   define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
62
#   define LIBVLC_FORMAT_ARG(x) __attribute__ ((format_arg(x)))
63
#   define LIBVLC_USED __attribute__ ((warn_unused_result))
64
#   define LIBVLC_MALLOC __attribute__ ((malloc))
65 66
#else
#   define LIBVLC_FORMAT(x,y)
67
#   define LIBVLC_FORMAT_ARG(x)
68
#   define LIBVLC_USED
69
#   define LIBVLC_MALLOC
70 71
#endif

72 73 74 75 76 77 78 79 80
/* Branch prediction */
#ifdef __GNUC__
#   define likely(p)   __builtin_expect(!!(p), 1)
#   define unlikely(p) __builtin_expect(!!(p), 0)
#else
#   define likely(p)   (!!(p))
#   define unlikely(p) (!!(p))
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
81 82 83
/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
84
#if defined( WIN32 ) || defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
85
#   include <malloc.h>
86 87 88
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
89 90
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
91 92 93
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

94
/* Audio volume */
95 96
typedef uint16_t            audio_volume_t;

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
97 98 99
/**
 * High precision date or time interval
 *
100 101
 * Store a high precision date or time interval. The maximum precision is the
 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
Sam Hocevar's avatar
 
Sam Hocevar committed
102
 * time interval is then 292271 years, which should be long enough for any
103 104
 * video). Dates are stored as microseconds since a common date (usually the
 * epoch). Note that date and time intervals can be manipulated using regular
Sam Hocevar's avatar
 
Sam Hocevar committed
105
 * arithmetic operators, and that no special functions are required.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
106
 */
107
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
108

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
109
/**
110
 * The vlc_fourcc_t type.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
111
 *
112
 * See http://www.webartz.com/fourcc/ for a very detailed list.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
113
 */
114
typedef uint32_t vlc_fourcc_t;
115

116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
#ifdef WORDS_BIGENDIAN
#   define VLC_FOURCC( a, b, c, d ) \
        ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
           | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
#   define VLC_TWOCC( a, b ) \
        ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )

#else
#   define VLC_FOURCC( a, b, c, d ) \
        ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
#   define VLC_TWOCC( a, b ) \
        ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )

#endif

132 133 134 135 136 137 138
/**
 * Translate a vlc_fourcc into its string representation. This function
 * assumes there is enough room in psz_fourcc to store 4 characters in.
 *
 * \param fcc a vlc_fourcc_t
 * \param psz_fourcc string to store string representation of vlc_fourcc in
 */
139 140
static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
{
141
    memcpy( psz_fourcc, &fcc, 4 );
142 143 144 145 146
}

#define vlc_fourcc_to_char( a, b ) \
    __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )

Sam Hocevar's avatar
 
Sam Hocevar committed
147 148 149 150
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

151
/* Internal types */
152 153
typedef struct vlc_list_t vlc_list_t;
typedef struct vlc_object_t vlc_object_t;
154
typedef struct libvlc_int_t libvlc_int_t;
155
typedef struct date_t date_t;
Clément Stenac's avatar
Clément Stenac committed
156 157
typedef struct dict_entry_t dict_entry_t;
typedef struct dict_t dict_t;
158

Gildas Bazin's avatar
 
Gildas Bazin committed
159
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
160 161 162 163 164 165

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
166
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
167 168
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
169 170 171
    PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
    PLAYLIST_STOP,      /**< No arg                             res=can fail*/
    PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
172 173 174
} playlist_command_t;


175 176
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
177
typedef struct playlist_view_t playlist_view_t;
178 179
typedef struct services_discovery_t services_discovery_t;
typedef struct services_discovery_sys_t services_discovery_sys_t;
Clément Stenac's avatar
Clément Stenac committed
180
typedef struct playlist_add_t playlist_add_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
181

182
/* Modules */
183 184 185 186
typedef struct module_bank_t module_bank_t;
typedef struct module_t module_t;
typedef struct module_config_t module_config_t;
typedef struct module_symbols_t module_symbols_t;
187
typedef struct module_cache_t module_cache_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
188

189 190
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
191
/* Input */
192
typedef struct input_thread_t input_thread_t;
193
typedef struct input_thread_sys_t input_thread_sys_t;
194
typedef struct input_item_t input_item_t;
195
typedef struct access_t access_t;
196
typedef struct access_sys_t access_sys_t;
197 198 199
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
200
typedef struct demux_sys_t demux_sys_t;
201 202 203
typedef struct es_out_t     es_out_t;
typedef struct es_out_id_t  es_out_id_t;
typedef struct es_out_sys_t es_out_sys_t;
204
typedef struct es_descriptor_t es_descriptor_t;
Gildas Bazin's avatar
Gildas Bazin committed
205
typedef struct seekpoint_t seekpoint_t;
206 207
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
208
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
209

210 211 212 213
/* Format */
typedef struct audio_format_t audio_format_t;
typedef struct video_format_t video_format_t;
typedef struct subs_format_t subs_format_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
214 215
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
216

Sam Hocevar's avatar
 
Sam Hocevar committed
217
/* Audio */
218 219
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
220
typedef struct aout_fifo_t aout_fifo_t;
221
typedef struct aout_input_t aout_input_t;
222
typedef struct block_t aout_buffer_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
223
typedef audio_format_t audio_sample_format_t;
224
typedef struct audio_date_t audio_date_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
225
typedef struct aout_filter_t aout_filter_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
226 227

/* Video */
228 229
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
230

Gildas Bazin's avatar
 
Gildas Bazin committed
231
typedef video_format_t video_frame_format_t;
232 233 234
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
235

236
/* Subpictures */
237
typedef struct spu_t spu_t;
238 239
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
240
typedef struct subpicture_region_t subpicture_region_t;
241
typedef struct text_style_t text_style_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
242

243 244
typedef struct image_handler_t image_handler_t;

245 246
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
247 248
typedef struct sout_instance_sys_t sout_instance_sys_t;

249
typedef struct sout_input_t sout_input_t;
250
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
251

252
typedef struct sout_access_out_t sout_access_out_t;
253 254
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

255
typedef struct sout_mux_t sout_mux_t;
256 257
typedef struct sout_mux_sys_t sout_mux_sys_t;

258
typedef struct sout_stream_t    sout_stream_t;
259 260
typedef struct sout_stream_sys_t sout_stream_sys_t;

261
typedef struct config_chain_t       config_chain_t;
262 263
typedef struct session_descriptor_t session_descriptor_t;
typedef struct announce_method_t announce_method_t;
264

265 266
typedef struct sout_param_t sout_param_t;
typedef struct sout_pcat_t sout_pcat_t;
267 268 269 270 271 272 273 274
typedef struct sout_std_t sout_std_t;
typedef struct sout_display_t sout_display_t;
typedef struct sout_duplicate_t sout_duplicate_t;
typedef struct sout_transcode_t sout_transcode_t;
typedef struct sout_chain_t sout_chain_t;
typedef struct streaming_profile_t streaming_profile_t;
typedef struct sout_module_t sout_module_t;
typedef struct sout_gui_descr_t sout_gui_descr_t;
275
typedef struct profile_parser_t profile_parser_t;
276

Sam Hocevar's avatar
 
Sam Hocevar committed
277
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
278 279 280
typedef struct decoder_t         decoder_t;
typedef struct decoder_sys_t     decoder_sys_t;
typedef struct decoder_synchro_t decoder_synchro_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
281

Gildas Bazin's avatar
 
Gildas Bazin committed
282 283 284 285
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

286 287 288 289
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

290
/* Network */
291
typedef struct network_socket_t network_socket_t;
292
typedef struct virtual_socket_t v_socket_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
293 294
typedef struct sockaddr sockaddr;
typedef struct addrinfo addrinfo;
295
typedef struct vlc_acl_t vlc_acl_t;
296
typedef struct vlc_url_t vlc_url_t;
297

298 299
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;
Clément Stenac's avatar
Clément Stenac committed
300
typedef struct device_t device_t;
301 302
typedef struct device_probe_t device_probe_t;
typedef struct probe_sys_t probe_sys_t;
303

304 305 306 307
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

308 309 310 311 312 313 314
/* httpd */
typedef struct httpd_t          httpd_t;
typedef struct httpd_host_t     httpd_host_t;
typedef struct httpd_url_t      httpd_url_t;
typedef struct httpd_client_t   httpd_client_t;
typedef struct httpd_callback_sys_t httpd_callback_sys_t;
typedef struct httpd_message_t  httpd_message_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
315
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
316 317
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
318 319 320
typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
typedef struct httpd_handler_t  httpd_handler_t;
typedef struct httpd_handler_sys_t httpd_handler_sys_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
321
typedef int (*httpd_handler_callback_t)( httpd_handler_sys_t *, httpd_handler_t *, char *psz_url, uint8_t *psz_request, int i_type, uint8_t *p_in, int i_in, char *psz_remote_addr, char *psz_remote_host, uint8_t **pp_data, int *pi_data );
322 323 324
typedef struct httpd_redirect_t httpd_redirect_t;
typedef struct httpd_stream_t httpd_stream_t;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
325 326 327 328
/* TLS support */
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

329 330 331
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
332 333 334 335 336 337
/* XML */
typedef struct xml_t xml_t;
typedef struct xml_sys_t xml_sys_t;
typedef struct xml_reader_t xml_reader_t;
typedef struct xml_reader_sys_t xml_reader_sys_t;

338 339 340
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
341
typedef struct vod_media_t vod_media_t;
342

343 344 345 346
/* opengl */
typedef struct opengl_t     opengl_t;
typedef struct opengl_sys_t opengl_sys_t;

347 348 349 350 351 352 353
/* osdmenu */
typedef struct osd_menu_t   osd_menu_t;
typedef struct osd_state_t  osd_state_t;
typedef struct osd_event_t  osd_event_t;
typedef struct osd_button_t osd_button_t;
typedef struct osd_menu_state_t osd_menu_state_t;

354
/* VLM */
355 356
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
357

358
/* misc */
359
typedef struct vlc_meta_t    vlc_meta_t;
360

361
/* Stats */
362 363 364
typedef struct counter_t     counter_t;
typedef struct counter_sample_t counter_sample_t;
typedef struct stats_handler_t stats_handler_t;
Clément Stenac's avatar
Clément Stenac committed
365
typedef struct input_stats_t input_stats_t;
366

367 368 369
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
370

371 372 373
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

374 375
/* stat/lstat/fstat */
#ifdef WIN32
376
#include <sys/stat.h>
377

378
# ifndef UNDER_CE
379
struct _stati64;
380 381
#define stat _stati64
#define fstat _fstati64
382 383
#endif

384
/* You should otherwise use utf8_stat and utf8_lstat. */
385 386 387 388
#else
struct stat;
#endif

389 390 391 392 393 394
/**
 * VLC value structure
 */
typedef union
{
    int             i_int;
395
    bool            b_bool;
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
    float           f_float;
    char *          psz_string;
    void *          p_address;
    vlc_object_t *  p_object;
    vlc_list_t *    p_list;
    mtime_t         i_time;

    struct { char *psz_name; int i_object_id; } var;

   /* Make sure the structure is at least 64bits */
    struct { char a, b, c, d, e, f, g, h; } padding;

} vlc_value_t;

/**
 * VLC list structure
 */
struct vlc_list_t
{
    int             i_count;
    vlc_value_t *   p_values;
    int *           pi_types;

};

/**
 * \defgroup var_type Variable types
 * These are the different types a vlc variable can have.
 * @{
 */
#define VLC_VAR_VOID      0x0010
#define VLC_VAR_BOOL      0x0020
#define VLC_VAR_INTEGER   0x0030
#define VLC_VAR_HOTKEY    0x0031
#define VLC_VAR_STRING    0x0040
#define VLC_VAR_MODULE    0x0041
#define VLC_VAR_FILE      0x0042
#define VLC_VAR_DIRECTORY 0x0043
#define VLC_VAR_VARIABLE  0x0044
#define VLC_VAR_FLOAT     0x0050
#define VLC_VAR_TIME      0x0060
#define VLC_VAR_ADDRESS   0x0070
#define VLC_VAR_MUTEX     0x0080
#define VLC_VAR_LIST      0x0090
/**@}*/

/*****************************************************************************
 * Error values (shouldn't be exposed)
 *****************************************************************************/
#define VLC_SUCCESS         -0                                   /* No error */
#define VLC_ENOMEM          -1                          /* Not enough memory */
#define VLC_ETIMEOUT        -3                                    /* Timeout */

#define VLC_ENOMOD         -10                           /* Module not found */

#define VLC_ENOOBJ         -20                           /* Object not found */

#define VLC_ENOVAR         -30                         /* Variable not found */
#define VLC_EBADVAR        -31                         /* Bad variable value */

#define VLC_ENOITEM        -40                           /**< Item not found */

#define VLC_EEXIT         -255                             /* Program exited */
#define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
#define VLC_EGENERIC      -666                              /* Generic error */

462 463 464 465 466 467 468 469 470
/*****************************************************************************
 * Variable callbacks
 *****************************************************************************/
typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
                                   char const *,            /* variable name */
                                   vlc_value_t,                 /* old value */
                                   vlc_value_t,                 /* new value */
                                   void * );                /* callback data */

Gildas Bazin's avatar
 
Gildas Bazin committed
471 472 473
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
474

475 476 477 478 479
#ifdef __cplusplus
# define LIBVLC_EXTERN extern "C"
#else
# define LIBVLC_EXTERN extern
#endif
480
#if defined (WIN32) && defined (DLL_EXPORT)
481 482 483
#if defined (UNDER_CE)
# include <windef.h>
#endif
484
# define LIBVLC_EXPORT __declspec(dllexport)
485
#else
486
# define LIBVLC_EXPORT
Gildas Bazin's avatar
 
Gildas Bazin committed
487
#endif
488 489
#define VLC_EXPORT( type, name, args ) \
                        LIBVLC_EXTERN LIBVLC_EXPORT type name args
Gildas Bazin's avatar
 
Gildas Bazin committed
490

491 492 493
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
494
#if defined( WIN32 ) || defined( UNDER_CE )
495 496 497 498
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
499
#include "vlc_mtime.h"
500 501 502 503 504 505 506 507
#include "vlc_threads.h"

/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
508 509 510 511
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
512
    const char *psz_object_type;                                            \
513
                                                                            \
514 515
    /* Messages header */                                                   \
    char *psz_header;                                                       \
516
    int  i_flags;                                                           \
517
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
518
    /* Object properties */                                                 \
519 520
    volatile bool b_error;                  /**< set by the object */ \
    volatile bool b_die;                   /**< set by the outside */ \
521
    bool b_force;      /**< set by the outside (eg. module_need()) */ \
522
                                                                            \
523 524 525
    /** Just a reminder so that people don't cast garbage */                \
    bool be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                       \
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
526
    /* Stuff related to the libvlc structure */                             \
527
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
528
                                                                            \
529
    vlc_object_t *  p_parent;                            /**< our parent */ \
530
                                                                            \
531
/**@}*/                                                                     \
532

533
/* VLC_OBJECT: attempt at doing a clever cast */
534 535
#ifdef __GNUC__
# define VLC_OBJECT( x ) \
536
    (((vlc_object_t *)(x))+0*(((__typeof__(x))0)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct))
537 538 539
#else
# define VLC_OBJECT( x ) ((vlc_object_t *)(x))
#endif
540

541
typedef struct gc_object_t
542
{
543 544 545 546
    vlc_spinlock_t spin;
    uintptr_t      refs;
    void          (*pf_destructor) (struct gc_object_t *);
} gc_object_t;
547

548 549 550 551
/**
 * These members are common to all objects that wish to be garbage-collected.
 */
#define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
552

553 554 555
VLC_EXPORT(void *, vlc_gc_init, (gc_object_t *, void (*)(gc_object_t *)));
VLC_EXPORT(void *, vlc_hold, (gc_object_t *));
VLC_EXPORT(void, vlc_release, (gc_object_t *));
556

557 558 559 560
#define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) )
#define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data )
#define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data )
#define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
561

Sam Hocevar's avatar
 
Sam Hocevar committed
562 563 564 565 566 567 568 569 570 571
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/

/* 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) )

Sam Hocevar's avatar
 
Sam Hocevar committed
572 573 574
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
575
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
576 577
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
578 579
#endif

580 581
LIBVLC_USED
static inline int64_t GCD ( int64_t a, int64_t b )
582
{
583 584 585 586 587 588 589
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
590 591
}

592
/* function imported from libavutil/common.h */
593
LIBVLC_USED
594 595 596 597 598 599
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

600
/* Free and set set the variable to NULL */
601
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
602

603 604
#define EMPTY_STR(str) (!str || !*str)

605
VLC_EXPORT( char const *, vlc_error, ( int ) LIBVLC_USED );
Clément Stenac's avatar
Clément Stenac committed
606

607
#include <vlc_arrays.h>
608

Sam Hocevar's avatar
 
Sam Hocevar committed
609
/* MSB (big endian)/LSB (little endian) conversions - network order is always
610
 * MSB, and should be used for both network communications and files. */
611
LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
612
static inline uint16_t U16_AT( const void * _p )
613
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
614
    const uint8_t * p = (const uint8_t *)_p;
615
    return ( ((uint16_t)p[0] << 8) | p[1] );
616
}
617 618

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
619
static inline uint32_t U32_AT( const void * _p )
620
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
621
    const uint8_t * p = (const uint8_t *)_p;
622 623
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
624
}
625 626

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
627
static inline uint64_t U64_AT( const void * _p )
628
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
629
    const uint8_t * p = (const uint8_t *)_p;
630 631 632 633
    return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
              | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
              | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
              | ((uint64_t)p[6] << 8) | p[7] );
634
}
635

636
LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
637
static inline uint16_t GetWLE( const void * _p )
638
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
639
    const uint8_t * p = (const uint8_t *)_p;
640 641
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
642 643

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
644
static inline uint32_t GetDWLE( const void * _p )
645
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
646
    const uint8_t * p = (const uint8_t *)_p;
647 648 649
    return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
              | ((uint32_t)p[1] << 8) | p[0] );
}
650 651

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
652
static inline uint64_t GetQWLE( const void * _p )
653
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
654
    const uint8_t * p = (const uint8_t *)_p;
655 656 657 658 659 660 661 662 663 664
    return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
              | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
              | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
              | ((uint64_t)p[1] << 8) | p[0] );
}

#define GetWBE( p )     U16_AT( p )
#define GetDWBE( p )    U32_AT( p )
#define GetQWBE( p )    U64_AT( p )

Gildas Bazin's avatar
 
Gildas Bazin committed
665
/* Helper writer functions */
666
#define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
667 668 669 670 671 672
static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
{
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}

673
#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
674 675 676 677 678 679 680
static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
{
    p[3] = ( i_dw >> 24 )&0xff;
    p[2] = ( i_dw >> 16 )&0xff;
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}
681
#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
682 683 684 685 686
static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
{
    SetDWLE( p,   i_qw&0xffffffff );
    SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
}
687
#define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
688 689 690 691 692 693
static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
{
    p[0] = ( i_dw >>  8 )&0xff;
    p[1] = ( i_dw       )&0xff;
}

694
#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
695 696 697 698 699 700 701
static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
{
    p[0] = ( i_dw >> 24 )&0xff;
    p[1] = ( i_dw >> 16 )&0xff;
    p[2] = ( i_dw >>  8 )&0xff;
    p[3] = ( i_dw       )&0xff;
}
702
#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
703 704 705 706 707
static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
{
    SetDWBE( p+4,   i_qw&0xffffffff );
    SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
708

709 710 711 712 713
#define hton16(i) htons(i)
#define hton32(i) htonl(i)
#define ntoh16(i) ntohs(i)
#define ntoh32(i) ntohl(i)

714
LIBVLC_USED
715 716 717 718 719 720 721 722 723 724 725 726 727
static inline uint64_t ntoh64 (uint64_t ll)
{
    union { uint64_t qw; uint8_t b[16]; } v = { ll };
    return ((uint64_t)v.b[0] << 56)
         | ((uint64_t)v.b[1] << 48)
         | ((uint64_t)v.b[2] << 40)
         | ((uint64_t)v.b[3] << 32)
         | ((uint64_t)v.b[4] << 24)
         | ((uint64_t)v.b[5] << 16)
         | ((uint64_t)v.b[6] <<  8)
         | ((uint64_t)v.b[7] <<  0);
}
#define hton64(i) ntoh64(i)
Sam Hocevar's avatar
 
Sam Hocevar committed
728

729 730 731
/* */
#define VLC_UNUSED(x) (void)(x)

732
/* Stuff defined in src/extras/libc.c */
733

734
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
735
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
736
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
737 738
#       define __attribute__(x)
#       define __inline__      __inline
Gildas Bazin's avatar
 
Gildas Bazin committed
739
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
740 741 742 743 744 745 746 747 748
#       define S_ISBLK(m)      (0)
#       define S_ISCHR(m)      (0)
#       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
#       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
#   endif

/* several type definitions */
#   if defined( __MINGW32__ )
#       if !defined( _OFF_T_ )
749 750
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
751 752
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
753 754 755
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
756 757 758 759
#           define off_t long long
#       endif
#   endif

760
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
761
#       if !defined( _OFF_T_DEFINED )
762
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
763 764
#           define _OFF_T_DEFINED
#       else
765
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
766 767 768 769
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
770
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
771
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
772
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
773 774
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
775 776
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
777 778 779 780
#   endif

#   ifndef alloca
#       define alloca _alloca
Sam Hocevar's avatar
 
Sam Hocevar committed
781 782
#   endif

783
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
784 785
#endif

786
VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
787

788 789
/* iconv wrappers (defined in src/extras/libc.c) */
typedef void *vlc_iconv_t;
790 791
VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) LIBVLC_USED );
VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) LIBVLC_USED );
792 793
VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );

794
/* execve wrapper (defined in src/extras/libc.c) */
795
VLC_EXPORT( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char *const *pp_argv, char *const *pp_env, const char *psz_cwd, const char *p_in, size_t i_in, char **pp_data, size_t *pi_data ) LIBVLC_USED );
796 797
#define vlc_execve(a,b,c,d,e,f,g,h,i) __vlc_execve(VLC_OBJECT(a),b,c,d,e,f,g,h,i)

798 799 800
/* dir wrappers (defined in src/extras/libc.c) */
VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir ));

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
801
/* Fast large memory copy and memory set */
802 803
VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
Sam Hocevar's avatar
 
Sam Hocevar committed
804 805 806 807

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
808
VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) LIBVLC_FORMAT_ARG(1) );
809

810
LIBVLC_FORMAT_ARG(2)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
811 812 813 814 815 816
static inline const char *vlc_pgettext( const char *ctx, const char *id )
{
    const char *tr = vlc_gettext( id );
    return (tr == ctx) ? id : tr;
}

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
/*****************************************************************************
 * Loosy memory allocation functions. Do not use in new code.
 *****************************************************************************/
static inline void *xmalloc (size_t len)
{
    void *ptr = malloc (len);
    if (unlikely (ptr == NULL))
        abort ();
    return ptr;
}

static inline void *xrealloc (void *ptr, size_t len)
{
    void *nptr = realloc (ptr, len);
    if (unlikely (nptr == NULL))
        abort ();
    return nptr;
}

836 837 838
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
839 840 841 842 843
VLC_EXPORT( const char *, VLC_Version, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_CompileBy, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_CompileHost, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) LIBVLC_USED );
VLC_EXPORT( const char *, VLC_Compiler, ( void ) LIBVLC_USED );
844

845
/*****************************************************************************
846
 * Additional vlc stuff
847
 *****************************************************************************/
848
#include "vlc_messages.h"
Clément Stenac's avatar
Clément Stenac committed
849
#include "vlc_variables.h"
Sam Hocevar's avatar
Sam Hocevar committed
850
#include "vlc_objects.h"
Clément Stenac's avatar
Clément Stenac committed
851
#include "vlc_modules.h"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
852
#include "vlc_main.h"
Clément Stenac's avatar
Clément Stenac committed
853
#include "vlc_configuration.h"
854

Antoine Cellerier's avatar
Antoine Cellerier committed
855
#if defined( WIN32 ) || defined( UNDER_CE )
856
#   define DIR_SEP_CHAR '\\'
Antoine Cellerier's avatar
Antoine Cellerier committed
857
#   define DIR_SEP "\\"
858 859
#   define PATH_SEP_CHAR ';'
#   define PATH_SEP ";"
Antoine Cellerier's avatar
Antoine Cellerier committed
860
#else
861
#   define DIR_SEP_CHAR '/'
Antoine Cellerier's avatar
Antoine Cellerier committed
862
#   define DIR_SEP "/"
863 864
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
Antoine Cellerier's avatar
Antoine Cellerier committed
865
#endif
866

867 868 869 870 871 872
#define LICENSE_MSG \
  _("This program comes with NO WARRANTY, to the extent permitted by " \
    "law.\nYou may redistribute it under the terms of the GNU General " \
    "Public License;\nsee the file named COPYING for details.\n" \
    "Written by the VideoLAN team; see the AUTHORS file.\n")

873
#endif /* !VLC_COMMON_H */