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