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     /* Stats counters */
 121     struct {
 122         counter_t *p_read_packets;
 123         counter_t *p_read_bytes;
 124         counter_t *p_input_bitrate;
 125         counter_t *p_demux_read;
 126         counter_t *p_demux_bitrate;
 127         counter_t *p_decoded_audio;
 128         counter_t *p_decoded_video;
 129         counter_t *p_decoded_sub;
 130         counter_t *p_sout_sent_packets;
 131         counter_t *p_sout_sent_bytes;
 132         counter_t *p_sout_send_bitrate;
 133         counter_t *p_played_abuffers;
 134         counter_t *p_lost_abuffers;
 135         counter_t *p_displayed_pictures;
 136         counter_t *p_lost_pictures;
 137         vlc_mutex_t counters_lock;
 138     } counters;
 139
 140     /* Buffer of pending actions */
 141     vlc_mutex_t lock_control;
 142     vlc_cond_t  wait_control;
 143     int i_control;
 144     struct
 145     {
 146         /* XXX for string value you have to allocate it before calling
 147          * input_ControlPush */
 148         int         i_type;
 149         vlc_value_t val;
 150     } control[INPUT_CONTROL_FIFO_SIZE];
 151 };
 152
 153 /***************************************************************************
 154  * Internal control helpers
 155  ***************************************************************************/
 156 enum input_control_e
 157 {
 158     INPUT_CONTROL_SET_DIE,
 159
 160     INPUT_CONTROL_SET_STATE,
 161
 162     INPUT_CONTROL_SET_RATE,
 163     INPUT_CONTROL_SET_RATE_SLOWER,
 164     INPUT_CONTROL_SET_RATE_FASTER,
 165
 166     INPUT_CONTROL_SET_POSITION,
 167     INPUT_CONTROL_SET_POSITION_OFFSET,
 168
 169     INPUT_CONTROL_SET_TIME,
 170     INPUT_CONTROL_SET_TIME_OFFSET,
 171
 172     INPUT_CONTROL_SET_PROGRAM,
 173
 174     INPUT_CONTROL_SET_TITLE,
 175     INPUT_CONTROL_SET_TITLE_NEXT,
 176     INPUT_CONTROL_SET_TITLE_PREV,
 177
 178     INPUT_CONTROL_SET_SEEKPOINT,
 179     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
 180     INPUT_CONTROL_SET_SEEKPOINT_PREV,
 181
 182     INPUT_CONTROL_SET_BOOKMARK,
 183
 184     INPUT_CONTROL_SET_ES,
 185     INPUT_CONTROL_RESTART_ES,
 186
 187     INPUT_CONTROL_SET_AUDIO_DELAY,
 188     INPUT_CONTROL_SET_SPU_DELAY,
 189
 190     INPUT_CONTROL_ADD_SLAVE,
 191
 192     INPUT_CONTROL_ADD_SUBTITLE,
 193
 194     INPUT_CONTROL_SET_RECORD_STATE,
 195 };
 196
 197 /* Internal helpers */
 198 static inline void input_ControlPush( input_thread_t *p_input,
 199                                       int i_type, vlc_value_t *p_val )
 200 {
 201     vlc_mutex_lock( &p_input->p->lock_control );
 202     if( i_type == INPUT_CONTROL_SET_DIE )
 203     {
 204         /* Special case, empty the control */
 205         p_input->p->i_control = 1;
 206         p_input->p->control[0].i_type = i_type;
 207         memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
 208     }
 209     else if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
 210     {
 211         msg_Err( p_input, "input control fifo overflow, trashing type=%d",
 212                  i_type );
 213     }
 214     else
 215     {
 216         p_input->p->control[p_input->p->i_control].i_type = i_type;
 217         if( p_val )
 218             p_input->p->control[p_input->p->i_control].val = *p_val;
 219         else
 220             memset( &p_input->p->control[p_input->p->i_control].val, 0,
 221                     sizeof( vlc_value_t ) );
 222
 223         p_input->p->i_control++;
 224     }
 225     vlc_cond_signal( &p_input->p->wait_control );
 226     vlc_mutex_unlock( &p_input->p->lock_control );
 227 }
 228
 229 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
 230  * anyway. */
 231
 232 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
 233 {
 234     bool send_event = false;
 235
 236     if( !p_i->p_meta )
 237         p_i->p_meta = vlc_meta_New();
 238
 239     vlc_mutex_lock( &p_i->lock );
 240     int new_status;
 241     if( preparsed )
 242         new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
 243     else
 244         new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
 245     if( p_i->p_meta->i_status != new_status )
 246     {
 247         p_i->p_meta->i_status = new_status;
 248         send_event = true;
 249     }
 250
 251     vlc_mutex_unlock( &p_i->lock );
 252
 253     if( send_event )
 254     {
 255         vlc_event_t event;
 256         event.type = vlc_InputItemPreparsedChanged;
 257         event.u.input_item_preparsed_changed.new_status = new_status;
 258         vlc_event_send( &p_i->event_manager, &event );
 259     }
 260 }
 261
 262 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
 263 {
 264     if( !p_i->p_meta )
 265         p_i->p_meta = vlc_meta_New();
 266
 267     if( notfound )
 268         p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
 269     else
 270         p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
 271 }
 272
 273 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
 274 {
 275     if( !p_i->p_meta )
 276         p_i->p_meta = vlc_meta_New();
 277
 278     if( artfetched )
 279         p_i->p_meta->i_status |= ITEM_ART_FETCHED;
 280     else
 281         p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
 282 }
 283
 284 void input_item_SetHasErrorWhenReading( input_item_t *p_i, bool error );
 285
 286 /**********************************************************************
 287  * Item metadata
 288  **********************************************************************/
 289 typedef struct playlist_album_t
 290 {
 291     char *psz_artist;
 292     char *psz_album;
 293     char *psz_arturl;
 294     bool b_found;
 295 } playlist_album_t;
 296
 297 int         input_ArtFind       ( playlist_t *, input_item_t * );
 298 int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
 299
 300 /* Becarefull; p_item lock HAS to be taken */
 301 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
 302
 303 /***************************************************************************
 304  * Internal prototypes
 305  ***************************************************************************/
 306
 307 /* misc/stats.c */
 308 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
 309
 310 /* input.c */
 311 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
 312 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
 313
 314 sout_instance_t * input_DetachSout( input_thread_t *p_input );
 315
 316 /* var.c */
 317 void input_ControlVarInit ( input_thread_t * );
 318 void input_ControlVarStop( input_thread_t * );
 319 void input_ControlVarNavigation( input_thread_t * );
 320 void input_ControlVarTitle( input_thread_t *, int i_title );
 321
 322 void input_ConfigVarInit ( input_thread_t * );
 323
 324 /* stream.c */
 325 stream_t *stream_AccessNew( access_t *p_access, bool );
 326 void stream_AccessDelete( stream_t *s );
 327 void stream_AccessReset( stream_t *s );
 328 void stream_AccessUpdate( stream_t *s );
 329
 330 /* Subtitles */
 331 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
 332 int subtitles_Filter( const char *);
 333
 334 static inline void input_ChangeStateWithVarCallback( input_thread_t *p_input, int i_state, bool callback )
 335 {
 336     const bool changed = p_input->i_state != i_state;
 337
 338     p_input->i_state = i_state;
 339     if( i_state == ERROR_S )
 340         p_input->b_error = true;
 341     else if( i_state == END_S )
 342         p_input->b_eof = true;
 343
 344     input_item_SetHasErrorWhenReading( p_input->p->input.p_item, (i_state == ERROR_S) );
 345
 346     if( callback )
 347     {
 348         var_SetInteger( p_input, "state", i_state );
 349     }
 350     else
 351     {
 352         vlc_value_t val;
 353         val.i_int = i_state;
 354         var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
 355     }
 356     if( changed )
 357     {
 358         vlc_event_t event;
 359         event.type = vlc_InputStateChanged;
 360         event.u.input_state_changed.new_state = i_state;
 361         vlc_event_send( &p_input->p->event_manager, &event );
 362     }
 363 }
 364
 365 static inline void input_ChangeState( input_thread_t *p_input, int state )
 366 {
 367     input_ChangeStateWithVarCallback( p_input, state, true );
 368 }
 369
 370 /* Helpers FIXME to export without input_ prefix */
 371 char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );
 372
 373 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
 374
 375 /* Access */
 376
 377 #define access_New( a, b, c, d ) __access_New(VLC_OBJECT(a), b, c, d )
 378 access_t * __access_New( vlc_object_t *p_obj, const char *psz_access,
 379                           const char *psz_demux, const char *psz_path );
 380 access_t * access_FilterNew( access_t *p_source,
 381                               const char *psz_access_filter );
 382 void access_Delete( access_t * );
 383
 384 /* Stream */
 385 /**
 386  * stream_t definition
 387  */
 388 struct stream_t
 389 {
 390     VLC_COMMON_MEMBERS
 391
 392     /*block_t *(*pf_block)  ( stream_t *, int i_size );*/
 393     int      (*pf_read)   ( stream_t *, void *p_read, unsigned int i_read );
 394     int      (*pf_peek)   ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
 395     int      (*pf_control)( stream_t *, int i_query, va_list );
 396     void     (*pf_destroy)( stream_t *);
 397
 398     stream_sys_t *p_sys;
 399
 400     /* UTF-16 and UTF-32 file reading */
 401     vlc_iconv_t     conv;
 402     int             i_char_width;
 403     bool            b_little_endian;
 404 };
 405
 406 #include <libvlc.h>
 407
 408 static inline stream_t *vlc_stream_create( vlc_object_t *obj )
 409 {
 410     return (stream_t *)vlc_custom_create( obj, sizeof(stream_t),
 411                                           VLC_OBJECT_GENERIC, "stream" );
 412 }
 413
 414 #endif