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>
zorglub's avatar
zorglub committed
32 33 34
#include <vlc_sout.h>
#include <vlc_playlist.h>
#include <vlc_interface.h>
35
#include "playlist_internal.h"
36
#include "input/resource.h"
37 38 39 40 41 42

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

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
    bool random = newval.b_bool;
49

50 51
    PL_LOCK;

52 53 54 55 56 57 58 59 60 61 62 63 64 65
    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 );
    }
66 67

    PL_UNLOCK;
zorglub's avatar
zorglub committed
68 69 70
    return VLC_SUCCESS;
}

71 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
/**
 * 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;
}

103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
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;
}

122
static int RateOffsetCallback( vlc_object_t *obj, char const *psz_cmd,
123 124
                               vlc_value_t oldval, vlc_value_t newval, void *p_data )
{
125
    playlist_t *p_playlist = (playlist_t *)obj;
126 127 128 129 130 131 132
    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,
    };
133 134 135 136
    const size_t i_rate_count = sizeof(pf_rate)/sizeof(*pf_rate);

    float f_rate;
    struct input_thread_t *input;
137 138

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

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

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

170 171 172 173
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;
174
    VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval); VLC_UNUSED(p_data); VLC_UNUSED(newval);
175 176 177 178 179 180

    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 )
181 182
    {
        const double f_position = var_GetFloat( p_input, "position" );
183
        input_Control( p_input, INPUT_RESTART_ES, -VIDEO_ES );
184 185
        var_SetFloat( p_input, "position", f_position );
    }
186 187 188 189

    PL_UNLOCK;
    return VLC_SUCCESS;
}
190

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

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

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

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

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

zorglub's avatar
zorglub committed
221 222
    ARRAY_INIT( p_playlist->items );
    ARRAY_INIT( p_playlist->all_items );
223
    ARRAY_INIT( pl_priv(p_playlist)->items_to_delete );
zorglub's avatar
zorglub committed
224
    ARRAY_INIT( p_playlist->current );
225

zorglub's avatar
zorglub committed
226
    p_playlist->i_current_index = 0;
227
    pl_priv(p_playlist)->b_reset_currently_playing = true;
zorglub's avatar
zorglub committed
228

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

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

233 234
    pl_priv(p_playlist)->b_auto_preparse =
        var_InheritBool( p_parent, "auto-preparse" );
235

236 237
   /* Preparser (and meta retriever) */
   p->p_preparser = playlist_preparser_New( VLC_OBJECT(p_playlist) );
238 239
   if( unlikely(p->p_preparser == NULL) )
       msg_Err( p_playlist, "cannot create preparser" );
240

jpd's avatar
jpd committed
241 242 243
    /* Create the root node */
    PL_LOCK;
    p_playlist->p_root = playlist_NodeCreate( p_playlist, NULL, NULL,
jpd's avatar
jpd committed
244
                                    PLAYLIST_END, 0, NULL );
245
    PL_UNLOCK;
jpd's avatar
jpd committed
246
    if( !p_playlist->p_root ) return NULL;
247

jpd's avatar
jpd committed
248 249 250 251
    /* Create currently playing items node */
    PL_LOCK;
    p_playlist->p_playing = playlist_NodeCreate(
        p_playlist, _( "Playlist" ), p_playlist->p_root,
jpd's avatar
jpd committed
252
        PLAYLIST_END, PLAYLIST_RO_FLAG, NULL );
253

254
    PL_UNLOCK;
255

jpd's avatar
jpd committed
256
    if( !p_playlist->p_playing ) return NULL;
257

jpd's avatar
jpd committed
258
    /* Create media library node */
259 260
    const bool b_ml = var_InheritBool( p_parent, "media-library");
    if( b_ml )
