es_out_timeshift.c 44 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 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

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

#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <assert.h>
#if defined (WIN32) && !defined (UNDER_CE)
#  include <direct.h>
#endif
#ifdef HAVE_SYS_STAT_H
#   include <sys/stat.h>
#endif

#include <vlc_common.h>
#include <vlc_charset.h>

#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
 *****************************************************************************/

56 57 58 59 60 61 62
/* 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

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

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

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

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

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

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
    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
        {
            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;
124 125 126 127 128 129 130
        struct
        {
            /* FIXME Really too big (double make the whole thing too big) */
            double  f_position;
            mtime_t i_time;
            mtime_t i_length;
        } times;
131
    };
Laurent Aimar's avatar
Laurent Aimar committed
132 133
} ts_cmd_control_t;

134
typedef struct attribute_packed
135
{
136
    int8_t  i_type;
137
    mtime_t i_date;
138 139
    union
    {
Laurent Aimar's avatar
Laurent Aimar committed
140 141 142 143
        ts_cmd_add_t     add;
        ts_cmd_del_t     del;
        ts_cmd_send_t    send;
        ts_cmd_control_t control;
144 145 146
    };
} ts_cmd_t;

147 148 149 150 151 152
typedef struct ts_storage_t ts_storage_t;
struct ts_storage_t
{
    ts_storage_t *p_next;

    /* */
153
    char    *psz_file;  /* Filename */
154
    size_t  i_file_max; /* Max size in bytes */
155 156 157
    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 */
158 159 160 161 162 163 164 165

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

166 167 168 169 170 171 172
typedef struct
{
    VLC_COMMON_MEMBERS

    /* */
    input_thread_t *p_input;
    es_out_t       *p_out;
173 174
    int64_t        i_tmp_size_max;
    const char     *psz_tmp_path;
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189

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

190 191 192
    /* */
    mtime_t        i_buffering_delay;

193
    /* */
194 195 196
    ts_storage_t   *p_storage_r;
    ts_storage_t   *p_storage_w;

197 198 199 200
    mtime_t        i_cmd_delay;

} ts_thread_t;

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
struct es_out_id_t
{
    es_out_id_t *p_es;
};

struct es_out_sys_t
{
    input_thread_t *p_input;
	es_out_t       *p_out;

    /* 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;
220
    ts_thread_t   *p_thread;
221

222 223 224 225 226
    /* */
    bool           b_input_paused;
    bool           b_input_paused_source;
    int            i_input_rate;
    int            i_input_rate_source;
227

228 229 230 231 232 233 234 235 236 237 238
    /* */
    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 * );

239
static int          TsStart( es_out_t * );
Laurent Aimar's avatar
Laurent Aimar committed
240 241
static void         TsAutoStop( es_out_t * );

242
static void         TsStop( ts_thread_t * );
243
static void         TsPushCmd( ts_thread_t *, ts_cmd_t * );
244
static int          TsPopCmdLocked( ts_thread_t *, ts_cmd_t *, bool b_flush );
245
static bool         TsHasCmd( ts_thread_t * );
Laurent Aimar's avatar
Laurent Aimar committed
246
static bool         TsIsUnused( ts_thread_t * );
247 248
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 );
249

250 251
static void         *TsRun( vlc_object_t * );

252
static ts_storage_t *TsStorageNew( const char *psz_path, int64_t i_tmp_size_max );
253
static void         TsStorageDelete( ts_storage_t * );
254 255
static void         TsStoragePack( ts_storage_t *p_storage );
static bool         TsStorageIsFull( ts_storage_t *, const ts_cmd_t *p_cmd );
256
static bool         TsStorageIsEmpty( ts_storage_t * );
257
static void         TsStoragePushCmd( ts_storage_t *, const ts_cmd_t *p_cmd, bool b_flush );
258
static void         TsStoragePopCmd( ts_storage_t *p_storage, ts_cmd_t *p_cmd, bool b_flush );
259

