input_internal.h 14.9 KB
Newer Older
Laurent Aimar's avatar
Laurent Aimar committed
1
/*****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
2
 * input_internal.h: Internal input structures
Laurent Aimar's avatar
Laurent Aimar committed
3
 *****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
4
 * Copyright (C) 1998-2006 the VideoLAN team
Antoine Cellerier's avatar
Antoine Cellerier committed
5
 * $Id$
Laurent Aimar's avatar
Laurent Aimar committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
 * 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
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Laurent Aimar's avatar
Laurent Aimar committed
22 23
 *****************************************************************************/

24 25 26 27
#if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
# error This header file can only be included from LibVLC.
#endif

Laurent Aimar's avatar
Laurent Aimar committed
28 29 30
#ifndef _INPUT_INTERNAL_H
#define _INPUT_INTERNAL_H 1

Clément Stenac's avatar
Clément Stenac committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
#include <vlc_access.h>
#include <vlc_demux.h>
#include <vlc_input.h>

/*****************************************************************************
 *  Private input fields
 *****************************************************************************/
/* input_source_t: gathers all information per input source */
typedef struct
{
    /* Input item description */
    input_item_t *p_item;

    /* Access/Stream/Demux plugins */
    access_t *p_access;
    stream_t *p_stream;
    demux_t  *p_demux;

    /* Title infos for that input */
Antoine Cellerier's avatar
Antoine Cellerier committed
50
    bool         b_title_demux; /* Titles/Seekpoints provided by demux */
Clément Stenac's avatar
Clément Stenac committed
51 52 53 54 55 56 57 58 59 60 61 62
    int          i_title;
    input_title_t **title;

    int i_title_offset;
    int i_seekpoint_offset;

    int i_title_start;
    int i_title_end;
    int i_seekpoint_start;
    int i_seekpoint_end;

    /* Properties */
63 64 65
    bool b_can_pause;
    bool b_can_pace_control;
    bool b_can_rate_control;
66
    bool b_can_stream_record;
67
    bool b_rescale_ts;
68

Antoine Cellerier's avatar
Antoine Cellerier committed
69
    bool       b_eof;   /* eof of demuxer */
70
    double     f_fps;
Clément Stenac's avatar
Clément Stenac committed
71 72 73 74 75 76 77 78 79

    /* Clock average variation */
    int     i_cr_average;

} input_source_t;

/** Private input fields */
struct input_thread_private_t
{
80 81 82
    /* Object's event manager */
    vlc_event_manager_t event_manager;

Clément Stenac's avatar
Clément Stenac committed
83
    /* Global properties */
Antoine Cellerier's avatar
Antoine Cellerier committed
84 85
    bool        b_can_pause;
    bool        b_can_rate_control;
Clément Stenac's avatar
Clément Stenac committed
86 87

    int         i_rate;
88
    bool        b_recording;
Clément Stenac's avatar
Clément Stenac committed
89 90 91
    /* */
    int64_t     i_start;    /* :start-time,0 by default */
    int64_t     i_stop;     /* :stop-time, 0 if none */
92
    int64_t     i_run;      /* :run-time, 0 if none */
Clément Stenac's avatar
Clément Stenac committed
93 94 95 96 97 98 99 100 101 102 103 104

    /* Title infos FIXME multi-input (not easy) ? */
    int          i_title;
    input_title_t **title;

    int i_title_offset;
    int i_seekpoint_offset;

    /* User bookmarks FIXME won't be easy with multiples input */
    int         i_bookmark;
    seekpoint_t **bookmark;

105 106 107 108
    /* Input attachment */
    int i_attachment;
    input_attachment_t **attachment;

Clément Stenac's avatar
Clément Stenac committed
109
    /* Output */
Antoine Cellerier's avatar
Antoine Cellerier committed
110
    es_out_t        *p_es_out;
Clément Stenac's avatar
Clément Stenac committed
111
    sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
Antoine Cellerier's avatar
Antoine Cellerier committed
112
    bool            b_out_pace_control; /*     idem ? */
Clément Stenac's avatar
Clément Stenac committed
113 114 115 116 117 118 119

