es_out_timeshift.c 47.9 KB
Newer Older
1 2 3 4 5 6
/*****************************************************************************
 * es_out_timeshift.c: Es Out timeshift.
 *****************************************************************************
 * Copyright (C) 2008 Laurent Aimar
 * $Id$
 *
7
 * Authors: Laurent Aimar < fenrir _AT_ videolan _DOT_ org>
8
 *
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 28 29 30 31 32 33
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include <stdlib.h>
#include <stdio.h>
#include <assert.h>
34
#include <errno.h>
35
#if defined (_WIN32)
36 37
#  include <direct.h>
#endif
38
#include <sys/stat.h>
39
#include <unistd.h>
40 41

#include <vlc_common.h>
42
#include <vlc_fs.h>
43
#ifdef _WIN32
44 45
#  include <vlc_charset.h>
#endif
46 47 48 49 50 51 52 53 54 55 56
#include <vlc_input.h>
#include <vlc_es_out.h>
#include <vlc_block.h>
#include "input_internal.h"
#include "es_out.h"
#include "es_out_timeshift.h"

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/

57 58 59 60 61 62 63
/* XXX attribute_packed is (and MUST be) used ONLY to reduce memory usage */
#ifdef HAVE_ATTRIBUTE_PACKED
#   define attribute_packed __attribute__((__packed__))
#else
#   define attribute_packed
#endif

64 65 66 67 68 69 70 71
enum
{
    C_ADD,
    C_SEND,
    C_DEL,
    C_CONTROL,
};

72
typedef struct attribute_packed
Laurent Aimar's avatar
Laurent Aimar committed
73 74 75
{
    es_out_id_t *p_es;
    es_format_t *p_fmt;
76
} ts_cmd_add_t;
Laurent Aimar's avatar
Laurent Aimar committed
77

78
typedef struct attribute_packed
Laurent Aimar's avatar
Laurent Aimar committed
79 80 81 82
{
    es_out_id_t *p_es;
} ts_cmd_del_t;

83
typedef struct attribute_packed
Laurent Aimar's avatar
Laurent Aimar committed
84 85 86
{
    es_out_id_t *p_es;
    block_t *p_block;
87
    int     i_offset;  /* We do not use file > INT_MAX */
Laurent Aimar's avatar
Laurent Aimar committed
88 89
} ts_cmd_send_t;

90
typedef struct attribute_packed
Laurent Aimar's avatar
Laurent Aimar committed
91 92 93
{
    int  i_query;

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
    union
    {
        bool b_bool;
        int  i_int;
        int64_t i_i64;
        es_out_id_t *p_es;
        struct
        {
            int     i_int;
            int64_t i_i64;
        } int_i64;
        struct
        {
            int        i_int;
            vlc_meta_t *p_meta;
        } int_meta;
        struct
        {
            int       i_int;
            vlc_epg_t *p_epg;
        } int_epg;
        struct
116 117 118 119 120
        {
            int       i_int;
            vlc_epg_event_t *p_evt;
        } int_epg_evt;
        struct
121 122 123 124 125 126 127 128 129
        {
            es_out_id_t *p_es;
            bool        b_bool;
        } es_bool;
        struct
        {
            es_out_id_t *p_es;
            es_format_t *p_fmt;
        } es_fmt;
130
        struct
131 132 133 134 135
        {
            int i_cat;
            int i_policy;
        } es_policy;
        struct
136 137 138 139 140 141
        {
            /* FIXME Really too big (double make the whole thing too big) */
            double  f_position;
            mtime_t i_time;
            mtime_t i_length;
        } times;
142 143 144
        struct
        {
            mtime_t i_pts_delay;
145
            mtime_t i_pts_jitter;
146 147
            int     i_cr_average;
        } jitter;
148
    } u;
Laurent Aimar's avatar
Laurent Aimar committed
149 150
} ts_cmd_control_t;

151
typedef struct attribute_packed
152
{
153
    int8_t  i_type;
154
    mtime_t i_date;
155 156
    union
    {
Laurent Aimar's avatar
Laurent Aimar committed
157 158 159 160
        ts_cmd_add_t     add;
        ts_cmd_del_t     del;
        ts_cmd_send_t    send;
        ts_cmd_control_t control;
161
    } u;
162 163
} ts_cmd_t;

164 165 166 167 168 169
typedef struct ts_storage_t ts_storage_t;
struct ts_storage_t
{
    ts_storage_t *p_next;

    /* */
170
#ifdef _WIN32
171
    char    *psz_file;  /* Filename */
172
#endif
173
    size_t  i_file_max; /* Max size in bytes */
174 175 176
    int64_t i_file_size;/* Current size in bytes */
    FILE    *p_filew;   /* FILE handle for data writing */
    FILE    *p_filer;   /* FILE handle for data reading */
177 178 179 180 181 182 183 184

    /* */
    int      i_cmd_r;
    int      i_cmd_w;
    int      i_cmd_max;
    ts_cmd_t *p_cmd;
};

185 186
typedef struct
{
187
    vlc_thread_t   thread;
188 189
    input_thread_t *p_input;
    es_out_t       *p_out;
190 191
    int64_t        i_tmp_size_max;
    const char     *psz_tmp_path;
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206

    /* Lock for all following fields */
    vlc_mutex_t    lock;
    vlc_cond_t     wait;

    /* */
    bool           b_paused;
    mtime_t        i_pause_date;

    /* */
    int            i_rate;
    int            i_rate_source;
    mtime_t        i_rate_date;
    mtime_t        i_rate_delay;

207 208 209
    /* */
    mtime_t        i_buffering_delay;

210
    /* */
211 212 213
    ts_storage_t   *p_storage_r;
    ts_storage_t   *p_storage_w;

214 215 216 217
    mtime_t        i_cmd_delay;

} ts_thread_t;

