Add CDM video decoder.

webkit/media/crypto/ppapi/content_decryption_module.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef WEBKIT_MEDIA_CRYPTO_PPAPI_CONTENT_DECRYPTION_MODULE_H_
 #define WEBKIT_MEDIA_CRYPTO_PPAPI_CONTENT_DECRYPTION_MODULE_H_
 
 #if defined(_MSC_VER)
 typedef unsigned char uint8_t;
 typedef unsigned int uint32_t;
+typedef int int32_t;
 typedef __int64 int64_t;
 #else
 #include <stdint.h>
 #endif
 
+#include "base/time.h"
 #include "webkit/media/crypto/ppapi/cdm_export.h"
 
 namespace cdm {
 class ContentDecryptionModule;
 }
 
 extern "C" {
 CDM_EXPORT cdm::ContentDecryptionModule* CreateCdmInstance();
 CDM_EXPORT void DestroyCdmInstance(cdm::ContentDecryptionModule* instance);
 CDM_EXPORT const char* GetCdmVersion();
@@ skipping 96 matching lines @@
       : data(NULL),
         data_size(0),
         timestamp(0) {}
 
   const uint8_t* data;  // Pointer to the beginning of the output data.
   uint32_t data_size;  // Size (in bytes) of |data|.
 
   int64_t timestamp;  // Presentation timestamp in microseconds.
 };
 
+struct VideoFrame {
+  // Surface formats roughly based on FOURCC labels, see:
+  // http://www.fourcc.org/rgb.php
+  // http://www.fourcc.org/yuv.php
+  enum ColorFormat {
+    // Values are skipped in here to keep them synchronized with

[ddorwin, 2012/09/02 21:39:08]

Is there a reason these need to be synchronized? Avoiding switch statements?
Same question for other enums.

+    // media::VideoFrame::Format.
+    kFormatInvalid = 0,  // Invalid format value.  Used for error reporting.
+    kFormatYv12 = 2,     // 12bpp YVU planar 1x1 Y, 2x2 VU samples.
+    kFormatEmpty = 4,    // An empty frame.
+    kFormatI420 = 5,     // 12bpp YVU planar 1x1 Y, 2x2 UV samples.
+  };
+
+  struct Size {
+    Size() : width(0), height(0) {}
+    Size(int32_t width, int32_t height) : width(width), height(height) {}
+
+    int32_t width;
+    int32_t height;
+  };
+
+  const static int32_t kMaxPlanes = 3;
+
+  VideoFrame() : format(kFormatInvalid) {
+    for (int i = 0; i < kMaxPlanes; ++i) {
+      strides[i] = 0;
+      data[i] = NULL;
+    }
+  }
+
+  ColorFormat format;
+
+  // Width and height of the video frame.
+  Size frame_size;
+
+  // Array of strides for each plane, typically greater or equal to the width
+  // of the surface divided by the horizontal sampling period.  Note that
+  // strides can be negative.
+  int32_t strides[kMaxPlanes];
+
+  // Array of data pointers to each plane.
+  uint8_t* data[kMaxPlanes];
+
+  base::TimeDelta timestamp;  // Presentation timestamp in microseconds.
+};
+
+struct VideoDecoderConfig {
+  enum VideoCodec {
+    kCodecUnknown = 0,
+    kCodecH264,
+    kCodecVp8 = 6  // matches value from media::VideoCodec.
+  };
+
+  enum VideoCodecProfile {
+    VIDEO_CODEC_PROFILE_UNKNOWN = -1,
+    H264PROFILE_MIN = 0,
+    H264PROFILE_BASELINE = H264PROFILE_MIN,
+    H264PROFILE_MAIN = 1,
+    H264PROFILE_EXTENDED = 2,
+    H264PROFILE_HIGH = 3,
+    H264PROFILE_HIGH10PROFILE = 4,
+    H264PROFILE_HIGH422PROFILE = 5,
+    H264PROFILE_HIGH444PREDICTIVEPROFILE = 6,
+    H264PROFILE_SCALABLEBASELINE = 7,
+    H264PROFILE_SCALABLEHIGH = 8,
+    H264PROFILE_STEREOHIGH = 9,
+    H264PROFILE_MULTIVIEWHIGH = 10,
+    H264PROFILE_MAX = H264PROFILE_MULTIVIEWHIGH,
+    VP8PROFILE_MIN = 11,
+    VP8PROFILE_MAIN = VP8PROFILE_MIN,
+    VP8PROFILE_MAX = VP8PROFILE_MAIN,
+    VIDEO_CODEC_PROFILE_MAX = VP8PROFILE_MAX
+  };
+
+  VideoCodec codec;
+  VideoCodecProfile profile;
+  VideoFrame::ColorFormat format;

[ddorwin, 2012/09/02 21:39:08]

Odd that we have to use the other class's enum. Maybe FrameInfo/FrameDescription
should be a separate class (unless we can eliminate these from one of the
classes altogether).

[xhwang, 2012/09/04 14:50:21]

Done in http://codereview.chromium.org/10900007/

+  VideoFrame::Size frame_size;
+  uint8_t* extra_data;
+  int32_t extra_data_size;
+
+  VideoDecoderConfig()
+      : codec(kCodecUnknown),
+        profile(VIDEO_CODEC_PROFILE_UNKNOWN),
+        format(VideoFrame::kFormatInvalid),
+        frame_size(0, 0),
+        extra_data(NULL),
+        extra_data_size(0) {}
+};
+
 class ContentDecryptionModule {
  public:
   // Generates a |key_request| given the |init_data|.
   // Returns kSuccess if the key request was successfully generated,
   // in which case the callee should have allocated memory for the output
   // parameters (e.g |session_id| in |key_request|) and passed the ownership
   // to the caller.
   // Returns kErrorUnknown otherwise, in which case the output parameters should
   // not be used by the caller.
   //
@@ skipping 14 matching lines @@
                         const uint8_t* key_id,
                         int key_id_size) = 0;
 
   // Cancels any pending key request made to the CDM for |session_id|.
   // Returns kSuccess if all pending key requests for |session_id| were
   // successfully canceled or there was no key request to be canceled.
   // Returns kErrorUnknown otherwise.
   virtual Status CancelKeyRequest(const char* session_id,
                                   int session_id_size) = 0;
 
