vlc_input.h 24.2 KB
Newer Older
Laurent Aimar's avatar
Laurent Aimar committed
1
/*****************************************************************************
2
 * vlc_input.h: Core input structures
Laurent Aimar's avatar
Laurent Aimar committed
3
 *****************************************************************************
4
 * Copyright (C) 1999-2006 the VideoLAN team
5
 * $Id$
Laurent Aimar's avatar
Laurent Aimar committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 *
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
 *          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
dionoea's avatar
dionoea committed
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Laurent Aimar's avatar
Laurent Aimar committed
23
24
 *****************************************************************************/

zorglub's avatar
zorglub committed
25
26
27
28
#if !defined( __LIBVLC__ )
  #error You are not libvlc or one of its plugins. You cannot include this file
#endif

Laurent Aimar's avatar
Laurent Aimar committed
29
30
31
32
/* __ is need because conflict with <vlc/input.h> */
#ifndef _VLC__INPUT_H
#define _VLC__INPUT_H 1

33
#include <vlc_es.h>
34
#include <vlc_meta.h>
Laurent Aimar's avatar
Laurent Aimar committed
35
#include <vlc_epg.h>
36
#include <vlc_events.h>
37

38
39
#include <string.h>                                     /* strcasestr() */

40
41
struct vlc_meta_t;

Laurent Aimar's avatar
Laurent Aimar committed
42
/*****************************************************************************
43
 * input_item_t: Describes an input and is used to spawn input_thread_t objects
Laurent Aimar's avatar
Laurent Aimar committed
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 *****************************************************************************/
struct info_t
{
    char *psz_name;            /**< Name of this info */
    char *psz_value;           /**< Value of the info */
};

struct info_category_t
{
    char   *psz_name;      /**< Name of this category */
    int    i_infos;        /**< Number of infos in the category */
    struct info_t **pp_infos;     /**< Pointer to an array of infos */
};

struct input_item_t
{
60
61
62
    VLC_GC_MEMBERS
    int        i_id;                 /**< Identifier of the item */

Laurent Aimar's avatar
Laurent Aimar committed
63
64
    char       *psz_name;            /**< text describing this item */
    char       *psz_uri;             /**< mrl of this item */
65
    bool  b_fixed_name;        /**< Can the interface change the name ?*/
Laurent Aimar's avatar
Laurent Aimar committed
66
67
68

    int        i_options;            /**< Number of input options */
    char       **ppsz_options;       /**< Array of input options */
69
70
    uint8_t    *optflagv;            /**< Some flags of input options */
    unsigned   optflagc;
Laurent Aimar's avatar
Laurent Aimar committed
71

72
    mtime_t    i_duration;           /**< Duration in milliseconds*/
Laurent Aimar's avatar
Laurent Aimar committed
73

zorglub's avatar
zorglub committed
74
75
    uint8_t    i_type;               /**< Type (file, disc, ...) */

Laurent Aimar's avatar
Laurent Aimar committed
76
77
78
    int        i_categories;         /**< Number of info categories */
    info_category_t **pp_categories; /**< Pointer to the first info category */

79
    int         i_es;                /**< Number of es format descriptions */
80
    es_format_t **es;                /**< Es formats */
zorglub's avatar
zorglub committed
81

zorglub's avatar
zorglub committed
82
    input_stats_t *p_stats;          /**< Statistics */
83
84
85
    int           i_nb_played;       /**< Number of times played */

    vlc_meta_t *p_meta;
86
87
88

    vlc_event_manager_t event_manager;

89
    vlc_mutex_t lock;                 /**< Lock for the item */
Laurent Aimar's avatar
Laurent Aimar committed
90
91
};

zorglub's avatar
zorglub committed
92
#define ITEM_TYPE_UNKNOWN       0
93
94
95
96
97
98
99
100
101
#define ITEM_TYPE_FILE          1
#define ITEM_TYPE_DIRECTORY     2
#define ITEM_TYPE_DISC          3
#define ITEM_TYPE_CDDA          4
#define ITEM_TYPE_CARD          5
#define ITEM_TYPE_NET           6
#define ITEM_TYPE_PLAYLIST      7
#define ITEM_TYPE_NODE          8
#define ITEM_TYPE_NUMBER        9
zorglub's avatar
zorglub committed
102