218 219 220 221 222 223 224 225
struct es_out_id_t
{
    es_out_id_t *p_es;
};

struct es_out_sys_t
{
    input_thread_t *p_input;
226
    es_out_t       *p_out;
227 228 229 230 231 232 233 234 235 236

    /* Configuration */
    int64_t        i_tmp_size_max;    /* Maximal temporary file size in byte */
    char           *psz_tmp_path;     /* Path for temporary files */

    /* Lock for all following fields */
    vlc_mutex_t    lock;

    /* */
    bool           b_delayed;
237
    ts_thread_t   *p_ts;
238

239 240 241 242 243
    /* */
    bool           b_input_paused;
    bool           b_input_paused_source;
    int            i_input_rate;
    int            i_input_rate_source;
244

245 246 247 248 249 250 251 252 253 254 255
    /* */
    int            i_es;
    es_out_id_t    **pp_es;
};

static es_out_id_t *Add    ( es_out_t *, const es_format_t * );
static int          Send   ( es_out_t *, es_out_id_t *, block_t * );
static void         Del    ( es_out_t *, es_out_id_t * );
static int          Control( es_out_t *, int i_query, va_list );
static void         Destroy( es_out_t * );

256
static int          TsStart( es_out_t * );
257 258
static void         TsAutoStop( es_out_t * );

259
static void         TsStop( ts_thread_t * );
260
static void         TsPushCmd( ts_thread_t *, ts_cmd_t * );
261
static int          TsPopCmdLocked( ts_thread_t *, ts_cmd_t *, bool b_flush );
262
static bool         TsHasCmd( ts_thread_t * );
263
static bool         TsIsUnused( ts_thread_t * );
264 265
static int          TsChangePause( ts_thread_t *, bool b_source_paused, bool b_paused, mtime_t i_date );
static int          TsChangeRate( ts_thread_t *, int i_src_rate, int i_rate );
266

267
static void         *TsRun( void * );
268

269
static ts_storage_t *TsStorageNew( const char *psz_path, int64_t i_tmp_size_max );
270
static void         TsStorageDelete( ts_storage_t * );
271 272
static void         TsStoragePack( ts_storage_t *p_storage );
static bool         TsStorageIsFull( ts_storage_t *, const ts_cmd_t *p_cmd );
273
static bool         TsStorageIsEmpty( ts_storage_t * );
274
static void         TsStoragePushCmd( ts_storage_t *, const ts_cmd_t *p_cmd, bool b_flush );
275
static void         TsStoragePopCmd( ts_storage_t *p_storage, ts_cmd_t *p_cmd, bool b_flush );
276

277 278
static void CmdClean( ts_cmd_t * );
static void cmd_cleanup_routine( void *p ) { CmdClean( p ); }
279 280 281 282 283 284

static int  CmdInitAdd    ( ts_cmd_t *, es_out_id_t *, const es_format_t *, bool b_copy );
static void CmdInitSend   ( ts_cmd_t *, es_out_id_t *, block_t * );
static int  CmdInitDel    ( ts_cmd_t *, es_out_id_t * );
static int  CmdInitControl( ts_cmd_t *, int i_query, va_list, bool b_copy );

285 286 287 288 289 290
/* */
static void CmdCleanAdd    ( ts_cmd_t * );
static void CmdCleanSend   ( ts_cmd_t * );
static void CmdCleanControl( ts_cmd_t *p_cmd );

/* XXX these functions will take the destination es_out_t */
291 292 293 294 295
static void CmdExecuteAdd    ( es_out_t *, ts_cmd_t * );
static int  CmdExecuteSend   ( es_out_t *, ts_cmd_t * );
static void CmdExecuteDel    ( es_out_t *, ts_cmd_t * );
static int  CmdExecuteControl( es_out_t *, ts_cmd_t * );

296
/* File helpers */
297
static int GetTmpFile( char **ppsz_file, const char *psz_path );
298 299 300 301

/*****************************************************************************
 * input_EsOutTimeshiftNew:
 *****************************************************************************/
