1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright © 2006 Rémi Denis-Courmont
7 * Author: Rémi Denis-Courmont <rem # videolan,org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
30 #include <vlc_access.h>
32 #include <vlc_charset.h>
35 #define DEFAULT_MARGIN 32 // megabytes
37 #define FORCE_TEXT N_("Force use of dump module")
38 #define FORCE_LONGTEXT N_("Activate the dump module " \
39 "even for media with fast seeking.")
41 #define MARGIN_TEXT N_("Maximum size of temporary file (Mb)")
42 #define MARGIN_LONGTEXT N_("The dump module will abort dumping of the media " \
43 "if more than this much megabyte were performed.")
45 static int Open (vlc_object_t *);
46 static void Close (vlc_object_t *);
49 set_shortname (_("Dump"));
50 set_description (_("Dump"));
51 set_category (CAT_INPUT);
52 set_subcategory (SUBCAT_INPUT_ACCESS_FILTER);
53 set_capability ("access_filter", 0);
54 add_shortcut ("dump");
55 set_callbacks (Open, Close);
57 add_bool ("dump-force", VLC_FALSE, NULL, FORCE_TEXT,
58 FORCE_LONGTEXT, VLC_FALSE);
59 add_integer ("dump-margin", DEFAULT_MARGIN, NULL, MARGIN_TEXT,
60 MARGIN_LONGTEXT, VLC_FALSE);
63 static int Read (access_t *access, uint8_t *buffer, int len);
64 static block_t *Block (access_t *access);
65 static int Seek (access_t *access, int64_t offset);
66 static int Control (access_t *access, int cmd, va_list ap);
68 static void Trigger (access_t *access);
69 static int KeyHandler (vlc_object_t *obj, char const *varname,
70 vlc_value_t oldval, vlc_value_t newval, void *data);
82 static int Open (vlc_object_t *obj)
84 access_t *access = (access_t*)obj;
85 access_t *src = access->p_source;
87 if (!var_CreateGetBool (access, "dump-force"))
90 if ((access2_Control (src, ACCESS_CAN_FASTSEEK, &b) == 0) && b)
92 msg_Dbg (obj, "dump filter useless");
97 if (src->pf_read != NULL)
98 access->pf_read = Read;
100 access->pf_block = Block;
101 if (src->pf_seek != NULL)
102 access->pf_seek = Seek;
104 access->pf_control = Control;
105 access->info = src->info;
107 access_sys_t *p_sys = access->p_sys = malloc (sizeof (*p_sys));
110 memset (p_sys, 0, sizeof (*p_sys));
112 if ((p_sys->stream = tmpfile ()) == NULL)
114 msg_Err (access, "cannot create temporary file: %m");
118 p_sys->tmp_max = ((int64_t)var_CreateGetInteger (access, "dump-margin")) << 20;
120 var_AddCallback (access->p_libvlc, "key-pressed", KeyHandler, access);
129 static void Close (vlc_object_t *obj)
131 access_t *access = (access_t *)obj;
132 access_sys_t *p_sys = access->p_sys;
134 var_DelCallback (access->p_libvlc, "key-pressed", KeyHandler, access);
136 if (p_sys->stream != NULL)
137 fclose (p_sys->stream);
142 static void Dump (access_t *access, const uint8_t *buffer, size_t len)
144 access_sys_t *p_sys = access->p_sys;
145 FILE *stream = p_sys->stream;
147 if ((stream == NULL) /* not dumping */
148 || (access->info.i_pos < p_sys->dumpsize) /* already known data */)
151 size_t needed = access->info.i_pos - p_sys->dumpsize;
153 return; /* gap between data and dump offset (seek too far ahead?) */
155 buffer += len - needed;
159 return; /* no useful data */
161 if ((p_sys->tmp_max != -1) && (access->info.i_pos > p_sys->tmp_max))
163 msg_Dbg (access, "too much data - dump will not work");
168 if (fwrite (buffer, len, 1, stream) != 1)
170 msg_Err (access, "cannot write to file: %m");
174 p_sys->dumpsize += len;
179 p_sys->stream = NULL;
183 static int Read (access_t *access, uint8_t *buffer, int len)
185 access_t *src = access->p_source;
187 src->info.i_update = access->info.i_update;
188 len = src->pf_read (src, buffer, len);
189 access->info = src->info;
191 Dump (access, buffer, len);
197 static block_t *Block (access_t *access)
199 access_t *src = access->p_source;
202 src->info.i_update = access->info.i_update;
203 block = src->pf_block (src);
204 access->info = src->info;
206 if ((block == NULL) || (block->i_buffer <= 0))
209 Dump (access, block->p_buffer, block->i_buffer);
215 static int Control (access_t *access, int cmd, va_list ap)
217 access_t *src = access->p_source;
219 return src->pf_control (src, cmd, ap);
223 static int Seek (access_t *access, int64_t offset)
225 access_t *src = access->p_source;
226 access_sys_t *p_sys = access->p_sys;
228 if (p_sys->tmp_max == -1)
230 msg_Err (access, "cannot seek while dumping!");
234 if (p_sys->stream != NULL)
235 msg_Dbg (access, "seeking - dump might not work");
237 src->info.i_update = access->info.i_update;
238 int ret = src->pf_seek (src, offset);
239 access->info = src->info;
244 #ifndef HAVE_LOCALTIME_R
245 static inline struct tm *localtime_r (const time_t *now, struct tm *res)
247 struct tm *unsafe = localtime (now);
249 * This is not thread-safe. Blame your C library.
250 * On Win32 there SHOULD be _localtime_s instead, but of course
251 * Cygwin and Mingw32 don't know about it. You're on your own if you
257 memcpy (res, unsafe, sizeof (*res));
263 static void Trigger (access_t *access)
265 access_sys_t *p_sys = access->p_sys;
267 if (p_sys->stream == NULL)
270 if (p_sys->tmp_max == -1)
271 return; // already triggered - should we stop? FIXME
277 if (localtime_r (&now, &t) == NULL)
278 return; // No time, eh? Well, I'd rather not run on your computer.
280 if (t.tm_year > 999999999)
281 // Humanity is about 300 times older than when this was written,
282 // and there is an off-by-one in the following sprintf().
285 const char *home = access->p_libvlc->psz_homedir;
287 /* Hmm what about the extension?? */
288 char filename[strlen (home) + sizeof ("/vlcdump-YYYYYYYYY-MM-DD-HH-MM-SS.ts")];
289 sprintf (filename, "%s/vlcdump-%04u-%02u-%02u-%02u-%02u-%02u.ts", home,
290 t.tm_year, t.tm_mon, t.tm_mday, t.tm_hour, t.tm_min, t.tm_sec);
292 msg_Info (access, "dumping media to \"%s\"...", filename);
294 FILE *newstream = utf8_fopen (filename, "wb");
295 if (newstream == NULL)
297 msg_Err (access, "cannot create dump file \"%s\": %m", filename);
301 /* This might cause excessive hard drive work :( */
302 FILE *oldstream = p_sys->stream;
308 size_t len = fread (buf, 1, sizeof (buf), oldstream);
311 if (ferror (oldstream))
313 msg_Err (access, "cannot read temporary file: %m");
317 /* Done with temporary file */
319 p_sys->stream = newstream;
324 if (fwrite (buf, len, 1, newstream) != 1)
326 msg_Err (access, "cannot write dump file: %m");
331 /* Failed to copy temporary file */
332 fseek (oldstream, 0, SEEK_END);
338 static int KeyHandler (vlc_object_t *obj, char const *varname,
339 vlc_value_t oldval, vlc_value_t newval, void *data)
341 access_t *access = data;
346 for (struct hotkey *key = access->p_libvlc->p_hotkeys;
347 key->psz_action != NULL; key++)
349 if (key->i_key == newval.i_int)
351 if (key->i_action == ACTIONID_DUMP)
352 Trigger ((access_t *)data);