WinCE: build dump and timeshift modules
[vlc.git] / modules / access_filter / dump.c
1 /*****************************************************************************
2  * dump.c
3  *****************************************************************************
4  * Copyright © 2006 Rémi Denis-Courmont
5  * $Id$
6  *
7  * Author: Rémi Denis-Courmont <rem # videolan,org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <vlc_common.h>
29 #include <vlc_plugin.h>
30
31 #include <assert.h>
32 #include <time.h>
33 #include <errno.h>
34
35 #include <vlc_access.h>
36
37 #include <vlc_charset.h>
38 #include "vlc_keys.h"
39
40 #define DEFAULT_MARGIN 32 // megabytes
41
42 #define FORCE_TEXT N_("Force use of dump module")
43 #define FORCE_LONGTEXT N_("Activate the dump module " \
44                           "even for media with fast seeking.")
45
46 #define MARGIN_TEXT N_("Maximum size of temporary file (Mb)")
47 #define MARGIN_LONGTEXT N_("The dump module will abort dumping of the media " \
48                            "if more than this much megabyte were performed.")
49
50 static int  Open (vlc_object_t *);
51 static void Close (vlc_object_t *);
52
53 vlc_module_begin ();
54     set_shortname (N_("Dump"));
55     set_description (N_("Dump"));
56     set_category (CAT_INPUT);
57     set_subcategory (SUBCAT_INPUT_ACCESS_FILTER);
58     set_capability ("access_filter", 0);
59     add_shortcut ("dump");
60     set_callbacks (Open, Close);
61
62     add_bool ("dump-force", false, NULL, FORCE_TEXT,
63               FORCE_LONGTEXT, false);
64     add_integer ("dump-margin", DEFAULT_MARGIN, NULL, MARGIN_TEXT,
65                  MARGIN_LONGTEXT, false);
66 vlc_module_end();
67
68 static ssize_t Read (access_t *access, uint8_t *buffer, size_t len);
69 static block_t *Block (access_t *access);
70 static int Seek (access_t *access, int64_t offset);
71 static int Control (access_t *access, int cmd, va_list ap);
72
73 static void Trigger (access_t *access);
74 static int KeyHandler (vlc_object_t *obj, char const *varname,
75                        vlc_value_t oldval, vlc_value_t newval, void *data);
76
77 struct access_sys_t
78 {
79     FILE *stream;
80     int64_t tmp_max;
81     int64_t dumpsize;
82 };
83
84 /**
85  * Open()
86  */
87 static int Open (vlc_object_t *obj)
88 {
89     access_t *access = (access_t*)obj;
90     access_t *src = access->p_source;
91
92     if (!var_CreateGetBool (access, "dump-force"))
93     {
94         bool b;
95         if ((access_Control (src, ACCESS_CAN_FASTSEEK, &b) == 0) && b)
96         {
97             msg_Dbg (obj, "dump filter useless");
98             return VLC_EGENERIC;
99         }
100     }
101
102     if (src->pf_read != NULL)
103         access->pf_read = Read;
104     else
105         access->pf_block = Block;
106     if (src->pf_seek != NULL)
107         access->pf_seek = Seek;
108
109     access->pf_control = Control;
110     access->info = src->info;
111
112     access_sys_t *p_sys = access->p_sys = malloc (sizeof (*p_sys));
113     if (p_sys == NULL)
114         return VLC_ENOMEM;
115     memset (p_sys, 0, sizeof (*p_sys));
116
117 # ifndef UNDER_CE
118     if ((p_sys->stream = tmpfile ()) == NULL)
119 # else
120     char buf[75];
121     if(GetTempFileName("\\Temp\\","vlc",0,buf) || ((p_sys->stream = fopen(buf,"wb+")) ==NULL))
122 #endif
123     {
124         msg_Err (access, "cannot create temporary file: %m");
125         free (p_sys);
126         return VLC_EGENERIC;
127     }
128     p_sys->tmp_max = ((int64_t)var_CreateGetInteger (access, "dump-margin")) << 20;
129
130     var_AddCallback (access->p_libvlc, "key-action", KeyHandler, access);
131
132     return VLC_SUCCESS;
133 }
134
135
136 /**
137  * Close()
138  */
139 static void Close (vlc_object_t *obj)
140 {
141     access_t *access = (access_t *)obj;
142     access_sys_t *p_sys = access->p_sys;
143
144     var_DelCallback (access->p_libvlc, "key-action", KeyHandler, access);
145
146     if (p_sys->stream != NULL)
147         fclose (p_sys->stream);
148     free (p_sys);
149 }
150
151
152 static void Dump (access_t *access, const uint8_t *buffer, size_t len)
153 {
154     access_sys_t *p_sys = access->p_sys;
155     FILE *stream = p_sys->stream;
156
157     if ((stream == NULL) /* not dumping */
158      || (access->info.i_pos < p_sys->dumpsize) /* already known data */)
159         return;
160
161     size_t needed = access->info.i_pos - p_sys->dumpsize;
162     if (len < needed)
163         return; /* gap between data and dump offset (seek too far ahead?) */
164
165     buffer += len - needed;
166     len = needed;
167
168     if (len == 0)
169         return; /* no useful data */
170
171     if ((p_sys->tmp_max != -1) && (access->info.i_pos > p_sys->tmp_max))
172     {
173         msg_Dbg (access, "too much data - dump will not work");
174         goto error;
175     }
176
177     assert (len > 0);
178     if (fwrite (buffer, len, 1, stream) != 1)
179     {
180         msg_Err (access, "cannot write to file: %m");
181         goto error;
182     }
183
184     p_sys->dumpsize += len;
185     return;
186
187 error:
188     fclose (stream);
189     p_sys->stream = NULL;
190 }
191
192
193 static ssize_t Read (access_t *access, uint8_t *buffer, size_t len)
194 {
195     access_t *src = access->p_source;
196
197     src->info.i_update = access->info.i_update;
198     len = src->pf_read (src, buffer, len);
199     access->info = src->info;
200
201     Dump (access, buffer, len);
202
203     return len;
204 }
205
206
207 static block_t *Block (access_t *access)
208 {
209     access_t *src = access->p_source;
210     block_t *block;
211
212     src->info.i_update = access->info.i_update;
213     block = src->pf_block (src);
214     access->info = src->info;
215
216     if ((block == NULL) || (block->i_buffer <= 0))
217         return block;
218
219     Dump (access, block->p_buffer, block->i_buffer);
220
221     return block;
222 }
223
224
225 static int Control (access_t *access, int cmd, va_list ap)
226 {
227     access_t *src = access->p_source;
228
229     return src->pf_control (src, cmd, ap);
230 }
231
232
233 static int Seek (access_t *access, int64_t offset)
234 {
235     access_t *src = access->p_source;
236     access_sys_t *p_sys = access->p_sys;
237
238     if (p_sys->tmp_max == -1)
239     {
240         msg_Err (access, "cannot seek while dumping!");
241         return VLC_EGENERIC;
242     }
243
244     if (p_sys->stream != NULL)
245         msg_Dbg (access, "seeking - dump might not work");
246
247     src->info.i_update = access->info.i_update;
248     int ret = src->pf_seek (src, offset);
249     access->info = src->info;
250     return ret;
251 }
252
253 static void Trigger (access_t *access)
254 {
255     access_sys_t *p_sys = access->p_sys;
256
257     if (p_sys->stream == NULL)
258         return; // too late
259
260     if (p_sys->tmp_max == -1)
261         return; // already triggered - should we stop? FIXME
262
263     time_t now;
264     time (&now);
265
266     struct tm t;
267     if (localtime_r (&now, &t) == NULL)
268         return; // No time, eh? Well, I'd rather not run on your computer.
269
270     if (t.tm_year > 999999999)
271         // Humanity is about 300 times older than when this was written,
272         // and there is an off-by-one in the following sprintf().
273         return;
274
275     const char *home = config_GetHomeDir();
276
277     /* Hmm what about the extension?? */
278     char filename[strlen (home) + sizeof ("/vlcdump-YYYYYYYYY-MM-DD-HH-MM-SS.ts")];
279     sprintf (filename, "%s/vlcdump-%04u-%02u-%02u-%02u-%02u-%02u.ts", home,
280              t.tm_year, t.tm_mon, t.tm_mday, t.tm_hour, t.tm_min, t.tm_sec);
281
282     msg_Info (access, "dumping media to \"%s\"...", filename);
283
284     FILE *newstream = utf8_fopen (filename, "wb");
285     if (newstream == NULL)
286     {
287         msg_Err (access, "cannot create dump file \"%s\": %m", filename);
288         return;
289     }
290
291     /* This might cause excessive hard drive work :( */
292     FILE *oldstream = p_sys->stream;
293     rewind (oldstream);
294
295     for (;;)
296     {
297         char buf[16384];
298         size_t len = fread (buf, 1, sizeof (buf), oldstream);
299         if (len == 0)
300         {
301             if (ferror (oldstream))
302             {
303                 msg_Err (access, "cannot read temporary file: %m");
304                 break;
305             }
306
307             /* Done with temporary file */
308             fclose (oldstream);
309             p_sys->stream = newstream;
310             p_sys->tmp_max = -1;
311             return;
312         }
313
314         if (fwrite (buf, len, 1, newstream) != 1)
315         {
316             msg_Err (access, "cannot write dump file: %m");
317             break;
318         }
319     }
320
321     /* Failed to copy temporary file */
322     fseek (oldstream, 0, SEEK_END);
323     fclose (newstream);
324     return;
325 }
326
327
328 static int KeyHandler (vlc_object_t *obj, char const *varname,
329                        vlc_value_t oldval, vlc_value_t newval, void *data)
330 {
331     access_t *access = data;
332
333     (void)varname;
334     (void)oldval;
335     (void)obj;
336
337     if (newval.i_int == ACTIONID_DUMP)
338         Trigger (access);
339     return VLC_SUCCESS;
340 }