third_party/chromium/media/cast/test/receiver/framer.h

// Copyright 2014 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_CAST_TEST_RECEIVER_FRAMER_H_
#define MEDIA_CAST_TEST_RECEIVER_FRAMER_H_

#include <stddef.h>
#include <stdint.h>

#include <map>
#include <memory>

#include "base/macros.h"
#include "base/time/tick_clock.h"
#include "base/time/time.h"
#include "media/cast/net/rtp/rtp_defines.h"
#include "media/cast/test/receiver/cast_message_builder.h"
#include "media/cast/test/receiver/frame_buffer.h"

namespace media {
namespace cast {

class Framer {
 public:
  Framer(const base::TickClock* clock,
         RtpPayloadFeedback* incoming_payload_feedback,
         uint32_t ssrc,
         bool decoder_faster_than_max_frame_rate,
         int max_unacked_frames);

  Framer(const Framer&) = delete;
  Framer& operator=(const Framer&) = delete;

  ~Framer();

  // Return true when receiving the last packet in a frame, creating a
  // complete frame. If a duplicate packet for an already complete frame is
  // received, the function returns false but sets |duplicate| to true.
  bool InsertPacket(const uint8_t* payload_data,
                    size_t payload_size,
                    const RtpCastHeader& rtp_header,
                    bool* duplicate);

  // Extracts a complete encoded frame - will only return a complete and
  // decodable frame. Returns false if no such frames exist.
  // |next_frame| will be set to true if the returned frame is the very
  // next frame. |have_multiple_complete_frames| will be set to true
  // if there are more decodadble frames available.
  bool GetEncodedFrame(EncodedFrame* video_frame,
                       bool* next_frame,
                       bool* have_multiple_complete_frames);

  // TODO(hubbe): Move this elsewhere.
  void AckFrame(FrameId frame_id);

  void ReleaseFrame(FrameId frame_id);

  bool TimeToSendNextCastMessage(base::TimeTicks* time_to_send);
  void SendCastMessage();

  // TODO(miu): These methods are called from CastMessageBuilder.  We need to
  // resolve these circular dependencies with some refactoring.
  // http://crbug.com/530845
  FrameId newest_frame_id() const { return newest_frame_id_; }
  bool Empty() const;
  bool FrameExists(FrameId frame_id) const;
  int NumberOfCompleteFrames() const;
  void GetMissingPackets(FrameId frame_id,
                         bool last_frame,
                         PacketIdSet* missing_packets) const;

 private:
  // Identifies the next frame to be released (rendered) and returns its
  // associated buffer, or returns nullptr there is none.
  FrameBuffer* FindNextFrameForRelease();

  // Returns the buffer associated with the oldest decodable frame (i.e., where
  // all dependencies are met), or nullptr if there is none.
  FrameBuffer* FindOldestDecodableFrame();
  bool HaveMultipleDecodableFrames() const;

  // Helper for FindNextFrameForRelease().
  bool IsNextFrameForRelease(const FrameBuffer& frame) const;

  // Helper for FindOldestDecodableFrame() and HaveMultipleDecodableFrames().
  bool IsDecodableFrame(const FrameBuffer& frame) const;

  const bool decoder_faster_than_max_frame_rate_;
  std::map<FrameId, std::unique_ptr<FrameBuffer>> frames_;
  CastMessageBuilder cast_msg_builder_;
  bool waiting_for_key_;
  FrameId last_released_frame_;
  FrameId newest_frame_id_;
};

}  //  namespace cast
}  //  namespace media

#endif  // MEDIA_CAST_TEST_RECEIVER_FRAMER_H_