103
104
static inline void input_ItemCopyOptions( input_item_t *p_parent,
                                          input_item_t *p_child )
105
106
107
108
109
{
    int i;
    for( i = 0 ; i< p_parent->i_options; i++ )
    {
        char *psz_option= strdup( p_parent->ppsz_options[i] );
110
111
112
113
114
        if( !strcmp( psz_option, "meta-file" ) )
        {
            free( psz_option );
            continue;
        }
zorglub's avatar
zorglub committed
115
116
117
118
119
        p_child->i_options++;
        p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
                                                  p_child->i_options *
                                                  sizeof( char * ) );
        p_child->ppsz_options[p_child->i_options-1] = psz_option;
120
121
122
123
        p_child->optflagc++;
        p_child->optflagv = (uint8_t *)realloc( p_child->optflagv,
                                                p_child->optflagc );
        p_child->optflagv[p_child->optflagc - 1] = p_parent->optflagv[i];
124
125
126
    }
}

127
static inline void input_item_SetName( input_item_t *p_item, const char *psz_name )
128
{
ivoire's avatar
ivoire committed
129
    free( p_item->psz_name );
130
131
132
133
134
135
136
137
    p_item->psz_name = strdup( psz_name );
}

/* This won't hold the item, but can tell to interested third parties
 * Like the playlist, that there is a new sub item. With this design
 * It is not the input item's responsability to keep all the ref of
 * the input item children. */
static inline void input_ItemAddSubItem( input_item_t *p_parent,
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
138
                                         input_item_t *p_child )
139
140
141
142
143
144
145
146
147
148
149
{
    vlc_event_t event;

    p_parent->i_type = ITEM_TYPE_PLAYLIST;

    /* Notify interested third parties */
    event.type = vlc_InputItemSubItemAdded;
    event.u.input_item_subitem_added.p_new_child = p_child;
    vlc_event_send( &p_parent->event_manager, &event );
}

150
/* Flags handled past input_ItemAddOpt() */
151
152
#define VLC_INPUT_OPTION_TRUSTED 0x2

153
154
155
156
/* Flags handled within input_ItemAddOpt() */
#define VLC_INPUT_OPTION_UNIQUE  0x100

VLC_EXPORT( int, input_ItemAddOpt, ( input_item_t *, const char *str, unsigned flags ) );
157
158

static inline
159
int input_ItemAddOption (input_item_t *item, const char *str)
160
{
161
    return input_ItemAddOpt (item, str, VLC_INPUT_OPTION_TRUSTED);
162
}
163

Laurent Aimar's avatar
Laurent Aimar committed
164

165
VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val ));
166

167
static inline bool input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz )
168
{
Rafaël Carré's avatar
Rafaël Carré committed
169
    vlc_mutex_lock( &p_i->lock );
170
171
172
    if( !p_i->p_meta )
    {
        vlc_mutex_unlock( &p_i->lock );
173
        return false;
174
    }
175
    const char * meta = vlc_meta_Get( p_i->p_meta, meta_type );
176
    bool ret = meta && strcasestr( meta, psz );
Rafaël Carré's avatar
Rafaël Carré committed
177
    vlc_mutex_unlock( &p_i->lock );
178
179
180
181

    return ret;
}

182
static inline char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
183
{
184
    char * psz = NULL;
Rafaël Carré's avatar
Rafaël Carré committed
185
    vlc_mutex_lock( &p_i->lock );
186

187
    if( !p_i->p_meta )
188
    {
Rafaël Carré's avatar
Rafaël Carré committed
189
        vlc_mutex_unlock( &p_i->lock );
190
        return NULL;
191
    }
192
193
194
195

    if( vlc_meta_Get( p_i->p_meta, meta_type ) )
        psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) );

Rafaël Carré's avatar
Rafaël Carré committed
196
    vlc_mutex_unlock( &p_i->lock );
197
    return psz;
198
199
}

200
static inline char * input_item_GetName( input_item_t * p_i )
201
{
Rafaël Carré's avatar
Rafaël Carré committed
202
    vlc_mutex_lock( &p_i->lock );
203
    char *psz_s = p_i->psz_name ? strdup( p_i->psz_name ) : NULL;
Rafaël Carré's avatar
Rafaël Carré committed
204
    vlc_mutex_unlock( &p_i->lock );
205
    return psz_s;
206
207
}

