playlist: Properly clean the playlist using the object destructor.
[vlc.git] / src / playlist / thread.c
1 /*****************************************************************************
2  * thread.c : Playlist management functions
3  *****************************************************************************
4  * Copyright © 1999-2008 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 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <vlc/vlc.h>
29 #include <vlc_es.h>
30 #include <vlc_input.h>
31 #include <vlc_interface.h>
32 #include <vlc_playlist.h>
33 #include "playlist_internal.h"
34
35 /*****************************************************************************
36  * Local prototypes
37  *****************************************************************************/
38 static void RunControlThread ( playlist_t * );
39 static void RunPreparse( playlist_preparse_t * );
40 static void RunFetcher( playlist_fetcher_t * );
41 static void PreparseDestructor( vlc_object_t * );
42 static void FetcherDestructor( vlc_object_t * );
43
44 /*****************************************************************************
45  * Main functions for the global thread
46  *****************************************************************************/
47
48 /**
49  * Create the main playlist thread
50  * Additionally to the playlist, this thread controls :
51  *    - Statistics
52  *    - VLM
53  * \param p_parent
54  * \return an object with a started thread
55  */
56 void __playlist_ThreadCreate( vlc_object_t *p_parent )
57 {
58     playlist_t *p_playlist = playlist_Create( p_parent );
59     if( !p_playlist ) return;
60
61     // Stats
62     p_playlist->p_stats = (global_stats_t *)malloc( sizeof( global_stats_t ) );
63     if( !p_playlist->p_stats )
64     {
65         vlc_object_release( p_playlist );
66         return;
67     }
68     vlc_mutex_init( p_playlist, &p_playlist->p_stats->lock );
69     p_playlist->p_stats_computer = NULL;
70
71     // Preparse
72     p_playlist->p_preparse = vlc_object_create( p_playlist,
73                                   sizeof( playlist_preparse_t ) );
74     p_playlist->p_preparse->psz_object_name = "preparser";
75     if( !p_playlist->p_preparse )
76     {
77         msg_Err( p_playlist, "unable to create preparser" );
78         vlc_object_release( p_playlist );
79         return;
80     }
81     p_playlist->p_preparse->i_waiting = 0;
82     p_playlist->p_preparse->pp_waiting = NULL;
83
84     vlc_object_set_destructor( p_playlist->p_preparse, PreparseDestructor );
85
86     vlc_object_attach( p_playlist->p_preparse, p_playlist );
87     if( vlc_thread_create( p_playlist->p_preparse, "preparser",
88                            RunPreparse, VLC_THREAD_PRIORITY_LOW, VLC_TRUE ) )
89     {
90         msg_Err( p_playlist, "cannot spawn preparse thread" );
91         vlc_object_release( p_playlist->p_preparse );
92         return;
93     }
94
95     // Secondary Preparse
96     p_playlist->p_fetcher = vlc_object_create( p_playlist,
97                               sizeof( playlist_fetcher_t ) );
98     p_playlist->p_fetcher->psz_object_name = "fetcher";
99     if( !p_playlist->p_fetcher )
100     {
101         msg_Err( p_playlist, "unable to create secondary preparser" );
102         vlc_object_release( p_playlist );
103         return;
104     }
105     p_playlist->p_fetcher->i_waiting = 0;
106     p_playlist->p_fetcher->p_waiting = NULL;
107     p_playlist->p_fetcher->b_fetch_meta = var_CreateGetInteger( p_playlist,
108                                                                  "fetch-meta" );
109     p_playlist->p_fetcher->i_art_policy = var_CreateGetInteger( p_playlist,
110                                                                 "album-art" );
111
112     vlc_object_set_destructor( p_playlist->p_fetcher, FetcherDestructor );
113
114     vlc_object_attach( p_playlist->p_fetcher, p_playlist );
115     if( vlc_thread_create( p_playlist->p_fetcher,
116                            "fetcher",
117                            RunFetcher,
118                            VLC_THREAD_PRIORITY_LOW, VLC_TRUE ) )
119     {
120         msg_Err( p_playlist, "cannot spawn secondary preparse thread" );
121         vlc_object_release( p_playlist->p_fetcher );
122         return;
123     }
124
125     // Start the thread
126     if( vlc_thread_create( p_playlist, "playlist", RunControlThread,
127                            VLC_THREAD_PRIORITY_LOW, VLC_TRUE ) )
128     {
129         msg_Err( p_playlist, "cannot spawn playlist thread" );
130         vlc_object_release( p_playlist );
131         return;
132     }
133
134     /* The object has been initialized, now attach it */
135     vlc_object_attach( p_playlist, p_parent );
136
137     return;
138 }
139
140 /**
141  * Destroy the playlist global thread.
142  *
143  * Deinits all things controlled by the playlist global thread
144  * \param p_playlist the playlist thread to destroy
145  * \return VLC_SUCCESS or an error
146  */
147 int playlist_ThreadDestroy( playlist_t * p_playlist )
148 {
149     playlist_Destroy( p_playlist );
150     return VLC_SUCCESS;
151 }
152
153 /**
154  * Run the main control thread itself
155  */
156 static void RunControlThread ( playlist_t *p_playlist )
157 {
158     int i_loops = 0;
159
160     /* Tell above that we're ready */
161     vlc_thread_ready( p_playlist );
162     while( !p_playlist->b_die )
163     {
164         i_loops++;
165
166         playlist_MainLoop( p_playlist );
167         if( p_playlist->b_cant_sleep )
168         {
169             /* 100 ms is an acceptable delay for playlist operations */
170             msleep( INTF_IDLE_SLEEP*2 );
171         }
172         else
173         {
174             PL_LOCK;
175             vlc_cond_wait( &p_playlist->object_wait, &p_playlist->object_lock );
176             PL_UNLOCK;
177         }
178     }
179     playlist_LastLoop( p_playlist );
180 }
181
182 /*****************************************************************************
183  * Preparse-specific functions
184  *****************************************************************************/
185 static void RunPreparse ( playlist_preparse_t *p_obj )
186 {
187     /* Tell above that we're ready */
188     vlc_thread_ready( p_obj );
189     playlist_PreparseLoop( p_obj );
190 }
191
192 static void RunFetcher( playlist_fetcher_t *p_obj )
193 {
194     /* Tell above that we're ready */
195     vlc_thread_ready( p_obj );
196     playlist_FetcherLoop( p_obj );
197 }
198
199 static void PreparseDestructor( vlc_object_t * p_this )
200 {
201     playlist_preparse_t * p_preparse = (playlist_preparse_t *)p_this;
202     free( p_preparse->pp_waiting );
203 }
204
205 static void FetcherDestructor( vlc_object_t * p_this )
206 {
207     playlist_fetcher_t * p_fetcher = (playlist_fetcher_t *)p_this;
208     free( p_fetcher->p_waiting );
209 }