302
es_out_t *input_EsOutTimeshiftNew( input_thread_t *p_input, es_out_t *p_next_out, int i_rate )
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
{
    es_out_t *p_out = malloc( sizeof(*p_out) );
    if( !p_out )
        return NULL;

    es_out_sys_t *p_sys = malloc( sizeof(*p_sys) );
    if( !p_sys )
    {
        free( p_out );
        return NULL;
    }

    /* */
    p_out->pf_add     = Add;
    p_out->pf_send    = Send;
    p_out->pf_del     = Del;
    p_out->pf_control = Control;
    p_out->pf_destroy = Destroy;
    p_out->p_sys      = p_sys;

    /* */
324 325
    p_sys->b_input_paused = false;
    p_sys->b_input_paused_source = false;
326
    p_sys->p_input = p_input;
327 328 329
    p_sys->i_input_rate = i_rate;
    p_sys->i_input_rate_source = i_rate;

330 331
    p_sys->p_out = p_next_out;
    vlc_mutex_init_recursive( &p_sys->lock );
332

333
    p_sys->b_delayed = false;
334
    p_sys->p_ts = NULL;
335 336 337

    TAB_INIT( p_sys->i_es, p_sys->pp_es );

338 339 340 341 342 343
    /* */
    const int i_tmp_size_max = var_CreateGetInteger( p_input, "input-timeshift-granularity" );
    if( i_tmp_size_max < 0 )
        p_sys->i_tmp_size_max = 50*1024*1024;
    else
        p_sys->i_tmp_size_max = __MAX( i_tmp_size_max, 1*1024*1024 );
344 345
    msg_Dbg( p_input, "using timeshift granularity of %d MiB",
             (int)p_sys->i_tmp_size_max/(1024*1024) );
346

347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
    p_sys->psz_tmp_path = var_InheritString( p_input, "input-timeshift-path" );
#if defined (_WIN32) && !VLC_WINSTORE_APP
    if( p_sys->psz_tmp_path == NULL )
    {
        const DWORD count = GetTempPath( 0, NULL );
        if( count > 0 )
        {
            TCHAR *path = malloc( (count + 1) * sizeof(TCHAR) );
            if( path != NULL )
            {
                DWORD ret = GetTempPath( count + 1, path );
                if( ret != 0 && ret <= count )
                    p_sys->psz_tmp_path = FromT( path );
                free( path );
            }
        }
    }
    if( p_sys->psz_tmp_path == NULL )
    {
        wchar_t *wpath = _wgetcwd( NULL, 0 );
        if( wpath != NULL )
        {
            p_sys->psz_tmp_path = FromWide( wpath );
            free( wpath );
        }
    }
    if( p_sys->psz_tmp_path == NULL )
        p_sys->psz_tmp_path = strdup( "C:" );
375

376 377 378 379 380 381 382 383 384 385 386 387 388 389
    if( p_sys->psz_tmp_path != NULL )
    {
        size_t len = strlen( p_sys->psz_tmp_path );

        while( len > 0 && p_sys->psz_tmp_path[len - 1] == DIR_SEP_CHAR )
            len--;

        p_sys->psz_tmp_path[len] = '\0';
    }
#endif
    if( p_sys->psz_tmp_path != NULL )
        msg_Dbg( p_input, "using timeshift path: %s", p_sys->psz_tmp_path );
    else
        msg_Dbg( p_input, "using default timeshift path" );
390

391 392 393 394 395 396 397 398 399 400
#if 0
#define S(t) msg_Err( p_input, "SIZEOF("#t")=%d", sizeof(t) )
    S(ts_cmd_t);
    S(ts_cmd_control_t);
    S(ts_cmd_send_t);
    S(ts_cmd_del_t);
    S(ts_cmd_add_t);
#undef S
#endif

401 402 403 404 405 406 407 408 409 410
    return p_out;
}

/*****************************************************************************
 * Internal functions
 *****************************************************************************/
static void Destroy( es_out_t *p_out )
{
    es_out_sys_t *p_sys = p_out->p_sys;

411
    if( p_sys->b_delayed )
412
    {
413
        TsStop( p_sys->p_ts );
414 415
        p_sys->b_delayed = false;
    }
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437

    while( p_sys->i_es > 0 )
        Del( p_out, p_sys->pp_es[0] );
    TAB_CLEAN( p_sys->i_es, p_sys->pp_es  );

    free( p_sys->psz_tmp_path );
    vlc_mutex_destroy( &p_sys->lock );
    free( p_sys );
    free( p_out );
}

static es_out_id_t *Add( es_out_t *p_out, const es_format_t *p_fmt )
{
    es_out_sys_t *p_sys = p_out->p_sys;
    ts_cmd_t cmd;

    es_out_id_t *p_es = malloc( sizeof( *p_es ) );
    if( !p_es )
        return NULL;

    vlc_mutex_lock( &p_sys->lock );

438 439
    TsAutoStop( p_out );

440 441 442 443 444 445 446 447 448 449
    if( CmdInitAdd( &cmd, p_es, p_fmt, p_sys->b_delayed ) )
    {
        vlc_mutex_unlock( &p_sys->lock );
        free( p_es );
        return NULL;
    }

    TAB_APPEND( p_sys->i_es, p_sys->pp_es, p_es );

    if( p_sys->b_delayed )
450
        TsPushCmd( p_sys->p_ts, &cmd );
451
    else
452
        CmdExecuteAdd( p_sys->p_out, &cmd );
453 454 455 456 457 458 459 460 461 462 463 464 465

    vlc_mutex_unlock( &p_sys->lock );

    return p_es;
}
static int Send( es_out_t *p_out, es_out_id_t *p_es, block_t *p_block )
{
    es_out_sys_t *p_sys = p_out->p_sys;
    ts_cmd_t cmd;
    int i_ret = VLC_SUCCESS;

    vlc_mutex_lock( &p_sys->lock );

466 467
    TsAutoStop( p_out );

468 469
    CmdInitSend( &cmd, p_es, p_block );
    if( p_sys->b_delayed )
470
        TsPushCmd( p_sys->p_ts, &cmd );
471
    else
472
        i_ret = CmdExecuteSend( p_sys->p_out, &cmd) ;
473 474 475 476 477 478 479 480 481 482 483 484

    vlc_mutex_unlock( &p_sys->lock );

    return i_ret;
}
static void Del( es_out_t *p_out, es_out_id_t *p_es )
{
    es_out_sys_t *p_sys = p_out->p_sys;
    ts_cmd_t cmd;

    vlc_mutex_lock( &p_sys->lock );

485 486
    TsAutoStop( p_out );

487 488
    CmdInitDel( &cmd, p_es );
    if( p_sys->b_delayed )
489
        TsPushCmd( p_sys->p_ts, &cmd );
490
    else
491
        CmdExecuteDel( p_sys->p_out, &cmd );
492 493 494 495 496

    TAB_REMOVE( p_sys->i_es, p_sys->pp_es, p_es );

    vlc_mutex_unlock( &p_sys->lock );
}
497 498 499 500 501