    /* Main input properties */
    input_source_t input;
    /* Slave demuxers (subs, and others) */
    int            i_slave;
    input_source_t **slave;

120
    /* pts delay fixup */
121 122
    struct
    {
123
        int  i_num_faulty;
124 125
        bool b_to_high;
        bool b_auto_adjust;
126 127
    } pts_adjust;

Clément Stenac's avatar
Clément Stenac committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
    /* Stats counters */
    struct {
        counter_t *p_read_packets;
        counter_t *p_read_bytes;
        counter_t *p_input_bitrate;
        counter_t *p_demux_read;
        counter_t *p_demux_bitrate;
        counter_t *p_decoded_audio;
        counter_t *p_decoded_video;
        counter_t *p_decoded_sub;
        counter_t *p_sout_sent_packets;
        counter_t *p_sout_sent_bytes;
        counter_t *p_sout_send_bitrate;
        counter_t *p_played_abuffers;
        counter_t *p_lost_abuffers;
        counter_t *p_displayed_pictures;
        counter_t *p_lost_pictures;
        vlc_mutex_t counters_lock;
    } counters;

    /* Buffer of pending actions */
    vlc_mutex_t lock_control;
150
    vlc_cond_t  wait_control;
Clément Stenac's avatar
Clément Stenac committed
151 152 153
    int i_control;
    struct
    {
154 155
        /* XXX for string value you have to allocate it before calling
         * input_ControlPush */
Clément Stenac's avatar
Clément Stenac committed
156 157 158 159 160 161 162 163
        int         i_type;
        vlc_value_t val;
    } control[INPUT_CONTROL_FIFO_SIZE];
};

/***************************************************************************
 * Internal control helpers
 ***************************************************************************/
Laurent Aimar's avatar
Laurent Aimar committed
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
enum input_control_e
{
    INPUT_CONTROL_SET_DIE,

    INPUT_CONTROL_SET_STATE,

    INPUT_CONTROL_SET_RATE,
    INPUT_CONTROL_SET_RATE_SLOWER,
    INPUT_CONTROL_SET_RATE_FASTER,

    INPUT_CONTROL_SET_POSITION,
    INPUT_CONTROL_SET_POSITION_OFFSET,

    INPUT_CONTROL_SET_TIME,
    INPUT_CONTROL_SET_TIME_OFFSET,

    INPUT_CONTROL_SET_PROGRAM,

    INPUT_CONTROL_SET_TITLE,
    INPUT_CONTROL_SET_TITLE_NEXT,
    INPUT_CONTROL_SET_TITLE_PREV,

    INPUT_CONTROL_SET_SEEKPOINT,
    INPUT_CONTROL_SET_SEEKPOINT_NEXT,
    INPUT_CONTROL_SET_SEEKPOINT_PREV,

    INPUT_CONTROL_SET_BOOKMARK,

    INPUT_CONTROL_SET_ES,
193
    INPUT_CONTROL_RESTART_ES,
194 195 196

    INPUT_CONTROL_SET_AUDIO_DELAY,
    INPUT_CONTROL_SET_SPU_DELAY,
197 198

    INPUT_CONTROL_ADD_SLAVE,
199 200

    INPUT_CONTROL_SET_RECORD_STATE,
Laurent Aimar's avatar
Laurent Aimar committed
201 202 203 204 205 206
};