260 261
static void CmdClean( ts_cmd_t * );
static void cmd_cleanup_routine( void *p ) { CmdClean( p ); }
262 263 264 265 266 267

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

268 269 270 271 272 273
/* */
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 */
274 275 276 277 278
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 * );

279
/* File helpers */
280
static char *GetTmpPath( char *psz_path );
281
static FILE *GetTmpFile( char **ppsz_file, const char *psz_path );
282 283 284 285

/*****************************************************************************
 * input_EsOutTimeshiftNew:
 *****************************************************************************/
286
es_out_t *input_EsOutTimeshiftNew( input_thread_t *p_input, es_out_t *p_next_out, int i_rate )
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
{
    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;
    p_out->b_sout     = p_input->p->p_sout != NULL;

    /* */
309 310
    p_sys->b_input_paused = false;
    p_sys->b_input_paused_source = false;
311
    p_sys->p_input = p_input;
312 313 314
    p_sys->i_input_rate = i_rate;
    p_sys->i_input_rate_source = i_rate;

315 316
    p_sys->p_out = p_next_out;
    vlc_mutex_init_recursive( &p_sys->lock );
317

318
    p_sys->b_delayed = false;
319
    p_sys->p_thread = NULL;
320 321 322

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

323 324 325 326 327 328 329 330 331 332 333 334
    /* */
    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 );
    msg_Dbg( p_input, "using timeshift granularity of %d bytes",
             (int)p_sys->i_tmp_size_max );

    char *psz_tmp_path = var_CreateGetNonEmptyString( p_input, "input-timeshift-path" );
    p_sys->psz_tmp_path = GetTmpPath( psz_tmp_path );
    msg_Dbg( p_input, "using timeshift  path '%s'", p_sys->psz_tmp_path );
335

336 337 338 339 340 341 342 343 344 345
#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

346 347 348 349 350 351 352 353 354 355
    return p_out;
}

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

356
    if( p_sys->b_delayed )
357 358 359 360
    {
        TsStop( p_sys->p_thread );
        p_sys->b_delayed = false;
    }
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382

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

Laurent Aimar's avatar
Laurent Aimar committed
383 384
    TsAutoStop( p_out );

385 386 387 388 389 390 391 392 393 394
    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 )
395
        TsPushCmd( p_sys->p_thread, &cmd );
396
    else
397
        CmdExecuteAdd( p_sys->p_out, &cmd );
398 399 400 401 402 403 404 405 406 407 408 409 410

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

Laurent Aimar's avatar
Laurent Aimar committed
411 412
    TsAutoStop( p_out );

413 414
    CmdInitSend( &cmd, p_es, p_block );
    if( p_sys->b_delayed )
415
        TsPushCmd( p_sys->p_thread, &cmd );
416
    else
417
        i_ret = CmdExecuteSend( p_sys->p_out, &cmd) ;
418 419 420 421 422 423 424 425 426 427 428 429

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

Laurent Aimar's avatar
Laurent Aimar committed
430 431
    TsAutoStop( p_out );

432 433
    CmdInitDel( &cmd, p_es );
    if( p_sys->b_delayed )
434
        TsPushCmd( p_sys->p_thread, &cmd );
435
    else
436
        CmdExecuteDel( p_sys->p_out, &cmd );
437 438 439 440 441

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

    vlc_mutex_unlock( &p_sys->lock );
}
442 443 444 445 446

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

447
    if( p_sys->b_delayed && TsHasCmd( p_sys->p_thread ) )