static int ControlLockedGetEmpty( es_out_t *p_out, bool *pb_empty )
{
    es_out_sys_t *p_sys = p_out->p_sys;

502
    if( p_sys->b_delayed && TsHasCmd( p_sys->p_ts ) )
503 504 505 506 507 508 509 510 511 512 513 514
        *pb_empty = false;
    else
        *pb_empty = es_out_GetEmpty( p_sys->p_out );

    return VLC_SUCCESS;
}
static int ControlLockedGetWakeup( es_out_t *p_out, mtime_t *pi_wakeup )
{
    es_out_sys_t *p_sys = p_out->p_sys;

    if( p_sys->b_delayed )
    {
515
        assert( !input_priv(p_sys->p_input)->b_can_pace_control );
516 517 518 519 520 521 522 523 524
        *pi_wakeup = 0;
    }
    else
    {
        *pi_wakeup = es_out_GetWakeup( p_sys->p_out );
    }

    return VLC_SUCCESS;
}
525
static int ControlLockedGetBuffering( es_out_t *p_out, bool *pb_buffering )
526 527 528 529 530 531
{
    es_out_sys_t *p_sys = p_out->p_sys;

    if( p_sys->b_delayed )
        *pb_buffering = true;
    else
532
        *pb_buffering = es_out_GetBuffering( p_sys->p_out );
533 534 535 536 537 538

    return VLC_SUCCESS;
}
static int ControlLockedSetPauseState( es_out_t *p_out, bool b_source_paused, bool b_paused, mtime_t i_date )
{
    es_out_sys_t *p_sys = p_out->p_sys;
539 540 541 542 543 544 545 546 547
    int i_ret;

    if( !p_sys->b_delayed && !b_source_paused == !b_paused )
    {
        i_ret = es_out_SetPauseState( p_sys->p_out, b_source_paused, b_paused, i_date );
    }
    else
    {
        i_ret = VLC_EGENERIC;
548
        if( !input_priv(p_sys->p_input)->b_can_pace_control )
549 550 551 552
        {
            if( !p_sys->b_delayed )
                TsStart( p_out );
            if( p_sys->b_delayed )
553
                i_ret = TsChangePause( p_sys->p_ts, b_source_paused, b_paused, i_date );
554 555 556
        }
        else
        {
557
            /* XXX we may do it BUT it would be better to finish the clock clean up+improvements
558 559
             * and so be able to advertize correctly pace control property in access
             * module */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
560
            msg_Err( p_sys->p_input, "EsOutTimeshift does not work with streams that have pace control" );
561 562
        }
    }
563

564
    if( !i_ret )
565
    {
566 567
        p_sys->b_input_paused_source = b_source_paused;
        p_sys->b_input_paused = b_paused;
568
    }
569
    return i_ret;
570 571 572 573
}
static int ControlLockedSetRate( es_out_t *p_out, int i_src_rate, int i_rate )
{
    es_out_sys_t *p_sys = p_out->p_sys;
574
    int i_ret;
575

576 577 578 579 580
    if( !p_sys->b_delayed && i_src_rate == i_rate )
    {
        i_ret = es_out_SetRate( p_sys->p_out, i_src_rate, i_rate );
    }
    else
581
    {
582
        i_ret = VLC_EGENERIC;
583
        if( !input_priv(p_sys->p_input)->b_can_pace_control )
584 585 586 587
        {
            if( !p_sys->b_delayed )
                TsStart( p_out );
            if( p_sys->b_delayed )
588
                i_ret = TsChangeRate( p_sys->p_ts, i_src_rate, i_rate );
589 590 591
        }
        else
        {
592
            /* XXX we may do it BUT it would be better to finish the clock clean up+improvements
593 594
             * and so be able to advertize correctly pace control property in access
             * module */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
595
            msg_Err( p_sys->p_input, "EsOutTimeshift does not work with streams that have pace control" );
596 597
        }

598
    }
599 600 601 602 603 604 605

    if( !i_ret )
    {
        p_sys->i_input_rate_source = i_src_rate;
        p_sys->i_input_rate = i_rate;
    }
    return i_ret;
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
}
static int ControlLockedSetTime( es_out_t *p_out, mtime_t i_date )
{
    es_out_sys_t *p_sys = p_out->p_sys;

    if( !p_sys->b_delayed )
        return es_out_SetTime( p_sys->p_out, i_date );

    /* TODO */
    msg_Err( p_sys->p_input, "EsOutTimeshift does not yet support time change" );
    return VLC_EGENERIC;
}
static int ControlLockedSetFrameNext( es_out_t *p_out )
{
    es_out_sys_t *p_sys = p_out->p_sys;

Laurent Aimar's avatar
Laurent Aimar committed
622
    return es_out_SetFrameNext( p_sys->p_out );
623 624
}

