engine.c 16.3 KB
Newer Older
1 2 3
/*****************************************************************************
 * engine.c : Run the playlist and handle its control
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2008 VLC authors and VideoLAN
5 6 7 8
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
 *          Clément Stenac <zorglub@videolan.org>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
9 10 11
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
12 13 14 15
 * (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
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
19 20 21
 * You should have received a copy of the GNU Lesser 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.
22
 *****************************************************************************/
23

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

28
#include <stddef.h>
29
#include <assert.h>
30

31
#include <vlc_common.h>
Clément Stenac's avatar
Clément Stenac committed
32 33 34
#include <vlc_sout.h>
#include <vlc_playlist.h>
#include <vlc_interface.h>
35
#include <vlc_http.h>
36
#include "playlist_internal.h"
37
#include "input/resource.h"
38 39 40 41 42 43

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
static void VariablesInit( playlist_t *p_playlist );

Clément Stenac's avatar
Clément Stenac committed
44 45 46
static int RandomCallback( vlc_object_t *p_this, char const *psz_cmd,
                           vlc_value_t oldval, vlc_value_t newval, void *a )
{
47
    (void)psz_cmd; (void)oldval; (void)newval; (void)a;
48
    playlist_t *p_playlist = (playlist_t*)p_this;
49
    bool random = newval.b_bool;
50

51 52
    PL_LOCK;

53 54 55 56 57 58 59 60 61 62 63 64 65 66
    if( !random ) {
        pl_priv(p_playlist)->b_reset_currently_playing = true;
        vlc_cond_signal( &pl_priv(p_playlist)->signal );
    } else {
        /* Shuffle and sync the playlist on activation of random mode.
         * This preserves the current playing item, so that the user
         * can return to it if needed. (See #4472)
         */
        playlist_private_t *p_sys = pl_priv(p_playlist);
        playlist_item_t *p_new = p_sys->status.p_item;
        ResetCurrentlyPlaying( p_playlist, NULL );
        if( p_new )
            ResyncCurrentIndex( p_playlist, p_new );
    }
67 68

    PL_UNLOCK;
Clément Stenac's avatar
Clément Stenac committed
69 70 71
    return VLC_SUCCESS;
}

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
/**
 * When there are one or more pending corks, playback should be paused.
 * This is used for audio policy.
 * \warning Always add and remove a cork with var_IncInteger() and var_DecInteger().
 * var_Get() and var_Set() are prone to race conditions.
 */
static int CorksCallback( vlc_object_t *obj, char const *var,
                          vlc_value_t old, vlc_value_t cur, void *dummy )
{
    playlist_t *pl = (playlist_t *)obj;

    msg_Dbg( obj, "corks count: %"PRId64" -> %"PRId64, old.i_int, cur.i_int );
    if( !old.i_int == !cur.i_int )
        return VLC_SUCCESS; /* nothing to do */

    if( cur.i_int )
    {
        if( var_InheritBool( obj, "playlist-cork" ) )
        {
            msg_Dbg( obj, "corked" );
            playlist_Pause( pl );
        }
        else
            msg_Dbg( obj, "not corked" );
    }
    else
        msg_Dbg( obj, "uncorked" );

    (void) var; (void) dummy;
    return VLC_SUCCESS;
}

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
static int RateCallback( vlc_object_t *p_this, char const *psz_cmd,
                         vlc_value_t oldval, vlc_value_t newval, void *p )
{
    (void)psz_cmd; (void)oldval;(void)p;
    playlist_t *p_playlist = (playlist_t*)p_this;

    PL_LOCK;

    if( pl_priv(p_playlist)->p_input == NULL )
    {
        PL_UNLOCK;
        return VLC_SUCCESS;
    }

    var_SetFloat( pl_priv( p_playlist )->p_input, "rate", newval.f_float );
    PL_UNLOCK;
    return VLC_SUCCESS;
}

