input_GetVout and input_GetAout helpers
[vlc.git] / 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 /* __ is need because conflict with <vlc/input.h> */
26 #ifndef VLC__INPUT_H
27 #define VLC__INPUT_H 1
28
29 /**
30  * \file
31  * This file defines functions, structures and enums for input objects in vlc
32  */
33
34 #include <vlc_es.h>
35 #include <vlc_meta.h>
36 #include <vlc_epg.h>
37 #include <vlc_events.h>
38 #include <vlc_input_item.h>
39
40 #include <string.h>
41
42 /*****************************************************************************
43  * Meta data helpers
44  *****************************************************************************/
45 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
46                                                         const vlc_meta_t *p_meta )
47 {
48     char * psz_value;
49
50     if( !p_meta )
51         return;
52
53     if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
54         (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
55     {
56         p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
57         p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
58     }
59     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
60              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
61     {
62         p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
63         p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
64     }
65     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
66              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
67     {
68         p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
69         p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
70     }
71     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
72     {
73         p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
74         p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
75     }
76 }
77
78 /*****************************************************************************
79  * Seek point: (generalisation of chapters)
80  *****************************************************************************/
81 struct seekpoint_t
82 {
83     int64_t i_byte_offset;
84     int64_t i_time_offset;
85     char    *psz_name;
86     int     i_level;
87 };
88
89 static inline seekpoint_t *vlc_seekpoint_New( void )
90 {
91     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
92     point->i_byte_offset =
93     point->i_time_offset = -1;
94     point->i_level = 0;
95     point->psz_name = NULL;
96     return point;
97 }
98
99 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
100 {
101     if( !point ) return;
102     free( point->psz_name );
103     free( point );
104 }
105
106 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
107 {
108     seekpoint_t *point = vlc_seekpoint_New();
109     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
110     point->i_time_offset = src->i_time_offset;
111     point->i_byte_offset = src->i_byte_offset;
112     return point;
113 }
114
115 /*****************************************************************************
116  * Title:
117  *****************************************************************************/
118 typedef struct
119 {
120     char        *psz_name;
121
122     bool        b_menu;      /* Is it a menu or a normal entry */
123
124     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
125     int64_t     i_size;     /* Size (bytes) if known, else 0 */
126
127     /* Title seekpoint */
128     int         i_seekpoint;
129     seekpoint_t **seekpoint;
130
131 } input_title_t;
132
133 static inline input_title_t *vlc_input_title_New(void)
134 {
135     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
136
137     t->psz_name = NULL;
138     t->b_menu = false;
139     t->i_length = 0;
140     t->i_size   = 0;
141     t->i_seekpoint = 0;
142     t->seekpoint = NULL;
143
144     return t;
145 }
146
147 static inline void vlc_input_title_Delete( input_title_t *t )
148 {
149     int i;
150     if( t == NULL )
151         return;
152
153     free( t->psz_name );
154     for( i = 0; i < t->i_seekpoint; i++ )
155     {
156         free( t->seekpoint[i]->psz_name );
157         free( t->seekpoint[i] );
158     }
159     free( t->seekpoint );
160     free( t );
161 }
162
163 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
164 {
165     input_title_t *dup = vlc_input_title_New( );
166     int i;
167
168     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
169     dup->b_menu      = t->b_menu;
170     dup->i_length    = t->i_length;
171     dup->i_size      = t->i_size;
172     dup->i_seekpoint = t->i_seekpoint;
173     if( t->i_seekpoint > 0 )
174     {
175         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
176                                                 sizeof(seekpoint_t*) );
177
178         for( i = 0; i < t->i_seekpoint; i++ )
179         {
180             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
181         }
182     }
183
184     return dup;
185 }
186
187 /*****************************************************************************
188  * Attachments
189  *****************************************************************************/
190 struct input_attachment_t
191 {
192     char *psz_name;
193     char *psz_mime;
194     char *psz_description;
195
196     int  i_data;
197     void *p_data;
198 };
199
200 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
201                                                             const char *psz_mime,
202                                                             const char *psz_description,
203                                                             const void *p_data,
204                                                             int i_data )
205 {
206     input_attachment_t *a =
207         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
208     if( !a )
209         return NULL;
210     a->psz_name = strdup( psz_name ? psz_name : "" );
211     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
212     a->psz_description = strdup( psz_description ? psz_description : "" );
213     a->i_data = i_data;
214     a->p_data = NULL;
215     if( i_data > 0 )
216     {
217         a->p_data = malloc( i_data );
218         if( a->p_data && p_data )
219             memcpy( a->p_data, p_data, i_data );
220     }
221     return a;
222 }
223 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
224 {
225     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
226                                      a->p_data, a->i_data );
227 }
228 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
229 {
230     if( !a )
231         return;
232     free( a->psz_name );
233     free( a->psz_mime );
234     free( a->psz_description );
235     free( a->p_data );
236     free( a );
237 }
238
239 /*****************************************************************************
240  * input defines/constants.
241  *****************************************************************************/
242
243 /* i_update field of access_t/demux_t */
244 #define INPUT_UPDATE_NONE       0x0000
245 #define INPUT_UPDATE_SIZE       0x0001
246 #define INPUT_UPDATE_TITLE      0x0010
247 #define INPUT_UPDATE_SEEKPOINT  0x0020
248 #define INPUT_UPDATE_META       0x0040
249 #define INPUT_UPDATE_SIGNAL     0x0080
250
251 /** Get the input item for an input thread
252  * FIXME see src/input/item.c but is is unsafe unless
253  * you hold p_input
254  */
255 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
256
257 typedef struct input_thread_private_t input_thread_private_t;
258
259 /**
260  * Main structure representing an input thread. This structure is mostly
261  * private. The only public fields are READ-ONLY. You must use the helpers
262  * to modify them
263  */
264 struct input_thread_t
265 {
266     VLC_COMMON_MEMBERS;
267
268     bool b_eof;
269     bool b_preparsing;
270     bool b_dead;
271
272     /* All other data is input_thread is PRIVATE. You can't access it
273      * outside of src/input */
274     input_thread_private_t *p;
275 };
276
277 /**
278  * Record prefix string.
279  * TODO make it configurable.
280  */
281 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
282
283 /*****************************************************************************
284  * Input events and variables
285  *****************************************************************************/
286
287 /**
288  * \defgroup inputvariable Input variables
289  *
290  * The input provides multiples variable you can write to and/or read from.
291  *
292  * TODO complete the documentation.
293  * The read only variables are:
294  *  - "length"
295  *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
296  *    or not, for that check position != 0.0)
297  *  - "can-pause"
298  *  - "can-rate"
299  *  - "can-rewind"
300  *  - "can-record" (if a stream can be recorded while playing)
301  *  - "teletext-es" to get the index of spu track that is teletext -1 if no teletext)
302  *  - "signal-quality"
303  *  - "signal-strength"
304  *  - "cache" (level of data cached [0 .. 1])
305  *
306  * The read-write variables are:
307  *  - state (\see input_state_e)
308  *  - rate, rate-slower, rate-faster
309  *  - position, position-offset
310  *  - time, time-offset
311  *  - title, next-title, prev-title
312  *  - chapter, next-chapter, next-chapter-prev
313  *  - program, audio-es, video-es, spu-es
314  *  - audio-delay, spu-delay
315  *  - bookmark (bookmark list)
316  *  - record
317  *  - frame-next
318  *  - navigation (list of "title %2i")
319  *  - "title %2i"
320  *
321  * The variable used for event is
322  *  - intf-event (\see input_event_type_e)
323  */
324
325 /**
326  * Input state
327  *
328  * This enum is used by the variable "state"
329  */
330 typedef enum input_state_e
331 {
332     INIT_S = 0,
333     OPENING_S,
334     PLAYING_S,
335     PAUSE_S,
336     END_S,
337     ERROR_S,
338 } input_state_e;
339
340 /**
341  * Input rate.
342  *
343  * It is an integer used by the variable "rate" in the
344  * range [INPUT_RATE_MIN, INPUT_RATE_MAX] the default value
345  * being INPUT_RATE_DEFAULT.
346  *
347  * A value lower than INPUT_RATE_DEFAULT plays faster.
348  * A value higher than INPUT_RATE_DEFAULT plays slower.
349  */
350
351 /**
352  * Default rate value
353  */
354 #define INPUT_RATE_DEFAULT  1000
355 /**
356  * Minimal rate value
357  */
358 #define INPUT_RATE_MIN        32            /* Up to 32/1 */
359 /**
360  * Maximal rate value
361  */
362 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
363
364 /**
365  * Input events
366  *
367  * You can catch input event by adding a callback on the variable "intf-event".
368  * This variable is an integer that will hold a input_event_type_e value.
369  */
370 typedef enum input_event_type_e
371 {
372     /* "state" has changed */
373     INPUT_EVENT_STATE,
374     /* b_dead is true */
375     INPUT_EVENT_DEAD,
376
377     /* "rate" has changed */
378     INPUT_EVENT_RATE,
379
380     /* At least one of "position" or "time" or "length" has changed */
381     INPUT_EVENT_TIMES,
382
383     /* A title has been added or removed or selected.
384      * It imply that chapter has changed (not chapter event is sent) */
385     INPUT_EVENT_TITLE,
386     /* A chapter has been added or removed or selected. */
387     INPUT_EVENT_CHAPTER,
388
389     /* A program has been added or removed or selected */
390     INPUT_EVENT_PROGRAM,
391     /* A ES has been added or removed or selected */
392     INPUT_EVENT_ES,
393     /* "teletext-es" has changed */
394     INPUT_EVENT_TELETEXT,
395
396     /* "record" has changed */
397     INPUT_EVENT_RECORD,
398
399     /* input_item_t media has changed */
400     INPUT_EVENT_ITEM_META,
401     /* input_item_t info has changed */
402     INPUT_EVENT_ITEM_INFO,
403     /* input_item_t name has changed */
404     INPUT_EVENT_ITEM_NAME,
405
406     /* Input statistics have been updated */
407     INPUT_EVENT_STATISTICS,
408     /* At least one of "signal-quality" or "signal-strength" has changed */
409     INPUT_EVENT_SIGNAL,
410
411     /* "audio-delay" has changed */
412     INPUT_EVENT_AUDIO_DELAY,
413     /* "spu-delay" has changed */
414     INPUT_EVENT_SUBTITLE_DELAY,
415
416     /* "bookmark" has changed */
417     INPUT_EVENT_BOOKMARK,
418
419     /* cache" has changed */
420     INPUT_EVENT_CACHE,
421
422     /* A aout_instance_t object has been created/deleted by *the input* */
423     INPUT_EVENT_AOUT,
424     /* A vout_thread_t object has been created/deleted by *the input* */
425     INPUT_EVENT_VOUT,
426
427 } input_event_type_e;
428
429 /** @}*/
430
431 /*****************************************************************************
432  * Prototypes
433  *****************************************************************************/
434
435 /* input_CreateThread
436  * Release the returned input_thread_t using vlc_object_release() */
437 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
438 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
439
440 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
441
442 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
443 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
444
445 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
446 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) );
447
448 enum input_query_e
449 {
450     /* input variable "position" */
451     INPUT_GET_POSITION,         /* arg1= double *       res=    */
452     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
453
454     /* input variable "length" */
455     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
456
457     /* input variable "time" */
458     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
459     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
460
461     /* input variable "rate" (1 is DEFAULT_RATE) */
462     INPUT_GET_RATE,             /* arg1= int *          res=    */
463     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
464
465     /* input variable "state" */
466     INPUT_GET_STATE,            /* arg1= int *          res=    */
467     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
468
469     /* input variable "audio-delay" and "sub-delay" */
470     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
471     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
472     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
473     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
474
475     /* Meta datas */
476     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
477     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
478     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
479     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
480
481     /* Input config options */
482     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
483
484     /* Input properties */
485     INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
486
487     /* bookmarks */
488     INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
489     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
490     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
491     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
492     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
493     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
494     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
495
496     /* Attachments */
497     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
498     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
499
500     /* On the fly input slave */
501     INPUT_ADD_SLAVE,       /* arg1= const char * */
502     INPUT_ADD_SUBTITLE,    /* arg1= const char *, arg2=bool b_check_extension */
503
504     /* On the fly record while playing */
505     INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
506     INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
507
508     /* ES */
509     INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
510
511     /* Input ressources
512      * XXX You must call vlc_object_release as soon as possible */
513     INPUT_GET_AOUT,         /* arg1=aout_instance_t **              res=can fail */
514     INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, int *        res=can fail */
515 };
516
517 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
518 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
519
520 /**
521  * It will return the current state of the input.
522  * Provided for convenience.
523  */
524 static inline input_state_e input_GetState( input_thread_t * p_input )
525 {
526     input_state_e state = INIT_S;
527     input_Control( p_input, INPUT_GET_STATE, &state );
528     return state;
529 }
530 /**
531  * It will add a new subtitle source to the input.
532  * Provided for convenience.
533  */
534 static inline int input_AddSubtitle( input_thread_t *p_input, const char *psz_url, bool b_check_extension )
535 {
536     return input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension );
537 }
538
539 /**
540  * Return one of the video output (if any). If possible, you should use
541  * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
542  * @param p_input an input thread from which to get a video output
543  * @return NULL on error, or a video output thread pointer (which needs to be
544  * released with vlc_object_release()).
545  */
546 static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
547 {
548      vout_thread_t **pp_vout, *p_vout;
549      unsigned i_vout;
550
551      if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
552          return NULL;
553
554      for( unsigned i = 1; i < i_vout; i++ )
555          vlc_object_release( (vlc_object_t *)(pp_vout[i]) );
556
557      p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
558      free (pp_vout);
559      return p_vout;
560 }
561
562 /**
563  * Return the audio output (if any) associated with an input.
564  * @param p_input an input thread
565  * @return NULL on error, or the audio output (which needs to be
566  * released with vlc_object_release()).
567  */
568 static inline aout_instance_t *input_GetAout( input_thread_t *p_input )
569 {
570      aout_instance_t *p_aout;
571      return input_Control( p_input, INPUT_GET_VOUTS, &p_aout ) ? NULL : p_aout;
572 }
573
574 /* */
575 typedef struct input_clock_t input_clock_t;
576 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, input_clock_t *, sout_instance_t * ) );
577 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
578 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
579
580 /**
581  * This function allows to split a MRL into access, demux and path part.
582  *
583  *  You should not write into access and demux string as they may not point into
584  * the provided buffer.
585  *  The buffer provided by psz_dup will be modified.
586  */
587 VLC_EXPORT( void, input_SplitMRL, ( const char **ppsz_access, const char **ppsz_demux, char **ppsz_path, char *psz_dup ) );
588
589 /**
590  * This function creates a sane filename path.
591  */
592 VLC_EXPORT( char *, input_CreateFilename, ( vlc_object_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) );
593
594 #endif