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

   1 /*****************************************************************************
   2  * cdda.c : CD digital audio input module for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2000, 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *          Gildas Bazin <gbazin@netcourrier.com>
   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 /**
  26  * Todo:
  27  *   - Improve CDDB support (non-blocking, cache, ...)
  28  *   - Fix tracknumber in MRL
  29  */
  30
  31 /*****************************************************************************
  32  * Preamble
  33  *****************************************************************************/
  34
  35 #include <vlc/vlc.h>
  36 #include <vlc_input.h>
  37 #include <vlc_access.h>
  38 #include <vlc_meta.h>
  39
  40 #include <vlc_codecs.h> /* For WAVEHEADER */
  41 #include "vcd/cdrom.h"
  42
  43 #include <vlc_playlist.h>
  44
  45 #ifdef HAVE_LIBCDDB
  46 #include <cddb/cddb.h>
  47 #endif
  48
  49 #ifdef HAVE_ERRNO_H
  50 #include <errno.h>
  51 #endif
  52
  53 /*****************************************************************************
  54  * Module descriptior
  55  *****************************************************************************/
  56 static int  Open ( vlc_object_t * );
  57 static void Close( vlc_object_t * );
  58
  59 #define CACHING_TEXT N_("Caching value in ms")
  60 #define CACHING_LONGTEXT N_( \
  61     "Default caching value for Audio CDs. This " \
  62     "value should be set in milliseconds." )
  63
  64 vlc_module_begin();
  65     set_shortname( _("Audio CD"));
  66     set_description( _("Audio CD input") );
  67     set_capability( "access2", 10 );
  68     set_category( CAT_INPUT );
  69     set_subcategory( SUBCAT_INPUT_ACCESS );
  70     set_callbacks( Open, Close );
  71
  72     add_usage_hint( N_("[cdda:][device][@[track]]") );
  73     add_integer( "cdda-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT,
  74                  CACHING_LONGTEXT, VLC_TRUE );
  75         change_safe();
  76
  77     add_integer( "cdda-track", -1 , NULL, NULL, NULL, VLC_TRUE );
  78         change_internal();
  79         change_safe();
  80     add_integer( "cdda-first-sector", -1, NULL, NULL, NULL, VLC_TRUE );
  81         change_internal();
  82         change_safe();
  83     add_integer( "cdda-last-sector", -1, NULL, NULL, NULL, VLC_TRUE );
  84         change_internal();
  85         change_safe();
  86
  87     add_string( "cddb-server", "freedb.freedb.org", NULL,
  88                 N_( "CDDB Server" ), N_( "Address of the CDDB server to use." ),
  89                 VLC_TRUE );
  90         change_safe();
  91     add_integer( "cddb-port", 8880, NULL,
  92                 N_( "CDDB port" ), N_( "CDDB Server port to use." ),
  93                 VLC_TRUE );
  94         change_safe();
  95     add_shortcut( "cdda" );
  96     add_shortcut( "cddasimple" );
  97 vlc_module_end();
  98
  99
 100 /* how many blocks VCDRead will read in each loop */
 101 #define CDDA_BLOCKS_ONCE 20
 102 #define CDDA_DATA_ONCE   (CDDA_BLOCKS_ONCE * CDDA_DATA_SIZE)
 103
 104 /*****************************************************************************
 105  * Access: local prototypes
 106  *****************************************************************************/
 107 struct access_sys_t
 108 {
 109     vcddev_t    *vcddev;                            /* vcd device descriptor */
 110
 111     /* Current position */
 112     int         i_sector;                                  /* Current Sector */
 113     int *       p_sectors;                                  /* Track sectors */
 114
 115     /* Wave header for the output data */
 116     WAVEHEADER  waveheader;
 117     vlc_bool_t  b_header;
 118
 119     int         i_track;
 120     int         i_first_sector;
 121     int         i_last_sector;
 122
 123 #ifdef HAVE_LIBCDDB
 124     cddb_disc_t *p_disc;
 125 #endif
 126 };
 127
 128 static block_t *Block( access_t * );
 129 static int      Seek( access_t *, int64_t );
 130 static int      Control( access_t *, int, va_list );
 131
 132 static int GetTracks( access_t *p_access, playlist_t *p_playlist,
 133                       playlist_item_t *p_parent );
 134
 135 #ifdef HAVE_LIBCDDB
 136 static void GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors );
 137 #endif
 138
 139 /*****************************************************************************
 140  * Open: open cdda
 141  *****************************************************************************/
 142 static int Open( vlc_object_t *p_this )
 143 {
 144     access_t     *p_access = (access_t*)p_this;
 145     access_sys_t *p_sys;
 146     vcddev_t *vcddev;
 147     char *psz_name;
 148     int i_mrl_tracknum = -1;
 149     int i_ret;
 150
 151     if( !p_access->psz_path || !*p_access->psz_path )
 152     {
 153         /* Only when selected */
 154         if( !p_this->b_force ) return VLC_EGENERIC;
 155
 156         psz_name = var_CreateGetString( p_this, "cd-audio" );
 157         if( !psz_name || !*psz_name )
 158         {
 159             if( psz_name ) free( psz_name );
 160             return VLC_EGENERIC;
 161         }
 162     }
 163     else psz_name = strdup( p_access->psz_path );
 164
 165 #ifdef WIN32
 166     if( psz_name[0] && psz_name[1] == ':' &&
 167         psz_name[2] == '\\' && psz_name[3] == '\0' ) psz_name[2] = '\0';
 168 #endif
 169
 170     /* Open CDDA */
 171     if( (vcddev = ioctl_Open( VLC_OBJECT(p_access), psz_name )) == NULL )
 172     {
 173         msg_Warn( p_access, "could not open %s", psz_name );
 174         free( psz_name );
 175         return VLC_EGENERIC;
 176     }
 177     free( psz_name );
 178
 179     /* Set up p_access */
 180     STANDARD_BLOCK_ACCESS_INIT
 181     p_sys->vcddev = vcddev;
 182
 183    /* Do we play a single track ? */
 184    p_sys->i_track = var_CreateGetInteger( p_access, "cdda-track" );
 185
 186    if( p_sys->i_track < 0 && i_mrl_tracknum <= 0 )
 187    {
 188         /* We only do separate items if the whole disc is requested */
 189         playlist_t *p_playlist = pl_Yield( p_access );
 190
 191         i_ret = -1;
 192         if( p_playlist )
 193         {
 194             input_thread_t *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
 195             if( p_input )
 196             {
 197                 input_item_t *p_current = input_GetItem( p_input );
 198                 playlist_item_t *p_item;
 199
 200                 if( p_playlist->status.p_item->p_input == p_current )
 201                     p_item = p_playlist->status.p_item;
 202                 else
 203                     p_item = playlist_ItemGetByInput( p_playlist, p_current, VLC_FALSE );
 204
 205                 if( p_item )
 206                     i_ret = GetTracks( p_access, p_playlist, p_item );
 207                 else
 208                     msg_Dbg( p_playlist, "unable to find item in playlist");
 209                 vlc_object_release( p_input );
 210             }
 211             vlc_object_release( p_playlist );
 212         }
 213         if( i_ret < 0 )
 214             goto error;
 215     }
 216     else
 217     {
 218         /* Build a WAV header for the output data */
 219         memset( &p_sys->waveheader, 0, sizeof(WAVEHEADER) );
 220         SetWLE( &p_sys->waveheader.Format, 1 ); /*WAVE_FORMAT_PCM*/
 221         SetWLE( &p_sys->waveheader.BitsPerSample, 16);
 222         p_sys->waveheader.MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
 223         p_sys->waveheader.Length = 0;               /* we just don't know */
 224         p_sys->waveheader.ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
 225         p_sys->waveheader.SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
 226         SetDWLE( &p_sys->waveheader.SubChunkLength, 16);
 227         SetWLE( &p_sys->waveheader.Modus, 2);
 228         SetDWLE( &p_sys->waveheader.SampleFreq, 44100);
 229         SetWLE( &p_sys->waveheader.BytesPerSample,
 230                     2 /*Modus*/ * 16 /*BitsPerSample*/ / 8 );
 231         SetDWLE( &p_sys->waveheader.BytesPerSec,
 232                     2*16/8 /*BytesPerSample*/ * 44100 /*SampleFreq*/ );
 233         p_sys->waveheader.DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
 234         p_sys->waveheader.DataLength = 0;           /* we just don't know */
 235
 236         p_sys->i_first_sector = var_CreateGetInteger( p_access,
 237                                                       "cdda-first-sector" );
 238         p_sys->i_last_sector  = var_CreateGetInteger( p_access,
 239                                                       "cdda-last-sector" );
 240         /* Tracknumber in MRL */
 241         if( p_sys->i_first_sector < 0 || p_sys->i_last_sector < 0 )
 242         {
 243             int i_titles;
 244             if( i_mrl_tracknum <= 0 )
 245             {
 246                 msg_Err( p_access, "wrong sector information" );
 247                 goto error;
 248             }
 249             i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
 250                                             p_sys->vcddev, &p_sys->p_sectors );
 251         }
 252
 253
 254         p_sys->i_sector = p_sys->i_first_sector;
 255         p_access->info.i_size = (p_sys->i_last_sector - p_sys->i_first_sector)
 256                                      * (int64_t)CDDA_DATA_SIZE;
 257     }
 258
 259     /* PTS delay */
 260     var_Create( p_access, "cdda-caching", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 261
 262     return VLC_SUCCESS;
 263
 264 error:
 265     ioctl_Close( VLC_OBJECT(p_access), p_sys->vcddev );
 266     free( p_sys );
 267     return VLC_EGENERIC;
 268 }
 269
 270 /*****************************************************************************
 271  * Close: closes cdda
 272  *****************************************************************************/
 273 static void Close( vlc_object_t *p_this )
 274 {
 275     access_t     *p_access = (access_t *)p_this;
 276     access_sys_t *p_sys = p_access->p_sys;
 277     ioctl_Close( p_this, p_sys->vcddev );
 278     free( p_sys );
 279 }
 280
 281 /*****************************************************************************
 282  * Block: read data (CDDA_DATA_ONCE)
 283  *****************************************************************************/
 284 static block_t *Block( access_t *p_access )
 285 {
 286     access_sys_t *p_sys = p_access->p_sys;
 287     int i_blocks = CDDA_BLOCKS_ONCE;
 288     block_t *p_block;
 289
 290     if( p_sys->i_track < 0 ) p_access->info.b_eof = VLC_TRUE;
 291
 292     /* Check end of file */
 293     if( p_access->info.b_eof ) return NULL;
 294
 295     if( !p_sys->b_header )
 296     {
 297         /* Return only the header */
 298         p_block = block_New( p_access, sizeof( WAVEHEADER ) );
 299         memcpy( p_block->p_buffer, &p_sys->waveheader, sizeof(WAVEHEADER) );
 300         p_sys->b_header = VLC_TRUE;
 301         return p_block;
 302     }
 303
 304     if( p_sys->i_sector >= p_sys->i_last_sector )
 305     {
 306         p_access->info.b_eof = VLC_TRUE;
 307         return NULL;
 308     }
 309
 310     /* Don't read too far */
 311     if( p_sys->i_sector + i_blocks >= p_sys->i_last_sector )
 312         i_blocks = p_sys->i_last_sector - p_sys->i_sector;
 313
 314     /* Do the actual reading */
 315     if( !( p_block = block_New( p_access, i_blocks * CDDA_DATA_SIZE ) ) )
 316     {
 317         msg_Err( p_access, "cannot get a new block of size: %i",
 318                  i_blocks * CDDA_DATA_SIZE );
 319         return NULL;
 320     }
 321
 322     if( ioctl_ReadSectors( VLC_OBJECT(p_access), p_sys->vcddev,
 323             p_sys->i_sector, p_block->p_buffer, i_blocks, CDDA_TYPE ) < 0 )
 324     {
 325         msg_Err( p_access, "cannot read sector %i", p_sys->i_sector );
 326         block_Release( p_block );
 327
 328         /* Try to skip one sector (in case of bad sectors) */
 329         p_sys->i_sector++;
 330         p_access->info.i_pos += CDDA_DATA_SIZE;
 331         return NULL;
 332     }
 333
 334     /* Update a few values */
 335     p_sys->i_sector += i_blocks;
 336     p_access->info.i_pos += p_block->i_buffer;
 337
 338     return p_block;
 339 }
 340
 341 /****************************************************************************
 342  * Seek
 343  ****************************************************************************/
 344 static int Seek( access_t *p_access, int64_t i_pos )
 345 {
 346     access_sys_t *p_sys = p_access->p_sys;
 347
 348     /* Next sector to read */
 349     p_sys->i_sector = p_sys->i_first_sector + i_pos / CDDA_DATA_SIZE;
 350     p_access->info.i_pos = i_pos;
 351
 352     return VLC_SUCCESS;
 353 }
 354
 355 /*****************************************************************************
 356  * Control:
 357  *****************************************************************************/
 358 static int Control( access_t *p_access, int i_query, va_list args )
 359 {
 360     vlc_bool_t   *pb_bool;
 361     int          *pi_int;
 362     int64_t      *pi_64;
 363
 364     switch( i_query )
 365     {
 366         case ACCESS_CAN_SEEK:
 367         case ACCESS_CAN_FASTSEEK:
 368         case ACCESS_CAN_PAUSE:
 369         case ACCESS_CAN_CONTROL_PACE:
 370             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 371             *pb_bool = VLC_TRUE;
 372             break;
 373
 374         case ACCESS_GET_MTU:
 375             pi_int = (int*)va_arg( args, int * );
 376             *pi_int = CDDA_DATA_ONCE;
 377             break;
 378
 379         case ACCESS_GET_PTS_DELAY:
 380             pi_64 = (int64_t*)va_arg( args, int64_t * );
 381             *pi_64 = var_GetInteger( p_access, "cdda-caching" ) * 1000;
 382             break;
 383
 384         case ACCESS_SET_PAUSE_STATE:
 385         case ACCESS_GET_TITLE_INFO:
 386         case ACCESS_SET_TITLE:
 387         case ACCESS_GET_META:
 388         case ACCESS_SET_SEEKPOINT:
 389         case ACCESS_SET_PRIVATE_ID_STATE:
 390         case ACCESS_GET_CONTENT_TYPE:
 391             return VLC_EGENERIC;
 392
 393         default:
 394             msg_Warn( p_access, "unimplemented query in control" );
 395             return VLC_EGENERIC;
 396
 397     }
 398     return VLC_SUCCESS;
 399 }
 400
 401 static int GetTracks( access_t *p_access,
 402                       playlist_t *p_playlist, playlist_item_t *p_parent )
 403 {
 404     access_sys_t *p_sys = p_access->p_sys;
 405     int i, i_titles;
 406     input_item_t *p_input_item;
 407     playlist_item_t *p_item_in_category;
 408     char *psz_name;
 409     i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
 410                                    p_sys->vcddev, &p_sys->p_sectors );
 411     if( i_titles < 0 )
 412     {
 413         msg_Err( p_access, "unable to count tracks" );
 414         return VLC_EGENERIC;;
 415     }
 416     else if( i_titles <= 0 )
 417     {
 418         msg_Err( p_access, "no audio tracks found" );
 419         return VLC_EGENERIC;
 420     }
 421
 422     p_item_in_category = playlist_ItemToNode( p_playlist, p_parent, VLC_FALSE );
 423     playlist_ItemSetName( p_parent, "Audio CD" );
 424     var_SetInteger( p_playlist, "item-change", p_parent->p_input->i_id );
 425
 426 #ifdef HAVE_LIBCDDB
 427     GetCDDBInfo( p_access, i_titles, p_sys->p_sectors );
 428     if( p_sys->p_disc )
 429     {
 430         if( cddb_disc_get_title( p_sys->p_disc ) )
 431         {
 432             const char *psz_name = cddb_disc_get_title( p_sys->p_disc );
 433             playlist_ItemSetName( p_parent, psz_name );
 434             var_SetInteger( p_playlist, "item-change",
 435                             p_parent->p_input->i_id );
 436         }
 437     }
 438 #endif
 439
 440     /* Build title table */
 441     for( i = 0; i < i_titles; i++ )
 442     {
 443         msg_Dbg( p_access, "track[%d] start=%d", i, p_sys->p_sectors[i] );
 444         char *psz_uri, *psz_opt, *psz_first, *psz_last;
 445         int i_path_len = p_access->psz_path ? strlen( p_access->psz_path ) : 0;
 446
 447         psz_name = (char*)malloc( strlen( _("Audio CD - Track ") ) + 5 );
 448         psz_opt = (char*)malloc( strlen( "cdda-track=" ) + 3 );
 449         psz_first = (char*)malloc( strlen( "cdda-first-sector=" ) + 7 );
 450         psz_last = (char*)malloc( strlen( "cdda-last-sector=" ) + 7 );
 451         psz_uri = (char*)malloc( i_path_len + 13 );
 452
 453         snprintf( psz_uri, i_path_len + 13, "cdda://%s",
 454                            p_access->psz_path ? p_access->psz_path : "" );
 455         sprintf( psz_opt, "cdda-track=%i", i+1 );
 456         sprintf( psz_first, "cdda-first-sector=%i",p_sys->p_sectors[i] );
 457
 458 //        if( i != i_titles -1 )
 459             sprintf( psz_last, "cdda-last-sector=%i", p_sys->p_sectors[i+1] );
 460 //         else
 461 //            sprintf( psz_last, "cdda-last-sector=%i", 1242 /* FIXME */);
 462
 463         /* Define a "default name" */
 464         sprintf( psz_name, _("Audio CD - Track %i"), (i+1) );
 465
 466         /* Create playlist items */
 467         p_input_item = input_ItemNewWithType( VLC_OBJECT( p_playlist ),
 468                                               psz_uri, psz_name, 0, NULL, -1,
 469                                               ITEM_TYPE_DISC );
 470         input_ItemAddOption( p_input_item, psz_first );
 471         input_ItemAddOption( p_input_item, psz_last );
 472         input_ItemAddOption( p_input_item, psz_opt );
 473
 474 #ifdef HAVE_LIBCDDB
 475         /* If we have CDDB info, change the name */
 476         if( p_sys->p_disc )
 477         {
 478             cddb_track_t *t = cddb_disc_get_track( p_sys->p_disc, i );
 479             if( t!= NULL )
 480             {
 481                 if( cddb_track_get_title( t )  != NULL )
 482                 {
 483                     if( p_input_item->psz_name )
 484                         free( p_input_item->psz_name );
 485                     p_input_item->psz_name = strdup( cddb_track_get_title( t ) );
 486                     input_item_SetTitle( p_input_item, cddb_track_get_title( t ) );
 487                 }
 488                 if( cddb_track_get_artist( t ) != NULL )
 489                 {
 490                     input_item_SetArtist( p_input_item, cddb_track_get_artist( t ) );
 491                 }
 492             }
 493         }
 494 #endif
 495         playlist_BothAddInput( p_playlist, p_input_item, p_item_in_category,
 496                                PLAYLIST_APPEND, PLAYLIST_END, NULL, NULL,
 497                                VLC_FALSE );
 498         vlc_gc_decref( p_input_item );
 499         free( psz_uri ); free( psz_opt ); free( psz_name );
 500         free( psz_first ); free( psz_last );
 501     }
 502     return VLC_SUCCESS;
 503 }
 504
 505 #ifdef HAVE_LIBCDDB
 506 static void GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors )
 507 {
 508     int i, i_matches;
 509     int64_t  i_length = 0, i_size = 0;
 510     cddb_conn_t  *p_cddb = cddb_new();
 511
 512     if( !p_cddb )
 513     {
 514         msg_Warn( p_access, "unable to use CDDB" );
 515         goto cddb_destroy;
 516     }
 517
 518     cddb_set_email_address( p_cddb, "vlc@videolan.org" );
 519     cddb_set_server_name( p_cddb, config_GetPsz( p_access, "cddb-server" ) );
 520     cddb_set_server_port( p_cddb, config_GetInt( p_access, "cddb-port" ) );
 521
 522     /// \todo
 523     cddb_cache_disable( p_cddb );
 524
 525 //    cddb_cache_set_dir( p_cddb,
 526 //                     config_GetPsz( p_access,
 527 //                                    MODULE_STRING "-cddb-cachedir") );
 528
 529     cddb_set_timeout( p_cddb, 10 );
 530
 531     /// \todo
 532     cddb_http_disable( p_cddb);
 533
 534     p_access->p_sys->p_disc = cddb_disc_new();
 535
 536     if(! p_access->p_sys->p_disc )
 537     {
 538         msg_Err( p_access, "unable to create CDDB disc structure." );
 539         goto cddb_end;
 540     }
 541
 542     for(i = 0; i < i_titles ; i++ )
 543     {
 544         cddb_track_t *t = cddb_track_new();
 545         cddb_track_set_frame_offset(t, p_sectors[i] );
 546         cddb_disc_add_track( p_access->p_sys->p_disc, t );
 547         i_size = ( p_sectors[i+1] - p_sectors[i] ) *
 548                    (int64_t)CDDA_DATA_SIZE;
 549         i_length += I64C(1000000) * i_size / 44100 / 4  ;
 550     }
 551
 552     cddb_disc_set_length( p_access->p_sys->p_disc, (int)(i_length/1000000) );
 553
 554     if (!cddb_disc_calc_discid(p_access->p_sys->p_disc ))
 555     {
 556         msg_Err( p_access, "CDDB disc ID calculation failed" );
 557         goto cddb_destroy;
 558     }
 559
 560     i_matches = cddb_query( p_cddb, p_access->p_sys->p_disc);
 561
 562     if (i_matches > 0)
 563     {
 564         if (i_matches > 1)
 565              msg_Warn( p_access, "found %d matches in CDDB. Using first one.",
 566                                  i_matches);
 567         cddb_read( p_cddb, p_access->p_sys->p_disc );
 568     }
 569     else
 570         msg_Warn( p_access, "CDDB error: %s", cddb_error_str(errno));
 571
 572 cddb_destroy:
 573     cddb_destroy( p_cddb);
 574
 575 cddb_end: ;
 576 }
 577 #endif /*HAVE_LIBCDDB*/