625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
static int ControlLocked( es_out_t *p_out, int i_query, va_list args )
{
    es_out_sys_t *p_sys = p_out->p_sys;

    switch( i_query )
    {
    /* Pass-through control */
    case ES_OUT_SET_MODE:
    case ES_OUT_SET_GROUP:
    case ES_OUT_SET_PCR:
    case ES_OUT_SET_GROUP_PCR:
    case ES_OUT_RESET_PCR:
    case ES_OUT_SET_NEXT_DISPLAY_TIME:
    case ES_OUT_SET_GROUP_META:
    case ES_OUT_SET_GROUP_EPG:
640
    case ES_OUT_SET_GROUP_EPG_EVENT:
641
    case ES_OUT_SET_EPG_TIME:
642
    case ES_OUT_SET_ES_SCRAMBLED_STATE:
643
    case ES_OUT_DEL_GROUP:
644
    case ES_OUT_SET_META:
645 646
    case ES_OUT_SET_ES:
    case ES_OUT_RESTART_ES:
647
    case ES_OUT_RESTART_ALL_ES:
648 649
    case ES_OUT_SET_ES_DEFAULT:
    case ES_OUT_SET_ES_STATE:
650
    case ES_OUT_SET_ES_CAT_POLICY:
651
    case ES_OUT_SET_ES_FMT:
652
    case ES_OUT_SET_TIMES:
653
    case ES_OUT_SET_JITTER:
654
    case ES_OUT_SET_EOS:
655 656 657 658 659 660
    {
        ts_cmd_t cmd;
        if( CmdInitControl( &cmd, i_query, args, p_sys->b_delayed ) )
            return VLC_EGENERIC;
        if( p_sys->b_delayed )
        {
661
            TsPushCmd( p_sys->p_ts, &cmd );
662 663
            return VLC_SUCCESS;
        }
664
        return CmdExecuteControl( p_sys->p_out, &cmd );
665 666
    }

667 668 669 670 671 672 673 674 675 676 677
    /* Special control when delayed */
    case ES_OUT_GET_ES_STATE:
    {
        es_out_id_t *p_es = (es_out_id_t*)va_arg( args, es_out_id_t * );
        bool *pb_enabled = (bool*)va_arg( args, bool* );

        if( p_sys->b_delayed )
        {
            *pb_enabled = true;
            return VLC_SUCCESS;
        }
678
        return es_out_Control( p_sys->p_out, ES_OUT_GET_ES_STATE, p_es->p_es, pb_enabled );
679 680
    }
    /* Special internal input control */
681 682 683 684 685
    case ES_OUT_GET_EMPTY:
    {
        bool *pb_empty = (bool*)va_arg( args, bool* );
        return ControlLockedGetEmpty( p_out, pb_empty );
    }
686
    case ES_OUT_GET_WAKE_UP: /* TODO ? */
687 688 689 690
    {
        mtime_t *pi_wakeup = (mtime_t*)va_arg( args, mtime_t* );
        return ControlLockedGetWakeup( p_out, pi_wakeup );
    }
691
    case ES_OUT_GET_BUFFERING:
692 693
    {
        bool *pb_buffering = (bool *)va_arg( args, bool* );
694
        return ControlLockedGetBuffering( p_out, pb_buffering );
695
    }
696
    case ES_OUT_SET_PAUSE_STATE:
697 698 699 700 701 702 703
    {
        const bool b_source_paused = (bool)va_arg( args, int );
        const bool b_paused = (bool)va_arg( args, int );
        const mtime_t i_date = (mtime_t) va_arg( args, mtime_t );

        return ControlLockedSetPauseState( p_out, b_source_paused, b_paused, i_date );
    }
704
    case ES_OUT_SET_RATE:
705 706 707 708 709 710
    {
        const int i_src_rate = (int)va_arg( args, int );
        const int i_rate = (int)va_arg( args, int );

        return ControlLockedSetRate( p_out, i_src_rate, i_rate );
    }
711
    case ES_OUT_SET_TIME:
712 713 714 715 716
    {
        const mtime_t i_date = (mtime_t)va_arg( args, mtime_t );

        return ControlLockedSetTime( p_out, i_date );
    }
717
    case ES_OUT_SET_FRAME_NEXT:
718 719 720
    {
        return ControlLockedSetFrameNext( p_out );
    }
721

722 723 724
    case ES_OUT_GET_PCR_SYSTEM:
        if( p_sys->b_delayed )
            return VLC_EGENERIC;
725 726
        /* fall through */
    case ES_OUT_GET_GROUP_FORCED:
727
    case ES_OUT_POST_SUBNODE:
728
        return es_out_vaControl( p_sys->p_out, i_query, args );
729

730 731 732 733 734 735 736 737 738 739
    case ES_OUT_MODIFY_PCR_SYSTEM:
    {
        const bool    b_absolute = va_arg( args, int );
        const mtime_t i_system   = va_arg( args, mtime_t );

        if( b_absolute && p_sys->b_delayed )
            return VLC_EGENERIC;

        return es_out_ControlModifyPcrSystem( p_sys->p_out, b_absolute, i_system );
    }
Laurent Aimar's avatar
Laurent Aimar committed
740

741 742 743 744 745 746 747
    /* Invalid queries for this es_out level */
    case ES_OUT_SET_ES_BY_ID:
    case ES_OUT_RESTART_ES_BY_ID:
    case ES_OUT_SET_ES_DEFAULT_BY_ID:
    case ES_OUT_GET_ES_OBJECTS_BY_ID:
    case ES_OUT_SET_DELAY:
    case ES_OUT_SET_RECORD_STATE:
748
    default:
749
        vlc_assert_unreachable();
750 751 752 753 754 755 756 757 758
        return VLC_EGENERIC;
    }
}
static int Control( es_out_t *p_out, int i_query, va_list args )
{
    es_out_sys_t *p_sys = p_out->p_sys;
    int i_ret;

    vlc_mutex_lock( &p_sys->lock );
759 760 761

    TsAutoStop( p_out );

762
    i_ret = ControlLocked( p_out, i_query, args );
763

764 765 766 767 768
    vlc_mutex_unlock( &p_sys->lock );

    return i_ret;
}