208
209
210
211
212
213
214
215
216
217
218
static inline char * input_item_GetURI( input_item_t * p_i )
{
    vlc_mutex_lock( &p_i->lock );
    char *psz_s = p_i->psz_uri ? strdup( p_i->psz_uri ) : NULL;
    vlc_mutex_unlock( &p_i->lock );
    return psz_s;
}

static inline void input_item_SetURI( input_item_t * p_i, char * psz_uri )
{
    vlc_mutex_lock( &p_i->lock );
ivoire's avatar
ivoire committed
219
220
    free( p_i->psz_uri );
    p_i->psz_uri = strdup( psz_uri );
221
222
223
224
225
226
227
228
229
230
231
232
233
    vlc_mutex_unlock( &p_i->lock );
}

static inline mtime_t input_item_GetDuration( input_item_t * p_i )
{
    vlc_mutex_lock( &p_i->lock );
    mtime_t i_duration = p_i->i_duration;
    vlc_mutex_unlock( &p_i->lock );
    return i_duration;
}

static inline void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration )
{
234
    bool send_event = false;
235

236
    vlc_mutex_lock( &p_i->lock );
237
238
239
    if( p_i->i_duration != i_duration )
    {
        p_i->i_duration = i_duration;
240
        send_event = true;
241
    }
242
    vlc_mutex_unlock( &p_i->lock );
243

244
    if ( send_event == true )
245
246
247
248
249
250
    {
        vlc_event_t event;
        event.type = vlc_InputItemDurationChanged;
        event.u.input_item_duration_changed.new_duration = i_duration;
        vlc_event_send( &p_i->event_manager, &event );
    }
251

252
253
254
    return;
}

255

256
static inline bool input_item_IsPreparsed( input_item_t *p_i )
257
{
258
    return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : false ;
259
260
}

261
static inline bool input_item_IsMetaFetched( input_item_t *p_i )
262
{
263
    return p_i->p_meta ? p_i->p_meta->i_status & ITEM_META_FETCHED : false ;
264
265
266
}


267
static inline bool input_item_IsArtFetched( input_item_t *p_i )
268
{
269
    return p_i->p_meta ? p_i->p_meta->i_status & ITEM_ART_FETCHED : false ;
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
}

static inline const vlc_meta_t * input_item_GetMetaObject( input_item_t *p_i )
{
    if( !p_i->p_meta )
        p_i->p_meta = vlc_meta_New();

    return p_i->p_meta;
}

static inline void input_item_MetaMerge( input_item_t *p_i, const vlc_meta_t * p_new_meta )
{
    if( !p_i->p_meta )
        p_i->p_meta = vlc_meta_New();

    vlc_meta_Merge( p_i->p_meta, p_new_meta );
}

#define input_item_SetTitle( item, b )       input_item_SetMeta( item, vlc_meta_Title, b )
#define input_item_SetArtist( item, b )      input_item_SetMeta( item, vlc_meta_Artist, b )
#define input_item_SetGenre( item, b )       input_item_SetMeta( item, vlc_meta_Genre, b )
#define input_item_SetCopyright( item, b )   input_item_SetMeta( item, vlc_meta_Copyright, b )
#define input_item_SetAlbum( item, b )       input_item_SetMeta( item, vlc_meta_Album, b )
#define input_item_SetTrackNum( item, b )    input_item_SetMeta( item, vlc_meta_TrackNumber, b )
#define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
#define input_item_SetRating( item, b )      input_item_SetMeta( item, vlc_meta_Rating, b )
#define input_item_SetDate( item, b )        input_item_SetMeta( item, vlc_meta_Date, b )
#define input_item_SetSetting( item, b )     input_item_SetMeta( item, vlc_meta_Setting, b )
#define input_item_SetURL( item, b )         input_item_SetMeta( item, vlc_meta_URL, b )
#define input_item_SetLanguage( item, b )    input_item_SetMeta( item, vlc_meta_Language, b )
#define input_item_SetNowPlaying( item, b )  input_item_SetMeta( item, vlc_meta_NowPlaying, b )
#define input_item_SetPublisher( item, b )   input_item_SetMeta( item, vlc_meta_Publisher, b )
#define input_item_SetEncodedBy( item, b )   input_item_SetMeta( item, vlc_meta_EncodedBy, b )
#define input_item_SetArtURL( item, b )      input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
#define input_item_SetTrackID( item, b )     input_item_SetMeta( item, vlc_meta_TrackID, b )

