Cleanup control and parser threads handling. Might fix #917
[vlc.git] / src / playlist / thread.c
1 /*****************************************************************************
2  * playlist.c : Playlist management functions
3  *****************************************************************************
4  * Copyright (C) 1999-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *          ClĂ©ment Stenac <zorglub@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 #include <vlc/vlc.h>
25 #include <vlc_es.h>
26 #include <vlc_input.h>
27 #include <vlc_interface.h>
28 #include <vlc_playlist.h>
29 #include "playlist_internal.h"
30 #include "interface/interface.h"
31
32 /*****************************************************************************
33  * Local prototypes
34  *****************************************************************************/
35 static void RunControlThread ( playlist_t * );
36 static void RunPreparse( playlist_preparse_t * );
37 static void RunFetcher( playlist_fetcher_t * );
38
39 static void DestroyInteraction( playlist_t * );
40
41 /*****************************************************************************
42  * Main functions for the global thread
43  *****************************************************************************/
44
45 /**
46  * Create the main playlist thread
47  * Additionally to the playlist, this thread controls :
48  *    - Interaction
49  *    - Statistics
50  *    - VLM
51  * \param p_parent
52  * \return an object with a started thread
53  */
54 void __playlist_ThreadCreate( vlc_object_t *p_parent )
55 {
56     playlist_t *p_playlist = playlist_Create( p_parent );
57     if( !p_playlist ) return;
58
59     // Stats
60     p_playlist->p_stats = (global_stats_t *)malloc( sizeof( global_stats_t ) );
61     vlc_mutex_init( p_playlist, &p_playlist->p_stats->lock );
62     p_playlist->p_stats_computer = NULL;
63
64     // Interaction
65     p_playlist->p_interaction = NULL;
66
67     // Preparse
68     p_playlist->p_preparse = vlc_object_create( p_playlist,
69                                   sizeof( playlist_preparse_t ) );
70     if( !p_playlist->p_preparse )
71     {
72         msg_Err( p_playlist, "unable to create preparser" );
73         vlc_object_destroy( p_playlist );
74         return;
75     }
76     p_playlist->p_preparse->i_waiting = 0;
77     p_playlist->p_preparse->pp_waiting = NULL;
78
79     vlc_object_attach( p_playlist->p_preparse, p_playlist );
80     if( vlc_thread_create( p_playlist->p_preparse, "preparser",
81                            RunPreparse, VLC_THREAD_PRIORITY_LOW, VLC_TRUE ) )
82     {
83         msg_Err( p_playlist, "cannot spawn preparse thread" );
84         vlc_object_detach( p_playlist->p_preparse );
85         vlc_object_destroy( p_playlist->p_preparse );
86         return;
87     }
88
89     // Secondary Preparse
90     p_playlist->p_fetcher = vlc_object_create( p_playlist,
91                               sizeof( playlist_fetcher_t ) );
92     if( !p_playlist->p_fetcher )
93     {
94         msg_Err( p_playlist, "unable to create secondary preparser" );
95         vlc_object_destroy( p_playlist );
96         return;
97     }
98     p_playlist->p_fetcher->i_waiting = 0;
99     p_playlist->p_fetcher->p_waiting = NULL;
100     p_playlist->p_fetcher->i_art_policy = var_CreateGetInteger( p_playlist,
101                                                                 "album-art" );
102
103     vlc_object_attach( p_playlist->p_fetcher, p_playlist );
104     if( vlc_thread_create( p_playlist->p_fetcher,
105                            "fetcher",
106                            RunFetcher,
107                            VLC_THREAD_PRIORITY_LOW, VLC_TRUE ) )
108     {
109         msg_Err( p_playlist, "cannot spawn secondary preparse thread" );
110         vlc_object_detach( p_playlist->p_fetcher );
111         vlc_object_destroy( p_playlist->p_fetcher );
112         return;
113     }
114
115     // Start the thread
116     if( vlc_thread_create( p_playlist, "playlist", RunControlThread,
117                            VLC_THREAD_PRIORITY_LOW, VLC_TRUE ) )
118     {
119         msg_Err( p_playlist, "cannot spawn playlist thread" );
120         vlc_object_destroy( p_playlist );
121         return;
122     }
123
124     /* The object has been initialized, now attach it */
125     vlc_object_attach( p_playlist, p_parent );
126
127     return;
128 }
129
130 /**
131  * Destroy the playlist global thread.
132  *
133  * Deinits all things controlled by the playlist global thread
134  * \param p_playlist the playlist thread to destroy
135  * \return VLC_SUCCESS or an error
136  */
137 int playlist_ThreadDestroy( playlist_t * p_playlist )
138 {
139     // Tell playlist to go to last loop
140     p_playlist->b_die = VLC_TRUE;
141     playlist_Signal( p_playlist );
142
143     // Kill preparser
144     if( p_playlist->p_preparse )
145     {
146         vlc_cond_signal( &p_playlist->p_preparse->object_wait );
147         free( p_playlist->p_preparse->pp_waiting );
148     }
149     vlc_thread_join( p_playlist->p_preparse );
150     vlc_object_detach( p_playlist->p_preparse );
151     vlc_object_destroy( p_playlist->p_preparse );
152
153     // Kill meta fetcher
154     if( p_playlist->p_fetcher )
155     {
156         vlc_cond_signal( &p_playlist->p_fetcher->object_wait );
157         free( p_playlist->p_fetcher->p_waiting );
158     }
159     vlc_thread_join( p_playlist->p_fetcher );
160     vlc_object_detach( p_playlist->p_fetcher );
161     vlc_object_destroy( p_playlist->p_fetcher );
162
163     // Wait for thread to complete
164     vlc_thread_join( p_playlist );
165
166     // Stats
167     vlc_mutex_destroy( &p_playlist->p_stats->lock );
168     if( p_playlist->p_stats )
169         free( p_playlist->p_stats );
170
171     DestroyInteraction( p_playlist );
172
173     playlist_Destroy( p_playlist );
174
175     return VLC_SUCCESS;
176 }
177
178 /**
179  * Run the main control thread itself
180  */
181 static void RunControlThread ( playlist_t *p_playlist )
182 {
183    int i_loops = 0;
184
185    /* Tell above that we're ready */
186    vlc_thread_ready( p_playlist );
187
188     while( !p_playlist->b_die )
189     {
190         i_loops++;
191
192         if( p_playlist->p_interaction )
193             intf_InteractionManage( p_playlist );
194
195         playlist_MainLoop( p_playlist );
196         if( p_playlist->b_cant_sleep )
197         {
198             /* 100 ms is an acceptable delay for playlist operations */
199             msleep( INTF_IDLE_SLEEP*2 );
200         }
201         else
202         {
203             PL_LOCK;
204             vlc_cond_wait( &p_playlist->object_wait, &p_playlist->object_lock );
205             PL_UNLOCK;
206         }
207     }
208
209     playlist_LastLoop( p_playlist );
210 }
211
212 /*****************************************************************************
213  * Preparse-specific functions
214  *****************************************************************************/
215 static void RunPreparse ( playlist_preparse_t *p_obj )
216 {
217     /* Tell above that we're ready */
218     vlc_thread_ready( p_obj );
219     playlist_PreparseLoop( p_obj );
220 }
221
222 static void RunFetcher( playlist_fetcher_t *p_obj )
223 {
224     /* Tell above that we're ready */
225     vlc_thread_ready( p_obj );
226     playlist_FetcherLoop( p_obj );
227 }
228
229 /*****************************************************************************
230  * Interaction functions
231  *****************************************************************************/
232 static void DestroyInteraction( playlist_t *p_playlist )
233 {
234     if( p_playlist->p_interaction )
235     {
236         intf_InteractionDestroy( p_playlist->p_interaction );
237         p_playlist->p_interaction = NULL;
238     }
239 }