videoplugin.h

Go to the documentation of this file.

// LiVES - video playback plugin header
// (c) G. Finch 2003 - 2008 <salsaman@xs4all.nl,salsaman@gmail.com>
// released under the GNU GPL 3 or later
// see file COPYING or www.gnu.org for details

#ifndef __VIDPLUGIN_H__
#define __VIDPLUGIN_H__

#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */

#include <inttypes.h>

#ifdef HAVE_SYSTEM_WEED
#include <weed/weed-palettes.h>
#else
#include "../../../../libweed/weed-palettes.h"
#endif

#ifndef PRId64

#ifndef __WORDSIZE
#if defined __x86_64__
# define __WORDSIZE     64
#ifndef __WORDSIZE_COMPAT32
# define __WORDSIZE_COMPAT32    1
#endif
#else
# define __WORDSIZE     32
#endif
#endif // __WORDSIZE

#ifndef __PRI64_PREFIX
# if __WORDSIZE == 64
#  define __PRI64_PREFIX        "l"
# else
#  define __PRI64_PREFIX        "ll"
# endif
#endif

# define PRId64         __PRI64_PREFIX "d"
# define PRIu64         __PRI64_PREFIX "u"
#endif // ifndef PRI64d

typedef void *(func_ptr)(void *);

#ifndef IS_MINGW
typedef int boolean;
#endif
#undef TRUE
#undef FALSE

#define TRUE 1
#define FALSE 0

#ifndef ABS
#define ABS(a) (a>0?a:-a)
#endif

// Warning - CPU_BITS macro evaluates only at runtime (uses sizeof)
#define CPU_BITS ((sizeof(void *))<<3)

// all playback modules need to implement these functions, unless they are marked (optional)

const char *module_check_init(void);
const char *version(void);
const char *get_description(void);   
const char *get_init_rfx(void);   

const void **get_play_params(func_ptr func);

const int *get_palette_list(void);

boolean set_palette(int palette);

uint64_t get_capabilities(int palette);

#define VPP_CAN_RESIZE    1<<0
#define VPP_CAN_RETURN    1<<1
#define VPP_LOCAL_DISPLAY 1<<2


boolean init_screen(int width, int height, boolean fullscreen, uint64_t window_id, int argc, char **argv);

boolean render_frame(int hsize, int vsize, int64_t timecode, void **pixel_data, void **return_data,
                     void **play_params);

void exit_screen(int16_t mouse_x, int16_t mouse_y);

void module_unload(void);


// extra functions for fixed fps
const char *get_fps_list(int palette);
boolean set_fps(double fps);

// mandatory function for display plugins (VPP_LOCAL_DISPLAY)

typedef boolean(*keyfunc)(boolean down, uint16_t unicode, uint16_t keymod);

#define MOD_CONTROL_MASK 1<<2
#define MOD_ALT_MASK 1<<3
#define MOD_NEEDS_TRANSLATION 1<<15

boolean send_keycodes(keyfunc);

// optional functions for yuv palettes

const int *get_yuv_palette_sampling(int palette);

const int *get_yuv_palette_clamping(int palette);

const int *get_yuv_palette_subspace(int palette);

boolean set_yuv_palette_sampling(int sampling_type);

boolean set_yuv_palette_clamping(int clamping_type);

boolean set_yuv_palette_subspace(int subspace_type);

// optional - supported audio streams :: defined in lives/src/plugins.h
const int *get_audio_fmts(void);

// ...may be expanded in the future to specify rates, #channels, sample size
// signed/endian [get_raw_audio_fmts ?]


#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif // #ifndef __VIDPLUGIN_H__