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_common.h>
  40 #include <vlc_plugin.h>
  41 #include <vlc_input.h>
  42 #include <vlc_access.h>
  43 #include <vlc_meta.h>
  44 #include <vlc_charset.h>
  45
  46 #include <vlc_codecs.h> /* For WAVEHEADER */
  47 #include "vcd/cdrom.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( N_("Audio CD"))
  70     set_description( N_("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", 0 , 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, input_item_t *p_current );
 131
 132 #ifdef HAVE_LIBCDDB
 133 static void GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors );
 134 #endif
 135
 136 /*****************************************************************************
 137  * Open: open cdda
 138  *****************************************************************************/
 139 static int Open( vlc_object_t *p_this )
 140 {
 141     access_t     *p_access = (access_t*)p_this;
 142     access_sys_t *p_sys;
 143     vcddev_t *vcddev;
 144     char *psz_name;
 145     int i_ret;
 146
 147     if( !p_access->psz_path || !*p_access->psz_path )
 148     {
 149         /* Only when selected */
 150         if( !p_this->b_force ) return VLC_EGENERIC;
 151
 152         psz_name = var_CreateGetString( p_this, "cd-audio" );
 153         if( !psz_name || !*psz_name )
 154         {
 155             free( psz_name );
 156             return VLC_EGENERIC;
 157         }
 158     }
 159     else psz_name = ToLocaleDup( p_access->psz_path );
 160
 161 #ifdef WIN32
 162     if( psz_name[0] && psz_name[1] == ':' &&
 163         psz_name[2] == '\\' && psz_name[3] == '\0' ) psz_name[2] = '\0';
 164 #endif
 165
 166     /* Open CDDA */
 167     if( (vcddev = ioctl_Open( VLC_OBJECT(p_access), psz_name )) == NULL )
 168     {
 169         msg_Warn( p_access, "could not open %s", psz_name );
 170         free( psz_name );
 171         return VLC_EGENERIC;
 172     }
 173     free( psz_name );
 174
 175     /* Set up p_access */
 176     STANDARD_BLOCK_ACCESS_INIT
 177     p_sys->vcddev = vcddev;
 178
 179    /* Do we play a single track ? */
 180    p_sys->i_track = var_CreateGetInteger( p_access, "cdda-track" ) - 1;
 181
 182    if( p_sys->i_track < 0 )
 183    {
 184         /* We only do separate items if the whole disc is requested */
 185         input_thread_t *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
 186
 187         i_ret = -1;
 188         if( p_input )
 189         {
 190             input_item_t *p_current = input_GetItem( p_input );
 191             if( p_current )
 192                 i_ret = GetTracks( p_access, p_current );
 193
 194             vlc_object_release( p_input );
 195         }
 196         if( i_ret < 0 )
 197             goto error;
 198     }
 199     else
 200     {
 201         /* Build a WAV header for the output data */
 202         memset( &p_sys->waveheader, 0, sizeof(WAVEHEADER) );
 203         SetWLE( &p_sys->waveheader.Format, 1 ); /*WAVE_FORMAT_PCM*/
 204         SetWLE( &p_sys->waveheader.BitsPerSample, 16);
 205         p_sys->waveheader.MainChunkID = VLC_FOURCC('R', 'I', 'F', 'F');
 206         p_sys->waveheader.Length = 0;               /* we just don't know */
 207         p_sys->waveheader.ChunkTypeID = VLC_FOURCC('W', 'A', 'V', 'E');
 208         p_sys->waveheader.SubChunkID = VLC_FOURCC('f', 'm', 't', ' ');
 209         SetDWLE( &p_sys->waveheader.SubChunkLength, 16);
 210         SetWLE( &p_sys->waveheader.Modus, 2);
 211         SetDWLE( &p_sys->waveheader.SampleFreq, 44100);
 212         SetWLE( &p_sys->waveheader.BytesPerSample,
 213                     2 /*Modus*/ * 16 /*BitsPerSample*/ / 8 );
 214         SetDWLE( &p_sys->waveheader.BytesPerSec,
 215                     2*16/8 /*BytesPerSample*/ * 44100 /*SampleFreq*/ );
 216         p_sys->waveheader.DataChunkID = VLC_FOURCC('d', 'a', 't', 'a');
 217         p_sys->waveheader.DataLength = 0;           /* we just don't know */
 218
 219         p_sys->i_first_sector = var_CreateGetInteger( p_access,
 220                                                       "cdda-first-sector" );
 221         p_sys->i_last_sector  = var_CreateGetInteger( p_access,
 222                                                       "cdda-last-sector" );
 223         /* Tracknumber in MRL */
 224         if( p_sys->i_first_sector < 0 || p_sys->i_last_sector < 0 )
 225         {
 226             const int i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
 227                                                      p_sys->vcddev, &p_sys->p_sectors );
 228             if( p_sys->i_track >= i_titles )
 229             {
 230                 msg_Err( p_access, "invalid track number" );
 231                 goto error;
 232             }
 233             p_sys->i_first_sector = p_sys->p_sectors[p_sys->i_track];
 234             p_sys->i_last_sector = p_sys->p_sectors[p_sys->i_track+1];
 235         }
 236
 237         p_sys->i_sector = p_sys->i_first_sector;
 238         p_access->info.i_size = (p_sys->i_last_sector - p_sys->i_first_sector)
 239                                      * (int64_t)CDDA_DATA_SIZE;
 240     }
 241
 242     /* PTS delay */
 243     var_Create( p_access, "cdda-caching", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 244
 245     return VLC_SUCCESS;
 246
 247 error:
 248     free( p_sys->p_sectors );
 249     ioctl_Close( VLC_OBJECT(p_access), p_sys->vcddev );
 250     free( p_sys );
 251     return VLC_EGENERIC;
 252 }
 253
 254 /*****************************************************************************
 255  * Close: closes cdda
 256  *****************************************************************************/
 257 static void Close( vlc_object_t *p_this )
 258 {
 259     access_t     *p_access = (access_t *)p_this;
 260     access_sys_t *p_sys = p_access->p_sys;
 261
 262     free( p_sys->p_sectors );
 263     ioctl_Close( p_this, p_sys->vcddev );
 264     free( p_sys );
 265 }
 266
 267 /*****************************************************************************
 268  * Block: read data (CDDA_DATA_ONCE)
 269  *****************************************************************************/
 270 static block_t *Block( access_t *p_access )
 271 {
 272     access_sys_t *p_sys = p_access->p_sys;
 273     int i_blocks = CDDA_BLOCKS_ONCE;
 274     block_t *p_block;
 275
 276     if( p_sys->i_track < 0 ) p_access->info.b_eof = true;
 277
 278     /* Check end of file */
 279     if( p_access->info.b_eof ) return NULL;
 280
 281     if( !p_sys->b_header )
 282     {
 283         /* Return only the header */
 284         p_block = block_New( p_access, sizeof( WAVEHEADER ) );
 285         memcpy( p_block->p_buffer, &p_sys->waveheader, sizeof(WAVEHEADER) );
 286         p_sys->b_header = true;
 287         return p_block;
 288     }
 289
 290     if( p_sys->i_sector >= p_sys->i_last_sector )
 291     {
 292         p_access->info.b_eof = true;
 293         return NULL;
 294     }
 295
 296     /* Don't read too far */
 297     if( p_sys->i_sector + i_blocks >= p_sys->i_last_sector )
 298         i_blocks = p_sys->i_last_sector - p_sys->i_sector;
 299
 300     /* Do the actual reading */
 301     if( !( p_block = block_New( p_access, i_blocks * CDDA_DATA_SIZE ) ) )
 302     {
 303         msg_Err( p_access, "cannot get a new block of size: %i",
 304                  i_blocks * CDDA_DATA_SIZE );
 305         return NULL;
 306     }
 307
 308     if( ioctl_ReadSectors( VLC_OBJECT(p_access), p_sys->vcddev,
 309             p_sys->i_sector, p_block->p_buffer, i_blocks, CDDA_TYPE ) < 0 )
 310     {
 311         msg_Err( p_access, "cannot read sector %i", p_sys->i_sector );
 312         block_Release( p_block );
 313
 314         /* Try to skip one sector (in case of bad sectors) */
 315         p_sys->i_sector++;
 316         p_access->info.i_pos += CDDA_DATA_SIZE;
 317         return NULL;
 318     }
 319
 320     /* Update a few values */
 321     p_sys->i_sector += i_blocks;
 322     p_access->info.i_pos += p_block->i_buffer;
 323
 324     return p_block;
 325 }
 326
 327 /****************************************************************************
 328  * Seek
 329  ****************************************************************************/
 330 static int Seek( access_t *p_access, int64_t i_pos )
 331 {
 332     access_sys_t *p_sys = p_access->p_sys;
 333
 334     /* Next sector to read */
 335     p_sys->i_sector = p_sys->i_first_sector + i_pos / CDDA_DATA_SIZE;
 336     p_access->info.i_pos = i_pos;
 337
 338     return VLC_SUCCESS;
 339 }
 340
 341 /*****************************************************************************
 342  * Control:
 343  *****************************************************************************/
 344 static int Control( access_t *p_access, int i_query, va_list args )
 345 {
 346     bool    *pb_bool;
 347     int64_t *pi_64;
 348
 349     switch( i_query )
 350     {
 351         case ACCESS_CAN_SEEK:
 352         case ACCESS_CAN_FASTSEEK:
 353         case ACCESS_CAN_PAUSE:
 354         case ACCESS_CAN_CONTROL_PACE:
 355             pb_bool = (bool*)va_arg( args, bool* );
 356             *pb_bool = true;
 357             break;
 358
 359         case ACCESS_GET_PTS_DELAY:
 360             pi_64 = (int64_t*)va_arg( args, int64_t * );
 361             *pi_64 = var_GetInteger( p_access, "cdda-caching" ) * INT64_C(1000);
 362             break;
 363
 364         case ACCESS_SET_PAUSE_STATE:
 365             break;
 366
 367         case ACCESS_GET_TITLE_INFO:
 368         case ACCESS_SET_TITLE:
 369         case ACCESS_GET_META:
 370         case ACCESS_SET_SEEKPOINT:
 371         case ACCESS_SET_PRIVATE_ID_STATE:
 372         case ACCESS_GET_CONTENT_TYPE:
 373             return VLC_EGENERIC;
 374
 375         default:
 376             msg_Warn( p_access, "unimplemented query in control" );
 377             return VLC_EGENERIC;
 378     }
 379     return VLC_SUCCESS;
 380 }
 381
 382 static int GetTracks( access_t *p_access, input_item_t *p_current )
 383 {
 384     access_sys_t *p_sys = p_access->p_sys;
 385
 386     const int i_titles = ioctl_GetTracksMap( VLC_OBJECT(p_access),
 387                                              p_sys->vcddev, &p_sys->p_sectors );
 388     if( i_titles <= 0 )
 389     {
 390         if( i_titles < 0 )
 391             msg_Err( p_access, "unable to count tracks" );
 392         else if( i_titles <= 0 )
 393             msg_Err( p_access, "no audio tracks found" );
 394         return VLC_EGENERIC;;
 395     }
 396
 397     input_item_SetName( p_current, "Audio CD" );
 398
 399 #ifdef HAVE_LIBCDDB
 400     GetCDDBInfo( p_access, i_titles, p_sys->p_sectors );
 401     const char *psz_album = NULL;
 402     const char *psz_year = NULL;
 403     const char *psz_genre = NULL;
 404     char psz_year_buffer[4+1];
 405
 406     if( p_sys->p_disc )
 407     {
 408         psz_album = cddb_disc_get_title( p_sys->p_disc );
 409         if( psz_album && *psz_album )
 410         {
 411             input_item_SetName( p_current, psz_album );
 412             input_item_SetAlbum( p_current, psz_album );
 413         }
 414
 415         const unsigned i_year = cddb_disc_get_year( p_sys->p_disc );
 416         if( i_year > 0 )
 417         {
 418             psz_year = psz_year_buffer;
 419             snprintf( psz_year_buffer, sizeof(psz_year_buffer), "%u", i_year );
 420             input_item_SetDate( p_current, psz_year );
 421         }
 422
 423         psz_genre = cddb_disc_get_genre( p_sys->p_disc );
 424         if( psz_genre && *psz_genre )
 425             input_item_SetGenre( p_current, psz_genre );
 426
 427         /* Set artist only if unique */
 428         const char *psz_artist = NULL;
 429         for( int i = 0; i < i_titles; i++ )
 430         {
 431             cddb_track_t *t = cddb_disc_get_track( p_sys->p_disc, i );
 432             if( !t )
 433                 continue;
 434             const char *psz_track_artist = cddb_track_get_artist( t );
 435             if( psz_artist && psz_track_artist &&
 436                 strcmp( psz_artist, psz_track_artist ) )
 437             {
 438                 psz_artist = NULL;
 439                 break;
 440             }
 441             psz_artist = psz_track_artist;
 442         }
 443         if( psz_artist && *psz_artist )
 444             input_item_SetArtist( p_current, psz_artist );
 445
 446         const mtime_t i_duration = (int64_t)( p_sys->p_sectors[i_titles] - p_sys->p_sectors[0] ) *
 447                                    CDDA_DATA_SIZE * 1000000 / 44100 / 2 / 2;
 448         input_item_SetDuration( p_current, i_duration );
 449     }
 450 #endif
 451
 452     /* Build title table */
 453     for( int i = 0; i < i_titles; i++ )
 454     {
 455         input_item_t *p_input_item;
 456
 457         char *psz_uri, *psz_opt, *psz_first, *psz_last;
 458         char *psz_name;
 459
 460         msg_Dbg( p_access, "track[%d] start=%d", i, p_sys->p_sectors[i] );
 461
 462         /* */
 463         if( asprintf( &psz_uri, "cdda://%s", p_access->psz_path ) == -1 )
 464             psz_uri = NULL;
 465         if( asprintf( &psz_opt, "cdda-track=%i", i+1 ) == -1 )
 466             psz_opt = NULL;
 467         if( asprintf( &psz_first, "cdda-first-sector=%i",p_sys->p_sectors[i] ) == -1 )
 468             psz_first = NULL;
 469         if( asprintf( &psz_last, "cdda-last-sector=%i", p_sys->p_sectors[i+1] ) == -1 )
 470             psz_last = NULL;
 471
 472         /* Define a "default name" */
 473         if( asprintf( &psz_name, _("Audio CD - Track %02i"), (i+1) ) == -1 )
 474             psz_name = NULL;
 475
 476         /* Create playlist items */
 477         const mtime_t i_duration = (int64_t)( p_sys->p_sectors[i+1] - p_sys->p_sectors[i] ) *
 478                                    CDDA_DATA_SIZE * 1000000 / 44100 / 2 / 2;
 479         p_input_item = input_item_NewWithType( VLC_OBJECT( p_access ),
 480                                               psz_uri, psz_name, 0, NULL, 0, i_duration,
 481                                               ITEM_TYPE_DISC );
 482         input_item_CopyOptions( p_current, p_input_item );
 483         input_item_AddOption( p_input_item, psz_first, VLC_INPUT_OPTION_TRUSTED );
 484         input_item_AddOption( p_input_item, psz_last, VLC_INPUT_OPTION_TRUSTED );
 485         input_item_AddOption( p_input_item, psz_opt, VLC_INPUT_OPTION_TRUSTED );
 486
 487 #ifdef HAVE_LIBCDDB
 488         /* If we have CDDB info, change the name */
 489         if( p_sys->p_disc )
 490         {
 491             cddb_track_t *t = cddb_disc_get_track( p_sys->p_disc, i );
 492             if( t != NULL )
 493             {
 494                 const char *psz_title = cddb_track_get_title( t );
 495                 const char *psz_artist = cddb_track_get_artist( t );
 496
 497                 if( psz_title )
 498                 {
 499                     input_item_SetName( p_input_item, psz_title );
 500                     input_item_SetTitle( p_input_item, psz_title );
 501                 }
 502                 if( psz_artist )
 503                     input_item_SetArtist( p_input_item, psz_artist );
 504             }
 505
 506             if( psz_album && *psz_album )
 507                 input_item_SetAlbum( p_input_item, psz_album );
 508
 509             if( psz_year )
 510                 input_item_SetDate( p_input_item, psz_year );
 511
 512             if( psz_genre && *psz_genre )
 513                 input_item_SetGenre( p_input_item, psz_genre );
 514         }
 515 #endif
 516         char psz_num[3+1];
 517         snprintf( psz_num, sizeof(psz_num), "%d", 1+i );
 518         input_item_SetTrackNum( p_input_item, psz_num );
 519
 520         input_item_AddSubItem( p_current, p_input_item );
 521         vlc_gc_decref( p_input_item );
 522         free( psz_uri ); free( psz_opt ); free( psz_name );
 523         free( psz_first ); free( psz_last );
 524     }
 525     return VLC_SUCCESS;
 526 }
 527
 528 #ifdef HAVE_LIBCDDB
 529 static void GetCDDBInfo( access_t *p_access, int i_titles, int *p_sectors )
 530 {
 531     int i, i_matches;
 532     int64_t  i_length = 0, i_size = 0;
 533     cddb_conn_t  *p_cddb = cddb_new();
 534
 535     if( !p_cddb )
 536     {
 537         msg_Warn( p_access, "unable to use CDDB" );
 538         goto cddb_destroy;
 539     }
 540
 541     char* psz_tmp = config_GetPsz( p_access, "cddb-server" );
 542     cddb_set_email_address( p_cddb, "vlc@videolan.org" );
 543     cddb_set_server_name( p_cddb, psz_tmp );
 544     cddb_set_server_port( p_cddb, config_GetInt( p_access, "cddb-port" ) );
 545     free( psz_tmp );
 546
 547     /// \todo
 548     cddb_cache_disable( p_cddb );
 549
 550 //    cddb_cache_set_dir( p_cddb,
 551 //                     config_GetPsz( p_access,
 552 //                                    MODULE_STRING "-cddb-cachedir") );
 553
 554     cddb_set_timeout( p_cddb, 10 );
 555
 556     /// \todo
 557     cddb_http_disable( p_cddb);
 558
 559     p_access->p_sys->p_disc = cddb_disc_new();
 560
 561     if(! p_access->p_sys->p_disc )
 562     {
 563         msg_Err( p_access, "unable to create CDDB disc structure." );
 564         goto cddb_end;
 565     }
 566
 567     for(i = 0; i < i_titles ; i++ )
 568     {
 569         cddb_track_t *t = cddb_track_new();
 570         cddb_track_set_frame_offset(t, p_sectors[i] );
 571         cddb_disc_add_track( p_access->p_sys->p_disc, t );
 572         i_size = ( p_sectors[i+1] - p_sectors[i] ) *
 573                    (int64_t)CDDA_DATA_SIZE;
 574         i_length += INT64_C(1000000) * i_size / 44100 / 4  ;
 575     }
 576
 577     cddb_disc_set_length( p_access->p_sys->p_disc, (int)(i_length/1000000) );
 578
 579     if (!cddb_disc_calc_discid(p_access->p_sys->p_disc ))
 580     {
 581         msg_Err( p_access, "CDDB disc ID calculation failed" );
 582         goto cddb_destroy;
 583     }
 584
 585     i_matches = cddb_query( p_cddb, p_access->p_sys->p_disc);
 586
 587     if (i_matches > 0)
 588     {
 589         if (i_matches > 1)
 590              msg_Warn( p_access, "found %d matches in CDDB. Using first one.",
 591                                  i_matches);
 592         cddb_read( p_cddb, p_access->p_sys->p_disc );
 593     }
 594     else
 595         msg_Warn( p_access, "CDDB error: %s", cddb_error_str(errno));
 596
 597 cddb_destroy:
 598     cddb_destroy( p_cddb);
 599
 600 cddb_end: ;
 601 }
 602 #endif /*HAVE_LIBCDDB*/