git.sesse.net Git - vlc/blob - src/control/log.c

   1 /*****************************************************************************
   2  * log.c: libvlc new API log functions
   3  *****************************************************************************
   4  * Copyright (C) 2005 the VideoLAN team
   5  *
   6  * $Id$
   7  *
   8  * Authors: Damien Fouilleul <damienf@videolan.org>
   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
  25 #include "libvlc_internal.h"
  26 #include <vlc/libvlc.h>
  27 #include <assert.h>
  28
  29 /* This API is terminally broken.
  30  * First, it does not implement any kind of notification.
  31  * Second, the iterating scheme is hermetic to any kind of thread-safety
  32  * owing to its constant pointer constraints.
  33  *  -- Courmisch
  34  *
  35  * "If you break your leg, don't run to me for sympathy"
  36  *   -- some character, Beneath a Steel Sky
  37  */
  38
  39 struct msg_cb_data_t
  40 {
  41     vlc_spinlock_t lock;
  42     msg_item_t *items[VLC_MSG_QSIZE];
  43     unsigned    count;
  44     int         verbosity;
  45 };
  46
  47 static void handler( msg_cb_data_t *d, msg_item_t *p_item, unsigned i_drop )
  48 {
  49     if (p_item->i_type > d->verbosity)
  50         return;
  51
  52     vlc_spin_lock (&d->lock);
  53     if (d->count < VLC_MSG_QSIZE)
  54     {
  55         d->items[d->count++] = p_item;
  56         /* FIXME FIXME: yield the message item */
  57     }
  58     vlc_spin_unlock (&d->lock);
  59     (void)i_drop;
  60 }
  61
  62 struct libvlc_log_t
  63 {
  64     libvlc_instance_t  *p_instance;
  65     msg_subscription_t *p_messages;
  66     msg_cb_data_t       data;
  67 };
  68
  69 struct libvlc_log_iterator_t
  70 {
  71     const msg_cb_data_t *p_data;
  72     unsigned i_pos;
  73     unsigned i_end;
  74 };
  75
  76 unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
  77 {
  78     assert( p_instance );
  79     (void)p_e;
  80     return p_instance->verbosity;
  81 }
  82
  83 void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level, libvlc_exception_t *p_e )
  84 {
  85     assert( p_instance );
  86     (void)p_e;
  87     p_instance->verbosity = level;
  88 }
  89
  90 libvlc_log_t *libvlc_log_open( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
  91 {
  92     struct libvlc_log_t *p_log =
  93         (struct libvlc_log_t *)malloc(sizeof(struct libvlc_log_t));
  94
  95     if( !p_log ) RAISENULL( "Out of memory" );
  96
  97     p_log->p_instance = p_instance;
  98     p_log->data.verbosity = p_instance->verbosity;
  99     p_log->p_messages = msg_Subscribe(p_instance->p_libvlc_int, handler, &p_log->data);
 100
 101     if( !p_log->p_messages )
 102     {
 103         free( p_log );
 104         RAISENULL( "Out of memory" );
 105     }
 106
 107     libvlc_retain( p_instance );
 108     return p_log;
 109 }
 110
 111 void libvlc_log_close( libvlc_log_t *p_log, libvlc_exception_t *p_e )
 112 {
 113     if( p_log )
 114     {
 115         assert( p_log->p_messages );
 116         msg_Unsubscribe(p_log->p_messages);
 117         libvlc_release( p_log->p_instance );
 118         free(p_log);
 119     }
 120     else
 121         RAISEVOID("Invalid log object!");
 122 }
 123
 124 unsigned libvlc_log_count( const libvlc_log_t *p_log, libvlc_exception_t *p_e )
 125 {
 126     if( p_log )
 127     {
 128         unsigned ret;
 129
 130         /* We cannot lock due to pointer constraints.
 131          * Even then, this would not be thread safe anyway. */
 132         /*vlc_spin_lock (&p_log->data.lock);*/
 133         ret = p_log->data.count;
 134         /*vlc_spin_unlock (&p_log->data.lock);*/
 135         return ret;
 136     }
 137     RAISEZERO("Invalid log object!");
 138 }
 139
 140 void libvlc_log_clear( libvlc_log_t *p_log, libvlc_exception_t *p_e )
 141 {
 142     if( p_log )
 143     {
 144         /*vlc_spin_lock (&p_log->data.lock);*/
 145         p_log->data.count = 0;
 146         /* FIXME: release items */
 147         /*vlc_spin_unlock (&p_log->data.lock);*/
 148     }
 149     else
 150         RAISEVOID("Invalid log object!");
 151 }
 152
 153 libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *p_log, libvlc_exception_t *p_e )
 154 {
 155     if( p_log )
 156     {
 157         struct libvlc_log_iterator_t *p_iter =
 158             (struct libvlc_log_iterator_t *)malloc(sizeof(struct libvlc_log_iterator_t));
 159
 160         if( !p_iter ) RAISENULL( "Out of memory" );
 161
 162         /*vlc_spin_lock (&p_log->data.lock);*/
 163         p_iter->p_data  = &p_log->data;
 164         p_iter->i_pos   = 0;
 165         p_iter->i_end   = p_log->data.count;
 166         /*vlc_spin_unlock (&p_log->data.lock);*/
 167
 168         return p_iter;
 169     }
 170     RAISENULL("Invalid log object!");
 171 }
 172
 173 void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e )
 174 {
 175     if( p_iter )
 176     {
 177         free(p_iter);
 178     }
 179     else
 180         RAISEVOID("Invalid log iterator!");
 181 }
 182
 183 int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e )
 184 {
 185     if( p_iter )
 186     {
 187         return p_iter->i_pos != p_iter->i_end;
 188     }
 189     RAISEZERO("Invalid log iterator!");
 190 }
 191
 192 libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
 193                                                 libvlc_log_message_t *buffer,
 194                                                 libvlc_exception_t *p_e )
 195 {
 196     unsigned i_pos;
 197
 198     if( !p_iter )
 199         RAISENULL("Invalid log iterator!");
 200     if( !buffer )
 201         RAISENULL("Invalid message buffer!");
 202
 203     i_pos = p_iter->i_pos;
 204     if( i_pos != p_iter->i_end )
 205     {
 206         msg_item_t *msg;
 207         /*vlc_spin_lock (&p_iter->p_data->lock);*/
 208         msg = p_iter->p_data->items[i_pos];
 209         buffer->i_severity  = msg->i_type;
 210         buffer->psz_type    = msg->psz_object_type;
 211         buffer->psz_name    = msg->psz_module;
 212         buffer->psz_header  = msg->psz_header;
 213         buffer->psz_message = msg->psz_msg;
 214         /*vlc_spin_unlock (&p_iter->p_data->lock);*/
 215         p_iter->i_pos++;
 216
 217         return buffer;
 218     }
 219     RAISENULL("No more messages");
 220 }