261
    {
jpd's avatar
jpd committed
262 263 264
        PL_LOCK;
        p_playlist->p_media_library = playlist_NodeCreate(
            p_playlist, _( "Media Library" ), p_playlist->p_root,
jpd's avatar
jpd committed
265
            PLAYLIST_END, PLAYLIST_RO_FLAG, NULL );
266
        PL_UNLOCK;
267 268 269
    }
    else
    {
jpd's avatar
jpd committed
270
        p_playlist->p_media_library = NULL;
271
    }
272

jpd's avatar
jpd committed
273 274 275 276 277 278 279
    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;;

280
    /* Initial status */
281
    pl_priv(p_playlist)->status.p_item = NULL;
jpd's avatar
jpd committed
282
    pl_priv(p_playlist)->status.p_node = p_playlist->p_playing;
283 284
    pl_priv(p_playlist)->request.b_request = false;
    pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
285

286 287 288 289 290 291 292
    if(b_ml)
    {
        const bool b_auto_preparse = pl_priv(p_playlist)->b_auto_preparse;
        pl_priv(p_playlist)->b_auto_preparse = false;
        playlist_MLLoad( p_playlist );
        pl_priv(p_playlist)->b_auto_preparse = b_auto_preparse;
    }
293

294 295 296 297 298
    /* Input resources */
    p->p_input_resource = input_resource_New( VLC_OBJECT( p_playlist ) );
    if( unlikely(p->p_input_resource == NULL) )
        abort();

299 300 301 302 303
    /* 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 );

304 305 306
    /* Thread */
    playlist_Activate (p_playlist);

307 308 309 310 311 312 313 314 315 316
    /* Add service discovery modules */
    char *mods = var_InheritString( p_playlist, "services-discovery" );
    if( mods != NULL )
    {
        char *p = mods, *m;
        while( (m = strsep( &p, " :," )) != NULL )
            playlist_ServicesDiscoveryAdd( p_playlist, m );
        free( mods );
    }

317 318 319
    return p_playlist;
}

320 321 322 323 324 325 326
/**
 * 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
 */
327 328 329 330
void playlist_Destroy( playlist_t *p_playlist )
{
    playlist_private_t *p_sys = pl_priv(p_playlist);

331 332 333
    /* Remove all services discovery */
    playlist_ServicesDiscoveryKillAll( p_playlist );

334
    msg_Dbg( p_playlist, "destroying" );
335

336
    playlist_Deactivate( p_playlist );
337 338
    if( p_sys->p_preparser )
        playlist_preparser_Delete( p_sys->p_preparser );
339

340 341 342 343 344 345 346 347 348 349 350 351 352
    /* 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;
353

354
    vlc_cond_destroy( &p_sys->signal );
355
    vlc_mutex_destroy( &p_sys->lock );
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373

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

374
    vlc_object_release( p_playlist );
375 376
}

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
377 378 379 380 381 382 383 384 385
#undef pl_Get
playlist_t *pl_Get (vlc_object_t *obj)
{
    static vlc_mutex_t lock = VLC_STATIC_MUTEX;
    libvlc_int_t *p_libvlc = obj->p_libvlc;
    playlist_t *pl;

    vlc_mutex_lock (&lock);
    pl = libvlc_priv (p_libvlc)->p_playlist;
386
    if (unlikely(pl == NULL))
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
387
    {
388 389 390 391
        pl = playlist_Create (VLC_OBJECT(p_libvlc));
        if (unlikely(pl == NULL))
            abort();
        libvlc_priv (p_libvlc)->p_playlist = pl;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
392 393 394 395 396
    }
    vlc_mutex_unlock (&lock);
    return pl;
}

397 398 399 400 401 402
/** Get current playing input.
 */
input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
{
    input_thread_t * p_input;
    PL_LOCK;
403
    p_input = pl_priv(p_playlist)->p_input;
404
    if( p_input ) vlc_object_hold( p_input );
405 406 407 408
    PL_UNLOCK;
    return p_input;
}

409 410 411 412
/**
 * @}
 */

413 414 415 416 417 418
/** Accessor for status item and status nodes.
 */
playlist_item_t * get_current_status_item( playlist_t * p_playlist )
{
    PL_ASSERT_LOCKED;

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

playlist_item_t * get_current_status_node( playlist_t * p_playlist )
{
    PL_ASSERT_LOCKED;

426
    return pl_priv(p_playlist)->status.p_node;
427 428 429 430 431 432 433
}

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

434 435 436
    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 )
437
    {
438
        /* It's unsafe given current design to delete a playlist item :(
439
        playlist_ItemDelete( pl_priv(p_playlist)->status.p_item ); */
440
    }
441
    pl_priv(p_playlist)->status.p_item = p_item;
442 443 444 445 446 447 448
}

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

