media/filters/decrypting_audio_decoder.h

   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 MEDIA_FILTERS_DECRYPTING_AUDIO_DECODER_H_
   6 #define MEDIA_FILTERS_DECRYPTING_AUDIO_DECODER_H_
   7
   8 #include "base/callback.h"
   9 #include "base/memory/ref_counted.h"
  10 #include "base/memory/scoped_ptr.h"
  11 #include "base/memory/weak_ptr.h"
  12 #include "base/time/time.h"
  13 #include "media/base/audio_decoder.h"
  14 #include "media/base/decryptor.h"
  15 #include "media/base/demuxer_stream.h"
  16
  17 namespace base {
  18 class SingleThreadTaskRunner;
  19 }
  20
  21 namespace media {
  22
  23 class AudioTimestampHelper;
  24 class DecoderBuffer;
  25 class Decryptor;
  26
  27 // Decryptor-based AudioDecoder implementation that can decrypt and decode
  28 // encrypted audio buffers and return decrypted and decompressed audio frames.
  29 // All public APIs and callbacks are trampolined to the |task_runner_| so
  30 // that no locks are required for thread safety.
  31 class MEDIA_EXPORT DecryptingAudioDecoder : public AudioDecoder {
  32  public:
  33   DecryptingAudioDecoder(
  34       const scoped_refptr<base::SingleThreadTaskRunner>& task_runner,
  35       const SetDecryptorReadyCB& set_decryptor_ready_cb,
  36       const base::Closure& waiting_for_decryption_key_cb);
  37   ~DecryptingAudioDecoder() override;
  38
  39   // AudioDecoder implementation.
  40   std::string GetDisplayName() const override;
  41   void Initialize(const AudioDecoderConfig& config,
  42                   const PipelineStatusCB& status_cb,
  43                   const OutputCB& output_cb) override;
  44   void Decode(const scoped_refptr<DecoderBuffer>& buffer,
  45               const DecodeCB& decode_cb) override;
  46   void Reset(const base::Closure& closure) override;
  47
  48  private:
  49   // For a detailed state diagram please see this link: http://goo.gl/8jAok
  50   // TODO(xhwang): Add a ASCII state diagram in this file after this class
  51   // stabilizes.
  52   // TODO(xhwang): Update this diagram for DecryptingAudioDecoder.
  53   enum State {
  54     kUninitialized = 0,
  55     kDecryptorRequested,
  56     kPendingDecoderInit,
  57     kIdle,
  58     kPendingDecode,
  59     kWaitingForKey,
  60     kDecodeFinished,
  61     kError
  62   };
  63
  64   // Callback for DecryptorHost::RequestDecryptor(). |decryptor_attached_cb| is
  65   // called when the decryptor has been completely attached to the pipeline.
  66   void SetDecryptor(Decryptor* decryptor,
  67                     const DecryptorAttachedCB& decryptor_attached_cb);
  68
  69   // Initializes the audio decoder on the |decryptor_| with |config_|.
  70   void InitializeDecoder();
  71
  72   // Callback for Decryptor::InitializeAudioDecoder() during initialization.
  73   void FinishInitialization(bool success);
  74
  75   void DecodePendingBuffer();
  76
  77   // Callback for Decryptor::DecryptAndDecodeAudio().
  78   void DeliverFrame(int buffer_size,
  79                     Decryptor::Status status,
  80                     const Decryptor::AudioFrames& frames);
  81
  82   // Callback for the |decryptor_| to notify this object that a new key has been
  83   // added.
  84   void OnKeyAdded();
  85
  86   // Resets decoder and calls |reset_cb_|.
  87   void DoReset();
  88
  89   // Sets timestamps for |frames| and then passes them to |output_cb_|.
  90   void ProcessDecodedFrames(const Decryptor::AudioFrames& frames);
  91
  92   scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
  93
  94   State state_;
  95
  96   PipelineStatusCB init_cb_;
  97   OutputCB output_cb_;
  98   DecodeCB decode_cb_;
  99   base::Closure reset_cb_;
 100   base::Closure waiting_for_decryption_key_cb_;
 101
 102   // The current decoder configuration.
 103   AudioDecoderConfig config_;
 104
 105   // Callback to request/cancel decryptor creation notification.
 106   SetDecryptorReadyCB set_decryptor_ready_cb_;
 107
 108   Decryptor* decryptor_;
 109
 110   // The buffer that needs decrypting/decoding.
 111   scoped_refptr<media::DecoderBuffer> pending_buffer_to_decode_;
 112
 113   // Indicates the situation where new key is added during pending decode
 114   // (in other words, this variable can only be set in state kPendingDecode).
 115   // If this variable is true and kNoKey is returned then we need to try
 116   // decrypting/decoding again in case the newly added key is the correct
 117   // decryption key.
 118   bool key_added_while_decode_pending_;
 119
 120   scoped_ptr<AudioTimestampHelper> timestamp_helper_;
 121
 122   base::WeakPtr<DecryptingAudioDecoder> weak_this_;
 123   base::WeakPtrFactory<DecryptingAudioDecoder> weak_factory_;
 124
 125   DISALLOW_COPY_AND_ASSIGN(DecryptingAudioDecoder);
 126 };
 127
 128 }  // namespace media
 129
 130 #endif  // MEDIA_FILTERS_DECRYPTING_AUDIO_DECODER_H_