+  // Initializes the CDM video decoder with |video_decoder_config|. This
+  // function must be called before DecryptAndDecode is called.
+  // Returns kSuccess if the |video_decoder_config| is supported and the CDM
+  // video decoder is successfully initialized.
+  // Returns kErrorUnknown otherwise.
+  virtual Status InitializeVideoDecoder(
+      const VideoDecoderConfig& video_decoder_config) = 0;
+
+  // Flushes decoded video buffers stored by the CDM video decoder. This
+  // function should be called after seeking to ensure that frames decoded
+  // before seeking are not displayed.
+  virtual Status FlushVideoDecoder() = 0;

[ddorwin, 2012/09/02 21:39:08]

Should we just have one Flush() for all streams? I guess that could not be used
if you wanted to change just one one decoder, but maybe the Initialize* methods
should handle that internally.

[xhwang, 2012/09/04 14:50:21]

From media pipeline, the flush calls come from VideoRenderer and AudioRenderer
separately.  If these two calls come out-of-sync, then we could end up with:
1, audio_decoder.flush() // CDM calls flush() and flushes both video and audio
decoder
2. video_decoder.Decode() // oops, error since the video decoder's state
changed!
3, video_decoder.flush()...

This may cause pipeline error.

+
   // Decrypts the |encrypted_buffer|.
   // Returns kSuccess if decryption succeeded, in which case the callee
   // should have filled the |decrypted_buffer| and passed the ownership of
   // |data| in |decrypted_buffer| to the caller.
   // Returns kErrorNoKey if the CDM did not have the necessary decryption key
   // to decrypt.
   // Returns kErrorUnknown if any other error happened.
   // In these two cases, |decrypted_buffer| should not be used by the caller.
   //
   // TODO(xhwang): It's not safe to pass the ownership of the dynamically
   // allocated memory over library boundaries. Fix it after related PPAPI change
   // and sample CDM are landed.
   virtual Status Decrypt(const InputBuffer& encrypted_buffer,
                          OutputBuffer* decrypted_buffer) = 0;
 
+  // Decrypts the |encrypted_buffer| and decodes the decrypted buffer into a
+  // |video_frame|. Upon end-of-stream, the caller should call this function
+  // repeatedly with empty |encrypted_buffer| (where |data| is NULL) until
+  // only empty (|format| being EMPTY) |video_frame| can be produced.
+  // Returns kSuccess if decryption and decoding both succeeded, in which case
+  // the callee should have filled the |video_frame| and passed the ownership of
+  // |data| in |video_frame| to the caller.
+  // Returns kErrorNoKey if the CDM did not have the necessary decryption key
+  // to decrypt.
+  // Returns kErrorUnknown if any other (decryption or decoding) error happened.
+  // In these two cases, |video_frame| should not be used by the caller.
+  //
+  // TODO(xhwang): It's not safe to pass the ownership of the dynamically
+  // allocated memory over library boundaries. Fix it after related PPAPI change
+  // and sample CDM are landed.
+  virtual Status DecryptAndDecode(const InputBuffer& encrypted_buffer,
+                                  VideoFrame* video_frame) = 0;
+
   virtual ~ContentDecryptionModule() {}
 };
 
 }  // namespace cdm
 
 #endif  // WEBKIT_MEDIA_CRYPTO_PPAPI_CONTENT_DECRYPTION_MODULE_H_