ppapi/api/pp_codecs.idl

   1 /* Copyright (c) 2014 The Chromium Authors. All rights reserved.
   2  * Use of this source code is governed by a BSD-style license that can be
   3  * found in the LICENSE file.
   4  */
   5
   6 /**
   7  * Video profiles.
   8  */
   9 enum PP_VideoProfile {
  10   PP_VIDEOPROFILE_H264BASELINE = 0,
  11   PP_VIDEOPROFILE_H264MAIN = 1,
  12   PP_VIDEOPROFILE_H264EXTENDED = 2,
  13   PP_VIDEOPROFILE_H264HIGH = 3,
  14   PP_VIDEOPROFILE_H264HIGH10PROFILE = 4,
  15   PP_VIDEOPROFILE_H264HIGH422PROFILE = 5,
  16   PP_VIDEOPROFILE_H264HIGH444PREDICTIVEPROFILE = 6,
  17   PP_VIDEOPROFILE_H264SCALABLEBASELINE = 7,
  18   PP_VIDEOPROFILE_H264SCALABLEHIGH = 8,
  19   PP_VIDEOPROFILE_H264STEREOHIGH = 9,
  20   PP_VIDEOPROFILE_H264MULTIVIEWHIGH = 10,
  21   PP_VIDEOPROFILE_VP8_ANY = 11,
  22   PP_VIDEOPROFILE_VP9_ANY = 12,
  23   PP_VIDEOPROFILE_MAX = PP_VIDEOPROFILE_VP9_ANY
  24 };
  25
  26 /**
  27  * Audio profiles.
  28  */
  29 enum PP_AudioProfile {
  30   PP_AUDIOPROFILE_OPUS = 0,
  31   PP_AUDIOPROFILE_SPEEX = 1,
  32   PP_AUDIOPROFILE_MAX = PP_AUDIOPROFILE_SPEEX
  33 };
  34
  35 /**
  36  * Hardware acceleration options.
  37  */
  38 enum PP_HardwareAcceleration {
  39   /** Create a hardware accelerated resource only. */
  40   PP_HARDWAREACCELERATION_ONLY = 0,
  41
  42   /**
  43    * Create a hardware accelerated resource if possible. Otherwise, fall back
  44    * to the software implementation.
  45    */
  46   PP_HARDWAREACCELERATION_WITHFALLBACK = 1,
  47
  48   /** Create the software implementation only. */
  49   PP_HARDWAREACCELERATION_NONE = 2,
  50
  51   PP_HARDWAREACCELERATION_LAST = PP_HARDWAREACCELERATION_NONE
  52 };
  53
  54 /**
  55  * Struct describing a decoded video picture. The decoded picture data is stored
  56  * in the GL texture corresponding to |texture_id|. The plugin can determine
  57  * which Decode call generated the picture using |decode_id|.
  58  */
  59 struct PP_VideoPicture {
  60   /**
  61    * |decode_id| parameter of the Decode call which generated this picture.
  62    * See the PPB_VideoDecoder function Decode() for more details.
  63    */
  64   uint32_t decode_id;
  65
  66   /**
  67    * Texture ID in the plugin's GL context. The plugin can use this to render
  68    * the decoded picture.
  69    */
  70   uint32_t texture_id;
  71
  72   /**
  73    * The GL texture target for the decoded picture. Possible values are:
  74    *   GL_TEXTURE_2D
  75    *   GL_TEXTURE_RECTANGLE_ARB
  76    *   GL_TEXTURE_EXTERNAL_OES
  77    *
  78    * The pixel format of the texture is GL_RGBA.
  79    */
  80   uint32_t texture_target;
  81
  82   /**
  83    * Dimensions of the texture holding the decoded picture.
  84    */
  85   PP_Size texture_size;
  86
  87   /**
  88    * The visible subrectangle of the picture. The plugin should display only
  89    * this part of the picture.
  90    */
  91   PP_Rect visible_rect;
  92 };
  93
  94 /**
  95  * Struct describing a decoded video picture. The decoded picture data is stored
  96  * in the GL texture corresponding to |texture_id|. The plugin can determine
  97  * which Decode call generated the picture using |decode_id|.
  98  */
  99 struct PP_VideoPicture_0_1 {
 100   /**
 101    * |decode_id| parameter of the Decode call which generated this picture.
 102    * See the PPB_VideoDecoder function Decode() for more details.
 103    */
 104   uint32_t decode_id;
 105
 106   /**
 107    * Texture ID in the plugin's GL context. The plugin can use this to render
 108    * the decoded picture.
 109    */
 110   uint32_t texture_id;
 111
 112   /**
 113    * The GL texture target for the decoded picture. Possible values are:
 114    *   GL_TEXTURE_2D
 115    *   GL_TEXTURE_RECTANGLE_ARB
 116    *   GL_TEXTURE_EXTERNAL_OES
 117    *
 118    * The pixel format of the texture is GL_RGBA.
 119    */
 120   uint32_t texture_target;
 121
 122   /**
 123    * Dimensions of the texture holding the decoded picture.
 124    */
 125   PP_Size texture_size;
 126 };
 127
 128 /**
 129  * Supported video profile information. See the PPB_VideoEncoder function
 130  * GetSupportedProfiles() for more details.
 131  */
 132 struct PP_VideoProfileDescription {
 133   /**
 134    * The codec profile.
 135    */
 136   PP_VideoProfile profile;
 137
 138   /**
 139    * Dimensions of the maximum resolution of video frames, in pixels.
 140    */
 141   PP_Size max_resolution;
 142
 143   /**
 144    * The numerator of the maximum frame rate.
 145    */
 146   uint32_t max_framerate_numerator;
 147
 148   /**
 149    * The denominator of the maximum frame rate.
 150    */
 151   uint32_t max_framerate_denominator;
 152
 153   /**
 154    * Whether the profile is hardware accelerated.
 155    */
 156   PP_Bool hardware_accelerated;
 157 };
 158
 159 /**
 160  * Supported video profile information. See the PPB_VideoEncoder function
 161  * GetSupportedProfiles() for more details.
 162  */
 163 struct PP_VideoProfileDescription_0_1 {
 164   /**
 165    * The codec profile.
 166    */
 167   PP_VideoProfile profile;
 168
 169   /**
 170    * Dimensions of the maximum resolution of video frames, in pixels.
 171    */
 172   PP_Size max_resolution;
 173
 174   /**
 175    * The numerator of the maximum frame rate.
 176    */
 177   uint32_t max_framerate_numerator;
 178
 179   /**
 180    * The denominator of the maximum frame rate.
 181    */
 182   uint32_t max_framerate_denominator;
 183
 184   /**
 185    * A value indicating if the profile is available in hardware, software, or
 186    * both.
 187    */
 188   PP_HardwareAcceleration acceleration;
 189 };
 190
 191 /**
 192  * Supported audio profile information. See the PPB_AudioEncoder function
 193  * GetSupportedProfiles() for more details.
 194  */
 195 struct PP_AudioProfileDescription {
 196   /**
 197    * The codec profile.
 198    */
 199   PP_AudioProfile profile;
 200
 201   /**
 202    * Maximum number of channels that can be encoded.
 203    */
 204   uint32_t max_channels;
 205
 206   /**
 207    * Sample size.
 208    */
 209   uint32_t sample_size;
 210
 211   /**
 212    * Sampling rate that can be encoded
 213    */
 214   uint32_t sample_rate;
 215
 216   /**
 217    * Whether the profile is hardware accelerated.
 218    */
 219   PP_Bool hardware_accelerated;
 220 };
 221
 222 /**
 223  * Struct describing a bitstream buffer.
 224  */
 225 struct PP_BitstreamBuffer {
 226   /**
 227    * The size, in bytes, of the bitstream data.
 228    */
 229   uint32_t size;
 230
 231   /**
 232    * The base address of the bitstream data.
 233    */
 234   mem_t buffer;
 235
 236   /**
 237    * Whether the buffer represents a key frame.
 238    */
 239   PP_Bool key_frame;
 240 };
 241
 242 /**
 243  * Struct describing an audio bitstream buffer.
 244  */
 245 struct PP_AudioBitstreamBuffer {
 246   /**
 247    * The size, in bytes, of the bitstream data.
 248    */
 249   uint32_t size;
 250
 251   /**
 252    * The base address of the bitstream data.
 253    */
 254   mem_t buffer;
 255 };