git.sesse.net Git - vlc/blob - modules/demux/voc.c

   1 /*****************************************************************************
   2  * voc.c : Creative Voice File (.VOC) demux module for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2005 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Remi Denis-Courmont <rem # videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <stdlib.h>                                      /* malloc(), free() */
  28
  29 #include <vlc/vlc.h>
  30 #include <vlc/input.h>
  31 #include <vlc/aout.h>
  32
  33 #include <codecs.h>
  34
  35 /*****************************************************************************
  36  * Module descriptor
  37  *****************************************************************************/
  38 static int  Open ( vlc_object_t * );
  39 static void Close( vlc_object_t * );
  40
  41 vlc_module_begin();
  42     set_description( _("VOC demuxer") );
  43     set_category( CAT_INPUT );
  44     set_subcategory( SUBCAT_INPUT_DEMUX );
  45     set_capability( "demux2", 10 );
  46     set_callbacks( Open, Close );
  47 vlc_module_end();
  48
  49 /*****************************************************************************
  50  * Local prototypes
  51  *****************************************************************************/
  52 static int Demux  ( demux_t * );
  53 static int Control( demux_t *, int i_query, va_list args );
  54
  55 struct demux_sys_t
  56 {
  57     es_format_t     fmt;
  58     es_out_id_t     *p_es;
  59
  60     int64_t         i_block_start;
  61     int64_t         i_block_end;
  62
  63     int64_t         i_loop_offset;
  64     unsigned        i_loop_count;
  65     unsigned        i_silence_countdown;
  66
  67     date_t          pts;
  68 };
  69
  70 static const char ct_header[] = "Creative Voice File\x1a";
  71
  72 /*****************************************************************************
  73  * Open: check file and initializes structures
  74  *****************************************************************************/
  75 static int Open( vlc_object_t * p_this )
  76 {
  77     demux_t     *p_demux = (demux_t*)p_this;
  78     demux_sys_t *p_sys;
  79     uint8_t     *p_buf;
  80     uint16_t    i_data_offset, i_version;
  81
  82     if( stream_Peek( p_demux->s, &p_buf, 26 ) < 26 )
  83         return VLC_EGENERIC;
  84
  85     if( memcmp( p_buf, ct_header, 20 ) )
  86         return VLC_EGENERIC;
  87     p_buf += 20;
  88
  89     i_data_offset = GetWLE( p_buf );
  90     if ( i_data_offset < 26 /* not enough room for full VOC header */ )
  91         return VLC_EGENERIC;
  92     p_buf += 2;
  93
  94     i_version = GetWLE( p_buf );
  95     if( ( i_version != 0x10A ) && ( i_version != 0x114 ) )
  96         return VLC_EGENERIC; /* unknown VOC version */
  97     p_buf += 2;
  98
  99     if( GetWLE( p_buf ) != (uint16_t)(0x1234 + ~i_version) )
 100         return VLC_EGENERIC;
 101
 102     /* We have a valid VOC header */
 103     msg_Dbg( p_demux, "CT Voice file v%d.%d", i_version >> 8,
 104              i_version & 0xff );
 105
 106     /* skip VOC header */
 107     if( stream_Read( p_demux->s, NULL, i_data_offset ) < i_data_offset )
 108         return VLC_EGENERIC;
 109
 110     p_demux->pf_demux   = Demux;
 111     p_demux->pf_control = Control;
 112     p_demux->p_sys      = p_sys = malloc( sizeof( demux_sys_t ) );
 113     if( p_sys == NULL )
 114         return VLC_ENOMEM;
 115
 116     p_sys->i_silence_countdown = p_sys->i_block_start = p_sys->i_block_end =
 117     p_sys->i_loop_count = 0;
 118     p_sys->p_es = NULL;
 119
 120     date_Init( &p_sys->pts, 1, 1 );
 121     date_Set( &p_sys->pts, 1 );
 122
 123     es_format_Init( &p_sys->fmt, AUDIO_ES, 0 );
 124
 125     return VLC_SUCCESS;
 126 }
 127
 128
 129 static int fmtcmp( es_format_t *ofmt, es_format_t *nfmt )
 130 {
 131     return (ofmt->audio.i_bitspersample != nfmt->audio.i_bitspersample)
 132         || (ofmt->audio.i_rate != nfmt->audio.i_rate)
 133         || (ofmt->audio.i_channels != nfmt->audio.i_channels);
 134 }
 135
 136
 137 static int ReadBlockHeader( demux_t *p_demux )
 138 {
 139     es_format_t     new_fmt;
 140     uint8_t buf[8];
 141     int32_t i_block_size;
 142     demux_sys_t *p_sys = p_demux->p_sys;
 143
 144     if( stream_Read( p_demux->s, buf, 4 ) < 4 )
 145         return VLC_EGENERIC; /* EOF */
 146
 147     i_block_size = GetDWLE( buf ) >> 8;
 148     msg_Dbg( p_demux, "new block: type: %u, size: %u",
 149              (unsigned)*buf, i_block_size );
 150
 151     es_format_Init( &new_fmt, AUDIO_ES, 0 );
 152
 153     switch( *buf )
 154     {
 155         case 0: /* not possible : caught with earlier stream_Read */
 156             goto corrupt;
 157
 158         case 1:
 159             if( i_block_size < 2 )
 160                 goto corrupt;
 161             i_block_size -= 2;
 162
 163             if( stream_Read( p_demux->s, buf, 2 ) < 2 )
 164                 goto corrupt;
 165
 166             new_fmt.audio.i_rate = 1000000L / (256L - buf[0]);
 167             if( buf[1] )
 168             {
 169                 msg_Err( p_demux, "Unsupported compression" );
 170                 return VLC_EGENERIC;
 171             }
 172
 173             new_fmt.i_codec = VLC_FOURCC('u','8',' ',' ');
 174             new_fmt.audio.i_bytes_per_frame = 1;
 175             new_fmt.audio.i_frame_length = 1;
 176             new_fmt.audio.i_channels = 1;
 177             new_fmt.audio.i_blockalign = 1;
 178             new_fmt.audio.i_bitspersample = 8;
 179             new_fmt.i_bitrate = p_sys->fmt.audio.i_rate * 8;
 180             break;
 181
 182         case 2: /* data block with same format as the previous one */
 183             if( p_sys->p_es == NULL )
 184                 goto corrupt; /* no previous block! */
 185
 186             memcpy( &new_fmt, &p_sys->fmt, sizeof( new_fmt ) );
 187             break;
 188
 189         case 3: /* silence block */
 190             if( ( i_block_size != 3 )
 191              || ( stream_Read( p_demux->s, buf, 3 ) < 3 ) )
 192                 goto corrupt;
 193
 194             i_block_size = 0;
 195             p_sys->i_silence_countdown = GetWLE( buf );
 196
 197             new_fmt.audio.i_rate = 1000000L / (256L - buf[2]);
 198             new_fmt.i_codec = VLC_FOURCC('u','8',' ',' ');
 199             new_fmt.audio.i_bytes_per_frame = 1;
 200             new_fmt.audio.i_frame_length = 1;
 201             new_fmt.audio.i_channels = 1;
 202             new_fmt.audio.i_blockalign = 1;
 203             new_fmt.audio.i_bitspersample = 8;
 204             new_fmt.i_bitrate = p_sys->fmt.audio.i_rate * 8;
 205             break;
 206
 207         case 6: /* repeat block */
 208             if( ( i_block_size != 2 )
 209              || ( stream_Read( p_demux->s, buf, 2 ) < 2 ) )
 210                 goto corrupt;
 211
 212             i_block_size = 0;
 213             p_sys->i_loop_count = GetWLE( buf );
 214             p_sys->i_loop_offset = stream_Tell( p_demux->s );
 215             break;
 216
 217         case 7: /* repeat end block */
 218             if( i_block_size != 0 )
 219                 goto corrupt;
 220
 221             if( p_sys->i_loop_count > 0 )
 222             {
 223                 if( stream_Seek( p_demux->s, p_sys->i_loop_offset ) )
 224                     msg_Warn( p_demux, "cannot loop: seek failed" );
 225                 else
 226                     p_sys->i_loop_count--;
 227             }
 228             break;
 229
 230         /* FIXME: support block type 8 properly */
 231         case 8:
 232             msg_Err( p_demux, "Unimplemented block type 8" );
 233             return VLC_EGENERIC;
 234
 235         case 9:
 236             if( i_block_size < 12 )
 237                 goto corrupt;
 238             i_block_size -= 12;
 239
 240             if( ( stream_Read( p_demux->s, buf, 8 ) < 8 )
 241              || ( stream_Read( p_demux->s, NULL, 4 ) < 4 ) )
 242                 goto corrupt;
 243
 244             new_fmt.audio.i_rate = GetDWLE( buf );
 245             new_fmt.audio.i_bitspersample = buf[4];
 246             new_fmt.audio.i_channels = buf[5];
 247
 248             switch( GetWLE( &buf[6] ) ) /* format */
 249             {
 250                 case 0x0000: /* PCM */
 251                     switch( new_fmt.audio.i_bitspersample )
 252                     {
 253                         case 8:
 254                             new_fmt.i_codec = VLC_FOURCC('u','8',' ',' ');
 255                             break;
 256
 257                         case 16:
 258                             new_fmt.i_codec = VLC_FOURCC('u','1','6','l');
 259                             break;
 260
 261                         default:
 262                             msg_Err( p_demux, "Unsupported bit res.: %u bits",
 263                                      new_fmt.audio.i_bitspersample );
 264                             return VLC_EGENERIC;
 265                     }
 266                     break;
 267
 268                 case 0x0004: /* signed */
 269                     switch( new_fmt.audio.i_bitspersample )
 270                     {
 271                         case 8:
 272                             new_fmt.i_codec = VLC_FOURCC('s','8',' ',' ');
 273                             break;
 274
 275                         case 16:
 276                             new_fmt.i_codec = VLC_FOURCC('s','1','6','l');
 277                             break;
 278
 279                         default:
 280                             msg_Err( p_demux, "Unsupported bit res.: %u bits",
 281                                      new_fmt.audio.i_bitspersample );
 282                             return VLC_EGENERIC;
 283                     }
 284                     break;
 285
 286                 default:
 287                     msg_Err( p_demux, "Unsupported compression" );
 288                     return VLC_EGENERIC;
 289             }
 290
 291             new_fmt.audio.i_bytes_per_frame = new_fmt.audio.i_channels
 292                 * (new_fmt.audio.i_bitspersample / 8);
 293             new_fmt.audio.i_frame_length = 1;
 294             new_fmt.audio.i_blockalign = p_sys->fmt.audio.i_bytes_per_frame;
 295             new_fmt.i_bitrate = 8 * new_fmt.audio.i_rate
 296                                      * new_fmt.audio.i_bytes_per_frame;
 297             break;
 298
 299         default:
 300             msg_Dbg( p_demux, "Unknown block type %u - skipping block",
 301                      (unsigned)*buf);
 302         case 4: /* blocks of non-audio types can be skipped */
 303         case 5:
 304             if( stream_Read( p_demux->s, NULL, i_block_size ) < i_block_size )
 305                 goto corrupt;
 306             i_block_size = 0;
 307             break;
 308     }
 309
 310     p_sys->i_block_start = stream_Tell( p_demux->s );
 311     p_sys->i_block_end = p_sys->i_block_start + i_block_size;
 312
 313     if( i_block_size || p_sys->i_silence_countdown )
 314     {
 315         /* we've read a block with data in it - update decoder */
 316         msg_Dbg( p_demux, "fourcc: %4.4s, channels: %d, "
 317                  "freq: %d Hz, bitrate: %dKo/s, blockalign: %d, "
 318                  "bits/samples: %d", (char *)&new_fmt.i_codec,
 319                  new_fmt.audio.i_channels, new_fmt.audio.i_rate,
 320                  new_fmt.i_bitrate / 8192, new_fmt.audio.i_blockalign,
 321                  new_fmt.audio.i_bitspersample );
 322
 323         if( ( p_sys->p_es != NULL ) && fmtcmp( &p_sys->fmt, &new_fmt ) )
 324         {
 325             msg_Dbg( p_demux, "codec change needed" );
 326             es_out_Del( p_demux->out, p_sys->p_es );
 327             p_sys->p_es = NULL;
 328         }
 329
 330         if( p_sys->p_es == NULL )
 331         {
 332             memcpy( &p_sys->fmt, &new_fmt, sizeof( p_sys->fmt ) );
 333             date_Change( &p_sys->pts, p_sys->fmt.audio.i_rate, 1 );
 334             p_sys->p_es = es_out_Add( p_demux->out, &p_sys->fmt );
 335         }
 336     }
 337
 338     return VLC_SUCCESS;
 339
 340 corrupt:
 341     msg_Err( p_demux, "corrupted file - halting demux" );
 342     return VLC_EGENERIC;
 343 }
 344
 345 /*****************************************************************************
 346  * Demux: read packet and send them to decoders
 347  *****************************************************************************
 348  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
 349  *****************************************************************************/
 350 static int Demux( demux_t *p_demux )
 351 {
 352     demux_sys_t *p_sys = p_demux->p_sys;
 353     block_t     *p_block;
 354     int64_t     i_offset, i;
 355
 356     i_offset = stream_Tell( p_demux->s );
 357
 358     while( ( i_offset >= p_sys->i_block_end )
 359          && ( p_sys->i_silence_countdown == 0 ) )
 360         if( ReadBlockHeader( p_demux ) != VLC_SUCCESS )
 361             return 0;
 362
 363     if( p_sys->i_silence_countdown == 0 )
 364     {
 365         i = ( p_sys->i_block_end - i_offset )
 366             / p_sys->fmt.audio.i_bytes_per_frame;
 367         if( i > 100)
 368             i = 100;
 369
 370         p_block = stream_Block( p_demux->s,
 371                                 p_sys->fmt.audio.i_bytes_per_frame * i );
 372         if( p_block == NULL )
 373         {
 374             msg_Warn( p_demux, "cannot read data" );
 375             return 0;
 376         }
 377     }
 378     else
 379     {   /* emulates silence from the stream */
 380         i = p_sys->i_silence_countdown;
 381         if (i > 100 )
 382             i = 100;
 383
 384         p_block = block_New( p_demux, i );
 385         if( p_block == NULL )
 386             return VLC_ENOMEM;
 387
 388         memset( p_block->p_buffer, 0, i );
 389         p_sys->i_silence_countdown -= i;
 390     }
 391
 392     p_block->i_dts = p_block->i_pts =
 393         date_Increment( &p_sys->pts, p_sys->fmt.audio.i_frame_length * i );
 394
 395     es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
 396
 397     es_out_Send( p_demux->out, p_sys->p_es, p_block );
 398
 399     return 1;
 400 }
 401
 402 /*****************************************************************************
 403  * Close: frees unused data
 404  *****************************************************************************/
 405 static void Close ( vlc_object_t * p_this )
 406 {
 407     demux_sys_t *p_sys  = ((demux_t *)p_this)->p_sys;
 408
 409     free( p_sys );
 410 }
 411
 412 /*****************************************************************************
 413  * Control:
 414  *****************************************************************************/
 415 static int Control( demux_t *p_demux, int i_query, va_list args )
 416 {
 417     demux_sys_t *p_sys  = p_demux->p_sys;
 418
 419     return demux2_vaControlHelper( p_demux->s, p_sys->i_block_start,
 420                                    p_sys->i_block_end,
 421                                    p_sys->fmt.i_bitrate,
 422                                    p_sys->fmt.audio.i_blockalign,
 423                                    i_query, args );
 424 }