448 449 450 451 452 453 454 455 456 457 458 459
        *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 )
    {
460
        assert( !p_sys->p_input->p->b_can_pace_control );
461 462 463 464 465 466 467 468 469
        *pi_wakeup = 0;
    }
    else
    {
        *pi_wakeup = es_out_GetWakeup( p_sys->p_out );
    }

    return VLC_SUCCESS;
}
470
static int ControlLockedGetBuffering( es_out_t *p_out, bool *pb_buffering )
471 472 473 474 475 476
{
    es_out_sys_t *p_sys = p_out->p_sys;

    if( p_sys->b_delayed )
        *pb_buffering = true;
    else
477
        *pb_buffering = es_out_GetBuffering( p_sys->p_out );
478 479 480 481 482 483

    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;
484 485 486 487 488 489 490 491 492
    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;
493
        if( !p_sys->p_input->p->b_can_pace_control )
494 495 496 497 498 499 500 501 502 503 504 505 506 507
        {
            if( !p_sys->b_delayed )
                TsStart( p_out );
            if( p_sys->b_delayed )
                i_ret = TsChangePause( p_sys->p_thread, b_source_paused, b_paused, i_date );
        }
        else
        {
            /* XXX we may do it BUT it would be better to finish the clock clean up+improvments
             * and so be able to advertize correctly pace control property in access
             * module */
            msg_Err( p_sys->p_input, "EsOutTimeshift does not work with streams that have space control" );
        }
    }
508

509
    if( !i_ret )
510
    {
511 512
        p_sys->b_input_paused_source = b_source_paused;
        p_sys->b_input_paused = b_paused;
513
    }
514
    return i_ret;
515 516 517 518
}
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;
519
    int i_ret;
520

521 522 523 524 525
    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
526
    {
527
        i_ret = VLC_EGENERIC;
528
        if( !p_sys->p_input->p->b_can_pace_control )
529 530 531 532 533 534 535 536 537 538 539 540 541 542
        {
            if( !p_sys->b_delayed )
                TsStart( p_out );
            if( p_sys->b_delayed )
                i_ret = TsChangeRate( p_sys->p_thread, i_src_rate, i_rate );
        }
        else
        {
            /* XXX we may do it BUT it would be better to finish the clock clean up+improvments
             * and so be able to advertize correctly pace control property in access
             * module */
            msg_Err( p_sys->p_input, "EsOutTimeshift does not work with streams that have space control" );
        }

543
    }
544 545 546 547 548 549 550

    if( !i_ret )
    {
        p_sys->i_input_rate_source = i_src_rate;
        p_sys->i_input_rate = i_rate;
    }
    return i_ret;
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
}
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
567
    return es_out_SetFrameNext( p_sys->p_out );
568 569
}

570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
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 )
    {
    /* Invalid query 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_SET_DELAY:
    case ES_OUT_SET_RECORD_STATE:
        assert(0);
        return VLC_EGENERIC;

    /* Pass-through control */
    case ES_OUT_SET_ACTIVE:
    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:
    case ES_OUT_DEL_GROUP:
    case ES_OUT_SET_ES:
    case ES_OUT_RESTART_ES:
    case ES_OUT_SET_ES_DEFAULT:
    case ES_OUT_SET_ES_STATE:
    case ES_OUT_SET_ES_FMT:
601
    case ES_OUT_SET_TIMES:
602 603 604 605 606 607
    {
        ts_cmd_t cmd;
        if( CmdInitControl( &cmd, i_query, args, p_sys->b_delayed ) )
            return VLC_EGENERIC;
        if( p_sys->b_delayed )
        {
608
            TsPushCmd( p_sys->p_thread, &cmd );
609 610
            return VLC_SUCCESS;
        }
611
        return CmdExecuteControl( p_sys->p_out, &cmd );
612 613
    }

614 615 616 617 618 619 620 621 622 623 624
    /* 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;
        }
625
        return es_out_Control( p_sys->p_out, ES_OUT_GET_ES_STATE, p_es->p_es, pb_enabled );
626 627 628
    }

    /* Special internal input control */
629 630 631 632 633
    case ES_OUT_GET_EMPTY:
    {
        bool *pb_empty = (bool*)va_arg( args, bool* );
        return ControlLockedGetEmpty( p_out, pb_empty );
    }
634
    case ES_OUT_GET_WAKE_UP: /* TODO ? */
635 636 637 638
    {
        mtime_t *pi_wakeup = (mtime_t*)va_arg( args, mtime_t* );
        return ControlLockedGetWakeup( p_out, pi_wakeup );
    }
639
    case ES_OUT_GET_BUFFERING:
640 641
    {
        bool *pb_buffering = (bool *)va_arg( args, bool* );
642
        return ControlLockedGetBuffering( p_out, pb_buffering );
643
    }
644
    case ES_OUT_SET_PAUSE_STATE:
645 646 647 648 649 650 651
    {
        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 );
    }
