git.sesse.net Git - vlc/blob - modules/access_output/file.c

   1 /*****************************************************************************
   2  * file.c
   3  *****************************************************************************
   4  * Copyright (C) 2001, 2002 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *          Eric Petit <titer@videolan.org>
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include <stdlib.h>
  29 #include <sys/types.h>
  30 #include <sys/stat.h>
  31 #include <string.h>
  32 #include <fcntl.h>
  33 #include <errno.h>
  34
  35 #include <vlc/vlc.h>
  36 #include <vlc/sout.h>
  37
  38 #ifdef HAVE_UNISTD_H
  39 #   include <unistd.h>
  40 #elif defined( WIN32 ) && !defined( UNDER_CE )
  41 #   include <io.h>
  42 #endif
  43
  44 /* For those platforms that don't use these */
  45 #ifndef S_IRGRP
  46 #   define S_IRGRP 0
  47 #endif
  48 #ifndef S_IROTH
  49 #   define S_IROTH 0
  50 #endif
  51 #ifndef STDOUT_FILENO
  52 #   define STDOUT_FILENO 1
  53 #endif
  54
  55 /*****************************************************************************
  56  * Module descriptor
  57  *****************************************************************************/
  58 static int  Open ( vlc_object_t * );
  59 static void Close( vlc_object_t * );
  60
  61 #define SOUT_CFG_PREFIX "sout-file-"
  62 #define APPEND_TEXT N_("Append to file")
  63 #define APPEND_LONGTEXT N_( "Append to file if it exists instead " \
  64                             "of replacing it.")
  65
  66 vlc_module_begin();
  67     set_description( _("File stream output") );
  68     set_capability( "sout access", 50 );
  69     add_shortcut( "file" );
  70     add_shortcut( "stream" );
  71     add_bool( SOUT_CFG_PREFIX "append", 0, NULL, APPEND_TEXT,APPEND_LONGTEXT,
  72               VLC_TRUE );
  73     set_callbacks( Open, Close );
  74 vlc_module_end();
  75
  76
  77 /*****************************************************************************
  78  * Exported prototypes
  79  *****************************************************************************/
  80 static const char *ppsz_sout_options[] = {
  81     "append", NULL
  82 };
  83
  84 static int Write( sout_access_out_t *, block_t * );
  85 static int Seek ( sout_access_out_t *, off_t  );
  86 static int Read ( sout_access_out_t *, block_t * );
  87
  88 struct sout_access_out_sys_t
  89 {
  90     int i_handle;
  91 };
  92
  93 /*****************************************************************************
  94  * Open: open the file
  95  *****************************************************************************/
  96 static int Open( vlc_object_t *p_this )
  97 {
  98     sout_access_out_t   *p_access = (sout_access_out_t*)p_this;
  99     int                 i_flags;
 100     vlc_value_t         val;
 101
 102     sout_CfgParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 103
 104     if( !( p_access->p_sys = malloc( sizeof( sout_access_out_sys_t ) ) ) )
 105     {
 106         msg_Err( p_access, "out of memory" );
 107         return( VLC_EGENERIC );
 108     }
 109
 110     if( !p_access->psz_name )
 111     {
 112         msg_Err( p_access, "no file name specified" );
 113         return VLC_EGENERIC;
 114     }
 115     i_flags = O_RDWR|O_CREAT;
 116
 117     var_Get( p_access, SOUT_CFG_PREFIX "append", &val );
 118     if( val.b_bool )
 119     {
 120         i_flags |= O_APPEND;
 121     }
 122     else
 123     {
 124         i_flags |= O_TRUNC;
 125     }
 126     if( !strcmp( p_access->psz_name, "-" ) )
 127     {
 128         p_access->p_sys->i_handle = STDOUT_FILENO;
 129         msg_Dbg( p_access, "using stdout" );
 130     }
 131     else if( ( p_access->p_sys->i_handle =
 132                open( p_access->psz_name, i_flags,
 133                      S_IWRITE | S_IREAD | S_IRGRP | S_IROTH ) ) == -1 )
 134     {
 135         msg_Err( p_access, "cannot open `%s'", p_access->psz_name );
 136         free( p_access->p_sys );
 137         return( VLC_EGENERIC );
 138     }
 139
 140     p_access->pf_write = Write;
 141     p_access->pf_read  = Read;
 142     p_access->pf_seek  = Seek;
 143
 144     msg_Dbg( p_access, "file access output opened (`%s')", p_access->psz_name );
 145
 146     /* Update pace control flag */
 147     if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
 148         p_access->p_sout->i_out_pace_nocontrol++;
 149
 150     return VLC_SUCCESS;
 151 }
 152
 153 /*****************************************************************************
 154  * Close: close the target
 155  *****************************************************************************/
 156 static void Close( vlc_object_t * p_this )
 157 {
 158     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 159
 160     if( strcmp( p_access->psz_name, "-" ) )
 161     {
 162         if( p_access->p_sys->i_handle )
 163         {
 164             close( p_access->p_sys->i_handle );
 165         }
 166     }
 167     free( p_access->p_sys );
 168
 169     /* Update pace control flag */
 170     if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
 171         p_access->p_sout->i_out_pace_nocontrol--;
 172
 173     msg_Dbg( p_access, "file access output closed" );
 174 }
 175
 176 /*****************************************************************************
 177  * Read: standard read on a file descriptor.
 178  *****************************************************************************/
 179 static int Read( sout_access_out_t *p_access, block_t *p_buffer )
 180 {
 181     if( strcmp( p_access->psz_name, "-" ) )
 182     {
 183         return read( p_access->p_sys->i_handle, p_buffer->p_buffer,
 184                      p_buffer->i_buffer );
 185     }
 186
 187     msg_Err( p_access, "cannot read while using stdout" );
 188     return VLC_EGENERIC;
 189 }
 190
 191 /*****************************************************************************
 192  * Write: standard write on a file descriptor.
 193  *****************************************************************************/
 194 static int Write( sout_access_out_t *p_access, block_t *p_buffer )
 195 {
 196     size_t i_write = 0;
 197
 198     while( p_buffer )
 199     {
 200         block_t *p_next = p_buffer->p_next;;
 201
 202         i_write += write( p_access->p_sys->i_handle,
 203                           p_buffer->p_buffer, p_buffer->i_buffer );
 204         block_Release( p_buffer );
 205
 206         p_buffer = p_next;
 207     }
 208
 209     return i_write;
 210 }
 211
 212 /*****************************************************************************
 213  * Seek: seek to a specific location in a file
 214  *****************************************************************************/
 215 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 216 {
 217     if( strcmp( p_access->psz_name, "-" ) )
 218     {
 219 #if defined( WIN32 ) && !defined( UNDER_CE )
 220         return( _lseeki64( p_access->p_sys->i_handle, i_pos, SEEK_SET ) );
 221 #else
 222         return( lseek( p_access->p_sys->i_handle, i_pos, SEEK_SET ) );
 223 #endif
 224     }
 225     else
 226     {
 227         msg_Err( p_access, "cannot seek while using stdout" );
 228         return VLC_EGENERIC;
 229     }
 230 }