769 770 771
/*****************************************************************************
 *
 *****************************************************************************/
772
static void TsDestroy( ts_thread_t *p_ts )
773 774 775
{
    vlc_cond_destroy( &p_ts->wait );
    vlc_mutex_destroy( &p_ts->lock );
776
    free( p_ts );
777
}
778 779 780
static int TsStart( es_out_t *p_out )
{
    es_out_sys_t *p_sys = p_out->p_sys;
781
    ts_thread_t *p_ts;
782 783 784

    assert( !p_sys->b_delayed );

785
    p_sys->p_ts = p_ts = calloc(1, sizeof(*p_ts));
786
    if( !p_ts )
787 788
        return VLC_EGENERIC;

789 790
    p_ts->i_tmp_size_max = p_sys->i_tmp_size_max;
    p_ts->psz_tmp_path = p_sys->psz_tmp_path;
791 792 793 794 795 796 797 798 799 800
    p_ts->p_input = p_sys->p_input;
    p_ts->p_out = p_sys->p_out;
    vlc_mutex_init( &p_ts->lock );
    vlc_cond_init( &p_ts->wait );
    p_ts->b_paused = p_sys->b_input_paused && !p_sys->b_input_paused_source;
    p_ts->i_pause_date = p_ts->b_paused ? mdate() : -1;
    p_ts->i_rate_source = p_sys->i_input_rate_source;
    p_ts->i_rate        = p_sys->i_input_rate;
    p_ts->i_rate_date = -1;
    p_ts->i_rate_delay = 0;
801
    p_ts->i_buffering_delay = 0;
802
    p_ts->i_cmd_delay = 0;
803 804
    p_ts->p_storage_r = NULL;
    p_ts->p_storage_w = NULL;
805

806
    p_sys->b_delayed = true;
807
    if( vlc_clone( &p_ts->thread, TsRun, p_ts, VLC_THREAD_PRIORITY_INPUT ) )
808
    {
809
        msg_Err( p_sys->p_input, "cannot create timeshift thread" );
810

811
        TsDestroy( p_ts );
812 813 814 815 816 817 818

        p_sys->b_delayed = false;
        return VLC_EGENERIC;
    }

    return VLC_SUCCESS;
}
819 820 821 822
static void TsAutoStop( es_out_t *p_out )
{
    es_out_sys_t *p_sys = p_out->p_sys;

823
    if( !p_sys->b_delayed || !TsIsUnused( p_sys->p_ts ) )
824 825 826
        return;

    msg_Warn( p_sys->p_input, "es out timeshift: auto stop" );
827
    TsStop( p_sys->p_ts );
828 829 830

    p_sys->b_delayed = false;
}
831
static void TsStop( ts_thread_t *p_ts )
832
{
833 834
    vlc_cancel( p_ts->thread );
    vlc_join( p_ts->thread, NULL );
835

836
    vlc_mutex_lock( &p_ts->lock );
Laurent Aimar's avatar
Laurent Aimar committed
837 838 839 840
    for( ;; )
    {
        ts_cmd_t cmd;

841
        if( TsPopCmdLocked( p_ts, &cmd, true ) )
Laurent Aimar's avatar
Laurent Aimar committed
842 843 844 845
            break;

        CmdClean( &cmd );
    }
846 847 848
    assert( !p_ts->p_storage_r || !p_ts->p_storage_r->p_next );
    if( p_ts->p_storage_r )
        TsStorageDelete( p_ts->p_storage_r );
849
    vlc_mutex_unlock( &p_ts->lock );
Laurent Aimar's avatar
Laurent Aimar committed
850

851
    TsDestroy( p_ts );
852
}
853
static void TsPushCmd( ts_thread_t *p_ts, ts_cmd_t *p_cmd )
854
{
855
    vlc_mutex_lock( &p_ts->lock );
856

857
    if( !p_ts->p_storage_w || TsStorageIsFull( p_ts->p_storage_w, p_cmd ) )
858
    {
859
        ts_storage_t *p_storage = TsStorageNew( p_ts->psz_tmp_path, p_ts->i_tmp_size_max );
860

861 862 863
        if( !p_storage )
        {
            CmdClean( p_cmd );
864 865
            vlc_mutex_unlock( &p_ts->lock );
            /* TODO warn the user (but only once) */
866 867
            return;
        }
868

869 870 871 872 873 874
        if( !p_ts->p_storage_w )
        {
            p_ts->p_storage_r = p_ts->p_storage_w = p_storage;
        }
        else
        {
875
            TsStoragePack( p_ts->p_storage_w );
876 877 878
            p_ts->p_storage_w->p_next = p_storage;
            p_ts->p_storage_w = p_storage;
        }
879
    }
880

881
    /* TODO return error and warn the user (but only once) */
882
    TsStoragePushCmd( p_ts->p_storage_w, p_cmd, p_ts->p_storage_r == p_ts->p_storage_w );
883 884 885 886

    vlc_cond_signal( &p_ts->wait );

    vlc_mutex_unlock( &p_ts->lock );
887
}
888
static int TsPopCmdLocked( ts_thread_t *p_ts, ts_cmd_t *p_cmd, bool b_flush )
889
{
890
    vlc_assert_locked( &p_ts->lock );
891

892
    if( TsStorageIsEmpty( p_ts->p_storage_r ) )
893 894
        return VLC_EGENERIC;

895
    TsStoragePopCmd( p_ts->p_storage_r, p_cmd, b_flush );
896 897 898 899 900 901 902 903 904 905

    while( p_ts->p_storage_r && TsStorageIsEmpty( p_ts->p_storage_r ) )
    {
        ts_storage_t *p_next = p_ts->p_storage_r->p_next;
        if( !p_next )
            break;

        TsStorageDelete( p_ts->p_storage_r );
        p_ts->p_storage_r = p_next;
    }
906 907 908

    return VLC_SUCCESS;
}
909
static bool TsHasCmd( ts_thread_t *p_ts )
910
{
911
    bool b_cmd;
912

913
    vlc_mutex_lock( &p_ts->lock );
914
    b_cmd =  TsStorageIsEmpty( p_ts->p_storage_r );
915 916 917 918
    vlc_mutex_unlock( &p_ts->lock );

    return b_cmd;
}
919 920 921 922 923 924 925
static bool TsIsUnused( ts_thread_t *p_ts )
{
    bool b_unused;

    vlc_mutex_lock( &p_ts->lock );
    b_unused = !p_ts->b_paused &&
               p_ts->i_rate == p_ts->i_rate_source &&
926
               TsStorageIsEmpty( p_ts->p_storage_r );
927 928 929 930
    vlc_mutex_unlock( &p_ts->lock );

    return b_unused;
}
931 932 933
static int TsChangePause( ts_thread_t *p_ts, bool b_source_paused, bool b_paused, mtime_t i_date )
{
    vlc_mutex_lock( &p_ts->lock );
934 935 936 937 938

    int i_ret;
    if( b_paused )
    {
        assert( !b_source_paused );
939
        i_ret = es_out_SetPauseState( p_ts->p_out, true, true, i_date );
940 941 942
    }
    else
    {
943
        i_ret = es_out_SetPauseState( p_ts->p_out, false, false, i_date );
944 945 946 947 948 949
    }

    if( !i_ret )
    {
        if( !b_paused )
        {
950
            assert( p_ts->i_pause_date > 0 );
951

952
            p_ts->i_cmd_delay += i_date - p_ts->i_pause_date;
953 954
        }

955 956
        p_ts->b_paused = b_paused;
        p_ts->i_pause_date = i_date;
957

958
        vlc_cond_signal( &p_ts->wait );
959
    }
960
    vlc_mutex_unlock( &p_ts->lock );
961 962
    return i_ret;
}
963
static int TsChangeRate( ts_thread_t *p_ts, int i_src_rate, int i_rate )
964
{
965
    int i_ret;
966

967 968
    vlc_mutex_lock( &p_ts->lock );
    p_ts->i_cmd_delay += p_ts->i_rate_delay;
969

970 971 972 973
    p_ts->i_rate_date = -1;
    p_ts->i_rate_delay = 0;
    p_ts->i_rate = i_rate;
    p_ts->i_rate_source = i_src_rate;
974

975 976
    i_ret = es_out_SetRate( p_ts->p_out, i_rate, i_rate );
    vlc_mutex_unlock( &p_ts->lock );
977

978
    return i_ret;
979 980
}

