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 62 63 64 65 66 67
/* Format string sanity checks */
#ifdef __GNUC__
#   define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
#   define LIBVLC_USED __attribute__ ((warn_unused_result))
#else
#   define LIBVLC_FORMAT(x,y)
#   define LIBVLC_USED
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
68 69 70
/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
71
#if defined( WIN32 ) || defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
72
#   include <malloc.h>
73 74 75
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
76 77
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
78 79 80
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

81
/* Audio volume */
82 83
typedef uint16_t            audio_volume_t;

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
84 85 86
/**
 * High precision date or time interval
 *
87 88
 * 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
89
 * time interval is then 292271 years, which should be long enough for any
90 91
 * 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
92
 * arithmetic operators, and that no special functions are required.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
93
 */
94
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
95

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
96
/**
97
 * The vlc_fourcc_t type.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
98
 *
99
 * See http://www.webartz.com/fourcc/ for a very detailed list.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
100
 */
101
typedef uint32_t vlc_fourcc_t;
102

103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
#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

119 120 121 122 123 124 125
/**
 * 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
 */
126 127
static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
{
128
    memcpy( psz_fourcc, &fcc, 4 );
129 130 131 132 133
}

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

Sam Hocevar's avatar
 
Sam Hocevar committed
134 135 136 137
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

138
/* Internal types */
139 140
typedef struct vlc_list_t vlc_list_t;
typedef struct vlc_object_t vlc_object_t;
141
typedef struct libvlc_int_t libvlc_int_t;
142
typedef struct date_t date_t;
Clément Stenac's avatar
Clément Stenac committed
143 144
typedef struct dict_entry_t dict_entry_t;
typedef struct dict_t dict_t;
145

Gildas Bazin's avatar
 
Gildas Bazin committed
146
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
147 148 149 150 151 152

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
153
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
154 155
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
156 157 158
    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
159 160 161
} playlist_command_t;


162 163
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
164
typedef struct playlist_view_t playlist_view_t;
165 166
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
167
typedef struct playlist_add_t playlist_add_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
168

169
/* Modules */
170 171 172 173
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;
174
typedef struct module_cache_t module_cache_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
175

Clément Stenac's avatar
Clément Stenac committed
176 177
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
178
/* Input */
179
typedef struct input_thread_t input_thread_t;
180
typedef struct input_thread_sys_t input_thread_sys_t;
181
typedef struct input_item_t input_item_t;
182
typedef struct access_t access_t;
183
typedef struct access_sys_t access_sys_t;
184 185 186
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
187
typedef struct demux_sys_t demux_sys_t;
188 189 190
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;
191
typedef struct es_descriptor_t es_descriptor_t;
Gildas Bazin's avatar
Gildas Bazin committed
192
typedef struct seekpoint_t seekpoint_t;
193 194
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
195
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
196

197 198 199 200
/* 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
201 202
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
203

Sam Hocevar's avatar
 
Sam Hocevar committed
204
/* Audio */
205 206
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
207
typedef struct aout_fifo_t aout_fifo_t;
208 209
typedef struct aout_input_t aout_input_t;
typedef struct aout_buffer_t aout_buffer_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
210
typedef audio_format_t audio_sample_format_t;
211
typedef struct audio_date_t audio_date_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
212
typedef struct aout_filter_t aout_filter_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
213 214

/* Video */
215 216
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
217

Gildas Bazin's avatar
 
Gildas Bazin committed
218
typedef video_format_t video_frame_format_t;
219 220 221
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
typedef struct picture_heap_t picture_heap_t;
222

223
/* Subpictures */
224
typedef struct spu_t spu_t;
225 226
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
227
typedef struct subpicture_region_t subpicture_region_t;
228
typedef struct text_style_t text_style_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
229

230 231
typedef struct image_handler_t image_handler_t;

232 233
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
234 235
typedef struct sout_instance_sys_t sout_instance_sys_t;

236
typedef struct sout_input_t sout_input_t;
237
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
238

239
typedef struct sout_access_out_t sout_access_out_t;
240 241
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

242
typedef struct sout_mux_t sout_mux_t;
243 244
typedef struct sout_mux_sys_t sout_mux_sys_t;

245
typedef struct sout_stream_t    sout_stream_t;
246 247
typedef struct sout_stream_sys_t sout_stream_sys_t;

