engine.c 9.73 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>
Clément Stenac's avatar
Clément Stenac committed
31 32 33
#include <vlc_sout.h>
#include <vlc_playlist.h>
#include <vlc_interface.h>
34
#include "playlist_internal.h"
Clément Stenac's avatar
Clément Stenac 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

Clément Stenac's avatar
Clément Stenac 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 52 53 54
    PL_LOCK;

    pl_priv(p_playlist)->b_reset_currently_playing = true;
    vlc_object_signal_unlocked( p_playlist );

    PL_UNLOCK;
Clément Stenac's avatar
Clément Stenac 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 84 85

    VariablesInit( p_playlist );

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

Clément Stenac's avatar
Clément Stenac committed
89 90
    ARRAY_INIT( p_playlist->items );
    ARRAY_INIT( p_playlist->all_items );
91
    ARRAY_INIT( pl_priv(p_playlist)->items_to_delete );
Clément Stenac's avatar
Clément Stenac committed
92
    ARRAY_INIT( p_playlist->current );
93

Clément Stenac's avatar
Clément Stenac committed
94
    p_playlist->i_current_index = 0;
95
    pl_priv(p_playlist)->b_reset_currently_playing = true;
96
    pl_priv(p_playlist)->last_rebuild_date = 0;
Clément Stenac's avatar
Clément Stenac committed
97

98
    pl_priv(p_playlist)->b_tree = var_CreateGetBool( p_playlist, "playlist-tree" );
99

100
    pl_priv(p_playlist)->b_doing_ml = false;
101

102
    pl_priv(p_playlist)->b_auto_preparse =
103
                        var_CreateGetBool( p_playlist, "auto-preparse" ) ;
104

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

112 113 114
    if( !p_playlist->p_root_category || !p_playlist->p_root_onelevel )
        return NULL;

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

122 123 124
    p_playlist->p_local_category->i_flags |= PLAYLIST_RO_FLAG;
    p_playlist->p_local_onelevel->i_flags |= PLAYLIST_RO_FLAG;

125 126 127 128 129
    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;

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

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

141 142 143 144 145 146 147
        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;
    }
148 149

    /* Initial status */
150 151 152 153
    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;
154

155
    pl_priv(p_playlist)->b_auto_preparse = false;
156
    playlist_MLLoad( p_playlist );
157
    pl_priv(p_playlist)->b_auto_preparse = true;
158

159 160
    vlc_object_set_destructor( p_playlist, playlist_Destructor );

161 162 163
    return p_playlist;
}

164 165 166 167 168 169 170
/**
 * Destroy playlist
 *
 * Destroy a playlist structure.
 * \param p_playlist the playlist object
 * \return nothing
 */
171 172 173

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

177
    assert( !p_sys->p_input );
178
    assert( !p_sys->p_input_ressource );
179 180
    assert( !p_sys->p_preparser );
    assert( !p_sys->p_fetcher );
181

182
    msg_Dbg( p_this, "Destroyed" );
183 184
}

185 186 187 188 189 190
/** Get current playing input.
 */
input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
{
    input_thread_t * p_input;
    PL_LOCK;
191
    p_input = pl_priv(p_playlist)->p_input;
192
    if( p_input ) vlc_object_hold( p_input );
193 194 195 196
    PL_UNLOCK;
    return p_input;
}

197 198 199 200
/**
 * @}
 */

201 202 203 204 205 206
/** Accessor for status item and status nodes.
 */
playlist_item_t * get_current_status_item( playlist_t * p_playlist )
{
    PL_ASSERT_LOCKED;

207
    return pl_priv(p_playlist)->status.p_item;
208 209 210 211 212 213
}

playlist_item_t * get_current_status_node( playlist_t * p_playlist )
{
    PL_ASSERT_LOCKED;

214
    return pl_priv(p_playlist)->status.p_node;
215 216 217 218 219 220 221
}

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

222 223 224
    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 )
225
    {
226
        /* It's unsafe given current design to delete a playlist item :(
227
        playlist_ItemDelete( pl_priv(p_playlist)->status.p_item ); */
228
    }
229
    pl_priv(p_playlist)->status.p_item = p_item;
230 231 232 233 234 235 236
}

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

237 238 239
    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 )
240
    {
241
        /* It's unsafe given current design to delete a playlist item :(
242
        playlist_ItemDelete( pl_priv(p_playlist)->status.p_node ); */
243
    }
244
    pl_priv(p_playlist)->status.p_node = p_node;
245 246
}

247 248 249 250 251
static void VariablesInit( playlist_t *p_playlist )
{
    vlc_value_t val;
    /* These variables control updates */
    var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
252
    val.b_bool = true;
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
    var_Set( p_playlist, "intf-change", val );

    var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
    val.i_int = -1;
    var_Set( p_playlist, "item-change", val );

    var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
    val.i_int = -1;
    var_Set( p_playlist, "item-deleted", val );

    var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );

    var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
    val.i_int = -1;
    var_Set( p_playlist, "playlist-current", val );

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

    /* Variables to control playback */
273 274 275 276 277
    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 );
Clément Stenac's avatar
Clément Stenac committed
278 279

    var_AddCallback( p_playlist, "random", RandomCallback, NULL );
280 281 282

    /* */
    var_Create( p_playlist, "album-art", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
283
}
284 285 286 287

int playlist_CurrentId( playlist_t * p_playlist )
{
    return pl_priv(p_playlist)->status.p_item->i_id;
288

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
}

bool playlist_IsPlaying( playlist_t * p_playlist )
{
    return ( pl_priv(p_playlist)->status.i_status == PLAYLIST_RUNNING &&
            !(pl_priv(p_playlist)->request.b_request && pl_priv(p_playlist)->request.i_status == PLAYLIST_STOPPED) );
}

playlist_item_t * playlist_CurrentPlayingItem( playlist_t * p_playlist )
{
    return pl_priv(p_playlist)->status.p_item;
}

int playlist_Status( playlist_t * p_playlist )
{
    return pl_priv(p_playlist)->status.i_status;
}