/* Internal helpers */
static inline void input_ControlPush( input_thread_t *p_input,
                                      int i_type, vlc_value_t *p_val )
{
Clément Stenac's avatar
Clément Stenac committed
207
    vlc_mutex_lock( &p_input->p->lock_control );
Laurent Aimar's avatar
Laurent Aimar committed
208 209 210
    if( i_type == INPUT_CONTROL_SET_DIE )
    {
        /* Special case, empty the control */
Clément Stenac's avatar
Clément Stenac committed
211 212 213
        p_input->p->i_control = 1;
        p_input->p->control[0].i_type = i_type;
        memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
Laurent Aimar's avatar
Laurent Aimar committed
214
    }
215
    else if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
216 217 218 219 220
    {
        msg_Err( p_input, "input control fifo overflow, trashing type=%d",
                 i_type );
    }
    else
Laurent Aimar's avatar
Laurent Aimar committed
221
    {
Clément Stenac's avatar
Clément Stenac committed
222
        p_input->p->control[p_input->p->i_control].i_type = i_type;
Laurent Aimar's avatar
Laurent Aimar committed
223
        if( p_val )
Clément Stenac's avatar
Clément Stenac committed
224
            p_input->p->control[p_input->p->i_control].val = *p_val;
Laurent Aimar's avatar
Laurent Aimar committed
225
        else
Clément Stenac's avatar
Clément Stenac committed
226
            memset( &p_input->p->control[p_input->p->i_control].val, 0,
Laurent Aimar's avatar
Laurent Aimar committed
227 228
                    sizeof( vlc_value_t ) );

Clément Stenac's avatar
Clément Stenac committed
229
        p_input->p->i_control++;
Laurent Aimar's avatar
Laurent Aimar committed
230
    }
231
    vlc_cond_signal( &p_input->p->wait_control );
Clément Stenac's avatar
Clément Stenac committed
232
    vlc_mutex_unlock( &p_input->p->lock_control );
Laurent Aimar's avatar
Laurent Aimar committed
233 234
}

235 236 237
/** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
 * anyway. */

238
static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
239
{
240
    bool send_event = false;
241 242 243 244 245 246 247 248 249 250

    if( !p_i->p_meta )
        p_i->p_meta = vlc_meta_New();

    vlc_mutex_lock( &p_i->lock );
    int new_status;
    if( preparsed )
        new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
    else
        new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
251
    if( p_i->p_meta->i_status != new_status )
252 253
    {
        p_i->p_meta->i_status = new_status;
254
        send_event = true;
255 256 257 258
    }

    vlc_mutex_unlock( &p_i->lock );

259
    if( send_event )
260 261 262 263 264 265 266 267
    {
        vlc_event_t event;
        event.type = vlc_InputItemPreparsedChanged;
        event.u.input_item_preparsed_changed.new_status = new_status;
        vlc_event_send( &p_i->event_manager, &event );
    }
}

268
static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
269 270 271 272 273 274 275 276 277 278
{
    if( !p_i->p_meta )
        p_i->p_meta = vlc_meta_New();

    if( notfound )
        p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
    else
        p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
}

279
static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
280 281 282 283 284 285 286 287 288 289
{
    if( !p_i->p_meta )
        p_i->p_meta = vlc_meta_New();

    if( artfetched )
        p_i->p_meta->i_status |= ITEM_ART_FETCHED;
    else
        p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
}

290
void input_item_SetHasErrorWhenReading( input_item_t *p_i, bool error );
291

Clément Stenac's avatar
Clément Stenac committed
292 293 294 295 296 297 298
/**********************************************************************
 * Item metadata
 **********************************************************************/
typedef struct playlist_album_t
{
    char *psz_artist;
    char *psz_album;
299
    char *psz_arturl;
300
    bool b_found;
Clément Stenac's avatar
Clément Stenac committed
301 302 303 304 305
} playlist_album_t;

int         input_ArtFind       ( playlist_t *, input_item_t * );
int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );

306 307 308
/* Becarefull; p_item lock HAS to be taken */
void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );

Clément Stenac's avatar
Clément Stenac committed
309 310 311 312
/***************************************************************************
 * Internal prototypes
 ***************************************************************************/

313 314 315
/* misc/stats.c */
input_stats_t *stats_NewInputStats( input_thread_t *p_input );

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
316
/* input.c */
317 318 319
#define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );

320
sout_instance_t * input_DetachSout( input_thread_t *p_input );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
321