248
typedef struct config_chain_t       config_chain_t;
249 250
typedef struct session_descriptor_t session_descriptor_t;
typedef struct announce_method_t announce_method_t;
251

252 253
typedef struct sout_param_t sout_param_t;
typedef struct sout_pcat_t sout_pcat_t;
254 255 256 257 258 259 260 261
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;
262
typedef struct profile_parser_t profile_parser_t;
263

Sam Hocevar's avatar
 
Sam Hocevar committed
264
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
265 266 267
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
268

Gildas Bazin's avatar
 
Gildas Bazin committed
269 270 271 272
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

273 274 275 276
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

277
/* Network */
278
typedef struct network_socket_t network_socket_t;
279
typedef struct virtual_socket_t v_socket_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
280 281
typedef struct sockaddr sockaddr;
typedef struct addrinfo addrinfo;
282
typedef struct vlc_acl_t vlc_acl_t;
283
typedef struct vlc_url_t vlc_url_t;
284

285 286
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;
Clément Stenac's avatar
Clément Stenac committed
287
typedef struct device_t device_t;
288 289
typedef struct device_probe_t device_probe_t;
typedef struct probe_sys_t probe_sys_t;
290

291 292 293 294
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

295 296 297 298 299 300 301
/* 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
302
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
303 304
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
305 306 307
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
308
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 );
309 310 311
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
312 313 314 315
/* TLS support */
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

316 317 318
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
319 320 321 322 323 324
/* 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;

325 326 327
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
328
typedef struct vod_media_t vod_media_t;
329

330 331 332 333
/* opengl */
typedef struct opengl_t     opengl_t;
typedef struct opengl_sys_t opengl_sys_t;

334 335 336 337 338 339 340
/* 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;

341
/* VLM */
342 343
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
344

345
/* misc */
346
typedef struct vlc_meta_t    vlc_meta_t;
347

348
/* Stats */
349 350 351
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
352
typedef struct input_stats_t input_stats_t;
353

354 355 356
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
357

358 359 360
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

361 362
/* stat/lstat/fstat */
#ifdef WIN32
363
#include <sys/stat.h>
364

365
# ifndef UNDER_CE
366
struct _stati64;
367 368
#define stat _stati64
#define fstat _fstati64
369 370
#endif

371
/* You should otherwise use utf8_stat and utf8_lstat. */
372 373 374 375
#else
struct stat;
#endif

376 377 378 379 380 381
/**
 * VLC value structure
 */
typedef union
{
    int             i_int;
382
    bool            b_bool;
383 384 385 386 387 388 389 390 391 392 393 394 395 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
    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 */

449 450 451 452 453 454 455 456 457
/*****************************************************************************
 * 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
458 459 460
/*****************************************************************************
 * Plug-in stuff
 *****************************************************************************/
461

462 463 464 465 466
#ifdef __cplusplus
# define LIBVLC_EXTERN extern "C"
#else
# define LIBVLC_EXTERN extern
#endif
467
#if defined (WIN32) && defined (DLL_EXPORT)
468 469 470
#if defined (UNDER_CE)
# include <windef.h>
#endif
471
# define LIBVLC_EXPORT __declspec(dllexport)
472
#else
473
# define LIBVLC_EXPORT
Gildas Bazin's avatar
 
Gildas Bazin committed
474
#endif
475 476
#define VLC_EXPORT( type, name, args ) \
                        LIBVLC_EXTERN LIBVLC_EXPORT type name args
Gildas Bazin's avatar
 
Gildas Bazin committed
477

478 479 480
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
481
#if defined( WIN32 ) || defined( UNDER_CE )
482 483 484 485
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
486
#include "vlc_mtime.h"
487 488 489 490 491 492 493 494
#include "vlc_threads.h"

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

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
495 496 497 498
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
499
    const char *psz_object_type;                                            \
500
                                                                            \
501 502
    /* Messages header */                                                   \
    char *psz_header;                                                       \
503
    int  i_flags;                                                           \
504
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
505
    /* Object properties */                                                 \
506 507
    volatile bool b_error;                  /**< set by the object */ \
    volatile bool b_die;                   /**< set by the outside */ \
508
    bool b_force;      /**< set by the outside (eg. module_need()) */ \
509
                                                                            \
510 511 512
    /** 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
513
    /* Stuff related to the libvlc structure */                             \
514
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
515
                                                                            \
516
    vlc_object_t *  p_parent;                            /**< our parent */ \
517
                                                                            \
518
/**@}*/                                                                     \
519

520
/* VLC_OBJECT: attempt at doing a clever cast */
521 522 523 524 525 526
#ifdef __GNUC__
# define VLC_OBJECT( x ) \
    (((vlc_object_t *)(x))+0*(((typeof(x))0)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct))
#else
# define VLC_OBJECT( x ) ((vlc_object_t *)(x))
#endif
527

528
typedef struct gc_object_t
529
{
530 531 532 533
    vlc_spinlock_t spin;
    uintptr_t      refs;
    void          (*pf_destructor) (struct gc_object_t *);
} gc_object_t;
534

535 536 537 538
/**
 * These members are common to all objects that wish to be garbage-collected.
 */
#define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
539

540 541 542
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 *));
543

