media/cast/logging/logging_defines.h

   1 // Copyright 2013 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_LOGGING_LOGGING_DEFINES_H_
   6 #define MEDIA_CAST_LOGGING_LOGGING_DEFINES_H_
   7
   8 #include <map>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "base/time/time.h"
  13
  14 namespace media {
  15 namespace cast {
  16
  17 static const uint32 kFrameIdUnknown = 0xFFFFFFFF;
  18
  19 typedef uint32 RtpTimestamp;
  20
  21 enum CastLoggingEvent {
  22   UNKNOWN,
  23   // Sender side frame events.
  24   FRAME_CAPTURE_BEGIN,
  25   FRAME_CAPTURE_END,
  26   FRAME_ENCODED,
  27   FRAME_ACK_RECEIVED,
  28   // Receiver side frame events.
  29   FRAME_ACK_SENT,
  30   FRAME_DECODED,
  31   FRAME_PLAYOUT,
  32   // Sender side packet events.
  33   PACKET_SENT_TO_NETWORK,
  34   PACKET_RETRANSMITTED,
  35   // Receiver side packet events.
  36   PACKET_RECEIVED,
  37   kNumOfLoggingEvents = PACKET_RECEIVED
  38 };
  39
  40 const char* CastLoggingToString(CastLoggingEvent event);
  41
  42 // CastLoggingEvent are classified into one of three following types.
  43 enum EventMediaType { AUDIO_EVENT, VIDEO_EVENT, UNKNOWN_EVENT };
  44
  45 struct FrameEvent {
  46   FrameEvent();
  47   ~FrameEvent();
  48
  49   RtpTimestamp rtp_timestamp;
  50   uint32 frame_id;
  51
  52   // Size of encoded frame. Only set for FRAME_ENCODED event.
  53   size_t size;
  54
  55   // Time of event logged.
  56   base::TimeTicks timestamp;
  57
  58   CastLoggingEvent type;
  59
  60   EventMediaType media_type;
  61
  62   // Render / playout delay. Only set for FRAME_PLAYOUT events.
  63   base::TimeDelta delay_delta;
  64
  65   // Whether the frame is a key frame. Only set for video FRAME_ENCODED event.
  66   bool key_frame;
  67
  68   // The requested target bitrate of the encoder at the time the frame is
  69   // encoded. Only set for video FRAME_ENCODED event.
  70   int target_bitrate;
  71 };
  72
  73 struct PacketEvent {
  74   PacketEvent();
  75   ~PacketEvent();
  76
  77   RtpTimestamp rtp_timestamp;
  78   uint32 frame_id;
  79   uint16 max_packet_id;
  80   uint16 packet_id;
  81   size_t size;
  82
  83   // Time of event logged.
  84   base::TimeTicks timestamp;
  85   CastLoggingEvent type;
  86   EventMediaType media_type;
  87 };
  88
  89 }  // namespace cast
  90 }  // namespace media
  91
  92 #endif  // MEDIA_CAST_LOGGING_LOGGING_DEFINES_H_