1 /*****************************************************************************
2 * libc.c: Extra libc function for some systems.
3 *****************************************************************************
4 * Copyright (C) 2002-2006 the VideoLAN team
7 * Authors: Jon Lech Johansen <jon-vl@nanocrew.net>
8 * Samuel Hocevar <sam@zoy.org>
9 * Gildas Bazin <gbazin@videolan.org>
10 * Derk-Jan Hartman <hartman at videolan dot org>
11 * Christophe Massiot <massiot@via.ecp.fr>
12 * Rémi Denis-Courmont <rem à videolan.org>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
27 *****************************************************************************/
32 #include <vlc_common.h>
42 #if defined(HAVE_ICONV)
53 # include <sys/time.h>
56 # include <sys/wait.h>
58 # include <sys/socket.h>
59 # include <sys/poll.h>
61 # define PF_LOCAL PF_UNIX
65 #if defined(WIN32) || defined(UNDER_CE)
70 # define WIN32_LEAN_AND_MEAN
74 /*****************************************************************************
75 * vlc_*dir_wrapper: wrapper under Windows to return the list of drive letters
76 * when called with an empty argument or just '\'
77 *****************************************************************************/
81 typedef struct vlc_DIR
85 struct _wdirent dd_dir;
89 void *vlc_wopendir( const wchar_t *wpath )
91 vlc_DIR *p_dir = NULL;
92 _WDIR *p_real_dir = NULL;
94 if ( wpath == NULL || wpath[0] == '\0'
95 || (wcscmp (wpath, L"\\") == 0) )
97 /* Special mode to list drive letters */
98 p_dir = malloc( sizeof(vlc_DIR) );
101 p_dir->p_real_dir = NULL;
102 #if defined(UNDER_CE)
103 p_dir->i_drives = NULL;
105 p_dir->i_drives = GetLogicalDrives();
107 return (void *)p_dir;
110 p_real_dir = _wopendir( wpath );
111 if ( p_real_dir == NULL )
114 p_dir = malloc( sizeof(vlc_DIR) );
117 _wclosedir( p_real_dir );
120 p_dir->p_real_dir = p_real_dir;
122 assert (wpath[0]); // wpath[1] is defined
123 p_dir->b_insert_back = !wcscmp (wpath + 1, L":\\");
124 return (void *)p_dir;
127 struct _wdirent *vlc_wreaddir( void *_p_dir )
129 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
132 if ( p_dir->p_real_dir != NULL )
134 if ( p_dir->b_insert_back )
136 /* Adds "..", gruik! */
137 p_dir->dd_dir.d_ino = 0;
138 p_dir->dd_dir.d_reclen = 0;
139 p_dir->dd_dir.d_namlen = 2;
140 wcscpy( p_dir->dd_dir.d_name, L".." );
141 p_dir->b_insert_back = false;
142 return &p_dir->dd_dir;
145 return _wreaddir( p_dir->p_real_dir );
148 /* Drive letters mode */
149 i_drives = p_dir->i_drives;
151 swprintf( p_dir->dd_dir.d_name, L"\\");
152 p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
156 return NULL; /* end */
158 for ( i = 0; i < sizeof(DWORD)*8; i++, i_drives >>= 1 )
159 if ( i_drives & 1 ) break;
162 return NULL; /* this should not happen */
164 swprintf( p_dir->dd_dir.d_name, L"%c:\\", 'A' + i );
165 p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
166 p_dir->i_drives &= ~(1UL << i);
168 return &p_dir->dd_dir;
171 void vlc_rewinddir( void *_p_dir )
173 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
175 if ( p_dir->p_real_dir != NULL )
176 _wrewinddir( p_dir->p_real_dir );
180 /* This one is in the libvlccore exported symbol list */
181 int vlc_wclosedir( void *_p_dir )
184 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
187 if ( p_dir->p_real_dir != NULL )
188 i_ret = _wclosedir( p_dir->p_real_dir );
193 return closedir( _p_dir );
198 # include <libintl.h>
202 * In-tree plugins share their gettext domain with LibVLC.
204 char *vlc_gettext( const char *msgid )
207 return dgettext( PACKAGE_NAME, msgid );
209 return (char *)msgid;
213 /*****************************************************************************
215 *****************************************************************************/
216 vlc_iconv_t vlc_iconv_open( const char *tocode, const char *fromcode )
218 #if defined(HAVE_ICONV)
219 return iconv_open( tocode, fromcode );
221 return (vlc_iconv_t)(-1);
225 size_t vlc_iconv( vlc_iconv_t cd, const char **inbuf, size_t *inbytesleft,
226 char **outbuf, size_t *outbytesleft )
228 #if defined(HAVE_ICONV)
229 return iconv( cd, (ICONV_CONST char **)inbuf, inbytesleft,
230 outbuf, outbytesleft );
236 int vlc_iconv_close( vlc_iconv_t cd )
238 #if defined(HAVE_ICONV)
239 return iconv_close( cd );
245 /*****************************************************************************
247 * (adapted from libavcodec, author Michael Niedermayer <michaelni@gmx.at>)
248 *****************************************************************************/
249 bool vlc_ureduce( unsigned *pi_dst_nom, unsigned *pi_dst_den,
250 uint64_t i_nom, uint64_t i_den, uint64_t i_max )
262 i_gcd = GCD( i_nom, i_den );
266 if( i_max == 0 ) i_max = INT64_C(0xFFFFFFFF);
268 if( i_nom > i_max || i_den > i_max )
270 uint64_t i_a0_num = 0, i_a0_den = 1, i_a1_num = 1, i_a1_den = 0;
275 uint64_t i_x = i_nom / i_den;
276 uint64_t i_a2n = i_x * i_a1_num + i_a0_num;
277 uint64_t i_a2d = i_x * i_a1_den + i_a0_den;
279 if( i_a2n > i_max || i_a2d > i_max ) break;
283 i_a0_num = i_a1_num; i_a0_den = i_a1_den;
284 i_a1_num = i_a2n; i_a1_den = i_a2d;
285 if( i_nom == 0 ) break;
286 i_x = i_nom; i_nom = i_den; i_den = i_x;
298 /*************************************************************************
299 * vlc_execve: Execute an external program with a given environment,
300 * wait until it finishes and return its standard output
301 *************************************************************************/
302 int __vlc_execve( vlc_object_t *p_object, int i_argc, char *const *ppsz_argv,
303 char *const *ppsz_env, const char *psz_cwd,
304 const char *p_in, size_t i_in,
305 char **pp_data, size_t *pi_data )
307 (void)i_argc; // <-- hmph
309 # define BUFSIZE 1024
310 int fds[2], i_status;
312 if (socketpair (PF_LOCAL, SOCK_STREAM, 0, fds))
316 if ((fds[0] > 2) && (fds[1] > 2))
322 msg_Err (p_object, "unable to fork (%m)");
331 pthread_sigmask (SIG_SETMASK, &set, NULL);
334 * Like it or not, close can fail (and not only with EBADF)
336 if ((close (0) == 0) && (close (1) == 0) && (close (2) == 0)
337 && (dup (fds[1]) == 0) && (dup (fds[1]) == 1)
338 && (open ("/dev/null", O_RDONLY) == 2)
339 && ((psz_cwd == NULL) || (chdir (psz_cwd) == 0)))
340 execve (ppsz_argv[0], ppsz_argv, ppsz_env);
354 shutdown (fds[0], SHUT_WR);
356 while (!p_object->b_die)
358 struct pollfd ufd[1];
359 memset (ufd, 0, sizeof (ufd));
361 ufd[0].events = POLLIN;
364 ufd[0].events |= POLLOUT;
366 if (poll (ufd, 1, 10) <= 0)
369 if (ufd[0].revents & ~POLLOUT)
371 char *ptr = realloc (*pp_data, *pi_data + BUFSIZE + 1);
373 break; /* safely abort */
377 ssize_t val = read (fds[0], ptr + *pi_data, BUFSIZE);
382 shutdown (fds[0], SHUT_RD);
390 if (ufd[0].revents & POLLOUT)
392 ssize_t val = write (fds[0], p_in, i_in);
398 shutdown (fds[0], SHUT_WR);
410 while (waitpid (pid, &i_status, 0) == -1);
412 if (WIFEXITED (i_status))
414 i_status = WEXITSTATUS (i_status);
416 msg_Warn (p_object, "child %s (PID %d) exited with error code %d",
417 ppsz_argv[0], (int)pid, i_status);
420 if (WIFSIGNALED (i_status)) // <-- this should be redumdant a check
422 i_status = WTERMSIG (i_status);
423 msg_Warn (p_object, "child %s (PID %d) exited on signal %d (%s)",
424 ppsz_argv[0], (int)pid, i_status, strsignal (i_status));
427 #elif defined( WIN32 ) && !defined( UNDER_CE )
428 SECURITY_ATTRIBUTES saAttr;
429 PROCESS_INFORMATION piProcInfo;
430 STARTUPINFO siStartInfo;
431 BOOL bFuncRetn = FALSE;
432 HANDLE hChildStdinRd, hChildStdinWr, hChildStdoutRd, hChildStdoutWr;
434 char *psz_cmd = NULL, *p_env = NULL, *p = NULL;
438 /* Set the bInheritHandle flag so pipe handles are inherited. */
439 saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
440 saAttr.bInheritHandle = TRUE;
441 saAttr.lpSecurityDescriptor = NULL;
443 /* Create a pipe for the child process's STDOUT. */
444 if ( !CreatePipe( &hChildStdoutRd, &hChildStdoutWr, &saAttr, 0 ) )
446 msg_Err( p_object, "stdout pipe creation failed" );
450 /* Ensure the read handle to the pipe for STDOUT is not inherited. */
451 SetHandleInformation( hChildStdoutRd, HANDLE_FLAG_INHERIT, 0 );
453 /* Create a pipe for the child process's STDIN. */
454 if ( !CreatePipe( &hChildStdinRd, &hChildStdinWr, &saAttr, 0 ) )
456 msg_Err( p_object, "stdin pipe creation failed" );
460 /* Ensure the write handle to the pipe for STDIN is not inherited. */
461 SetHandleInformation( hChildStdinWr, HANDLE_FLAG_INHERIT, 0 );
463 /* Set up members of the PROCESS_INFORMATION structure. */
464 ZeroMemory( &piProcInfo, sizeof(PROCESS_INFORMATION) );
466 /* Set up members of the STARTUPINFO structure. */
467 ZeroMemory( &siStartInfo, sizeof(STARTUPINFO) );
468 siStartInfo.cb = sizeof(STARTUPINFO);
469 siStartInfo.hStdError = hChildStdoutWr;
470 siStartInfo.hStdOutput = hChildStdoutWr;
471 siStartInfo.hStdInput = hChildStdinRd;
472 siStartInfo.wShowWindow = SW_HIDE;
473 siStartInfo.dwFlags |= STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
475 /* Set up the command line. */
476 psz_cmd = malloc(32768);
481 ppsz_parser = &ppsz_argv[0];
482 while ( ppsz_parser[0] != NULL && i_size > 0 )
484 /* Protect the last argument with quotes ; the other arguments
485 * are supposed to be already protected because they have been
486 * passed as a command-line option. */
487 if ( ppsz_parser[1] == NULL )
489 strncat( psz_cmd, "\"", i_size );
492 strncat( psz_cmd, *ppsz_parser, i_size );
493 i_size -= strlen( *ppsz_parser );
494 if ( ppsz_parser[1] == NULL )
496 strncat( psz_cmd, "\"", i_size );
499 strncat( psz_cmd, " ", i_size );
504 /* Set up the environment. */
505 p = p_env = malloc(32768);
513 ppsz_parser = &ppsz_env[0];
514 while ( *ppsz_parser != NULL && i_size > 0 )
516 memcpy( p, *ppsz_parser,
517 __MIN((int)(strlen(*ppsz_parser) + 1), i_size) );
518 p += strlen(*ppsz_parser) + 1;
519 i_size -= strlen(*ppsz_parser) + 1;
524 /* Create the child process. */
525 bFuncRetn = CreateProcess( NULL,
526 psz_cmd, // command line
527 NULL, // process security attributes
528 NULL, // primary thread security attributes
529 TRUE, // handles are inherited
533 &siStartInfo, // STARTUPINFO pointer
534 &piProcInfo ); // receives PROCESS_INFORMATION
539 if ( bFuncRetn == 0 )
541 msg_Err( p_object, "child creation failed" );
545 /* Read from a file and write its contents to a pipe. */
546 while ( i_in > 0 && !p_object->b_die )
549 if ( !WriteFile( hChildStdinWr, p_in, i_in, &i_written, NULL ) )
555 /* Close the pipe handle so the child process stops reading. */
556 CloseHandle(hChildStdinWr);
558 /* Close the write end of the pipe before reading from the
559 * read end of the pipe. */
560 CloseHandle(hChildStdoutWr);
562 /* Read output from the child process. */
567 *pp_data = malloc( 1025 ); /* +1 for \0 */
569 while ( !p_object->b_die )
572 if ( !ReadFile( hChildStdoutRd, &(*pp_data)[*pi_data], 1024, &i_read,
577 *pp_data = realloc( *pp_data, *pi_data + 1025 );
580 while ( !p_object->b_die
581 && !GetExitCodeProcess( piProcInfo.hProcess, &i_status )
582 && i_status != STILL_ACTIVE )
585 CloseHandle(piProcInfo.hProcess);
586 CloseHandle(piProcInfo.hThread);
590 "child %s returned with error code %ld",
591 ppsz_argv[0], i_status );
594 msg_Err( p_object, "vlc_execve called but no implementation is available" );
599 if (*pp_data == NULL)
602 (*pp_data)[*pi_data] = '\0';