git.sesse.net Git - vlc/blob - include/vlc_input.h

   1 /*****************************************************************************
   2  * vlc_input.h: Core input structures
   3  *****************************************************************************
   4  * Copyright (C) 1999-2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Laurent Aimar <fenrir@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #if !defined( __LIBVLC__ )
  26   #error You are not libvlc or one of its plugins. You cannot include this file
  27 #endif
  28
  29 /* __ is need because conflict with <vlc/input.h> */
  30 #ifndef _VLC__INPUT_H
  31 #define _VLC__INPUT_H 1
  32
  33 #include <vlc_es.h>
  34 #include <vlc_meta.h>
  35 #include <vlc_epg.h>
  36
  37 struct vlc_meta_t;
  38
  39 /*****************************************************************************
  40  * input_item_t: Describes an input and is used to spawn input_thread_t objects
  41  *****************************************************************************/
  42 struct info_t
  43 {
  44     char *psz_name;            /**< Name of this info */
  45     char *psz_value;           /**< Value of the info */
  46 };
  47
  48 struct info_category_t
  49 {
  50     char   *psz_name;      /**< Name of this category */
  51     int    i_infos;        /**< Number of infos in the category */
  52     struct info_t **pp_infos;     /**< Pointer to an array of infos */
  53 };
  54
  55 struct input_item_t
  56 {
  57     VLC_GC_MEMBERS
  58     int        i_id;                 /**< Identifier of the item */
  59
  60     char       *psz_name;            /**< text describing this item */
  61     char       *psz_uri;             /**< mrl of this item */
  62     vlc_bool_t  b_fixed_name;        /**< Can the interface change the name ?*/
  63
  64     int        i_options;            /**< Number of input options */
  65     char       **ppsz_options;       /**< Array of input options */
  66
  67     mtime_t    i_duration;           /**< Duration in milliseconds*/
  68
  69     uint8_t    i_type;               /**< Type (file, disc, ...) */
  70     vlc_bool_t b_prefers_tree;      /**< Do we prefer being displayed as tree*/
  71
  72     int        i_categories;         /**< Number of info categories */
  73     info_category_t **pp_categories; /**< Pointer to the first info category */
  74
  75     int         i_es;                /**< Number of es format descriptions */
  76     es_format_t **es;                /**< Es formats */
  77
  78     input_stats_t *p_stats;          /**< Statistics */
  79     int           i_nb_played;       /**< Number of times played */
  80
  81     vlc_meta_t *p_meta;
  82
  83     vlc_mutex_t lock;                /**< Lock for the item */
  84 };
  85
  86 #define ITEM_TYPE_UNKNOWN       0
  87 #define ITEM_TYPE_AFILE         1
  88 #define ITEM_TYPE_VFILE         2
  89 #define ITEM_TYPE_DIRECTORY     3
  90 #define ITEM_TYPE_DISC          4
  91 #define ITEM_TYPE_CDDA          5
  92 #define ITEM_TYPE_CARD          6
  93 #define ITEM_TYPE_NET           7
  94 #define ITEM_TYPE_PLAYLIST      8
  95 #define ITEM_TYPE_NODE          9
  96 #define ITEM_TYPE_NUMBER        10
  97
  98 static inline void input_ItemInit( vlc_object_t *p_o, input_item_t *p_i )
  99 {
 100     memset( p_i, 0, sizeof(input_item_t) );
 101     p_i->psz_name = NULL;
 102     p_i->psz_uri = NULL;
 103     TAB_INIT( p_i->i_es, p_i->es );
 104     TAB_INIT( p_i->i_options, p_i->ppsz_options );
 105     TAB_INIT( p_i->i_categories, p_i->pp_categories );
 106
 107     p_i->i_type = ITEM_TYPE_UNKNOWN;
 108     p_i->b_fixed_name = VLC_TRUE;
 109
 110     p_i->p_stats = NULL;
 111     p_i->p_meta = NULL;
 112
 113     vlc_mutex_init( p_o, &p_i->lock );
 114 }
 115
 116 static inline void input_ItemCopyOptions( input_item_t *p_parent,
 117                                           input_item_t *p_child )
 118 {
 119     int i;
 120     for( i = 0 ; i< p_parent->i_options; i++ )
 121     {
 122         char *psz_option= strdup( p_parent->ppsz_options[i] );
 123         p_child->i_options++;
 124         p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
 125                                                   p_child->i_options *
 126                                                   sizeof( char * ) );
 127         p_child->ppsz_options[p_child->i_options-1] = psz_option;
 128     }
 129 }
 130
 131 VLC_EXPORT( void, input_ItemAddOption,( input_item_t *, const char * ) );
 132 VLC_EXPORT( void, input_ItemAddOptionNoDup,( input_item_t *, const char * ) );
 133
 134 static inline void input_ItemClean( input_item_t *p_i )
 135 {
 136     int i;
 137
 138     free( p_i->psz_name );
 139     free( p_i->psz_uri );
 140     if( p_i->p_stats )
 141     {
 142         vlc_mutex_destroy( &p_i->p_stats->lock );
 143         free( p_i->p_stats );
 144     }
 145
 146     if( p_i->p_meta )
 147         vlc_meta_Delete( p_i->p_meta );
 148
 149     for( i = 0; i < p_i->i_options; i++ )
 150     {
 151         if( p_i->ppsz_options[i] )
 152             free( p_i->ppsz_options[i] );
 153     }
 154     TAB_CLEAN( p_i->i_options, p_i->ppsz_options );
 155
 156     for( i = 0; i < p_i->i_es; i++ )
 157     {
 158         es_format_Clean( p_i->es[i] );
 159         free( p_i->es[i] );
 160     }
 161     TAB_CLEAN( p_i->i_es, p_i->es );
 162
 163     for( i = 0; i < p_i->i_categories; i++ )
 164     {
 165         info_category_t *p_category = p_i->pp_categories[i];
 166         int j;
 167
 168         for( j = 0; j < p_category->i_infos; j++ )
 169         {
 170             struct info_t *p_info = p_category->pp_infos[j];
 171
 172             if( p_info->psz_name )
 173                 free( p_info->psz_name);
 174             if( p_info->psz_value )
 175                 free( p_info->psz_value );
 176             free( p_info );
 177         }
 178         TAB_CLEAN( p_category->i_infos, p_category->pp_infos );
 179
 180         if( p_category->psz_name ) free( p_category->psz_name );
 181         free( p_category );
 182     }
 183     TAB_CLEAN( p_i->i_categories, p_i->pp_categories );
 184
 185     vlc_mutex_destroy( &p_i->lock );
 186 }
 187
 188 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 189 VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
 190
 191 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
 192 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
 193 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
 194 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
 195
 196 VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
 197
 198 /*****************************************************************************
 199  * Seek point: (generalisation of chapters)
 200  *****************************************************************************/
 201 struct seekpoint_t
 202 {
 203     int64_t i_byte_offset;
 204     int64_t i_time_offset;
 205     char    *psz_name;
 206     int     i_level;
 207 };
 208
 209 static inline seekpoint_t *vlc_seekpoint_New( void )
 210 {
 211     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
 212     point->i_byte_offset =
 213     point->i_time_offset = -1;
 214     point->i_level = 0;
 215     point->psz_name = NULL;
 216     return point;
 217 }
 218
 219 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
 220 {
 221     if( !point ) return;
 222     if( point->psz_name ) free( point->psz_name );
 223     free( point );
 224 }
 225
 226 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
 227 {
 228     seekpoint_t *point = vlc_seekpoint_New();
 229     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
 230     point->i_time_offset = src->i_time_offset;
 231     point->i_byte_offset = src->i_byte_offset;
 232     return point;
 233 }
 234
 235 /*****************************************************************************
 236  * Title:
 237  *****************************************************************************/
 238 typedef struct
 239 {
 240     char        *psz_name;
 241
 242     vlc_bool_t  b_menu;      /* Is it a menu or a normal entry */
 243
 244     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
 245     int64_t     i_size;     /* Size (bytes) if known, else 0 */
 246
 247     /* Title seekpoint */
 248     int         i_seekpoint;
 249     seekpoint_t **seekpoint;
 250
 251 } input_title_t;
 252
 253 static inline input_title_t *vlc_input_title_New(void)
 254 {
 255     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 256
 257     t->psz_name = NULL;
 258     t->b_menu = VLC_FALSE;
 259     t->i_length = 0;
 260     t->i_size   = 0;
 261     t->i_seekpoint = 0;
 262     t->seekpoint = NULL;
 263
 264     return t;
 265 }
 266
 267 static inline void vlc_input_title_Delete( input_title_t *t )
 268 {
 269     int i;
 270     if( t == NULL )
 271         return;
 272
 273     if( t->psz_name ) free( t->psz_name );
 274     for( i = 0; i < t->i_seekpoint; i++ )
 275     {
 276         if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
 277         free( t->seekpoint[i] );
 278     }
 279     if( t->seekpoint ) free( t->seekpoint );
 280     free( t );
 281 }
 282
 283 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 284 {
 285     input_title_t *dup = vlc_input_title_New( );
 286     int i;
 287
 288     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 289     dup->b_menu      = t->b_menu;
 290     dup->i_length    = t->i_length;
 291     dup->i_size      = t->i_size;
 292     dup->i_seekpoint = t->i_seekpoint;
 293     if( t->i_seekpoint > 0 )
 294     {
 295         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
 296                                                 sizeof(seekpoint_t*) );
 297
 298         for( i = 0; i < t->i_seekpoint; i++ )
 299         {
 300             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 301         }
 302     }
 303
 304     return dup;
 305 }
 306 /*****************************************************************************
 307  * Attachments
 308  *****************************************************************************/
 309 struct input_attachment_t
 310 {
 311     char *psz_name;
 312     char *psz_mime;
 313     char *psz_description;
 314
 315     int  i_data;
 316     void *p_data;
 317 };
 318 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
 319                                                             const char *psz_mime,
 320                                                             const char *psz_description,
 321                                                             const void *p_data,
 322                                                             int i_data )
 323 {
 324     input_attachment_t *a =
 325         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
 326     if( !a )
 327         return NULL;
 328     a->psz_name = strdup( psz_name ? psz_name : "" );
 329     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
 330     a->psz_description = strdup( psz_description ? psz_description : "" );
 331     a->i_data = i_data;
 332     a->p_data = NULL;
 333     if( i_data > 0 )
 334     {
 335         a->p_data = malloc( i_data );
 336         if( a->p_data && p_data )
 337             memcpy( a->p_data, p_data, i_data );
 338     }
 339     return a;
 340 }
 341 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
 342 {
 343     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
 344                                      a->p_data, a->i_data );
 345 }
 346 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
 347 {
 348     if( !a )
 349         return;
 350     free( a->psz_name );
 351     free( a->psz_mime );
 352     free( a->psz_description );
 353     if( a->p_data )
 354         free( a->p_data );
 355     free( a );
 356 }
 357 /*****************************************************************************
 358  * input defines/constants.
 359  *****************************************************************************/
 360
 361 /* "state" value */
 362 enum input_state_e
 363 {
 364     INIT_S,
 365     OPENING_S,
 366     BUFFERING_S,
 367     PLAYING_S,
 368     PAUSE_S,
 369     END_S,
 370     ERROR_S
 371 };
 372
 373 /* "rate" default, min/max
 374  * A rate below 1000 plays the movie faster,
 375  * A rate above 1000 plays the movie slower.
 376  */
 377 #define INPUT_RATE_DEFAULT  1000
 378 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 379 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 380
 381 /* i_update field of access_t/demux_t */
 382 #define INPUT_UPDATE_NONE       0x0000
 383 #define INPUT_UPDATE_SIZE       0x0001
 384 #define INPUT_UPDATE_TITLE      0x0010
 385 #define INPUT_UPDATE_SEEKPOINT  0x0020
 386 #define INPUT_UPDATE_META       0x0040
 387
 388 /* Input control XXX: internal */
 389 #define INPUT_CONTROL_FIFO_SIZE    100
 390
 391 /** Get the input item for an input thread */
 392 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
 393
 394 typedef struct input_thread_private_t input_thread_private_t;
 395
 396 /**
 397  * Main structure representing an input thread. This structure is mostly
 398  * private. The only public fields are READ-ONLY. You must use the helpers
 399  * to modify them
 400  */
 401 struct input_thread_t
 402 {
 403     VLC_COMMON_MEMBERS;
 404
 405     vlc_bool_t  b_eof;
 406     vlc_bool_t b_preparsing;
 407
 408     int i_state;
 409     vlc_bool_t b_can_pace_control;
 410     int64_t     i_time;     /* Current time */
 411
 412     /* Internal caching common to all inputs */
 413     int i_pts_delay;
 414
 415     /* All other data is input_thread is PRIVATE. You can't access it
 416      * outside of src/input */
 417     input_thread_private_t *p;
 418 };
 419
 420 /*****************************************************************************
 421  * Prototypes
 422  *****************************************************************************/
 423 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 424 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 425 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
 426 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
 427
 428 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
 429 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
 430 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 431 VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 432
 433 enum input_query_e
 434 {
 435     /* input variable "position" */
 436     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 437     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 438
 439     /* input variable "length" */
 440     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 441
 442     /* input variable "time" */
 443     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 444     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 445
 446     /* input variable "rate" (1 is DEFAULT_RATE) */
 447     INPUT_GET_RATE,             /* arg1= int *          res=    */
 448     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 449
 450     /* input variable "state" */
 451     INPUT_GET_STATE,            /* arg1= int *          res=    */
 452     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 453
 454     /* input variable "audio-delay" and "sub-delay" */
 455     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 456     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 457     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 458     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 459
 460     /* Meta datas */
 461     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
 462     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
 463     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
 464     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
 465
 466     /* Input config options */
 467     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
 468
 469     /* Input properties */
 470     INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
 471     INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
 472
 473     /* bookmarks */
 474     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 475     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 476     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 477     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 478     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 479     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 480
 481     /* Attachments */
 482     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
 483     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
 484
 485     /* On the fly input slave */
 486     INPUT_ADD_SLAVE        /* arg1= char * */
 487 };
 488
 489 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
 490 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
 491
 492 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
 493 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 494 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 495
 496 VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );
 497
 498 #endif