123
static int RateOffsetCallback( vlc_object_t *obj, char const *psz_cmd,
124 125
                               vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
126
    playlist_t *p_playlist = (playlist_t *)obj;
127 128 129 130 131 132 133
    VLC_UNUSED(oldval); VLC_UNUSED(p_data); VLC_UNUSED(newval);

    static const float pf_rate[] = {
        1.0/64, 1.0/32, 1.0/16, 1.0/8, 1.0/4, 1.0/3, 1.0/2, 2.0/3,
        1.0/1,
        3.0/2, 2.0/1, 3.0/1, 4.0/1, 8.0/1, 16.0/1, 32.0/1, 64.0/1,
    };
134 135 136 137
    const size_t i_rate_count = sizeof(pf_rate)/sizeof(*pf_rate);

    float f_rate;
    struct input_thread_t *input;
138 139

    PL_LOCK;
140 141
    input = pl_priv( p_playlist )->p_input;
    f_rate = var_GetFloat( input ? (vlc_object_t *)input : obj, "rate" );
142 143
    PL_UNLOCK;

144
    if( !strcmp( psz_cmd, "rate-faster" ) )
145
    {
146
        /* compensate for input rounding errors */
147
        float r = f_rate * 1.1f;
148 149 150 151 152 153
        for( size_t i = 0; i < i_rate_count; i++ )
            if( r < pf_rate[i] )
            {
                f_rate = pf_rate[i];
                break;
            }
154
    }
155
    else
156
    {
157
        /* compensate for input rounding errors */
158
        float r = f_rate * .9f;
159 160 161 162 163 164
        for( size_t i = 1; i < i_rate_count; i++ )
            if( r <= pf_rate[i] )
            {
                f_rate = pf_rate[i - 1];
                break;
            }
165
    }
166 167

    var_SetFloat( p_playlist, "rate", f_rate );
168 169 170
    return VLC_SUCCESS;
}

171 172 173 174
static int VideoSplitterCallback( vlc_object_t *p_this, char const *psz_cmd,
                                  vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
    playlist_t *p_playlist = (playlist_t*)p_this;
175
    VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data); VLC_UNUSED(newval);
176 177 178 179 180 181

    PL_LOCK;

    /* Force the input to restart the video ES to force a vout recreation */
    input_thread_t *p_input = pl_priv( p_playlist )->p_input;
    if( p_input )
182 183
    {
        const double f_position = var_GetFloat( p_input, "position" );
184
        input_Control( p_input, INPUT_RESTART_ES, -VIDEO_ES );
185 186
        var_SetFloat( p_input, "position", f_position );
    }
187 188 189 190

    PL_UNLOCK;
    return VLC_SUCCESS;
}
191

192 193 194 195 196 197 198
/**
 * 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
 */
