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_common.h>
  39 #include <vlc_plugin.h>
  40 #include <vlc_sout.h>
  41 #include <vlc_block.h>
  42 #include <vlc_charset.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
  67 vlc_module_begin();
  68     set_description( N_("File stream output") );
  69     set_shortname( N_("File" ));
  70     set_capability( "sout access", 50 );
  71     set_category( CAT_SOUT );
  72     set_subcategory( SUBCAT_SOUT_ACO );
  73     add_shortcut( "file" );
  74     add_shortcut( "stream" );
  75     add_bool( SOUT_CFG_PREFIX "append", 0, NULL, APPEND_TEXT,APPEND_LONGTEXT,
  76               true );
  77     set_callbacks( Open, Close );
  78 vlc_module_end();
  79
  80
  81 /*****************************************************************************
  82  * Exported prototypes
  83  *****************************************************************************/
  84 static const char *const ppsz_sout_options[] = {
  85     "append", NULL
  86 };
  87
  88 static ssize_t Write( sout_access_out_t *, block_t * );
  89 static int Seek ( sout_access_out_t *, off_t  );
  90 static ssize_t Read ( sout_access_out_t *, block_t * );
  91
  92 struct sout_access_out_sys_t
  93 {
  94     int i_handle;
  95 };
  96
  97 /*****************************************************************************
  98  * Open: open the file
  99  *****************************************************************************/
 100 static int Open( vlc_object_t *p_this )
 101 {
 102     sout_access_out_t   *p_access = (sout_access_out_t*)p_this;
 103     int                 fd;
 104
 105     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 106
 107     if( !p_access->psz_path )
 108     {
 109         msg_Err( p_access, "no file name specified" );
 110         return VLC_EGENERIC;
 111     }
 112
 113     bool append = var_GetBool( p_access, SOUT_CFG_PREFIX "append" );
 114
 115     if( !strcmp( p_access->psz_path, "-" ) )
 116     {
 117 #ifdef WIN32
 118         setmode (fileno (stdout), O_BINARY);
 119 #endif
 120         fd = dup (fileno (stdout));
 121         msg_Dbg( p_access, "using stdout" );
 122     }
 123     else
 124     {
 125         char *psz_tmp = str_format( p_access, p_access->psz_path );
 126         path_sanitize( psz_tmp );
 127
 128         fd = utf8_open( psz_tmp, O_RDWR | O_CREAT | O_LARGEFILE |
 129                         (append ? 0 : O_TRUNC), 0666 );
 130         free( psz_tmp );
 131     }
 132
 133     if (fd == -1)
 134     {
 135         msg_Err( p_access, "cannot open `%s' (%m)", p_access->psz_path );
 136         return VLC_EGENERIC;
 137     }
 138
 139     p_access->pf_write = Write;
 140     p_access->pf_read  = Read;
 141     p_access->pf_seek  = Seek;
 142     p_access->p_sys    = (void *)(intptr_t)fd;
 143
 144     msg_Dbg( p_access, "file access output opened (%s)", p_access->psz_path );
 145     if (append)
 146         lseek (fd, 0, SEEK_END);
 147
 148     /* Update pace control flag */
 149     if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
 150         p_access->p_sout->i_out_pace_nocontrol++;
 151
 152     return VLC_SUCCESS;
 153 }
 154
 155 /*****************************************************************************
 156  * Close: close the target
 157  *****************************************************************************/
 158 static void Close( vlc_object_t * p_this )
 159 {
 160     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 161
 162     close( (intptr_t)p_access->p_sys );
 163
 164     /* Update pace control flag */
 165     if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
 166         p_access->p_sout->i_out_pace_nocontrol--;
 167
 168     msg_Dbg( p_access, "file access output closed" );
 169 }
 170
 171 /*****************************************************************************
 172  * Read: standard read on a file descriptor.
 173  *****************************************************************************/
 174 static ssize_t Read( sout_access_out_t *p_access, block_t *p_buffer )
 175 {
 176     return read( (intptr_t)p_access->p_sys, p_buffer->p_buffer,
 177                  p_buffer->i_buffer );
 178 }
 179
 180 /*****************************************************************************
 181  * Write: standard write on a file descriptor.
 182  *****************************************************************************/
 183 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
 184 {
 185     size_t i_write = 0;
 186
 187     while( p_buffer )
 188     {
 189         block_t *p_next = p_buffer->p_next;;
 190
 191         i_write += write( (intptr_t)p_access->p_sys,
 192                           p_buffer->p_buffer, p_buffer->i_buffer );
 193         block_Release( p_buffer );
 194
 195         p_buffer = p_next;
 196     }
 197
 198     return i_write;
 199 }
 200
 201 /*****************************************************************************
 202  * Seek: seek to a specific location in a file
 203  *****************************************************************************/
 204 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 205 {
 206     return lseek( (intptr_t)p_access->p_sys, i_pos, SEEK_SET );
 207 }