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
  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 #else
  49 #   include <unistd.h>
  50 #endif
  51
  52 #ifndef O_LARGEFILE
  53 #   define O_LARGEFILE 0
  54 #endif
  55
  56 /*****************************************************************************
  57  * Module descriptor
  58  *****************************************************************************/
  59 static int  Open ( vlc_object_t * );
  60 static void Close( vlc_object_t * );
  61
  62 #define SOUT_CFG_PREFIX "sout-file-"
  63 #define APPEND_TEXT N_("Append to file")
  64 #define APPEND_LONGTEXT N_( "Append to file if it exists instead " \
  65                             "of replacing it.")
  66 #define SYNC_TEXT N_("Synchronous writing")
  67 #define SYNC_LONGTEXT N_( "Open the file with synchronous writing.")
  68
  69 vlc_module_begin ()
  70     set_description( N_("File stream output") )
  71     set_shortname( N_("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", false, NULL, APPEND_TEXT,APPEND_LONGTEXT,
  78               true )
  79     add_bool( SOUT_CFG_PREFIX "sync", false, NULL, SYNC_TEXT,SYNC_LONGTEXT,
  80               false )
  81     set_callbacks( Open, Close )
  82 vlc_module_end ()
  83
  84
  85 /*****************************************************************************
  86  * Exported prototypes
  87  *****************************************************************************/
  88 static const char *const ppsz_sout_options[] = {
  89     "append", "sync", NULL
  90 };
  91
  92 static ssize_t Write( sout_access_out_t *, block_t * );
  93 static int Seek ( sout_access_out_t *, off_t  );
  94 static ssize_t Read ( sout_access_out_t *, block_t * );
  95 static int Control( sout_access_out_t *, int, va_list );
  96
  97 struct sout_access_out_sys_t
  98 {
  99     int i_handle;
 100 };
 101
 102 /*****************************************************************************
 103  * Open: open the file
 104  *****************************************************************************/
 105 static int Open( vlc_object_t *p_this )
 106 {
 107     sout_access_out_t   *p_access = (sout_access_out_t*)p_this;
 108     int                 fd;
 109     bool                sync;
 110
 111     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 112
 113     if( !p_access->psz_path )
 114     {
 115         msg_Err( p_access, "no file name specified" );
 116         return VLC_EGENERIC;
 117     }
 118
 119     bool append = var_GetBool( p_access, SOUT_CFG_PREFIX "append" );
 120     sync = var_GetBool( p_access, SOUT_CFG_PREFIX "sync" );
 121
 122     if( !strcmp( p_access->psz_path, "-" ) )
 123     {
 124 #ifndef UNDER_CE
 125 #ifdef WIN32
 126         setmode (fileno (stdout), O_BINARY);
 127 #endif
 128         fd = vlc_dup (fileno (stdout));
 129         msg_Dbg( p_access, "using stdout" );
 130 #else
 131 #warning stdout is not supported on Windows Mobile, but may be used on Windows CE
 132         fd = -1;
 133 #endif
 134     }
 135     else
 136     {
 137         char *psz_tmp = str_format( p_access, p_access->psz_path );
 138         path_sanitize( psz_tmp );
 139
 140         fd = vlc_open( psz_tmp, O_RDWR | O_CREAT | O_LARGEFILE |
 141 #ifdef O_SYNC
 142                         (sync ? O_SYNC : 0) |
 143 #endif
 144                         (append ? 0 : O_TRUNC), 0666 );
 145         free( psz_tmp );
 146     }
 147
 148     if (fd == -1)
 149     {
 150         msg_Err( p_access, "cannot open `%s' (%m)", p_access->psz_path );
 151         return VLC_EGENERIC;
 152     }
 153
 154     p_access->pf_write = Write;
 155     p_access->pf_read  = Read;
 156     p_access->pf_seek  = Seek;
 157     p_access->pf_control = Control;
 158     p_access->p_sys    = (void *)(intptr_t)fd;
 159
 160     msg_Dbg( p_access, "file access output opened (%s)", p_access->psz_path );
 161     if (append)
 162         lseek (fd, 0, SEEK_END);
 163
 164     return VLC_SUCCESS;
 165 }
 166
 167 /*****************************************************************************
 168  * Close: close the target
 169  *****************************************************************************/
 170 static void Close( vlc_object_t * p_this )
 171 {
 172     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 173
 174     close( (intptr_t)p_access->p_sys );
 175
 176     msg_Dbg( p_access, "file access output closed" );
 177 }
 178
 179 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
 180 {
 181     switch( i_query )
 182     {
 183         case ACCESS_OUT_CONTROLS_PACE:
 184         {
 185             bool *pb = va_arg( args, bool * );
 186             *pb = strcmp( p_access->psz_access, "stream" );
 187             break;
 188         }
 189
 190         default:
 191             return VLC_EGENERIC;
 192     }
 193     return VLC_SUCCESS;
 194 }
 195
 196 /*****************************************************************************
 197  * Read: standard read on a file descriptor.
 198  *****************************************************************************/
 199 static ssize_t Read( sout_access_out_t *p_access, block_t *p_buffer )
 200 {
 201     ssize_t val;
 202
 203     do
 204         val = read( (intptr_t)p_access->p_sys, p_buffer->p_buffer,
 205                     p_buffer->i_buffer );
 206     while (val == -1 && errno == EINTR);
 207     return val;
 208 }
 209
 210 /*****************************************************************************
 211  * Write: standard write on a file descriptor.
 212  *****************************************************************************/
 213 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
 214 {
 215     size_t i_write = 0;
 216
 217     while( p_buffer )
 218     {
 219         ssize_t val = write ((intptr_t)p_access->p_sys,
 220                              p_buffer->p_buffer, p_buffer->i_buffer);
 221         if (val == -1)
 222         {
 223             if (errno == EINTR)
 224                 continue;
 225             block_ChainRelease (p_buffer);
 226             return -1;
 227         }
 228
 229         if ((size_t)val >= p_buffer->i_buffer)
 230         {
 231             block_t *p_next = p_buffer->p_next;
 232             block_Release (p_buffer);
 233             p_buffer = p_next;
 234         }
 235         else
 236         {
 237             p_buffer->p_buffer += val;
 238             p_buffer->i_buffer -= val;
 239         }
 240         i_write += val;
 241     }
 242     return i_write;
 243 }
 244
 245 /*****************************************************************************
 246  * Seek: seek to a specific location in a file
 247  *****************************************************************************/
 248 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 249 {
 250     return lseek( (intptr_t)p_access->p_sys, i_pos, SEEK_SET );
 251 }