/*
 * Xephyr - A kdrive X server thats runs in a host X window.
 *          Authored by Matthew Allum <mallum@openedhand.com>
 * 
 * Copyright © 2007 OpenedHand Ltd 
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of OpenedHand Ltd not be used in
 * advertising or publicity pertaining to distribution of the software without
 * specific, written prior permission. OpenedHand Ltd makes no
 * representations about the suitability of this software for any purpose.  It
 * is provided "as is" without express or implied warranty.
 *
 * OpenedHand Ltd DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL OpenedHand Ltd BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 *
 * Authors:
 *    Dodji Seketeli <dodji@openedhand.com>
 */
#ifndef __EPHYRHOSTVIDEO_H__
#define __EPHYRHOSTVIDEO_H__

typedef void* EphyrHostXVAdaptor ;
typedef struct _EphyrHostXVAdaptorArray EphyrHostXVAdaptorArray ;

typedef struct _EphyrHostVideoFormat {
    char depth ;
    short visual_class;
} EphyrHostVideoFormat ;

typedef struct _EphyrHostRational {
    int numerator ;
    int denominator ;
} EphyrHostRational;

typedef struct _EphyrHostEncoding {
    int id ;
    char *name ;
    unsigned short width, height ;
    EphyrHostRational rate ;
} EphyrHostEncoding ;

typedef struct _EphyrHostAttribute {
    int flags;
    int min_value;
    int max_value;
    char *name;
} EphyrHostAttribute ;

typedef struct _EphyrHostImageFormat {
    int id;                      /* Unique descriptor for the format */
    int type;                    /* XvRGB, XvYUV */
    int byte_order;              /* LSBFirst, MSBFirst */
    char guid[16];               /* Globally Unique IDentifier */
    int bits_per_pixel;
    int format;                  /* XvPacked, XvPlanar */
    int num_planes;

    /* for RGB formats only */
    int depth;
    unsigned int red_mask;
    unsigned int green_mask;
    unsigned int blue_mask;

    /* for YUV formats only */
    unsigned int y_sample_bits;
    unsigned int u_sample_bits;
    unsigned int v_sample_bits;
    unsigned int horz_y_period;
    unsigned int horz_u_period;
    unsigned int horz_v_period;
    unsigned int vert_y_period;
    unsigned int vert_u_period;
    unsigned int vert_v_period;
    char component_order[32];    /* eg. UYVY */
    int scanline_order;          /* XvTopToBottom, XvBottomToTop */
} EphyrHostImageFormat ;

/*
 * host adaptor array
 */
Bool EphyrHostXVQueryAdaptors (EphyrHostXVAdaptorArray **a_adaptors) ;
void EphyrHostXVAdaptorArrayDelete (EphyrHostXVAdaptorArray *a_adaptors) ;
int EphyrHostXVAdaptorArrayGetSize (const EphyrHostXVAdaptorArray *a_this) ;
EphyrHostXVAdaptor* EphyrHostXVAdaptorArrayAt (const EphyrHostXVAdaptorArray *a_this,
                                               int a_index) ;

/*
 * host adaptor
 */

char EphyrHostXVAdaptorGetType (const EphyrHostXVAdaptor *a_this) ;
const char* EphyrHostXVAdaptorGetName (const EphyrHostXVAdaptor *a_this) ;
EphyrHostVideoFormat* EphyrHostXVAdaptorGetVideoFormats
                                                (const EphyrHostXVAdaptor *a_this,
                                                 int *a_nb_formats) ;
int EphyrHostXVAdaptorGetNbPorts (const EphyrHostXVAdaptor *a_this) ;
int EphyrHostXVAdaptorGetFirstPortID (const EphyrHostXVAdaptor *a_this) ;

/*
 * encoding
 */
Bool EphyrHostXVQueryEncodings (int a_port_id,
                                EphyrHostEncoding **a_encodings,
                                unsigned int *a_num_encodings) ;

void EphyrHostEncodingsDelete (EphyrHostEncoding *a_encodings,
                               int a_num_encodings) ;

/*
 * attribute
 */
Bool EphyrHostXVQueryPortAttributes (int a_port_id,
                                     EphyrHostAttribute **a_attributes,
                                     int *a_num_attributes) ;

void EphyrHostAttributesDelete (EphyrHostAttribute *a_attributes) ;
/*
 * image format
 */

Bool EphyrHostXVQueryImageFormats (int a_port_id,
                                   EphyrHostImageFormat **a_formats,
                                   int *a_num_format) ;

#endif /*__EPHYRHOSTVIDEO_H__*/