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 #include <libvlc.h>
  35
  36 /*****************************************************************************
  37  *  Private input fields
  38  *****************************************************************************/
  39
  40 #define INPUT_CONTROL_FIFO_SIZE    100
  41
  42 /* input_source_t: gathers all information per input source */
  43 typedef struct
  44 {
  45     /* Input item description */
  46     input_item_t *p_item;
  47
  48     /* Access/Stream/Demux plugins */
  49     access_t *p_access;
  50     stream_t *p_stream;
  51     demux_t  *p_demux;
  52
  53     /* Title infos for that input */
  54     bool         b_title_demux; /* Titles/Seekpoints provided by demux */
  55     int          i_title;
  56     input_title_t **title;
  57
  58     int i_title_offset;
  59     int i_seekpoint_offset;
  60
  61     int i_title_start;
  62     int i_title_end;
  63     int i_seekpoint_start;
  64     int i_seekpoint_end;
  65
  66     /* Properties */
  67     bool b_can_pause;
  68     bool b_can_pace_control;
  69     bool b_can_rate_control;
  70     bool b_can_stream_record;
  71     bool b_rescale_ts;
  72
  73     bool       b_eof;   /* eof of demuxer */
  74     double     f_fps;
  75
  76     /* Clock average variation */
  77     int     i_cr_average;
  78
  79 } input_source_t;
  80
  81 /** Private input fields */
  82 struct input_thread_private_t
  83 {
  84     /* Object's event manager */
  85     vlc_event_manager_t event_manager;
  86
  87     /* Global properties */
  88     bool        b_can_pause;
  89     bool        b_can_rate_control;
  90
  91     int         i_rate;
  92     bool        b_recording;
  93     /* */
  94     int64_t     i_start;    /* :start-time,0 by default */
  95     int64_t     i_stop;     /* :stop-time, 0 if none */
  96     int64_t     i_run;      /* :run-time, 0 if none */
  97
  98     /* Title infos FIXME multi-input (not easy) ? */
  99     int          i_title;
 100     input_title_t **title;
 101
 102     int i_title_offset;
 103     int i_seekpoint_offset;
 104
 105     /* User bookmarks FIXME won't be easy with multiples input */
 106     int         i_bookmark;
 107     seekpoint_t **bookmark;
 108
 109     /* Input attachment */
 110     int i_attachment;
 111     input_attachment_t **attachment;
 112
 113     /* Output */
 114     es_out_t        *p_es_out;
 115     es_out_t        *p_es_out_display;
 116     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
 117     bool            b_out_pace_control; /*     idem ? */
 118
 119     /* Main input properties */
 120     input_source_t input;
 121     /* Slave demuxers (subs, and others) */
 122     int            i_slave;
 123     input_source_t **slave;
 124
 125     /* Stats counters */
 126     struct {
 127         counter_t *p_read_packets;
 128         counter_t *p_read_bytes;
 129         counter_t *p_input_bitrate;
 130         counter_t *p_demux_read;
 131         counter_t *p_demux_bitrate;
 132         counter_t *p_decoded_audio;
 133         counter_t *p_decoded_video;
 134         counter_t *p_decoded_sub;
 135         counter_t *p_sout_sent_packets;
 136         counter_t *p_sout_sent_bytes;
 137         counter_t *p_sout_send_bitrate;
 138         counter_t *p_played_abuffers;
 139         counter_t *p_lost_abuffers;
 140         counter_t *p_displayed_pictures;
 141         counter_t *p_lost_pictures;
 142         vlc_mutex_t counters_lock;
 143     } counters;
 144
 145     /* Buffer of pending actions */
 146     vlc_mutex_t lock_control;
 147     vlc_cond_t  wait_control;
 148     int i_control;
 149     struct
 150     {
 151         /* XXX for string value you have to allocate it before calling
 152          * input_ControlPush */
 153         int         i_type;
 154         vlc_value_t val;
 155     } control[INPUT_CONTROL_FIFO_SIZE];
 156 };
 157
 158 /***************************************************************************
 159  * Internal control helpers
 160  ***************************************************************************/
 161 enum input_control_e
 162 {
 163     INPUT_CONTROL_SET_DIE,
 164
 165     INPUT_CONTROL_SET_STATE,
 166
 167     INPUT_CONTROL_SET_RATE,
 168     INPUT_CONTROL_SET_RATE_SLOWER,
 169     INPUT_CONTROL_SET_RATE_FASTER,
 170
 171     INPUT_CONTROL_SET_POSITION,
 172     INPUT_CONTROL_SET_POSITION_OFFSET,
 173
 174     INPUT_CONTROL_SET_TIME,
 175     INPUT_CONTROL_SET_TIME_OFFSET,
 176
 177     INPUT_CONTROL_SET_PROGRAM,
 178
 179     INPUT_CONTROL_SET_TITLE,
 180     INPUT_CONTROL_SET_TITLE_NEXT,
 181     INPUT_CONTROL_SET_TITLE_PREV,
 182
 183     INPUT_CONTROL_SET_SEEKPOINT,
 184     INPUT_CONTROL_SET_SEEKPOINT_NEXT,
 185     INPUT_CONTROL_SET_SEEKPOINT_PREV,
 186
 187     INPUT_CONTROL_SET_BOOKMARK,
 188
 189     INPUT_CONTROL_SET_ES,
 190     INPUT_CONTROL_RESTART_ES,
 191
 192     INPUT_CONTROL_SET_AUDIO_DELAY,
 193     INPUT_CONTROL_SET_SPU_DELAY,
 194
 195     INPUT_CONTROL_ADD_SLAVE,
 196
 197     INPUT_CONTROL_ADD_SUBTITLE,
 198
 199     INPUT_CONTROL_SET_RECORD_STATE,
 200
 201     INPUT_CONTROL_SET_FRAME_NEXT,
 202 };
 203
 204 /* Internal helpers */
 205 static inline void input_ControlPush( input_thread_t *p_input,
 206                                       int i_type, vlc_value_t *p_val )
 207 {
 208     vlc_mutex_lock( &p_input->p->lock_control );
 209     if( i_type == INPUT_CONTROL_SET_DIE )
 210     {
 211         /* Special case, empty the control */
 212         p_input->p->i_control = 1;
 213         p_input->p->control[0].i_type = i_type;
 214         memset( &p_input->p->control[0].val, 0, sizeof( vlc_value_t ) );
 215     }
 216     else if( p_input->p->i_control >= INPUT_CONTROL_FIFO_SIZE )
 217     {
 218         msg_Err( p_input, "input control fifo overflow, trashing type=%d",
 219                  i_type );
 220     }
 221     else
 222     {
 223         p_input->p->control[p_input->p->i_control].i_type = i_type;
 224         if( p_val )
 225             p_input->p->control[p_input->p->i_control].val = *p_val;
 226         else
 227             memset( &p_input->p->control[p_input->p->i_control].val, 0,
 228                     sizeof( vlc_value_t ) );
 229
 230         p_input->p->i_control++;
 231     }
 232     vlc_cond_signal( &p_input->p->wait_control );
 233     vlc_mutex_unlock( &p_input->p->lock_control );
 234 }
 235
 236 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
 237  * anyway. */
 238
 239 static inline void input_item_SetPreparsed( input_item_t *p_i, bool preparsed )
 240 {
 241     bool send_event = false;
 242
 243     if( !p_i->p_meta )
 244         p_i->p_meta = vlc_meta_New();
 245
 246     vlc_mutex_lock( &p_i->lock );
 247     int new_status;
 248     if( preparsed )
 249         new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
 250     else
 251         new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
 252     if( p_i->p_meta->i_status != new_status )
 253     {
 254         p_i->p_meta->i_status = new_status;
 255         send_event = true;
 256     }
 257
 258     vlc_mutex_unlock( &p_i->lock );
 259
 260     if( send_event )
 261     {
 262         vlc_event_t event;
 263         event.type = vlc_InputItemPreparsedChanged;
 264         event.u.input_item_preparsed_changed.new_status = new_status;
 265         vlc_event_send( &p_i->event_manager, &event );
 266     }
 267 }
 268
 269 static inline void input_item_SetArtNotFound( input_item_t *p_i, bool notfound )
 270 {
 271     if( !p_i->p_meta )
 272         p_i->p_meta = vlc_meta_New();
 273
 274     if( notfound )
 275         p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
 276     else
 277         p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
 278 }
 279
 280 static inline void input_item_SetArtFetched( input_item_t *p_i, bool artfetched )
 281 {
 282     if( !p_i->p_meta )
 283         p_i->p_meta = vlc_meta_New();
 284
 285     if( artfetched )
 286         p_i->p_meta->i_status |= ITEM_ART_FETCHED;
 287     else
 288         p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
 289 }
 290
 291 void input_item_SetHasErrorWhenReading( input_item_t *p_i, bool error );
 292
 293 /**********************************************************************
 294  * Item metadata
 295  **********************************************************************/
 296 typedef struct playlist_album_t
 297 {
 298     char *psz_artist;
 299     char *psz_album;
 300     char *psz_arturl;
 301     bool b_found;
 302 } playlist_album_t;
 303
 304 int         input_ArtFind       ( playlist_t *, input_item_t * );
 305 int         input_DownloadAndCacheArt ( playlist_t *, input_item_t * );
 306
 307 /* Becarefull; p_item lock HAS to be taken */
 308 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input );
 309
 310 /***************************************************************************
 311  * Internal prototypes
 312  ***************************************************************************/
 313
 314 /* misc/stats.c */
 315 input_stats_t *stats_NewInputStats( input_thread_t *p_input );
 316
 317 /* input.c */
 318 #define input_CreateThreadExtended(a,b,c,d) __input_CreateThreadExtended(VLC_OBJECT(a),b,c,d)
 319 input_thread_t *__input_CreateThreadExtended ( vlc_object_t *, input_item_t *, const char *, sout_instance_t * );
 320
 321 sout_instance_t * input_DetachSout( input_thread_t *p_input );
 322
 323 /* var.c */
 324 void input_ControlVarInit ( input_thread_t * );
 325 void input_ControlVarStop( input_thread_t * );
 326 void input_ControlVarNavigation( input_thread_t * );
 327 void input_ControlVarTitle( input_thread_t *, int i_title );
 328
 329 void input_ConfigVarInit ( input_thread_t * );
 330
 331 /* Subtitles */
 332 char **subtitles_Detect( input_thread_t *, char* path, const char *fname );
 333 int subtitles_Filter( const char *);
 334
 335 static inline void input_ChangeStateWithVarCallback( input_thread_t *p_input, int i_state, bool callback )
 336 {
 337     const bool changed = p_input->i_state != i_state;
 338
 339     p_input->i_state = i_state;
 340     if( i_state == ERROR_S )
 341         p_input->b_error = true;
 342     else if( i_state == END_S )
 343         p_input->b_eof = true;
 344
 345     input_item_SetHasErrorWhenReading( p_input->p->input.p_item, (i_state == ERROR_S) );
 346
 347     if( callback )
 348     {
 349         var_SetInteger( p_input, "state", i_state );
 350     }
 351     else
 352     {
 353         vlc_value_t val;
 354         val.i_int = i_state;
 355         var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
 356     }
 357     if( changed )
 358     {
 359         vlc_event_t event;
 360         event.type = vlc_InputStateChanged;
 361         event.u.input_state_changed.new_state = i_state;
 362         vlc_event_send( &p_input->p->event_manager, &event );
 363     }
 364 }
 365
 366 static inline void input_ChangeState( input_thread_t *p_input, int state )
 367 {
 368     input_ChangeStateWithVarCallback( p_input, state, true );
 369 }
 370
 371 /* Helpers FIXME to export without input_ prefix */
 372 char *input_CreateFilename( vlc_object_t *p_obj, const char *psz_path, const char *psz_prefix, const char *psz_extension );
 373
 374 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
 375
 376 #endif