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
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <sys/types.h>
  34 #include <sys/stat.h>
  35 #include <time.h>
  36 #include <fcntl.h>
  37 #include <errno.h>
  38
  39 #include <vlc_common.h>
  40 #include <vlc_plugin.h>
  41 #include <vlc_sout.h>
  42 #include <vlc_block.h>
  43 #include <vlc_charset.h>
  44 #include "vlc_strings.h"
  45
  46 #if defined( WIN32 ) && !defined( UNDER_CE )
  47 #   include <io.h>
  48 #   define lseek _lseeki64
  49 #else
  50 #   include <unistd.h>
  51 #endif
  52
  53 #ifndef O_LARGEFILE
  54 #   define O_LARGEFILE 0
  55 #endif
  56
  57 /*****************************************************************************
  58  * Module descriptor
  59  *****************************************************************************/
  60 static int  Open ( vlc_object_t * );
  61 static void Close( vlc_object_t * );
  62
  63 #define SOUT_CFG_PREFIX "sout-file-"
  64 #define APPEND_TEXT N_("Append to file")
  65 #define APPEND_LONGTEXT N_( "Append to file if it exists instead " \
  66                             "of replacing it.")
  67
  68 vlc_module_begin();
  69     set_description( N_("File stream output") );
  70     set_shortname( N_("File" ));
  71     set_capability( "sout access", 50 );
  72     set_category( CAT_SOUT );
  73     set_subcategory( SUBCAT_SOUT_ACO );
  74     add_shortcut( "file" );
  75     add_shortcut( "stream" );
  76     add_bool( SOUT_CFG_PREFIX "append", 0, NULL, APPEND_TEXT,APPEND_LONGTEXT,
  77               true );
  78     set_callbacks( Open, Close );
  79 vlc_module_end();
  80
  81
  82 /*****************************************************************************
  83  * Exported prototypes
  84  *****************************************************************************/
  85 static const char *const ppsz_sout_options[] = {
  86     "append", NULL
  87 };
  88
  89 static ssize_t Write( sout_access_out_t *, block_t * );
  90 static int Seek ( sout_access_out_t *, off_t  );
  91 static ssize_t Read ( sout_access_out_t *, block_t * );
  92 static int Control( sout_access_out_t *, int, va_list );
  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                 fd;
 106
 107     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 108
 109     if( !p_access->psz_path )
 110     {
 111         msg_Err( p_access, "no file name specified" );
 112         return VLC_EGENERIC;
 113     }
 114
 115     bool append = var_GetBool( p_access, SOUT_CFG_PREFIX "append" );
 116
 117     if( !strcmp( p_access->psz_path, "-" ) )
 118     {
 119 #ifdef WIN32
 120         setmode (fileno (stdout), O_BINARY);
 121 #endif
 122         fd = dup (fileno (stdout));
 123         msg_Dbg( p_access, "using stdout" );
 124     }
 125     else
 126     {
 127         char *psz_tmp = str_format( p_access, p_access->psz_path );
 128         path_sanitize( psz_tmp );
 129
 130         fd = utf8_open( psz_tmp, O_RDWR | O_CREAT | O_LARGEFILE |
 131                         (append ? 0 : O_TRUNC), 0666 );
 132         free( psz_tmp );
 133     }
 134
 135     if (fd == -1)
 136     {
 137         msg_Err( p_access, "cannot open `%s' (%m)", p_access->psz_path );
 138         return VLC_EGENERIC;
 139     }
 140
 141     p_access->pf_write = Write;
 142     p_access->pf_read  = Read;
 143     p_access->pf_seek  = Seek;
 144     p_access->pf_control = Control;
 145     p_access->p_sys    = (void *)(intptr_t)fd;
 146
 147     msg_Dbg( p_access, "file access output opened (%s)", p_access->psz_path );
 148     if (append)
 149         lseek (fd, 0, SEEK_END);
 150
 151     return VLC_SUCCESS;
 152 }
 153
 154 /*****************************************************************************
 155  * Close: close the target
 156  *****************************************************************************/
 157 static void Close( vlc_object_t * p_this )
 158 {
 159     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 160
 161     close( (intptr_t)p_access->p_sys );
 162
 163     msg_Dbg( p_access, "file access output closed" );
 164 }
 165
 166 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
 167 {
 168     switch( i_query )
 169     {
 170         case ACCESS_OUT_CONTROLS_PACE:
 171         {
 172             bool *pb = va_arg( args, bool * );
 173             *pb = strcmp( p_access->psz_access, "stream" );
 174             break;
 175         }
 176
 177         default:
 178             return VLC_EGENERIC;
 179     }
 180     return VLC_SUCCESS;
 181 }
 182
 183 /*****************************************************************************
 184  * Read: standard read on a file descriptor.
 185  *****************************************************************************/
 186 static ssize_t Read( sout_access_out_t *p_access, block_t *p_buffer )
 187 {
 188     ssize_t val;
 189
 190     do
 191         val = read( (intptr_t)p_access->p_sys, p_buffer->p_buffer,
 192                     p_buffer->i_buffer );
 193     while (val == -1 && errno == EINTR);
 194     return val;
 195 }
 196
 197 /*****************************************************************************
 198  * Write: standard write on a file descriptor.
 199  *****************************************************************************/
 200 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
 201 {
 202     size_t i_write = 0;
 203
 204     while( p_buffer )
 205     {
 206         ssize_t val = write ((intptr_t)p_access->p_sys,
 207                              p_buffer->p_buffer, p_buffer->i_buffer);
 208         if (val == -1)
 209         {
 210             if (errno == EINTR)
 211                 continue;
 212             block_ChainRelease (p_buffer);
 213             return -1;
 214         }
 215
 216         if ((size_t)val >= p_buffer->i_buffer)
 217         {
 218             block_t *p_next = p_buffer->p_next;
 219             block_Release (p_buffer);
 220             p_buffer = p_next;
 221         }
 222         else
 223         {
 224             p_buffer->p_buffer += val;
 225             p_buffer->i_buffer -= val;
 226         }
 227         i_write += val;
 228     }
 229     return i_write;
 230 }
 231
 232 /*****************************************************************************
 233  * Seek: seek to a specific location in a file
 234  *****************************************************************************/
 235 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 236 {
 237     return lseek( (intptr_t)p_access->p_sys, i_pos, SEEK_SET );
 238 }