include/linux/dvb/video.h

   1 /*
   2  * video.h
   3  *
   4  * Copyright (C) 2000 Marcus Metzler <marcus@convergence.de>
   5  *                  & Ralph  Metzler <ralph@convergence.de>
   6  *                    for convergence integrated media GmbH
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 2.1
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21  *
  22  */
  23
  24 #ifndef _DVBVIDEO_H_
  25 #define _DVBVIDEO_H_
  26
  27 #include <linux/compiler.h>
  28
  29 #ifdef __KERNEL__
  30 #include <linux/types.h>
  31 #else
  32 #include <stdint.h>
  33 #include <time.h>
  34 #endif
  35
  36
  37 typedef enum {
  38         VIDEO_FORMAT_4_3,     /* Select 4:3 format */
  39         VIDEO_FORMAT_16_9,    /* Select 16:9 format. */
  40         VIDEO_FORMAT_221_1    /* 2.21:1 */
  41 } video_format_t;
  42
  43
  44 typedef enum {
  45          VIDEO_SYSTEM_PAL,
  46          VIDEO_SYSTEM_NTSC,
  47          VIDEO_SYSTEM_PALN,
  48          VIDEO_SYSTEM_PALNc,
  49          VIDEO_SYSTEM_PALM,
  50          VIDEO_SYSTEM_NTSC60,
  51          VIDEO_SYSTEM_PAL60,
  52          VIDEO_SYSTEM_PALM60
  53 } video_system_t;
  54
  55
  56 typedef enum {
  57         VIDEO_PAN_SCAN,       /* use pan and scan format */
  58         VIDEO_LETTER_BOX,     /* use letterbox format */
  59         VIDEO_CENTER_CUT_OUT  /* use center cut out format */
  60 } video_displayformat_t;
  61
  62 typedef struct {
  63         int w;
  64         int h;
  65         video_format_t aspect_ratio;
  66 } video_size_t;
  67
  68 typedef enum {
  69         VIDEO_SOURCE_DEMUX, /* Select the demux as the main source */
  70         VIDEO_SOURCE_MEMORY /* If this source is selected, the stream
  71                                comes from the user through the write
  72                                system call */
  73 } video_stream_source_t;
  74
  75
  76 typedef enum {
  77         VIDEO_STOPPED, /* Video is stopped */
  78         VIDEO_PLAYING, /* Video is currently playing */
  79         VIDEO_FREEZED  /* Video is freezed */
  80 } video_play_state_t;
  81
  82
  83 struct video_event {
  84         int32_t type;
  85 #define VIDEO_EVENT_SIZE_CHANGED        1
  86 #define VIDEO_EVENT_FRAME_RATE_CHANGED  2
  87         time_t timestamp;
  88         union {
  89                 video_size_t size;
  90                 unsigned int frame_rate;        /* in frames per 1000sec */
  91         } u;
  92 };
  93
  94
  95 struct video_status {
  96         int                   video_blank;   /* blank video on freeze? */
  97         video_play_state_t    play_state;    /* current state of playback */
  98         video_stream_source_t stream_source; /* current source (demux/memory) */
  99         video_format_t        video_format;  /* current aspect ratio of stream*/
 100         video_displayformat_t display_format;/* selected cropping mode */
 101 };
 102
 103
 104 struct video_still_picture {
 105         char __user *iFrame;        /* pointer to a single iframe in memory */
 106         int32_t size;
 107 };
 108
 109
 110 typedef
 111 struct video_highlight {
 112         int     active;      /*    1=show highlight, 0=hide highlight */
 113         uint8_t contrast1;   /*    7- 4  Pattern pixel contrast */
 114                              /*    3- 0  Background pixel contrast */
 115         uint8_t contrast2;   /*    7- 4  Emphasis pixel-2 contrast */
 116                              /*    3- 0  Emphasis pixel-1 contrast */
 117         uint8_t color1;      /*    7- 4  Pattern pixel color */
 118                              /*    3- 0  Background pixel color */
 119         uint8_t color2;      /*    7- 4  Emphasis pixel-2 color */
 120                              /*    3- 0  Emphasis pixel-1 color */
 121         uint32_t ypos;       /*   23-22  auto action mode */
 122                              /*   21-12  start y */
 123                              /*    9- 0  end y */
 124         uint32_t xpos;       /*   23-22  button color number */
 125                              /*   21-12  start x */
 126                              /*    9- 0  end x */
 127 } video_highlight_t;
 128
 129
 130 typedef struct video_spu {
 131         int active;
 132         int stream_id;
 133 } video_spu_t;
 134
 135
 136 typedef struct video_spu_palette {      /* SPU Palette information */
 137         int length;
 138         uint8_t __user *palette;
 139 } video_spu_palette_t;
 140
 141
 142 typedef struct video_navi_pack {
 143         int length;          /* 0 ... 1024 */
 144         uint8_t data[1024];
 145 } video_navi_pack_t;
 146
 147
 148 typedef uint16_t video_attributes_t;
 149 /*   bits: descr. */
 150 /*   15-14 Video compression mode (0=MPEG-1, 1=MPEG-2) */
 151 /*   13-12 TV system (0=525/60, 1=625/50) */
 152 /*   11-10 Aspect ratio (0=4:3, 3=16:9) */
 153 /*    9- 8 permitted display mode on 4:3 monitor (0=both, 1=only pan-sca */
 154 /*    7    line 21-1 data present in GOP (1=yes, 0=no) */
 155 /*    6    line 21-2 data present in GOP (1=yes, 0=no) */
 156 /*    5- 3 source resolution (0=720x480/576, 1=704x480/576, 2=352x480/57 */
 157 /*    2    source letterboxed (1=yes, 0=no) */
 158 /*    0    film/camera mode (0=camera, 1=film (625/50 only)) */
 159
 160
 161 /* bit definitions for capabilities: */
 162 /* can the hardware decode MPEG1 and/or MPEG2? */
 163 #define VIDEO_CAP_MPEG1   1
 164 #define VIDEO_CAP_MPEG2   2
 165 /* can you send a system and/or program stream to video device?
 166    (you still have to open the video and the audio device but only
 167     send the stream to the video device) */
 168 #define VIDEO_CAP_SYS     4
 169 #define VIDEO_CAP_PROG    8
 170 /* can the driver also handle SPU, NAVI and CSS encoded data?
 171    (CSS API is not present yet) */
 172 #define VIDEO_CAP_SPU    16
 173 #define VIDEO_CAP_NAVI   32
 174 #define VIDEO_CAP_CSS    64
 175
 176
 177 #define VIDEO_STOP                 _IO('o', 21)
 178 #define VIDEO_PLAY                 _IO('o', 22)
 179 #define VIDEO_FREEZE               _IO('o', 23)
 180 #define VIDEO_CONTINUE             _IO('o', 24)
 181 #define VIDEO_SELECT_SOURCE        _IO('o', 25)
 182 #define VIDEO_SET_BLANK            _IO('o', 26)
 183 #define VIDEO_GET_STATUS           _IOR('o', 27, struct video_status)
 184 #define VIDEO_GET_EVENT            _IOR('o', 28, struct video_event)
 185 #define VIDEO_SET_DISPLAY_FORMAT   _IO('o', 29)
 186 #define VIDEO_STILLPICTURE         _IOW('o', 30, struct video_still_picture)
 187 #define VIDEO_FAST_FORWARD         _IO('o', 31)
 188 #define VIDEO_SLOWMOTION           _IO('o', 32)
 189 #define VIDEO_GET_CAPABILITIES     _IOR('o', 33, unsigned int)
 190 #define VIDEO_CLEAR_BUFFER         _IO('o',  34)
 191 #define VIDEO_SET_ID               _IO('o', 35)
 192 #define VIDEO_SET_STREAMTYPE       _IO('o', 36)
 193 #define VIDEO_SET_FORMAT           _IO('o', 37)
 194 #define VIDEO_SET_SYSTEM           _IO('o', 38)
 195 #define VIDEO_SET_HIGHLIGHT        _IOW('o', 39, video_highlight_t)
 196 #define VIDEO_SET_SPU              _IOW('o', 50, video_spu_t)
 197 #define VIDEO_SET_SPU_PALETTE      _IOW('o', 51, video_spu_palette_t)
 198 #define VIDEO_GET_NAVI             _IOR('o', 52, video_navi_pack_t)
 199 #define VIDEO_SET_ATTRIBUTES       _IO('o', 53)
 200 #define VIDEO_GET_SIZE             _IOR('o', 55, video_size_t)
 201 #define VIDEO_GET_FRAME_RATE       _IOR('o', 56, unsigned int)
 202
 203 /**
 204  * VIDEO_GET_PTS
 205  *
 206  * Read the 33 bit presentation time stamp as defined
 207  * in ITU T-REC-H.222.0 / ISO/IEC 13818-1.
 208  *
 209  * The PTS should belong to the currently played
 210  * frame if possible, but may also be a value close to it
 211  * like the PTS of the last decoded frame or the last PTS
 212  * extracted by the PES parser.
 213  */
 214 #define VIDEO_GET_PTS              _IOR('o', 57, __u64)
 215
 216 #endif /*_DVBVIDEO_H_*/