652
    case ES_OUT_SET_RATE:
653 654 655 656 657 658
    {
        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 );
    }
659
    case ES_OUT_SET_TIME:
660 661 662 663 664
    {
        const mtime_t i_date = (mtime_t)va_arg( args, mtime_t );

        return ControlLockedSetTime( p_out, i_date );
    }
665
    case ES_OUT_SET_FRAME_NEXT:
666 667 668
    {
        return ControlLockedSetFrameNext( p_out );
    }
669 670 671 672 673 674 675 676 677 678 679 680 681

    default:
        msg_Err( p_sys->p_input, "Unknown es_out_Control query !" );
        assert(0);
        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 );
Laurent Aimar's avatar
Laurent Aimar committed
682 683 684

    TsAutoStop( p_out );

685
    i_ret = ControlLocked( p_out, i_query, args );
Laurent Aimar's avatar
Laurent Aimar committed
686

687 688 689 690 691
    vlc_mutex_unlock( &p_sys->lock );

    return i_ret;
}

692 693 694
/*****************************************************************************
 *
 *****************************************************************************/
695 696 697 698 699 700 701
static void TsDestructor( vlc_object_t *p_this )
{
    ts_thread_t *p_ts = (ts_thread_t*)p_this;

    vlc_cond_destroy( &p_ts->wait );
    vlc_mutex_destroy( &p_ts->lock );
}
702 703 704
static int TsStart( es_out_t *p_out )
{
    es_out_sys_t *p_sys = p_out->p_sys;
705
    ts_thread_t *p_ts;
706 707 708

    assert( !p_sys->b_delayed );

709 710 711
    p_sys->p_thread = p_ts = vlc_custom_create( p_sys->p_input, sizeof(ts_thread_t),
                                                VLC_OBJECT_GENERIC, "es out timeshift" );
    if( !p_ts )
712 713
        return VLC_EGENERIC;

714 715
    p_ts->i_tmp_size_max = p_sys->i_tmp_size_max;
    p_ts->psz_tmp_path = p_sys->psz_tmp_path;
716 717 718 719 720 721 722 723 724 725
    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;
726
    p_ts->i_buffering_delay = 0;
727
    p_ts->i_cmd_delay = 0;
728 729
    p_ts->p_storage_r = NULL;
    p_ts->p_storage_w = NULL;
730 731 732

    vlc_object_set_destructor( p_ts, TsDestructor );

733
    p_sys->b_delayed = true;
Laurent Aimar's avatar
Laurent Aimar committed
734
    if( vlc_thread_create( p_ts, "es out timeshift",
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
735
                           TsRun, VLC_THREAD_PRIORITY_INPUT ) )
736 737
    {
        msg_Err( p_sys->p_input, "cannot create input thread" );
738

Laurent Aimar's avatar
Laurent Aimar committed
739
        vlc_object_release( p_ts );
740 741 742 743 744 745 746

        p_sys->b_delayed = false;
        return VLC_EGENERIC;
    }

    return VLC_SUCCESS;
}
Laurent Aimar's avatar
Laurent Aimar committed
747 748 749 750 751 752 753 754 755 756 757 758
static void TsAutoStop( es_out_t *p_out )
{
    es_out_sys_t *p_sys = p_out->p_sys;

    if( !p_sys->b_delayed || !TsIsUnused( p_sys->p_thread ) )
        return;

    msg_Warn( p_sys->p_input, "es out timeshift: auto stop" );
    TsStop( p_sys->p_thread );

    p_sys->b_delayed = false;
}
759
static void TsStop( ts_thread_t *p_ts )
760
{
761 762
    vlc_object_kill( p_ts );
    vlc_thread_join( p_ts );
763

764
    vlc_mutex_lock( &p_ts->lock );
Laurent Aimar's avatar
Laurent Aimar committed
765 766 767 768
    for( ;; )
    {
        ts_cmd_t cmd;

769
        if( TsPopCmdLocked( p_ts, &cmd, true ) )
Laurent Aimar's avatar
Laurent Aimar committed
770 771 772 773
            break;

        CmdClean( &cmd );
    }
774 775 776
    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 );