Laurent Aimar's avatar
Laurent Aimar committed
322 323
/* var.c */
void input_ControlVarInit ( input_thread_t * );
324
void input_ControlVarStop( input_thread_t * );
Laurent Aimar's avatar
Laurent Aimar committed
325 326 327 328 329 330
void input_ControlVarNavigation( input_thread_t * );
void input_ControlVarTitle( input_thread_t *, int i_title );

void input_ConfigVarInit ( input_thread_t * );

/* stream.c */
331
stream_t *stream_AccessNew( access_t *p_access, bool );
Laurent Aimar's avatar
Laurent Aimar committed
332 333
void stream_AccessDelete( stream_t *s );
void stream_AccessReset( stream_t *s );
334
void stream_AccessUpdate( stream_t *s );
Laurent Aimar's avatar
Laurent Aimar committed
335

336
/* decoder.c */
337 338 339 340 341
void       input_DecoderDiscontinuity( decoder_t * p_dec, bool b_flush );
bool input_DecoderEmpty( decoder_t * p_dec );
int        input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
int        input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
void       input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
Laurent Aimar's avatar
Laurent Aimar committed
342 343

/* es_out.c */
344
es_out_t  *input_EsOutNew( input_thread_t *, int i_rate );
Laurent Aimar's avatar
 
Laurent Aimar committed
345
void       input_EsOutDelete( es_out_t * );
Laurent Aimar's avatar
Laurent Aimar committed
346
es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
Laurent Aimar's avatar
 
Laurent Aimar committed
347
void       input_EsOutSetDelay( es_out_t *, int i_cat, int64_t );
348
int        input_EsOutSetRecord(  es_out_t *, bool b_record );
349
void       input_EsOutChangeRate( es_out_t *, int );
350
void       input_EsOutChangeState( es_out_t * );
Laurent Aimar's avatar
Laurent Aimar committed
351
void       input_EsOutChangePosition( es_out_t * );
352
bool input_EsOutDecodersEmpty( es_out_t * );
Laurent Aimar's avatar
Laurent Aimar committed
353 354 355 356 357 358 359 360 361 362 363 364 365 366

/* clock.c */
enum /* Synchro states */
{
    SYNCHRO_OK     = 0,
    SYNCHRO_START  = 1,
    SYNCHRO_REINIT = 2,
};

typedef struct
{
    /* Synchronization information */
    mtime_t                 delta_cr;
    mtime_t                 cr_ref, sysdate_ref;
367
    mtime_t                 last_sysdate;
Laurent Aimar's avatar
Laurent Aimar committed
368 369 370
    mtime_t                 last_cr; /* reference to detect unexpected stream
                                      * discontinuities                      */
    mtime_t                 last_pts;
371
    mtime_t                 last_update;
Laurent Aimar's avatar
Laurent Aimar committed
372 373
    int                     i_synchro_state;

Antoine Cellerier's avatar
Antoine Cellerier committed
374
    bool                    b_master;
Laurent Aimar's avatar
Laurent Aimar committed
375

376 377
    int                     i_rate;

Laurent Aimar's avatar
Laurent Aimar committed
378 379
    /* Config */
    int                     i_cr_average;
380
    int                     i_delta_cr_residue;
Laurent Aimar's avatar
Laurent Aimar committed
381 382
} input_clock_t;

383
void    input_ClockInit( input_clock_t *, bool b_master, int i_cr_average, int i_rate );
Laurent Aimar's avatar
Laurent Aimar committed
384
void    input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
385
void    input_ClockResetPCR( input_clock_t * );
Laurent Aimar's avatar
Laurent Aimar committed
386
mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
387
void    input_ClockSetRate( input_clock_t *cl, int i_rate );
Laurent Aimar's avatar
Laurent Aimar committed
388 389

/* Subtitles */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
390
char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
391 392
int subtitles_Filter( const char *);

