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 *****************************************************************************/
34 #include <vlc_access.h>
36 #include <vlc_charset.h>
39 #define DEFAULT_MARGIN 32 // megabytes
41 #define FORCE_TEXT N_("Force use of dump module")
42 #define FORCE_LONGTEXT N_("Activate the dump module " \
43 "even for media with fast seeking.")
45 #define MARGIN_TEXT N_("Maximum size of temporary file (Mb)")
46 #define MARGIN_LONGTEXT N_("The dump module will abort dumping of the media " \
47 "if more than this much megabyte were performed.")
49 static int Open (vlc_object_t *);
50 static void Close (vlc_object_t *);
53 set_shortname (_("Dump"));
54 set_description (_("Dump"));
55 set_category (CAT_INPUT);
56 set_subcategory (SUBCAT_INPUT_ACCESS_FILTER);
57 set_capability ("access_filter", 0);
58 add_shortcut ("dump");
59 set_callbacks (Open, Close);
61 add_bool ("dump-force", VLC_FALSE, NULL, FORCE_TEXT,
62 FORCE_LONGTEXT, VLC_FALSE);
63 add_integer ("dump-margin", DEFAULT_MARGIN, NULL, MARGIN_TEXT,
64 MARGIN_LONGTEXT, VLC_FALSE);
67 static ssize_t Read (access_t *access, uint8_t *buffer, size_t len);
68 static block_t *Block (access_t *access);
69 static int Seek (access_t *access, int64_t offset);
70 static int Control (access_t *access, int cmd, va_list ap);
72 static void Trigger (access_t *access);
73 static int KeyHandler (vlc_object_t *obj, char const *varname,
74 vlc_value_t oldval, vlc_value_t newval, void *data);
86 static int Open (vlc_object_t *obj)
88 access_t *access = (access_t*)obj;
89 access_t *src = access->p_source;
91 if (!var_CreateGetBool (access, "dump-force"))
94 if ((access2_Control (src, ACCESS_CAN_FASTSEEK, &b) == 0) && b)
96 msg_Dbg (obj, "dump filter useless");
101 if (src->pf_read != NULL)
102 access->pf_read = Read;
104 access->pf_block = Block;
105 if (src->pf_seek != NULL)
106 access->pf_seek = Seek;
108 access->pf_control = Control;
109 access->info = src->info;
111 access_sys_t *p_sys = access->p_sys = malloc (sizeof (*p_sys));
114 memset (p_sys, 0, sizeof (*p_sys));
116 if ((p_sys->stream = tmpfile ()) == NULL)
118 msg_Err (access, "cannot create temporary file: %m");
122 p_sys->tmp_max = ((int64_t)var_CreateGetInteger (access, "dump-margin")) << 20;
124 var_AddCallback (access->p_libvlc, "key-action", KeyHandler, access);
133 static void Close (vlc_object_t *obj)
135 access_t *access = (access_t *)obj;
136 access_sys_t *p_sys = access->p_sys;
138 var_DelCallback (access->p_libvlc, "key-action", KeyHandler, access);
140 if (p_sys->stream != NULL)
141 fclose (p_sys->stream);
146 static void Dump (access_t *access, const uint8_t *buffer, size_t len)
148 access_sys_t *p_sys = access->p_sys;
149 FILE *stream = p_sys->stream;
151 if ((stream == NULL) /* not dumping */
152 || (access->info.i_pos < p_sys->dumpsize) /* already known data */)
155 size_t needed = access->info.i_pos - p_sys->dumpsize;
157 return; /* gap between data and dump offset (seek too far ahead?) */
159 buffer += len - needed;
163 return; /* no useful data */
165 if ((p_sys->tmp_max != -1) && (access->info.i_pos > p_sys->tmp_max))
167 msg_Dbg (access, "too much data - dump will not work");
172 if (fwrite (buffer, len, 1, stream) != 1)
174 msg_Err (access, "cannot write to file: %m");
178 p_sys->dumpsize += len;
183 p_sys->stream = NULL;
187 static ssize_t Read (access_t *access, uint8_t *buffer, size_t len)
189 access_t *src = access->p_source;
191 src->info.i_update = access->info.i_update;
192 len = src->pf_read (src, buffer, len);
193 access->info = src->info;
195 Dump (access, buffer, len);
201 static block_t *Block (access_t *access)
203 access_t *src = access->p_source;
206 src->info.i_update = access->info.i_update;
207 block = src->pf_block (src);
208 access->info = src->info;
210 if ((block == NULL) || (block->i_buffer <= 0))
213 Dump (access, block->p_buffer, block->i_buffer);
219 static int Control (access_t *access, int cmd, va_list ap)
221 access_t *src = access->p_source;
223 return src->pf_control (src, cmd, ap);
227 static int Seek (access_t *access, int64_t offset)
229 access_t *src = access->p_source;
230 access_sys_t *p_sys = access->p_sys;
232 if (p_sys->tmp_max == -1)
234 msg_Err (access, "cannot seek while dumping!");
238 if (p_sys->stream != NULL)
239 msg_Dbg (access, "seeking - dump might not work");
241 src->info.i_update = access->info.i_update;
242 int ret = src->pf_seek (src, offset);
243 access->info = src->info;
247 static void Trigger (access_t *access)
249 access_sys_t *p_sys = access->p_sys;
251 if (p_sys->stream == NULL)
254 if (p_sys->tmp_max == -1)
255 return; // already triggered - should we stop? FIXME
261 if (localtime_r (&now, &t) == NULL)
262 return; // No time, eh? Well, I'd rather not run on your computer.
264 if (t.tm_year > 999999999)
265 // Humanity is about 300 times older than when this was written,
266 // and there is an off-by-one in the following sprintf().
269 const char *home = access->p_libvlc->psz_homedir;
271 /* Hmm what about the extension?? */
272 char filename[strlen (home) + sizeof ("/vlcdump-YYYYYYYYY-MM-DD-HH-MM-SS.ts")];
273 sprintf (filename, "%s/vlcdump-%04u-%02u-%02u-%02u-%02u-%02u.ts", home,
274 t.tm_year, t.tm_mon, t.tm_mday, t.tm_hour, t.tm_min, t.tm_sec);
276 msg_Info (access, "dumping media to \"%s\"...", filename);
278 FILE *newstream = utf8_fopen (filename, "wb");
279 if (newstream == NULL)
281 msg_Err (access, "cannot create dump file \"%s\": %m", filename);
285 /* This might cause excessive hard drive work :( */
286 FILE *oldstream = p_sys->stream;
292 size_t len = fread (buf, 1, sizeof (buf), oldstream);
295 if (ferror (oldstream))
297 msg_Err (access, "cannot read temporary file: %m");
301 /* Done with temporary file */
303 p_sys->stream = newstream;
308 if (fwrite (buf, len, 1, newstream) != 1)
310 msg_Err (access, "cannot write dump file: %m");
315 /* Failed to copy temporary file */
316 fseek (oldstream, 0, SEEK_END);
322 static int KeyHandler (vlc_object_t *obj, char const *varname,
323 vlc_value_t oldval, vlc_value_t newval, void *data)
325 access_t *access = data;
330 if (newval.i_int == ACTIONID_DUMP)