777
    vlc_mutex_unlock( &p_ts->lock );
Laurent Aimar's avatar
Laurent Aimar committed
778

779
    vlc_object_release( p_ts );
780
}
781
static void TsPushCmd( ts_thread_t *p_ts, ts_cmd_t *p_cmd )
782
{
783
    vlc_mutex_lock( &p_ts->lock );
784

785
    if( !p_ts->p_storage_w || TsStorageIsFull( p_ts->p_storage_w, p_cmd ) )
786
    {
787
        ts_storage_t *p_storage = TsStorageNew( p_ts->psz_tmp_path, p_ts->i_tmp_size_max );
788

789 790 791
        if( !p_storage )
        {
            CmdClean( p_cmd );
792 793
            vlc_mutex_unlock( &p_ts->lock );
            /* TODO warn the user (but only once) */
794 795
            return;
        }
796

797 798 799 800 801 802
        if( !p_ts->p_storage_w )
        {
            p_ts->p_storage_r = p_ts->p_storage_w = p_storage;
        }
        else
        {
803
            TsStoragePack( p_ts->p_storage_w );
804 805 806
            p_ts->p_storage_w->p_next = p_storage;
            p_ts->p_storage_w = p_storage;
        }
807
    }
808

809
    /* TODO return error and warn the user (but only once) */
810
    TsStoragePushCmd( p_ts->p_storage_w, p_cmd, p_ts->p_storage_r == p_ts->p_storage_w );
811 812 813 814

    vlc_cond_signal( &p_ts->wait );

    vlc_mutex_unlock( &p_ts->lock );
815
}
816
static int TsPopCmdLocked( ts_thread_t *p_ts, ts_cmd_t *p_cmd, bool b_flush )
817
{
818
    vlc_assert_locked( &p_ts->lock );
819

820
    if( TsStorageIsEmpty( p_ts->p_storage_r ) )
821 822
        return VLC_EGENERIC;

823
    TsStoragePopCmd( p_ts->p_storage_r, p_cmd, b_flush );
824 825 826 827 828 829 830 831 832 833

    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;
    }
834 835 836

    return VLC_SUCCESS;
}
837
static bool TsHasCmd( ts_thread_t *p_ts )
838
{
839
    bool b_cmd;
840

841
    vlc_mutex_lock( &p_ts->lock );
842
    b_cmd =  TsStorageIsEmpty( p_ts->p_storage_r );
843 844 845 846
    vlc_mutex_unlock( &p_ts->lock );

    return b_cmd;
}
Laurent Aimar's avatar
Laurent Aimar committed
847 848 849 850 851 852 853
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 &&
854
               TsStorageIsEmpty( p_ts->p_storage_r );