449 450 451
    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 )
452
    {
453
        /* It's unsafe given current design to delete a playlist item :(
454
        playlist_ItemDelete( pl_priv(p_playlist)->status.p_node ); */
455
    }
456
    pl_priv(p_playlist)->status.p_node = p_node;
457 458
}

459 460 461 462
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
463
    var_SetBool( p_playlist, "intf-change", true );
464

465
    var_Create( p_playlist, "item-change", VLC_VAR_ADDRESS );
466
    var_Create( p_playlist, "leaf-to-parent", VLC_VAR_INTEGER );
467

468 469
    var_Create( p_playlist, "playlist-item-deleted", VLC_VAR_INTEGER );
    var_SetInteger( p_playlist, "playlist-item-deleted", -1 );
470

471
    var_Create( p_playlist, "playlist-item-append", VLC_VAR_ADDRESS );
472

473
    var_Create( p_playlist, "input-current", VLC_VAR_ADDRESS );
474

475
    var_Create( p_playlist, "activity", VLC_VAR_VOID );
476 477

    /* Variables to control playback */
478
    var_Create( p_playlist, "playlist-autostart", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
479
    var_Create( p_playlist, "random", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
480
    var_AddCallback( p_playlist, "random", RandomCallback, NULL );
481 482
    var_Create( p_playlist, "repeat", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
    var_Create( p_playlist, "loop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
483 484
    var_Create( p_playlist, "corks", VLC_VAR_INTEGER );
    var_AddCallback( p_playlist, "corks", CorksCallback, NULL );
zorglub's avatar
zorglub committed
485

486 487
    var_Create( p_playlist, "rate", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
    var_AddCallback( p_playlist, "rate", RateCallback, NULL );
488
    var_Create( p_playlist, "rate-slower", VLC_VAR_VOID );
489
    var_AddCallback( p_playlist, "rate-slower", RateOffsetCallback, NULL );
490
    var_Create( p_playlist, "rate-faster", VLC_VAR_VOID );
491 492
    var_AddCallback( p_playlist, "rate-faster", RateOffsetCallback, NULL );

493 494
    var_Create( p_playlist, "video-splitter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
    var_AddCallback( p_playlist, "video-splitter", VideoSplitterCallback, NULL );
495

496 497
    /* */
    var_Create( p_playlist, "album-art", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
498 499 500

    /* Variables to preserve video output parameters */
    var_Create( p_playlist, "fullscreen", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
501
    var_Create( p_playlist, "video-on-top", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
502
    var_Create( p_playlist, "video-wallpaper", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
503

504
    /* Audio output parameters */
505
    var_Create( p_playlist, "mute", VLC_VAR_BOOL );
506 507
    var_Create( p_playlist, "volume", VLC_VAR_FLOAT );
    var_SetFloat( p_playlist, "volume", -1.f );
508
}
509 510 511

playlist_item_t * playlist_CurrentPlayingItem( playlist_t * p_playlist )
{
512 513
    PL_ASSERT_LOCKED;

514 515 516 517 518
    return pl_priv(p_playlist)->status.p_item;
}

int playlist_Status( playlist_t * p_playlist )
{
519 520
    PL_ASSERT_LOCKED;

521 522
    return pl_priv(p_playlist)->status.i_status;
}
523