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