git.sesse.net Git - vlc/blob - modules/access/fake.c

   1 /*****************************************************************************
   2  * fake.c : Fake video input for VLC
   3  *****************************************************************************
   4  * Copyright (C) 2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Author: 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., 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_access.h>
  35 #include <vlc_demux.h>
  36 #include <vlc_image.h>
  37
  38 /*****************************************************************************
  39  * Module descriptior
  40  *****************************************************************************/
  41 static int  Open ( vlc_object_t * );
  42 static void Close( vlc_object_t * );
  43
  44 #define CACHING_TEXT N_("Caching value in ms")
  45 #define CACHING_LONGTEXT N_( \
  46     "Caching value for fake streams. This " \
  47     "value should be set in milliseconds." )
  48 #define FPS_TEXT N_("Framerate")
  49 #define FPS_LONGTEXT N_( \
  50     "Number of frames per second (eg. 24, 25, 29.97, 30).")
  51 #define ID_TEXT N_("ID")
  52 #define ID_LONGTEXT N_( \
  53     "Set the ID of the fake elementary stream for use in " \
  54     "#duplicate{} constructs (default 0).")
  55 #define DURATION_TEXT N_("Duration in ms")
  56 #define DURATION_LONGTEXT N_( \
  57     "Duration of the fake streaming before faking an " \
  58     "end-of-file (default is -1 meaning that the stream is unlimited when " \
  59     "fake is forced, or lasts for 10 seconds otherwise. 0, means that the " \
  60     "stream is unlimited).")
  61
  62 vlc_module_begin ()
  63     set_shortname( N_("Fake") )
  64     set_description( N_("Fake input") )
  65     set_category( CAT_INPUT )
  66     set_subcategory( SUBCAT_INPUT_ACCESS )
  67
  68     add_integer( "fake-caching", DEFAULT_PTS_DELAY / 1000, NULL,
  69                  CACHING_TEXT, CACHING_LONGTEXT, true );
  70     add_float( "fake-fps", 25.0, NULL, FPS_TEXT, FPS_LONGTEXT, true )
  71     add_integer( "fake-id", 0, NULL, ID_TEXT, ID_LONGTEXT, true )
  72     add_integer( "fake-duration", -1, NULL, DURATION_TEXT, DURATION_LONGTEXT,
  73                  true );
  74
  75     add_shortcut( "fake" )
  76     set_capability( "access_demux", 10 )
  77     set_callbacks( Open, Close )
  78 vlc_module_end ()
  79
  80 /*****************************************************************************
  81  * Access: local prototypes
  82  *****************************************************************************/
  83 static int Demux  ( demux_t * );
  84 static int Control( demux_t *, int, va_list );
  85
  86 struct demux_sys_t
  87 {
  88     float f_fps;
  89     mtime_t i_last_pts, i_duration, i_first_pts, i_end_pts, i_pause_pts;
  90
  91     es_out_id_t  *p_es_video;
  92 };
  93
  94 /*****************************************************************************
  95  * Open: opens fake device
  96  *****************************************************************************/
  97 static int Open( vlc_object_t *p_this )
  98 {
  99     demux_t     *p_demux = (demux_t*)p_this;
 100     demux_sys_t *p_sys;
 101     es_format_t fmt;
 102
 103     if( *p_demux->psz_access != '\0' )
 104     {
 105         /* if an access is provided, then it has to be "fake" */
 106         if( strcmp( p_demux->psz_access, "fake" ) )
 107             return VLC_EGENERIC;
 108
 109         msg_Dbg( p_demux, "fake:// access_demux detected" );
 110     }
 111     else
 112     {
 113        /**
 114         * access is not provided,
 115         * then let's see if path could be an image
 116         **/
 117
 118         if( !p_demux->psz_path || !*p_demux->psz_path )
 119             return VLC_EGENERIC;
 120
 121         vlc_fourcc_t i_codec = image_Ext2Fourcc( p_demux->psz_path );
 122         if( !i_codec )
 123             return VLC_EGENERIC;
 124         msg_Dbg( p_demux, "still image detected with codec format %4.4s",
 125                  (const char*)&i_codec );
 126     }
 127
 128     if( p_demux->psz_path && *p_demux->psz_path )
 129     {
 130         /* set up fake-file on the fly */
 131         var_Create( p_demux->p_parent, "fake-file", VLC_VAR_STRING );
 132         var_SetString( p_demux->p_parent, "fake-file", p_demux->psz_path );
 133     }
 134
 135     /* Set up p_demux */
 136     DEMUX_INIT_COMMON(); p_sys = p_demux->p_sys;
 137     p_demux->info.i_update = 0;
 138     p_demux->info.i_title = 0;
 139     p_demux->info.i_seekpoint = 0;
 140
 141     p_sys->i_duration =
 142         (mtime_t)var_CreateGetInteger( p_demux, "fake-duration" ) * 1000;
 143     if( p_sys->i_duration < 0 )
 144     {
 145         if( !strcmp( p_demux->psz_access, "fake" ) )
 146             p_sys->i_duration = 0;
 147         else
 148             p_sys->i_duration = 10000*1000;
 149     }
 150     p_sys->f_fps = var_CreateGetFloat( p_demux, "fake-fps" );
 151
 152     /* Declare the elementary stream */
 153     es_format_Init( &fmt, VIDEO_ES, VLC_FOURCC('f','a','k','e') );
 154     fmt.i_id = var_CreateGetInteger( p_demux, "fake-id" );
 155     p_sys->p_es_video = es_out_Add( p_demux->out, &fmt );
 156
 157     /* Update default_pts to a suitable value for access */
 158     var_Create( p_demux, "fake-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 159
 160     return VLC_SUCCESS;
 161 }
 162
 163 /*****************************************************************************
 164  * Close: close device, free resources
 165  *****************************************************************************/
 166 static void Close( vlc_object_t *p_this )
 167 {
 168     demux_t     *p_demux = (demux_t *)p_this;
 169     demux_sys_t *p_sys   = p_demux->p_sys;
 170
 171     free( p_sys );
 172 }
 173
 174 /*****************************************************************************
 175  * Control:
 176  *****************************************************************************/
 177 static int Control( demux_t *p_demux, int i_query, va_list args )
 178 {
 179     demux_sys_t *p_sys = p_demux->p_sys;
 180     bool *pb, b;
 181     int64_t    *pi64, i64;
 182     double     *pf, f;
 183
 184     switch( i_query )
 185     {
 186         /* Special for access_demux */
 187         case DEMUX_CAN_PAUSE:
 188         case DEMUX_CAN_SEEK:
 189         case DEMUX_CAN_CONTROL_PACE:
 190             pb = (bool *)va_arg( args, bool * );
 191             *pb = true;
 192             return VLC_SUCCESS;
 193
 194         case DEMUX_SET_PAUSE_STATE:
 195             b = (bool)va_arg( args, int );
 196             if ( b )
 197             {
 198                 p_sys->i_pause_pts = mdate();
 199             }
 200             else if ( p_sys->i_pause_pts )
 201             {
 202                 mtime_t i_pause_duration = mdate() - p_sys->i_pause_pts;
 203                 p_sys->i_first_pts += i_pause_duration;
 204                 p_sys->i_last_pts += i_pause_duration;
 205                 if ( p_sys->i_duration )
 206                     p_sys->i_end_pts += i_pause_duration;
 207                 p_sys->i_pause_pts = 0;
 208             }
 209             return VLC_SUCCESS;
 210
 211         case DEMUX_GET_PTS_DELAY:
 212             pi64 = (int64_t *)va_arg( args, int64_t * );
 213             *pi64 = (int64_t)var_GetInteger( p_demux, "fake-caching" ) * 1000;
 214             return VLC_SUCCESS;
 215
 216         case DEMUX_GET_POSITION:
 217             if( p_sys->i_duration <= 0 )
 218                 return VLC_EGENERIC;
 219             pf = (double*)va_arg( args, double* );
 220             *pf = (double)( p_sys->i_last_pts - p_sys->i_first_pts )
 221                             / (double)(p_sys->i_duration);
 222             return VLC_SUCCESS;
 223
 224         case DEMUX_SET_POSITION:
 225             if( p_sys->i_duration <= 0 )
 226                 return VLC_EGENERIC;
 227             f = (double)va_arg( args, double );
 228             i64 = f * (double)p_sys->i_duration;
 229             p_sys->i_first_pts = p_sys->i_last_pts - i64;
 230             p_sys->i_end_pts = p_sys->i_first_pts + p_sys->i_duration;
 231             return VLC_SUCCESS;
 232
 233         case DEMUX_GET_TIME:
 234             pi64 = (int64_t *)va_arg( args, int64_t * );
 235             *pi64 = p_sys->i_last_pts - p_sys->i_first_pts;
 236             return VLC_SUCCESS;
 237
 238         case DEMUX_GET_LENGTH:
 239             if( p_sys->i_duration <= 0 )
 240                 return VLC_EGENERIC;
 241             pi64 = (int64_t*)va_arg( args, int64_t * );
 242             *pi64 = p_sys->i_duration;
 243             return VLC_SUCCESS;
 244
 245         case DEMUX_SET_TIME:
 246             i64 = (int64_t)va_arg( args, int64_t );
 247             p_sys->i_first_pts = p_sys->i_last_pts - i64;
 248             p_sys->i_end_pts = p_sys->i_first_pts + p_sys->i_duration;
 249             return VLC_SUCCESS;
 250
 251         /* TODO implement others */
 252         default:
 253             return VLC_EGENERIC;
 254     }
 255
 256     return VLC_EGENERIC;
 257 }
 258
 259 /*****************************************************************************
 260  * Demux:
 261  *****************************************************************************/
 262 static int Demux( demux_t *p_demux )
 263 {
 264     demux_sys_t *p_sys = p_demux->p_sys;
 265
 266     if ( !p_sys->i_last_pts )
 267     {
 268         p_sys->i_last_pts = p_sys->i_first_pts = mdate();
 269         if ( p_sys->i_duration )
 270             p_sys->i_end_pts = p_sys->i_first_pts + p_sys->i_duration;
 271     }
 272     else
 273     {
 274         p_sys->i_last_pts += (mtime_t)(1000000.0 / p_sys->f_fps);
 275         if ( p_sys->i_duration && p_sys->i_last_pts > p_sys->i_end_pts )
 276             return 0;
 277         mwait( p_sys->i_last_pts );
 278     }
 279
 280     block_t *p_block = block_New( p_demux, 1 );
 281     p_block->i_flags |= BLOCK_FLAG_TYPE_I;
 282     p_block->i_dts = p_block->i_pts = p_sys->i_last_pts;
 283
 284     es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
 285     es_out_Send( p_demux->out, p_sys->p_es_video, p_block );
 286
 287     return 1;
 288 }