git.sesse.net Git - vlc/blob - src/input/input_internal.h

   1 /*****************************************************************************
   2  * input_internal.h: Internal input structures
   3  *****************************************************************************
   4  * Copyright (C) 1998-2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
  25 # error This header file can only be included from LibVLC.
  26 #endif
  27
  28 #ifndef _INPUT_INTERNAL_H
  29 #define _INPUT_INTERNAL_H 1
  30
  31 #include <vlc_access.h>
  32 #include <vlc_demux.h>
  33 #include <vlc_input.h>
  34
  35 /*****************************************************************************
  36  *  Private input fields
  37  *****************************************************************************/
  38 /* input_source_t: gathers all information per input source */
  39 typedef struct
  40 {
  41     /* Input item description */
  42     input_item_t *p_item;
  43
  44     /* Access/Stream/Demux plugins */
  45     access_t *p_access;
  46     stream_t *p_stream;
  47     demux_t  *p_demux;
  48
  49     /* Title infos for that input */
  50     bool         b_title_demux; /* Titles/Seekpoints provided by demux */
  51     int          i_title;
  52     input_title_t **title;
  53
  54     int i_title_offset;
  55     int i_seekpoint_offset;
  56
  57     int i_title_start;
  58     int i_title_end;
  59     int i_seekpoint_start;
  60     int i_seekpoint_end;
  61
  62     /* Properties */
  63     bool b_can_pause;
  64     bool b_can_pace_control;
  65     bool b_can_rate_control;
  66     bool b_can_stream_record;
  67     bool b_rescale_ts;
  68
  69     bool       b_eof;   /* eof of demuxer */
  70     double     f_fps;
  71
  72     /* Clock average variation */
  73     int     i_cr_average;
  74
  75 } input_source_t;
  76
  77 /** Private input fields */
  78 struct input_thread_private_t
  79 {
  80     /* Object's event manager */
  81     vlc_event_manager_t event_manager;
  82
  83     /* Global properties */
  84     bool        b_can_pause;
  85     bool        b_can_rate_control;
  86
  87     int         i_rate;
  88     bool        b_recording;
  89     /* */
  90     int64_t     i_start;    /* :start-time,0 by default */
  91     int64_t     i_stop;     /* :stop-time, 0 if none */
  92     int64_t     i_run;      /* :run-time, 0 if none */
  93
  94     /* Title infos FIXME multi-input (not easy) ? */
  95     int          i_title;
  96     input_title_t **title;
  97
  98     int i_title_offset;
  99     int i_seekpoint_offset;
 100
 101     /* User bookmarks FIXME won't be easy with multiples input */
 102     int         i_bookmark;
 103     seekpoint_t **bookmark;
 104
 105     /* Input attachment */
 106     int i_attachment;
 107     input_attachment_t **attachment;
 108
 109     /* Output */
 110     es_out_t        *p_es_out;
 111     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
 112     bool            b_out_pace_control; /*     idem ? */
 113
 114     /* Main input properties */
 115     input_source_t input;
 116     /* Slave demuxers (subs, and others) */
 117     int            i_slave;
 118     input_source_t **slave;
 119
 120     /* pts delay fixup */
 121     struct
 122     {
 123         int  i_num_faulty;
 124         bool b_to_high;
 125         bool b_auto_adjust;
 126     } pts_adjust;
 127
 128     /* Stats counters */
 129     struct {
 130         counter_t *p_read_packets;
 131         counter_t *p_read_bytes;
 132         counter_t *p_input_bitrate;
 133         counter_t *p_demux_read;
 134         counter_t *p_demux_bitrate;
 135         counter_t *p_decoded_audio;
 136         counter_t *p_decoded_video;
 137         counter_t *p_decoded_sub;
 138         counter_t *p_sout_sent_packets;
 139         counter_t *p_sout_sent_bytes;
 140         counter_t *p_sout_send_bitrate;
 141         counter_t *p_played_abuffers;
 142         counter_t *p_lost_abuffers;
 143         counter_t *p_displayed_pictures;
 144         counter_t *p_lost_pictures;
 145         vlc_mutex_t counters_lock;
 146     } counters;
 147
 148     /* Buffer of pending actions */
 149     vlc_mutex_t lock_control;
 150     vlc_cond_t  wait_control;
 151     int i_control;
 152     struct
 153     {
 154         /* XXX for string value you have to allocate it before calling
 155          * input_ControlPush */
 156         int         i_type;
 157         vlc_value_t val;
 158     } control[INPUT_CONTROL_FIFO_SIZE];
 159 };
 160
 161 /***************************************************************************
 162  * Internal control helpers
 163  ***************************************************************************/
 164 enum input_control_e
 165 {
 166     INPUT_CONTROL_SET_DIE,
 167
 168     INPUT_CONTROL_SET_STATE,
 169
 170     INPUT_CONTROL_SET_RATE,
 171     INPUT_CONTROL_SET_RATE_SLOWER,
 172     INPUT_CONTROL_SET_RATE_FASTER,
 173
 174     INPUT_CONTROL_SET_POSITION,
 175     INPUT_CONTROL_SET_POSITION_OFFSET,
 176
 177     INPUT_CONTROL_SET_TIME,
 178     INPUT_CONTROL_SET_TIME_OFFSET,
 179
 180     INPUT_CONTROL_SET_PROGRAM,
 181
 182     INPUT_CONTROL_SET_TITLE,
 183     INPUT_CONTROL_SET_TITLE_NEXT,
 184     INPUT_CONTROL_SET_TITLE_PREV,
 185
 186     INPUT_CONTROL_SET_SEEKPOINT,
 187     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
 188     INPUT_CONTROL_SET_SEEKPOINT_PREV,
 189
 190     INPUT_CONTROL_SET_BOOKMARK,
 191
 192     INPUT_CONTROL_SET_ES,
 193     INPUT_CONTROL_RESTART_ES,
 194
 195     INPUT_CONTROL_SET_AUDIO_DELAY,
 196     INPUT_CONTROL_SET_SPU_DELAY,
 197
 198     INPUT_CONTROL_ADD_SLAVE,
 199
 200     INPUT_CONTROL_SET_RECORD_STATE,
 201 };
 202
 203 /* Internal helpers */
 204 static inline void input_ControlPush( input_thread_t *p_input,
 205                                       int i_type, vlc_value_t *p_val )
 206 {
 207     vlc_mutex_lock( &p_input->p->lock_control );
 208     if( i_type == INPUT_CONTROL_SET_DIE )
 209     {
 210         /* Special case, empty the control */
 211         p_input->p->i_control = 1;
 212         p_input->p->control[0].i_type = i_type;
 213         memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
 214     }
 215     else if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
 216     {
 217         msg_Err( p_input, "input control fifo overflow, trashing type=%d",
 218                  i_type );
 219     }
 220     else
 221     {
 222         p_input->p->control[p_input->p->i_control].i_type = i_type;
 223         if( p_val )
 224             p_input->p->control[p_input->p->i_control].val = *p_val;
 225         else
 226             memset( &p_input->p->control[p_input->p->i_control].val, 0,
 227                     sizeof( vlc_value_t ) );
 228
 229         p_input->p->i_control++;
 230     }
 231     vlc_cond_signal( &p_input->p->wait_control );
 232     vlc_mutex_unlock( &p_input->p->lock_control );
 233 }
 234
 235 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
 236  * anyway. */
 237
 238 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
 239 {
 240     bool send_event = false;
 241
 242     if( !p_i->p_meta )
 243         p_i->p_meta = vlc_meta_New();
 244
 245     vlc_mutex_lock( &p_i->lock );
 246     int new_status;
 247     if( preparsed )
 248         new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
 249     else
 250         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     vlc_mutex_unlock( &p_i->lock );
 258
 259     if( send_event )
 260     {
 261         vlc_event_t event;
 262         event.type = vlc_InputItemPreparsedChanged;
 263         event.u.input_item_preparsed_changed.new_status = new_status;
 264         vlc_event_send( &p_i->event_manager, &event );
 265     }
 266 }
 267
 268 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
 269 {
 270     if( !p_i->p_meta )
 271         p_i->p_meta = vlc_meta_New();
 272
 273     if( notfound )
 274         p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
 275     else
 276         p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
 277 }
 278
 279 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
 280 {
 281     if( !p_i->p_meta )
 282         p_i->p_meta = vlc_meta_New();
 283
 284     if( artfetched )
 285         p_i->p_meta->i_status |= ITEM_ART_FETCHED;
 286     else
 287         p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
 288 }
 289
 290 void input_item_SetHasErrorWhenReading( input_item_t *p_i, bool error );
 291
 292 /**********************************************************************
 293  * Item metadata
 294  **********************************************************************/
 295 typedef struct playlist_album_t
 296 {
 297     char *psz_artist;
 298     char *psz_album;
 299     char *psz_arturl;
 300     bool b_found;
 301 } playlist_album_t;
 302
 303 int         input_ArtFind       ( playlist_t *, input_item_t * );
 304 int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
 305
 306 /* Becarefull; p_item lock HAS to be taken */
 307 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
 308
 309 /***************************************************************************
 310  * Internal prototypes
 311  ***************************************************************************/
 312
 313 /* misc/stats.c */
 314 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
 315
 316 /* input.c */
 317 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
 318 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
 319
 320 sout_instance_t * input_DetachSout( input_thread_t *p_input );
 321
 322 /* var.c */
 323 void input_ControlVarInit ( input_thread_t * );
 324 void input_ControlVarStop( input_thread_t * );
 325 void input_ControlVarNavigation( input_thread_t * );
 326 void input_ControlVarTitle( input_thread_t *, int i_title );
 327
 328 void input_ConfigVarInit ( input_thread_t * );
 329
 330 /* stream.c */
 331 stream_t *stream_AccessNew( access_t *p_access, bool );
 332 void stream_AccessDelete( stream_t *s );
 333 void stream_AccessReset( stream_t *s );
 334 void stream_AccessUpdate( stream_t *s );
 335
 336 /* decoder.c */
 337 void       input_DecoderDiscontinuity( decoder_t * p_dec, bool b_flush );
 338 bool input_DecoderEmpty( decoder_t * p_dec );
 339 int        input_DecoderSetCcState( decoder_t *, bool b_decode, int i_channel );
 340 int        input_DecoderGetCcState( decoder_t *, bool *pb_decode, int i_channel );
 341 void       input_DecoderIsCcPresent( decoder_t *, bool pb_present[4] );
 342
 343 /* es_out.c */
 344 es_out_t  *input_EsOutNew( input_thread_t *, int i_rate );
 345 void       input_EsOutDelete( es_out_t * );
 346 es_out_id_t *input_EsOutGetFromID( es_out_t *, int i_id );
 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 * );
 351 void       input_EsOutChangePosition( es_out_t * );
 352 bool input_EsOutDecodersEmpty( es_out_t * );
 353
 354 /* clock.c */
 355 enum /* Synchro states */
 356 {
 357     SYNCHRO_OK     = 0,
 358     SYNCHRO_START  = 1,
 359     SYNCHRO_REINIT = 2,
 360 };
 361
 362 typedef struct
 363 {
 364     /* Synchronization information */
 365     mtime_t                 delta_cr;
 366     mtime_t                 cr_ref, sysdate_ref;
 367     mtime_t                 last_sysdate;
 368     mtime_t                 last_cr; /* reference to detect unexpected stream
 369                                       * discontinuities                      */
 370     mtime_t                 last_pts;
 371     mtime_t                 last_update;
 372     int                     i_synchro_state;
 373
 374     bool                    b_master;
 375
 376     int                     i_rate;
 377
 378     /* Config */
 379     int                     i_cr_average;
 380     int                     i_delta_cr_residue;
 381 } input_clock_t;
 382
 383 void    input_ClockInit( input_clock_t *, bool b_master, int i_cr_average, int i_rate );
 384 void    input_ClockSetPCR( input_thread_t *, input_clock_t *, mtime_t );
 385 void    input_ClockResetPCR( input_clock_t * );
 386 mtime_t input_ClockGetTS( input_thread_t *, input_clock_t *, mtime_t );
 387 void    input_ClockSetRate( input_clock_t *cl, int i_rate );
 388
 389 /* Subtitles */
 390 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
 391 int subtitles_Filter( const char *);
 392
 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     p_input->i_state = i_state;
 398     if( i_state == ERROR_S )
 399         p_input->b_error = true;
 400     else if( i_state == END_S )
 401         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     else
 410     {
 411         vlc_value_t val;
 412         val.i_int = i_state;
 413         var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
 414     }
 415     if( changed )
 416     {
 417         vlc_event_t event;
 418         event.type = vlc_InputStateChanged;
 419         event.u.input_state_changed.new_state = i_state;
 420         vlc_event_send( &p_input->p->event_manager, &event );
 421     }
 422 }
 423
 424 static inline void input_ChangeState( input_thread_t *p_input, int state )
 425 {
 426     input_ChangeStateWithVarCallback( p_input, state, true );
 427 }
 428
 429 /* Helpers FIXME to export without input_ prefix */
 430 char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );
 431
 432 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
 433
 434 /* Access */
 435
 436 #define access_New( a, b, c, d ) __access_New(VLC_OBJECT(a), b, c, d )
 437 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,
 440                               const char *psz_access_filter );
 441 void access_Delete( access_t * );
 442
 443 /* Demuxer */
 444 #include <vlc_demux.h>
 445
 446 /* stream_t *s could be null and then it mean a access+demux in one */
 447 #define demux_New( a, b, c, d, e, f,g ) __demux_New(VLC_OBJECT(a),b,c,d,e,f,g)
 448 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 );
 449
 450 void demux_Delete(demux_t *);
 451
 452 static inline int demux_Demux( demux_t *p_demux )
 453 {
 454     return p_demux->pf_demux( p_demux );
 455 }
 456 static inline int demux_vaControl( demux_t *p_demux, int i_query, va_list args )
 457 {
 458     return p_demux->pf_control( p_demux, i_query, args );
 459 }
 460 static inline int demux_Control( demux_t *p_demux, int i_query, ... )
 461 {
 462     va_list args;
 463     int     i_result;
 464
 465     va_start( args, i_query );
 466     i_result = demux_vaControl( p_demux, i_query, args );
 467     va_end( args );
 468     return i_result;
 469 }
 470
 471 /* Stream */
 472 /**
 473  * stream_t definition
 474  */
 475 struct stream_t
 476 {
 477     VLC_COMMON_MEMBERS
 478
 479     /*block_t *(*pf_block)  ( stream_t *, int i_size );*/
 480     int      (*pf_read)   ( stream_t *, void *p_read, unsigned int i_read );
 481     int      (*pf_peek)   ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
 482     int      (*pf_control)( stream_t *, int i_query, va_list );
 483     void     (*pf_destroy)( stream_t *);
 484
 485     stream_sys_t *p_sys;
 486
 487     /* UTF-16 and UTF-32 file reading */
 488     vlc_iconv_t     conv;
 489     int             i_char_width;
 490     bool            b_little_endian;
 491 };
 492
 493 #include <libvlc.h>
 494
 495 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
 496 {
 497     return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
 498                                           VLC_OBJECT_GENERIC, "stream" );
 499 }
 500
 501 #endif