engine.c 15.8 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
#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
#include <math.h> /* for fabs() */
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 198 199 200
/**
 * 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 )
{
    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
    libvlc_priv(p_parent->p_libvlc)->p_playlist = p_playlist;
213 214

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

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

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

zorglub's avatar
zorglub committed
228
    p_playlist->i_current_index = 0;
229
    pl_priv(p_playlist)->b_reset_currently_playing = true;
230
    pl_priv(p_playlist)->last_rebuild_date = 0;
zorglub's avatar
zorglub committed
231

232
    pl_priv(p_playlist)->b_tree = var_InheritBool( p_parent, "playlist-tree" );
233

234
    pl_priv(p_playlist)->b_doing_ml = false;
235

236 237
    pl_priv(p_playlist)->b_auto_preparse =
        var_InheritBool( p_parent, "auto-preparse" );
238

239
    /* Fetcher */
240
    p->p_fetcher = playlist_fetcher_New( VLC_OBJECT(p_playlist) );
241 242 243 244 245 246 247 248 249 250 251 252
    if( unlikely(p->p_fetcher == NULL) )
    {
        msg_Err( p_playlist, "cannot create fetcher" );
        p->p_preparser = NULL;
    }
    else
    {   /* Preparse */
        p->p_preparser = playlist_preparser_New( p_playlist, p->p_fetcher );
        if( unlikely(p->p_preparser == NULL) )
            msg_Err( p_playlist, "cannot create preparser" );
    }

jpd's avatar
jpd committed
253 254 255
    /* Create the root node */
    PL_LOCK;
    p_playlist->p_root = playlist_NodeCreate( p_playlist, NULL, NULL,
jpd's avatar
jpd committed
256
                                    PLAYLIST_END, 0, NULL );
257
    PL_UNLOCK;
jpd's avatar
jpd committed
258
    if( !p_playlist->p_root ) return NULL;
259

jpd's avatar
jpd committed
260 261 262 263
    /* 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
264
        PLAYLIST_END, PLAYLIST_RO_FLAG, NULL );
265

266
    PL_UNLOCK;
267

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

jpd's avatar
jpd committed
270
    /* Create media library node */
271 272
    const bool b_ml = var_InheritBool( p_parent, "media-library");
    if( b_ml )
273
    {
jpd's avatar
jpd committed
274 275 276
        PL_LOCK;
        p_playlist->p_media_library = playlist_NodeCreate(
            p_playlist, _( "Media Library" ), p_playlist->p_root,
jpd's avatar
jpd committed
277
            PLAYLIST_END, PLAYLIST_RO_FLAG, NULL );
278
        PL_UNLOCK;
279

jpd's avatar
jpd committed
280
        if(!p_playlist->p_media_library ) return NULL;
281 282 283
    }
    else
    {
jpd's avatar
jpd committed
284
        p_playlist->p_media_library = NULL;
285
    }
286

jpd's avatar
jpd committed
287 288 289 290 291 292 293
    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;;

294
    /* Initial status */
295
    pl_priv(p_playlist)->status.p_item = NULL;
jpd's avatar
jpd committed
296
    pl_priv(p_playlist)->status.p_node = p_playlist->p_playing;
297 298
    pl_priv(p_playlist)->request.b_request = false;
    pl_priv(p_playlist)->status.i_status = PLAYLIST_STOPPED;
299

300 301 302 303 304 305 306
    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;
    }
307

308 309 310
    return p_playlist;
}

311 312 313 314 315 316 317
/**
 * 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
 */
318 319 320 321 322 323 324 325 326
void playlist_Destroy( playlist_t *p_playlist )
{
    playlist_private_t *p_sys = pl_priv(p_playlist);

    msg_Dbg( p_playlist, "destroying" );
    if( p_sys->p_preparser )
        playlist_preparser_Delete( p_sys->p_preparser );
    if( p_sys->p_fetcher )
        playlist_fetcher_Delete( p_sys->p_fetcher );
327

328
    /* Already cleared when deactivating (if activated anyway) */
Laurent Aimar's avatar
Laurent Aimar committed
329
    assert( !p_sys->p_input );
330
    assert( !p_sys->p_input_resource );
331

332
    vlc_cond_destroy( &p_sys->signal );
333
    vlc_mutex_destroy( &p_sys->lock );
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351

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

352
    vlc_object_release( p_playlist );
353 354
}

355 356 357 358 359 360
/** Get current playing input.
 */
input_thread_t * playlist_CurrentInput( playlist_t * p_playlist )
{
    input_thread_t * p_input;
    PL_LOCK;
361
    p_input = pl_priv(p_playlist)->p_input;
362
    if( p_input ) vlc_object_hold( p_input );
363 364 365 366
    PL_UNLOCK;
    return p_input;
}

