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

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