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