git.sesse.net Git - vlc/blob - modules/access/vcd/vcd.c

   1 /*****************************************************************************
   2  * vcd.c : VCD input module for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2000-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Author: Johan Bilien <jobi@via.ecp.fr>
   8  *
   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.
  13  *
  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.
  18  *
  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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_input.h>
  35 #include <vlc_access.h>
  36 #include <vlc_charset.h>
  37
  38 #include "cdrom.h"
  39
  40 /*****************************************************************************
  41  * Module descriptior
  42  *****************************************************************************/
  43 static int  Open ( vlc_object_t * );
  44 static void Close( vlc_object_t * );
  45
  46 #define CACHING_TEXT N_("Caching value in ms")
  47 #define CACHING_LONGTEXT N_( \
  48     "Caching value for VCDs. This " \
  49     "value should be set in milliseconds." )
  50
  51 vlc_module_begin ()
  52     set_shortname( N_("VCD"))
  53     set_description( N_("VCD input") )
  54     set_capability( "access", 60 )
  55     set_callbacks( Open, Close )
  56     set_category( CAT_INPUT )
  57     set_subcategory( SUBCAT_INPUT_ACCESS )
  58
  59     add_usage_hint( N_("[vcd:][device][@[title][,[chapter]]]") )
  60     add_integer( "vcd-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
  61                  CACHING_LONGTEXT, true )
  62     add_shortcut( "vcd" )
  63     add_shortcut( "svcd" )
  64 vlc_module_end ()
  65
  66 /*****************************************************************************
  67  * Local prototypes
  68  *****************************************************************************/
  69
  70 /* how many blocks VCDRead will read in each loop */
  71 #define VCD_BLOCKS_ONCE 20
  72 #define VCD_DATA_ONCE   (VCD_BLOCKS_ONCE * VCD_DATA_SIZE)
  73
  74 struct access_sys_t
  75 {
  76     vcddev_t    *vcddev;                            /* vcd device descriptor */
  77
  78     /* Title infos */
  79     int           i_titles;
  80     input_title_t *title[99];            /* No more that 99 track in a vcd ? */
  81
  82
  83     int         i_sector;                                  /* Current Sector */
  84     int         *p_sectors;                                 /* Track sectors */
  85 };
  86
  87 static block_t *Block( access_t * );
  88 static int      Seek( access_t *, int64_t );
  89 static int      Control( access_t *, int, va_list );
  90 static int      EntryPoints( access_t * );
  91
  92 /*****************************************************************************
  93  * VCDOpen: open vcd
  94  *****************************************************************************/
  95 static int Open( vlc_object_t *p_this )
  96 {
  97     access_t     *p_access = (access_t *)p_this;
  98     access_sys_t *p_sys;
  99     char *psz_dup = ToLocaleDup( p_access->psz_path );
 100     char *psz;
 101     int i_title = 0;
 102     int i_chapter = 0;
 103     int i;
 104     vcddev_t *vcddev;
 105
 106     /* Command line: vcd://[dev_path][@title[,chapter]] */
 107     if( ( psz = strchr( psz_dup, '@' ) ) )
 108     {
 109         *psz++ = '\0';
 110
 111         i_title = strtol( psz, &psz, 0 );
 112         if( *psz )
 113             i_chapter = strtol( psz+1, &psz, 0 );
 114     }
 115
 116     if( *psz_dup == '\0' )
 117     {
 118         free( psz_dup );
 119
 120         /* Only when selected */
 121         if( strcmp( p_access->psz_access, "vcd" ) &&
 122             strcmp( p_access->psz_access, "svcd" ) )
 123             return VLC_EGENERIC;
 124
 125         psz_dup = var_CreateGetString( p_access, "vcd" );
 126         if( *psz_dup == '\0' )
 127         {
 128             free( psz_dup );
 129             return VLC_EGENERIC;
 130         }
 131     }
 132
 133 #ifdef WIN32
 134     if( psz_dup[0] && psz_dup[1] == ':' &&
 135         psz_dup[2] == '\\' && psz_dup[3] == '\0' ) psz_dup[2] = '\0';
 136 #endif
 137
 138     /* Open VCD */
 139     if( !(vcddev = ioctl_Open( p_this, psz_dup )) )
 140     {
 141         free( psz_dup );
 142         return VLC_EGENERIC;
 143     }
 144     free( psz_dup );
 145
 146     /* Set up p_access */
 147     p_access->pf_read = NULL;
 148     p_access->pf_block = Block;
 149     p_access->pf_control = Control;
 150     p_access->pf_seek = Seek;
 151     p_access->info.i_update = 0;
 152     p_access->info.i_size = 0;
 153     p_access->info.i_pos = 0;
 154     p_access->info.b_eof = false;
 155     p_access->info.i_title = 0;
 156     p_access->info.i_seekpoint = 0;
 157     p_access->p_sys = p_sys = calloc( 1, sizeof( access_sys_t ) );
 158     if( !p_sys )
 159         goto error;
 160     p_sys->vcddev = vcddev;
 161
 162     /* We read the Table Of Content information */
 163     p_sys->i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
 164                                           p_sys->vcddev, &p_sys->p_sectors );
 165     if( p_sys->i_titles < 0 )
 166     {
 167         msg_Err( p_access, "unable to count tracks" );
 168         goto error;
 169     }
 170     else if( p_sys->i_titles <= 1 )
 171     {
 172         msg_Err( p_access, "no movie tracks found" );
 173         goto error;
 174     }
 175     /* The first title isn't usable */
 176     p_sys->i_titles--;
 177
 178     /* Build title table */
 179     for( i = 0; i < p_sys->i_titles; i++ )
 180     {
 181         input_title_t *t = p_sys->title[i] = vlc_input_title_New();
 182
 183         msg_Dbg( p_access, "title[%d] start=%d\n", i, p_sys->p_sectors[1+i] );
 184         msg_Dbg( p_access, "title[%d] end=%d\n", i, p_sys->p_sectors[i+2] );
 185
 186         t->i_size = ( p_sys->p_sectors[i+2] - p_sys->p_sectors[i+1] ) *
 187                     (int64_t)VCD_DATA_SIZE;
 188     }
 189
 190     /* Map entry points into chapters */
 191     if( EntryPoints( p_access ) )
 192     {
 193         msg_Warn( p_access, "could not read entry points, will not use them" );
 194     }
 195
 196     /* Starting title/chapter and sector */
 197     if( i_title >= p_sys->i_titles )
 198         i_title = 0;
 199     if( i_chapter >= p_sys->title[i_title]->i_seekpoint )
 200         i_chapter = 0;
 201
 202     p_sys->i_sector = p_sys->p_sectors[1+i_title];
 203     if( i_chapter > 0 )
 204     {
 205         p_sys->i_sector +=
 206             ( p_sys->title[i_title]->seekpoint[i_chapter]->i_byte_offset /
 207               VCD_DATA_SIZE );
 208     }
 209     p_access->info.i_title = i_title;
 210     p_access->info.i_seekpoint = i_chapter;
 211     p_access->info.i_size = p_sys->title[i_title]->i_size;
 212     p_access->info.i_pos = ( p_sys->i_sector - p_sys->p_sectors[1+i_title] ) *
 213         VCD_DATA_SIZE;
 214
 215     free( p_access->psz_demux );
 216     p_access->psz_demux = strdup( "ps" );
 217
 218     return VLC_SUCCESS;
 219
 220 error:
 221     ioctl_Close( VLC_OBJECT(p_access), p_sys->vcddev );
 222     free( p_sys );
 223     return VLC_EGENERIC;
 224 }
 225
 226 /*****************************************************************************
 227  * Close: closes vcd
 228  *****************************************************************************/
 229 static void Close( vlc_object_t *p_this )
 230 {
 231     access_t     *p_access = (access_t *)p_this;
 232     access_sys_t *p_sys = p_access->p_sys;
 233
 234     ioctl_Close( p_this, p_sys->vcddev );
 235     free( p_sys );
 236 }
 237
 238 /*****************************************************************************
 239  * Control:
 240  *****************************************************************************/
 241 static int Control( access_t *p_access, int i_query, va_list args )
 242 {
 243     access_sys_t *p_sys = p_access->p_sys;
 244     bool   *pb_bool;
 245     int          *pi_int;
 246     int64_t      *pi_64;
 247     input_title_t ***ppp_title;
 248     int i;
 249
 250     switch( i_query )
 251     {
 252         /* */
 253         case ACCESS_CAN_SEEK:
 254         case ACCESS_CAN_FASTSEEK:
 255         case ACCESS_CAN_PAUSE:
 256         case ACCESS_CAN_CONTROL_PACE:
 257             pb_bool = (bool*)va_arg( args, bool* );
 258             *pb_bool = true;
 259             break;
 260
 261         /* */
 262         case ACCESS_GET_PTS_DELAY:
 263             pi_64 = (int64_t*)va_arg( args, int64_t * );
 264             *pi_64 = var_GetInteger( p_access, "vcd-caching" ) * 1000;
 265             break;
 266
 267         /* */
 268         case ACCESS_SET_PAUSE_STATE:
 269             break;
 270
 271         case ACCESS_GET_TITLE_INFO:
 272             ppp_title = (input_title_t***)va_arg( args, input_title_t*** );
 273             pi_int    = (int*)va_arg( args, int* );
 274
 275             /* Duplicate title infos */
 276             *pi_int = p_sys->i_titles;
 277             *ppp_title = malloc( sizeof(input_title_t **) * p_sys->i_titles );
 278             for( i = 0; i < p_sys->i_titles; i++ )
 279             {
 280                 (*ppp_title)[i] = vlc_input_title_Duplicate( p_sys->title[i] );
 281             }
 282             break;
 283
 284         case ACCESS_SET_TITLE:
 285             i = (int)va_arg( args, int );
 286             if( i != p_access->info.i_title )
 287             {
 288                 /* Update info */
 289                 p_access->info.i_update |=
 290                   INPUT_UPDATE_TITLE|INPUT_UPDATE_SEEKPOINT|INPUT_UPDATE_SIZE;
 291                 p_access->info.i_title = i;
 292                 p_access->info.i_seekpoint = 0;
 293                 p_access->info.i_size = p_sys->title[i]->i_size;
 294                 p_access->info.i_pos  = 0;
 295
 296                 /* Next sector to read */
 297                 p_sys->i_sector = p_sys->p_sectors[1+i];
 298             }
 299             break;
 300
 301         case ACCESS_SET_SEEKPOINT:
 302         {
 303             input_title_t *t = p_sys->title[p_access->info.i_title];
 304             i = (int)va_arg( args, int );
 305             if( t->i_seekpoint > 0 )
 306             {
 307                 p_access->info.i_update |= INPUT_UPDATE_SEEKPOINT;
 308                 p_access->info.i_seekpoint = i;
 309
 310                 p_sys->i_sector = p_sys->p_sectors[1+p_access->info.i_title] +
 311                     t->seekpoint[i]->i_byte_offset / VCD_DATA_SIZE;
 312
 313                 p_access->info.i_pos = (int64_t)(p_sys->i_sector -
 314                     p_sys->p_sectors[1+p_access->info.i_title]) *VCD_DATA_SIZE;
 315             }
 316             return VLC_SUCCESS;
 317         }
 318
 319         case ACCESS_SET_PRIVATE_ID_STATE:
 320         case ACCESS_GET_CONTENT_TYPE:
 321             return VLC_EGENERIC;
 322
 323         default:
 324             msg_Warn( p_access, "unimplemented query in control" );
 325             return VLC_EGENERIC;
 326
 327     }
 328     return VLC_SUCCESS;
 329 }
 330
 331 /*****************************************************************************
 332  * Block:
 333  *****************************************************************************/
 334 static block_t *Block( access_t *p_access )
 335 {
 336     access_sys_t *p_sys = p_access->p_sys;
 337     int i_blocks = VCD_BLOCKS_ONCE;
 338     block_t *p_block;
 339     int i_read;
 340
 341     /* Check end of file */
 342     if( p_access->info.b_eof ) return NULL;
 343
 344     /* Check end of title */
 345     while( p_sys->i_sector >= p_sys->p_sectors[p_access->info.i_title + 2] )
 346     {
 347         if( p_access->info.i_title + 2 >= p_sys->i_titles )
 348         {
 349             p_access->info.b_eof = true;
 350             return NULL;
 351         }
 352
 353         p_access->info.i_update |=
 354             INPUT_UPDATE_TITLE | INPUT_UPDATE_SEEKPOINT | INPUT_UPDATE_SIZE;
 355         p_access->info.i_title++;
 356         p_access->info.i_seekpoint = 0;
 357         p_access->info.i_size =
 358             p_sys->title[p_access->info.i_title]->i_size;
 359         p_access->info.i_pos = 0;
 360     }
 361
 362     /* Don't read after the end of a title */
 363     if( p_sys->i_sector + i_blocks >=
 364         p_sys->p_sectors[p_access->info.i_title + 2] )
 365     {
 366         i_blocks = p_sys->p_sectors[p_access->info.i_title + 2 ] -
 367                    p_sys->i_sector;
 368     }
 369
 370     /* Do the actual reading */
 371     if( !( p_block = block_New( p_access, i_blocks * VCD_DATA_SIZE ) ) )
 372     {
 373         msg_Err( p_access, "cannot get a new block of size: %i",
 374                  i_blocks * VCD_DATA_SIZE );
 375         return NULL;
 376     }
 377
 378     if( ioctl_ReadSectors( VLC_OBJECT(p_access), p_sys->vcddev,
 379             p_sys->i_sector, p_block->p_buffer, i_blocks, VCD_TYPE ) < 0 )
 380     {
 381         msg_Err( p_access, "cannot read sector %i", p_sys->i_sector );
 382         block_Release( p_block );
 383
 384         /* Try to skip one sector (in case of bad sectors) */
 385         p_sys->i_sector++;
 386         p_access->info.i_pos += VCD_DATA_SIZE;
 387         return NULL;
 388     }
 389
 390     /* Update seekpoints */
 391     for( i_read = 0; i_read < i_blocks; i_read++ )
 392     {
 393         input_title_t *t = p_sys->title[p_access->info.i_title];
 394
 395         if( t->i_seekpoint > 0 &&
 396             p_access->info.i_seekpoint + 1 < t->i_seekpoint &&
 397             p_access->info.i_pos + i_read * VCD_DATA_SIZE >=
 398             t->seekpoint[p_access->info.i_seekpoint+1]->i_byte_offset )
 399         {
 400             msg_Dbg( p_access, "seekpoint change" );
 401             p_access->info.i_update |= INPUT_UPDATE_SEEKPOINT;
 402             p_access->info.i_seekpoint++;
 403         }
 404     }
 405
 406     /* Update a few values */
 407     p_sys->i_sector += i_blocks;
 408     p_access->info.i_pos += p_block->i_buffer;
 409
 410     return p_block;
 411 }
 412
 413 /*****************************************************************************
 414  * Seek:
 415  *****************************************************************************/
 416 static int Seek( access_t *p_access, int64_t i_pos )
 417 {
 418     access_sys_t *p_sys = p_access->p_sys;
 419     input_title_t *t = p_sys->title[p_access->info.i_title];
 420     int i_seekpoint;
 421
 422     /* Next sector to read */
 423     p_access->info.i_pos = i_pos;
 424     p_sys->i_sector = i_pos / VCD_DATA_SIZE +
 425         p_sys->p_sectors[p_access->info.i_title + 1];
 426
 427     /* Update current seekpoint */
 428     for( i_seekpoint = 0; i_seekpoint < t->i_seekpoint; i_seekpoint++ )
 429     {
 430         if( i_seekpoint + 1 >= t->i_seekpoint ) break;
 431         if( i_pos < t->seekpoint[i_seekpoint + 1]->i_byte_offset ) break;
 432     }
 433
 434     if( i_seekpoint != p_access->info.i_seekpoint )
 435     {
 436         msg_Dbg( p_access, "seekpoint change" );
 437         p_access->info.i_update |= INPUT_UPDATE_SEEKPOINT;
 438         p_access->info.i_seekpoint = i_seekpoint;
 439     }
 440
 441     /* Reset eof */
 442     p_access->info.b_eof = false;
 443
 444     return VLC_SUCCESS;
 445 }
 446
 447 /*****************************************************************************
 448  * EntryPoints: Reads the information about the entry points on the disc.
 449  *****************************************************************************/
 450 static int EntryPoints( access_t *p_access )
 451 {
 452     access_sys_t *p_sys = p_access->p_sys;
 453     uint8_t      sector[VCD_DATA_SIZE];
 454
 455     entries_sect_t entries;
 456     int i_nb, i;
 457
 458     /* Read the entry point sector */
 459     if( ioctl_ReadSectors( VLC_OBJECT(p_access), p_sys->vcddev,
 460         VCD_ENTRIES_SECTOR, sector, 1, VCD_TYPE ) < 0 )
 461     {
 462         msg_Err( p_access, "could not read entry points sector" );
 463         return VLC_EGENERIC;
 464     }
 465     memcpy( &entries, sector, CD_SECTOR_SIZE );
 466
 467     i_nb = GetWBE( &entries.i_entries_nb );
 468     if( i_nb > 500 )
 469     {
 470         msg_Err( p_access, "invalid entry points number" );
 471         return VLC_EGENERIC;
 472     }
 473
 474     if( strncmp( entries.psz_id, "ENTRYVCD", sizeof( entries.psz_id ) ) &&
 475         strncmp( entries.psz_id, "ENTRYSVD", sizeof( entries.psz_id ) ) )
 476     {
 477         msg_Err( p_access, "unrecognized entry points format" );
 478         return VLC_EGENERIC;
 479     }
 480
 481     for( i = 0; i < i_nb; i++ )
 482     {
 483         const int i_title = BCD_TO_BIN(entries.entry[i].i_track) - 2;
 484         const int i_sector =
 485             (MSF_TO_LBA2( BCD_TO_BIN( entries.entry[i].msf.minute ),
 486                           BCD_TO_BIN( entries.entry[i].msf.second ),
 487                           BCD_TO_BIN( entries.entry[i].msf.frame  ) ));
 488         seekpoint_t *s;
 489
 490         if( i_title < 0 ) continue;   /* Should not occur */
 491         if( i_title >= p_sys->i_titles ) continue;
 492
 493         msg_Dbg( p_access, "Entry[%d] title=%d sector=%d\n",
 494                  i, i_title, i_sector );
 495
 496         s = vlc_seekpoint_New();
 497         s->i_byte_offset = (i_sector - p_sys->p_sectors[i_title+1]) *
 498             VCD_DATA_SIZE;
 499
 500         TAB_APPEND( p_sys->title[i_title]->i_seekpoint,
 501                     p_sys->title[i_title]->seekpoint, s );
 502     }
 503
 504     return VLC_SUCCESS;
 505 }
 506