git.sesse.net Git - vlc/blob - modules/stream_out/bridge.c

   1 /*****************************************************************************
   2  * bridge.c: bridge stream output module
   3  *****************************************************************************
   4  * Copyright (C) 2005 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   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>
  28 #include <string.h>
  29
  30 #include <vlc/vlc.h>
  31 #include <vlc/sout.h>
  32
  33 /*****************************************************************************
  34  * Module descriptor
  35  *****************************************************************************/
  36 #define ID_TEXT N_("ID")
  37 #define ID_LONGTEXT N_( \
  38     "Specify an identifier integer for this elementary stream" )
  39
  40 #define DELAY_TEXT N_("Delay")
  41 #define DELAY_LONGTEXT N_("Pictures coming from the picture video outputs " \
  42         "will be delayed accordingly (in milliseconds, >= 100 ms). For high " \
  43         "values you will need to raise file-caching and others.")
  44
  45 #define ID_OFFSET_TEXT N_("ID Offset")
  46 #define ID_OFFSET_LONGTEXT N_("Offset to add to the stream IDs specified in " \
  47         "bridge_out to obtain the stream IDs bridge_in will register.")
  48
  49 static int  OpenOut ( vlc_object_t * );
  50 static void CloseOut( vlc_object_t * );
  51 static int  OpenIn  ( vlc_object_t * );
  52 static void CloseIn ( vlc_object_t * );
  53
  54 #define SOUT_CFG_PREFIX_OUT "sout-bridge-out-"
  55 #define SOUT_CFG_PREFIX_IN "sout-bridge-in-"
  56
  57 vlc_module_begin();
  58     set_shortname( _("Bridge"));
  59     set_description( _("Bridge stream output"));
  60     add_submodule();
  61     set_section( N_("Bridge out"), NULL );
  62     set_capability( "sout stream", 50 );
  63     add_shortcut( "bridge-out" );
  64     /* Only usable with VLM. No category so not in gui preferences
  65     set_category( CAT_SOUT );
  66     set_subcategory( SUBCAT_SOUT_STREAM );*/
  67     add_integer( SOUT_CFG_PREFIX_OUT "id", 0, NULL, ID_TEXT, ID_LONGTEXT,
  68                  VLC_FALSE );
  69     set_callbacks( OpenOut, CloseOut );
  70
  71     add_submodule();
  72     set_section( N_("Bridge in"), NULL );
  73     set_capability( "sout stream", 50 );
  74     add_shortcut( "bridge-in" );
  75     /*set_category( CAT_SOUT );
  76     set_subcategory( SUBCAT_SOUT_STREAM );*/
  77     add_integer( SOUT_CFG_PREFIX_IN "delay", 0, NULL, DELAY_TEXT,
  78                  DELAY_LONGTEXT, VLC_FALSE );
  79     add_integer( SOUT_CFG_PREFIX_IN "id-offset", 8192, NULL, ID_OFFSET_TEXT,
  80                  ID_OFFSET_LONGTEXT, VLC_FALSE );
  81     set_callbacks( OpenIn, CloseIn );
  82
  83     var_Create( p_module->p_libvlc, "bridge-lock", VLC_VAR_MUTEX );
  84 vlc_module_end();
  85
  86
  87 /*****************************************************************************
  88  * Local prototypes
  89  *****************************************************************************/
  90 static const char *ppsz_sout_options_out[] = {
  91     "id", NULL
  92 };
  93
  94 static const char *ppsz_sout_options_in[] = {
  95     "delay", "id-offset", NULL
  96 };
  97
  98 static sout_stream_id_t *AddOut ( sout_stream_t *, es_format_t * );
  99 static int               DelOut ( sout_stream_t *, sout_stream_id_t * );
 100 static int               SendOut( sout_stream_t *, sout_stream_id_t *, block_t * );
 101
 102 static sout_stream_id_t *AddIn ( sout_stream_t *, es_format_t * );
 103 static int               DelIn ( sout_stream_t *, sout_stream_id_t * );
 104 static int               SendIn( sout_stream_t *, sout_stream_id_t *, block_t * );
 105
 106 typedef struct bridged_es_t
 107 {
 108     es_format_t fmt;
 109     block_t *p_block;
 110     block_t **pp_last;
 111     vlc_bool_t b_empty;
 112
 113     /* bridge in part */
 114     sout_stream_id_t *id;
 115     mtime_t i_last;
 116     vlc_bool_t b_changed;
 117 } bridged_es_t;
 118
 119 typedef struct bridge_t
 120 {
 121     bridged_es_t **pp_es;
 122     int i_es_num;
 123 } bridge_t;
 124
 125 #define GetBridge(a) __GetBridge( VLC_OBJECT(a) )
 126 static bridge_t *__GetBridge( vlc_object_t *p_object )
 127 {
 128     libvlc_t *p_libvlc = p_object->p_libvlc;
 129     bridge_t *p_bridge;
 130     vlc_value_t val;
 131
 132     if( var_Get( p_libvlc, "bridge-struct", &val ) != VLC_SUCCESS )
 133     {
 134         p_bridge = NULL;
 135     }
 136     else
 137     {
 138         p_bridge = val.p_address;
 139     }
 140
 141     return p_bridge;
 142 }
 143
 144
 145 /*
 146  * Bridge out
 147  */
 148
 149 typedef struct out_sout_stream_sys_t
 150 {
 151     vlc_mutex_t *p_lock;
 152     bridged_es_t *p_es;
 153     int i_id;
 154     vlc_bool_t b_inited;
 155 } out_sout_stream_sys_t;
 156
 157 /*****************************************************************************
 158  * OpenOut:
 159  *****************************************************************************/
 160 static int OpenOut( vlc_object_t *p_this )
 161 {
 162     sout_stream_t     *p_stream = (sout_stream_t *)p_this;
 163     out_sout_stream_sys_t *p_sys;
 164     vlc_value_t val;
 165
 166     sout_CfgParse( p_stream, SOUT_CFG_PREFIX_OUT, ppsz_sout_options_out,
 167                    p_stream->p_cfg );
 168
 169     p_sys          = malloc( sizeof( out_sout_stream_sys_t ) );
 170     p_sys->b_inited = VLC_FALSE;
 171
 172     var_Get( p_this->p_libvlc, "bridge-lock", &val );
 173     p_sys->p_lock = val.p_address;
 174
 175     var_Get( p_stream, SOUT_CFG_PREFIX_OUT "id", &val );
 176     p_sys->i_id = val.i_int;
 177
 178     p_stream->pf_add    = AddOut;
 179     p_stream->pf_del    = DelOut;
 180     p_stream->pf_send   = SendOut;
 181
 182     p_stream->p_sys     = (sout_stream_sys_t *)p_sys;
 183
 184     p_stream->p_sout->i_out_pace_nocontrol++;
 185
 186     return VLC_SUCCESS;
 187 }
 188
 189 /*****************************************************************************
 190  * CloseOut:
 191  *****************************************************************************/
 192 static void CloseOut( vlc_object_t * p_this )
 193 {
 194     sout_stream_t     *p_stream = (sout_stream_t*)p_this;
 195     out_sout_stream_sys_t *p_sys = (out_sout_stream_sys_t *)p_stream->p_sys;
 196
 197     p_stream->p_sout->i_out_pace_nocontrol--;
 198
 199     free( p_sys );
 200 }
 201
 202 static sout_stream_id_t * AddOut( sout_stream_t *p_stream, es_format_t *p_fmt )
 203 {
 204     out_sout_stream_sys_t *p_sys = (out_sout_stream_sys_t *)p_stream->p_sys;
 205     bridge_t *p_bridge;
 206     bridged_es_t *p_es;
 207     int i;
 208
 209     if ( p_sys->b_inited )
 210     {
 211         return NULL;
 212     }
 213     p_sys->b_inited = VLC_TRUE;
 214
 215     vlc_mutex_lock( p_sys->p_lock );
 216
 217     p_bridge = GetBridge( p_stream );
 218     if ( p_bridge == NULL )
 219     {
 220         libvlc_t *p_libvlc = p_stream->p_libvlc;
 221         vlc_value_t val;
 222
 223         p_bridge = malloc( sizeof( bridge_t ) );
 224
 225         var_Create( p_libvlc, "bridge-struct", VLC_VAR_ADDRESS );
 226         val.p_address = p_bridge;
 227         var_Set( p_libvlc, "bridge-struct", val );
 228
 229         p_bridge->i_es_num = 0;
 230         p_bridge->pp_es = NULL;
 231     }
 232
 233     for ( i = 0; i < p_bridge->i_es_num; i++ )
 234     {
 235         if ( p_bridge->pp_es[i]->b_empty && !p_bridge->pp_es[i]->b_changed )
 236             break;
 237     }
 238
 239     if ( i == p_bridge->i_es_num )
 240     {
 241         p_bridge->pp_es = realloc( p_bridge->pp_es,
 242                                    (p_bridge->i_es_num + 1)
 243                                      * sizeof(bridged_es_t *) );
 244         p_bridge->i_es_num++;
 245         p_bridge->pp_es[i] = malloc( sizeof(bridged_es_t) );
 246     }
 247
 248     p_sys->p_es = p_es = p_bridge->pp_es[i];
 249
 250     p_es->fmt = *p_fmt;
 251     p_es->fmt.i_id = p_sys->i_id;
 252     p_es->p_block = NULL;
 253     p_es->pp_last = &p_es->p_block;
 254     p_es->b_empty = VLC_FALSE;
 255
 256     p_es->id = NULL;
 257     p_es->i_last = 0;
 258     p_es->b_changed = VLC_TRUE;
 259
 260     msg_Dbg( p_stream, "bridging out input codec=%4.4s id=%d pos=%d",
 261              (char*)&p_es->fmt.i_codec, p_es->fmt.i_id, i );
 262
 263     vlc_mutex_unlock( p_sys->p_lock );
 264
 265     return (sout_stream_id_t *)p_sys;
 266 }
 267
 268 static int DelOut( sout_stream_t *p_stream, sout_stream_id_t *id )
 269 {
 270     out_sout_stream_sys_t *p_sys = (out_sout_stream_sys_t *)p_stream->p_sys;
 271     bridged_es_t *p_es;
 272
 273     if ( !p_sys->b_inited )
 274     {
 275         return VLC_SUCCESS;
 276     }
 277
 278     vlc_mutex_lock( p_sys->p_lock );
 279
 280     p_es = p_sys->p_es;
 281
 282     p_es->b_empty = VLC_TRUE;
 283     block_ChainRelease( p_es->p_block );
 284     p_es->p_block = VLC_FALSE;
 285
 286     p_es->b_changed = VLC_TRUE;
 287     vlc_mutex_unlock( p_sys->p_lock );
 288
 289     return VLC_SUCCESS;
 290 }
 291
 292 static int SendOut( sout_stream_t *p_stream, sout_stream_id_t *id,
 293                     block_t *p_buffer )
 294 {
 295     out_sout_stream_sys_t *p_sys = (out_sout_stream_sys_t *)p_stream->p_sys;
 296     bridged_es_t *p_es;
 297
 298     if ( (out_sout_stream_sys_t *)id != p_sys )
 299     {
 300         block_ChainRelease( p_buffer );
 301         return VLC_SUCCESS;
 302     }
 303
 304     vlc_mutex_lock( p_sys->p_lock );
 305
 306     p_es = p_sys->p_es;
 307     *p_es->pp_last = p_buffer;
 308     while ( p_buffer != NULL )
 309     {
 310         p_es->pp_last = &p_buffer->p_next;
 311         p_buffer = p_buffer->p_next;
 312     }
 313
 314     vlc_mutex_unlock( p_sys->p_lock );
 315
 316     return VLC_SUCCESS;
 317 }
 318
 319
 320 /*
 321  * Bridge in
 322  */
 323
 324 typedef struct in_sout_stream_sys_t
 325 {
 326     sout_stream_t *p_out;
 327     vlc_mutex_t *p_lock;
 328     int i_id_offset;
 329     mtime_t i_delay;
 330 } in_sout_stream_sys_t;
 331
 332 /*****************************************************************************
 333  * OpenIn:
 334  *****************************************************************************/
 335 static int OpenIn( vlc_object_t *p_this )
 336 {
 337     sout_stream_t     *p_stream = (sout_stream_t*)p_this;
 338     in_sout_stream_sys_t *p_sys;
 339     vlc_value_t val;
 340
 341     p_sys          = malloc( sizeof( in_sout_stream_sys_t ) );
 342
 343     p_sys->p_out = sout_StreamNew( p_stream->p_sout, p_stream->psz_next );
 344     if( !p_sys->p_out )
 345     {
 346         msg_Err( p_stream, "cannot create chain" );
 347         free( p_sys );
 348         return VLC_EGENERIC;
 349     }
 350
 351     sout_CfgParse( p_stream, SOUT_CFG_PREFIX_IN, ppsz_sout_options_in,
 352                    p_stream->p_cfg );
 353
 354     var_Get( p_this->p_libvlc, "bridge-lock", &val );
 355     p_sys->p_lock = val.p_address;
 356
 357     var_Get( p_stream, SOUT_CFG_PREFIX_IN "id-offset", &val );
 358     p_sys->i_id_offset = val.i_int;
 359
 360     var_Get( p_stream, SOUT_CFG_PREFIX_IN "delay", &val );
 361     p_sys->i_delay = (mtime_t)val.i_int * 1000;
 362
 363     p_stream->pf_add    = AddIn;
 364     p_stream->pf_del    = DelIn;
 365     p_stream->pf_send   = SendIn;
 366
 367     p_stream->p_sys     = (sout_stream_sys_t *)p_sys;
 368
 369     /* update p_sout->i_out_pace_nocontrol */
 370     p_stream->p_sout->i_out_pace_nocontrol++;
 371
 372     return VLC_SUCCESS;
 373 }
 374
 375 /*****************************************************************************
 376  * CloseIn:
 377  *****************************************************************************/
 378 static void CloseIn( vlc_object_t * p_this )
 379 {
 380     sout_stream_t     *p_stream = (sout_stream_t*)p_this;
 381     in_sout_stream_sys_t *p_sys = (in_sout_stream_sys_t *)p_stream->p_sys;
 382
 383     sout_StreamDelete( p_sys->p_out );
 384     p_stream->p_sout->i_out_pace_nocontrol--;
 385
 386     free( p_sys );
 387 }
 388
 389 static sout_stream_id_t * AddIn( sout_stream_t *p_stream, es_format_t *p_fmt )
 390 {
 391     in_sout_stream_sys_t *p_sys = (in_sout_stream_sys_t *)p_stream->p_sys;
 392
 393     return p_sys->p_out->pf_add( p_sys->p_out, p_fmt );
 394 }
 395
 396 static int DelIn( sout_stream_t *p_stream, sout_stream_id_t *id )
 397 {
 398     in_sout_stream_sys_t *p_sys = (in_sout_stream_sys_t *)p_stream->p_sys;
 399
 400     return p_sys->p_out->pf_del( p_sys->p_out, id );
 401 }
 402
 403 static int SendIn( sout_stream_t *p_stream, sout_stream_id_t *id,
 404                    block_t *p_buffer )
 405 {
 406     in_sout_stream_sys_t *p_sys = (in_sout_stream_sys_t *)p_stream->p_sys;
 407     bridge_t *p_bridge;
 408     vlc_bool_t b_no_es = VLC_TRUE;
 409     int i;
 410
 411     /* First forward the packet for our own ES */
 412     p_sys->p_out->pf_send( p_sys->p_out, id, p_buffer );
 413
 414     /* Then check all bridged streams */
 415     vlc_mutex_lock( p_sys->p_lock );
 416
 417     p_bridge = GetBridge( p_stream );
 418     if ( p_bridge == NULL )
 419     {
 420         vlc_mutex_unlock( p_sys->p_lock );
 421         return VLC_SUCCESS;
 422     }
 423
 424     for ( i = 0; i < p_bridge->i_es_num; i++ )
 425     {
 426         if ( !p_bridge->pp_es[i]->b_empty )
 427             b_no_es = VLC_FALSE;
 428
 429         while ( p_bridge->pp_es[i]->p_block != NULL
 430                  && (p_bridge->pp_es[i]->p_block->i_dts + p_sys->i_delay
 431                        < mdate()
 432                       || p_bridge->pp_es[i]->p_block->i_dts + p_sys->i_delay
 433                           < p_bridge->pp_es[i]->i_last) )
 434         {
 435             block_t *p_block = p_bridge->pp_es[i]->p_block;
 436             msg_Dbg( p_stream, "dropping a packet (" I64Fd ")",
 437                      mdate() - p_block->i_dts - p_sys->i_delay );
 438             p_bridge->pp_es[i]->p_block
 439                 = p_bridge->pp_es[i]->p_block->p_next;
 440             block_Release( p_block );
 441         }
 442
 443         if ( p_bridge->pp_es[i]->p_block == NULL )
 444         {
 445             p_bridge->pp_es[i]->pp_last = &p_bridge->pp_es[i]->p_block;
 446         }
 447
 448         if ( p_bridge->pp_es[i]->b_changed )
 449         {
 450             if ( p_bridge->pp_es[i]->b_empty && p_bridge->pp_es[i]->id != NULL )
 451             {
 452                 p_sys->p_out->pf_del( p_sys->p_out, p_bridge->pp_es[i]->id );
 453             }
 454             else
 455             {
 456                 /* We need at least two packets to enter the mux. */
 457                 if ( p_bridge->pp_es[i]->p_block == NULL
 458                       || p_bridge->pp_es[i]->p_block->p_next == NULL )
 459                 {
 460                     continue;
 461                 }
 462
 463                 p_bridge->pp_es[i]->fmt.i_id += p_sys->i_id_offset;
 464                 p_bridge->pp_es[i]->id = p_sys->p_out->pf_add(
 465                             p_sys->p_out, &p_bridge->pp_es[i]->fmt );
 466                 if ( p_bridge->pp_es[i]->id == NULL )
 467                 {
 468                     msg_Warn( p_stream, "couldn't create chain for id %d",
 469                               p_bridge->pp_es[i]->fmt.i_id );
 470                 }
 471                 msg_Dbg( p_stream, "bridging in input codec=%4.4s id=%d pos=%d",
 472                          (char*)&p_bridge->pp_es[i]->fmt.i_codec,
 473                          p_bridge->pp_es[i]->fmt.i_id, i );
 474             }
 475         }
 476         p_bridge->pp_es[i]->b_changed = VLC_FALSE;
 477
 478         if ( p_bridge->pp_es[i]->b_empty )
 479             continue;
 480
 481         if ( p_bridge->pp_es[i]->p_block == NULL )
 482         {
 483             if ( p_bridge->pp_es[i]->id != NULL
 484                   && p_bridge->pp_es[i]->i_last < mdate() )
 485             {
 486                 p_sys->p_out->pf_del( p_sys->p_out, p_bridge->pp_es[i]->id );
 487                 p_bridge->pp_es[i]->fmt.i_id -= p_sys->i_id_offset;
 488                 p_bridge->pp_es[i]->b_changed = VLC_TRUE;
 489                 p_bridge->pp_es[i]->id = NULL;
 490             }
 491             continue;
 492         }
 493
 494         if ( p_bridge->pp_es[i]->id != NULL )
 495         {
 496             block_t *p_block = p_bridge->pp_es[i]->p_block;
 497             while ( p_block != NULL )
 498             {
 499                 p_bridge->pp_es[i]->i_last = p_block->i_dts;
 500                 p_block->i_pts += p_sys->i_delay;
 501                 p_block->i_dts += p_sys->i_delay;
 502                 p_block = p_block->p_next;
 503             }
 504             p_sys->p_out->pf_send( p_sys->p_out, p_bridge->pp_es[i]->id,
 505                                    p_bridge->pp_es[i]->p_block );
 506         }
 507         else
 508         {
 509             block_ChainRelease( p_bridge->pp_es[i]->p_block );
 510         }
 511
 512         p_bridge->pp_es[i]->p_block = NULL;
 513         p_bridge->pp_es[i]->pp_last = &p_bridge->pp_es[i]->p_block;
 514     }
 515
 516     if( b_no_es )
 517     {
 518         libvlc_t *p_libvlc = p_stream->p_libvlc;
 519         for ( i = 0; i < p_bridge->i_es_num; i++ )
 520             free( p_bridge->pp_es[i] );
 521         free( p_bridge->pp_es );
 522         free( p_bridge );
 523         var_Destroy( p_libvlc, "bridge-struct" );
 524     }
 525
 526     vlc_mutex_unlock( p_sys->p_lock );
 527
 528     return VLC_SUCCESS;
 529 }