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 /*****************************************************************************
79 *****************************************************************************/
80 #if !defined( HAVE_STRNLEN )
81 size_t vlc_strnlen( const char *psz, size_t n )
83 const char *psz_end = memchr( psz, 0, n );
84 return psz_end ? (size_t)( psz_end - psz ) : n;
88 /*****************************************************************************
89 * strcasecmp: compare two strings ignoring case
90 *****************************************************************************/
91 #if !defined( HAVE_STRCASECMP ) && !defined( HAVE_STRICMP )
92 int vlc_strcasecmp( const char *s1, const char *s2 )
95 if( !s1 || !s2 ) return -1;
102 if( c1 != c2 ) return (c1 < c2 ? -1 : 1);
106 if( !*s1 && !*s2 ) return 0;
107 else return (*s1 ? 1 : -1);
111 /*****************************************************************************
112 * strncasecmp: compare n chars from two strings ignoring case
113 *****************************************************************************/
114 #if !defined( HAVE_STRNCASECMP ) && !defined( HAVE_STRNICMP )
115 int vlc_strncasecmp( const char *s1, const char *s2, size_t n )
118 if( !s1 || !s2 ) return -1;
120 while( n > 0 && *s1 && *s2 )
125 if( c1 != c2 ) return (c1 < c2 ? -1 : 1);
129 if( !n || (!*s1 && !*s2) ) return 0;
130 else return (*s1 ? 1 : -1);
134 /******************************************************************************
135 * strcasestr: find a substring (little) in another substring (big)
136 * Case sensitive. Return NULL if not found, return big if little == null
137 *****************************************************************************/
138 #if !defined( HAVE_STRCASESTR ) && !defined( HAVE_STRISTR )
139 char * vlc_strcasestr( const char *psz_big, const char *psz_little )
141 char *p_pos = (char *)psz_big;
143 if( !psz_big || !psz_little || !*psz_little ) return p_pos;
147 if( toupper( *p_pos ) == toupper( *psz_little ) )
149 char * psz_cur1 = p_pos + 1;
150 char * psz_cur2 = (char *)psz_little + 1;
151 while( *psz_cur1 && *psz_cur2 &&
152 toupper( *psz_cur1 ) == toupper( *psz_cur2 ) )
157 if( !*psz_cur2 ) return p_pos;
165 /*****************************************************************************
167 *****************************************************************************/
168 #if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
169 int vlc_vasprintf(char **strp, const char *fmt, va_list ap)
171 /* Guess we need no more than 100 bytes. */
173 char *p = malloc( i_size );
184 /* Try to print in the allocated space. */
185 n = vsnprintf( p, i_size, fmt, ap );
187 /* If that worked, return the string. */
188 if (n > -1 && n < i_size)
193 /* Else try again with more space. */
194 if (n > -1) /* glibc 2.1 */
196 i_size = n+1; /* precisely what is needed */
200 i_size *= 2; /* twice the old size */
202 if( (p = realloc( p, i_size ) ) == NULL)
211 /*****************************************************************************
213 *****************************************************************************/
214 #if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS)
215 int vlc_asprintf( char **strp, const char *fmt, ... )
220 va_start( args, fmt );
221 i_ret = vasprintf( strp, fmt, args );
228 /*****************************************************************************
229 * strtoll: convert a string to a 64 bits int.
230 *****************************************************************************/
231 #if !defined( HAVE_STRTOLL )
232 int64_t vlc_strtoll( const char *nptr, char **endptr, int base )
235 int sign = 1, newbase = base ? base : 10;
237 while( isspace(*nptr) ) nptr++;
245 /* Try to detect base */
258 if( base && newbase != base )
260 if( endptr ) *endptr = (char *)nptr;
267 while( *nptr >= '0' && *nptr <= '9' )
270 i_value += ( *nptr++ - '0' );
272 if( endptr ) *endptr = (char *)nptr;
276 while( (*nptr >= '0' && *nptr <= '9') ||
277 (*nptr >= 'a' && *nptr <= 'f') ||
278 (*nptr >= 'A' && *nptr <= 'F') )
281 if(*nptr >= '0' && *nptr <= '9') i_valc = *nptr - '0';
282 else if(*nptr >= 'a' && *nptr <= 'f') i_valc = *nptr - 'a' +10;
283 else if(*nptr >= 'A' && *nptr <= 'F') i_valc = *nptr - 'A' +10;
288 if( endptr ) *endptr = (char *)nptr;
292 i_value = strtol( nptr, endptr, newbase );
296 return i_value * sign;
301 * Copy a string to a sized buffer. The result is always nul-terminated
302 * (contrary to strncpy()).
304 * @param dest destination buffer
305 * @param src string to be copied
306 * @param len maximum number of characters to be copied plus one for the
309 * @return strlen(src)
312 extern size_t vlc_strlcpy (char *tgt, const char *src, size_t bufsize)
316 for (length = 1; (length < bufsize) && *src; length++)
329 /*****************************************************************************
330 * vlc_*dir_wrapper: wrapper under Windows to return the list of drive letters
331 * when called with an empty argument or just '\'
332 *****************************************************************************/
333 #if defined(WIN32) && !defined(UNDER_CE)
336 typedef struct vlc_DIR
340 struct _wdirent dd_dir;
344 void *vlc_wopendir( const wchar_t *wpath )
346 vlc_DIR *p_dir = NULL;
347 _WDIR *p_real_dir = NULL;
349 if ( wpath == NULL || wpath[0] == '\0'
350 || (wcscmp (wpath, L"\\") == 0) )
352 /* Special mode to list drive letters */
353 p_dir = malloc( sizeof(vlc_DIR) );
356 p_dir->p_real_dir = NULL;
357 p_dir->i_drives = GetLogicalDrives();
358 return (void *)p_dir;
361 p_real_dir = _wopendir( wpath );
362 if ( p_real_dir == NULL )
365 p_dir = malloc( sizeof(vlc_DIR) );
368 _wclosedir( p_real_dir );
371 p_dir->p_real_dir = p_real_dir;
373 assert (wpath[0]); // wpath[1] is defined
374 p_dir->b_insert_back = !wcscmp (wpath + 1, L":\\");
375 return (void *)p_dir;
378 struct _wdirent *vlc_wreaddir( void *_p_dir )
380 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
384 if ( p_dir->p_real_dir != NULL )
386 if ( p_dir->b_insert_back )
388 /* Adds "..", gruik! */
389 p_dir->dd_dir.d_ino = 0;
390 p_dir->dd_dir.d_reclen = 0;
391 p_dir->dd_dir.d_namlen = 2;
392 wcscpy( p_dir->dd_dir.d_name, L".." );
393 p_dir->b_insert_back = false;
394 return &p_dir->dd_dir;
397 return _wreaddir( p_dir->p_real_dir );
400 /* Drive letters mode */
401 i_drives = p_dir->i_drives;
403 return NULL; /* end */
405 for ( i = 0; i < sizeof(DWORD)*8; i++, i_drives >>= 1 )
406 if ( i_drives & 1 ) break;
409 return NULL; /* this should not happen */
411 swprintf( p_dir->dd_dir.d_name, L"%c:\\", 'A' + i );
412 p_dir->dd_dir.d_namlen = wcslen(p_dir->dd_dir.d_name);
413 p_dir->i_drives &= ~(1UL << i);
414 return &p_dir->dd_dir;
417 int vlc_wclosedir( void *_p_dir )
419 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
422 if ( p_dir->p_real_dir != NULL )
423 i_ret = _wclosedir( p_dir->p_real_dir );
429 void vlc_rewinddir( void *_p_dir )
431 vlc_DIR *p_dir = (vlc_DIR *)_p_dir;
433 if ( p_dir->p_real_dir != NULL )
434 _wrewinddir( p_dir->p_real_dir );
438 /*****************************************************************************
439 * scandir: scan a directory alpha-sorted
440 *****************************************************************************/
441 #if !defined( HAVE_SCANDIR )
442 /* FIXME: I suspect this is dead code -> utf8_scandir */
448 int vlc_alphasort( const struct dirent **a, const struct dirent **b )
450 return strcoll( (*a)->d_name, (*b)->d_name );
453 int vlc_scandir( const char *name, struct dirent ***namelist,
454 int (*filter) ( const struct dirent * ),
455 int (*compar) ( const struct dirent **,
456 const struct dirent ** ) )
459 struct dirent * p_content;
460 struct dirent ** pp_list;
463 if( !namelist || !( p_dir = opendir( name ) ) ) return -1;
467 while( ( p_content = readdir( p_dir ) ) )
469 if( filter && !filter( p_content ) )
473 pp_list = realloc( pp_list, ( ret + 1 ) * sizeof( struct dirent * ) );
474 size = sizeof( struct dirent ) + strlen( p_content->d_name ) + 1;
475 pp_list[ret] = malloc( size );
478 memcpy( pp_list[ret], p_content, size );
483 /* Continuing is useless when no more memory can be allocted,
484 * so better return what we have found.
495 qsort( pp_list, ret, sizeof( struct dirent * ),
496 (int (*)(const void *, const void *)) compar );
506 * gettext callbacks for plugins.
507 * LibVLC links libintl statically on Windows.
509 char *vlc_dgettext( const char *package, const char *msgid )
511 return dgettext( package, msgid );
516 * In-tree plugins share their gettext domain with LibVLC.
518 char *vlc_gettext( const char *msgid )
520 return dgettext( PACKAGE_NAME, msgid );
523 /*****************************************************************************
524 * count_utf8_string: returns the number of characters in the string.
525 *****************************************************************************/
526 static int count_utf8_string( const char *psz_string )
528 int i = 0, i_count = 0;
529 while( psz_string[ i ] != 0 )
531 if( ((unsigned char *)psz_string)[ i ] < 0x80UL ) i_count++;
537 /*****************************************************************************
538 * wraptext: inserts \n at convenient places to wrap the text.
539 * Returns the modified string in a new buffer.
540 *****************************************************************************/
541 char *vlc_wraptext( const char *psz_text, int i_line )
544 char *psz_line, *psz_new_text;
546 psz_line = psz_new_text = strdup( psz_text );
548 i_len = count_utf8_string( psz_text );
550 while( i_len > i_line )
552 /* Look if there is a newline somewhere. */
553 char *psz_parser = psz_line;
555 while( i_count <= i_line && *psz_parser != '\n' )
557 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
561 if( *psz_parser == '\n' )
563 i_len -= (i_count + 1);
564 psz_line = psz_parser + 1;
568 /* Find the furthest space. */
569 while( psz_parser > psz_line && *psz_parser != ' ' )
571 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser--;
575 if( *psz_parser == ' ' )
578 i_len -= (i_count + 1);
579 psz_line = psz_parser + 1;
583 /* Wrapping has failed. Find the first space or newline */
584 while( i_count < i_len && *psz_parser != ' ' && *psz_parser != '\n' )
586 while( *((unsigned char *)psz_parser) >= 0x80UL ) psz_parser++;
590 if( i_count < i_len ) *psz_parser = '\n';
591 i_len -= (i_count + 1);
592 psz_line = psz_parser + 1;
598 /*****************************************************************************
600 *****************************************************************************/
601 vlc_iconv_t vlc_iconv_open( const char *tocode, const char *fromcode )
603 #if defined(HAVE_ICONV)
604 return iconv_open( tocode, fromcode );
610 size_t vlc_iconv( vlc_iconv_t cd, const char **inbuf, size_t *inbytesleft,
611 char **outbuf, size_t *outbytesleft )
613 #if defined(HAVE_ICONV)
614 return iconv( cd, (ICONV_CONST char **)inbuf, inbytesleft,
615 outbuf, outbytesleft );
619 if (inbytesleft == NULL || outbytesleft == NULL)
624 i_bytes = __MIN(*inbytesleft, *outbytesleft);
625 if( !inbuf || !outbuf || !i_bytes ) return (size_t)(-1);
626 memcpy( *outbuf, *inbuf, i_bytes );
629 inbytesleft -= i_bytes;
630 outbytesleft -= i_bytes;
635 int vlc_iconv_close( vlc_iconv_t cd )
637 #if defined(HAVE_ICONV)
638 return iconv_close( cd );
644 /*****************************************************************************
646 * (adapted from libavcodec, author Michael Niedermayer <michaelni@gmx.at>)
647 *****************************************************************************/
648 bool vlc_ureduce( unsigned *pi_dst_nom, unsigned *pi_dst_den,
649 uint64_t i_nom, uint64_t i_den, uint64_t i_max )
661 i_gcd = GCD( i_nom, i_den );
665 if( i_max == 0 ) i_max = INT64_C(0xFFFFFFFF);
667 if( i_nom > i_max || i_den > i_max )
669 uint64_t i_a0_num = 0, i_a0_den = 1, i_a1_num = 1, i_a1_den = 0;
674 uint64_t i_x = i_nom / i_den;
675 uint64_t i_a2n = i_x * i_a1_num + i_a0_num;
676 uint64_t i_a2d = i_x * i_a1_den + i_a0_den;
678 if( i_a2n > i_max || i_a2d > i_max ) break;
682 i_a0_num = i_a1_num; i_a0_den = i_a1_den;
683 i_a1_num = i_a2n; i_a1_den = i_a2d;
684 if( i_nom == 0 ) break;
685 i_x = i_nom; i_nom = i_den; i_den = i_x;
697 /*************************************************************************
698 * vlc_execve: Execute an external program with a given environment,
699 * wait until it finishes and return its standard output
700 *************************************************************************/
701 int __vlc_execve( vlc_object_t *p_object, int i_argc, char *const *ppsz_argv,
702 char *const *ppsz_env, const char *psz_cwd,
703 const char *p_in, size_t i_in,
704 char **pp_data, size_t *pi_data )
706 (void)i_argc; // <-- hmph
708 # define BUFSIZE 1024
709 int fds[2], i_status;
711 if (socketpair (AF_LOCAL, SOCK_STREAM, 0, fds))
715 if ((fds[0] > 2) && (fds[1] > 2))
721 msg_Err (p_object, "unable to fork (%m)");
730 pthread_sigmask (SIG_SETMASK, &set, NULL);
733 * Like it or not, close can fail (and not only with EBADF)
735 if ((close (0) == 0) && (close (1) == 0) && (close (2) == 0)
736 && (dup (fds[1]) == 0) && (dup (fds[1]) == 1)
737 && (open ("/dev/null", O_RDONLY) == 2)
738 && ((psz_cwd == NULL) || (chdir (psz_cwd) == 0)))
739 execve (ppsz_argv[0], ppsz_argv, ppsz_env);
753 shutdown (fds[0], SHUT_WR);
755 while (!p_object->b_die)
757 struct pollfd ufd[1];
758 memset (ufd, 0, sizeof (ufd));
760 ufd[0].events = POLLIN;
763 ufd[0].events |= POLLOUT;
765 if (poll (ufd, 1, 10) <= 0)
768 if (ufd[0].revents & ~POLLOUT)
770 char *ptr = realloc (*pp_data, *pi_data + BUFSIZE + 1);
772 break; /* safely abort */
776 ssize_t val = read (fds[0], ptr + *pi_data, BUFSIZE);
781 shutdown (fds[0], SHUT_RD);
789 if (ufd[0].revents & POLLOUT)
791 ssize_t val = write (fds[0], p_in, i_in);
797 shutdown (fds[0], SHUT_WR);
809 while (waitpid (pid, &i_status, 0) == -1);
811 if (WIFEXITED (i_status))
813 i_status = WEXITSTATUS (i_status);
815 msg_Warn (p_object, "child %s (PID %d) exited with error code %d",
816 ppsz_argv[0], (int)pid, i_status);
819 if (WIFSIGNALED (i_status)) // <-- this should be redumdant a check
821 i_status = WTERMSIG (i_status);
822 msg_Warn (p_object, "child %s (PID %d) exited on signal %d (%s)",
823 ppsz_argv[0], (int)pid, i_status, strsignal (i_status));
826 #elif defined( WIN32 ) && !defined( UNDER_CE )
827 SECURITY_ATTRIBUTES saAttr;
828 PROCESS_INFORMATION piProcInfo;
829 STARTUPINFO siStartInfo;
830 BOOL bFuncRetn = FALSE;
831 HANDLE hChildStdinRd, hChildStdinWr, hChildStdoutRd, hChildStdoutWr;
833 char *psz_cmd = NULL, *p_env = NULL, *p = NULL;
837 /* Set the bInheritHandle flag so pipe handles are inherited. */
838 saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
839 saAttr.bInheritHandle = TRUE;
840 saAttr.lpSecurityDescriptor = NULL;
842 /* Create a pipe for the child process's STDOUT. */
843 if ( !CreatePipe( &hChildStdoutRd, &hChildStdoutWr, &saAttr, 0 ) )
845 msg_Err( p_object, "stdout pipe creation failed" );
849 /* Ensure the read handle to the pipe for STDOUT is not inherited. */
850 SetHandleInformation( hChildStdoutRd, HANDLE_FLAG_INHERIT, 0 );
852 /* Create a pipe for the child process's STDIN. */
853 if ( !CreatePipe( &hChildStdinRd, &hChildStdinWr, &saAttr, 0 ) )
855 msg_Err( p_object, "stdin pipe creation failed" );
859 /* Ensure the write handle to the pipe for STDIN is not inherited. */
860 SetHandleInformation( hChildStdinWr, HANDLE_FLAG_INHERIT, 0 );
862 /* Set up members of the PROCESS_INFORMATION structure. */
863 ZeroMemory( &piProcInfo, sizeof(PROCESS_INFORMATION) );
865 /* Set up members of the STARTUPINFO structure. */
866 ZeroMemory( &siStartInfo, sizeof(STARTUPINFO) );
867 siStartInfo.cb = sizeof(STARTUPINFO);
868 siStartInfo.hStdError = hChildStdoutWr;
869 siStartInfo.hStdOutput = hChildStdoutWr;
870 siStartInfo.hStdInput = hChildStdinRd;
871 siStartInfo.wShowWindow = SW_HIDE;
872 siStartInfo.dwFlags |= STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
874 /* Set up the command line. */
875 psz_cmd = malloc(32768);
880 ppsz_parser = &ppsz_argv[0];
881 while ( ppsz_parser[0] != NULL && i_size > 0 )
883 /* Protect the last argument with quotes ; the other arguments
884 * are supposed to be already protected because they have been
885 * passed as a command-line option. */
886 if ( ppsz_parser[1] == NULL )
888 strncat( psz_cmd, "\"", i_size );
891 strncat( psz_cmd, *ppsz_parser, i_size );
892 i_size -= strlen( *ppsz_parser );
893 if ( ppsz_parser[1] == NULL )
895 strncat( psz_cmd, "\"", i_size );
898 strncat( psz_cmd, " ", i_size );
903 /* Set up the environment. */
904 p = p_env = malloc(32768);
912 ppsz_parser = &ppsz_env[0];
913 while ( *ppsz_parser != NULL && i_size > 0 )
915 memcpy( p, *ppsz_parser,
916 __MIN((int)(strlen(*ppsz_parser) + 1), i_size) );
917 p += strlen(*ppsz_parser) + 1;
918 i_size -= strlen(*ppsz_parser) + 1;
923 /* Create the child process. */
924 bFuncRetn = CreateProcess( NULL,
925 psz_cmd, // command line
926 NULL, // process security attributes
927 NULL, // primary thread security attributes
928 TRUE, // handles are inherited
932 &siStartInfo, // STARTUPINFO pointer
933 &piProcInfo ); // receives PROCESS_INFORMATION
938 if ( bFuncRetn == 0 )
940 msg_Err( p_object, "child creation failed" );
944 /* Read from a file and write its contents to a pipe. */
945 while ( i_in > 0 && !p_object->b_die )
948 if ( !WriteFile( hChildStdinWr, p_in, i_in, &i_written, NULL ) )
954 /* Close the pipe handle so the child process stops reading. */
955 CloseHandle(hChildStdinWr);
957 /* Close the write end of the pipe before reading from the
958 * read end of the pipe. */
959 CloseHandle(hChildStdoutWr);
961 /* Read output from the child process. */
966 *pp_data = malloc( 1025 ); /* +1 for \0 */
968 while ( !p_object->b_die )
971 if ( !ReadFile( hChildStdoutRd, &(*pp_data)[*pi_data], 1024, &i_read,
976 *pp_data = realloc( *pp_data, *pi_data + 1025 );
979 while ( !p_object->b_die
980 && !GetExitCodeProcess( piProcInfo.hProcess, &i_status )
981 && i_status != STILL_ACTIVE )
984 CloseHandle(piProcInfo.hProcess);
985 CloseHandle(piProcInfo.hThread);
989 "child %s returned with error code %ld",
990 ppsz_argv[0], i_status );
993 msg_Err( p_object, "vlc_execve called but no implementation is available" );
998 if (*pp_data == NULL)
1001 (*pp_data)[*pi_data] = '\0';