199
playlist_t *playlist_Create( vlc_object_t *p_parent )
200 201
{
    playlist_t *p_playlist;
202
    playlist_private_t *p;
203 204

    /* Allocate structure */
205
    p = vlc_custom_create( p_parent, sizeof( *p ), "playlist" );
206
    if( !p )
207
        return NULL;
208

209 210
    assert( offsetof( playlist_private_t, public_data ) == 0 );
    p_playlist = &p->public_data;
211
    TAB_INIT( pl_priv(p_playlist)->i_sds, pl_priv(p_playlist)->pp_sds );
212

213
    VariablesInit( p_playlist );
214
    vlc_mutex_init( &p->lock );
215
    vlc_cond_init( &p->signal );
216
    p->killed = false;
217 218

    /* Initialise data structures */
219
    pl_priv(p_playlist)->i_last_playlist_id = 0;
220
    pl_priv(p_playlist)->p_input = NULL;
221

Clément Stenac's avatar
Clément Stenac committed
222 223
    ARRAY_INIT( p_playlist->items );
    ARRAY_INIT( p_playlist->all_items );
224
    ARRAY_INIT( pl_priv(p_playlist)->items_to_delete );
Clément Stenac's avatar
Clément Stenac committed
225
    ARRAY_INIT( p_playlist->current );
226

Clément Stenac's avatar
Clément Stenac committed
227
    p_playlist->i_current_index = 0;
228
    pl_priv(p_playlist)->b_reset_currently_playing = true;
Clément Stenac's avatar
Clément Stenac committed
229

230
    pl_priv(p_playlist)->b_tree = var_InheritBool( p_parent, "playlist-tree" );
231

232
    pl_priv(p_playlist)->b_doing_ml = false;
233

234 235 236
    /* Create the root node */
    PL_LOCK;
    p_playlist->p_root = playlist_NodeCreate( p_playlist, NULL, NULL,
237
                                    PLAYLIST_END, 0, NULL );
238
    PL_UNLOCK;
239
    if( !p_playlist->p_root ) return NULL;
240

241 242 243 244
    /* Create currently playing items node */
    PL_LOCK;
    p_playlist->p_playing = playlist_NodeCreate(
        p_playlist, _( "Playlist" ), p_playlist->p_root,
245
        PLAYLIST_END, PLAYLIST_RO_FLAG, NULL );
246

247
    PL_UNLOCK;
248

249
    if( !p_playlist->p_playing ) return NULL;
250

251
    /* Create media library node */
252 253
    const bool b_ml = var_InheritBool( p_parent, "media-library");
    if( b_ml )
254
    {
255 256 257
        PL_LOCK;
        p_playlist->p_media_library = playlist_NodeCreate(
            p_playlist, _( "Media Library" ), p_playlist->p_root,
258
            PLAYLIST_END, PLAYLIST_RO_FLAG, NULL );
259
        PL_UNLOCK;
260 261 262
    }
    else
    {
263
        p_playlist->p_media_library = NULL;
264
    }
265

266 267 268 269 270 271 272
    p_playlist->p_root_category = p_playlist->p_root;
    p_playlist->p_root_onelevel = p_playlist->p_root;
    p_playlist->p_local_category = p_playlist->p_playing;
    p_playlist->p_local_onelevel = p_playlist->p_playing;
    p_playlist->p_ml_category = p_playlist->p_media_library;
    p_playlist->p_ml_onelevel = p_playlist->p_media_library;;

273
    /* Initial status */
274
    pl_priv(p_playlist)->status.p_item = NULL;
275
    pl_priv(p_playlist)->status.p_node = p_playlist->p_playing;
276 277
    pl_priv(p_playlist)->request.b_request = false;
    pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
278

279 280
    if(b_ml)
        playlist_MLLoad( p_playlist );
281 282 283 284 285 286 287

    /* Preparser (and meta retriever) _after_ the Media Library*/
    if( var_InheritBool( p_parent, "auto-preparse" ) )
    {
        p->p_preparser = playlist_preparser_New( VLC_OBJECT(p_playlist) );
        if( unlikely(p->p_preparser == NULL) )
            msg_Err( p_playlist, "cannot create preparser" );
288
    }
289

290 291 292 293 294
    /* Input resources */
    p->p_input_resource = input_resource_New( VLC_OBJECT( p_playlist ) );
    if( unlikely(p->p_input_resource == NULL) )
        abort();

295 296 297 298 299
    /* Audio output (needed for volume and device controls). */
    audio_output_t *aout = input_resource_GetAout( p->p_input_resource );
    if( aout != NULL )
        input_resource_PutAout( p->p_input_resource, aout );

300 301 302 303 304 305 306 307 308
    /* Initialize the shared HTTP cookie jar */
    vlc_value_t cookies;
    cookies.p_address = vlc_http_cookies_new();
    if ( likely(cookies.p_address) )
    {
        var_Create( p_playlist, "http-cookies", VLC_VAR_ADDRESS );
        var_SetChecked( p_playlist, "http-cookies", VLC_VAR_ADDRESS, cookies );
    }

309 310 311
    /* Thread */
    playlist_Activate (p_playlist);

312 313 314 315
    /* Add service discovery modules */
    char *mods = var_InheritString( p_playlist, "services-discovery" );
    if( mods != NULL )
    {
316 317
        char *s = mods, *m;
        while( (m = strsep( &s, " :," )) != NULL )
318 319 320 321
            playlist_ServicesDiscoveryAdd( p_playlist, m );
        free( mods );
    }

322 323 324
    return p_playlist;
}

325 326 327 328 329 330 331
/**
 * Destroy playlist.
 * This is not thread-safe. Any reference to the playlist is assumed gone.
 * (In particular, all interface and services threads must have been joined).
 *
 * \param p_playlist the playlist object
 */
332 333 334 335
void playlist_Destroy( playlist_t *p_playlist )
{
    playlist_private_t *p_sys = pl_priv(p_playlist);

336 337 338
    /* Remove all services discovery */
    playlist_ServicesDiscoveryKillAll( p_playlist );

339
    msg_Dbg( p_playlist, "destroying" );
340

341
    playlist_Deactivate( p_playlist );
342 343
    if( p_sys->p_preparser )
        playlist_preparser_Delete( p_sys->p_preparser );
344

345 346 347 348 349 350 351 352 353 354 355 356 357
    /* Release input resources */
    assert( p_sys->p_input == NULL );
    input_resource_Release( p_sys->p_input_resource );

    if( p_playlist->p_media_library != NULL )
        playlist_MLDump( p_playlist );

    PL_LOCK;
    /* Release the current node */
    set_current_status_node( p_playlist, NULL );
    /* Release the current item */
    set_current_status_item( p_playlist, NULL );
    PL_UNLOCK;
358

359
    vlc_cond_destroy( &p_sys->signal );
360
    vlc_mutex_destroy( &p_sys->lock );
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378

    /* 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 );

379 380 381 382 383 384 385
    vlc_http_cookie_jar_t *cookies = var_GetAddress( p_playlist, "http-cookies" );
    if ( cookies )
    {
        var_Destroy( p_playlist, "http-cookies" );
        vlc_http_cookies_destroy( cookies );
    }

386
    vlc_object_release( p_playlist );
387 388
}

389 390 391 392 393 394
/** Get current playing input.
 */
input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
{
    input_thread_t * p_input;
    PL_LOCK;
395
    p_input = pl_priv(p_playlist)->p_input;
396
    if( p_input ) vlc_object_hold( p_input );
397 398 399 400
    PL_UNLOCK;
    return p_input;
}

401 402 403 404
/**
 * @}
 */

405 406 407 408 409 410
/** Accessor for status item and status nodes.
 */
playlist_item_t * get_current_status_item( playlist_t * p_playlist )
{
    PL_ASSERT_LOCKED;

411
    return pl_priv(p_playlist)->status.p_item;
412 413 414 415 416 417
}

playlist_item_t * get_current_status_node( playlist_t * p_playlist )
{
    PL_ASSERT_LOCKED;

418
    return pl_priv(p_playlist)->status.p_node;
419 420 421 422 423 424 425
}

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

426 427 428
    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 )
