home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 May / maximum-cd-2009-05.iso / DiscContents / vlc-0.9.8a-win32.exe / sdk / include / vlc / plugins / vlc_messages.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-06  |  9.8 KB  |  325 lines
  1. /*****************************************************************************
  2.  * messages.h: messages interface
  3.  * This library provides basic functions for threads to interact with user
  4.  * interface, such as message output.
  5.  *****************************************************************************
  6.  * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
  7.  * $Id: c0b8ee5e178ee6bd185bb20f83e0c3da4ea03316 $
  8.  *
  9.  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  10.  *          Samuel Hocevar <sam@zoy.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. #ifndef VLC_MESSAGES_H_
  28. #define VLC_MESSAGES_H_
  29.  
  30. /**
  31.  * \file
  32.  * This file defines structures and functions to handle messages and statistics gathering
  33.  */
  34.  
  35. #include <stdarg.h>
  36.  
  37. /**
  38.  * \defgroup messages Messages
  39.  * This library provides basic functions for threads to interact with user
  40.  * interface, such as message output.
  41.  *
  42.  * @{
  43.  */
  44.  
  45. /**
  46.  * Store a single message sent to user.
  47.  */
  48. typedef struct
  49. {
  50.     int     i_type;                             /**< message type, see below */
  51.     int     i_object_id;
  52.     const char *psz_object_type;
  53.     char *  psz_module;
  54.     char *  psz_msg;                            /**< the message itself */
  55.     char *  psz_header;                         /**< Additional header */
  56.  
  57.     mtime_t date;                               /**< Message date */
  58. } msg_item_t;
  59.  
  60. /* Message types */
  61. /** standard messages */
  62. #define VLC_MSG_INFO  0
  63. /** error messages */
  64. #define VLC_MSG_ERR   1
  65. /** warning messages */
  66. #define VLC_MSG_WARN  2
  67. /** debug messages */
  68. #define VLC_MSG_DBG   3
  69.  
  70. /**
  71.  * Used by interface plugins which subscribe to the message bank.
  72.  */
  73. struct msg_subscription_t
  74. {
  75.     int   i_start;
  76.     int*  pi_stop;
  77.  
  78.     msg_item_t*  p_msg;
  79.     vlc_mutex_t* p_lock;
  80. };
  81.  
  82. /*****************************************************************************
  83.  * Prototypes
  84.  *****************************************************************************/
  85. VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) LIBVLC_FORMAT( 4, 5 ) );
  86. VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, const char *, const char *, va_list args ) );
  87. #define msg_GenericVa(a, b, c, d, e) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e)
  88. VLC_EXPORT( void, __msg_Info,    ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
  89. VLC_EXPORT( void, __msg_Err,     ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
  90. VLC_EXPORT( void, __msg_Warn,    ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
  91. VLC_EXPORT( void, __msg_Dbg,    ( vlc_object_t *, const char *, ... ) LIBVLC_FORMAT( 2, 3 ) );
  92.  
  93. #define msg_Info( p_this, ... ) \
  94.       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
  95.                      MODULE_STRING, __VA_ARGS__ )
  96. #define msg_Err( p_this, ... ) \
  97.       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
  98.                      MODULE_STRING, __VA_ARGS__ )
  99. #define msg_Warn( p_this, ... ) \
  100.       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
  101.                      MODULE_STRING, __VA_ARGS__ )
  102. #define msg_Dbg( p_this, ... ) \
  103.       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
  104.                      MODULE_STRING, __VA_ARGS__ )
  105.  
  106. #define msg_Subscribe(a) __msg_Subscribe(VLC_OBJECT(a))
  107. #define msg_Unsubscribe(a,b) __msg_Unsubscribe(VLC_OBJECT(a),b)
  108. VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t * ) );
  109. VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );
  110.  
  111. /**
  112.  * @}
  113.  */
  114.  
  115. /**
  116.  * \defgroup statistics Statistics
  117.  *
  118.  * @{
  119.  */
  120.  
  121. /****************************
  122.  * Generic stats stuff
  123.  ****************************/
  124. enum
  125. {
  126.     STATS_LAST,
  127.     STATS_COUNTER,
  128.     STATS_MAX,
  129.     STATS_MIN,
  130.     STATS_DERIVATIVE,
  131.     STATS_TIMER
  132. };
  133.  
  134. struct counter_sample_t
  135. {
  136.     vlc_value_t value;
  137.     mtime_t     date;
  138. };
  139.  
  140. struct counter_t
  141. {
  142.     unsigned int        i_id;
  143.     char              * psz_name;
  144.     int                 i_type;
  145.     void              * p_obj;
  146.     int                 i_compute_type;
  147.     int                 i_samples;
  148.     counter_sample_t ** pp_samples;
  149.  
  150.     mtime_t             update_interval;
  151.     mtime_t             last_update;
  152. };
  153.  
  154. enum
  155. {
  156.     STATS_INPUT_BITRATE,
  157.     STATS_READ_BYTES,
  158.     STATS_READ_PACKETS,
  159.     STATS_DEMUX_READ,
  160.     STATS_DEMUX_BITRATE,
  161.     STATS_PLAYED_ABUFFERS,
  162.     STATS_LOST_ABUFFERS,
  163.     STATS_DECODED_AUDIO,
  164.     STATS_DECODED_VIDEO,
  165.     STATS_DECODED_SUB,
  166.     STATS_CLIENT_CONNECTIONS,
  167.     STATS_ACTIVE_CONNECTIONS,
  168.     STATS_SOUT_SENT_PACKETS,
  169.     STATS_SOUT_SENT_BYTES,
  170.     STATS_SOUT_SEND_BITRATE,
  171.     STATS_DISPLAYED_PICTURES,
  172.     STATS_LOST_PICTURES,
  173.  
  174.     STATS_TIMER_PLAYLIST_BUILD,
  175.     STATS_TIMER_ML_LOAD,
  176.     STATS_TIMER_ML_DUMP,
  177.     STATS_TIMER_INTERACTION,
  178.     STATS_TIMER_PREPARSE,
  179.     STATS_TIMER_INPUT_LAUNCHING,
  180.     STATS_TIMER_MODULE_NEED,
  181.     STATS_TIMER_VIDEO_FRAME_ENCODING,
  182.     STATS_TIMER_AUDIO_FRAME_ENCODING,
  183.  
  184.     STATS_TIMER_SKINS_PLAYTREE_IMAGE,
  185. };
  186.  
  187. #define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c )
  188. VLC_EXPORT( int, __stats_Update, (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *) );
  189. #define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c )
  190. VLC_EXPORT( counter_t *, __stats_CounterCreate, (vlc_object_t*, int, int) );
  191. #define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c)
  192. VLC_EXPORT( int, __stats_Get, (vlc_object_t*, counter_t *, vlc_value_t*) );
  193.  
  194. VLC_EXPORT (void, stats_CounterClean, (counter_t * ) );
  195.  
  196. #define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c )
  197. static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
  198.                                       int *value )
  199. {
  200.     int i_ret;
  201.     vlc_value_t val; val.i_int = 0;
  202.     if( !p_counter ) return VLC_EGENERIC;
  203.     i_ret = __stats_Get( p_obj, p_counter, &val );
  204.     *value = val.i_int;
  205.     return i_ret;
  206. }
  207.  
  208. #define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c )
  209. static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
  210.                                     float *value )
  211. {
  212.     int i_ret;
  213.     vlc_value_t val; val.f_float = 0.0;
  214.     if( !p_counter ) return VLC_EGENERIC;
  215.     i_ret = __stats_Get( p_obj, p_counter, &val );
  216.     *value = val.f_float;
  217.     return i_ret;
  218. }
  219. #define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d )
  220. static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
  221.                                          int i, int *pi_new )
  222. {
  223.     int i_ret;
  224.     vlc_value_t val;
  225.     vlc_value_t new_val; new_val.i_int = 0;
  226.     if( !p_co ) return VLC_EGENERIC;
  227.     val.i_int = i;
  228.     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
  229.     if( pi_new )
  230.         *pi_new = new_val.i_int;
  231.     return i_ret;
  232. }
  233. #define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d )
  234. static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
  235.                                        float f, float *pf_new )
  236. {
  237.     vlc_value_t val;
  238.     int i_ret;
  239.     vlc_value_t new_val;new_val.f_float = 0.0;
  240.     if( !p_co ) return VLC_EGENERIC;
  241.     val.f_float = f;
  242.     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
  243.     if( pf_new )
  244.         *pf_new = new_val.f_float;
  245.     return i_ret;
  246. }
  247.  
  248. /******************
  249.  * Input stats
  250.  ******************/
  251. struct input_stats_t
  252. {
  253.     vlc_mutex_t         lock;
  254.  
  255.     /* Input */
  256.     int i_read_packets;
  257.     int i_read_bytes;
  258.     float f_input_bitrate;
  259.     float f_average_input_bitrate;
  260.  
  261.     /* Demux */
  262.     int i_demux_read_packets;
  263.     int i_demux_read_bytes;
  264.     float f_demux_bitrate;
  265.     float f_average_demux_bitrate;
  266.  
  267.     /* Decoders */
  268.     int i_decoded_audio;
  269.     int i_decoded_video;
  270.  
  271.     /* Vout */
  272.     int i_displayed_pictures;
  273.     int i_lost_pictures;
  274.  
  275.     /* Sout */
  276.     int i_sent_packets;
  277.     int i_sent_bytes;
  278.     float f_send_bitrate;
  279.  
  280.     /* Aout */
  281.     int i_played_abuffers;
  282.     int i_lost_abuffers;
  283. };
  284.  
  285. VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) );
  286. VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) );
  287. VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) );
  288.  
  289. /********************
  290.  * Global stats
  291.  *******************/
  292. struct global_stats_t
  293. {
  294.     vlc_mutex_t lock;
  295.  
  296.     float f_input_bitrate;
  297.     float f_demux_bitrate;
  298.     float f_output_bitrate;
  299.  
  300.     int i_http_clients;
  301. };
  302.  
  303. #define stats_ComputeGlobalStats(a,b) __stats_ComputeGlobalStats( VLC_OBJECT(a),b)
  304. VLC_EXPORT( void, __stats_ComputeGlobalStats, (vlc_object_t*,global_stats_t*));
  305.  
  306.  
  307. /*********
  308.  * Timing
  309.  ********/
  310. #define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
  311. #define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b )
  312. #define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b )
  313. #define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) )
  314. VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) );
  315. VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, unsigned int) );
  316. VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) );
  317. VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
  318. #define stats_TimersCleanAll(a) __stats_TimersCleanAll( VLC_OBJECT(a) )
  319. VLC_EXPORT( void, __stats_TimersCleanAll, (vlc_object_t * ) );
  320.  
  321. #define stats_TimerClean(a,b) __stats_TimerClean( VLC_OBJECT(a), b )
  322. VLC_EXPORT( void, __stats_TimerClean, (vlc_object_t *, unsigned int ) );
  323.  
  324. #endif
  325.