modules/demux/nsv.c

   1 /*****************************************************************************
   2  * nsv.c: NullSoft Video demuxer.
   3  *****************************************************************************
   4  * Copyright (C) 2004-2007 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_demux.h>
  35
  36 /* TODO:
  37  *  - implement NSVf parsing (to get meta data)
  38  *  - implement missing Control (and in the right way)
  39  *  - ...
  40  */
  41
  42 /*****************************************************************************
  43  * Module descriptor
  44  *****************************************************************************/
  45 static int  Open    ( vlc_object_t * );
  46 static void Close  ( vlc_object_t * );
  47
  48 vlc_module_begin ()
  49     set_description( N_("NullSoft demuxer" ) )
  50     set_capability( "demux", 10 )
  51     set_category( CAT_INPUT )
  52     set_subcategory( SUBCAT_INPUT_DEMUX )
  53     set_callbacks( Open, Close )
  54     add_shortcut( "nsv" )
  55 vlc_module_end ()
  56
  57 /*****************************************************************************
  58  * Local prototypes
  59  *****************************************************************************/
  60
  61 struct demux_sys_t
  62 {
  63     es_format_t  fmt_audio;
  64     es_out_id_t *p_audio;
  65
  66     es_format_t  fmt_video;
  67     es_out_id_t *p_video;
  68
  69     es_format_t  fmt_sub;
  70     es_out_id_t  *p_sub;
  71
  72     int64_t     i_pcr;
  73     int64_t     i_time;
  74     int64_t     i_pcr_inc;
  75
  76     bool b_start_record;
  77 };
  78
  79 static int Demux  ( demux_t *p_demux );
  80 static int Control( demux_t *p_demux, int i_query, va_list args );
  81
  82 static int ReSynch( demux_t *p_demux );
  83
  84 static int ReadNSVf( demux_t *p_demux );
  85 static int ReadNSVs( demux_t *p_demux );
  86
  87 /*****************************************************************************
  88  * Open
  89  *****************************************************************************/
  90 static int Open( vlc_object_t *p_this )
  91 {
  92     demux_t     *p_demux = (demux_t*)p_this;
  93     demux_sys_t *p_sys;
  94
  95     const uint8_t *p_peek;
  96
  97     if( vlc_stream_Peek( p_demux->s, &p_peek, 8 ) < 8 )
  98         return VLC_EGENERIC;
  99
 100     if( memcmp( p_peek, "NSVf", 4 ) && memcmp( p_peek, "NSVs", 4 ) )
 101     {
 102        /* In case we had force this demuxer we try to resynch */
 103         if( !p_demux->obj.force || ReSynch( p_demux ) )
 104             return VLC_EGENERIC;
 105     }
 106
 107     p_sys = malloc( sizeof( demux_sys_t ) );
 108     if( unlikely(p_sys == NULL) )
 109         return VLC_ENOMEM;
 110
 111     /* Fill p_demux field */
 112     p_demux->p_sys = p_sys;
 113     p_demux->pf_demux = Demux;
 114     p_demux->pf_control = Control;
 115
 116     es_format_Init( &p_sys->fmt_audio, AUDIO_ES, 0 );
 117     p_sys->p_audio = NULL;
 118
 119     es_format_Init( &p_sys->fmt_video, VIDEO_ES, 0 );
 120     p_sys->p_video = NULL;
 121
 122     es_format_Init( &p_sys->fmt_sub, SPU_ES, 0 );
 123     p_sys->p_sub = NULL;
 124
 125     p_sys->i_pcr   = 0;
 126     p_sys->i_time  = 0;
 127     p_sys->i_pcr_inc = 0;
 128
 129     p_sys->b_start_record = false;
 130
 131     return VLC_SUCCESS;
 132 }
 133
 134 /*****************************************************************************
 135  * Close
 136  *****************************************************************************/
 137 static void Close( vlc_object_t *p_this )
 138 {
 139     demux_t     *p_demux = (demux_t*)p_this;
 140     demux_sys_t *p_sys = p_demux->p_sys;
 141
 142     free( p_sys );
 143 }
 144
 145
 146 /*****************************************************************************
 147  * Demux:
 148  *****************************************************************************/
 149 static int Demux( demux_t *p_demux )
 150 {
 151     demux_sys_t *p_sys = p_demux->p_sys;
 152
 153     uint8_t     header[5];
 154     const uint8_t *p_peek;
 155
 156     int         i_size;
 157     block_t     *p_frame;
 158
 159     for( ;; )
 160     {
 161         if( vlc_stream_Peek( p_demux->s, &p_peek, 8 ) < 8 )
 162         {
 163             msg_Warn( p_demux, "cannot peek" );
 164             return 0;
 165         }
 166
 167         if( !memcmp( p_peek, "NSVf", 4 ) )
 168         {
 169             if( ReadNSVf( p_demux ) )
 170                 return -1;
 171         }
 172         else if( !memcmp( p_peek, "NSVs", 4 ) )
 173         {
 174             if( p_sys->b_start_record )
 175             {
 176                 /* Enable recording once synchronized */
 177                 vlc_stream_Control( p_demux->s, STREAM_SET_RECORD_STATE, true, "nsv" );
 178                 p_sys->b_start_record = false;
 179             }
 180
 181             if( ReadNSVs( p_demux ) )
 182                 return -1;
 183             break;
 184         }
 185         else if( GetWLE( p_peek ) == 0xbeef )
 186         {
 187             /* Next frame of the current NSVs chunk */
 188             if( vlc_stream_Read( p_demux->s, NULL, 2 ) < 2 )
 189             {
 190                 msg_Warn( p_demux, "cannot read" );
 191                 return 0;
 192             }
 193             break;
 194         }
 195         else
 196         {
 197             msg_Err( p_demux, "invalid signature 0x%x (%4.4s)", GetDWLE( p_peek ), (const char*)p_peek );
 198             if( ReSynch( p_demux ) )
 199                 return -1;
 200         }
 201     }
 202
 203     if( vlc_stream_Read( p_demux->s, header, 5 ) < 5 )
 204     {
 205         msg_Warn( p_demux, "cannot read" );
 206         return 0;
 207     }
 208
 209     /* Set PCR */
 210     es_out_Control( p_demux->out, ES_OUT_SET_PCR, VLC_TS_0 + p_sys->i_pcr );
 211
 212     /* Read video */
 213     i_size = ( header[0] >> 4 ) | ( header[1] << 4 ) | ( header[2] << 12 );
 214     if( i_size > 0 )
 215     {
 216         /* extra data ? */
 217         if( (header[0]&0x0f) != 0x0 )
 218         {
 219             uint8_t      aux[6];
 220             int          i_aux;
 221             vlc_fourcc_t fcc;
 222             if( vlc_stream_Read( p_demux->s, aux, 6 ) < 6 )
 223             {
 224                 msg_Warn( p_demux, "cannot read" );
 225                 return 0;
 226             }
 227             i_aux = GetWLE( aux );
 228             fcc   = VLC_FOURCC( aux[2], aux[3], aux[4], aux[5] );
 229
 230             msg_Dbg( p_demux, "Belekas: %d - size=%d fcc=%4.4s",
 231                      header[0]&0xf, i_aux, (char*)&fcc );
 232
 233             if( fcc == VLC_FOURCC( 'S', 'U', 'B', 'T' ) && i_aux > 2 )
 234             {
 235                 if( p_sys->p_sub == NULL )
 236                 {
 237                     p_sys->fmt_sub.i_codec = VLC_FOURCC( 's', 'u', 'b', 't' );
 238                     p_sys->p_sub = es_out_Add( p_demux->out, &p_sys->fmt_sub );
 239                     es_out_Control( p_demux->out, ES_OUT_SET_ES, p_sys->p_sub );
 240                 }
 241                 vlc_stream_Read( p_demux->s, NULL, 2 );
 242
 243                 if( ( p_frame = vlc_stream_Block( p_demux->s, i_aux - 2 ) ) )
 244                 {
 245                     uint8_t *p = p_frame->p_buffer;
 246
 247                     while( p < &p_frame->p_buffer[p_frame->i_buffer] && *p != 0 )
 248                     {
 249                         p++;
 250                     }
 251                     if( *p == 0 && p + 1 < &p_frame->p_buffer[p_frame->i_buffer] )
 252                     {
 253                         p_frame->i_buffer -= p + 1 - p_frame->p_buffer;
 254                         p_frame->p_buffer = p + 1;
 255                     }
 256
 257                     /* Skip the first part (it is the language name) */
 258                     p_frame->i_pts = VLC_TS_0 + p_sys->i_pcr;
 259                     p_frame->i_dts = VLC_TS_0 + p_sys->i_pcr + 4000000;    /* 4s */
 260
 261                     es_out_Send( p_demux->out, p_sys->p_sub, p_frame );
 262                 }
 263             }
 264             else
 265             {
 266                 /* We skip this extra data */
 267                 if( vlc_stream_Read( p_demux->s, NULL, i_aux ) < i_aux )
 268                 {
 269                     msg_Warn( p_demux, "cannot read" );
 270                     return 0;
 271                 }
 272             }
 273             i_size -= 6 + i_aux;
 274         }
 275
 276         /* msg_Dbg( p_demux, "frame video size=%d", i_size ); */
 277         if( i_size > 0 && ( p_frame = vlc_stream_Block( p_demux->s, i_size ) ) )
 278         {
 279             p_frame->i_dts = VLC_TS_0 + p_sys->i_pcr;
 280
 281             if( p_sys->p_video )
 282                 es_out_Send( p_demux->out, p_sys->p_video, p_frame );
 283             else
 284             {
 285                 block_Release( p_frame );
 286                 msg_Dbg( p_demux, "ignoring unsupported video frame (size=%d)",
 287                          i_size );
 288             }
 289         }
 290     }
 291
 292     /* Read audio */
 293     i_size = header[3] | ( header[4] << 8 );
 294     if( i_size > 0 )
 295     {
 296         /* msg_Dbg( p_demux, "frame audio size=%d", i_size ); */
 297         if( p_sys->fmt_audio.i_codec == VLC_FOURCC( 'a', 'r', 'a', 'w' ) )
 298         {
 299             uint8_t h[4];
 300             vlc_stream_Read( p_demux->s, h, 4 );
 301
 302             p_sys->fmt_audio.audio.i_channels = h[1];
 303             p_sys->fmt_audio.audio.i_rate = GetWLE( &h[2] );
 304
 305             i_size -= 4;
 306         }
 307         if( p_sys->p_audio == NULL )
 308         {
 309             p_sys->p_audio = es_out_Add( p_demux->out, &p_sys->fmt_audio );
 310         }
 311
 312         if( ( p_frame = vlc_stream_Block( p_demux->s, i_size ) ) )
 313         {
 314             p_frame->i_dts =
 315             p_frame->i_pts = VLC_TS_0 + p_sys->i_pcr;
 316
 317             if( p_sys->p_audio )
 318                 es_out_Send( p_demux->out, p_sys->p_audio, p_frame );
 319             else
 320             {
 321                 block_Release( p_frame );
 322                 msg_Dbg( p_demux, "ignoring unsupported audio frame (size=%d)",
 323                          i_size );
 324             }
 325         }
 326     }
 327
 328     p_sys->i_pcr += p_sys->i_pcr_inc;
 329     if( p_sys->i_time >= 0 )
 330     {
 331         p_sys->i_time += p_sys->i_pcr_inc;
 332     }
 333
 334     return 1;
 335 }
 336
 337 /*****************************************************************************
 338  * Control:
 339  *****************************************************************************/
 340 static int Control( demux_t *p_demux, int i_query, va_list args )
 341 {
 342     demux_sys_t *p_sys = p_demux->p_sys;
 343     double f, *pf;
 344     bool b_bool, *pb_bool;
 345     int64_t i64, *pi64;
 346
 347     switch( i_query )
 348     {
 349         case DEMUX_CAN_SEEK:
 350             return vlc_stream_vaControl( p_demux->s, i_query, args );
 351
 352         case DEMUX_GET_POSITION:
 353             pf = (double*) va_arg( args, double* );
 354             i64 = stream_Size( p_demux->s );
 355             if( i64 > 0 )
 356             {
 357                 double current = vlc_stream_Tell( p_demux->s );
 358                 *pf = current / (double)i64;
 359             }
 360             else
 361             {
 362                 *pf = 0.0;
 363             }
 364             return VLC_SUCCESS;
 365
 366         case DEMUX_SET_POSITION:
 367             f = (double) va_arg( args, double );
 368             i64 = stream_Size( p_demux->s );
 369
 370             if( vlc_stream_Seek( p_demux->s, (int64_t)(i64 * f) ) || ReSynch( p_demux ) )
 371                 return VLC_EGENERIC;
 372
 373             p_sys->i_time = -1; /* Invalidate time display */
 374             return VLC_SUCCESS;
 375
 376         case DEMUX_GET_TIME:
 377             pi64 = (int64_t*)va_arg( args, int64_t * );
 378             if( p_sys->i_time < 0 )
 379             {
 380                 *pi64 = 0;
 381                 return VLC_EGENERIC;
 382             }
 383             *pi64 = p_sys->i_time;
 384             return VLC_SUCCESS;
 385
 386 #if 0
 387         case DEMUX_GET_LENGTH:
 388             pi64 = (int64_t*)va_arg( args, int64_t * );
 389             if( p_sys->i_mux_rate > 0 )
 390             {
 391                 *pi64 = (int64_t)1000000 * ( stream_Size( p_demux->s ) / 50 ) / p_sys->i_mux_rate;
 392                 return VLC_SUCCESS;
 393             }
 394             *pi64 = 0;
 395             return VLC_EGENERIC;
 396
 397 #endif
 398         case DEMUX_GET_FPS:
 399             pf = (double*)va_arg( args, double * );
 400             *pf = (double)1000000.0 / (double)p_sys->i_pcr_inc;
 401             return VLC_SUCCESS;
 402
 403         case DEMUX_CAN_RECORD:
 404             pb_bool = (bool*)va_arg( args, bool * );
 405             *pb_bool = true;
 406             return VLC_SUCCESS;
 407
 408         case DEMUX_SET_RECORD_STATE:
 409             b_bool = (bool)va_arg( args, int );
 410
 411             if( !b_bool )
 412                 vlc_stream_Control( p_demux->s, STREAM_SET_RECORD_STATE, false );
 413             p_sys->b_start_record = b_bool;
 414             return VLC_SUCCESS;
 415
 416
 417         case DEMUX_SET_TIME:
 418         default:
 419             return VLC_EGENERIC;
 420     }
 421 }
 422
 423 /*****************************************************************************
 424  * ReSynch:
 425  *****************************************************************************/
 426 static int ReSynch( demux_t *p_demux )
 427 {
 428     for( ;; )
 429     {
 430         const uint8_t *p_peek;
 431         int i_peek = vlc_stream_Peek( p_demux->s, &p_peek, 1024 );
 432         if( i_peek < 8 )
 433             break;
 434
 435         int i_skip = 0;
 436
 437         while( i_skip < i_peek - 4 )
 438         {
 439             if( !memcmp( p_peek, "NSVf", 4 )
 440              || !memcmp( p_peek, "NSVs", 4 ) )
 441             {
 442                 if( i_skip > 0 )
 443                 {
 444                     vlc_stream_Read( p_demux->s, NULL, i_skip );
 445                 }
 446                 return VLC_SUCCESS;
 447             }
 448             p_peek++;
 449             i_skip++;
 450         }
 451
 452         if( vlc_stream_Read( p_demux->s, NULL, i_skip ) < i_skip )
 453             break;
 454     }
 455     return VLC_EGENERIC;
 456 }
 457
 458 /*****************************************************************************
 459  * ReadNSVf:
 460  *****************************************************************************/
 461 static int ReadNSVf( demux_t *p_demux )
 462 {
 463     /* demux_sys_t *p_sys = p_demux->p_sys; */
 464     const uint8_t     *p;
 465
 466     msg_Dbg( p_demux, "new NSVf chunk" );
 467     if( vlc_stream_Peek( p_demux->s, &p, 8 ) < 8 )
 468     {
 469         return VLC_EGENERIC;
 470     }
 471
 472     uint32_t i_header_size = GetDWLE( &p[4] );
 473     msg_Dbg( p_demux, "    - size=%" PRIu32, i_header_size );
 474
 475     if( i_header_size == 0 || i_header_size == UINT32_MAX )
 476         return VLC_EGENERIC;
 477
 478
 479     return vlc_stream_Read( p_demux->s, NULL, i_header_size ) == i_header_size
 480         ? VLC_SUCCESS : VLC_EGENERIC;
 481 }
 482 /*****************************************************************************
 483  * ReadNSVs:
 484  *****************************************************************************/
 485 static int ReadNSVs( demux_t *p_demux )
 486 {
 487     demux_sys_t *p_sys = p_demux->p_sys;
 488     uint8_t      header[19];
 489     vlc_fourcc_t fcc;
 490
 491     if( vlc_stream_Read( p_demux->s, header, 19 ) < 19 )
 492     {
 493         msg_Warn( p_demux, "cannot read" );
 494         return VLC_EGENERIC;
 495     }
 496
 497     /* Video */
 498     switch( ( fcc = VLC_FOURCC( header[4], header[5], header[6], header[7] ) ) )
 499     {
 500         case VLC_FOURCC( 'V', 'P', '3', ' ' ):
 501         case VLC_FOURCC( 'V', 'P', '3', '0' ):
 502             fcc = VLC_FOURCC( 'V', 'P', '3', '0' );
 503             break;
 504
 505         case VLC_FOURCC( 'V', 'P', '3', '1' ):
 506             fcc = VLC_FOURCC( 'V', 'P', '3', '1' );
 507             break;
 508
 509         case VLC_FOURCC( 'V', 'P', '5', ' ' ):
 510         case VLC_FOURCC( 'V', 'P', '5', '0' ):
 511             fcc = VLC_FOURCC( 'V', 'P', '5', '0' );
 512             break;
 513         case VLC_FOURCC( 'V', 'P', '6', '0' ):
 514         case VLC_FOURCC( 'V', 'P', '6', '1' ):
 515         case VLC_FOURCC( 'V', 'P', '6', '2' ):
 516         case VLC_FOURCC( 'V', 'P', '8', '0' ):
 517         case VLC_FOURCC( 'H', '2', '6', '4' ):
 518         case VLC_FOURCC( 'N', 'O', 'N', 'E' ):
 519             break;
 520         default:
 521             msg_Err( p_demux, "unsupported video codec %4.4s", (char *)&fcc );
 522             break;
 523     }
 524     if( fcc != VLC_FOURCC( 'N', 'O', 'N', 'E' ) && fcc != p_sys->fmt_video.i_codec  )
 525     {
 526         es_format_Init( &p_sys->fmt_video, VIDEO_ES, fcc );
 527         p_sys->fmt_video.video.i_width = GetWLE( &header[12] );
 528         p_sys->fmt_video.video.i_height = GetWLE( &header[14] );
 529         p_sys->fmt_video.video.i_visible_width = p_sys->fmt_video.video.i_width;
 530         p_sys->fmt_video.video.i_visible_height = p_sys->fmt_video.video.i_height;
 531         if( p_sys->p_video )
 532         {
 533             es_out_Del( p_demux->out, p_sys->p_video );
 534         }
 535         p_sys->p_video = es_out_Add( p_demux->out, &p_sys->fmt_video );
 536
 537         msg_Dbg( p_demux, "    - video `%4.4s' %dx%d",
 538                  (char*)&fcc,
 539                  p_sys->fmt_video.video.i_width,
 540                  p_sys->fmt_video.video.i_height );
 541     }
 542
 543     /* Audio */
 544     switch( ( fcc = VLC_FOURCC( header[8], header[9], header[10], header[11] ) ) )
 545     {
 546         case VLC_FOURCC( 'M', 'P', '3', ' ' ):
 547             fcc = VLC_FOURCC( 'm', 'p', 'g', 'a' );
 548             break;
 549         case VLC_FOURCC( 'P', 'C', 'M', ' ' ):
 550             fcc = VLC_FOURCC( 'a', 'r', 'a', 'w' );
 551             break;
 552         case VLC_FOURCC( 'A', 'A', 'C', ' ' ):
 553         case VLC_FOURCC( 'A', 'A', 'C', 'P' ):
 554             fcc = VLC_FOURCC( 'm', 'p', '4', 'a' );
 555             break;
 556         case VLC_FOURCC( 'S', 'P', 'X', ' ' ):
 557             fcc = VLC_FOURCC( 's', 'p', 'x', ' ' );
 558             break;
 559         case VLC_FOURCC( 'N', 'O', 'N', 'E' ):
 560             break;
 561         default:
 562             msg_Err( p_demux, "unsupported audio codec %4.4s", (char *)&fcc );
 563             break;
 564     }
 565
 566     if( fcc != VLC_FOURCC( 'N', 'O', 'N', 'E' ) && fcc != p_sys->fmt_audio.i_codec )
 567     {
 568         msg_Dbg( p_demux, "    - audio `%4.4s'", (char*)&fcc );
 569
 570         if( p_sys->p_audio )
 571         {
 572             es_out_Del( p_demux->out, p_sys->p_audio );
 573             p_sys->p_audio = NULL;
 574         }
 575         es_format_Init( &p_sys->fmt_audio, AUDIO_ES, fcc );
 576     }
 577
 578     if( header[16]&0x80 )
 579     {
 580         /* Fractional frame rate */
 581         switch( header[16]&0x03 )
 582         {
 583             case 0: /* 30 fps */
 584                 p_sys->i_pcr_inc = 33333; /* 300000/9 */
 585                 break;
 586             case 1: /* 29.97 fps */
 587                 p_sys->i_pcr_inc = 33367; /* 300300/9 */
 588                 break;
 589             case 2: /* 25 fps */
 590                 p_sys->i_pcr_inc = 40000; /* 360000/9 */
 591                 break;
 592             case 3: /* 23.98 fps */
 593                 p_sys->i_pcr_inc = 41700; /* 375300/9 */
 594                 break;
 595         }
 596
 597         if( header[16] < 0xc0 )
 598             p_sys->i_pcr_inc = p_sys->i_pcr_inc * (((header[16] ^ 0x80) >> 2 ) +1 );
 599         else
 600             p_sys->i_pcr_inc = p_sys->i_pcr_inc / (((header[16] ^ 0xc0) >> 2 ) +1 );
 601     }
 602     else if( header[16] != 0 )
 603     {
 604         /* Integer frame rate */
 605         p_sys->i_pcr_inc = 1000000 / header[16];
 606     }
 607     else
 608     {
 609         msg_Dbg( p_demux, "invalid fps (0x00)" );
 610         p_sys->i_pcr_inc = 40000;
 611     }
 612     //msg_Dbg( p_demux, "    - fps=%.3f", 1000000.0 / (double)p_sys->i_pcr_inc );
 613
 614     if( p_sys->p_audio == NULL && p_sys->p_video == NULL )
 615     {
 616         msg_Err( p_demux, "unable to play neither audio nor video, aborting." );
 617         return VLC_EGENERIC;
 618     }
 619
 620     return VLC_SUCCESS;
 621 }
 622