#define input_item_GetTitle( item )          input_item_GetMeta( item, vlc_meta_Title )
#define input_item_GetArtist( item )         input_item_GetMeta( item, vlc_meta_Artist )
#define input_item_GetGenre( item )          input_item_GetMeta( item, vlc_meta_Genre )
#define input_item_GetCopyright( item )      input_item_GetMeta( item, vlc_meta_Copyright )
#define input_item_GetAlbum( item )          input_item_GetMeta( item, vlc_meta_Album )
#define input_item_GetTrackNum( item )       input_item_GetMeta( item, vlc_meta_TrackNumber )
#define input_item_GetDescription( item )    input_item_GetMeta( item, vlc_meta_Description )
#define input_item_GetRating( item )         input_item_GetMeta( item, vlc_meta_Rating )
#define input_item_GetDate( item )           input_item_GetMeta( item, vlc_meta_Date )
#define input_item_GetGetting( item )        input_item_GetMeta( item, vlc_meta_Getting )
#define input_item_GetURL( item )            input_item_GetMeta( item, vlc_meta_URL )
#define input_item_GetLanguage( item )       input_item_GetMeta( item, vlc_meta_Language )
#define input_item_GetNowPlaying( item )     input_item_GetMeta( item, vlc_meta_NowPlaying )
#define input_item_GetPublisher( item )      input_item_GetMeta( item, vlc_meta_Publisher )
#define input_item_GetEncodedBy( item )      input_item_GetMeta( item, vlc_meta_EncodedBy )
#define input_item_GetArtURL( item )         input_item_GetMeta( item, vlc_meta_ArtworkURL )
#define input_item_GetTrackID( item )        input_item_GetMeta( item, vlc_meta_TrackID )
323
#define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
324

325
VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
326
VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) ATTRIBUTE_FORMAT( 4, 5 ) );
327

328
329
#define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
#define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
330
331
VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
332

333
334
#define input_ItemGetById(a,b) __input_ItemGetById( VLC_OBJECT(a),b )
VLC_EXPORT( input_item_t *, __input_ItemGetById, (vlc_object_t *, int ) );
335

336
337
338
339
340
341
/*****************************************************************************
 * Meta data helpers
 *****************************************************************************/
