* common.h: common definitions
* Collection of useful common types and macros definitions
*****************************************************************************
- * Copyright (C) 1998, 1999, 2000 VideoLAN
- * $Id: vlc_common.h,v 1.10 2002/07/20 18:01:42 sam Exp $
+ * Copyright (C) 1998-2005 the VideoLAN team
+ * $Id$
*
* Authors: Samuel Hocevar <sam@via.ecp.fr>
* Vincent Seguin <seguin@via.ecp.fr>
- * Gildas Bazin <gbazin@netcourrier.com>
+ * Gildas Bazin <gbazin@videolan.org>
*
* 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.
- *
+ *
* 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
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
+/**
+ * \file
+ * This file is a collection of common definitions and types
+ */
+
+#ifndef VLC_COMMON_H
+# define VLC_COMMON_H 1
+
/*****************************************************************************
- * Compiler-specific workarounds
+ * Required vlc headers
*****************************************************************************/
-#if defined( __BORLANDC__ )
-# undef HAVE_VARIADIC_MACROS
-# undef HAVE_STDINT_H
+#if defined( _MSC_VER )
+# pragma warning( disable : 4244 )
#endif
+#include "vlc_config.h"
+
/*****************************************************************************
* Required system headers
*****************************************************************************/
-#ifdef HAVE_STRING_H
-# include <string.h> /* strerror() */
-#endif
+#include <stdlib.h>
+#include <stdarg.h>
+
+#include <string.h>
+#include <stdio.h>
+#include <inttypes.h>
-#ifdef HAVE_SYS_TYPES_H
-# include <sys/types.h>
+#ifndef __cplusplus
+# include <stdbool.h>
#endif
/*****************************************************************************
* Basic types definitions
*****************************************************************************/
-#ifdef HAVE_STDINT_H
-# include <stdint.h>
- typedef uint8_t u8;
- typedef int8_t s8;
-
- typedef uint16_t u16;
- typedef int16_t s16;
-
- typedef uint32_t u32;
- typedef int32_t s32;
+#if defined( WIN32 ) || defined( UNDER_CE )
+# include <malloc.h>
+# ifndef PATH_MAX
+# define PATH_MAX MAX_PATH
+# endif
+#endif
- typedef uint64_t u64;
- typedef int64_t s64;
-#else
- typedef unsigned char u8;
- typedef signed char s8;
+/* Counter for statistics and profiling */
+typedef unsigned long count_t;
- typedef unsigned short u16;
- typedef signed short s16;
+/* Audio volume */
+typedef uint16_t audio_volume_t;
- typedef unsigned int u32;
- typedef signed int s32;
+/**
+ * High precision date or time interval
+ *
+ * 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
+ * time interval is then 292271 years, which should be long enough for any
+ * video). Dates are stored as microseconds since a common date (usually the
+ * epoch). Note that date and time intervals can be manipulated using regular
+ * arithmetic operators, and that no special functions are required.
+ */
+typedef int64_t mtime_t;
-# if defined( _MSC_VER ) || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
- typedef unsigned __int64 u64;
- typedef signed __int64 s64;
-# else
- typedef unsigned long long u64;
- typedef signed long long s64;
-# endif
-#endif
+/**
+ * The vlc_fourcc_t type.
+ *
+ * See http://www.webartz.com/fourcc/ for a very detailed list.
+ */
+typedef uint32_t vlc_fourcc_t;
-typedef u8 byte_t;
+#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 ) )
-/* ptrdiff_t definition */
-#ifdef HAVE_STDDEF_H
-# include <stddef.h>
#else
-# include <malloc.h>
-# ifndef _PTRDIFF_T
-# define _PTRDIFF_T
-/* Not portable in a 64-bit environment. */
-typedef int ptrdiff_t;
-# endif
-#endif
+# 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 ) )
-#if defined( WIN32 )
-typedef int ssize_t;
#endif
-/* Counter for statistics and profiling */
-typedef unsigned long count_t;
-
-/* DCT elements types */
-typedef s16 dctelem_t;
-
-/* Video buffer types */
-typedef u8 yuv_data_t;
+static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
+{
+ memcpy( psz_fourcc, &fcc, 4 );
+}
-/*****************************************************************************
- * mtime_t: high precision date or time interval
- *****************************************************************************
- * Store an high precision date or time interval. The maximum precision is the
- * micro-second, and a 64 bits integer is used to avoid any overflow (maximum
- * time interval is then 292271 years, which should be long enough for any
- * video). Date are stored as a time interval since a common date.
- * Note that date and time intervals can be manipulated using regular
- * arithmetic operators, and that no special functions are required.
- *****************************************************************************/
-typedef s64 mtime_t;
+#define vlc_fourcc_to_char( a, b ) \
+ __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
/*****************************************************************************
* Classes declaration
*****************************************************************************/
+/* Internal types */
+typedef struct vlc_list_t vlc_list_t;
+typedef struct vlc_object_t vlc_object_t;
+typedef struct libvlc_int_t libvlc_int_t;
+typedef struct variable_t variable_t;
+typedef struct date_t date_t;
+typedef struct dict_entry_t dict_entry_t;
+typedef struct dict_t dict_t;
+typedef struct gc_object_t gc_object_t ;
+
/* Messages */
-VLC_DECLARE_STRUCT(msg_bank_t)
-VLC_DECLARE_STRUCT(msg_subscription_t)
+typedef struct msg_subscription_t msg_subscription_t;
/* Playlist */
-VLC_DECLARE_STRUCT(playlist_t)
-VLC_DECLARE_STRUCT(playlist_item_t)
+
+/* FIXME */
+/**
+ * Playlist commands
+ */
+typedef enum {
+ PLAYLIST_PLAY, /**< No arg. res=can fail*/
+ PLAYLIST_VIEWPLAY, /**< arg1= playlist_item_t*,*/
+ /** arg2 = playlist_item_t* , res=can fail */
+ PLAYLIST_PAUSE, /**< No arg res=can fail*/
+ PLAYLIST_STOP, /**< No arg res=can fail*/
+ PLAYLIST_SKIP, /**< arg1=int, res=can fail*/
+} playlist_command_t;
+
+
+typedef struct playlist_t playlist_t;
+typedef struct playlist_item_t playlist_item_t;
+typedef struct playlist_view_t playlist_view_t;
+typedef struct playlist_export_t playlist_export_t;
+typedef struct services_discovery_t services_discovery_t;
+typedef struct services_discovery_sys_t services_discovery_sys_t;
+typedef struct playlist_add_t playlist_add_t;
+typedef struct playlist_preparse_t playlist_preparse_t;
+typedef struct playlist_fetcher_t playlist_fetcher_t;
/* Modules */
-VLC_DECLARE_STRUCT(module_bank_t)
-VLC_DECLARE_STRUCT(module_t)
-VLC_DECLARE_STRUCT(module_config_t)
-VLC_DECLARE_STRUCT(module_symbols_t)
-VLC_DECLARE_STRUCT(module_functions_t)
+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;
+typedef struct module_cache_t module_cache_t;
+
+typedef struct config_category_t config_category_t;
/* Interface */
-VLC_DECLARE_STRUCT(intf_thread_t)
-VLC_DECLARE_STRUCT(intf_sys_t)
-VLC_DECLARE_STRUCT(intf_console_t)
-VLC_DECLARE_STRUCT(intf_msg_t)
-VLC_DECLARE_STRUCT(intf_channel_t)
+typedef struct intf_thread_t intf_thread_t;
+typedef struct intf_sys_t intf_sys_t;
+typedef struct intf_console_t intf_console_t;
+typedef struct intf_msg_t intf_msg_t;
+typedef struct interaction_t interaction_t;
+typedef struct interaction_dialog_t interaction_dialog_t;
+typedef struct user_widget_t user_widget_t;
/* Input */
-VLC_DECLARE_STRUCT(input_thread_t)
-VLC_DECLARE_STRUCT(input_channel_t)
-VLC_DECLARE_STRUCT(input_cfg_t)
-VLC_DECLARE_STRUCT(input_area_t)
-VLC_DECLARE_STRUCT(input_buffers_t)
-VLC_DECLARE_STRUCT(input_socket_t)
+typedef struct input_thread_t input_thread_t;
+typedef struct input_thread_sys_t input_thread_sys_t;
+typedef struct input_item_t input_item_t;
+typedef struct access_t access_t;
+typedef struct access_sys_t access_sys_t;
+typedef struct stream_t stream_t;
+typedef struct stream_sys_t stream_sys_t;
+typedef struct demux_t demux_t;
+typedef struct demux_meta_t demux_meta_t;
+typedef struct demux_sys_t demux_sys_t;
+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;
+typedef struct es_descriptor_t es_descriptor_t;
+typedef struct seekpoint_t seekpoint_t;
+typedef struct info_t info_t;
+typedef struct info_category_t info_category_t;
+typedef struct input_attachment_t input_attachment_t;
+
+/* 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;
+typedef struct es_format_t es_format_t;
+typedef struct video_palette_t video_palette_t;
/* Audio */
-VLC_DECLARE_STRUCT(aout_thread_t)
-VLC_DECLARE_STRUCT(aout_sys_t)
-VLC_DECLARE_STRUCT(aout_fifo_t)
+typedef struct aout_instance_t aout_instance_t;
+typedef struct aout_sys_t aout_sys_t;
+typedef struct aout_fifo_t aout_fifo_t;
+typedef struct aout_input_t aout_input_t;
+typedef struct aout_buffer_t aout_buffer_t;
+typedef audio_format_t audio_sample_format_t;
+typedef struct audio_date_t audio_date_t;
+typedef struct aout_filter_t aout_filter_t;
/* Video */
-VLC_DECLARE_STRUCT(vout_thread_t)
-VLC_DECLARE_STRUCT(vout_font_t)
-VLC_DECLARE_STRUCT(vout_sys_t)
-VLC_DECLARE_STRUCT(chroma_sys_t)
-VLC_DECLARE_STRUCT(picture_t)
-VLC_DECLARE_STRUCT(picture_sys_t)
-VLC_DECLARE_STRUCT(picture_heap_t)
-VLC_DECLARE_STRUCT(subpicture_t)
-VLC_DECLARE_STRUCT(subpicture_sys_t)
+typedef struct vout_thread_t vout_thread_t;
+typedef struct vout_sys_t vout_sys_t;
+
+typedef video_format_t video_frame_format_t;
+typedef struct picture_t picture_t;
+typedef struct picture_sys_t picture_sys_t;
+typedef struct picture_heap_t picture_heap_t;
+
+/* Subpictures */
+typedef struct spu_t spu_t;
+typedef struct subpicture_t subpicture_t;
+typedef struct subpicture_sys_t subpicture_sys_t;
+typedef struct subpicture_region_t subpicture_region_t;
+typedef struct text_style_t text_style_t;
+
+typedef struct image_handler_t image_handler_t;
+
+/* Stream output */
+typedef struct sout_instance_t sout_instance_t;
+typedef struct sout_instance_sys_t sout_instance_sys_t;
+
+typedef struct sout_input_t sout_input_t;
+typedef struct sout_packetizer_input_t sout_packetizer_input_t;
+
+typedef struct sout_access_out_t sout_access_out_t;
+typedef struct sout_access_out_sys_t sout_access_out_sys_t;
+
+typedef struct sout_mux_t sout_mux_t;
+typedef struct sout_mux_sys_t sout_mux_sys_t;
+
+typedef struct sout_stream_t sout_stream_t;
+typedef struct sout_stream_sys_t sout_stream_sys_t;
+
+typedef struct config_chain_t config_chain_t;
+typedef struct sap_session_t sap_session_t;
+typedef struct sap_address_t sap_address_t;
+typedef struct session_descriptor_t session_descriptor_t;
+typedef struct announce_method_t announce_method_t;
+typedef struct announce_handler_t announce_handler_t;
+typedef struct sap_handler_t sap_handler_t;
+
+typedef struct sout_param_t sout_param_t;
+typedef struct sout_pcat_t sout_pcat_t;
+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;
+typedef struct profile_parser_t profile_parser_t;
/* Decoders */
-VLC_DECLARE_STRUCT(decoder_fifo_t)
+typedef struct decoder_t decoder_t;
+typedef struct decoder_sys_t decoder_sys_t;
+typedef struct decoder_synchro_t decoder_synchro_t;
+
+/* Encoders */
+typedef struct encoder_t encoder_t;
+typedef struct encoder_sys_t encoder_sys_t;
+
+/* Filters */
+typedef struct filter_t filter_t;
+typedef struct filter_sys_t filter_sys_t;
+
+/* Network */
+typedef struct network_socket_t network_socket_t;
+typedef struct virtual_socket_t v_socket_t;
+typedef struct sockaddr sockaddr;
+typedef struct addrinfo addrinfo;
+typedef struct vlc_acl_t vlc_acl_t;
+typedef struct vlc_url_t vlc_url_t;
/* Misc */
-VLC_DECLARE_STRUCT(macroblock_t)
-VLC_DECLARE_STRUCT(data_packet_t)
-VLC_DECLARE_STRUCT(data_buffer_t)
-VLC_DECLARE_STRUCT(downmix_t)
-VLC_DECLARE_STRUCT(imdct_t)
-VLC_DECLARE_STRUCT(complex_t)
-VLC_DECLARE_STRUCT(dm_par_t)
-VLC_DECLARE_STRUCT(es_descriptor_t)
-VLC_DECLARE_STRUCT(pgrm_descriptor_t)
-VLC_DECLARE_STRUCT(stream_descriptor_t)
-VLC_DECLARE_STRUCT(stream_position_t)
-VLC_DECLARE_STRUCT(stream_ctrl_t)
-VLC_DECLARE_STRUCT(pes_packet_t)
-VLC_DECLARE_STRUCT(bit_stream_t)
-VLC_DECLARE_STRUCT(network_socket_t)
-VLC_DECLARE_STRUCT(iso639_lang_t)
+typedef struct iso639_lang_t iso639_lang_t;
+typedef struct device_t device_t;
+typedef struct device_probe_t device_probe_t;
+typedef struct probe_sys_t probe_sys_t;
+
+/* block */
+typedef struct block_t block_t;
+typedef struct block_fifo_t block_fifo_t;
+
+/* 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;
+typedef int (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
+typedef struct httpd_file_t httpd_file_t;
+typedef struct httpd_file_sys_t httpd_file_sys_t;
+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;
+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 );
+typedef struct httpd_redirect_t httpd_redirect_t;
+typedef struct httpd_stream_t httpd_stream_t;
+
+/* TLS support */
+typedef struct tls_server_t tls_server_t;
+typedef struct tls_session_t tls_session_t;
+
+/* Hashing */
+typedef struct md5_s md5_t;
+
+/* 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;
+
+/* vod server */
+typedef struct vod_t vod_t;
+typedef struct vod_sys_t vod_sys_t;
+typedef struct vod_media_t vod_media_t;
+
+/* opengl */
+typedef struct opengl_t opengl_t;
+typedef struct opengl_sys_t opengl_sys_t;
+
+/* 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;
+
+/* VLM */
+typedef struct vlm_t vlm_t;
+typedef struct vlm_message_t vlm_message_t;
+
+/* divers */
+typedef struct vlc_meta_t vlc_meta_t;
+typedef struct meta_export_t meta_export_t;
+
+/* Stats */
+typedef struct counter_t counter_t;
+typedef struct counter_sample_t counter_sample_t;
+typedef struct stats_handler_t stats_handler_t;
+typedef struct input_stats_t input_stats_t;
+typedef struct global_stats_t global_stats_t;
+
+/* Update */
+typedef struct update_t update_t;
+typedef struct update_iterator_t update_iterator_t;
+
+/* Meta engine */
+typedef struct meta_engine_t meta_engine_t;
+
+/* stat/lstat/fstat */
+#ifdef WIN32
+#include <sys/stat.h>
+struct _stati64;
+#define stat _stati64
+#define fstat _fstati64
+/* You should otherwise use utf8_stat and utf8_lstat. */
+#else
+struct stat;
+#endif
+
+/**
+ * VLC value structure
+ */
+typedef union
+{
+ int i_int;
+ bool b_bool;
+ 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_ETHREAD -2 /* Thread error */
+#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 */
+
+/*****************************************************************************
+ * 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 */
/*****************************************************************************
* Plug-in stuff
*****************************************************************************/
-#ifndef __PLUGIN__
-# define VLC_EXPORT( type, name, args ) type name args;
+
+#ifdef __cplusplus
+# define LIBVLC_EXTERN extern "C"
#else
-# define VLC_EXPORT( type, name, args ) ;
- extern module_symbols_t* p_symbols;
+# define LIBVLC_EXTERN extern
#endif
+#if defined (WIN32) && defined (DLL_EXPORT)
+# define LIBVLC_EXPORT __declspec(dllexport)
+#else
+# define LIBVLC_EXPORT
+#endif
+#define VLC_EXPORT( type, name, args ) \
+ LIBVLC_EXTERN LIBVLC_EXPORT type name args
/*****************************************************************************
* OS-specific headers and thread types
*****************************************************************************/
-#if defined( WIN32 )
+#if defined( WIN32 ) || defined( UNDER_CE )
# define WIN32_LEAN_AND_MEAN
# include <windows.h>
+# if defined( UNDER_CE )
+# define IS_WINNT 0
+# else
+# define IS_WINNT ( GetVersion() < 0x80000000 )
+# endif
#endif
+#include "vlc_mtime.h"
#include "vlc_threads.h"
+typedef struct vlc_object_internals_t vlc_object_internals_t;
+
/*****************************************************************************
* Common structure members
*****************************************************************************/
/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS \
+/** \name VLC_COMMON_MEMBERS \
+ * these members are common for all vlc objects \
+ */ \
+/**@{*/ \
int i_object_id; \
int i_object_type; \
- char *psz_object_type; \
+ const char *psz_object_type; \
char *psz_object_name; \
\
- /* Thread properties, if any */ \
- vlc_bool_t b_thread; \
- vlc_thread_t thread_id; \
+ /* Messages header */ \
+ char *psz_header; \
+ int i_flags; \
\
- /* Object access lock */ \
- vlc_mutex_t object_lock; \
- vlc_cond_t object_wait; \
+ /* Object properties */ \
+ volatile bool b_error; /**< set by the object */ \
+ volatile bool b_die; /**< set by the outside */ \
+ volatile bool b_dead; /**< set by the object */ \
+ bool b_force; /**< set by the outside (eg. module_Need()) */ \
\
- volatile vlc_bool_t b_error; /* set by the object */ \
- volatile vlc_bool_t b_die; /* set by the outside */ \
- volatile vlc_bool_t b_dead; /* set by the object */ \
+ /* Stuff related to the libvlc structure */ \
+ libvlc_int_t *p_libvlc; /**< (root of all evil) - 1 */ \
\
- vlc_t * p_vlc; /* root of all evil */ \
+ vlc_object_t * p_parent; /**< our parent */ \
\
- volatile int i_refcount; \
- vlc_object_t ** pp_parents; /* our parents */ \
- volatile int i_parents; \
- vlc_object_t ** pp_children; /* our children */ \
- volatile int i_children; \
+ /* Private data */ \
+ void * p_private; \
\
- /* Just a reminder so that people don't cast garbage */ \
+ /** Just a reminder so that people don't cast garbage */ \
int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct; \
-
-/* The real vlc_object_t type. Yes, it's that simple :-) */
-struct vlc_object_t
+/**@}*/ \
+
+/* VLC_OBJECT: attempt at doing a clever cast */
+#define VLC_OBJECT( x ) \
+ (((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct)
+
+#define VLC_GC_MEMBERS \
+/** \name VLC_GC_MEMBERS \
+ * these members are common to all objects that wish to be garbage-collected \
+ */ \
+/**@{*/ \
+ int i_gc_refcount; \
+ void (*pf_destructor) ( gc_object_t * ); \
+ void *p_destructor_arg; \
+/**@}*/
+
+struct gc_object_t
{
- VLC_COMMON_MEMBERS
+ VLC_GC_MEMBERS
};
-/* CAST_TO_VLC_OBJECT: attempt at doing a clever cast */
-#define CAST_TO_VLC_OBJECT( x ) \
- ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
+VLC_EXPORT(void, __vlc_gc_incref, ( gc_object_t * p_gc ));
+VLC_EXPORT(void, __vlc_gc_decref, ( gc_object_t * p_gc ));
+VLC_EXPORT(void, __vlc_gc_init, ( gc_object_t * p_gc,
+ void (*pf_destructor)( gc_object_t * ), void * arg));
+
+#define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
+#define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
+#define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
+
/*****************************************************************************
* Macros and inline functions
*****************************************************************************/
-#ifdef NTOHL_IN_SYS_PARAM_H
-# include <sys/param.h>
-
-#elif !defined(WIN32) /* NTOHL_IN_SYS_PARAM_H || WIN32 */
-# include <netinet/in.h>
-
-#endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
/* CEIL: division with round to nearest greater integer */
#define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
# define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
#endif
+static inline int64_t GCD( int64_t a, int64_t b )
+{
+ while( b )
+ {
+ int64_t c = a % b;
+ a = b;
+ b = c;
+ }
+ return a;
+}
+
+/* function imported from libavutil/common.h */
+static inline uint8_t clip_uint8_vlc( int32_t a )
+{
+ if( a&(~255) ) return (-a)>>31;
+ else return a;
+}
+
+/* Malloc with automatic error */
+#define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
+ if( !var ) return; } while(0)
+#define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
+ if( !var ) return NULL; } while(0)
+#define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
+ if( !var ) return VLC_ENOMEM; } while(0)
+#define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
+ if( !var ) goto error; } while(0)
+#define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
+ if( !var ) return;
+#define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\
+ if( !var ) return VLC_ENOMEM;
+#define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
+ if( !var ) return NULL;
+
+#define FREENULL(a) do { free( a ); a = NULL; } while(0)
+
+#define EMPTY_STR(str) (!str || !*str)
+
+VLC_EXPORT( char const *, vlc_error, ( int ) );
+
+#include <vlc_arrays.h>
+
/* MSB (big endian)/LSB (little endian) conversions - network order is always
- * MSB, and should be used for both network communications and files. Note that
- * byte orders other than little and big endians are not supported, but only
- * the VAX seems to have such exotic properties. */
-static inline u16 U16_AT( void * _p )
+ * MSB, and should be used for both network communications and files. */
+static inline uint16_t U16_AT( const void * _p )
{
- u8 * p = (u8 *)_p;
- return ( ((u16)p[0] << 8) | p[1] );
+ const uint8_t * p = (const uint8_t *)_p;
+ return ( ((uint16_t)p[0] << 8) | p[1] );
}
-static inline u32 U32_AT( void * _p )
+static inline uint32_t U32_AT( const void * _p )
{
- u8 * p = (u8 *)_p;
- return ( ((u32)p[0] << 24) | ((u32)p[1] << 16) | ((u32)p[2] << 8) | p[3] );
+ const uint8_t * p = (const uint8_t *)_p;
+ return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
+ | ((uint32_t)p[2] << 8) | p[3] );
}
-static inline u64 U64_AT( void * _p )
+static inline uint64_t U64_AT( const void * _p )
{
- u8 * p = (u8 *)_p;
- return ( ((u64)p[0] << 56) | ((u64)p[1] << 48) | ((u64)p[2] << 40)
- | ((u64)p[3] << 32) | ((u64)p[4] << 24) | ((u64)p[5] << 16)
- | ((u64)p[6] << 8) | p[7] );
+ const uint8_t * p = (const uint8_t *)_p;
+ 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] );
}
-#if WORDS_BIGENDIAN
-# define hton16(i) ( i )
-# define hton32(i) ( i )
-# define hton64(i) ( i )
-# define ntoh16(i) ( i )
-# define ntoh32(i) ( i )
-# define ntoh64(i) ( i )
-#else
-# define hton16(i) U16_AT(&i)
-# define hton32(i) U32_AT(&i)
-# define hton64(i) U64_AT(&i)
-# define ntoh16(i) U16_AT(&i)
-# define ntoh32(i) U32_AT(&i)
-# define ntoh64(i) U64_AT(&i)
-#endif
-/* Alignment of critical static data structures */
-#ifdef ATTRIBUTE_ALIGNED_MAX
-# define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
-#else
-# define ATTR_ALIGN(align)
-#endif
+static inline uint16_t GetWLE( const void * _p )
+{
+ const uint8_t * p = (const uint8_t *)_p;
+ return ( ((uint16_t)p[1] << 8) | p[0] );
+}
+static inline uint32_t GetDWLE( const void * _p )
+{
+ const uint8_t * p = (const uint8_t *)_p;
+ return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
+ | ((uint32_t)p[1] << 8) | p[0] );
+}
+static inline uint64_t GetQWLE( const void * _p )
+{
+ const uint8_t * p = (const uint8_t *)_p;
+ 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] );
+}
-/* Alignment of critical dynamic data structure
- *
- * Not all platforms support memalign so we provide a vlc_memalign wrapper
- * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
- * *pp_orig is the pointer that has to be freed afterwards.
- */
-#if 0
-#ifdef HAVE_POSIX_MEMALIGN
-# define vlc_memalign(align,size,pp_orig) \
- ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
-#endif
-#endif
-#ifdef HAVE_MEMALIGN
- /* Some systems have memalign() but no declaration for it */
- void * memalign( size_t align, size_t size );
+#define GetWBE( p ) U16_AT( p )
+#define GetDWBE( p ) U32_AT( p )
+#define GetQWBE( p ) U64_AT( p )
-# define vlc_memalign(pp_orig,align,size) \
- ( *(pp_orig) = memalign( align, size ) )
+/* Helper writer functions */
+#define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
+static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
+{
+ p[1] = ( i_dw >> 8 )&0xff;
+ p[0] = ( i_dw )&0xff;
+}
-#else /* We don't have any choice but to align manually */
-# define vlc_memalign(pp_orig,align,size) \
- (( *(pp_orig) = malloc( size + align - 1 )) \
- ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
- & (~(unsigned long)(align-1)) ) \
- : NULL )
+#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
+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;
+}
+#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
+static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
+{
+ SetDWLE( p, i_qw&0xffffffff );
+ SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
+}
+#define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
+static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
+{
+ p[0] = ( i_dw >> 8 )&0xff;
+ p[1] = ( i_dw )&0xff;
+}
-#endif
+#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
+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;
+}
+#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
+static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
+{
+ SetDWBE( p+4, i_qw&0xffffffff );
+ SetDWBE( p, ( i_qw >> 32)&0xffffffff );
+}
+
+#define hton16(i) htons(i)
+#define hton32(i) htonl(i)
+#define ntoh16(i) ntohs(i)
+#define ntoh32(i) ntohl(i)
+
+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)
-/* strndup (defined in src/misc/extras.c) */
-#ifndef HAVE_STRNDUP
-char * strndup( const char *s, size_t n );
+/* Format string sanity checks */
+#ifdef __GNUC__
+# define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
+#else
+# define LIBVLC_FORMAT(x,y)
#endif
+/* */
+#define VLC_UNUSED(x) (void)(x)
-#define I64C(x) x##LL
+/* Stuff defined in src/extras/libc.c */
+VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
+VLC_EXPORT( long long, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
-#ifdef WIN32
+VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
+
+#if defined(WIN32) || defined(UNDER_CE)
/* win32, cl and icl support */
# if defined( _MSC_VER ) || !defined( __MINGW32__ )
# define __attribute__(x)
# define __inline__ __inline
-# define strncasecmp strnicmp
-# define strcasecmp stricmp
# define S_IFBLK 0x3000 /* Block */
# 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)
-# undef I64C
-# define I64C(x) x##i64
# endif
/* several type definitions */
# if defined( __MINGW32__ )
# if !defined( _OFF_T_ )
-typedef long long _off_t;
-typedef _off_t off_t;
+ typedef long long _off_t;
+ typedef _off_t off_t;
# define _OFF_T_
# else
+# ifdef off_t
+# undef off_t
+# endif
# define off_t long long
# endif
# endif
-# if defined( _MSC_VER )
+# if defined( _MSC_VER ) && !defined( __WXMSW__ )
# if !defined( _OFF_T_DEFINED )
-typedef __int64 off_t;
+ typedef __int64 off_t;
# define _OFF_T_DEFINED
# else
+ /* for wx compatibility typedef long off_t; */
# define off_t __int64
# endif
# endif
# define O_NONBLOCK 0
# endif
+# ifndef alloca
+# define alloca _alloca
+# endif
+
+ /* These two are not defined in mingw32 (bug?) */
# ifndef snprintf
-# define snprintf _snprintf /* snprintf not defined in mingw32 (bug?) */
+# define snprintf _snprintf
+# endif
+# ifndef vsnprintf
+# define vsnprintf _vsnprintf
# endif
+# include <tchar.h>
#endif
+VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
+
+/* vlc_wraptext (defined in src/extras/libc.c) */
+#define wraptext vlc_wraptext
+VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
+
+/* iconv wrappers (defined in src/extras/libc.c) */
+typedef void *vlc_iconv_t;
+VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
+VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
+VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
+
+/* execve wrapper (defined in src/extras/libc.c) */
+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 ) );
+#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)
+
+/* dir wrappers (defined in src/extras/libc.c) */
+VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir ));
+
/*****************************************************************************
* CPU capabilities
*****************************************************************************/
#define CPU_CAPABILITY_3DNOW (1<<4)
#define CPU_CAPABILITY_MMXEXT (1<<5)
#define CPU_CAPABILITY_SSE (1<<6)
+#define CPU_CAPABILITY_SSE2 (1<<7)
#define CPU_CAPABILITY_ALTIVEC (1<<16)
#define CPU_CAPABILITY_FPU (1<<31)
+VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
+
+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) );
+VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
+VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
/*****************************************************************************
* I18n stuff
*****************************************************************************/
-#ifndef PACKAGE /* Borland C++ uses this ! */
-#define PACKAGE VLC_PACKAGE
-#endif
-#define VERSION VLC_VERSION
-
-#if defined( ENABLE_NLS ) && defined ( HAVE_GETTEXT ) && !defined( __BORLANDC__ ) && !defined( MODULE_NAME_IS_gnome )
-# include <libintl.h>
-# undef _
-# define _(String) dgettext (PACKAGE, String)
-# ifdef gettext_noop
-# define N_(String) gettext_noop (String)
-# else
-# define N_(String) (String)
-# endif
-#elif !defined( MODULE_NAME_IS_gnome )
-# define _(String) (String)
-# define N_(String) (String)
-#endif
+VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) );
/*****************************************************************************
- * Plug-in stuff
+ * libvlc features
+ *****************************************************************************/
+VLC_EXPORT( const char *, VLC_Version, ( void ) );
+VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
+VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
+VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
+VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
+VLC_EXPORT( const char *, VLC_Error, ( int ) );
+VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
+
+/*****************************************************************************
+ * Additional vlc stuff
*****************************************************************************/
-#include "vlc_symbols.h"
+#include "vlc_messages.h"
+#include "vlc_variables.h"
+#include "vlc_objects.h"
+#include "vlc_modules.h"
+#include "vlc_main.h"
+#include "vlc_configuration.h"
+
+#if defined( WIN32 ) || defined( UNDER_CE )
+# define DIR_SEP_CHAR '\\'
+# define DIR_SEP "\\"
+# define PATH_SEP_CHAR ';'
+# define PATH_SEP ";"
+#else
+# define DIR_SEP_CHAR '/'
+# define DIR_SEP "/"
+# define PATH_SEP_CHAR ':'
+# define PATH_SEP ":"
+#endif
+
+#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")
+
+#endif /* !VLC_COMMON_H */