393
static inline void input_ChangeStateWithVarCallback( input_thread_t *p_input, int i_state, bool callback )
394
{
395
    const bool changed = p_input->i_state != i_state;
396

397 398 399 400 401
    p_input->i_state = i_state;
    if( i_state == ERROR_S )
        p_input->b_error = true;
    else if( i_state == END_S )
        p_input->b_eof = true;
402

403
    input_item_SetHasErrorWhenReading( p_input->p->input.p_item, (i_state == ERROR_S) );
404

405
    if( callback )
406
    {
407
        var_SetInteger( p_input, "state", i_state );
408
    }
409 410 411
    else
    {
        vlc_value_t val;
412
        val.i_int = i_state;
413 414
        var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
    }
415 416 417 418
    if( changed )
    {
        vlc_event_t event;
        event.type = vlc_InputStateChanged;
419
        event.u.input_state_changed.new_state = i_state;
420 421
        vlc_event_send( &p_input->p->event_manager, &event );
    }
422 423
}

424 425 426 427 428
static inline void input_ChangeState( input_thread_t *p_input, int state )
{
    input_ChangeStateWithVarCallback( p_input, state, true );
}

429 430 431
/* Helpers FIXME to export without input_ prefix */
char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );

432
#define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
433

Clément Stenac's avatar
Clément Stenac committed
434 435
/* Access */

436 437
#define access_New( a, b, c, d ) __access_New(VLC_OBJECT(a), b, c, d )
access_t * __access_New( vlc_object_t *p_obj, const char *psz_access,
438
                          const char *psz_demux, const char *psz_path );
439
access_t * access_FilterNew( access_t *p_source,
Clément Stenac's avatar
Clément Stenac committed
440
                              const char *psz_access_filter );
441
void access_Delete( access_t * );
Clément Stenac's avatar
Clément Stenac committed
442 443 444 445 446

/* Demuxer */
#include <vlc_demux.h>

/* stream_t *s could be null and then it mean a access+demux in one */
447 448
#define demux_New( a, b, c, d, e, f,g ) __demux_New(VLC_OBJECT(a),b,c,d,e,f,g)
demux_t *__demux_New(vlc_object_t *p_obj, const char *psz_access, const char *psz_demux, const char *psz_path, stream_t *s, es_out_t *out, bool );
Clément Stenac's avatar
Clément Stenac committed
449

450
void demux_Delete(demux_t *);
Clément Stenac's avatar
Clément Stenac committed
451

452
static inline int demux_Demux( demux_t *p_demux )
Clément Stenac's avatar
Clément Stenac committed
453 454 455
{
    return p_demux->pf_demux( p_demux );
}
456
static inline int demux_vaControl( demux_t *p_demux, int i_query, va_list args )
Clément Stenac's avatar
Clément Stenac committed
457 458 459
{
    return p_demux->pf_control( p_demux, i_query, args );
}
460
static inline int demux_Control( demux_t *p_demux, int i_query, ... )
Clément Stenac's avatar
Clément Stenac committed
461 462 463 464 465
{
    va_list args;
    int     i_result;

    va_start( args, i_query );
466
    i_result = demux_vaControl( p_demux, i_query, args );
Clément Stenac's avatar
Clément Stenac committed
467 468 469 470
    va_end( args );
    return i_result;
}

471 472 473 474 475 476 477 478
/* Stream */
/**
 * stream_t definition
 */
struct stream_t
{
    VLC_COMMON_MEMBERS

479
    /*block_t *(*pf_block)  ( stream_t *, int i_size );*/
480 481
    int      (*pf_read)   ( stream_t *, void *p_read, unsigned int i_read );
    int      (*pf_peek)   ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
482 483 484 485 486 487 488 489
    int      (*pf_control)( stream_t *, int i_query, va_list );
    void     (*pf_destroy)( stream_t *);

    stream_sys_t *p_sys;

    /* UTF-16 and UTF-32 file reading */
    vlc_iconv_t     conv;
    int             i_char_width;
Antoine Cellerier's avatar
Antoine Cellerier committed
490
    bool            b_little_endian;
491 492
};

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
493
#include <libvlc.h>
494 495 496 497

static inline stream_t *vlc_stream_create( vlc_object_t *obj )
{
    return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
498
                                          VLC_OBJECT_GENERIC, "stream" );
499
}
500 501

#endif