static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
                                                        const vlc_meta_t *p_meta )
{
342
343
    char * psz_value;

344
345
346
    if( !p_meta )
        return;

347
348
    if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
        (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
349
    {
350
        p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
351
352
353
354
355
        p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
    }
    else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
             (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
    {
356
        p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
357
358
359
360
361
        p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
    }
    else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
             (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
    {
362
        p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
363
364
365
366
        p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
    }
    else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
    {
367
        p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
368
        p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
369
370
371
    }
}

Laurent Aimar's avatar
Laurent Aimar committed
372
373
374
375
376
377
378
379
/*****************************************************************************
 * Seek point: (generalisation of chapters)
 *****************************************************************************/
struct seekpoint_t
{
    int64_t i_byte_offset;
    int64_t i_time_offset;
    char    *psz_name;
380
    int     i_level;
Laurent Aimar's avatar
Laurent Aimar committed
381
382
383
384
385
386
};

static inline seekpoint_t *vlc_seekpoint_New( void )
{
    seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
    point->i_byte_offset =
387
    point->i_time_offset = -1;
388
    point->i_level = 0;
Laurent Aimar's avatar
Laurent Aimar committed
389
390
391
392
393
394
395
    point->psz_name = NULL;
    return point;
}

static inline void vlc_seekpoint_Delete( seekpoint_t *point )
{
    if( !point ) return;
ivoire's avatar
ivoire committed
396
    free( point->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
    free( point );
}

static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
{
    seekpoint_t *point = vlc_seekpoint_New();
    if( src->psz_name ) point->psz_name = strdup( src->psz_name );
    point->i_time_offset = src->i_time_offset;
    point->i_byte_offset = src->i_byte_offset;
    return point;
}

/*****************************************************************************
 * Title:
 *****************************************************************************/
typedef struct
{
    char        *psz_name;

416
    bool  b_menu;      /* Is it a menu or a normal entry */
Laurent Aimar's avatar
Laurent Aimar committed
417
418
419
420
421
422
423
424
425
426

    int64_t     i_length;   /* Length(microsecond) if known, else 0 */
    int64_t     i_size;     /* Size (bytes) if known, else 0 */

    /* Title seekpoint */
    int         i_seekpoint;
    seekpoint_t **seekpoint;

} input_title_t;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
427
static inline input_title_t *vlc_input_title_New(void)
Laurent Aimar's avatar
Laurent Aimar committed
428
429
430
431
{
    input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );

    t->psz_name = NULL;
432
    t->b_menu = false;
Laurent Aimar's avatar
Laurent Aimar committed
433
434
435
436
437
438
439
    t->i_length = 0;
    t->i_size   = 0;
    t->i_seekpoint = 0;
    t->seekpoint = NULL;

    return t;
}
440

Laurent Aimar's avatar
Laurent Aimar committed
441
442
443
444
445
446
static inline void vlc_input_title_Delete( input_title_t *t )
{
    int i;
    if( t == NULL )
        return;

ivoire's avatar
ivoire committed
447
    free( t->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
448
449
    for( i = 0; i < t->i_seekpoint; i++ )
    {
ivoire's avatar
ivoire committed
450
        free( t->seekpoint[i]->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
451
452
        free( t->seekpoint[i] );
    }
ivoire's avatar
ivoire committed
453
    free( t->seekpoint );
Laurent Aimar's avatar
Laurent Aimar committed
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
    free( t );
}

static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
{
    input_title_t *dup = vlc_input_title_New( );
    int i;

    if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
    dup->b_menu      = t->b_menu;
    dup->i_length    = t->i_length;
    dup->i_size      = t->i_size;
    dup->i_seekpoint = t->i_seekpoint;
    if( t->i_seekpoint > 0 )
    {
        dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
                                                sizeof(seekpoint_t*) );

        for( i = 0; i < t->i_seekpoint; i++ )
        {
            dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
        }
    }

    return dup;
}
480
481
482
483
484
485
486
487
/*****************************************************************************
 * Attachments
 *****************************************************************************/
struct input_attachment_t
{
    char *psz_name;
    char *psz_mime;
    char *psz_description;
Laurent Aimar's avatar
Laurent Aimar committed
488

489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
    int  i_data;
    void *p_data;
};
static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
                                                            const char *psz_mime,
                                                            const char *psz_description,
                                                            const void *p_data,
                                                            int i_data )
{
    input_attachment_t *a =
        (input_attachment_t*)malloc( sizeof(input_attachment_t) );
    if( !a )
        return NULL;
    a->psz_name = strdup( psz_name ? psz_name : "" );
    a->psz_mime = strdup( psz_mime ? psz_mime : "" );
    a->psz_description = strdup( psz_description ? psz_description : "" );
    a->i_data = i_data;
    a->p_data = NULL;
    if( i_data > 0 )
    {
        a->p_data = malloc( i_data );
        if( a->p_data && p_data )
            memcpy( a->p_data, p_data, i_data );
    }
    return a;
}
static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
{
    return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
                                     a->p_data, a->i_data );
}
static inline void vlc_input_attachment_Delete( input_attachment_t *a )
{
    if( !a )
        return;
    free( a->psz_name );
    free( a->psz_mime );
    free( a->psz_description );
ivoire's avatar
ivoire committed
527
    free( a->p_data );
528
529
    free( a );
}
Laurent Aimar's avatar
Laurent Aimar committed
530
531
532
533
534
535
536
/*****************************************************************************
 * input defines/constants.
 *****************************************************************************/

/* "state" value */
enum input_state_e
{
537
    INIT_S,
damienf's avatar
damienf committed
538
539
    OPENING_S,
    BUFFERING_S,
Laurent Aimar's avatar
Laurent Aimar committed
540
541
    PLAYING_S,
    PAUSE_S,
542
543
    END_S,
    ERROR_S
Laurent Aimar's avatar
Laurent Aimar committed
544
545
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
546
547
548
549
/* "rate" default, min/max
 * A rate below 1000 plays the movie faster,
 * A rate above 1000 plays the movie slower.
 */
Laurent Aimar's avatar
Laurent Aimar committed
550
551
#define INPUT_RATE_DEFAULT  1000
#define INPUT_RATE_MIN       125            /* Up to 8/1 */
sigmunau's avatar
sigmunau committed
552
#define INPUT_RATE_MAX     32000            /* Up to 1/32 */
Laurent Aimar's avatar
Laurent Aimar committed
553
554
555
556
557
558

/* i_update field of access_t/demux_t */
#define INPUT_UPDATE_NONE       0x0000
#define INPUT_UPDATE_SIZE       0x0001
#define INPUT_UPDATE_TITLE      0x0010
#define INPUT_UPDATE_SEEKPOINT  0x0020
559
#define INPUT_UPDATE_META       0x0040
Laurent Aimar's avatar
Laurent Aimar committed
560
561
562
563

/* Input control XXX: internal */
#define INPUT_CONTROL_FIFO_SIZE    100

zorglub's avatar
zorglub committed
564
565
566
567
568
569
570
571
572
573
/** Get the input item for an input thread */
VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));

typedef struct input_thread_private_t input_thread_private_t;

/**
 * Main structure representing an input thread. This structure is mostly
 * private. The only public fields are READ-ONLY. You must use the helpers
 * to modify them
 */
Laurent Aimar's avatar
Laurent Aimar committed
574
575
struct input_thread_t
{
zorglub's avatar
zorglub committed
576
    VLC_COMMON_MEMBERS;
Laurent Aimar's avatar
Laurent Aimar committed
577

578
579
    bool  b_eof;
    bool b_preparsing;
580

zorglub's avatar
zorglub committed
581
    int i_state;
582
    bool b_can_pace_control;
Laurent Aimar's avatar
Laurent Aimar committed
583
    int64_t     i_time;     /* Current time */
584

zorglub's avatar
zorglub committed
585
586
587
588
589
590
    /* Internal caching common to all inputs */
    int i_pts_delay;

    /* All other data is input_thread is PRIVATE. You can't access it
     * outside of src/input */
    input_thread_private_t *p;
Laurent Aimar's avatar
Laurent Aimar committed
591
592
593
594
595
};

/*****************************************************************************
 * Prototypes
 *****************************************************************************/
596
597
598

/* input_CreateThread
 * Release the returned input_thread_t using vlc_object_release() */
Laurent Aimar's avatar
Laurent Aimar committed
599
600
#define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
601

602
603
#define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
604
605

#define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
606
VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) );
Laurent Aimar's avatar
Laurent Aimar committed
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );

