engine.c 10.1 KB
Newer Older
1 2 3
/*****************************************************************************
 * engine.c : Run the playlist and handle its control
 *****************************************************************************
4
 * Copyright (C) 1999-2008 the VideoLAN team
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
 *          Clément Stenac <zorglub@videolan.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/
23

24 25 26 27
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

28
#include <stddef.h>
29
#include <assert.h>
30
#include <vlc_common.h>
zorglub's avatar
zorglub committed
31 32 33
#include <vlc_sout.h>
#include <vlc_playlist.h>
#include <vlc_interface.h>
34
#include "playlist_internal.h"
zorglub's avatar
zorglub committed
35
#include "stream_output/stream_output.h" /* sout_DeleteInstance */
36 37 38 39 40

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
static void VariablesInit( playlist_t *p_playlist );
41
static void playlist_Destructor( vlc_object_t * p_this );
42

zorglub's avatar
zorglub committed
43 44 45
static int RandomCallback( vlc_object_t *p_this, char const *psz_cmd,
                           vlc_value_t oldval, vlc_value_t newval, void *a )
{
46
    (void)psz_cmd; (void)oldval; (void)newval; (void)a;
47
    playlist_t *p_playlist = (playlist_t*)p_this;
48

49 50 51
    PL_LOCK;

    pl_priv(p_playlist)->b_reset_currently_playing = true;
52
    vlc_cond_signal( &pl_priv(p_playlist)->signal );
53 54

    PL_UNLOCK;
zorglub's avatar
zorglub committed
55 56 57
    return VLC_SUCCESS;
}

58 59 60 61 62 63 64 65 66
/**
 * Create playlist
 *
 * Create a playlist structure.
 * \param p_parent the vlc object that is to be the parent of this playlist
 * \return a pointer to the created playlist, or NULL on error
 */