429
    {
430
        /* It's unsafe given current design to delete a playlist item :(
431
        playlist_ItemDelete( pl_priv(p_playlist)->status.p_item ); */
432
    }
433
    pl_priv(p_playlist)->status.p_item = p_item;
434 435 436 437 438 439 440
}

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

441 442 443
    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 )
444
    {
445
        /* It's unsafe given current design to delete a playlist item :(
446
        playlist_ItemDelete( pl_priv(p_playlist)->status.p_node ); */
447
    }
448
    pl_priv(p_playlist)->status.p_node = p_node;
449 450
}

451 452 453 454
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
455
    var_SetBool( p_playlist, "intf-change", true );
456

457
    var_Create( p_playlist, "item-change", VLC_VAR_ADDRESS );
458
    var_Create( p_playlist, "leaf-to-parent", VLC_VAR_INTEGER );
459

460 461
    var_Create( p_playlist, "playlist-item-deleted", VLC_VAR_INTEGER );
    var_SetInteger( p_playlist, "playlist-item-deleted", -1 );
462

463
    var_Create( p_playlist, "playlist-item-append", VLC_VAR_ADDRESS );
464

465
    var_Create( p_playlist, "input-current", VLC_VAR_ADDRESS );
466

467
    var_Create( p_playlist, "activity", VLC_VAR_VOID );
468 469

    /* Variables to control playback */
470
    var_Create( p_playlist, "playlist-autostart", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
471
    var_Create( p_playlist, "random", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
472
    var_AddCallback( p_playlist, "random", RandomCallback, NULL );
473 474
    var_Create( p_playlist, "repeat", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
    var_Create( p_playlist, "loop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
475 476
    var_Create( p_playlist, "corks", VLC_VAR_INTEGER );
    var_AddCallback( p_playlist, "corks", CorksCallback, NULL );
Clément Stenac's avatar
Clément Stenac committed
477

478 479
    var_Create( p_playlist, "rate", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
    var_AddCallback( p_playlist, "rate", RateCallback, NULL );
480
    var_Create( p_playlist, "rate-slower", VLC_VAR_VOID );
481
    var_AddCallback( p_playlist, "rate-slower", RateOffsetCallback, NULL );
482
    var_Create( p_playlist, "rate-faster", VLC_VAR_VOID );
483 484
    var_AddCallback( p_playlist, "rate-faster", RateOffsetCallback, NULL );

485 486
    var_Create( p_playlist, "video-splitter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
    var_AddCallback( p_playlist, "video-splitter", VideoSplitterCallback, NULL );
487

488 489
    /* */
    var_Create( p_playlist, "album-art", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
490
    var_Create( p_playlist, "metadata-network-access", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
491 492 493

    /* Variables to preserve video output parameters */
    var_Create( p_playlist, "fullscreen", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
494
    var_Create( p_playlist, "video-on-top", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
495
    var_Create( p_playlist, "video-wallpaper", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
496

497
    /* Audio output parameters */
498
    var_Create( p_playlist, "mute", VLC_VAR_BOOL );
499 500
    var_Create( p_playlist, "volume", VLC_VAR_FLOAT );
    var_SetFloat( p_playlist, "volume", -1.f );
501
}
502 503 504

playlist_item_t * playlist_CurrentPlayingItem( playlist_t * p_playlist )
{
505 506
    PL_ASSERT_LOCKED;

507 508 509 510 511
    return pl_priv(p_playlist)->status.p_item;
}

int playlist_Status( playlist_t * p_playlist )
{
512 513
    PL_ASSERT_LOCKED;

514 515
    return pl_priv(p_playlist)->status.i_status;
}
516