git.sesse.net Git - vlc/blob - include/vlc/control.h

   1 /*****************************************************************************
   2  * control.h: global header for mediacontrol
   3  *****************************************************************************
   4  * Copyright (C) 2005 VideoLAN (Centrale Réseaux) and its contributors
   5  * $Id: vlc.h 10101 2005-03-02 16:47:31Z robux4 $
   6  *
   7  * Authors: Olivier Aubert <olivier.aubert@liris.univ-lyon1.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 #ifndef _VLC_CONTROL_H
  25 #define _VLC_CONTROL_H 1
  26
  27 # ifdef __cplusplus
  28 extern "C" {
  29 # endif
  30
  31 #include <vlc/vlc.h>
  32
  33 #if defined( WIN32 )
  34 #define WINDOWHANDLE HWND
  35 #else
  36 #define WINDOWHANDLE int
  37 #endif
  38
  39 #ifndef true
  40 typedef int bool;
  41 #endif
  42
  43 /************************************************************************
  44  * Position Object Manipulation
  45  *************************************************************************/
  46 typedef enum  {
  47   mediacontrol_AbsolutePosition,
  48   mediacontrol_RelativePosition,
  49   mediacontrol_ModuloPosition
  50 } mediacontrol_PositionOrigin;
  51
  52 typedef enum {
  53   mediacontrol_ByteCount,
  54   mediacontrol_SampleCount,
  55   mediacontrol_MediaTime
  56 } mediacontrol_PositionKey;
  57
  58 typedef struct {
  59   mediacontrol_PositionOrigin origin;
  60   mediacontrol_PositionKey key;
  61   long value;
  62 } mediacontrol_Position;
  63
  64 typedef struct {
  65   int  width;
  66   int  height;
  67   long type;
  68   long long date;
  69   int  size;
  70   char* data;
  71 } mediacontrol_RGBPicture;
  72
  73 typedef struct {
  74   int size;
  75   char** data;
  76 } mediacontrol_PlaylistSeq;
  77
  78 typedef struct {
  79   int code;
  80   char* message;
  81 } mediacontrol_Exception;
  82
  83 /* Exception codes */
  84 #define mediacontrol_PositionKeyNotSupported    1
  85 #define mediacontrol_PositionOriginNotSupported 2
  86 #define mediacontrol_InvalidPosition            3
  87 #define mediacontrol_PlaylistException          4
  88 #define mediacontrol_InternalException          5
  89
  90 typedef struct {
  91   vlc_object_t  *p_vlc;
  92   playlist_t    *p_playlist;
  93   intf_thread_t *p_intf;
  94   int           vlc_object_id;
  95 } mediacontrol_Instance;
  96
  97 /* Cf stream_control.h */
  98 enum mediacontrol_PlayerStatusList
  99   {
 100     mediacontrol_PlayingStatus, mediacontrol_PauseStatus,
 101     mediacontrol_ForwardStatus, mediacontrol_BackwardStatus,
 102     mediacontrol_InitStatus,    mediacontrol_EndStatus,
 103     mediacontrol_UndefinedStatus
 104   };
 105 typedef enum mediacontrol_PlayerStatusList mediacontrol_PlayerStatus;
 106
 107 typedef struct {
 108     mediacontrol_PlayerStatus streamstatus;
 109     char* url;         /* The URL of the current media stream */
 110     long long position;     /* actual location in the stream (in ms) */
 111     long long length;         /* total length of the stream (in ms) */
 112   } mediacontrol_StreamInformation;
 113
 114 /**************************************************************************
 115  *  Helper functions
 116  ***************************************************************************/
 117 long long mediacontrol_unit_convert (input_thread_t *p_input,
 118                                      mediacontrol_PositionKey from,
 119                                      mediacontrol_PositionKey to,
 120                                      long long value);
 121 long long
 122 mediacontrol_position2microsecond (input_thread_t* p_input, const mediacontrol_Position * pos);
 123
 124 mediacontrol_RGBPicture* mediacontrol_RGBPicture__alloc (int datasize);
 125 void mediacontrol_RGBPicture__free (mediacontrol_RGBPicture* pic);
 126 mediacontrol_PlaylistSeq* mediacontrol_PlaylistSeq__alloc (int size);
 127 void mediacontrol_PlaylistSeq__free (mediacontrol_PlaylistSeq* ps);
 128
 129 mediacontrol_Exception* mediacontrol_exception_init(mediacontrol_Exception *exception);
 130 void mediacontrol_exception_free(mediacontrol_Exception *exception);
 131
 132 /*****************************************************************************
 133  * Core functions
 134  *****************************************************************************/
 135 mediacontrol_Instance* mediacontrol_new(char** args, mediacontrol_Exception *exception);
 136 mediacontrol_Instance* mediacontrol_new_from_object(vlc_object_t* p_object,
 137                             mediacontrol_Exception *exception);
 138
 139 mediacontrol_Position* mediacontrol_get_media_position(
 140                                        mediacontrol_Instance *self,
 141                                        mediacontrol_PositionOrigin an_origin,
 142                                        mediacontrol_PositionKey a_key,
 143                                        mediacontrol_Exception *exception);
 144 void mediacontrol_set_media_position(mediacontrol_Instance *self,
 145                                      const mediacontrol_Position* a_position,
 146                                      mediacontrol_Exception *exception);
 147 void mediacontrol_start( mediacontrol_Instance *self,
 148                          const mediacontrol_Position* a_position,
 149                          mediacontrol_Exception *exception);
 150
 151 void mediacontrol_pause(mediacontrol_Instance *self,
 152                         const mediacontrol_Position* a_position,
 153                         mediacontrol_Exception *exception);
 154
 155 void mediacontrol_resume(mediacontrol_Instance *self,
 156                          const mediacontrol_Position* a_position,
 157                          mediacontrol_Exception *exception);
 158
 159 void mediacontrol_stop(mediacontrol_Instance *self,
 160                        const mediacontrol_Position* a_position,
 161                        mediacontrol_Exception *exception);
 162 void mediacontrol_exit(mediacontrol_Instance *self);
 163
 164 void mediacontrol_playlist_add_item (mediacontrol_Instance *self,
 165                                      const char* psz_file,
 166                                      mediacontrol_Exception *exception);
 167 void mediacontrol_playlist_clear (mediacontrol_Instance *self,
 168                                   mediacontrol_Exception *exception);
 169 mediacontrol_PlaylistSeq* mediacontrol_playlist_get_list (
 170                                 mediacontrol_Instance *self,
 171                                 mediacontrol_Exception *exception);
 172
 173
 174 /*****************************************************************************
 175  * A/V functions
 176  *****************************************************************************/
 177 mediacontrol_RGBPicture* mediacontrol_snapshot (mediacontrol_Instance *self,
 178                                 const mediacontrol_Position* a_position,
 179                                 mediacontrol_Exception *exception);
 180
 181 /* Return a NULL terminated list */
 182 mediacontrol_RGBPicture** mediacontrol_all_snapshots (mediacontrol_Instance *self,
 183                                                       mediacontrol_Exception *exception);
 184
 185 // Displays the message string, between "begin" and "end" positions
 186 void mediacontrol_display_text (mediacontrol_Instance *self,
 187                                 const char* message,
 188                                 const mediacontrol_Position* begin,
 189                                 const mediacontrol_Position* end,
 190                                 mediacontrol_Exception *exception);
 191
 192 mediacontrol_StreamInformation*
 193 mediacontrol_get_stream_information(mediacontrol_Instance* self,
 194                                     mediacontrol_PositionKey a_key,
 195                                     mediacontrol_Exception *exception);
 196
 197 unsigned short mediacontrol_sound_get_volume(mediacontrol_Instance* self,
 198                                              mediacontrol_Exception *exception);
 199 void mediacontrol_sound_set_volume(mediacontrol_Instance* self,
 200                                    const unsigned short volume,
 201                                    mediacontrol_Exception *exception);
 202
 203 bool mediacontrol_set_visual(mediacontrol_Instance* self,
 204                              WINDOWHANDLE visual_id,
 205                              mediacontrol_Exception *exception);
 206
 207 # ifdef __cplusplus
 208 }
 209 # endif
 210
 211 #endif
 212