playlist_t * playlist_Create( vlc_object_t *p_parent )
{
67
    static const char playlist_name[] = "playlist";
68
    playlist_t *p_playlist;
69
    playlist_private_t *p;
70 71

    /* Allocate structure */
72 73 74
    p = vlc_custom_create( p_parent, sizeof( *p ),
                           VLC_OBJECT_GENERIC, playlist_name );
    if( !p )
75
        return NULL;
76

77 78
    assert( offsetof( playlist_private_t, public_data ) == 0 );
    p_playlist = &p->public_data;
79
    TAB_INIT( pl_priv(p_playlist)->i_sds, pl_priv(p_playlist)->pp_sds );
80

81
    libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
82 83

    VariablesInit( p_playlist );
84
    vlc_mutex_init( &p->lock );
85
    vlc_cond_init( &p->signal );
86 87

    /* Initialise data structures */
88
    pl_priv(p_playlist)->i_last_playlist_id = 0;
89
    pl_priv(p_playlist)->p_input = NULL;
90

zorglub's avatar
zorglub committed
91 92
    ARRAY_INIT( p_playlist->items );
    ARRAY_INIT( p_playlist->all_items );
93
    ARRAY_INIT( pl_priv(p_playlist)->items_to_delete );
zorglub's avatar
zorglub committed
94
    ARRAY_INIT( p_playlist->current );
95

zorglub's avatar
zorglub committed
96
    p_playlist->i_current_index = 0;
97
    pl_priv(p_playlist)->b_reset_currently_playing = true;
98
    pl_priv(p_playlist)->last_rebuild_date = 0;
zorglub's avatar
zorglub committed
99

100
    pl_priv(p_playlist)->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
101

102
    pl_priv(p_playlist)->b_doing_ml = false;
103

104 105
    const bool b_auto_preparse = var_CreateGetBool( p_playlist, "auto-preparse" );
    pl_priv(p_playlist)->b_auto_preparse = b_auto_preparse;
106

107
    PL_LOCK; /* playlist_NodeCreate will check for it */
108
    p_playlist->p_root_category = playlist_NodeCreate( p_playlist, NULL, NULL,
109
                                    0, NULL );
110
    p_playlist->p_root_onelevel = playlist_NodeCreate( p_playlist, NULL, NULL,
111
                                    0, p_playlist->p_root_category->p_input );
112
    PL_UNLOCK;
113

114 115 116
    if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
        return NULL;

117
    /* Create playlist and media library */
118
    PL_LOCK; /* playlist_NodesPairCreate will check for it */
119 120
    playlist_NodesPairCreate( p_playlist, _( "Playlist" ),
                            &p_playlist->p_local_category,
121
                            &p_playlist->p_local_onelevel, false );
122
    PL_UNLOCK;
123

124 125 126
    p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
    p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;

127 128 129 130 131
    if( !p_playlist->p_local_category || !p_playlist->p_local_onelevel ||
        !p_playlist->p_local_category->p_input ||
        !p_playlist->p_local_onelevel->p_input )
        return NULL;

132 133
    if( config_GetInt( p_playlist, "media-library") )
    {
134
        PL_LOCK; /* playlist_NodesPairCreate will check for it */
135 136
        playlist_NodesPairCreate( p_playlist, _( "Media Library" ),
                            &p_playlist->p_ml_category,
137
                            &p_playlist->p_ml_onelevel, false );
138
        PL_UNLOCK;
139 140 141 142

        if(!p_playlist->p_ml_category || !p_playlist->p_ml_onelevel)
            return NULL;

143 144 145 146 147 148 149
        p_playlist->p_ml_category->i_flags |= PLAYLIST_RO_FLAG;
        p_playlist->p_ml_onelevel->i_flags |= PLAYLIST_RO_FLAG;
    }
    else
    {
        p_playlist->p_ml_category = p_playlist->p_ml_onelevel = NULL;
    }
150 151

    /* Initial status */
152 153 154 155
    pl_priv(p_playlist)->status.p_item = NULL;
    pl_priv(p_playlist)->status.p_node = p_playlist->p_local_onelevel;
    pl_priv(p_playlist)->request.b_request = false;
    pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
156

157
    pl_priv(p_playlist)->b_auto_preparse = false;
158
    playlist_MLLoad( p_playlist );
159
    pl_priv(p_playlist)->b_auto_preparse = b_auto_preparse;
160

161 162
    vlc_object_set_destructor( p_playlist, playlist_Destructor );

163 164 165
    return p_playlist;
}

ivoire's avatar
ivoire committed
166 167 168 169 170 171 172
/**
 * Destroy playlist
 *
 * Destroy a playlist structure.
 * \param p_playlist the playlist object
 * \return nothing
 */
173 174 175

static void playlist_Destructor( vlc_object_t * p_this )
{
176 177
    playlist_t *p_playlist = (playlist_t *)p_this;
    playlist_private_t *p_sys = pl_priv(p_playlist);
178

Laurent Aimar's avatar
Laurent Aimar committed
179
    assert( !p_sys->p_input );
180
    assert( !p_sys->p_input_resource );
181 182
    assert( !p_sys->p_preparser );
    assert( !p_sys->p_fetcher );
183

184
    vlc_cond_destroy( &p_sys->signal );
185
    vlc_mutex_destroy( &p_sys->lock );
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203

    /* Remove all remaining items */
    FOREACH_ARRAY( playlist_item_t *p_del, p_playlist->all_items )
        free( p_del->pp_children );
        vlc_gc_decref( p_del->p_input );
        free( p_del );
    FOREACH_END();
    ARRAY_RESET( p_playlist->all_items );
    FOREACH_ARRAY( playlist_item_t *p_del, p_sys->items_to_delete )
        free( p_del->pp_children );
        vlc_gc_decref( p_del->p_input );
        free( p_del );
    FOREACH_END();
    ARRAY_RESET( p_sys->items_to_delete );

    ARRAY_RESET( p_playlist->items );
    ARRAY_RESET( p_playlist->current );

Laurent Aimar's avatar
Laurent Aimar committed
204
    msg_Dbg( p_this, "Destroyed" );
205 206
}

207 208 209 210 211 212
/** Get current playing input.
 */