enum input_query_e
{
    /* input variable "position" */
    INPUT_GET_POSITION,         /* arg1= double *       res=    */
    INPUT_SET_POSITION,         /* arg1= double         res=can fail    */

    /* input variable "length" */
    INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */

    /* input variable "time" */
    INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
    INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */

    /* input variable "rate" (1 is DEFAULT_RATE) */
    INPUT_GET_RATE,             /* arg1= int *          res=    */
    INPUT_SET_RATE,             /* arg1= int            res=can fail    */

    /* input variable "state" */
    INPUT_GET_STATE,            /* arg1= int *          res=    */
    INPUT_SET_STATE,            /* arg1= int            res=can fail    */

hartman's avatar
hartman committed
630
    /* input variable "audio-delay" and "sub-delay" */
631
632
633
634
635
636
    INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
    INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
    INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
    INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */

    /* Meta datas */
637
638
639
640
    INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
    INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
    INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
    INPUT_SET_NAME,   /* arg1= char* res=can fail    */
641

642
643
644
645
646
647
    /* Input config options */
    INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/

    /* Input properties */
    INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
    INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
648
    INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
649

Laurent Aimar's avatar
Laurent Aimar committed
650
651
652
653
654
655
656
    /* bookmarks */
    INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
    INPUT_CLEAR_BOOKMARKS, /* res=can fail */
    INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
    INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
    INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
    INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
657

658
659
660
661
    /* Attachments */
    INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
    INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */

662
    /* On the fly input slave */
zorglub's avatar
zorglub committed
663
    INPUT_ADD_SLAVE        /* arg1= char * */
Laurent Aimar's avatar
Laurent Aimar committed
664
665
666
667
668
};

VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );

669
VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, bool b_force_decoder ) );
Laurent Aimar's avatar
Laurent Aimar committed
670
671
672
VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );

673
VLC_EXPORT( bool, input_AddSubtitles, ( input_thread_t *, char *, bool ) );
674

Laurent Aimar's avatar
Laurent Aimar committed
675
#endif