544 545 546 547
#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)))
548

Sam Hocevar's avatar
 
Sam Hocevar committed
549 550 551 552 553 554 555 556 557 558
/*****************************************************************************
 * 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
559 560 561
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
562
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
563 564
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
565 566
#endif

567 568
LIBVLC_USED
static inline int64_t GCD ( int64_t a, int64_t b )
569
{
570 571 572 573 574 575 576
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
577 578
}

579
/* function imported from libavutil/common.h */
580
LIBVLC_USED
581 582 583 584 585 586
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

587
/* Free and set set the variable to NULL */
588
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
Clément Stenac's avatar
Clément Stenac committed
589

590 591
#define EMPTY_STR(str) (!str || !*str)

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

594
#include <vlc_arrays.h>
595

Sam Hocevar's avatar
 
Sam Hocevar committed
596
/* MSB (big endian)/LSB (little endian) conversions - network order is always
597
 * MSB, and should be used for both network communications and files. */
598
LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
599
static inline uint16_t U16_AT( const void * _p )
600
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
601
    const uint8_t * p = (const uint8_t *)_p;
602
    return ( ((uint16_t)p[0] << 8) | p[1] );
603
}
604 605

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
606
static inline uint32_t U32_AT( const void * _p )
607
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
608
    const uint8_t * p = (const uint8_t *)_p;
609 610
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
611
}
612 613

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
614
static inline uint64_t U64_AT( const void * _p )
615
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
616
    const uint8_t * p = (const uint8_t *)_p;
617 618 619 620
    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] );
621
}
622

623
LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
624
static inline uint16_t GetWLE( const void * _p )
625
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
626
    const uint8_t * p = (const uint8_t *)_p;
627 628
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
629 630

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
631
static inline uint32_t GetDWLE( const void * _p )
632
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
633
    const uint8_t * p = (const uint8_t *)_p;
634 635 636
    return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
              | ((uint32_t)p[1] << 8) | p[0] );
}
637 638

LIBVLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
639
static inline uint64_t GetQWLE( const void * _p )
640
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
641
    const uint8_t * p = (const uint8_t *)_p;
642 643 644 645 646 647 648 649 650 651
    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
652
/* Helper writer functions */
653
#define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
654 655 656 657 658 659
static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
{
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}

660
#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
661 662 663 664 665 666 667
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;
}
668
#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
669 670 671 672 673
static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
{
    SetDWLE( p,   i_qw&0xffffffff );
    SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
}
674
#define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
675 676 677 678 679 680
static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
{
    p[0] = ( i_dw >>  8 )&0xff;
    p[1] = ( i_dw       )&0xff;
}

