media/cast/net/rtp/framer.h

   1 // Copyright 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 #ifndef MEDIA_CAST_FRAMER_FRAMER_H_
   6 #define MEDIA_CAST_FRAMER_FRAMER_H_
   7
   8 #include <map>
   9
  10 #include "base/basictypes.h"
  11 #include "base/memory/linked_ptr.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/time/tick_clock.h"
  14 #include "base/time/time.h"
  15 #include "media/cast/net/rtcp/rtcp.h"
  16 #include "media/cast/net/rtp/cast_message_builder.h"
  17 #include "media/cast/net/rtp/frame_buffer.h"
  18 #include "media/cast/net/rtp/rtp_receiver_defines.h"
  19
  20 namespace media {
  21 namespace cast {
  22
  23 typedef std::map<uint32, linked_ptr<FrameBuffer> > FrameList;
  24
  25 class Framer {
  26  public:
  27   Framer(base::TickClock* clock,
  28          RtpPayloadFeedback* incoming_payload_feedback,
  29          uint32 ssrc,
  30          bool decoder_faster_than_max_frame_rate,
  31          int max_unacked_frames);
  32   ~Framer();
  33
  34   // Return true when receiving the last packet in a frame, creating a
  35   // complete frame. If a duplicate packet for an already complete frame is
  36   // received, the function returns false but sets |duplicate| to true.
  37   bool InsertPacket(const uint8* payload_data,
  38                     size_t payload_size,
  39                     const RtpCastHeader& rtp_header,
  40                     bool* duplicate);
  41
  42   // Extracts a complete encoded frame - will only return a complete and
  43   // decodable frame. Returns false if no such frames exist.
  44   // |next_frame| will be set to true if the returned frame is the very
  45   // next frame. |have_multiple_complete_frames| will be set to true
  46   // if there are more decodadble frames available.
  47   bool GetEncodedFrame(EncodedFrame* video_frame,
  48                        bool* next_frame,
  49                        bool* have_multiple_complete_frames);
  50
  51   // TODO(hubbe): Move this elsewhere.
  52   void AckFrame(uint32 frame_id);
  53
  54   void ReleaseFrame(uint32 frame_id);
  55
  56   // Reset framer state to original state and flush all pending buffers.
  57   void Reset();
  58   bool TimeToSendNextCastMessage(base::TimeTicks* time_to_send);
  59   void SendCastMessage();
  60
  61   bool Empty() const;
  62   bool FrameExists(uint32 frame_id) const;
  63   uint32 NewestFrameId() const;
  64
  65   void RemoveOldFrames(uint32 frame_id);
  66
  67   // Identifies the next frame to be released (rendered).
  68   bool NextContinuousFrame(uint32* frame_id) const;
  69   uint32 LastContinuousFrame() const;
  70
  71   bool NextFrameAllowingSkippingFrames(uint32* frame_id) const;
  72   bool HaveMultipleDecodableFrames() const;
  73
  74   int NumberOfCompleteFrames() const;
  75   void GetMissingPackets(uint32 frame_id,
  76                          bool last_frame,
  77                          PacketIdSet* missing_packets) const;
  78
  79  private:
  80   bool ContinuousFrame(FrameBuffer* frame) const;
  81   bool DecodableFrame(FrameBuffer* frame) const;
  82
  83   const bool decoder_faster_than_max_frame_rate_;
  84   FrameList frames_;
  85   scoped_ptr<CastMessageBuilder> cast_msg_builder_;
  86   bool waiting_for_key_;
  87   uint32 last_released_frame_;
  88   uint32 newest_frame_id_;
  89
  90   DISALLOW_COPY_AND_ASSIGN(Framer);
  91 };
  92
  93 }  //  namespace cast
  94 }  //  namespace media
  95
  96 #endif  // MEDIA_CAST_FRAMER_FRAMER_H_