]> git.sesse.net Git - vlc/blob - include/vlc_common.h
Move VLC_FOURCC to vlc_es.h
[vlc] / include / vlc_common.h
1 /*****************************************************************************
2  * common.h: common definitions
3  * Collection of useful common types and macros definitions
4  *****************************************************************************
5  * Copyright (C) 1998-2005 the VideoLAN team
6  * $Id$
7  *
8  * Authors: Samuel Hocevar <sam@via.ecp.fr>
9  *          Vincent Seguin <seguin@via.ecp.fr>
10  *          Gildas Bazin <gbazin@videolan.org>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 /**
28  * \file
29  * This file is a collection of common definitions and types
30  */
31
32 /*****************************************************************************
33  * Required vlc headers
34  *****************************************************************************/
35 #if defined( _MSC_VER )
36 #   pragma warning( disable : 4244 )
37 #endif
38
39 #include "vlc_config.h"
40
41 /*****************************************************************************
42  * Required system headers
43  *****************************************************************************/
44 #include <stdlib.h>
45 #include <stdarg.h>
46
47 #include <string.h>
48 #include <stdio.h>
49 #include <inttypes.h>
50
51 /*****************************************************************************
52  * Basic types definitions
53  *****************************************************************************/
54 #if defined( WIN32 ) || defined( UNDER_CE )
55 #   include <malloc.h>
56 #   ifndef PATH_MAX
57 #       define PATH_MAX MAX_PATH
58 #   endif
59 #endif
60
61 /* Counter for statistics and profiling */
62 typedef unsigned long       count_t;
63
64 /* DCT elements types */
65 typedef int16_t             dctelem_t;
66
67 /* Video buffer types */
68 typedef uint8_t             yuv_data_t;
69
70 /* Audio volume */
71 typedef uint16_t            audio_volume_t;
72
73 /**
74  * High precision date or time interval
75  *
76  * Store a high precision date or time interval. The maximum precision is the
77  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
78  * time interval is then 292271 years, which should be long enough for any
79  * video). Dates are stored as microseconds since a common date (usually the
80  * epoch). Note that date and time intervals can be manipulated using regular
81  * arithmetic operators, and that no special functions are required.
82  */
83 typedef int64_t mtime_t;
84
85 /**
86  * The vlc_fourcc_t type.
87  *
88  * See http://www.webartz.com/fourcc/ for a very detailed list.
89  */
90 typedef uint32_t vlc_fourcc_t;
91
92 static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
93 {
94     memcpy( psz_fourcc, &fcc, 4 );
95 }
96
97 #define vlc_fourcc_to_char( a, b ) \
98     __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
99
100 /*****************************************************************************
101  * Classes declaration
102  *****************************************************************************/
103
104 /* Internal types */
105 typedef struct libvlc_int_t libvlc_int_t;
106 typedef struct variable_t variable_t;
107 typedef struct date_t date_t;
108 typedef struct dict_entry_t dict_entry_t;
109 typedef struct dict_t dict_t;
110 typedef struct gc_object_t gc_object_t ;
111
112 /* Messages */
113 typedef struct msg_subscription_t msg_subscription_t;
114
115 /* Playlist */
116
117 /* FIXME */
118 /**
119  * Playlist commands
120  */
121 typedef enum {
122     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
123     PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
124                         /**  arg2 = playlist_item_t*          , res=can fail */
125     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
126     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
127     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
128 } playlist_command_t;
129
130
131 typedef struct playlist_t playlist_t;
132 typedef struct playlist_item_t playlist_item_t;
133 typedef struct playlist_view_t playlist_view_t;
134 typedef struct playlist_export_t playlist_export_t;
135 typedef struct services_discovery_t services_discovery_t;
136 typedef struct services_discovery_sys_t services_discovery_sys_t;
137 typedef struct playlist_add_t playlist_add_t;
138 typedef struct playlist_preparse_t playlist_preparse_t;
139 typedef struct playlist_fetcher_t playlist_fetcher_t;
140
141 /* Modules */
142 typedef struct module_bank_t module_bank_t;
143 typedef struct module_t module_t;
144 typedef struct module_config_t module_config_t;
145 typedef struct module_symbols_t module_symbols_t;
146 typedef struct module_cache_t module_cache_t;
147
148 typedef struct config_category_t config_category_t;
149
150 /* Interface */
151 typedef struct intf_thread_t intf_thread_t;
152 typedef struct intf_sys_t intf_sys_t;
153 typedef struct intf_console_t intf_console_t;
154 typedef struct intf_msg_t intf_msg_t;
155 typedef struct interaction_t interaction_t;
156 typedef struct interaction_dialog_t interaction_dialog_t;
157 typedef struct user_widget_t user_widget_t;
158
159 /* Input */
160 typedef struct input_thread_t input_thread_t;
161 typedef struct input_thread_sys_t input_thread_sys_t;
162 typedef struct input_item_t input_item_t;
163 typedef struct access_t access_t;
164 typedef struct access_sys_t access_sys_t;
165 typedef struct stream_t     stream_t;
166 typedef struct stream_sys_t stream_sys_t;
167 typedef struct demux_t  demux_t;
168 typedef struct demux_meta_t demux_meta_t;
169 typedef struct demux_sys_t demux_sys_t;
170 typedef struct es_out_t     es_out_t;
171 typedef struct es_out_id_t  es_out_id_t;
172 typedef struct es_out_sys_t es_out_sys_t;
173 typedef struct es_descriptor_t es_descriptor_t;
174 typedef struct seekpoint_t seekpoint_t;
175 typedef struct info_t info_t;
176 typedef struct info_category_t info_category_t;
177 typedef struct input_attachment_t input_attachment_t;
178
179 /* Format */
180 typedef struct audio_format_t audio_format_t;
181 typedef struct video_format_t video_format_t;
182 typedef struct subs_format_t subs_format_t;
183 typedef struct es_format_t es_format_t;
184 typedef struct video_palette_t video_palette_t;
185
186 /* Audio */
187 typedef struct aout_instance_t aout_instance_t;
188 typedef struct aout_sys_t aout_sys_t;
189 typedef struct aout_fifo_t aout_fifo_t;
190 typedef struct aout_input_t aout_input_t;
191 typedef struct aout_buffer_t aout_buffer_t;
192 typedef audio_format_t audio_sample_format_t;
193 typedef struct audio_date_t audio_date_t;
194 typedef struct aout_filter_t aout_filter_t;
195
196 /* Video */
197 typedef struct vout_thread_t vout_thread_t;
198 typedef struct vout_sys_t vout_sys_t;
199 typedef struct chroma_sys_t chroma_sys_t;
200
201 typedef video_format_t video_frame_format_t;
202 typedef struct picture_t picture_t;
203 typedef struct picture_sys_t picture_sys_t;
204 typedef struct picture_heap_t picture_heap_t;
205
206 /* Subpictures */
207 typedef struct spu_t spu_t;
208 typedef struct subpicture_t subpicture_t;
209 typedef struct subpicture_sys_t subpicture_sys_t;
210 typedef struct subpicture_region_t subpicture_region_t;
211 typedef struct text_style_t text_style_t;
212
213 typedef struct image_handler_t image_handler_t;
214
215 /* Stream output */
216 typedef struct sout_instance_t sout_instance_t;
217 typedef struct sout_instance_sys_t sout_instance_sys_t;
218
219 typedef struct sout_input_t sout_input_t;
220 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
221
222 typedef struct sout_access_out_t sout_access_out_t;
223 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
224
225 typedef struct sout_mux_t sout_mux_t;
226 typedef struct sout_mux_sys_t sout_mux_sys_t;
227
228 typedef struct sout_stream_t    sout_stream_t;
229 typedef struct sout_stream_sys_t sout_stream_sys_t;
230
231 typedef struct config_chain_t       config_chain_t;
232 typedef struct sap_session_t    sap_session_t;
233 typedef struct sap_address_t sap_address_t;
234 typedef struct session_descriptor_t session_descriptor_t;
235 typedef struct announce_method_t announce_method_t;
236 typedef struct announce_handler_t announce_handler_t;
237 typedef struct sap_handler_t sap_handler_t;
238
239 typedef struct sout_param_t sout_param_t;
240 typedef struct sout_pcat_t sout_pcat_t;
241 typedef struct sout_std_t sout_std_t;
242 typedef struct sout_display_t sout_display_t;
243 typedef struct sout_duplicate_t sout_duplicate_t;
244 typedef struct sout_transcode_t sout_transcode_t;
245 typedef struct sout_chain_t sout_chain_t;
246 typedef struct streaming_profile_t streaming_profile_t;
247 typedef struct sout_module_t sout_module_t;
248 typedef struct sout_gui_descr_t sout_gui_descr_t;
249 typedef struct profile_parser_t profile_parser_t;
250
251 /* Decoders */
252 typedef struct decoder_t         decoder_t;
253 typedef struct decoder_sys_t     decoder_sys_t;
254 typedef struct decoder_synchro_t decoder_synchro_t;
255
256 /* Encoders */
257 typedef struct encoder_t      encoder_t;
258 typedef struct encoder_sys_t  encoder_sys_t;
259
260 /* Filters */
261 typedef struct filter_t filter_t;
262 typedef struct filter_sys_t filter_sys_t;
263
264 /* Network */
265 typedef struct network_socket_t network_socket_t;
266 typedef struct virtual_socket_t v_socket_t;
267 typedef struct sockaddr sockaddr;
268 typedef struct addrinfo addrinfo;
269 typedef struct vlc_acl_t vlc_acl_t;
270 typedef struct vlc_url_t vlc_url_t;
271
272 /* Misc */
273 typedef struct iso639_lang_t iso639_lang_t;
274 typedef struct device_t device_t;
275 typedef struct device_probe_t device_probe_t;
276 typedef struct probe_sys_t probe_sys_t;
277
278 /* block */
279 typedef struct block_t      block_t;
280 typedef struct block_fifo_t block_fifo_t;
281
282 /* httpd */
283 typedef struct httpd_t          httpd_t;
284 typedef struct httpd_host_t     httpd_host_t;
285 typedef struct httpd_url_t      httpd_url_t;
286 typedef struct httpd_client_t   httpd_client_t;
287 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
288 typedef struct httpd_message_t  httpd_message_t;
289 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
290 typedef struct httpd_file_t     httpd_file_t;
291 typedef struct httpd_file_sys_t httpd_file_sys_t;
292 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
293 typedef struct httpd_handler_t  httpd_handler_t;
294 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
295 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 );
296 typedef struct httpd_redirect_t httpd_redirect_t;
297 typedef struct httpd_stream_t httpd_stream_t;
298
299 /* TLS support */
300 typedef struct tls_server_t tls_server_t;
301 typedef struct tls_session_t tls_session_t;
302
303 /* Hashing */
304 typedef struct md5_s md5_t;
305
306 /* XML */
307 typedef struct xml_t xml_t;
308 typedef struct xml_sys_t xml_sys_t;
309 typedef struct xml_reader_t xml_reader_t;
310 typedef struct xml_reader_sys_t xml_reader_sys_t;
311
312 /* vod server */
313 typedef struct vod_t     vod_t;
314 typedef struct vod_sys_t vod_sys_t;
315 typedef struct vod_media_t vod_media_t;
316
317 /* opengl */
318 typedef struct opengl_t     opengl_t;
319 typedef struct opengl_sys_t opengl_sys_t;
320
321 /* osdmenu */
322 typedef struct osd_menu_t   osd_menu_t;
323 typedef struct osd_state_t  osd_state_t;
324 typedef struct osd_event_t  osd_event_t;
325 typedef struct osd_button_t osd_button_t;
326 typedef struct osd_menu_state_t osd_menu_state_t;
327
328 /* VLM */
329 typedef struct vlm_t         vlm_t;
330 typedef struct vlm_message_t vlm_message_t;
331
332 /* divers */
333 typedef struct vlc_meta_t    vlc_meta_t;
334 typedef struct meta_export_t meta_export_t;
335
336 /* Stats */
337 typedef struct counter_t     counter_t;
338 typedef struct counter_sample_t counter_sample_t;
339 typedef struct stats_handler_t stats_handler_t;
340 typedef struct input_stats_t input_stats_t;
341 typedef struct global_stats_t global_stats_t;
342
343 /* Update */
344 typedef struct update_t update_t;
345 typedef struct update_iterator_t update_iterator_t;
346
347 /* Meta engine */
348 typedef struct meta_engine_t meta_engine_t;
349
350 /* stat/lstat/fstat */
351 #ifdef WIN32
352 #include <sys/stat.h>
353 struct _stati64;
354 #define stat _stati64
355 #define fstat _fstati64
356 /* You should otherwise use utf8_stat and utf8_lstat. */
357 #else
358 struct stat;
359 #endif
360
361 /*****************************************************************************
362  * Variable callbacks
363  *****************************************************************************/
364 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
365                                    char const *,            /* variable name */
366                                    vlc_value_t,                 /* old value */
367                                    vlc_value_t,                 /* new value */
368                                    void * );                /* callback data */
369
370 /*****************************************************************************
371  * Plug-in stuff
372  *****************************************************************************/
373
374 #ifdef __cplusplus
375 # define LIBVLC_EXTERN extern "C"
376 #else
377 # define LIBVLC_EXTERN extern
378 #endif
379 #if defined (WIN32) && defined (DLL_EXPORT)
380 # define LIBVLC_EXPORT __declspec(dllexport)
381 #else
382 # define LIBVLC_EXPORT
383 #endif
384 #define VLC_PUBLIC_API  LIBVLC_EXTERN LIBVLC_EXPORT
385 #define VLC_PRIVATE_API LIBVLC_EXTERN LIBVLC_EXPORT /* FIXME: dubious! */
386 #define VLC_EXPORT( type, name, args ) \
387                         LIBVLC_EXTERN LIBVLC_EXPORT type name args
388
389 /*****************************************************************************
390  * OS-specific headers and thread types
391  *****************************************************************************/
392 #if defined( WIN32 ) || defined( UNDER_CE )
393 #   define WIN32_LEAN_AND_MEAN
394 #   include <windows.h>
395 #   if defined( UNDER_CE )
396 #      define IS_WINNT 0
397 #   else
398 #      define IS_WINNT ( GetVersion() < 0x80000000 )
399 #   endif
400 #endif
401
402 #include "vlc_mtime.h"
403 #include "vlc_threads.h"
404
405 typedef struct vlc_object_internals_t vlc_object_internals_t;
406
407 /*****************************************************************************
408  * Common structure members
409  *****************************************************************************/
410
411 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
412 #define VLC_COMMON_MEMBERS                                                  \
413 /** \name VLC_COMMON_MEMBERS                                                \
414  * these members are common for all vlc objects                             \
415  */                                                                         \
416 /**@{*/                                                                     \
417     int   i_object_id;                                                      \
418     int   i_object_type;                                                    \
419     const char *psz_object_type;                                            \
420     char *psz_object_name;                                                  \
421                                                                             \
422     /* Messages header */                                                   \
423     char *psz_header;                                                       \
424     int  i_flags;                                                           \
425                                                                             \
426     /* Object access lock */                                                \
427     vlc_mutex_t  object_lock;                                               \
428     vlc_cond_t   object_wait;                                               \
429                                                                             \
430     /* Object properties */                                                 \
431     volatile bool b_error;                  /**< set by the object */ \
432     volatile bool b_die;                   /**< set by the outside */ \
433     volatile bool b_dead;                   /**< set by the object */ \
434     bool b_force;      /**< set by the outside (eg. module_Need()) */ \
435                                                                             \
436     /* Stuff related to the libvlc structure */                             \
437     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
438                                                                             \
439     vlc_object_t *  p_parent;                            /**< our parent */ \
440                                                                             \
441     /* Private data */                                                      \
442     void *          p_private;                                              \
443                                                                             \
444     /** Just a reminder so that people don't cast garbage */                \
445     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
446 /**@}*/                                                                     \
447
448 /* VLC_OBJECT: attempt at doing a clever cast */
449 #define VLC_OBJECT( x ) \
450     (((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct)
451
452 #define VLC_GC_MEMBERS                                                       \
453 /** \name VLC_GC_MEMBERS                                                     \
454  * these members are common to all objects that wish to be garbage-collected \
455  */                                                                          \
456 /**@{*/                                                                      \
457     int i_gc_refcount;                                                       \
458     void (*pf_destructor) ( gc_object_t * );                                 \
459     void *p_destructor_arg;                                                  \
460 /**@}*/
461
462 struct gc_object_t
463 {
464             VLC_GC_MEMBERS
465 };
466
467 static inline void __vlc_gc_incref( gc_object_t * p_gc )
468 {
469     p_gc->i_gc_refcount ++;
470 };
471
472 static inline void __vlc_gc_decref( gc_object_t *p_gc )
473 {
474     if( !p_gc ) return;
475
476     p_gc->i_gc_refcount -- ;
477
478     if( p_gc->i_gc_refcount == 0 )
479     {
480         p_gc->pf_destructor( p_gc );
481         /* Do not use the p_gc pointer from now on ! */
482     }
483 }
484
485 static inline void
486 __vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
487                void * arg)
488 {
489     p_gc->i_gc_refcount = 1;
490     p_gc->pf_destructor = pf_destructor;
491     p_gc->p_destructor_arg = arg;
492 }
493
494 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
495 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
496 #define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
497
498
499 /*****************************************************************************
500  * Macros and inline functions
501  *****************************************************************************/
502
503 /* CEIL: division with round to nearest greater integer */
504 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
505
506 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
507 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
508
509 /* __MAX and __MIN: self explanatory */
510 #ifndef __MAX
511 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
512 #endif
513 #ifndef __MIN
514 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
515 #endif
516
517 static inline int64_t GCD( int64_t a, int64_t b )
518 {
519     while( b )
520     {
521         int64_t c = a % b;
522         a = b;
523         b = c;
524     }
525     return a;
526 }
527
528 /* function imported from libavutil/common.h */
529 static inline uint8_t clip_uint8_vlc( int32_t a )
530 {
531     if( a&(~255) ) return (-a)>>31;
532     else           return a;
533 }
534
535 /* Malloc with automatic error */
536 #define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
537                                    if( !var ) return; } while(0)
538 #define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
539                                    if( !var ) return NULL; } while(0)
540 #define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
541                                    if( !var ) return VLC_ENOMEM; } while(0)
542 #define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
543                                       if( !var ) goto error; } while(0)
544 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
545                                     if( !var ) return;
546 #define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
547                                     if( !var ) return VLC_ENOMEM;
548 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
549                                     if( !var ) return NULL;
550
551 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
552
553 #define EMPTY_STR(str) (!str || !*str)
554
555 VLC_EXPORT( char const *, vlc_error, ( int ) );
556
557 #include <vlc_arrays.h>
558
559 /* MSB (big endian)/LSB (little endian) conversions - network order is always
560  * MSB, and should be used for both network communications and files. Note that
561  * byte orders other than little and big endians are not supported, but only
562  * the VAX seems to have such exotic properties. */
563 static inline uint16_t U16_AT( const void * _p )
564 {
565     const uint8_t * p = (const uint8_t *)_p;
566     return ( ((uint16_t)p[0] << 8) | p[1] );
567 }
568 static inline uint32_t U32_AT( const void * _p )
569 {
570     const uint8_t * p = (const uint8_t *)_p;
571     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
572               | ((uint32_t)p[2] << 8) | p[3] );
573 }
574 static inline uint64_t U64_AT( const void * _p )
575 {
576     const uint8_t * p = (const uint8_t *)_p;
577     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
578               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
579               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
580               | ((uint64_t)p[6] << 8) | p[7] );
581 }
582
583 static inline uint16_t GetWLE( const void * _p )
584 {
585     const uint8_t * p = (const uint8_t *)_p;
586     return ( ((uint16_t)p[1] << 8) | p[0] );
587 }
588 static inline uint32_t GetDWLE( const void * _p )
589 {
590     const uint8_t * p = (const uint8_t *)_p;
591     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
592               | ((uint32_t)p[1] << 8) | p[0] );
593 }
594 static inline uint64_t GetQWLE( const void * _p )
595 {
596     const uint8_t * p = (const uint8_t *)_p;
597     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
598               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
599               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
600               | ((uint64_t)p[1] << 8) | p[0] );
601 }
602
603 #define GetWBE( p )     U16_AT( p )
604 #define GetDWBE( p )    U32_AT( p )
605 #define GetQWBE( p )    U64_AT( p )
606
607 /* Helper writer functions */
608 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
609 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
610 {
611     p[1] = ( i_dw >>  8 )&0xff;
612     p[0] = ( i_dw       )&0xff;
613 }
614
615 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
616 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
617 {
618     p[3] = ( i_dw >> 24 )&0xff;
619     p[2] = ( i_dw >> 16 )&0xff;
620     p[1] = ( i_dw >>  8 )&0xff;
621     p[0] = ( i_dw       )&0xff;
622 }
623 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
624 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
625 {
626     SetDWLE( p,   i_qw&0xffffffff );
627     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
628 }
629 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
630 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
631 {
632     p[0] = ( i_dw >>  8 )&0xff;
633     p[1] = ( i_dw       )&0xff;
634 }
635
636 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
637 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
638 {
639     p[0] = ( i_dw >> 24 )&0xff;
640     p[1] = ( i_dw >> 16 )&0xff;
641     p[2] = ( i_dw >>  8 )&0xff;
642     p[3] = ( i_dw       )&0xff;
643 }
644 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
645 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
646 {
647     SetDWBE( p+4,   i_qw&0xffffffff );
648     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
649 }
650
651 #define hton16(i) htons(i)
652 #define hton32(i) htonl(i)
653 #define ntoh16(i) ntohs(i)
654 #define ntoh32(i) ntohl(i)
655
656 static inline uint64_t ntoh64 (uint64_t ll)
657 {
658     union { uint64_t qw; uint8_t b[16]; } v = { ll };
659     return ((uint64_t)v.b[0] << 56)
660          | ((uint64_t)v.b[1] << 48)
661          | ((uint64_t)v.b[2] << 40)
662          | ((uint64_t)v.b[3] << 32)
663          | ((uint64_t)v.b[4] << 24)
664          | ((uint64_t)v.b[5] << 16)
665          | ((uint64_t)v.b[6] <<  8)
666          | ((uint64_t)v.b[7] <<  0);
667 }
668 #define hton64(i) ntoh64(i)
669
670 /* Format string sanity checks */
671 #ifdef __GNUC__
672 #   define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
673 #else
674 #   define LIBVLC_FORMAT(x,y)
675 #endif
676
677 /* */
678 #define VLC_UNUSED(x) (void)(x)
679
680 /* Stuff defined in src/extras/libc.c */
681 VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
682 VLC_EXPORT( long long, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
683
684 VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
685
686 #if defined(WIN32) || defined(UNDER_CE)
687 /* win32, cl and icl support */
688 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
689 #       define __attribute__(x)
690 #       define __inline__      __inline
691 #       define S_IFBLK         0x3000  /* Block */
692 #       define S_ISBLK(m)      (0)
693 #       define S_ISCHR(m)      (0)
694 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
695 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
696 #   endif
697
698 /* several type definitions */
699 #   if defined( __MINGW32__ )
700 #       if !defined( _OFF_T_ )
701             typedef long long _off_t;
702             typedef _off_t off_t;
703 #           define _OFF_T_
704 #       else
705 #           ifdef off_t
706 #               undef off_t
707 #           endif
708 #           define off_t long long
709 #       endif
710 #   endif
711
712 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
713 #       if !defined( _OFF_T_DEFINED )
714             typedef __int64 off_t;
715 #           define _OFF_T_DEFINED
716 #       else
717             /* for wx compatibility typedef long off_t; */
718 #           define off_t __int64
719 #       endif
720 #   endif
721
722 #   if defined( __BORLANDC__ )
723 #       undef off_t
724 #       define off_t unsigned __int64
725 #   endif
726
727 #   ifndef O_NONBLOCK
728 #       define O_NONBLOCK 0
729 #   endif
730
731 #   ifndef alloca
732 #       define alloca _alloca
733 #   endif
734
735     /* These two are not defined in mingw32 (bug?) */
736 #   ifndef snprintf
737 #       define snprintf _snprintf
738 #   endif
739 #   ifndef vsnprintf
740 #       define vsnprintf _vsnprintf
741 #   endif
742
743 #   include <tchar.h>
744 #endif
745
746 VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
747
748 /* vlc_wraptext (defined in src/extras/libc.c) */
749 #define wraptext vlc_wraptext
750 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
751
752 /* iconv wrappers (defined in src/extras/libc.c) */
753 typedef void *vlc_iconv_t;
754 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
755 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
756 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
757
758 /* execve wrapper (defined in src/extras/libc.c) */
759 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 ) );
760 #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)
761
762 /*****************************************************************************
763  * CPU capabilities
764  *****************************************************************************/
765 #define CPU_CAPABILITY_NONE    0
766 #define CPU_CAPABILITY_486     (1<<0)
767 #define CPU_CAPABILITY_586     (1<<1)
768 #define CPU_CAPABILITY_PPRO    (1<<2)
769 #define CPU_CAPABILITY_MMX     (1<<3)
770 #define CPU_CAPABILITY_3DNOW   (1<<4)
771 #define CPU_CAPABILITY_MMXEXT  (1<<5)
772 #define CPU_CAPABILITY_SSE     (1<<6)
773 #define CPU_CAPABILITY_SSE2    (1<<7)
774 #define CPU_CAPABILITY_ALTIVEC (1<<16)
775 #define CPU_CAPABILITY_FPU     (1<<31)
776 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
777
778 typedef void *(*vlc_memcpy_t) (void *tgt, const void *src, size_t n);
779 typedef void *(*vlc_memset_t) (void *tgt, int c, size_t n);
780
781 VLC_EXPORT( void, vlc_fastmem_register, (vlc_memcpy_t cpy, vlc_memset_t set) );
782 VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
783 VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
784
785 /*****************************************************************************
786  * I18n stuff
787  *****************************************************************************/
788 #ifdef WIN32
789 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
790 VLC_EXPORT( int, vlc_wclosedir, (void *) );
791 #endif
792
793 VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) );
794
795 /*****************************************************************************
796  * libvlc features
797  *****************************************************************************/
798 VLC_EXPORT( const char *, VLC_Version, ( void ) );
799 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
800 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
801 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
802 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
803 VLC_EXPORT( const char *, VLC_Error, ( int ) );
804 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
805
806 /*****************************************************************************
807  * Additional vlc stuff
808  *****************************************************************************/
809 #include "vlc_messages.h"
810 #include "vlc_variables.h"
811 #include "vlc_objects.h"
812 #include "vlc_modules.h"
813 #include "vlc_main.h"
814 #include "vlc_configuration.h"
815
816 #if defined( WIN32 ) || defined( UNDER_CE )
817 #   define DIR_SEP_CHAR '\\'
818 #   define DIR_SEP "\\"
819 #   define PATH_SEP_CHAR ';'
820 #   define PATH_SEP ";"
821 #else
822 #   define DIR_SEP_CHAR '/'
823 #   define DIR_SEP "/"
824 #   define PATH_SEP_CHAR ':'
825 #   define PATH_SEP ":"
826 #endif