libvlc.h
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:11k
源码类别:

midi

开发平台:

Unix_Linux

  1. /*****************************************************************************
  2.  * libvlc.h: Internal libvlc generic/misc declaration
  3.  *****************************************************************************
  4.  * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
  5.  * Copyright © 2006-2007 Rémi Denis-Courmont
  6.  * $Id: 16f9aee12a3db37a606e2d48107dcd7c69fc845b $
  7.  *
  8.  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  9.  *
  10.  * This program is free software; you can redistribute it and/or modify
  11.  * it under the terms of the GNU General Public License as published by
  12.  * the Free Software Foundation; either version 2 of the License, or
  13.  * (at your option) any later version.
  14.  *
  15.  * This program is distributed in the hope that it will be useful,
  16.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18.  * GNU General Public License for more details.
  19.  *
  20.  * You should have received a copy of the GNU General Public License
  21.  * along with this program; if not, write to the Free Software
  22.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23.  *****************************************************************************/
  24. #ifndef LIBVLC_LIBVLC_H
  25. # define LIBVLC_LIBVLC_H 1
  26. typedef struct variable_t variable_t;
  27. extern const char vlc_usage[];
  28. /* Actions (hot keys) */
  29. typedef struct action
  30. {
  31.     char name[24];
  32.     int  value;
  33. } action_t;
  34. extern const struct action libvlc_actions[];
  35. extern const size_t libvlc_actions_count;
  36. extern int vlc_key_to_action (vlc_object_t *, const char *,
  37.                               vlc_value_t, vlc_value_t, void *);
  38. /*
  39.  * OS-specific initialization
  40.  */
  41. void system_Init      ( libvlc_int_t *, int *, const char *[] );
  42. void system_Configure ( libvlc_int_t *, int *, const char *[] );
  43. void system_End       ( libvlc_int_t * );
  44. /*
  45.  * Legacy object stuff that is still used within libvlccore (only)
  46.  */
  47. #define vlc_object_signal_unlocked( obj )
  48. vlc_list_t *vlc_list_find( vlc_object_t *, int, int );
  49. #define VLC_OBJECT_INTF        (-4)
  50. #define VLC_OBJECT_PACKETIZER  (-13)
  51. /*
  52.  * Threads subsystem
  53.  */
  54. /* Hopefully, no need to export this. There is a new thread API instead. */
  55. void vlc_thread_cancel (vlc_object_t *);
  56. int vlc_object_waitpipe (vlc_object_t *obj);
  57. void vlc_threads_setup (libvlc_int_t *);
  58. void vlc_trace (const char *fn, const char *file, unsigned line);
  59. #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
  60. #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
  61. void vlc_assert_locked (vlc_mutex_t *);
  62. #else
  63. # define vlc_assert_locked( m ) (void)m
  64. #endif
  65. /*
  66.  * CPU capabilities
  67.  */
  68. extern uint32_t cpu_flags;
  69. uint32_t CPUCapabilities( void );
  70. /*
  71.  * Message/logging stuff
  72.  */
  73. /**
  74.  * Store all data required by messages interfaces.
  75.  */
  76. typedef struct msg_bank_t
  77. {
  78.     /** Message queue lock */
  79.     vlc_mutex_t lock;
  80.     vlc_cond_t  wait;
  81.     /* Subscribers */
  82.     int i_sub;
  83.     msg_subscription_t **pp_sub;
  84.     /* Logfile for WinCE */
  85. #ifdef UNDER_CE
  86.     FILE *logfile;
  87. #endif
  88. } msg_bank_t;
  89. void msg_Create  (libvlc_int_t *);
  90. void msg_Destroy (libvlc_int_t *);
  91. /** Internal message stack context */
  92. void msg_StackSet ( int, const char*, ... );
  93. void msg_StackAdd ( const char*, ... );
  94. const char* msg_StackMsg ( void );
  95. void msg_StackDestroy (void *);
  96. /*
  97.  * Unicode stuff
  98.  */
  99. char *vlc_fix_readdir (const char *);
  100. /*
  101.  * LibVLC objects stuff
  102.  */
  103. /**
  104.  * Creates a VLC object.
  105.  *
  106.  * Note that because the object name pointer must remain valid, potentially
  107.  * even after the destruction of the object (through the message queues), this
  108.  * function CANNOT be exported to plugins as is. In this case, the old
  109.  * vlc_object_create() must be used instead.
  110.  *
  111.  * @param p_this an existing VLC object
  112.  * @param i_size byte size of the object structure
  113.  * @param i_type object type, usually VLC_OBJECT_CUSTOM
  114.  * @param psz_type object type name
  115.  * @return the created object, or NULL.
  116.  */
  117. extern void *
  118. __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
  119.                      const char *psz_type);
  120. #define vlc_custom_create(o, s, t, n) 
  121.         __vlc_custom_create(VLC_OBJECT(o), s, t, n)
  122. /*
  123.  * To be cleaned-up module stuff:
  124.  */
  125. extern char *psz_vlcpath;
  126. /* Return a NULL terminated array with the names of the modules that have a
  127.  * certain capability.
  128.  * Free after uses both the string and the table. */
  129. char **module_GetModulesNamesForCapability (const char * psz_capability,
  130.                                             char ***psz_longname);
  131. module_t *module_find_by_shortcut (const char *psz_shortcut);
  132. /**
  133.  * Private LibVLC data for each object.
  134.  */
  135. typedef struct vlc_object_internals_t
  136. {
  137.     int             i_object_type; /* Object type, deprecated */
  138.     /* Object variables */
  139.     variable_t *    p_vars;
  140.     vlc_mutex_t     var_lock;
  141.     vlc_cond_t      var_wait;
  142.     int             i_vars;
  143.     /* Thread properties, if any */
  144.     vlc_thread_t    thread_id;
  145.     bool            b_thread;
  146.     /* Objects thread synchronization */
  147.     int             pipes[2];
  148.     /* Objects management */
  149.     vlc_spinlock_t   ref_spin;
  150.     unsigned         i_refcount;
  151.     vlc_destructor_t pf_destructor;
  152.     /* Objects tree structure */
  153.     vlc_object_t    *prev, *next;
  154.     vlc_object_t   **pp_children;
  155.     int              i_children;
  156. } vlc_object_internals_t;
  157. #define ZOOM_SECTION N_("Zoom")
  158. #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
  159. #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
  160. #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
  161. #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
  162. #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
  163. typedef struct sap_handler_t sap_handler_t;
  164. /**
  165.  * Private LibVLC instance data.
  166.  */
  167. typedef struct libvlc_priv_t
  168. {
  169.     libvlc_int_t       public_data;
  170.     vlc_cond_t         exiting; ///< signaled when VLC wants to exit
  171.     int                i_last_input_id ; ///< Last id of input item
  172.     /* Messages */
  173.     msg_bank_t         msg_bank;    ///< The message bank
  174.     int                i_verbose;   ///< info messages
  175.     bool               b_color;     ///< color messages?
  176.     vlc_dictionary_t   msg_enabled_objects; ///< Enabled objects
  177.     bool               msg_all_objects_enabled; ///< Should we print all objects?
  178.     /* Timer stats */
  179.     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
  180.     counter_t        **pp_timers;   ///< Array of all timers
  181.     int                i_timers;    ///< Number of timers
  182.     bool               b_stats;     ///< Whether to collect stats
  183.     /* Singleton objects */
  184.     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
  185.     playlist_t        *p_playlist; //< the playlist singleton
  186.     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
  187.     vlc_object_t      *p_dialog_provider; ///< dialog provider
  188.     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
  189. #ifdef ENABLE_SOUT
  190.     sap_handler_t     *p_sap; ///< SAP SDP advertiser
  191. #endif
  192.     vlc_mutex_t        structure_lock;
  193. } libvlc_priv_t;
  194. static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
  195. {
  196.     return (libvlc_priv_t *)libvlc;
  197. }
  198. void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
  199. #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
  200. /**
  201.  * LibVLC "main module" configuration settings array.
  202.  */
  203. extern module_config_t libvlc_config[];
  204. extern const size_t libvlc_config_count;
  205. /*
  206.  * Variables stuff
  207.  */
  208. void var_OptionParse (vlc_object_t *, const char *, bool trusted);
  209. /*
  210.  * Stats stuff
  211.  */
  212. #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
  213. int __stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *);
  214. #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
  215. counter_t * __stats_CounterCreate (vlc_object_t*, int, int);
  216. #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
  217. int __stats_Get (vlc_object_t*, counter_t *, vlc_value_t*);
  218. void stats_CounterClean (counter_t * );
  219. #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
  220. static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
  221.                                       int *value )
  222. {
  223.     int i_ret;
  224.     vlc_value_t val; val.i_int = 0;
  225.     if( !p_counter ) return VLC_EGENERIC;
  226.     i_ret = __stats_Get( p_obj, p_counter, &val );
  227.     *value = val.i_int;
  228.     return i_ret;
  229. }
  230. #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
  231. static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
  232.                                     float *value )
  233. {
  234.     int i_ret;
  235.     vlc_value_t val; val.f_float = 0.0;
  236.     if( !p_counter ) return VLC_EGENERIC;
  237.     i_ret = __stats_Get( p_obj, p_counter, &val );
  238.     *value = val.f_float;
  239.     return i_ret;
  240. }
  241. #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
  242. static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
  243.                                          int i, int *pi_new )
  244. {
  245.     int i_ret;
  246.     vlc_value_t val;
  247.     vlc_value_t new_val; new_val.i_int = 0;
  248.     if( !p_co ) return VLC_EGENERIC;
  249.     val.i_int = i;
  250.     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
  251.     if( pi_new )
  252.         *pi_new = new_val.i_int;
  253.     return i_ret;
  254. }
  255. #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
  256. static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
  257.                                        float f, float *pf_new )
  258. {
  259.     vlc_value_t val;
  260.     int i_ret;
  261.     vlc_value_t new_val;new_val.f_float = 0.0;
  262.     if( !p_co ) return VLC_EGENERIC;
  263.     val.f_float = f;
  264.     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
  265.     if( pf_new )
  266.         *pf_new = new_val.f_float;
  267.     return i_ret;
  268. }
  269. VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
  270. VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
  271. VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
  272. /*
  273.  * Replacement functions
  274.  */
  275. # ifndef HAVE_DIRENT_H
  276. typedef void DIR;
  277. #  ifndef FILENAME_MAX
  278. #      define FILENAME_MAX (260)
  279. #  endif
  280. struct dirent
  281. {
  282.     long            d_ino;          /* Always zero. */
  283.     unsigned short  d_reclen;       /* Always zero. */
  284.     unsigned short  d_namlen;       /* Length of name in d_name. */
  285.     char            d_name[FILENAME_MAX]; /* File name. */
  286. };
  287. #  define opendir vlc_opendir
  288. #  define readdir vlc_readdir
  289. #  define closedir vlc_closedir
  290. #  define rewinddir vlc_rewindir
  291. void *vlc_opendir (const char *);
  292. void *vlc_readdir (void *);
  293. int   vlc_closedir(void *);
  294. void  vlc_rewinddir(void *);
  295. # endif
  296. #if defined (WIN32)
  297. #   include <dirent.h>
  298. void *vlc_wopendir (const wchar_t *);
  299. /* void *vlc_wclosedir (void *); in vlc's exported symbols */
  300. struct _wdirent *vlc_wreaddir (void *);
  301. void vlc_rewinddir (void *);
  302. #   define _wopendir vlc_wopendir
  303. #   define _wreaddir vlc_wreaddir
  304. #   define _wclosedir vlc_wclosedir
  305. #   define rewinddir vlc_rewinddir
  306. #endif
  307. #endif