981
static void *TsRun( void *p_data )
982
{
983
    ts_thread_t *p_ts = p_data;
984
    mtime_t i_buffering_date = -1;
985 986 987 988

    for( ;; )
    {
        ts_cmd_t cmd;
989
        mtime_t  i_deadline;
990
        bool b_buffering;
991

992
        /* Pop a command to execute */
993 994
        vlc_mutex_lock( &p_ts->lock );
        mutex_cleanup_push( &p_ts->lock );
995

996 997 998
        for( ;; )
        {
            const int canc = vlc_savecancel();
999
            b_buffering = es_out_GetBuffering( p_ts->p_out );
1000

1001
            if( ( !p_ts->b_paused || b_buffering ) && !TsPopCmdLocked( p_ts, &cmd, false ) )
1002 1003
            {
                vlc_restorecancel( canc );
1004
                break;
1005 1006
            }
            vlc_restorecancel( canc );
1007

1008
            vlc_cond_wait( &p_ts->wait, &p_ts->lock );
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
        }

        if( b_buffering && i_buffering_date < 0 )
        {
            i_buffering_date = cmd.i_date;
        }
        else if( i_buffering_date > 0 )
        {
            p_ts->i_buffering_delay += i_buffering_date - cmd.i_date; /* It is < 0 */
            if( b_buffering )
                i_buffering_date = cmd.i_date;
            else
                i_buffering_date = -1;
        }
1023

1024 1025
        if( p_ts->i_rate_date < 0 )
            p_ts->i_rate_date = cmd.i_date;
1026

1027 1028
        p_ts->i_rate_delay = 0;
        if( p_ts->i_rate_source != p_ts->i_rate )
1029
        {
1030 1031
            const mtime_t i_duration = cmd.i_date - p_ts->i_rate_date;
            p_ts->i_rate_delay = i_duration * p_ts->i_rate / p_ts->i_rate_source - i_duration;
1032
        }
1033
        if( p_ts->i_cmd_delay + p_ts->i_rate_delay + p_ts->i_buffering_delay < 0 && p_ts->i_rate != p_ts->i_rate_source )
1034
        {
1035 1036
            const int canc = vlc_savecancel();

1037
            /* Auto reset to rate 1.0 */
1038
            msg_Warn( p_ts->p_input, "es out timeshift: auto reset rate to %d", p_ts->i_rate_source );
1039

1040
            p_ts->i_cmd_delay = 0;
1041
            p_ts->i_buffering_delay = 0;
1042

1043
            p_ts->i_rate_delay = 0;
1044
            p_ts->i_rate_date = -1;
1045
            p_ts->i_rate = p_ts->i_rate_source;
1046

1047
            if( !es_out_SetRate( p_ts->p_out, p_ts->i_rate_source, p_ts->i_rate ) )
1048
            {
1049
                vlc_value_t val = { .i_int = p_ts->i_rate };
1050 1051 1052
                /* Warn back input
                 * FIXME it is perfectly safe BUT it is ugly as it may hide a
                 * rate change requested by user */
1053
                input_ControlPush( p_ts->p_input, INPUT_CONTROL_SET_RATE, &val );
1054
            }
1055 1056

            vlc_restorecancel( canc );
1057
        }
1058
        i_deadline = cmd.i_date + p_ts->i_cmd_delay + p_ts->i_rate_delay + p_ts->i_buffering_delay;
1059

1060 1061
        vlc_cleanup_pop();
        vlc_mutex_unlock( &p_ts->lock );
1062 1063 1064 1065 1066

        /* Regulate the speed of command processing to the same one than
         * reading  */
        vlc_cleanup_push( cmd_cleanup_routine, &cmd );

1067
        mwait( i_deadline );
1068 1069

        vlc_cleanup_pop();
1070

1071
        /* Execute the command  */
1072 1073 1074 1075
        const int canc = vlc_savecancel();
        switch( cmd.i_type )
        {
        case C_ADD:
1076
            CmdExecuteAdd( p_ts->p_out, &cmd );
1077 1078 1079
            CmdCleanAdd( &cmd );
            break;
        case C_SEND:
1080
            CmdExecuteSend( p_ts->p_out, &cmd );
1081 1082 1083
            CmdCleanSend( &cmd );
            break;
        case C_CONTROL:
1084
            CmdExecuteControl( p_ts->p_out, &cmd );
1085 1086 1087
            CmdCleanControl( &cmd );
            break;
        case C_DEL:
1088
            CmdExecuteDel( p_ts->p_out, &cmd );
1089 1090
            break;
        default:
1091
            vlc_assert_unreachable();
1092 1093
            break;
        }
1094
        vlc_restorecancel( canc );
1095 1096 1097 1098 1099
    }

    return NULL;
}

