Add status parameter to DemuxerStream::ReadCB

media/base/demuxer_stream.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 MEDIA_BASE_DEMUXER_STREAM_H_
 #define MEDIA_BASE_DEMUXER_STREAM_H_
 
 #include "base/callback.h"
 #include "base/memory/ref_counted.h"
 #include "media/base/media_export.h"
 #include "media/base/ranges.h"
 
 namespace media {
 
 class AudioDecoderConfig;
 class DecoderBuffer;
 class VideoDecoderConfig;
 
 class MEDIA_EXPORT DemuxerStream
     : public base::RefCountedThreadSafe<DemuxerStream> {
  public:
   enum Type {
     UNKNOWN,
     AUDIO,
     VIDEO,
     NUM_TYPES,  // Always keep this entry as the last one!
   };
 
+  // Status returned in the Read() callback.
+  //  kOk : Indicates the second parameter is Non-NULL and contains media data
+  //        or the end of the stream.
+  //  kAborted : Indicates an aborted Read(). This can happen if the
+  //             DemuxerStream gets flushed and doesn't have any more data to
+  //             return. The second parameter MUST be NULL when this status is
+  //             returned.
+  //  kConfigChange : Indicates that the AudioDecoderConfig or
+  //                  VideoDecoderConfig for the stream has changed.
+  //                  The DemuxerStream expects an audio_decoder_config() or
+  //                  video_decoder_config() call before Read() will start
+  //                  returning DecoderBuffers again. The decoder will need this
+  //                  new configuration to properly decode the buffers read
+  //                  from this point forward. The second parameter MUST be NULL
+  //                  when this status is returned.
+  enum Status {
+    kOk,
+    kAborted,
+    kConfigChanged,
+  };
+
   // Request a buffer to returned via the provided callback.
   //
-  // Non-NULL buffer pointers will contain media data or signal the end of the
-  // stream. A NULL pointer indicates an aborted Read(). This can happen if the
-  // DemuxerStream gets flushed and doesn't have any more data to return.
-  typedef base::Callback<void(const scoped_refptr<DecoderBuffer>&)> ReadCB;
+  // The first parameter indicates the status of the read.
+  // The second parameter is Non-NULL and contains media data

[Ami GONE FROM CHROMIUM, 2012/07/12 17:10:26]

s/Non/non/

[acolwell GONE FROM CHROMIUM, 2012/07/12 21:59:58]

Done.

+  // or the end of the stream if the first parameter is kOk. NULL otherwise.
+  typedef base::Callback<void(Status, const scoped_refptr<DecoderBuffer>&)>
+      ReadCB;

[Ami GONE FROM CHROMIUM, 2012/07/12 17:10:26]

indent isn't supported by style guide.  I'd put a newline after the comma in the
previous line and line up the void() params, instead.

[acolwell GONE FROM CHROMIUM, 2012/07/12 21:59:58]

Done.

   virtual void Read(const ReadCB& read_cb) = 0;
 
   // Returns the audio decoder configuration. It is an error to call this method
   // if type() != AUDIO.
   virtual const AudioDecoderConfig& audio_decoder_config() = 0;
 
   // Returns the video decoder configuration. It is an error to call this method
   // if type() != VIDEO.
   virtual const VideoDecoderConfig& video_decoder_config() = 0;
 
   // Returns time ranges known to have been seen by this stream.
   virtual Ranges<base::TimeDelta> GetBufferedRanges() = 0;
 
   // Returns the type of stream.
   virtual Type type() = 0;
 
   virtual void EnableBitstreamConverter() = 0;
 
  protected:
   friend class base::RefCountedThreadSafe<DemuxerStream>;
   virtual ~DemuxerStream();
 };
 
 }  // namespace media
 
 #endif  // MEDIA_BASE_DEMUXER_STREAM_H_