input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
{
    input_thread_t * p_input;
    PL_LOCK;
213
    p_input = pl_priv(p_playlist)->p_input;
214
    if( p_input ) vlc_object_hold( p_input );
215 216 217 218
    PL_UNLOCK;
    return p_input;
}

219 220 221 222
/**
 * @}
 */

223 224 225 226 227 228
/** Accessor for status item and status nodes.
 */
playlist_item_t * get_current_status_item( playlist_t * p_playlist )
{
    PL_ASSERT_LOCKED;

229
    return pl_priv(p_playlist)->status.p_item;
230 231 232 233 234 235
}

playlist_item_t * get_current_status_node( playlist_t * p_playlist )
{
    PL_ASSERT_LOCKED;

236
    return pl_priv(p_playlist)->status.p_node;
237 238 239 240 241 242 243
}

void set_current_status_item( playlist_t * p_playlist,
    playlist_item_t * p_item )
{
    PL_ASSERT_LOCKED;

244 245 246
    if( pl_priv(p_playlist)->status.p_item &&
        pl_priv(p_playlist)->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG &&
        pl_priv(p_playlist)->status.p_item != p_item )
247
    {
248
        /* It's unsafe given current design to delete a playlist item :(
249
        playlist_ItemDelete( pl_priv(p_playlist)->status.p_item ); */
250
    }
251
    pl_priv(p_playlist)->status.p_item = p_item;
252 253 254 255 256 257 258
}

void set_current_status_node( playlist_t * p_playlist,
    playlist_item_t * p_node )
{
    PL_ASSERT_LOCKED;

259 260 261
    if( pl_priv(p_playlist)->status.p_node &&
        pl_priv(p_playlist)->status.p_node->i_flags & PLAYLIST_REMOVE_FLAG &&
        pl_priv(p_playlist)->status.p_node != p_node )
262
    {
263
        /* It's unsafe given current design to delete a playlist item :(
264
        playlist_ItemDelete( pl_priv(p_playlist)->status.p_node ); */
265
    }
266
    pl_priv(p_playlist)->status.p_node = p_node;
267 268
}

269 270 271 272
static void VariablesInit( playlist_t *p_playlist )
{
    /* These variables control updates */
    var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
Laurent Aimar's avatar
Laurent Aimar committed
273
    var_SetBool( p_playlist, "intf-change", true );
274

275
    var_Create( p_playlist, "item-change", VLC_VAR_ADDRESS );
276

277 278
    var_Create( p_playlist, "playlist-item-deleted", VLC_VAR_INTEGER );
    var_SetInteger( p_playlist, "playlist-item-deleted", -1 );
279

280
    var_Create( p_playlist, "playlist-item-append", VLC_VAR_ADDRESS );
281

282 283
    var_Create( p_playlist, "item-current", VLC_VAR_INTEGER );
    var_SetInteger( p_playlist, "item-current", -1 );
284 285 286 287 288

    var_Create( p_playlist, "activity", VLC_VAR_INTEGER );
    var_SetInteger( p_playlist, "activity", 0 );

    /* Variables to control playback */
289 290 291 292 293
    var_Create( p_playlist, "play-and-stop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
    var_Create( p_playlist, "play-and-exit", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
    var_Create( p_playlist, "random", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
    var_Create( p_playlist, "repeat", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
    var_Create( p_playlist, "loop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
zorglub's avatar
zorglub committed
294 295

    var_AddCallback( p_playlist, "random", RandomCallback, NULL );
296 297 298

    /* */
    var_Create( p_playlist, "album-art", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
299
}
300 301 302

playlist_item_t * playlist_CurrentPlayingItem( playlist_t * p_playlist )
{
303 304
    PL_ASSERT_LOCKED;

305 306 307 308 309
    return pl_priv(p_playlist)->status.p_item;
}

int playlist_Status( playlist_t * p_playlist )
{
310 311
    PL_ASSERT_LOCKED;

312 313
    return pl_priv(p_playlist)->status.i_status;
}
314