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 *****************************************************************************/
42 #if defined(HAVE_ICONV)
55 # include <sys/time.h>
58 # include <sys/wait.h>
60 # include <sys/socket.h>
61 # include <sys/poll.h>
64 #if defined(WIN32) || defined(UNDER_CE)
69 # define WIN32_LEAN_AND_MEAN
74 # define strcoll strcmp
77 /*****************************************************************************
78 * strcasecmp: compare two strings ignoring case
79 *****************************************************************************/
80 #if !defined( HAVE_STRCASECMP ) && !defined( HAVE_STRICMP )
81 int vlc_strcasecmp( const char *s1, const char *s2 )
84 if( !s1 || !s2 ) return -1;
91 if( c1 != c2 ) return (c1 < c2 ? -1 : 1);
95 if( !*s1 && !*s2 ) return 0;
96 else return (*s1 ? 1 : -1);
100 /*****************************************************************************
101 * strncasecmp: compare n chars from two strings ignoring case
102 *****************************************************************************/
103 #if !defined( HAVE_STRNCASECMP ) && !defined( HAVE_STRNICMP )
104 int vlc_strncasecmp( const char *s1, const char *s2, size_t n )
107 if( !s1 || !s2 ) return -1;
109 while( n > 0 && *s1 && *s2 )
114 if( c1 != c2 ) return (c1 < c2 ? -1 : 1);
118 if( !n || (!*s1 && !*s2) ) return 0;
119 else return (*s1 ? 1 : -1);
123 /******************************************************************************
124 * strcasestr: find a substring (little) in another substring (big)
125 * Case sensitive. Return NULL if not found, return big if little == null
126 *****************************************************************************/
127 #if !defined( HAVE_STRCASESTR ) && !defined( HAVE_STRISTR )
128 char * vlc_strcasestr( const char *psz_big, const char *psz_little )
130 char *p_pos = (char *)psz_big;
132 if( !psz_big || !psz_little || !*psz_little ) return p_pos;
136 if( toupper( *p_pos ) == toupper( *psz_little ) )
138 char * psz_cur1 = p_pos + 1;
139 char * psz_cur2 = (char *)psz_little + 1;
140 while( *psz_cur1 && *psz_cur2 &&
141 toupper( *psz_cur1 ) == toupper( *psz_cur2 ) )
146 if( !*psz_cur2 ) return p_pos;
154 /*****************************************************************************
156 *****************************************************************************/
157 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
158 int vlc_vasprintf(char **strp, const char *fmt, va_list ap)
160 /* Guess we need no more than 100 bytes. */
162 char *p = malloc( i_size );
173 /* Try to print in the allocated space. */
174 n = vsnprintf( p, i_size, fmt, ap );
176 /* If that worked, return the string. */
177 if (n > -1 && n < i_size)
182 /* Else try again with more space. */
183 if (n > -1) /* glibc 2.1 */
185 i_size = n+1; /* precisely what is needed */
189 i_size *= 2; /* twice the old size */
191 if( (p = realloc( p, i_size ) ) == NULL)
200 /*****************************************************************************
202 *****************************************************************************/
203 #if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
204 int vlc_asprintf( char **strp, const char *fmt, ... )
209 va_start( args, fmt );
210 i_ret = vasprintf( strp, fmt, args );
217 /*****************************************************************************
218 * strtoll: convert a string to a 64 bits int.
219 *****************************************************************************/
220 #if !defined( HAVE_STRTOLL )
221 int64_t vlc_strtoll( const char *nptr, char **endptr, int base )
224 int sign = 1, newbase = base ? base : 10;
226 while( isspace(*nptr) ) nptr++;
234 /* Try to detect base */
247 if( base && newbase != base )
249 if( endptr ) *endptr = (char *)nptr;
256 while( *nptr >= '0' && *nptr <= '9' )
259 i_value += ( *nptr++ - '0' );
261 if( endptr ) *endptr = (char *)nptr;
265 while( (*nptr >= '0' && *nptr <= '9') ||
266 (*nptr >= 'a' && *nptr <= 'f') ||
267 (*nptr >= 'A' && *nptr <= 'F') )
270 if(*nptr >= '0' && *nptr <= '9') i_valc = *nptr - '0';
271 else if(*nptr >= 'a' && *nptr <= 'f') i_valc = *nptr - 'a' +10;
272 else if(*nptr >= 'A' && *nptr <= 'F') i_valc = *nptr - 'A' +10;
277 if( endptr ) *endptr = (char *)nptr;
281 i_value = strtol( nptr, endptr, newbase );
285 return i_value * sign;
290 * Copy a string to a sized buffer. The result is always nul-terminated
291 * (contrary to strncpy()).
293 * @param dest destination buffer
294 * @param src string to be copied
295 * @param len maximum number of characters to be copied plus one for the
298 * @return strlen(src)
301 extern size_t vlc_strlcpy (char *tgt, const char *src, size_t bufsize)
305 for (length = 1; (length < bufsize) && *src; length++)
318 /*****************************************************************************
319 * vlc_*dir_wrapper: wrapper under Windows to return the list of drive letters
320 * when called with an empty argument or just '\'
321 *****************************************************************************/
322 #if defined(WIN32) && !defined(UNDER_CE)
325 typedef struct vlc_DIR
329 struct _wdirent dd_dir;
333 void *vlc_wopendir( const wchar_t *wpath )
335 vlc_DIR *p_dir = NULL;
336 _WDIR *p_real_dir = NULL;
338 if ( wpath == NULL || wpath[0] == '\0'
339 || (wcscmp (wpath, L"\\") == 0) )
341 /* Special mode to list drive letters */
342 p_dir = malloc( sizeof(vlc_DIR) );
345 p_dir->p_real_dir = NULL;
346 p_dir->i_drives = GetLogicalDrives();
347 return (void *)p_dir;
350 p_real_dir = _wopendir( wpath );
351 if ( p_real_dir == NULL )
354 p_dir = malloc( sizeof(vlc_DIR) );
357 _wclosedir( p_real_dir );
360 p_dir->p_real_dir = p_real_dir;
362 assert (wpath[0]); // wpath[1] is defined
363 p_dir->b_insert_back = !wcscmp (wpath + 1, L":\\");
364 return (void *)p_dir;
367 struct _wdirent *vlc_wreaddir( void *_p_dir )
369 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
373 if ( p_dir->p_real_dir != NULL )
375 if ( p_dir->b_insert_back )
377 /* Adds "..", gruik! */
378 p_dir->dd_dir.d_ino = 0;
379 p_dir->dd_dir.d_reclen = 0;
380 p_dir->dd_dir.d_namlen = 2;
381 wcscpy( p_dir->dd_dir.d_name, L".." );
382 p_dir->b_insert_back = false;
383 return &p_dir->dd_dir;
386 return _wreaddir( p_dir->p_real_dir );
389 /* Drive letters mode */
390 i_drives = p_dir->i_drives;
392 return NULL; /* end */
394 for ( i = 0; i < sizeof(DWORD)*8; i++, i_drives >>= 1 )
395 if ( i_drives & 1 ) break;
398 return NULL; /* this should not happen */
400 swprintf( p_dir->dd_dir.d_name, L"%c:\\", 'A' + i );
401 p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
402 p_dir->i_drives &= ~(1UL << i);
403 return &p_dir->dd_dir;
406 int vlc_wclosedir( void *_p_dir )
408 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
411 if ( p_dir->p_real_dir != NULL )
412 i_ret = _wclosedir( p_dir->p_real_dir );
418 void vlc_rewinddir( void *_p_dir )
420 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
422 if ( p_dir->p_real_dir != NULL )
423 _wrewinddir( p_dir->p_real_dir );
427 /*****************************************************************************
428 * scandir: scan a directory alpha-sorted
429 *****************************************************************************/
430 #if !defined( HAVE_SCANDIR )
431 /* FIXME: I suspect this is dead code -> utf8_scandir */
437 int vlc_alphasort( const struct dirent **a, const struct dirent **b )
439 return strcoll( (*a)->d_name, (*b)->d_name );
442 int vlc_scandir( const char *name, struct dirent ***namelist,
443 int (*filter) ( const struct dirent * ),
444 int (*compar) ( const struct dirent **,
445 const struct dirent ** ) )
448 struct dirent * p_content;
449 struct dirent ** pp_list;
452 if( !namelist || !( p_dir = opendir( name ) ) ) return -1;
456 while( ( p_content = readdir( p_dir ) ) )
458 if( filter && !filter( p_content ) )
462 pp_list = realloc( pp_list, ( ret + 1 ) * sizeof( struct dirent * ) );
463 size = sizeof( struct dirent ) + strlen( p_content->d_name ) + 1;
464 pp_list[ret] = malloc( size );
467 memcpy( pp_list[ret], p_content, size );
472 /* Continuing is useless when no more memory can be allocted,
473 * so better return what we have found.
484 qsort( pp_list, ret, sizeof( struct dirent * ),
485 (int (*)(const void *, const void *)) compar );
495 * gettext callbacks for plugins.
496 * LibVLC links libintl statically on Windows.
498 char *vlc_dgettext( const char *package, const char *msgid )
500 return dgettext( package, msgid );
505 * In-tree plugins share their gettext domain with LibVLC.
507 char *vlc_gettext( const char *msgid )
509 return dgettext( PACKAGE_NAME, msgid );
512 /*****************************************************************************
513 * count_utf8_string: returns the number of characters in the string.
514 *****************************************************************************/
515 static int count_utf8_string( const char *psz_string )
517 int i = 0, i_count = 0;
518 while( psz_string[ i ] != 0 )
520 if( ((unsigned char *)psz_string)[ i ] < 0x80UL ) i_count++;
526 /*****************************************************************************
527 * wraptext: inserts \n at convenient places to wrap the text.
528 * Returns the modified string in a new buffer.
529 *****************************************************************************/
530 char *vlc_wraptext( const char *psz_text, int i_line )
533 char *psz_line, *psz_new_text;
535 psz_line = psz_new_text = strdup( psz_text );
537 i_len = count_utf8_string( psz_text );
539 while( i_len > i_line )
541 /* Look if there is a newline somewhere. */
542 char *psz_parser = psz_line;
544 while( i_count <= i_line && *psz_parser != '\n' )
546 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
550 if( *psz_parser == '\n' )
552 i_len -= (i_count + 1);
553 psz_line = psz_parser + 1;
557 /* Find the furthest space. */
558 while( psz_parser > psz_line && *psz_parser != ' ' )
560 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser--;
564 if( *psz_parser == ' ' )
567 i_len -= (i_count + 1);
568 psz_line = psz_parser + 1;
572 /* Wrapping has failed. Find the first space or newline */
573 while( i_count < i_len && *psz_parser != ' ' && *psz_parser != '\n' )
575 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
579 if( i_count < i_len ) *psz_parser = '\n';
580 i_len -= (i_count + 1);
581 psz_line = psz_parser + 1;
587 /*****************************************************************************
589 *****************************************************************************/
590 vlc_iconv_t vlc_iconv_open( const char *tocode, const char *fromcode )
592 #if defined(HAVE_ICONV)
593 return iconv_open( tocode, fromcode );
599 size_t vlc_iconv( vlc_iconv_t cd, const char **inbuf, size_t *inbytesleft,
600 char **outbuf, size_t *outbytesleft )
602 #if defined(HAVE_ICONV)
603 return iconv( cd, (ICONV_CONST char **)inbuf, inbytesleft,
604 outbuf, outbytesleft );
608 if (inbytesleft == NULL || outbytesleft == NULL)
613 i_bytes = __MIN(*inbytesleft, *outbytesleft);
614 if( !inbuf || !outbuf || !i_bytes ) return (size_t)(-1);
615 memcpy( *outbuf, *inbuf, i_bytes );
618 inbytesleft -= i_bytes;
619 outbytesleft -= i_bytes;
624 int vlc_iconv_close( vlc_iconv_t cd )
626 #if defined(HAVE_ICONV)
627 return iconv_close( cd );
633 /*****************************************************************************
635 * (adapted from libavcodec, author Michael Niedermayer <michaelni@gmx.at>)
636 *****************************************************************************/
637 bool vlc_ureduce( unsigned *pi_dst_nom, unsigned *pi_dst_den,
638 uint64_t i_nom, uint64_t i_den, uint64_t i_max )
650 i_gcd = GCD( i_nom, i_den );
654 if( i_max == 0 ) i_max = INT64_C(0xFFFFFFFF);
656 if( i_nom > i_max || i_den > i_max )
658 uint64_t i_a0_num = 0, i_a0_den = 1, i_a1_num = 1, i_a1_den = 0;
663 uint64_t i_x = i_nom / i_den;
664 uint64_t i_a2n = i_x * i_a1_num + i_a0_num;
665 uint64_t i_a2d = i_x * i_a1_den + i_a0_den;
667 if( i_a2n > i_max || i_a2d > i_max ) break;
671 i_a0_num = i_a1_num; i_a0_den = i_a1_den;
672 i_a1_num = i_a2n; i_a1_den = i_a2d;
673 if( i_nom == 0 ) break;
674 i_x = i_nom; i_nom = i_den; i_den = i_x;
686 /*************************************************************************
687 * vlc_execve: Execute an external program with a given environment,
688 * wait until it finishes and return its standard output
689 *************************************************************************/
690 int __vlc_execve( vlc_object_t *p_object, int i_argc, char *const *ppsz_argv,
691 char *const *ppsz_env, const char *psz_cwd,
692 const char *p_in, size_t i_in,
693 char **pp_data, size_t *pi_data )
695 (void)i_argc; // <-- hmph
697 # define BUFSIZE 1024
698 int fds[2], i_status;
700 if (socketpair (AF_LOCAL, SOCK_STREAM, 0, fds))
704 if ((fds[0] > 2) && (fds[1] > 2))
710 msg_Err (p_object, "unable to fork (%m)");
719 pthread_sigmask (SIG_SETMASK, &set, NULL);
722 * Like it or not, close can fail (and not only with EBADF)
724 if ((close (0) == 0) && (close (1) == 0) && (close (2) == 0)
725 && (dup (fds[1]) == 0) && (dup (fds[1]) == 1)
726 && (open ("/dev/null", O_RDONLY) == 2)
727 && ((psz_cwd == NULL) || (chdir (psz_cwd) == 0)))
728 execve (ppsz_argv[0], ppsz_argv, ppsz_env);
742 shutdown (fds[0], SHUT_WR);
744 while (!p_object->b_die)
746 struct pollfd ufd[1];
747 memset (ufd, 0, sizeof (ufd));
749 ufd[0].events = POLLIN;
752 ufd[0].events |= POLLOUT;
754 if (poll (ufd, 1, 10) <= 0)
757 if (ufd[0].revents & ~POLLOUT)
759 char *ptr = realloc (*pp_data, *pi_data + BUFSIZE + 1);
761 break; /* safely abort */
765 ssize_t val = read (fds[0], ptr + *pi_data, BUFSIZE);
770 shutdown (fds[0], SHUT_RD);
778 if (ufd[0].revents & POLLOUT)
780 ssize_t val = write (fds[0], p_in, i_in);
786 shutdown (fds[0], SHUT_WR);
798 while (waitpid (pid, &i_status, 0) == -1);
800 if (WIFEXITED (i_status))
802 i_status = WEXITSTATUS (i_status);
804 msg_Warn (p_object, "child %s (PID %d) exited with error code %d",
805 ppsz_argv[0], (int)pid, i_status);
808 if (WIFSIGNALED (i_status)) // <-- this should be redumdant a check
810 i_status = WTERMSIG (i_status);
811 msg_Warn (p_object, "child %s (PID %d) exited on signal %d (%s)",
812 ppsz_argv[0], (int)pid, i_status, strsignal (i_status));
815 #elif defined( WIN32 ) && !defined( UNDER_CE )
816 SECURITY_ATTRIBUTES saAttr;
817 PROCESS_INFORMATION piProcInfo;
818 STARTUPINFO siStartInfo;
819 BOOL bFuncRetn = FALSE;
820 HANDLE hChildStdinRd, hChildStdinWr, hChildStdoutRd, hChildStdoutWr;
822 char *psz_cmd = NULL, *p_env = NULL, *p = NULL;
826 /* Set the bInheritHandle flag so pipe handles are inherited. */
827 saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
828 saAttr.bInheritHandle = TRUE;
829 saAttr.lpSecurityDescriptor = NULL;
831 /* Create a pipe for the child process's STDOUT. */
832 if ( !CreatePipe( &hChildStdoutRd, &hChildStdoutWr, &saAttr, 0 ) )
834 msg_Err( p_object, "stdout pipe creation failed" );
838 /* Ensure the read handle to the pipe for STDOUT is not inherited. */
839 SetHandleInformation( hChildStdoutRd, HANDLE_FLAG_INHERIT, 0 );
841 /* Create a pipe for the child process's STDIN. */
842 if ( !CreatePipe( &hChildStdinRd, &hChildStdinWr, &saAttr, 0 ) )
844 msg_Err( p_object, "stdin pipe creation failed" );
848 /* Ensure the write handle to the pipe for STDIN is not inherited. */
849 SetHandleInformation( hChildStdinWr, HANDLE_FLAG_INHERIT, 0 );
851 /* Set up members of the PROCESS_INFORMATION structure. */
852 ZeroMemory( &piProcInfo, sizeof(PROCESS_INFORMATION) );
854 /* Set up members of the STARTUPINFO structure. */
855 ZeroMemory( &siStartInfo, sizeof(STARTUPINFO) );
856 siStartInfo.cb = sizeof(STARTUPINFO);
857 siStartInfo.hStdError = hChildStdoutWr;
858 siStartInfo.hStdOutput = hChildStdoutWr;
859 siStartInfo.hStdInput = hChildStdinRd;
860 siStartInfo.wShowWindow = SW_HIDE;
861 siStartInfo.dwFlags |= STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
863 /* Set up the command line. */
864 psz_cmd = malloc(32768);
869 ppsz_parser = &ppsz_argv[0];
870 while ( ppsz_parser[0] != NULL && i_size > 0 )
872 /* Protect the last argument with quotes ; the other arguments
873 * are supposed to be already protected because they have been
874 * passed as a command-line option. */
875 if ( ppsz_parser[1] == NULL )
877 strncat( psz_cmd, "\"", i_size );
880 strncat( psz_cmd, *ppsz_parser, i_size );
881 i_size -= strlen( *ppsz_parser );
882 if ( ppsz_parser[1] == NULL )
884 strncat( psz_cmd, "\"", i_size );
887 strncat( psz_cmd, " ", i_size );
892 /* Set up the environment. */
893 p = p_env = malloc(32768);
901 ppsz_parser = &ppsz_env[0];
902 while ( *ppsz_parser != NULL && i_size > 0 )
904 memcpy( p, *ppsz_parser,
905 __MIN((int)(strlen(*ppsz_parser) + 1), i_size) );
906 p += strlen(*ppsz_parser) + 1;
907 i_size -= strlen(*ppsz_parser) + 1;
912 /* Create the child process. */
913 bFuncRetn = CreateProcess( NULL,
914 psz_cmd, // command line
915 NULL, // process security attributes
916 NULL, // primary thread security attributes
917 TRUE, // handles are inherited
921 &siStartInfo, // STARTUPINFO pointer
922 &piProcInfo ); // receives PROCESS_INFORMATION
927 if ( bFuncRetn == 0 )
929 msg_Err( p_object, "child creation failed" );
933 /* Read from a file and write its contents to a pipe. */
934 while ( i_in > 0 && !p_object->b_die )
937 if ( !WriteFile( hChildStdinWr, p_in, i_in, &i_written, NULL ) )
943 /* Close the pipe handle so the child process stops reading. */
944 CloseHandle(hChildStdinWr);
946 /* Close the write end of the pipe before reading from the
947 * read end of the pipe. */
948 CloseHandle(hChildStdoutWr);
950 /* Read output from the child process. */
955 *pp_data = malloc( 1025 ); /* +1 for \0 */
957 while ( !p_object->b_die )
960 if ( !ReadFile( hChildStdoutRd, &(*pp_data)[*pi_data], 1024, &i_read,
965 *pp_data = realloc( *pp_data, *pi_data + 1025 );
968 while ( !p_object->b_die
969 && !GetExitCodeProcess( piProcInfo.hProcess, &i_status )
970 && i_status != STILL_ACTIVE )
973 CloseHandle(piProcInfo.hProcess);
974 CloseHandle(piProcInfo.hThread);
978 "child %s returned with error code %ld",
979 ppsz_argv[0], i_status );
982 msg_Err( p_object, "vlc_execve called but no implementation is available" );
987 if (*pp_data == NULL)
990 (*pp_data)[*pi_data] = '\0';