681
#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
682 683 684 685 686 687 688
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;
}
689
#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
690 691 692 693 694
static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
{
    SetDWBE( p+4,   i_qw&0xffffffff );
    SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
695

696 697 698 699 700
#define hton16(i) htons(i)
#define hton32(i) htonl(i)
#define ntoh16(i) ntohs(i)
#define ntoh32(i) ntohl(i)

701
LIBVLC_USED
702 703 704 705 706 707 708 709 710 711 712 713 714
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
715

716 717 718
/* */
#define VLC_UNUSED(x) (void)(x)

719
/* Stuff defined in src/extras/libc.c */
720

721
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
722
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
723
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
724 725
#       define __attribute__(x)
#       define __inline__      __inline
Gildas Bazin's avatar
 
Gildas Bazin committed
726
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
727 728 729 730 731 732 733 734 735
#       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_ )
736 737
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
738 739
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
740 741 742
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
743 744 745 746
#           define off_t long long
#       endif
#   endif

747
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
748
#       if !defined( _OFF_T_DEFINED )
749
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
750 751
#           define _OFF_T_DEFINED
#       else
752
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
753 754 755 756
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
757
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
758
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
759
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
760 761
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
762 763
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
764 765 766 767
#   endif

#   ifndef alloca
#       define alloca _alloca
Sam Hocevar's avatar
 
Sam Hocevar committed
768 769
#   endif

770
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
771 772
#endif

773
VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
774

775 776
/* iconv wrappers (defined in src/extras/libc.c) */
typedef void *vlc_iconv_t;
777 778
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 );
779 780
VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );

781
/* execve wrapper (defined in src/extras/libc.c) */
782
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 );
783 784
#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)

785 786 787
/* dir wrappers (defined in src/extras/libc.c) */
VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir ));

Sam Hocevar's avatar
 
Sam Hocevar committed
788 789 790 791 792 793 794 795
/*****************************************************************************
 * CPU capabilities
 *****************************************************************************/
#define CPU_CAPABILITY_NONE    0
#define CPU_CAPABILITY_MMX     (1<<3)
#define CPU_CAPABILITY_3DNOW   (1<<4)
#define CPU_CAPABILITY_MMXEXT  (1<<5)
#define CPU_CAPABILITY_SSE     (1<<6)
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
796
#define CPU_CAPABILITY_SSE2    (1<<7)
797 798 799
#define CPU_CAPABILITY_SSE3    (1<<8)
#define CPU_CAPABILITY_SSSE3   (1<<9)
#define CPU_CAPABILITY_SSE4    (1<<10)
Sam Hocevar's avatar
 
Sam Hocevar committed
800
#define CPU_CAPABILITY_ALTIVEC (1<<16)
801
#define CPU_CAPABILITY_NEON    (1<<24)
Sam Hocevar's avatar
 
Sam Hocevar committed
802
#define CPU_CAPABILITY_FPU     (1<<31)
803
VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
804 805 806 807 808

typedef void *(*vlc_memcpy_t) (void *tgt, const void *src, size_t n);
typedef void *(*vlc_memset_t) (void *tgt, int c, size_t n);

VLC_EXPORT( void, vlc_fastmem_register, (vlc_memcpy_t cpy, vlc_memset_t set) );
809 810
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
811 812 813 814

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
815
VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) LIBVLC_USED );
816

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
817 818 819 820 821 822
static inline const char *vlc_pgettext( const char *ctx, const char *id )
{
    const char *tr = vlc_gettext( id );
    return (tr == ctx) ? id : tr;
}

823 824 825
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
826 827 828 829 830 831
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 );
VLC_EXPORT( const char *, VLC_Error, ( int ) LIBVLC_USED );
832

833
/*****************************************************************************
834
 * Additional vlc stuff
835
 *****************************************************************************/
836
#include "vlc_messages.h"
Clément Stenac's avatar
Clément Stenac committed
837
#include "vlc_variables.h"
Sam Hocevar's avatar
Sam Hocevar committed
838
#include "vlc_objects.h"
Clément Stenac's avatar
Clément Stenac committed
839
#include "vlc_modules.h"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
840
#include "vlc_main.h"
Clément Stenac's avatar
Clément Stenac committed
841
#include "vlc_configuration.h"
842

Antoine Cellerier's avatar
Antoine Cellerier committed
843
#if defined( WIN32 ) || defined( UNDER_CE )
844
#   define DIR_SEP_CHAR '\\'
Antoine Cellerier's avatar
Antoine Cellerier committed
845
#   define DIR_SEP "\\"
846 847
#   define PATH_SEP_CHAR ';'
#   define PATH_SEP ";"
Antoine Cellerier's avatar
Antoine Cellerier committed
848
#else
849
#   define DIR_SEP_CHAR '/'
Antoine Cellerier's avatar
Antoine Cellerier committed
850
#   define DIR_SEP "/"
851 852
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
Antoine Cellerier's avatar
Antoine Cellerier committed
853
#endif
854

855 856 857 858 859 860
#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")

861
#endif /* !VLC_COMMON_H */