1 /*****************************************************************************
2 * input_programs.c: es_descriptor_t, pgrm_descriptor_t management
3 *****************************************************************************
4 * Copyright (C) 1999-2002 VideoLAN
5 * $Id: input_programs.c,v 1.104 2003/04/13 20:00:21 fenrir Exp $
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
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.
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.
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
28 #include <string.h> /* memcpy(), memset() */
32 #include "stream_control.h"
33 #include "input_ext-intf.h"
34 #include "input_ext-dec.h"
35 #include "input_ext-plugins.h"
38 * NOTICE : all of these functions expect you to have taken the lock on
39 * p_input->stream.lock
42 /* Navigation callbacks */
43 static int ProgramCallback( vlc_object_t *, char const *,
44 vlc_value_t, vlc_value_t, void * );
45 static int TitleCallback( vlc_object_t *, char const *,
46 vlc_value_t, vlc_value_t, void * );
47 static int ChapterCallback( vlc_object_t *, char const *,
48 vlc_value_t, vlc_value_t, void * );
49 static int NavigationCallback( vlc_object_t *, char const *,
50 vlc_value_t, vlc_value_t, void * );
52 /*****************************************************************************
53 * input_InitStream: init the stream descriptor of the given input
54 *****************************************************************************/
55 int input_InitStream( input_thread_t * p_input, size_t i_data_len )
58 p_input->stream.i_stream_id = 0;
60 /* initialized to 0 since we don't give the signal to the interface
61 * before the end of input initialization */
62 p_input->stream.b_changed = 0;
63 p_input->stream.pp_es = NULL;
64 p_input->stream.pp_selected_es = NULL;
65 p_input->stream.p_removed_es = NULL;
66 p_input->stream.p_newly_selected_es = NULL;
67 p_input->stream.pp_programs = NULL;
68 p_input->stream.p_selected_program = NULL;
69 p_input->stream.p_new_program = NULL;
73 if ( (p_input->stream.p_demux_data = malloc( i_data_len )) == NULL )
75 msg_Err( p_input, "out of memory" );
78 memset( p_input->stream.p_demux_data, 0, i_data_len );
82 p_input->stream.p_demux_data = NULL;
85 /* Create a few object variables used for navigation in the interfaces */
86 var_Create( p_input, "program", VLC_VAR_INTEGER | VLC_VAR_HASCHOICE );
87 var_Create( p_input, "title", VLC_VAR_INTEGER | VLC_VAR_HASCHOICE );
88 var_Create( p_input, "chapter", VLC_VAR_INTEGER | VLC_VAR_HASCHOICE );
89 var_Create( p_input, "navigation", VLC_VAR_VARIABLE | VLC_VAR_HASCHOICE );
90 var_AddCallback( p_input, "program", ProgramCallback, NULL );
91 var_AddCallback( p_input, "title", TitleCallback, NULL );
92 var_AddCallback( p_input, "chapter", ChapterCallback, NULL );
97 /*****************************************************************************
98 * input_EndStream: free all stream descriptors
99 *****************************************************************************/
100 void input_EndStream( input_thread_t * p_input )
102 /* Free navigation variables */
103 var_Destroy( p_input, "program" );
104 var_Destroy( p_input, "title" );
105 var_Destroy( p_input, "chapter" );
107 /* Free all programs and associated ES, and associated decoders. */
108 while( p_input->stream.i_pgrm_number )
110 input_DelProgram( p_input, p_input->stream.pp_programs[0] );
113 /* Free standalone ES */
114 while( p_input->stream.i_es_number )
116 input_DelES( p_input, p_input->stream.pp_es[0] );
120 while( p_input->stream.i_area_nb )
122 input_DelArea( p_input, p_input->stream.pp_areas[0] );
125 /* Free selected ES */
126 if( p_input->stream.pp_selected_es != NULL )
128 free( p_input->stream.pp_selected_es );
131 if( p_input->stream.p_demux_data != NULL )
133 free( p_input->stream.p_demux_data );
137 /*****************************************************************************
138 * input_FindProgram: returns a pointer to a program described by its ID
139 *****************************************************************************/
140 pgrm_descriptor_t * input_FindProgram( input_thread_t * p_input,
145 for( i = 0; i < p_input->stream.i_pgrm_number; i++ )
147 if( p_input->stream.pp_programs[i]->i_number == i_pgrm_id )
149 return p_input->stream.pp_programs[i];
156 /*****************************************************************************
157 * input_AddProgram: add and init a program descriptor
158 *****************************************************************************
159 * This program descriptor will be referenced in the given stream descriptor
160 *****************************************************************************/
161 pgrm_descriptor_t * input_AddProgram( input_thread_t * p_input,
162 u16 i_pgrm_id, size_t i_data_len )
164 /* Where to add the pgrm */
165 pgrm_descriptor_t * p_pgrm = malloc( sizeof(pgrm_descriptor_t) );
170 msg_Err( p_input, "out of memory" );
174 /* Init this entry */
175 p_pgrm->i_number = i_pgrm_id;
177 p_pgrm->i_version = 0;
179 p_pgrm->i_es_number = 0;
180 p_pgrm->pp_es = NULL;
182 input_ClockInit( p_pgrm );
184 p_pgrm->i_synchro_state = SYNCHRO_START;
188 p_pgrm->p_demux_data = malloc( i_data_len );
189 if( p_pgrm->p_demux_data == NULL )
191 msg_Err( p_input, "out of memory" );
194 memset( p_pgrm->p_demux_data, 0, i_data_len );
198 p_pgrm->p_demux_data = NULL;
201 /* Add an entry to the list of program associated with the stream */
202 INSERT_ELEM( p_input->stream.pp_programs,
203 p_input->stream.i_pgrm_number,
204 p_input->stream.i_pgrm_number,
207 val.i_int = i_pgrm_id;
208 var_Change( p_input, "program", VLC_VAR_ADDCHOICE, &val );
213 /*****************************************************************************
214 * input_DelProgram: destroy a program descriptor
215 *****************************************************************************
216 * All ES descriptions referenced in the descriptor will be deleted.
217 *****************************************************************************/
218 void input_DelProgram( input_thread_t * p_input, pgrm_descriptor_t * p_pgrm )
220 unsigned int i_pgrm_index;
223 /* Find the program in the programs table */
224 for( i_pgrm_index = 0; i_pgrm_index < p_input->stream.i_pgrm_number;
227 if( p_input->stream.pp_programs[i_pgrm_index] == p_pgrm )
231 /* If the program wasn't found, do nothing */
232 if( i_pgrm_index == p_input->stream.i_pgrm_number )
234 msg_Err( p_input, "program does not belong to this input" );
238 val.i_int = i_pgrm_index;
239 var_Change( p_input, "program", VLC_VAR_DELCHOICE, &val );
241 /* Free the structures that describe the es that belongs to that program */
242 while( p_pgrm->i_es_number )
244 input_DelES( p_input, p_pgrm->pp_es[0] );
247 /* Free the demux data */
248 if( p_pgrm->p_demux_data != NULL )
250 free( p_pgrm->p_demux_data );
253 /* Remove this program from the stream's list of programs */
254 REMOVE_ELEM( p_input->stream.pp_programs,
255 p_input->stream.i_pgrm_number,
258 /* Free the description of this program */
262 /*****************************************************************************
263 * input_AddArea: add and init an area descriptor
264 *****************************************************************************
265 * This area descriptor will be referenced in the given stream descriptor
266 *****************************************************************************/
267 input_area_t * input_AddArea( input_thread_t * p_input,
268 uint16_t i_area_id, uint16_t i_part_nb )
270 /* Where to add the pgrm */
271 input_area_t * p_area = malloc( sizeof(input_area_t) );
277 msg_Err( p_input, "out of memory" );
281 /* Init this entry */
282 p_area->i_id = i_area_id;
283 p_area->i_part_nb = i_part_nb;
288 p_area->i_seek = NO_SEEK;
290 /* Add an entry to the list of program associated with the stream */
291 INSERT_ELEM( p_input->stream.pp_areas,
292 p_input->stream.i_area_nb,
293 p_input->stream.i_area_nb,
296 /* Don't add empty areas */
300 /* Take care of the navigation variables */
301 val.i_int = i_area_id;
302 var_Change( p_input, "title", VLC_VAR_ADDCHOICE, &val );
304 val.psz_string = malloc( sizeof("title ") + 5 );
309 sprintf( val.psz_string, "title %2i", i_area_id );
310 var_Destroy( p_input, val.psz_string );
311 var_Create( p_input, val.psz_string, VLC_VAR_INTEGER |
312 VLC_VAR_HASCHOICE | VLC_VAR_ISCOMMAND );
313 var_AddCallback( p_input, val.psz_string, NavigationCallback,
314 (void *)(int)i_area_id );
316 var_Change( p_input, "navigation", VLC_VAR_ADDCHOICE, &val );
318 for( i = 1; i <= i_part_nb; i++ )
321 var_Change( p_input, val.psz_string, VLC_VAR_ADDCHOICE, &val2 );
328 /*****************************************************************************
329 * input_SetProgram: changes the current program
330 *****************************************************************************/
331 int input_SetProgram( input_thread_t * p_input, pgrm_descriptor_t * p_new_prg )
333 unsigned int i_es_index;
334 int i_required_audio_es;
335 int i_required_spu_es;
340 if ( p_input->stream.p_selected_program )
342 for ( i_es_index = 1 ; /* 0 should be the PMT */
343 i_es_index < p_input->stream.p_selected_program->
347 #define p_es p_input->stream.p_selected_program->pp_es[i_es_index]
348 if ( p_es->p_decoder_fifo ) /* if the ES was selected */
350 input_UnselectES( p_input , p_es );
355 /* Get the number of the required audio stream */
356 if( config_GetInt( p_input, "audio" ) )
358 /* Default is the first one */
359 i_required_audio_es = config_GetInt( p_input, "audio-channel" );
360 if( i_required_audio_es < 0 )
362 i_required_audio_es = 1;
367 i_required_audio_es = 0;
370 /* Same thing for subtitles */
371 if( config_GetInt( p_input, "video" ) )
373 /* for spu, default is none */
374 i_required_spu_es = config_GetInt( p_input, "spu-channel" );
375 if( i_required_spu_es < 0 )
377 i_required_spu_es = 0;
382 i_required_spu_es = 0;
385 for( i_es_index = 0 ; i_es_index < p_new_prg->i_es_number ; i_es_index ++ )
387 switch( p_new_prg->pp_es[i_es_index]->i_cat )
390 msg_Dbg( p_input, "selecting ES %x",
391 p_new_prg->pp_es[i_es_index]->i_id );
392 input_SelectES( p_input, p_new_prg->pp_es[i_es_index] );
396 if( i_audio_es <= i_required_audio_es )
398 msg_Dbg( p_input, "selecting ES %x",
399 p_new_prg->pp_es[i_es_index]->i_id );
400 input_SelectES( p_input, p_new_prg->pp_es[i_es_index]);
403 /* Not sure this one is fully specification-compliant */
406 if( i_spu_es <= i_required_spu_es )
408 msg_Dbg( p_input, "selecting ES %x",
409 p_new_prg->pp_es[i_es_index]->i_id );
410 input_SelectES( p_input, p_new_prg->pp_es[i_es_index] );
414 msg_Dbg( p_input, "ES %x has unknown type",
415 p_new_prg->pp_es[i_es_index]->i_id );
422 p_input->stream.p_selected_program = p_new_prg;
424 /* Update the navigation variables without triggering a callback */
425 val.i_int = p_new_prg->i_number;
426 var_Change( p_input, "program", VLC_VAR_SETVALUE, &val );
431 /*****************************************************************************
432 * input_DelArea: destroy a area descriptor
433 *****************************************************************************
434 * All ES descriptions referenced in the descriptor will be deleted.
435 *****************************************************************************/
436 void input_DelArea( input_thread_t * p_input, input_area_t * p_area )
438 unsigned int i_area_index;
441 /* Find the area in the areas table */
442 for( i_area_index = 0; i_area_index < p_input->stream.i_area_nb;
445 if( p_input->stream.pp_areas[i_area_index] == p_area )
449 /* If the area wasn't found, do nothing */
450 if( i_area_index == p_input->stream.i_area_nb )
452 msg_Err( p_input, "area does not belong to this input" );
456 /* Take care of the navigation variables */
457 val.psz_string = malloc( sizeof("title ") + 5 );
460 sprintf( val.psz_string, "title %i", p_area->i_id );
461 var_Change( p_input, "navigation", VLC_VAR_DELCHOICE, &val );
462 var_Destroy( p_input, val.psz_string );
465 /* Remove this area from the stream's list of areas */
466 REMOVE_ELEM( p_input->stream.pp_areas,
467 p_input->stream.i_area_nb,
470 /* Free the description of this area */
475 /*****************************************************************************
476 * input_FindES: returns a pointer to an ES described by its ID
477 *****************************************************************************/
478 es_descriptor_t * input_FindES( input_thread_t * p_input, uint16_t i_es_id )
482 for( i = 0; i < p_input->stream.i_es_number; i++ )
484 if( p_input->stream.pp_es[i]->i_id == i_es_id )
486 return p_input->stream.pp_es[i];
493 /*****************************************************************************
495 *****************************************************************************
496 * Reserve a slot in the table of ES descriptors for the ES and add it to the
497 * list of ES of p_pgrm. If p_pgrm if NULL, then the ES is considered as stand
499 *****************************************************************************/
500 es_descriptor_t * input_AddES( input_thread_t * p_input,
501 pgrm_descriptor_t * p_pgrm, u16 i_es_id,
504 es_descriptor_t * p_es;
506 p_es = (es_descriptor_t *)malloc( sizeof(es_descriptor_t) );
509 msg_Err( p_input, "out of memory" );
513 INSERT_ELEM( p_input->stream.pp_es,
514 p_input->stream.i_es_number,
515 p_input->stream.i_es_number,
518 /* Init its values */
519 p_es->i_id = i_es_id;
520 p_es->psz_desc[0] = '\0';
522 p_es->p_decoder_fifo = NULL;
523 p_es->i_cat = UNKNOWN_ES;
524 p_es->i_demux_fd = 0;
526 p_es->c_invalid_packets = 0;
527 p_es->b_force_decoder = VLC_FALSE;
531 p_es->p_demux_data = malloc( i_data_len );
532 if( p_es->p_demux_data == NULL )
534 msg_Err( p_input, "out of memory" );
537 memset( p_es->p_demux_data, 0, i_data_len );
541 p_es->p_demux_data = NULL;
543 p_es->p_waveformatex = NULL;
544 p_es->p_bitmapinfoheader = NULL;
546 /* Add this ES to the program definition if one is given */
549 INSERT_ELEM( p_pgrm->pp_es,
553 p_es->p_pgrm = p_pgrm;
563 /*****************************************************************************
565 *****************************************************************************/
566 void input_DelES( input_thread_t * p_input, es_descriptor_t * p_es )
568 unsigned int i_index, i_es_index;
569 pgrm_descriptor_t * p_pgrm;
571 /* Find the ES in the ES table */
572 for( i_es_index = 0; i_es_index < p_input->stream.i_es_number;
575 if( p_input->stream.pp_es[i_es_index] == p_es )
579 /* If the ES wasn't found, do nothing */
580 if( i_es_index == p_input->stream.i_es_number )
582 msg_Err( p_input, "ES does not belong to this input" );
586 p_pgrm = p_es->p_pgrm;
588 /* Kill associated decoder, if any. */
589 if( p_es->p_decoder_fifo != NULL )
591 input_EndDecoder( p_input, p_es );
594 /* Remove this ES from the description of the program if it is associated to
598 for( i_index = 0; i_index < p_pgrm->i_es_number; i_index++ )
600 if( p_pgrm->pp_es[i_index] == p_es )
602 REMOVE_ELEM( p_pgrm->pp_es,
610 /* Free the demux data */
611 if( p_es->p_demux_data != NULL )
613 free( p_es->p_demux_data );
615 if( p_es->p_waveformatex )
617 free( p_es->p_waveformatex );
619 if( p_es->p_bitmapinfoheader )
621 free( p_es->p_bitmapinfoheader );
624 /* Find the ES in the ES table */
625 for( i_es_index = 0; i_es_index < p_input->stream.i_es_number;
628 if( p_input->stream.pp_es[i_es_index] == p_es )
632 /* Remove this ES from the stream's list of ES */
633 REMOVE_ELEM( p_input->stream.pp_es,
634 p_input->stream.i_es_number,
641 /*****************************************************************************
642 * input_SelectES: selects an ES and spawns the associated decoder
643 *****************************************************************************
644 * Remember we are still supposed to have stream_lock when entering this
646 *****************************************************************************/
647 int input_SelectES( input_thread_t * p_input, es_descriptor_t * p_es )
651 msg_Err( p_input, "nothing to do in input_SelectES" );
655 if( ((p_es->i_cat == VIDEO_ES) || (p_es->i_cat == SPU_ES))
656 && !config_GetInt( p_input, "video" ) )
659 "video is disabled, not selecting ES 0x%x", p_es->i_id );
663 if( (p_es->i_cat == AUDIO_ES) && !config_GetInt( p_input, "audio" ) )
666 "audio is disabled, not selecting ES 0x%x", p_es->i_id );
670 msg_Dbg( p_input, "selecting ES 0x%x", p_es->i_id );
672 if( p_es->p_decoder_fifo != NULL )
674 msg_Err( p_input, "ES 0x%x is already selected", p_es->i_id );
678 /* Release the lock, not to block the input thread during
679 * the creation of the thread. */
680 vlc_mutex_unlock( &p_input->stream.stream_lock );
681 p_es->p_decoder_fifo = input_RunDecoder( p_input, p_es );
682 vlc_mutex_lock( &p_input->stream.stream_lock );
684 if( p_es->p_decoder_fifo == NULL )
692 /*****************************************************************************
693 * input_UnselectES: removes an ES from the list of selected ES
694 *****************************************************************************/
695 int input_UnselectES( input_thread_t * p_input, es_descriptor_t * p_es )
698 unsigned int i_index = 0;
702 msg_Err( p_input, "nothing to do in input_UnselectES" );
706 msg_Dbg( p_input, "unselecting ES 0x%x", p_es->i_id );
708 if( p_es->p_decoder_fifo == NULL )
710 msg_Err( p_input, "ES 0x%x is not selected", p_es->i_id );
714 input_EndDecoder( p_input, p_es );
717 if( ( p_es->p_decoder_fifo == NULL ) &&
718 ( p_input->stream.i_selected_es_number > 0 ) )
720 while( ( i_index < p_input->stream.i_selected_es_number - 1 ) &&
721 ( p_input->stream.pp_selected_es[i_index] != p_es ) )
726 /* XXX: no need to memmove, we have unsorted data */
727 REMOVE_ELEM( p_input->stream.pp_selected_es,
728 p_input->stream.i_selected_es_number,
731 if( p_input->stream.i_selected_es_number == 0 )
733 msg_Dbg( p_input, "no more selected ES" );
741 /*****************************************************************************
742 * Navigation callback: a bunch of navigation variables are used as an
743 * alternative to the navigation API.
744 *****************************************************************************/
745 static int ProgramCallback( vlc_object_t *p_this, char const *psz_cmd,
746 vlc_value_t oldval, vlc_value_t newval, void *p_data )
748 input_thread_t *p_input = (input_thread_t *)p_this;
750 if( oldval.i_int == newval.i_int )
753 vlc_mutex_lock( &p_input->stream.stream_lock );
754 if( ( newval.i_int > 0 ) )
756 vlc_mutex_unlock( &p_input->stream.stream_lock );
757 input_ChangeProgram( p_input, (uint16_t)newval.i_int );
758 input_SetStatus( p_input, INPUT_STATUS_PLAY );
759 vlc_mutex_lock( &p_input->stream.stream_lock );
761 vlc_mutex_unlock( &p_input->stream.stream_lock );
766 static int TitleCallback( vlc_object_t *p_this, char const *psz_cmd,
767 vlc_value_t oldval, vlc_value_t newval, void *p_data )
769 input_thread_t *p_input = (input_thread_t *)p_this;
770 input_area_t *p_area;
772 if( oldval.i_int == newval.i_int )
775 /* Sanity check should have already be done by var_Set(). */
776 vlc_mutex_lock( &p_input->stream.stream_lock );
777 p_area = p_input->stream.pp_areas[newval.i_int];
779 vlc_mutex_unlock( &p_input->stream.stream_lock );
780 input_ChangeArea( p_input, p_area );
781 input_SetStatus( p_input, INPUT_STATUS_PLAY );
786 static int ChapterCallback( vlc_object_t *p_this, char const *psz_cmd,
787 vlc_value_t oldval, vlc_value_t newval, void *p_data )
789 input_thread_t *p_input = (input_thread_t *)p_this;
790 input_area_t *p_area;
792 if( oldval.i_int == newval.i_int )
795 /* Sanity check will have already be done by var_Set(). */
796 vlc_mutex_lock( &p_input->stream.stream_lock );
797 p_area = p_input->stream.p_selected_area;
798 p_input->stream.p_selected_area->i_part = newval.i_int;
799 vlc_mutex_unlock( &p_input->stream.stream_lock );
801 input_ChangeArea( p_input, p_area );
802 input_SetStatus( p_input, INPUT_STATUS_PLAY );
807 static int NavigationCallback( vlc_object_t *p_this, char const *psz_cmd,
808 vlc_value_t oldval, vlc_value_t newval, void *p_data )
810 input_thread_t *p_input = (input_thread_t *)p_this;
811 uint16_t i_area_id = (int)p_data;
813 vlc_mutex_lock( &p_input->stream.stream_lock );
815 if( p_input->stream.p_selected_area->i_id == i_area_id &&
816 oldval.i_int == newval.i_int )
819 vlc_mutex_unlock( &p_input->stream.stream_lock );
823 if( ( i_area_id < p_input->stream.i_area_nb ) && ( newval.i_int > 0 ) &&
824 ( (uint16_t)newval.i_int <=
825 p_input->stream.pp_areas[i_area_id]->i_part_nb ) )
827 input_area_t *p_area = p_input->stream.pp_areas[i_area_id];
828 p_input->stream.p_selected_area->i_part = newval.i_int;
829 vlc_mutex_unlock( &p_input->stream.stream_lock );
830 input_ChangeArea( p_input, p_area );
831 input_SetStatus( p_input, INPUT_STATUS_PLAY );
832 vlc_mutex_lock( &p_input->stream.stream_lock );
834 vlc_mutex_unlock( &p_input->stream.stream_lock );