367 368 369 370
/**
 * @}
 */

371 372 373 374 375 376
/** Accessor for status item and status nodes.
 */
playlist_item_t * get_current_status_item( playlist_t * p_playlist )
{
    PL_ASSERT_LOCKED;

377
    return pl_priv(p_playlist)->status.p_item;
378 379 380 381 382 383
}

playlist_item_t * get_current_status_node( playlist_t * p_playlist )
{
    PL_ASSERT_LOCKED;

384
    return pl_priv(p_playlist)->status.p_node;
385 386 387 388 389 390 391
}

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

392 393 394
    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 )
395
    {
396
        /* It's unsafe given current design to delete a playlist item :(
397
        playlist_ItemDelete( pl_priv(p_playlist)->status.p_item ); */
398
    }
399
    pl_priv(p_playlist)->status.p_item = p_item;
400 401 402 403 404 405 406
}

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

407 408 409
    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 )
410
    {
411
        /* It's unsafe given current design to delete a playlist item :(
412
        playlist_ItemDelete( pl_priv(p_playlist)->status.p_node ); */
413
    }
414
    pl_priv(p_playlist)->status.p_node = p_node;
415 416
}

417 418 419 420 421 422
static input_thread_t *playlist_FindInput( vlc_object_t *object )
{
    assert( object == VLC_OBJECT(pl_Get(object)) );
    return playlist_CurrentInput( (playlist_t *)object );
}

423 424 425 426
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
427
    var_SetBool( p_playlist, "intf-change", true );
428

429
    var_Create( p_playlist, "item-change", VLC_VAR_ADDRESS );
430
    var_Create( p_playlist, "leaf-to-parent", VLC_VAR_INTEGER );
431

432 433
    var_Create( p_playlist, "playlist-item-deleted", VLC_VAR_INTEGER );
    var_SetInteger( p_playlist, "playlist-item-deleted", -1 );
434

435
    var_Create( p_playlist, "playlist-item-append", VLC_VAR_ADDRESS );
436

437
    var_Create( p_playlist, "item-current", VLC_VAR_ADDRESS );
438
    var_Create( p_playlist, "input-current", VLC_VAR_ADDRESS );
439 440 441 442 443

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

    /* Variables to control playback */
444
    var_Create( p_playlist, "playlist-autostart", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
445 446 447
    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 );
448
    var_AddCallback( p_playlist, "random", RandomCallback, NULL );
449 450
    var_Create( p_playlist, "repeat", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
    var_Create( p_playlist, "loop", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
451 452
    var_Create( p_playlist, "corks", VLC_VAR_INTEGER );
    var_AddCallback( p_playlist, "corks", CorksCallback, NULL );
zorglub's avatar
zorglub committed
453

454 455
    var_Create( p_playlist, "rate", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
    var_AddCallback( p_playlist, "rate", RateCallback, NULL );
456
    var_Create( p_playlist, "rate-slower", VLC_VAR_VOID );
457
    var_AddCallback( p_playlist, "rate-slower", RateOffsetCallback, NULL );
458
    var_Create( p_playlist, "rate-faster", VLC_VAR_VOID );
459 460
    var_AddCallback( p_playlist, "rate-faster", RateOffsetCallback, NULL );

461 462
    var_Create( p_playlist, "video-splitter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
    var_AddCallback( p_playlist, "video-splitter", VideoSplitterCallback, NULL );
463

464 465
    /* */
    var_Create( p_playlist, "album-art", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
466 467 468

    /* Variables to preserve video output parameters */
    var_Create( p_playlist, "fullscreen", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
469
    var_Create( p_playlist, "video-on-top", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
470

471
    /* Audio output parameters */
472
    var_Create( p_playlist, "mute", VLC_VAR_BOOL );
473 474
    var_Create( p_playlist, "volume", VLC_VAR_FLOAT );
    var_SetFloat( p_playlist, "volume", -1.f );
475 476 477
    /* FIXME: horrible hack for audio output interface code */
    var_Create( p_playlist, "find-input-callback", VLC_VAR_ADDRESS );
    var_SetAddress( p_playlist, "find-input-callback", playlist_FindInput );
478
}
479 480 481

playlist_item_t * playlist_CurrentPlayingItem( playlist_t * p_playlist )
{
482 483
    PL_ASSERT_LOCKED;

484 485 486 487 488
    return pl_priv(p_playlist)->status.p_item;
}

int playlist_Status( playlist_t * p_playlist )
{
489 490
    PL_ASSERT_LOCKED;

491 492
    return pl_priv(p_playlist)->status.i_status;
}
493