a45bf7255a0f931bd53eb1eece2ed334162825c9
[vlc.git] / 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         msg_Hold (p_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     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 )
77 {
78     assert( p_instance );
79     return p_instance->verbosity;
80 }
81
82 void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level )
83 {
84     assert( p_instance );
85     p_instance->verbosity = level;
86 }
87
88 libvlc_log_t *libvlc_log_open( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
89 {
90     struct libvlc_log_t *p_log =
91         (struct libvlc_log_t *)malloc(sizeof(struct libvlc_log_t));
92
93     if( !p_log ) RAISENULL( "Out of memory" );
94
95     p_log->p_instance = p_instance;
96     vlc_spin_init( &p_log->data.lock );
97     p_log->data.count = 0;
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 )
112 {
113     if( !p_log )
114         return;
115
116     assert( p_log->p_messages );
117     msg_Unsubscribe(p_log->p_messages);
118     libvlc_release( p_log->p_instance );
119     libvlc_log_clear( p_log );
120     vlc_spin_destroy( &p_log->data.lock );
121     free(p_log);
122 }
123
124 unsigned libvlc_log_count( const libvlc_log_t *p_log )
125 {
126     if( !p_log )
127         return 0;
128
129     msg_cb_data_t *data = &((libvlc_log_t *)p_log)->data;
130     unsigned ret;
131
132     /* We cannot lock due to constant pointer constraints. Break them.
133      * Even then, this si not really thread safe anyway. */
134     vlc_spin_lock (&data->lock);
135     ret = data->count;
136     vlc_spin_unlock (&data->lock);
137     return ret;
138 }
139
140 void libvlc_log_clear( libvlc_log_t *p_log )
141 {
142     if( !p_log )
143         return;
144
145     vlc_spin_lock (&p_log->data.lock);
146     msg_item_t *tab[p_log->data.count];
147     memcpy (tab, p_log->data.items, sizeof (tab));
148     p_log->data.count = 0;
149     vlc_spin_unlock (&p_log->data.lock);
150
151     for (unsigned i = 0; i < sizeof (tab) / sizeof (tab[0]); i++)
152          msg_Release (tab[i]);
153 }
154
155 libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *p_log,
156  libvlc_exception_t *p_e )
157 {
158     if( p_log )
159     {
160         struct libvlc_log_iterator_t *p_iter =
161             (struct libvlc_log_iterator_t *)malloc(sizeof(struct libvlc_log_iterator_t));
162         /* FIXME: break constant pointer constraints */
163         msg_cb_data_t *data = &((libvlc_log_t *)p_log)->data;
164
165         if( !p_iter ) RAISENULL( "Out of memory" );
166
167         vlc_spin_lock (&data->lock);
168         p_iter->p_data  = data;
169         p_iter->i_pos   = 0;
170         p_iter->i_end   = data->count;
171         vlc_spin_unlock (&data->lock);
172
173         return p_iter;
174     }
175     RAISENULL("Invalid log object!");
176 }
177
178 void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter )
179 {
180     free( p_iter );
181 }
182
183 int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter )
184 {
185     if( !p_iter )
186         return 0;
187     return p_iter->i_pos != p_iter->i_end;
188 }
189
190 libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
191                                                 libvlc_log_message_t *buffer,
192                                                 libvlc_exception_t *p_e )
193 {
194     unsigned i_pos;
195
196     if( !p_iter )
197         return NULL;
198     assert( buffer );
199
200     i_pos = p_iter->i_pos;
201     if( i_pos != p_iter->i_end )
202     {
203         msg_item_t *msg;
204         vlc_spin_lock (&p_iter->p_data->lock);
205         msg = p_iter->p_data->items[i_pos];
206         buffer->i_severity  = msg->i_type;
207         buffer->psz_type    = msg->psz_object_type;
208         buffer->psz_name    = msg->psz_module;
209         buffer->psz_header  = msg->psz_header;
210         buffer->psz_message = msg->psz_msg;
211         vlc_spin_unlock (&p_iter->p_data->lock);
212         p_iter->i_pos++;
213
214         return buffer;
215     }
216     RAISENULL("No more messages");
217 }