1 /*****************************************************************************
2 * vlc_common.h: common definitions
3 * Collection of useful common types and macros definitions
4 *****************************************************************************
5 * Copyright (C) 1998-2011 VLC authors and VideoLAN
7 * Authors: Samuel Hocevar <sam@via.ecp.fr>
8 * Vincent Seguin <seguin@via.ecp.fr>
9 * Gildas Bazin <gbazin@videolan.org>
10 * RĂ©mi Denis-Courmont
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU Lesser General Public License as published by
14 * the Free Software Foundation; either version 2.1 of the License, or
15 * (at your option) any later version.
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 Lesser General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public License
23 * along with this program; if not, write to the Free Software Foundation,
24 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
29 * This file is a collection of common definitions and types
33 # define VLC_COMMON_H 1
35 /*****************************************************************************
36 * Required vlc headers
37 *****************************************************************************/
38 #include "vlc_config.h"
40 /*****************************************************************************
41 * Required system headers
42 *****************************************************************************/
55 /* Helper for GCC version checks */
57 # define VLC_GCC_VERSION(maj,min) \
58 ((__GNUC__ > (maj)) || (__GNUC__ == (maj) && __GNUC_MINOR__ >= (min)))
60 # define VLC_GCC_VERSION(maj,min) (0)
63 /* Try to fix format strings for all versions of mingw and mingw64 */
64 #if defined( _WIN32 ) && defined( __USE_MINGW_ANSI_STDIO )
75 #define snprintf __mingw_snprintf
76 #define vsnprintf __mingw_vsnprintf
79 /* Function attributes for compiler warnings */
81 # define VLC_DEPRECATED __attribute__((deprecated))
83 # if defined( _WIN32 ) && VLC_GCC_VERSION(4,4)
84 # define VLC_FORMAT(x,y) __attribute__ ((format(gnu_printf,x,y)))
86 # define VLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
88 # define VLC_FORMAT_ARG(x) __attribute__ ((format_arg(x)))
90 # define VLC_MALLOC __attribute__ ((malloc))
91 # define VLC_NORETURN __attribute__ ((noreturn))
93 # if VLC_GCC_VERSION(3,4)
94 # define VLC_USED __attribute__ ((warn_unused_result))
100 # define VLC_DEPRECATED
101 # define VLC_FORMAT(x,y)
102 # define VLC_FORMAT_ARG(x)
104 # define VLC_NORETURN
109 /* Branch prediction */
111 # define likely(p) __builtin_expect(!!(p), 1)
112 # define unlikely(p) __builtin_expect(!!(p), 0)
114 # define likely(p) (!!(p))
115 # define unlikely(p) (!!(p))
120 # define VLC_EXTERN extern "C"
125 #if defined (WIN32) && defined (DLL_EXPORT)
126 # define VLC_EXPORT __declspec(dllexport)
127 #elif VLC_GCC_VERSION(4,0)
128 # define VLC_EXPORT __attribute__((visibility("default")))
133 #define VLC_API VLC_EXTERN VLC_EXPORT
136 /*****************************************************************************
137 * Basic types definitions
138 *****************************************************************************/
142 # define PATH_MAX MAX_PATH
147 #include <sys/syslimits.h>
151 * High precision date or time interval
153 * Store a high precision date or time interval. The maximum precision is the
154 * microsecond, and a 64 bits integer is used to avoid overflows (maximum
155 * time interval is then 292271 years, which should be long enough for any
156 * video). Dates are stored as microseconds since a common date (usually the
157 * epoch). Note that date and time intervals can be manipulated using regular
158 * arithmetic operators, and that no special functions are required.
160 typedef int64_t mtime_t;
163 * The vlc_fourcc_t type.
165 * See http://www.webartz.com/fourcc/ for a very detailed list.
167 typedef uint32_t vlc_fourcc_t;
169 #ifdef WORDS_BIGENDIAN
170 # define VLC_FOURCC( a, b, c, d ) \
171 ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
172 | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
173 # define VLC_TWOCC( a, b ) \
174 ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
177 # define VLC_FOURCC( a, b, c, d ) \
178 ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
179 | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
180 # define VLC_TWOCC( a, b ) \
181 ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
186 * Translate a vlc_fourcc into its string representation. This function
187 * assumes there is enough room in psz_fourcc to store 4 characters in.
189 * \param fcc a vlc_fourcc_t
190 * \param psz_fourcc string to store string representation of vlc_fourcc in
192 static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
194 memcpy( psz_fourcc, &fcc, 4 );
197 #define vlc_fourcc_to_char( a, b ) \
198 vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
200 /*****************************************************************************
201 * Classes declaration
202 *****************************************************************************/
205 typedef struct vlc_list_t vlc_list_t;
206 typedef struct vlc_object_t vlc_object_t;
207 typedef struct libvlc_int_t libvlc_int_t;
208 typedef struct date_t date_t;
217 PLAYLIST_PLAY, /**< No arg. res=can fail*/
218 PLAYLIST_VIEWPLAY, /**< arg1= playlist_item_t*,*/
219 /** arg2 = playlist_item_t* , res=can fail */
220 PLAYLIST_PAUSE, /**< No arg res=can fail*/
221 PLAYLIST_STOP, /**< No arg res=can fail*/
222 PLAYLIST_SKIP, /**< arg1=int, res=can fail*/
223 } playlist_command_t;
226 typedef struct playlist_t playlist_t;
227 typedef struct playlist_item_t playlist_item_t;
228 typedef struct playlist_view_t playlist_view_t;
229 typedef struct services_discovery_t services_discovery_t;
230 typedef struct services_discovery_sys_t services_discovery_sys_t;
231 typedef struct playlist_add_t playlist_add_t;
234 typedef struct module_t module_t;
235 typedef struct module_config_t module_config_t;
237 typedef struct config_category_t config_category_t;
240 typedef struct input_thread_t input_thread_t;
241 typedef struct input_item_t input_item_t;
242 typedef struct input_item_node_t input_item_node_t;
243 typedef struct access_t access_t;
244 typedef struct access_sys_t access_sys_t;
245 typedef struct stream_t stream_t;
246 typedef struct stream_sys_t stream_sys_t;
247 typedef struct demux_t demux_t;
248 typedef struct demux_sys_t demux_sys_t;
249 typedef struct es_out_t es_out_t;
250 typedef struct es_out_id_t es_out_id_t;
251 typedef struct es_out_sys_t es_out_sys_t;
252 typedef struct seekpoint_t seekpoint_t;
253 typedef struct info_t info_t;
254 typedef struct info_category_t info_category_t;
255 typedef struct input_attachment_t input_attachment_t;
258 typedef struct audio_format_t audio_format_t;
259 typedef struct video_format_t video_format_t;
260 typedef struct subs_format_t subs_format_t;
261 typedef struct es_format_t es_format_t;
262 typedef struct video_palette_t video_palette_t;
265 typedef struct audio_output audio_output_t;
266 typedef struct aout_sys_t aout_sys_t;
267 typedef struct aout_fifo_t aout_fifo_t;
268 typedef struct aout_input_t aout_input_t;
269 typedef audio_format_t audio_sample_format_t;
272 typedef struct vout_thread_t vout_thread_t;
274 typedef video_format_t video_frame_format_t;
275 typedef struct picture_t picture_t;
276 typedef struct picture_sys_t picture_sys_t;
279 typedef struct spu_t spu_t;
280 typedef struct subpicture_t subpicture_t;
281 typedef struct subpicture_sys_t subpicture_sys_t;
282 typedef struct subpicture_region_t subpicture_region_t;
284 typedef struct image_handler_t image_handler_t;
287 typedef struct sout_instance_t sout_instance_t;
288 typedef struct sout_instance_sys_t sout_instance_sys_t;
290 typedef struct sout_input_t sout_input_t;
291 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
293 typedef struct sout_access_out_t sout_access_out_t;
294 typedef struct sout_access_out_sys_t sout_access_out_sys_t;
296 typedef struct sout_mux_t sout_mux_t;
297 typedef struct sout_mux_sys_t sout_mux_sys_t;
299 typedef struct sout_stream_t sout_stream_t;
300 typedef struct sout_stream_sys_t sout_stream_sys_t;
302 typedef struct config_chain_t config_chain_t;
303 typedef struct session_descriptor_t session_descriptor_t;
306 typedef struct decoder_t decoder_t;
307 typedef struct decoder_sys_t decoder_sys_t;
308 typedef struct decoder_synchro_t decoder_synchro_t;
311 typedef struct encoder_t encoder_t;
312 typedef struct encoder_sys_t encoder_sys_t;
315 typedef struct filter_t filter_t;
316 typedef struct filter_sys_t filter_sys_t;
319 typedef struct virtual_socket_t v_socket_t;
320 typedef struct vlc_url_t vlc_url_t;
323 typedef struct iso639_lang_t iso639_lang_t;
326 typedef struct block_t block_t;
327 typedef struct block_fifo_t block_fifo_t;
330 typedef struct md5_s md5_t;
333 typedef struct xml_t xml_t;
334 typedef struct xml_sys_t xml_sys_t;
335 typedef struct xml_reader_t xml_reader_t;
336 typedef struct xml_reader_sys_t xml_reader_sys_t;
339 typedef struct vod_t vod_t;
340 typedef struct vod_sys_t vod_sys_t;
341 typedef struct vod_media_t vod_media_t;
344 typedef struct osd_menu_t osd_menu_t;
345 typedef struct osd_state_t osd_state_t;
346 typedef struct osd_event_t osd_event_t;
347 typedef struct osd_button_t osd_button_t;
348 typedef struct osd_menu_state_t osd_menu_state_t;
351 typedef struct vlm_t vlm_t;
352 typedef struct vlm_message_t vlm_message_t;
355 typedef struct vlc_meta_t vlc_meta_t;
356 typedef struct input_stats_t input_stats_t;
359 typedef struct update_t update_t;
360 typedef struct update_iterator_t update_iterator_t;
363 typedef struct meta_engine_t meta_engine_t;
366 * VLC value structure
375 vlc_object_t * p_object;
378 struct { int32_t x; int32_t y; } coords;
388 vlc_value_t * p_values;
393 /*****************************************************************************
394 * Error values (shouldn't be exposed)
395 *****************************************************************************/
396 #define VLC_SUCCESS (-0) /**< No error */
397 #define VLC_EGENERIC (-1) /**< Unspecified error */
398 #define VLC_ENOMEM (-2) /**< Not enough memory */
399 #define VLC_ETIMEOUT (-3) /**< Timeout */
400 #define VLC_ENOMOD (-4) /**< Module not found */
401 #define VLC_ENOOBJ (-5) /**< Object not found */
402 #define VLC_ENOVAR (-6) /**< Variable not found */
403 #define VLC_EBADVAR (-7) /**< Bad variable value */
404 #define VLC_ENOITEM (-8) /**< Item not found */
406 /*****************************************************************************
408 *****************************************************************************/
409 typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
410 char const *, /* variable name */
411 vlc_value_t, /* old value */
412 vlc_value_t, /* new value */
413 void * ); /* callback data */
415 /*****************************************************************************
416 * OS-specific headers and thread types
417 *****************************************************************************/
419 # include <windows.h>
423 # define OS2EMX_PLAIN_CHAR
429 #include "vlc_mtime.h"
430 #include "vlc_threads.h"
432 /*****************************************************************************
433 * Common structure members
434 *****************************************************************************/
436 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
437 #define VLC_COMMON_MEMBERS \
438 /** \name VLC_COMMON_MEMBERS \
439 * these members are common for all vlc objects \
442 const char *psz_object_type; \
444 /* Messages header */ \
448 /* Object properties */ \
449 bool b_force; /**< set by the outside (eg. module_need()) */ \
451 /* Stuff related to the libvlc structure */ \
452 libvlc_int_t *p_libvlc; /**< (root of all evil) - 1 */ \
454 vlc_object_t * p_parent; /**< our parent */ \
458 /* VLC_OBJECT: attempt at doing a clever cast */
459 #if VLC_GCC_VERSION(4,0)
461 # define VLC_OBJECT( x ) \
462 __builtin_choose_expr( \
463 __builtin_offsetof(__typeof__(*(x)), psz_object_type), \
464 (void)0 /* screw you */, \
467 # define VLC_OBJECT( x ) \
468 ((vlc_object_t *)(x) \
469 + 0 * __builtin_offsetof(__typeof__(*(x)), psz_object_type))
472 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
475 /*****************************************************************************
476 * Macros and inline functions
477 *****************************************************************************/
479 /* CEIL: division with round to nearest greater integer */
480 #define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
482 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
483 #define PAD(n, d) ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
485 /* __MAX and __MIN: self explanatory */
487 # define __MAX(a, b) ( ((a) > (b)) ? (a) : (b) )
490 # define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
493 /* clip v in [min, max] */
494 #define VLC_CLIP(v, min, max) __MIN(__MAX((v), (min)), (max))
497 static inline int64_t GCD ( int64_t a, int64_t b )
508 /* function imported from libavutil/common.h */
510 static inline uint8_t clip_uint8_vlc( int32_t a )
512 if( a&(~255) ) return (-a)>>31;
516 /** Count leading zeroes */
518 static inline unsigned clz (unsigned x)
520 #if VLC_GCC_VERSION(3,4)
521 return __builtin_clz (x);
523 unsigned i = sizeof (x) * 8;
534 #define clz8( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))
535 #define clz16( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))
536 /* XXX: this assumes that int is 32-bits or more */
537 #define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))
541 static inline unsigned popcount (unsigned x)
543 #if VLC_GCC_VERSION(3,4)
544 return __builtin_popcount (x);
557 static inline unsigned parity (unsigned x)
559 #if VLC_GCC_VERSION(3,4)
560 return __builtin_parity (x);
562 for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
574 /** Byte swap (16 bits) */
576 static inline uint16_t bswap16 (uint16_t x)
578 return (x << 8) | (x >> 8);
581 /** Byte swap (32 bits) */
583 static inline uint32_t bswap32 (uint32_t x)
585 #if VLC_GCC_VERSION(4,3)
586 return __builtin_bswap32 (x);
588 return ((x & 0x000000FF) << 24)
589 | ((x & 0x0000FF00) << 8)
590 | ((x & 0x00FF0000) >> 8)
591 | ((x & 0xFF000000) >> 24);
595 /** Byte swap (64 bits) */
597 static inline uint64_t bswap64 (uint64_t x)
599 #if VLC_GCC_VERSION(4,3)
600 return __builtin_bswap64 (x);
601 #elif !defined (__cplusplus)
602 return ((x & 0x00000000000000FF) << 56)
603 | ((x & 0x000000000000FF00) << 40)
604 | ((x & 0x0000000000FF0000) << 24)
605 | ((x & 0x00000000FF000000) << 8)
606 | ((x & 0x000000FF00000000) >> 8)
607 | ((x & 0x0000FF0000000000) >> 24)
608 | ((x & 0x00FF000000000000) >> 40)
609 | ((x & 0xFF00000000000000) >> 56);
611 return ((x & 0x00000000000000FFLLU) << 56)
612 | ((x & 0x000000000000FF00LLU) << 40)
613 | ((x & 0x0000000000FF0000LLU) << 24)
614 | ((x & 0x00000000FF000000LLU) << 8)
615 | ((x & 0x000000FF00000000LLU) >> 8)
616 | ((x & 0x0000FF0000000000LLU) >> 24)
617 | ((x & 0x00FF000000000000LLU) >> 40)
618 | ((x & 0xFF00000000000000LLU) >> 56);
623 /* Free and set set the variable to NULL */
624 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
626 #define EMPTY_STR(str) (!str || !*str)
628 VLC_API char const * vlc_error( int ) VLC_USED;
630 #include <vlc_arrays.h>
632 /* MSB (big endian)/LSB (little endian) conversions - network order is always
633 * MSB, and should be used for both network communications and files. */
635 #ifdef WORDS_BIGENDIAN
636 # define hton16(i) ((uint16_t)(i))
637 # define hton32(i) ((uint32_t)(i))
638 # define hton64(i) ((uint64_t)(i))
640 # define hton16(i) bswap16(i)
641 # define hton32(i) bswap32(i)
642 # define hton64(i) bswap64(i)
644 #define ntoh16(i) hton16(i)
645 #define ntoh32(i) hton32(i)
646 #define ntoh64(i) hton64(i)
648 /** Reads 16 bits in network byte order */
650 static inline uint16_t U16_AT (const void *p)
654 memcpy (&x, p, sizeof (x));
658 /** Reads 32 bits in network byte order */
660 static inline uint32_t U32_AT (const void *p)
664 memcpy (&x, p, sizeof (x));
668 /** Reads 64 bits in network byte order */
670 static inline uint64_t U64_AT (const void *p)
674 memcpy (&x, p, sizeof (x));
678 #define GetWBE(p) U16_AT(p)
679 #define GetDWBE(p) U32_AT(p)
680 #define GetQWBE(p) U64_AT(p)
682 /** Reads 16 bits in little-endian order */
684 static inline uint16_t GetWLE (const void *p)
688 memcpy (&x, p, sizeof (x));
689 #ifdef WORDS_BIGENDIAN
695 /** Reads 32 bits in little-endian order */
697 static inline uint32_t GetDWLE (const void *p)
701 memcpy (&x, p, sizeof (x));
702 #ifdef WORDS_BIGENDIAN
708 /** Reads 64 bits in little-endian order */
710 static inline uint64_t GetQWLE (const void *p)
714 memcpy (&x, p, sizeof (x));
715 #ifdef WORDS_BIGENDIAN
721 /** Writes 16 bits in network byte order */
722 static inline void SetWBE (void *p, uint16_t w)
725 memcpy (p, &w, sizeof (w));
728 /** Writes 32 bits in network byte order */
729 static inline void SetDWBE (void *p, uint32_t dw)
732 memcpy (p, &dw, sizeof (dw));
735 /** Writes 64 bits in network byte order */
736 static inline void SetQWBE (void *p, uint64_t qw)
739 memcpy (p, &qw, sizeof (qw));
742 /** Writes 16 bits in little endian order */
743 static inline void SetWLE (void *p, uint16_t w)
745 #ifdef WORDS_BIGENDIAN
748 memcpy (p, &w, sizeof (w));
751 /** Writes 32 bits in little endian order */
752 static inline void SetDWLE (void *p, uint32_t dw)
754 #ifdef WORDS_BIGENDIAN
757 memcpy (p, &dw, sizeof (dw));
760 /** Writes 64 bits in little endian order */
761 static inline void SetQWLE (void *p, uint64_t qw)
763 #ifdef WORDS_BIGENDIAN
766 memcpy (p, &qw, sizeof (qw));
770 #define VLC_UNUSED(x) (void)(x)
772 /* Stuff defined in src/extras/libc.c */
776 /* several type definitions */
777 # if defined( __MINGW32__ )
778 # if !defined( _OFF_T_ )
779 typedef long long _off_t;
780 typedef _off_t off_t;
786 # define off_t long long
791 # define O_NONBLOCK 0
797 VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
799 /* Aligned memory allocator */
801 #include <AvailabilityMacros.h>
806 # define vlc_memalign(align, size) (__mingw_aligned_malloc(size, align))
807 # define vlc_free(base) (__mingw_aligned_free(base))
808 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
809 static inline void *vlc_memalign(size_t align, size_t size)
814 ptr = malloc(size+align);
817 diff = ((-(long)ptr - 1)&(align-1)) + 1;
818 ptr = (char*)ptr + diff;
819 ((char*)ptr)[-1]= diff;
823 static void vlc_free(void *ptr)
826 free((char*)ptr - ((char*)ptr)[-1]);
829 static inline void *vlc_memalign(size_t align, size_t size)
832 if (unlikely(posix_memalign(&base, align, size)))
836 # define vlc_free(base) free(base)
839 VLC_API void vlc_tdestroy( void *, void (*)(void *) );
841 /*****************************************************************************
843 *****************************************************************************/
844 VLC_API char *vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
845 VLC_API char *vlc_ngettext( const char *s, const char *p, unsigned long n ) VLC_FORMAT_ARG(1) VLC_FORMAT_ARG(2);
847 #define vlc_pgettext( ctx, id ) \
848 vlc_pgettext_aux( ctx "\004" id, id )
851 static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
853 const char *tr = vlc_gettext( ctx );
854 return (tr == ctx) ? id : tr;
857 /*****************************************************************************
858 * Loosy memory allocation functions. Do not use in new code.
859 *****************************************************************************/
860 static inline void *xmalloc (size_t len)
862 void *ptr = malloc (len);
863 if (unlikely (ptr == NULL))
868 static inline void *xrealloc (void *ptr, size_t len)
870 void *nptr = realloc (ptr, len);
871 if (unlikely (nptr == NULL))
876 static inline void *xcalloc (size_t n, size_t size)
878 void *ptr = calloc (n, size);
879 if (unlikely (ptr == NULL))
884 static inline char *xstrdup (const char *str)
886 char *ptr = strdup (str);
887 if (unlikely(ptr == NULL))
892 /*****************************************************************************
894 *****************************************************************************/
895 VLC_API const char * VLC_CompileBy( void ) VLC_USED;
896 VLC_API const char * VLC_CompileHost( void ) VLC_USED;
897 VLC_API const char * VLC_Compiler( void ) VLC_USED;
899 /*****************************************************************************
900 * Additional vlc stuff
901 *****************************************************************************/
902 #include "vlc_messages.h"
903 #include "vlc_objects.h"
904 #include "vlc_variables.h"
905 #include "vlc_main.h"
906 #include "vlc_configuration.h"
908 #if defined( WIN32 ) || defined( __SYMBIAN32__ ) || defined( __OS2__ )
909 # define DIR_SEP_CHAR '\\'
910 # define DIR_SEP "\\"
911 # define PATH_SEP_CHAR ';'
912 # define PATH_SEP ";"
914 # define DIR_SEP_CHAR '/'
916 # define PATH_SEP_CHAR ':'
917 # define PATH_SEP ":"
920 #define LICENSE_MSG \
921 _("This program comes with NO WARRANTY, to the extent permitted by " \
922 "law.\nYou may redistribute it under the terms of the GNU General " \
923 "Public License;\nsee the file named COPYING for details.\n" \
924 "Written by the VideoLAN team; see the AUTHORS file.\n")
926 #endif /* !VLC_COMMON_H */