Laurent Aimar's avatar
Laurent Aimar committed
855 856 857 858
    vlc_mutex_unlock( &p_ts->lock );

    return b_unused;
}
859 860 861
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 );
862 863 864 865 866

    int i_ret;
    if( b_paused )
    {
        assert( !b_source_paused );
867
        i_ret = es_out_SetPauseState( p_ts->p_out, true, true, i_date );
868 869 870
    }
    else
    {
871
        i_ret = es_out_SetPauseState( p_ts->p_out, false, false, i_date );
872 873 874 875 876 877
    }

    if( !i_ret )
    {
        if( !b_paused )
        {
878
            assert( p_ts->i_pause_date > 0 );
879

880
            p_ts->i_cmd_delay += i_date - p_ts->i_pause_date;
881 882
        }

883 884
        p_ts->b_paused = b_paused;
        p_ts->i_pause_date = i_date;
885

886
        vlc_cond_signal( &p_ts->wait );
887
    }
888
    vlc_mutex_unlock( &p_ts->lock );
889 890
    return i_ret;
}
891
static int TsChangeRate( ts_thread_t *p_ts, int i_src_rate, int i_rate )
892
{
893
    int i_ret;
894

895 896
    vlc_mutex_lock( &p_ts->lock );
    p_ts->i_cmd_delay += p_ts->i_rate_delay;
897

898 899 900 901
    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;
902

903 904
    i_ret = es_out_SetRate( p_ts->p_out, i_rate, i_rate );
    vlc_mutex_unlock( &p_ts->lock );
905

906
    return i_ret;
907 908
}

909 910
static void *TsRun( vlc_object_t *p_thread )
{
911
    ts_thread_t *p_ts = (ts_thread_t*)p_thread;
912
    mtime_t i_buffering_date = -1;
913 914 915 916

    for( ;; )
    {
        ts_cmd_t cmd;
917
        mtime_t  i_deadline;
918
        bool b_buffering;
919

920
        /* Pop a command to execute */
921 922
        vlc_mutex_lock( &p_ts->lock );
        mutex_cleanup_push( &p_ts->lock );
923

924 925 926
        for( ;; )
        {
            const int canc = vlc_savecancel();
927
            b_buffering = es_out_GetBuffering( p_ts->p_out );
928

929
            if( ( !p_ts->b_paused || b_buffering ) && !TsPopCmdLocked( p_ts, &cmd, false ) )
930 931
            {
                vlc_restorecancel( canc );
932
                break;
933 934
            }
            vlc_restorecancel( canc );
935

936
            vlc_cond_wait( &p_ts->wait, &p_ts->lock );
937 938 939 940 941 942 943 944 945 946 947 948 949 950
        }

        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;
        }
951

952 953
        if( p_ts->i_rate_date < 0 )
            p_ts->i_rate_date = cmd.i_date;
954

955 956
        p_ts->i_rate_delay = 0;
        if( p_ts->i_rate_source != p_ts->i_rate )
957
        {
958 959
            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;
960
        }
961
        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 )
962
        {
963 964
            const int canc = vlc_savecancel();

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

968
            p_ts->i_cmd_delay = 0;
969
            p_ts->i_buffering_delay = 0;
970

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

975
            if( !es_out_SetRate( p_ts->p_out, p_ts->i_rate_source, p_ts->i_rate ) )
976
            {
977
                vlc_value_t val = { .i_int = p_ts->i_rate };
978 979 980
                /* Warn back input
                 * FIXME it is perfectly safe BUT it is ugly as it may hide a
                 * rate change requested by user */
981
                input_ControlPush( p_ts->p_input, INPUT_CONTROL_SET_RATE, &val );
982
            }
983 984

            vlc_restorecancel( canc );
985
        }
986
        i_deadline = cmd.i_date + p_ts->i_cmd_delay + p_ts->i_rate_delay + p_ts->i_buffering_delay;
987 988

        vlc_cleanup_run();
989 990 991 992 993

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

994
        mwait( i_deadline );
995 996

        vlc_cleanup_pop();
997

998
        /* Execute the command  */
