A bit of vlc/libvlc cleanup:

[vlc] / include / vlc / vlc.h

diff --git a/include/vlc/vlc.h b/include/vlc/vlc.h
index 91295f62ac10dac5cdae3dbda53ccf997974b89e..0f1144632852385750424fde6f073d11324f3908 100644 (file)
--- a/include/vlc/vlc.h
+++ b/include/vlc/vlc.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
- * vlc.h: global header for vlc
+ * vlc.h: global header for libvlc (old-style)
  *****************************************************************************
- * Copyright (C) 1998-2004 VideoLAN
+ * Copyright (C) 1998-2004 the VideoLAN team
  * $Id$
  *
  * Authors: Vincent Seguin <seguin@via.ecp.fr>
@@ -21,12 +21,13 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /**
- * \defgroup libvlc Libvlc
+ * \defgroup libvlc_old Libvlc Old
  * This is libvlc, the base library of the VLC program.
+ * This is the legacy API. Please consider using the new libvlc API
  *
  * @{
  */
@@ -46,6 +47,12 @@ typedef int vlc_bool_t;
 typedef struct vlc_list_t vlc_list_t;
 typedef struct vlc_object_t vlc_object_t;
 
+#if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( __MINGW32__ )
+typedef signed __int64 vlc_int64_t;
+# else
+typedef signed long long vlc_int64_t;
+#endif
+
 /**
  * \defgroup var_type Variable types
  * These are the different types a vlc variable can have.
@@ -79,12 +86,7 @@ typedef union
     void *          p_address;
     vlc_object_t *  p_object;
     vlc_list_t *    p_list;
-
-#if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( __MINGW32__ )
-    signed __int64   i_time;
-# else
-    signed long long i_time;
-#endif
+    vlc_int64_t     i_time;
 
     struct { char *psz_name; int i_object_id; } var;
 
@@ -121,6 +123,7 @@ struct vlc_list_t
 #define VLC_EBADVAR        -31                         /* Bad variable value */
 
 #define VLC_EEXIT         -255                             /* Program exited */
+#define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
 #define VLC_EGENERIC      -666                              /* Generic error */
 
 /*****************************************************************************
@@ -135,24 +138,25 @@ struct vlc_list_t
 
 /* Used by VLC_AddTarget() */
 #define PLAYLIST_INSERT          0x0001
-#define PLAYLIST_REPLACE         0x0002
-#define PLAYLIST_APPEND          0x0004
-#define PLAYLIST_GO              0x0008
-#define PLAYLIST_CHECK_INSERT    0x0010
+#define PLAYLIST_APPEND          0x0002
+#define PLAYLIST_GO              0x0004
+#define PLAYLIST_PREPARSE        0x0008
+#define PLAYLIST_SPREPARSE       0x0010
 
 #define PLAYLIST_END           -666
 
 /*****************************************************************************
  * Required internal headers
  *****************************************************************************/
-#if defined( __VLC__ )
+#if defined( __LIBVLC__ )
 #   include "vlc_common.h"
 #endif
 
 /*****************************************************************************
  * Exported libvlc API
  *****************************************************************************/
-
+#if !defined( __LIBVLC__ )
+/* Otherwise they are declared and exported in vlc_common.h */
 /**
  * Retrieve libvlc version
  *
@@ -160,6 +164,48 @@ struct vlc_list_t
  */
 char const * VLC_Version ( void );
 
+/**
+ * Retrieve libvlc compile time
+ *
+ * \return a string containing the libvlc compile time
+ */
+char const * VLC_CompileTime ( void );
+
+/**
+ * Retrieve the username of the libvlc builder
+ *
+ * \return a string containing the username of the libvlc builder
+ */
+char const * VLC_CompileBy ( void );
+
+/**
+ * Retrieve the host of the libvlc builder
+ *
+ * \return a string containing the host of the libvlc builder
+ */
+char const * VLC_CompileHost ( void );
+
+/**
+ * Retrieve the domain name of the host of the libvlc builder
+ *
+ * \return a string containing the domain name of the host of the libvlc builder
+ */
+char const * VLC_CompileDomain ( void );
+
+/**
+ * Retrieve libvlc compiler version
+ *
+ * \return a string containing the libvlc compiler version
+ */
+char const * VLC_Compiler ( void );
+
+/**
+ * Retrieve libvlc changeset
+ *
+ * \return a string containing the libvlc subversion changeset
+ */
+char const * VLC_Changeset ( void );
+
 /**
  * Return an error string
  *
@@ -168,6 +214,8 @@ char const * VLC_Version ( void );
  */
 char const * VLC_Error ( int i_err );
 
+#endif /* __LIBVLC__ */
+
 /**
  * Initialize libvlc
  *
@@ -239,7 +287,7 @@ int     VLC_CleanUp( int );
  *
  * This function requests the running threads to finish, waits for their
  * termination, and destroys their structure.
- * Then it will de-init all VLC object initializations. 
+ * Then it will de-init all VLC object initializations.
  *
  * \param i_object a vlc object id
  * \return VLC_SUCCESS on success
@@ -525,4 +573,10 @@ int             VLC_FullScreen( int );
 }
 # endif
 
+#define LICENSE_MSG \
+  _("This program comes with NO WARRANTY, to the extent permitted by " \
+    "law.\nYou may redistribute it under the terms of the GNU General " \
+    "Public License;\nsee the file named COPYING for details.\n" \
+    "Written by the VideoLAN team; see the AUTHORS file.\n")
+
 #endif /* <vlc/vlc.h> */