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