999 1000 1001 1002
        const int canc = vlc_savecancel();
        switch( cmd.i_type )
        {
        case C_ADD:
1003
            CmdExecuteAdd( p_ts->p_out, &cmd );
1004 1005 1006
            CmdCleanAdd( &cmd );
            break;
        case C_SEND:
1007
            CmdExecuteSend( p_ts->p_out, &cmd );
1008 1009 1010
            CmdCleanSend( &cmd );
            break;
        case C_CONTROL:
1011
            CmdExecuteControl( p_ts->p_out, &cmd );
1012 1013 1014
            CmdCleanControl( &cmd );
            break;
        case C_DEL:
1015
            CmdExecuteDel( p_ts->p_out, &cmd );
1016 1017 1018 1019 1020
            break;
        default:
            assert(0);
            break;
        }
1021
        vlc_restorecancel( canc );
1022 1023 1024 1025 1026
    }

    return NULL;
}

1027 1028 1029
/*****************************************************************************
 *
 *****************************************************************************/
1030
static ts_storage_t *TsStorageNew( const char *psz_tmp_path, int64_t i_tmp_size_max )
1031
{
1032
    ts_storage_t *p_storage = calloc( 1, sizeof(ts_storage_t) );
1033 1034 1035 1036 1037 1038
    if( !p_storage )
        return NULL;

    /* */
    p_storage->p_next = NULL;

1039 1040 1041 1042 1043 1044 1045
    /* */
    p_storage->i_file_max = i_tmp_size_max;
    p_storage->i_file_size = 0;
    p_storage->p_filew = GetTmpFile( &p_storage->psz_file, psz_tmp_path );
    if( p_storage->psz_file )
        p_storage->p_filer = utf8_fopen( p_storage->psz_file, "rb" );

1046 1047 1048
    /* */
    p_storage->i_cmd_w = 0;
    p_storage->i_cmd_r = 0;
1049
    p_storage->i_cmd_max = 30000;
1050
    p_storage->p_cmd = malloc( p_storage->i_cmd_max * sizeof(*p_storage->p_cmd) );
1051
    //fprintf( stderr, "\nSTORAGE name=%s size=%d kbytes\n", p_storage->psz_file, p_storage->i_cmd_max * sizeof(*p_storage->p_cmd) /1024 );
1052

1053
    if( !p_storage->p_cmd || !p_storage->p_filew || !p_storage->p_filer )
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
    {
        TsStorageDelete( p_storage );
        return NULL;
    }
    return p_storage;
}
static void TsStorageDelete( ts_storage_t *p_storage )
{
    while( p_storage->i_cmd_r < p_storage->i_cmd_w )
    {
        ts_cmd_t cmd;

1066
        TsStoragePopCmd( p_storage, &cmd, true );
1067 1068 1069 1070 1071

        CmdClean( &cmd );
    }
    free( p_storage->p_cmd );

1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
    if( p_storage->p_filer )
        fclose( p_storage->p_filer );
    if( p_storage->p_filew )
        fclose( p_storage->p_filew );

    if( p_storage->psz_file )
    {
        utf8_unlink( p_storage->psz_file );
        free( p_storage->psz_file );
    }

1083 1084
    free( p_storage );
}
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
static void TsStoragePack( ts_storage_t *p_storage )
{
    /* Try to release a bit of memory */
    if( p_storage->i_cmd_w >= p_storage->i_cmd_max )
        return;

    p_storage->i_cmd_max = __MAX( p_storage->i_cmd_w, 1 );

    ts_cmd_t *p_new = realloc( p_storage->p_cmd, p_storage->i_cmd_max * sizeof(*p_storage->p_cmd) );
    if( p_new )
        p_storage->p_cmd = p_new;
}
static bool TsStorageIsFull( ts_storage_t *p_storage, const ts_cmd_t *p_cmd )
1098
{
1099 1100 1101 1102 1103 1104 1105
    if( p_cmd && p_cmd->i_type == C_SEND && p_storage->i_cmd_w > 0 )
    {
        size_t i_size = sizeof(*p_cmd->send.p_block) + p_cmd->send.p_block->i_buffer;

        if( p_storage->i_file_size + i_size >= p_storage->i_file_max )
            return true;
    }
Laurent Aimar's avatar