Home | History | Annotate | Download | only in media
      1 // Copyright (c) 2012 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 #ifndef CONTENT_COMMON_GPU_MEDIA_DXVA_VIDEO_DECODE_ACCELERATOR_H_
      6 #define CONTENT_COMMON_GPU_MEDIA_DXVA_VIDEO_DECODE_ACCELERATOR_H_
      7 
      8 #include <d3d9.h>
      9 // Work around bug in this header by disabling the relevant warning for it.
     10 // https://connect.microsoft.com/VisualStudio/feedback/details/911260/dxva2api-h-in-win8-sdk-triggers-c4201-with-w4
     11 #pragma warning(push)
     12 #pragma warning(disable:4201)
     13 #include <dxva2api.h>
     14 #pragma warning(pop)
     15 #include <list>
     16 #include <map>
     17 #include <mfidl.h>
     18 #include <vector>
     19 
     20 #include "base/compiler_specific.h"
     21 #include "base/memory/linked_ptr.h"
     22 #include "base/memory/weak_ptr.h"
     23 #include "base/threading/non_thread_safe.h"
     24 #include "base/win/scoped_comptr.h"
     25 #include "content/common/content_export.h"
     26 #include "media/video/video_decode_accelerator.h"
     27 
     28 interface IMFSample;
     29 interface IDirect3DSurface9;
     30 
     31 namespace content {
     32 
     33 // Class to provide a DXVA 2.0 based accelerator using the Microsoft Media
     34 // foundation APIs via the VideoDecodeAccelerator interface.
     35 // This class lives on a single thread and DCHECKs that it is never accessed
     36 // from any other.
     37 class CONTENT_EXPORT DXVAVideoDecodeAccelerator
     38     : public media::VideoDecodeAccelerator,
     39       NON_EXPORTED_BASE(public base::NonThreadSafe) {
     40  public:
     41   enum State {
     42     kUninitialized,   // un-initialized.
     43     kNormal,          // normal playing state.
     44     kResetting,       // upon received Reset(), before ResetDone()
     45     kStopped,         // upon output EOS received.
     46     kFlushing,        // upon flush request received.
     47   };
     48 
     49   // Does not take ownership of |client| which must outlive |*this|.
     50   explicit DXVAVideoDecodeAccelerator(
     51       const base::Callback<bool(void)>& make_context_current);
     52   virtual ~DXVAVideoDecodeAccelerator();
     53 
     54   // media::VideoDecodeAccelerator implementation.
     55   virtual bool Initialize(media::VideoCodecProfile profile,
     56                           Client* client) OVERRIDE;
     57   virtual void Decode(const media::BitstreamBuffer& bitstream_buffer) OVERRIDE;
     58   virtual void AssignPictureBuffers(
     59       const std::vector<media::PictureBuffer>& buffers) OVERRIDE;
     60   virtual void ReusePictureBuffer(int32 picture_buffer_id) OVERRIDE;
     61   virtual void Flush() OVERRIDE;
     62   virtual void Reset() OVERRIDE;
     63   virtual void Destroy() OVERRIDE;
     64   virtual bool CanDecodeOnIOThread() OVERRIDE;
     65 
     66  private:
     67   typedef void* EGLConfig;
     68   typedef void* EGLSurface;
     69   // Creates and initializes an instance of the D3D device and the
     70   // corresponding device manager. The device manager instance is eventually
     71   // passed to the IMFTransform interface implemented by the h.264 decoder.
     72   bool CreateD3DDevManager();
     73 
     74   // Creates, initializes and sets the media types for the h.264 decoder.
     75   bool InitDecoder(media::VideoCodecProfile profile);
     76 
     77   // Validates whether the h.264 decoder supports hardware video acceleration.
     78   bool CheckDecoderDxvaSupport();
     79 
     80   // Returns information about the input and output streams. This includes
     81   // alignment information, decoder support flags, minimum sample size, etc.
     82   bool GetStreamsInfoAndBufferReqs();
     83 
     84   // Registers the input and output media types on the h.264 decoder. This
     85   // includes the expected input and output formats.
     86   bool SetDecoderMediaTypes();
     87 
     88   // Registers the input media type for the h.264 decoder.
     89   bool SetDecoderInputMediaType();
     90 
     91   // Registers the output media type for the h.264 decoder.
     92   bool SetDecoderOutputMediaType(const GUID& subtype);
     93 
     94   // Passes a command message to the decoder. This includes commands like
     95   // start of stream, end of stream, flush, drain the decoder, etc.
     96   bool SendMFTMessage(MFT_MESSAGE_TYPE msg, int32 param);
     97 
     98   // The bulk of the decoding happens here. This function handles errors,
     99   // format changes and processes decoded output.
    100   void DoDecode();
    101 
    102   // Invoked when we have a valid decoded output sample. Retrieves the D3D
    103   // surface and maintains a copy of it which is passed eventually to the
    104   // client when we have a picture buffer to copy the surface contents to.
    105   bool ProcessOutputSample(IMFSample* sample);
    106 
    107   // Processes pending output samples by copying them to available picture
    108   // slots.
    109   void ProcessPendingSamples();
    110 
    111   // Helper function to notify the accelerator client about the error.
    112   void StopOnError(media::VideoDecodeAccelerator::Error error);
    113 
    114   // Transitions the decoder to the uninitialized state. The decoder will stop
    115   // accepting requests in this state.
    116   void Invalidate();
    117 
    118   // Notifies the client that the input buffer identifed by input_buffer_id has
    119   // been processed.
    120   void NotifyInputBufferRead(int input_buffer_id);
    121 
    122   // Notifies the client that the decoder was flushed.
    123   void NotifyFlushDone();
    124 
    125   // Notifies the client that the decoder was reset.
    126   void NotifyResetDone();
    127 
    128   // Requests picture buffers from the client.
    129   void RequestPictureBuffers(int width, int height);
    130 
    131   // Notifies the client about the availability of a picture.
    132   void NotifyPictureReady(const media::Picture& picture);
    133 
    134   // Sends pending input buffer processed acks to the client if we don't have
    135   // output samples waiting to be processed.
    136   void NotifyInputBuffersDropped();
    137 
    138   // Decodes pending input buffers.
    139   void DecodePendingInputBuffers();
    140 
    141   // Helper for handling the Flush operation.
    142   void FlushInternal();
    143 
    144   // Helper for handling the Decode operation.
    145   void DecodeInternal(const base::win::ScopedComPtr<IMFSample>& input_sample);
    146 
    147   // Handles mid stream resolution changes.
    148   void HandleResolutionChanged(int width, int height);
    149 
    150   struct DXVAPictureBuffer;
    151   typedef std::map<int32, linked_ptr<DXVAPictureBuffer> > OutputBuffers;
    152 
    153   // Tells the client to dismiss the stale picture buffers passed in.
    154   void DismissStaleBuffers();
    155 
    156   // Called after the client indicates we can recycle a stale picture buffer.
    157   void DeferredDismissStaleBuffer(int32 picture_buffer_id);
    158 
    159   // To expose client callbacks from VideoDecodeAccelerator.
    160   media::VideoDecodeAccelerator::Client* client_;
    161 
    162   base::win::ScopedComPtr<IMFTransform> decoder_;
    163 
    164   base::win::ScopedComPtr<IDirect3D9Ex> d3d9_;
    165   base::win::ScopedComPtr<IDirect3DDevice9Ex> device_;
    166   base::win::ScopedComPtr<IDirect3DDeviceManager9> device_manager_;
    167   base::win::ScopedComPtr<IDirect3DQuery9> query_;
    168   // Ideally the reset token would be a stack variable which is used while
    169   // creating the device manager. However it seems that the device manager
    170   // holds onto the token and attempts to access it if the underlying device
    171   // changes.
    172   // TODO(ananta): This needs to be verified.
    173   uint32 dev_manager_reset_token_;
    174 
    175   // The EGL config to use for decoded frames.
    176   EGLConfig egl_config_;
    177 
    178   // Current state of the decoder.
    179   State state_;
    180 
    181   MFT_INPUT_STREAM_INFO input_stream_info_;
    182   MFT_OUTPUT_STREAM_INFO output_stream_info_;
    183 
    184   // Contains information about a decoded sample.
    185   struct PendingSampleInfo {
    186     PendingSampleInfo(int32 buffer_id, IMFSample* sample);
    187     ~PendingSampleInfo();
    188 
    189     int32 input_buffer_id;
    190     base::win::ScopedComPtr<IMFSample> output_sample;
    191   };
    192 
    193   typedef std::list<PendingSampleInfo> PendingOutputSamples;
    194 
    195   // List of decoded output samples.
    196   PendingOutputSamples pending_output_samples_;
    197 
    198   // This map maintains the picture buffers passed the client for decoding.
    199   // The key is the picture buffer id.
    200   OutputBuffers output_picture_buffers_;
    201 
    202   // After a resolution change there may be a few output buffers which have yet
    203   // to be displayed so they cannot be dismissed immediately. We move them from
    204   // |output_picture_buffers_| to this map so they may be dismissed once they
    205   // become available.
    206   OutputBuffers stale_output_picture_buffers_;
    207 
    208   // Set to true if we requested picture slots from the client.
    209   bool pictures_requested_;
    210 
    211   // Counter which holds the number of input packets before a successful
    212   // decode.
    213   int inputs_before_decode_;
    214 
    215   // List of input samples waiting to be processed.
    216   typedef std::list<base::win::ScopedComPtr<IMFSample>> PendingInputs;
    217   PendingInputs pending_input_buffers_;
    218 
    219   // Callback to set the correct gl context.
    220   base::Callback<bool(void)> make_context_current_;
    221 
    222   // WeakPtrFactory for posting tasks back to |this|.
    223   base::WeakPtrFactory<DXVAVideoDecodeAccelerator> weak_this_factory_;
    224 };
    225 
    226 }  // namespace content
    227 
    228 #endif  // CONTENT_COMMON_GPU_MEDIA_DXVA_VIDEO_DECODE_ACCELERATOR_H_
    229