74b9eac67cc9ffa83e1b42906821d3b7a46d8cd8
[vlc.git] / modules / demux / decomp.c
1 /*****************************************************************************
2  * decomp.c : Decompression module for vlc
3  *****************************************************************************
4  * Copyright © 2008 Rémi Denis-Courmont
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation; either version 2.1 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19  *****************************************************************************/
20
21 #ifdef HAVE_CONFIG_H
22 # include "config.h"
23 #endif
24
25 #include <vlc_common.h>
26 #include <vlc_plugin.h>
27 #include <vlc_demux.h>
28 #include <vlc_stream.h>
29 #include <vlc_network.h>
30 #include <unistd.h>
31 #include <fcntl.h>
32 #include <spawn.h>
33 #include <sys/wait.h>
34 #include <sys/ioctl.h>
35
36 #include <assert.h>
37
38 static int  OpenGzip (vlc_object_t *);
39 static int  OpenBzip2 (vlc_object_t *);
40 static void Close (vlc_object_t *);
41
42 vlc_module_begin ();
43     set_description (N_("Decompression"));
44     set_category (CAT_INPUT);
45     set_subcategory (SUBCAT_INPUT_DEMUX);
46     set_capability ("demux", 20);
47     set_callbacks (OpenBzip2, Close);
48     /* TODO: shortnames */
49     /* --demux support */
50
51     add_submodule ();
52     set_callbacks (OpenGzip, Close);
53 vlc_module_end ();
54
55 static int Demux   (demux_t *);
56 static int Control (demux_t *, int i_query, va_list args);
57
58 struct demux_sys_t
59 {
60     stream_t    *out;
61     vlc_thread_t thread;
62     pid_t        pid;
63     int          write_fd, read_fd;
64 };
65
66 static void cloexec (int fd)
67 {
68     int flags = fcntl (fd, F_GETFD);
69     fcntl (fd, F_SETFD, O_CLOEXEC | (flags != -1) ? flags : 0);
70 }
71
72 extern char **environ;
73
74 static void cleanup_fd (void *data)
75 {
76     close ((intptr_t)data);
77 }
78
79 static void *Thread (void *data)
80 {
81     demux_t *demux = data;
82     demux_sys_t *p_sys = demux->p_sys;
83     int fd = p_sys->write_fd;
84     bool error = false;
85
86     vlc_cleanup_push (cleanup_fd, (void *)(intptr_t)fd);
87
88     do
89     {
90 #ifdef __linux__
91         /* TODO: mmap() + vmsplice() */
92 #endif
93         unsigned char buf[65536];
94         int canc = vlc_savecancel ();
95         ssize_t len = stream_Read (demux->s, buf, sizeof (buf));
96
97         vlc_restorecancel (canc);
98
99         if (len <= 0)
100             break;
101
102         for (ssize_t i = 0, j = 0; i < len; i += j)
103         {
104             j = write (fd, buf + i, len - i);
105             if (j == -1)
106             {
107                 msg_Err (demux, "cannot write data (%m)");
108                 error = true;
109                 break;
110             }
111         }
112     }
113     while (!error);
114
115     vlc_cleanup_run (); /* close(fd) */
116     return NULL;
117 }
118
119
120 #define MIN_BLOCK (1 << 10)
121 #define MAX_BLOCK (1 << 20)
122 /**
123  * Read data, decompress it, and forward
124  * @return -1 in case of error, 0 in case of EOF, 1 otherwise.
125  */
126 static int Demux (demux_t *demux)
127 {
128     demux_sys_t *p_sys = demux->p_sys;
129     int length, fd = p_sys->read_fd;
130
131 #ifdef TIOCINQ
132     if (ioctl (fd, TIOCINQ, &length) == 0)
133     {
134         if (length > MAX_BLOCK)
135             length = MAX_BLOCK;
136         else
137         if (length < MIN_BLOCK)
138             length = MIN_BLOCK;
139     }
140     else
141 #endif
142         length = MIN_BLOCK;
143
144     block_t *block = block_Alloc (length);
145     if (block == NULL)
146         return VLC_ENOMEM;
147
148     length = net_Read (demux, fd, NULL, block->p_buffer, length, false);
149     if (length <= 0)
150         return 0;
151     block->i_buffer = length;
152     stream_DemuxSend (p_sys->out, block);
153     return 1;
154 }
155
156
157 /*****************************************************************************
158  * Control:
159  *****************************************************************************/
160 static int Control (demux_t *demux, int query, va_list args)
161 {
162     /*demux_sys_t *p_sys = demux->p_sys;*/
163     (void)demux;
164     (void)query; (void)args;
165     return VLC_EGENERIC;
166 }
167
168 /**
169  * Pipe data through an external executable.
170  * @param demux the demux object.
171  * @param path path to the executable.
172  */
173 static int Open (demux_t *demux, const char *path)
174 {
175     demux_sys_t *p_sys = demux->p_sys = malloc (sizeof (*p_sys));
176     if (p_sys == NULL)
177         return VLC_ENOMEM;
178
179     demux->pf_demux = Demux;
180     demux->pf_control = Control;
181
182     /* I am not a big fan of the pyramid style, but I cannot think of anything
183      * better here. There are too many failure cases. */
184     int ret = VLC_EGENERIC;
185     int comp[2];
186     if (pipe (comp) == 0)
187     {
188         cloexec (comp[1]);
189         p_sys->write_fd = comp[1];
190
191         int uncomp[2];
192         if (pipe (uncomp) == 0)
193         {
194             cloexec (uncomp[0]);
195             p_sys->read_fd = uncomp[0];
196
197             posix_spawn_file_actions_t actions;
198             if (posix_spawn_file_actions_init (&actions) == 0)
199             {
200                 char *const argv[] = { (char *)path, NULL };
201
202                 if (!posix_spawn_file_actions_adddup2 (&actions, comp[0], 0)
203                  && !posix_spawn_file_actions_addclose (&actions, comp[0])
204                  && !posix_spawn_file_actions_adddup2 (&actions, uncomp[1], 1)
205                  && !posix_spawn_file_actions_addclose (&actions, comp[1])
206                  && !posix_spawnp (&p_sys->pid, path, &actions, NULL, argv,
207                                    environ))
208                 {
209                     p_sys->out = stream_DemuxNew (demux, "", demux->out);
210                     if (p_sys->out != NULL)
211                     {
212                         if (vlc_clone (&p_sys->thread, Thread, demux,
213                                        VLC_THREAD_PRIORITY_INPUT) == 0)
214                             ret = VLC_SUCCESS;
215                         else
216                             stream_DemuxDelete (p_sys->out);
217                     }
218                     else
219                         msg_Err (demux, "Cannot create demux");
220                 }
221                 else
222                     msg_Err (demux, "Cannot execute %s", path);
223                 posix_spawn_file_actions_destroy (&actions);
224             }
225             if (ret != VLC_SUCCESS)
226             {
227                 close (comp[1]);
228                 close (comp[0]);
229             }
230         }
231         if (ret != VLC_SUCCESS)
232             close (uncomp[0]);
233         close (uncomp[1]);
234     }
235     return ret;
236 }
237
238
239 /**
240  * Releases allocate resources.
241  */
242 static void Close (vlc_object_t *obj)
243 {
244     demux_t *demux = (demux_t *)obj;
245     demux_sys_t *p_sys = demux->p_sys;
246     int status;
247
248     vlc_cancel (p_sys->thread);
249     stream_DemuxDelete (p_sys->out);
250     close (p_sys->read_fd);
251     vlc_join (p_sys->thread, NULL);
252
253     msg_Dbg (obj, "waiting for PID %u", (unsigned)p_sys->pid);
254     while (waitpid (p_sys->pid, &status, 0) == -1);
255     msg_Dbg (obj, "exit status %d", status);
256
257     free (p_sys);
258 }
259
260
261 /**
262  * Detects gzip file format
263  */
264 static int OpenGzip (vlc_object_t *obj)
265 {
266     demux_t       *demux = (demux_t *)obj;
267     stream_t      *stream = demux->s;
268     const uint8_t *peek;
269
270     if (stream_Peek (stream, &peek, 3) < 3)
271         return VLC_EGENERIC;
272
273     if (memcmp (peek, "\x1f\x8b\x08", 3))
274         return VLC_EGENERIC;
275
276     msg_Dbg (obj, "detected gzip compressed stream");
277     return Open (demux, "zcat");
278 }
279
280
281 /**
282  * Detects bzip2 file format
283  */
284 static int OpenBzip2 (vlc_object_t *obj)
285 {
286     demux_t       *demux = (demux_t *)obj;
287     stream_t      *stream = demux->s;
288     const uint8_t *peek;
289
290     /* (Try to) parse the bzip2 header */
291     if (stream_Peek (stream, &peek, 10) < 10)
292         return VLC_EGENERIC;
293
294     if (memcmp (peek, "BZh", 3) || (peek[3] < '1') || (peek[3] > '9')
295      || memcmp (peek, "\x31\x41\x59\x26\x53\x59", 6))
296         return VLC_EGENERIC;
297
298     msg_Dbg (obj, "detected bzip2 compressed stream");
299     return Open (demux, "bzcat");
300 }
301