]> git.sesse.net Git - vlc/blob - plugins/vcd/input_vcd.c
* Got rid of TRACE and intf_DbgMsg which were seldom used anyway.
[vlc] / plugins / vcd / input_vcd.c
1 /****************************************************************************
2  * input_vcd.c: VideoCD raw reading plugin.
3  *****************************************************************************
4  * Copyright (C) 1998-2001 VideoLAN
5  *
6  * Author: Johan Bilien <jobi@via.ecp.fr>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  * 
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
21  *****************************************************************************/
22
23 /*****************************************************************************
24  * Preamble
25  *****************************************************************************/
26 #include <stdio.h>
27 #include <stdlib.h>
28
29 #include <videolan/vlc.h>
30
31 #ifdef HAVE_UNISTD_H
32 #   include <unistd.h>
33 #endif
34
35 #include <fcntl.h>
36 #include <sys/types.h>
37 #include <string.h>
38 #include <errno.h>
39
40 #ifdef STRNCASECMP_IN_STRINGS_H
41 #   include <strings.h>
42 #endif
43
44 #if defined( WIN32 )
45 #   include <io.h>                                                 /* read() */
46 #else
47 #   include <sys/uio.h>                                      /* struct iovec */
48 #endif
49
50 #if defined( WIN32 )
51 #   include "input_iovec.h"
52 #endif
53
54 #include "stream_control.h"
55 #include "input_ext-intf.h"
56 #include "input_ext-dec.h"
57 #include "input_ext-plugins.h"
58
59 #include "debug.h"
60
61 #include "input_vcd.h"
62 #include "linux_cdrom_tools.h"
63
64 /* how many blocks VCDRead will read in each loop */
65 #define VCD_BLOCKS_ONCE 4
66 #define VCD_DATA_ONCE   (2 * VCD_BLOCKS_ONCE)
67 #define BUFFER_SIZE VCD_DATA_SIZE
68
69 /*****************************************************************************
70  * Local prototypes
71  *****************************************************************************/
72 /* called from outside */
73 static int  VCDProbe        ( struct input_thread_s * );
74 static void VCDInit         ( struct input_thread_s * );
75 static int  VCDRead         ( struct input_thread_s *, data_packet_t ** );
76 static int  VCDSetArea      ( struct input_thread_s *, struct input_area_s * );
77 static int  VCDSetProgram   ( struct input_thread_s *, pgrm_descriptor_t * );
78 static void VCDOpen         ( struct input_thread_s *);
79 static void VCDClose        ( struct input_thread_s *);
80 static void VCDEnd          ( struct input_thread_s *);
81 static void VCDSeek         ( struct input_thread_s *, off_t );
82 static int  VCDRewind       ( struct input_thread_s * );
83
84 /*****************************************************************************
85  * Declare a buffer manager
86  *****************************************************************************/
87 #define FLAGS           BUFFERS_NOFLAGS
88 #define NB_LIFO         2
89 DECLARE_BUFFERS_EMBEDDED( FLAGS, NB_LIFO );
90 DECLARE_BUFFERS_INIT( FLAGS, NB_LIFO );
91 DECLARE_BUFFERS_END( FLAGS, NB_LIFO );
92 DECLARE_BUFFERS_NEWPACKET( FLAGS, NB_LIFO );
93 DECLARE_BUFFERS_DELETEPACKET( FLAGS, NB_LIFO, 1000 );
94 DECLARE_BUFFERS_NEWPES( FLAGS, NB_LIFO );
95 DECLARE_BUFFERS_DELETEPES( FLAGS, NB_LIFO, 1000 );
96
97
98 /*****************************************************************************
99  * Functions exported as capabilities. They are declared as static so that
100  * we don't pollute the namespace too much.
101  *****************************************************************************/
102 void _M( input_getfunctions )( function_list_t * p_function_list )
103 {
104 #define input p_function_list->functions.input
105     input.pf_probe            = VCDProbe;
106     input.pf_init             = VCDInit;
107     input.pf_open             = VCDOpen;
108     input.pf_close            = VCDClose;
109     input.pf_end              = VCDEnd;
110     input.pf_init_bit_stream  = InitBitstream;
111     input.pf_read             = VCDRead;
112     input.pf_set_area         = VCDSetArea;
113     input.pf_set_program      = VCDSetProgram;
114     input.pf_demux            = input_DemuxPS;
115     input.pf_new_packet       = input_NewPacket;
116     input.pf_new_pes          = input_NewPES;
117     input.pf_delete_packet    = input_DeletePacket;
118     input.pf_delete_pes       = input_DeletePES;
119     input.pf_rewind           = VCDRewind;
120     input.pf_seek             = VCDSeek;
121 #undef input
122 }
123
124 /*
125  * Data reading functions
126  */
127
128 /*****************************************************************************
129  * VCDProbe: verifies that the stream is a PS stream
130  *****************************************************************************/
131 static int VCDProbe( input_thread_t * p_input )
132 {
133     char * psz_name = p_input->p_source;
134
135     if( ( strlen(psz_name) > 4 ) && !strncasecmp( psz_name, "vcd:", 4 ) )
136     {
137         /* If the user specified "vcd:" then it's probably a VCD */
138         return 0;
139     }
140
141     return -1;
142 }
143
144 /*****************************************************************************
145  * VCDOpen: open vcd
146  *****************************************************************************/
147 static void VCDOpen( struct input_thread_s *p_input )
148 {
149     vlc_mutex_lock( &p_input->stream.stream_lock );
150
151     /* If we are here we can control the pace... */
152     p_input->stream.b_pace_control = 1;
153
154     p_input->stream.b_seekable = 1;
155     p_input->stream.p_selected_area->i_size = 0;
156     p_input->stream.p_selected_area->i_tell = 0;
157
158     vlc_mutex_unlock( &p_input->stream.stream_lock );
159
160     /* XXX: put this shit in an access plugin */
161     if( strlen( p_input->p_source ) > 4
162          && !strncasecmp( p_input->p_source, "vcd:", 4 ) )
163     {
164         p_input->i_handle
165             = open( p_input->p_source + 4, O_RDONLY | O_NONBLOCK );
166     }
167     else
168     {
169         p_input->i_handle
170             = open( p_input->p_source, O_RDONLY | O_NONBLOCK );
171     }
172
173     if( p_input->i_handle == -1 )
174     {
175         p_input->b_error = 1;
176     }
177 }
178
179 /*****************************************************************************
180  * VCDClose: close vcd
181  *****************************************************************************/
182 static void VCDClose( struct input_thread_s *p_input )
183 {
184     close( p_input->i_handle );
185 }
186
187 /*****************************************************************************
188  * VCDInit: initializes VCD structures
189  *****************************************************************************/
190 static void VCDInit( input_thread_t * p_input )
191 {
192     thread_vcd_data_t *  p_vcd;
193     int                  i_title;
194     int                  i_chapter;
195     int                  i;
196     input_area_t *       p_area;
197     es_descriptor_t *    p_es;
198
199     p_vcd = malloc( sizeof(thread_vcd_data_t) );
200
201     if( p_vcd == NULL )
202     {
203         intf_ErrMsg( "vcd error: out of memory" );
204         p_input->b_error = 1;
205         return;
206     }
207
208     p_input->p_plugin_data = (void *)p_vcd;
209
210     if( (p_input->p_method_data = input_BuffersInit()) == NULL )
211     {
212         free( p_vcd );
213         p_input->b_error = 1;
214         return;
215     }
216
217     p_vcd->i_handle = p_input->i_handle;
218
219     /* We read the Table Of Content information */
220     p_vcd->nb_tracks = ioctl_GetTrackCount( p_input->i_handle );
221     if( p_vcd->nb_tracks < 0 )
222     {
223         input_BuffersEnd( p_input->p_method_data );
224         free( p_vcd );
225         p_input->b_error = 1;
226         return;
227     }
228     else if( p_vcd->nb_tracks <= 1 )
229     {
230         intf_ErrMsg( "input error: no movie tracks found" );
231         input_BuffersEnd( p_input->p_method_data );
232         free( p_vcd );
233         p_input->b_error = 1;
234         return;
235     }
236
237     p_vcd->p_sectors = ioctl_GetSectors( p_input->i_handle );
238     if ( p_vcd->p_sectors == NULL )
239     {
240         input_BuffersEnd( p_input->p_method_data );
241         free( p_vcd );
242         p_input->b_error = 1;
243         return;
244     }
245
246     /* Set stream and area data */
247     vlc_mutex_lock( &p_input->stream.stream_lock );
248
249     /* Initialize ES structures */
250     input_InitStream( p_input, sizeof( stream_ps_data_t ) );
251
252     /* disc input method */
253     p_input->stream.i_method = INPUT_METHOD_VCD;
254
255 #define area p_input->stream.pp_areas
256     for( i = 1 ; i <= p_vcd->nb_tracks - 1 ; i++ )
257     {
258         input_AddArea( p_input );
259
260         /* Titles are Program Chains */
261         area[i]->i_id = i;
262
263         /* Absolute start offset and size */
264         area[i]->i_start = (off_t)p_vcd->p_sectors[i] * (off_t)VCD_DATA_SIZE;
265         area[i]->i_size = (off_t)(p_vcd->p_sectors[i+1] - p_vcd->p_sectors[i])
266                            * (off_t)VCD_DATA_SIZE;
267
268         /* Number of chapters */
269         area[i]->i_part_nb = 0;   // will be the entry points
270         area[i]->i_part = 1;
271
272         /* Number of angles */
273         area[i]->i_angle_nb = 1; // no angle support in VCDs
274         area[i]->i_angle = 1;
275
276         area[i]->i_plugin_data = p_vcd->p_sectors[i];
277     }
278 #undef area
279
280     /* Get requested title - if none try the first title */
281     i_title = main_GetIntVariable( INPUT_TITLE_VAR, 1 );
282     if( i_title <= 0 )
283     {
284         i_title = 1;
285     }
286
287     // p_vcd->i_track = i_title-1;
288
289     /* Get requested chapter - if none defaults to first one */
290     i_chapter = main_GetIntVariable( INPUT_CHAPTER_VAR, 1 );
291     if( i_chapter <= 0 )
292     {
293         i_chapter = 1;
294     }
295
296     p_input->stream.pp_areas[i_title]->i_part = i_chapter;
297
298     p_area = p_input->stream.pp_areas[i_title];
299
300     VCDSetArea( p_input, p_area );
301
302     /* Set program information. */
303
304     input_AddProgram( p_input, 0, sizeof( stream_ps_data_t ) );
305     p_input->stream.p_selected_program = p_input->stream.pp_programs[0];
306
307     /* No PSM to read in disc mode, we already have all the information */
308     p_input->stream.p_selected_program->b_is_ok = 1;
309
310     p_es = input_AddES( p_input, p_input->stream.p_selected_program, 0xe0, 0 );
311     p_es->i_stream_id = 0xe0;
312     p_es->i_type = MPEG1_VIDEO_ES;
313     p_es->i_cat = VIDEO_ES;
314
315     if( p_main->b_video )
316     {
317         input_SelectES( p_input, p_es );
318     }
319
320     p_es = input_AddES( p_input, p_input->stream.p_selected_program, 0xc0, 0 );
321     p_es->i_stream_id = 0xc0;
322     p_es->i_type = MPEG1_AUDIO_ES;
323     p_es->b_audio = 1;
324     p_es->i_cat = AUDIO_ES;
325
326     if( p_main->b_audio )
327     {
328         input_SelectES( p_input, p_es );
329     }
330
331     vlc_mutex_unlock( &p_input->stream.stream_lock );
332 }
333
334 /*****************************************************************************
335  * VCDEnd: frees unused data
336  *****************************************************************************/
337 static void VCDEnd( input_thread_t * p_input )
338 {
339     thread_vcd_data_t *     p_vcd;
340
341     input_BuffersEnd( p_input->p_method_data );
342
343     p_vcd = (thread_vcd_data_t*)p_input->p_plugin_data;
344
345     free( p_vcd );
346 }
347
348 /*****************************************************************************
349  * VCDSetProgram: Does nothing since a VCD is mono_program
350  *****************************************************************************/
351 static int VCDSetProgram( input_thread_t * p_input,
352                           pgrm_descriptor_t * p_program)
353 {
354     return 0;
355 }
356
357
358 /*****************************************************************************
359  * VCDSetArea: initialize input data for title x, chapter y.
360  * It should be called for each user navigation request.
361  ****************************************************************************/
362 static int VCDSetArea( input_thread_t * p_input, input_area_t * p_area )
363 {
364     thread_vcd_data_t *     p_vcd;
365
366     p_vcd = (thread_vcd_data_t*)p_input->p_plugin_data;
367
368     /* we can't use the interface slider until initilization is complete */
369     p_input->stream.b_seekable = 0;
370
371     if( p_area != p_input->stream.p_selected_area )
372     {
373         /* Reset the Chapter position of the current title */
374         p_input->stream.p_selected_area->i_part = 1;
375         p_input->stream.p_selected_area->i_tell = 0;
376
377         /* Change the default area */
378         p_input->stream.p_selected_area = p_area;
379
380         /* Change the current track */
381         /* The first track is not a valid one  */
382         p_vcd->i_track = p_area->i_id;
383         p_vcd->i_sector = p_vcd->p_sectors[p_vcd->i_track];
384     }
385
386     /* warn interface that something has changed */
387     p_input->stream.b_seekable = 1;
388     p_input->stream.b_changed = 1;
389
390     return 0;
391 }
392
393 /*****************************************************************************
394  * VCDRead: reads from the VCD into PES packets.
395  *****************************************************************************
396  * Returns -1 in case of error, 0 in case of EOF, otherwise the number of
397  * packets.
398  *****************************************************************************/
399 static int VCDRead( input_thread_t * p_input, data_packet_t ** pp_data )
400 {
401     thread_vcd_data_t *     p_vcd;
402     data_packet_t *         p_data;
403     int                     i_packet_size;
404     int                     i_index;
405     int                     i_packet;
406     u32                     i_header;
407     byte_t                  p_buffer[ VCD_DATA_SIZE ];
408     boolean_t               b_eot = 0; /* end of track */
409     /* boolean_t               b_eoc; No chapters yet */
410
411     p_vcd = (thread_vcd_data_t *)p_input->p_plugin_data;
412
413     i_packet = 0;
414     *pp_data = NULL;
415
416     while( i_packet < VCD_DATA_ONCE )
417     {
418         if( ioctl_ReadSector( p_vcd->i_handle, p_vcd->i_sector, p_buffer ) )
419         {
420             /* Read error, but assume we reached the end of the track */
421             b_eot = 1;
422             break;
423         }
424
425         p_vcd->i_sector++;
426
427         if( p_vcd->i_sector >= p_vcd->p_sectors[p_vcd->i_track + 1] )
428         {
429             b_eot = 1;
430             break;
431         }
432
433         i_index = 0;
434
435         while( i_index < BUFFER_SIZE-6 && i_packet < VCD_DATA_ONCE )
436         {
437             i_header = U32_AT(p_buffer + i_index);
438
439             /* It is common for MPEG-1 streams to pad with zeros
440              * (although it is forbidden by the recommendation), so
441              * don't bother everybody in this case. */
442             while( !i_header && (++i_index < BUFFER_SIZE - 4) )
443             {
444                 i_header = U32_AT(p_buffer + i_index);
445             }
446
447             if( !i_header )
448             {
449                 intf_WarnMsg( 12, "vcd warning: zero-padded packet" );
450                 break;
451             }
452
453             /* Read the stream until we find a startcode. */
454             while( (i_header & 0xFFFFFF00) != 0x100L
455                      && (++i_index < BUFFER_SIZE - 4) )
456             {
457                 i_header = U32_AT(p_buffer + i_index);
458             }
459
460             if( (i_header & 0xFFFFFF00) != 0x100L )
461             {
462                 intf_WarnMsg( 3, "vcd warning: no packet at sector %d",
463                                  p_vcd->i_sector - 1 );
464                 break; /* go to the next sector */
465             }
466
467             switch( i_header )
468             {
469                 /* 0x1b9 == SYSTEM_END_CODE, it is only 4 bytes long. */
470                 case 0x1b9:
471                     i_packet_size = -2;
472                     break;
473
474                 /* Pack header */
475                 case 0x1ba:
476                     if( ( *( p_buffer + ( i_index + 4 ) ) & 0xC0) == 0x40 )
477                     {
478                         /* MPEG-2 */
479                         i_packet_size = 8;
480                     }
481                     else if( (*(p_buffer + ( i_index + 4 ) ) & 0xF0) == 0x20 )
482                     {
483                         /* MPEG-1 */
484                         i_packet_size = 6;
485                     }
486                     else
487                     {
488                         intf_ErrMsg( "vcd error: unable to determine "
489                                      "stream type" );
490                         return( -1 );
491                     }
492                     break;
493
494                 /* The packet is at least 6 bytes long. */
495                 default:
496                     /* That's the case for all packets, except pack header. */
497                     i_packet_size = U16_AT((p_buffer + ( i_index + 4 )));
498                     break;
499             }
500
501             if ( i_index + i_packet_size > BUFFER_SIZE )
502             {
503                 intf_ErrMsg( "vcd error: packet too long (%i)",
504                              i_index + i_packet_size );
505                 continue;
506             }
507
508             /* Fetch a packet of the appropriate size. */
509             p_data = p_input->pf_new_packet( p_input->p_method_data,
510                                              i_packet_size + 6 );
511
512             if( p_data == NULL )
513             {
514                 intf_ErrMsg( "vcd error: out of memory" );
515                 return( -1 );
516             }
517
518             if( U32_AT(p_buffer) != 0x1B9 )
519             {
520                 FAST_MEMCPY( p_data->p_demux_start, p_buffer + i_index,
521                              6 + i_packet_size );
522                 i_index += ( 6 + i_packet_size );
523             }
524             else
525             {
526                 /* Copy the small header. */
527                 memcpy( p_data->p_demux_start, p_buffer + i_index, 4 );
528                 i_index += 4;
529             }
530
531             /* Give the packet to the other input stages. */
532             *pp_data = p_data;
533             pp_data = &p_data->p_next;
534
535             i_packet++;
536         }
537     }
538
539     vlc_mutex_lock( &p_input->stream.stream_lock );
540
541     p_input->stream.p_selected_area->i_tell =
542         (off_t)p_vcd->i_sector * (off_t)VCD_DATA_SIZE
543           - p_input->stream.p_selected_area->i_start;
544
545     /* no chapter for the moment*/
546 #if 0
547     if( b_eoc )
548     {
549         /* We modify i_part only at end of chapter not to erase
550          * some modification from the interface */
551         p_input->stream.p_selected_area->i_part = p_vcd->i_chapter;
552     }
553 #endif
554
555     if( b_eot )
556     {
557         input_area_t *p_area;
558
559         /* EOF ? */
560         if( p_vcd->i_track >= p_vcd->nb_tracks - 1 )
561         {
562             vlc_mutex_unlock( &p_input->stream.stream_lock );
563             return 0;
564         }
565
566         intf_WarnMsg( 4, "vcd info: new title" );
567
568         p_area = p_input->stream.pp_areas[
569                                  p_input->stream.p_selected_area->i_id + 1 ];
570
571         p_area->i_part = 1;
572         VCDSetArea( p_input, p_area );
573     }
574
575     vlc_mutex_unlock( &p_input->stream.stream_lock );
576
577     return( i_packet + 1 );
578 }
579
580 /*****************************************************************************
581  * VCDRewind : reads a stream backward
582  *****************************************************************************/
583 static int VCDRewind( input_thread_t * p_input )
584 {
585     return( -1 );
586 }
587
588 /****************************************************************************
589  * VCDSeek
590  ****************************************************************************/
591 static void VCDSeek( input_thread_t * p_input, off_t i_off )
592 {
593     thread_vcd_data_t *               p_vcd;
594
595     p_vcd = (thread_vcd_data_t *) p_input->p_plugin_data;
596
597     p_vcd->i_sector = p_vcd->p_sectors[p_vcd->i_track]
598                        + i_off / (off_t)VCD_DATA_SIZE;
599
600     p_input->stream.p_selected_area->i_tell = 
601         (off_t)p_vcd->i_sector * (off_t)VCD_DATA_SIZE
602          - p_input->stream.p_selected_area->i_start;
603 }
604