1100 1101 1102
/*****************************************************************************
 *
 *****************************************************************************/
1103
static ts_storage_t *TsStorageNew( const char *psz_tmp_path, int64_t i_tmp_size_max )
1104
{
1105 1106
    ts_storage_t *p_storage = malloc( sizeof (*p_storage) );
    if( unlikely(p_storage == NULL) )
1107 1108
        return NULL;

1109 1110
    char *psz_file;
    int fd = GetTmpFile( &psz_file, psz_tmp_path );
1111 1112 1113 1114 1115 1116 1117 1118 1119
    if( fd == -1 )
    {
        free( p_storage );
        return NULL;
    }

    p_storage->p_filew = fdopen( fd, "w+b" );
    if( p_storage->p_filew == NULL )
    {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1120
        vlc_close( fd );
1121
        vlc_unlink( psz_file );
1122 1123 1124
        goto error;
    }

1125
    p_storage->p_filer = vlc_fopen( psz_file, "rb" );
1126 1127 1128
    if( p_storage->p_filer == NULL )
    {
        fclose( p_storage->p_filew );
1129
        vlc_unlink( psz_file );
1130 1131 1132
        goto error;
    }

1133 1134 1135 1136 1137 1138
#ifndef _WIN32
    vlc_unlink( psz_file );
    free( psz_file );
#else
    p_storage->psz_file = psz_file;
#endif
1139 1140
    p_storage->p_next = NULL;

1141 1142 1143 1144
    /* */
    p_storage->i_file_max = i_tmp_size_max;
    p_storage->i_file_size = 0;

1145 1146 1147
    /* */
    p_storage->i_cmd_w = 0;
    p_storage->i_cmd_r = 0;
1148
    p_storage->i_cmd_max = 30000;
1149
    p_storage->p_cmd = malloc( p_storage->i_cmd_max * sizeof(*p_storage->p_cmd) );
1150
    //fprintf( stderr, "\nSTORAGE name=%s size=%d KiB\n", p_storage->psz_file, p_storage->i_cmd_max * sizeof(*p_storage->p_cmd) /1024 );
1151

1152
    if( !p_storage->p_cmd )
1153 1154 1155 1156 1157
    {
        TsStorageDelete( p_storage );
        return NULL;
    }
    return p_storage;
1158
error:
1159
    free( psz_file );
1160 1161
    free( p_storage );
    return NULL;
1162
}
1163

1164 1165 1166 1167 1168 1169
static void TsStorageDelete( ts_storage_t *p_storage )
{
    while( p_storage->i_cmd_r < p_storage->i_cmd_w )
    {
        ts_cmd_t cmd;

1170
        TsStoragePopCmd( p_storage,