4734e55deca84176f70ccd3dd24d2ff16b61db6a
[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 #ifdef __linux__
36 # include <sys/uio.h>
37 # include <sys/mman.h>
38 #endif
39
40 #include <assert.h>
41
42 static int  OpenGzip (vlc_object_t *);
43 static int  OpenBzip2 (vlc_object_t *);
44 static void Close (vlc_object_t *);
45
46 vlc_module_begin ();
47     set_description (N_("Decompression"));
48     set_category (CAT_INPUT);
49     set_subcategory (SUBCAT_INPUT_DEMUX);
50     set_capability ("demux", 20);
51     set_callbacks (OpenBzip2, Close);
52     /* TODO: shortnames */
53     /* --demux support */
54
55     add_submodule ();
56     set_callbacks (OpenGzip, Close);
57 vlc_module_end ();
58
59 static int Demux   (demux_t *);
60 static int Control (demux_t *, int i_query, va_list args);
61
62 struct demux_sys_t
63 {
64     stream_t    *out;
65     vlc_thread_t thread;
66     pid_t        pid;
67     int          write_fd, read_fd;
68 };
69
70 static void cloexec (int fd)
71 {
72     int flags = fcntl (fd, F_GETFD);
73     fcntl (fd, F_SETFD, FD_CLOEXEC | ((flags != -1) ? flags : 0));
74 }
75
76 extern char **environ;
77
78 static const size_t bufsize = 65536;
79 static void cleanup_mmap (void *addr)
80 {
81     munmap (addr, bufsize);
82 }
83
84
85 static void *Thread (void *data)
86 {
87     demux_t *demux = data;
88     demux_sys_t *p_sys = demux->p_sys;
89     int fd = p_sys->write_fd;
90     bool error = false;
91
92     do
93     {
94         ssize_t len;
95         int canc = vlc_savecancel ();
96 #ifdef __linux__
97         unsigned char *buf = mmap (NULL, bufsize, PROT_READ|PROT_WRITE,
98                                    MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
99         vlc_cleanup_push (cleanup_mmap, buf);
100 #else
101         unsigned char buf[bufsize];
102 #endif
103
104         len = stream_Read (demux->s, buf, bufsize);
105         vlc_restorecancel (canc);
106
107         if (len <= 0)
108             break;
109
110         for (ssize_t i = 0, j = 0; i < len; i += j)
111         {
112             struct iovec iov[1] = { { buf + i, len - i, } };
113
114 #ifdef __linux__
115             j = vmsplice (fd, iov, 1, SPLICE_F_GIFT);
116 #else
117             j = writev (fd, iov, 1);
118 #endif
119             if (j == -1)
120             {
121                 msg_Err (demux, "cannot write data (%m)");
122                 error = true;
123                 break;
124             }
125         }
126 #ifdef __linux__
127         vlc_cleanup_run (); /* munmap (buf, bufsize) */
128 #endif
129     }
130     while (!error);
131
132     msg_Dbg (demux, "compressed stream at EOF");
133     return NULL;
134 }
135
136
137 #define MIN_BLOCK (1 << 10)
138 #define MAX_BLOCK (1 << 20)
139 /**
140  * Read data, decompress it, and forward
141  * @return -1 in case of error, 0 in case of EOF, 1 otherwise.
142  */
143 static int Demux (demux_t *demux)
144 {
145     demux_sys_t *p_sys = demux->p_sys;
146     int length, fd = p_sys->read_fd;
147
148 #ifdef TIOCINQ
149     if (ioctl (fd, TIOCINQ, &length) == 0)
150     {
151         if (length > MAX_BLOCK)
152             length = MAX_BLOCK;
153         else
154         if (length < MIN_BLOCK)
155             length = MIN_BLOCK;
156     }
157     else
158 #endif
159         length = MIN_BLOCK;
160
161     block_t *block = block_Alloc (length);
162     if (block == NULL)
163         return VLC_ENOMEM;
164
165     length = net_Read (demux, fd, NULL, block->p_buffer, length, false);
166     if (length <= 0)
167         return 0;
168     block->i_buffer = length;
169     stream_DemuxSend (p_sys->out, block);
170     return 1;
171 }
172
173
174 /*****************************************************************************
175  * Control:
176  *****************************************************************************/
177 static int Control (demux_t *demux, int query, va_list args)
178 {
179     /*demux_sys_t *p_sys = demux->p_sys;*/
180     (void)demux;
181     (void)query; (void)args;
182     return VLC_EGENERIC;
183 }
184
185 /**
186  * Pipe data through an external executable.
187  * @param demux the demux object.
188  * @param path path to the executable.
189  */
190 static int Open (demux_t *demux, const char *path)
191 {
192     demux_sys_t *p_sys = demux->p_sys = malloc (sizeof (*p_sys));
193     if (p_sys == NULL)
194         return VLC_ENOMEM;
195
196     demux->pf_demux = Demux;
197     demux->pf_control = Control;
198
199     /* I am not a big fan of the pyramid style, but I cannot think of anything
200      * better here. There are too many failure cases. */
201     int ret = VLC_EGENERIC;
202     int comp[2];
203     if (pipe (comp) == 0)
204     {
205         cloexec (comp[1]);
206         p_sys->write_fd = comp[1];
207
208         int uncomp[2];
209         if (pipe (uncomp) == 0)
210         {
211             cloexec (uncomp[0]);
212             p_sys->read_fd = uncomp[0];
213
214             posix_spawn_file_actions_t actions;
215             if (posix_spawn_file_actions_init (&actions) == 0)
216             {
217                 char *const argv[] = { (char *)path, NULL };
218
219                 if (!posix_spawn_file_actions_adddup2 (&actions, comp[0], 0)
220                  && !posix_spawn_file_actions_addclose (&actions, comp[0])
221                  && !posix_spawn_file_actions_adddup2 (&actions, uncomp[1], 1)
222                  && !posix_spawn_file_actions_addclose (&actions, uncomp[1])
223                  && !posix_spawnp (&p_sys->pid, path, &actions, NULL, argv,
224                                    environ))
225                 {
226                     p_sys->out = stream_DemuxNew (demux, "", demux->out);
227                     if (p_sys->out != NULL)
228                     {
229                         if (vlc_clone (&p_sys->thread, Thread, demux,
230                                        VLC_THREAD_PRIORITY_INPUT) == 0)
231                             ret = VLC_SUCCESS;
232                         else
233                             stream_DemuxDelete (p_sys->out);
234                     }
235                     else
236                         msg_Err (demux, "Cannot create demux");
237                 }
238                 else
239                     msg_Err (demux, "Cannot execute %s", path);
240                 posix_spawn_file_actions_destroy (&actions);
241             }
242             if (ret != VLC_SUCCESS)
243             {
244                 close (comp[1]);
245                 close (comp[0]);
246             }
247         }
248         if (ret != VLC_SUCCESS)
249             close (uncomp[0]);
250         close (uncomp[1]);
251     }
252     return ret;
253 }
254
255
256 /**
257  * Releases allocate resources.
258  */
259 static void Close (vlc_object_t *obj)
260 {
261     demux_t *demux = (demux_t *)obj;
262     demux_sys_t *p_sys = demux->p_sys;
263     int status;
264
265     vlc_cancel (p_sys->thread);
266     stream_DemuxDelete (p_sys->out);
267     close (p_sys->read_fd);
268     vlc_join (p_sys->thread, NULL);
269     close (p_sys->write_fd);
270
271     msg_Dbg (obj, "waiting for PID %u", (unsigned)p_sys->pid);
272     while (waitpid (p_sys->pid, &status, 0) == -1);
273     msg_Dbg (obj, "exit status %d", status);
274
275     free (p_sys);
276 }
277
278
279 /**
280  * Detects gzip file format
281  */
282 static int OpenGzip (vlc_object_t *obj)
283 {
284     demux_t       *demux = (demux_t *)obj;
285     stream_t      *stream = demux->s;
286     const uint8_t *peek;
287
288     if (stream_Peek (stream, &peek, 3) < 3)
289         return VLC_EGENERIC;
290
291     if (memcmp (peek, "\x1f\x8b\x08", 3))
292         return VLC_EGENERIC;
293
294     msg_Dbg (obj, "detected gzip compressed stream");
295     return Open (demux, "zcat");
296 }
297
298
299 /**
300  * Detects bzip2 file format
301  */
302 static int OpenBzip2 (vlc_object_t *obj)
303 {
304     demux_t       *demux = (demux_t *)obj;
305     stream_t      *stream = demux->s;
306     const uint8_t *peek;
307
308     /* (Try to) parse the bzip2 header */
309     if (stream_Peek (stream, &peek, 10) < 10)
310         return VLC_EGENERIC;
311
312     if (memcmp (peek, "BZh", 3) || (peek[3] < '1') || (peek[3] > '9')
313      || memcmp (peek, "\x31\x41\x59\x26\x53\x59", 6))
314         return VLC_EGENERIC;
315
316     msg_Dbg (obj, "detected bzip2 compressed stream");
317     return Open (demux, "bzcat");
318 }
319