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