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 <time.h>
  35 #include <fcntl.h>
  36 #include <errno.h>
  37
  38 #include <vlc_common.h>
  39 #include <vlc_plugin.h>
  40 #include <vlc_sout.h>
  41 #include <vlc_block.h>
  42 #include <vlc_fs.h>
  43 #include <vlc_strings.h>
  44
  45 #if defined( WIN32 ) && !defined( UNDER_CE )
  46 #   include <io.h>
  47 #   define lseek _lseeki64
  48 #elif defined( __OS2__ )
  49 #   include <io.h>
  50 #else
  51 #   include <unistd.h>
  52 #endif
  53
  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 #define SYNC_TEXT N_("Synchronous writing")
  69 #define SYNC_LONGTEXT N_( "Open the file with synchronous writing.")
  70
  71 vlc_module_begin ()
  72     set_description( N_("File stream output") )
  73     set_shortname( N_("File" ))
  74     set_capability( "sout access", 50 )
  75     set_category( CAT_SOUT )
  76     set_subcategory( SUBCAT_SOUT_ACO )
  77     add_shortcut( "file", "stream", "fd" )
  78     add_bool( SOUT_CFG_PREFIX "append", false, APPEND_TEXT,APPEND_LONGTEXT,
  79               true )
  80 #ifdef O_SYNC
  81     add_bool( SOUT_CFG_PREFIX "sync", false, SYNC_TEXT,SYNC_LONGTEXT,
  82               false )
  83 #endif
  84     set_callbacks( Open, Close )
  85 vlc_module_end ()
  86
  87
  88 /*****************************************************************************
  89  * Exported prototypes
  90  *****************************************************************************/
  91 static const char *const ppsz_sout_options[] = {
  92     "append",
  93 #ifdef O_SYNC
  94     "sync",
  95 #endif
  96     NULL
  97 };
  98
  99 static ssize_t Write( sout_access_out_t *, block_t * );
 100 static int Seek ( sout_access_out_t *, off_t  );
 101 static ssize_t Read ( sout_access_out_t *, block_t * );
 102 static int Control( sout_access_out_t *, int, va_list );
 103
 104 /*****************************************************************************
 105  * Open: open the file
 106  *****************************************************************************/
 107 static int Open( vlc_object_t *p_this )
 108 {
 109     sout_access_out_t   *p_access = (sout_access_out_t*)p_this;
 110     int                 fd;
 111
 112     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 113
 114     if( !p_access->psz_path )
 115     {
 116         msg_Err( p_access, "no file name specified" );
 117         return VLC_EGENERIC;
 118     }
 119
 120     bool append = var_GetBool( p_access, SOUT_CFG_PREFIX "append" );
 121
 122     if (!strcmp (p_access->psz_access, "fd"))
 123     {
 124         char *end;
 125
 126         fd = strtol (p_access->psz_path, &end, 0);
 127         if (!*p_access->psz_path || *end)
 128         {
 129             msg_Err (p_access, "invalid file descriptor: %s",
 130                      p_access->psz_path);
 131             return VLC_EGENERIC;
 132         }
 133         fd = vlc_dup (fd);
 134         if (fd == -1)
 135         {
 136             msg_Err (p_access, "cannot use file descriptor: %m");
 137             return VLC_EGENERIC;
 138         }
 139     }
 140 #ifndef UNDER_CE
 141     else
 142     if( !strcmp( p_access->psz_path, "-" ) )
 143     {
 144 #if defined( WIN32 ) || defined( __OS2__ )
 145         setmode (fileno (stdout), O_BINARY);
 146 #endif
 147         fd = vlc_dup (fileno (stdout));
 148         if (fd == -1)
 149         {
 150             msg_Err (p_access, "cannot use standard output: %m");
 151             return VLC_EGENERIC;
 152         }
 153         msg_Dbg( p_access, "using stdout" );
 154     }
 155 #endif
 156     else
 157     {
 158         char *psz_tmp = str_format( p_access, p_access->psz_path );
 159         path_sanitize( psz_tmp );
 160
 161         fd = vlc_open( psz_tmp, O_RDWR | O_CREAT | O_LARGEFILE |
 162 #ifdef O_SYNC
 163                 (var_GetBool( p_access, SOUT_CFG_PREFIX "sync" ) ? O_SYNC : 0) |
 164 #endif
 165                 (append ? 0 : O_TRUNC), 0666 );
 166         free( psz_tmp );
 167         if (fd == -1)
 168         {
 169             msg_Err (p_access, "cannot create %s: %m", p_access->psz_path);
 170             return VLC_EGENERIC;
 171         }
 172     }
 173
 174     p_access->pf_write = Write;
 175     p_access->pf_read  = Read;
 176     p_access->pf_seek  = Seek;
 177     p_access->pf_control = Control;
 178     p_access->p_sys    = (void *)(intptr_t)fd;
 179
 180     msg_Dbg( p_access, "file access output opened (%s)", p_access->psz_path );
 181     if (append)
 182         lseek (fd, 0, SEEK_END);
 183
 184     return VLC_SUCCESS;
 185 }
 186
 187 /*****************************************************************************
 188  * Close: close the target
 189  *****************************************************************************/
 190 static void Close( vlc_object_t * p_this )
 191 {
 192     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 193
 194     close( (intptr_t)p_access->p_sys );
 195
 196     msg_Dbg( p_access, "file access output closed" );
 197 }
 198
 199 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
 200 {
 201     switch( i_query )
 202     {
 203         case ACCESS_OUT_CONTROLS_PACE:
 204         {
 205             bool *pb = va_arg( args, bool * );
 206             *pb = strcmp( p_access->psz_access, "stream" );
 207             break;
 208         }
 209
 210         default:
 211             return VLC_EGENERIC;
 212     }
 213     return VLC_SUCCESS;
 214 }
 215
 216 /*****************************************************************************
 217  * Read: standard read on a file descriptor.
 218  *****************************************************************************/
 219 static ssize_t Read( sout_access_out_t *p_access, block_t *p_buffer )
 220 {
 221     ssize_t val;
 222
 223     do
 224         val = read( (intptr_t)p_access->p_sys, p_buffer->p_buffer,
 225                     p_buffer->i_buffer );
 226     while (val == -1 && errno == EINTR);
 227     return val;
 228 }
 229
 230 /*****************************************************************************
 231  * Write: standard write on a file descriptor.
 232  *****************************************************************************/
 233 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
 234 {
 235     size_t i_write = 0;
 236
 237     while( p_buffer )
 238     {
 239         ssize_t val = write ((intptr_t)p_access->p_sys,
 240                              p_buffer->p_buffer, p_buffer->i_buffer);
 241         if (val == -1)
 242         {
 243             if (errno == EINTR)
 244                 continue;
 245             block_ChainRelease (p_buffer);
 246             return -1;
 247         }
 248
 249         if ((size_t)val >= p_buffer->i_buffer)
 250         {
 251             block_t *p_next = p_buffer->p_next;
 252             block_Release (p_buffer);
 253             p_buffer = p_next;
 254         }
 255         else
 256         {
 257             p_buffer->p_buffer += val;
 258             p_buffer->i_buffer -= val;
 259         }
 260         i_write += val;
 261     }
 262     return i_write;
 263 }
 264
 265 /*****************************************************************************
 266  * Seek: seek to a specific location in a file
 267  *****************************************************************************/
 268 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 269 {
 270     return lseek( (intptr_t)p_access->p_sys, i_pos, SEEK_SET );
 271 }