logging_impl.h

// Copyright 2013 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_LOGGING_LOGGING_IMPL_H_
#define MEDIA_CAST_LOGGING_LOGGING_IMPL_H_

// Generic class that handles event logging for the cast library.
// Logging has three possible optional forms:
// 1. Raw data and stats accessible by the application.
// 2. Tracing of raw events.

#include "base/memory/ref_counted.h"
#include "base/threading/thread_checker.h"
#include "media/cast/cast_config.h"
#include "media/cast/logging/logging_defines.h"
#include "media/cast/logging/logging_raw.h"

namespace media {
namespace cast {

class LoggingImpl {
 public:
  LoggingImpl();
  ~LoggingImpl();

  // Note: All methods below should be called from the same thread.

  void InsertFrameEvent(const base::TimeTicks& time_of_event,
                        CastLoggingEvent event, EventMediaType event_media_type,
                        uint32 rtp_timestamp, uint32 frame_id);

  void InsertCapturedVideoFrameEvent(const base::TimeTicks& time_of_event,
                                     uint32 rtp_timestamp,
                                     int width,
                                     int height);

  void InsertEncodedFrameEvent(const base::TimeTicks& time_of_event,
                               CastLoggingEvent event,
                               EventMediaType event_media_type,
                               uint32 rtp_timestamp,
                               uint32 frame_id,
                               int encoded_size,
                               bool key_frame,
                               int target_bitrate,
                               double encoder_cpu_utilization,
                               double idealized_bitrate_utilization);

  void InsertFrameEventWithDelay(const base::TimeTicks& time_of_event,
                                 CastLoggingEvent event,
                                 EventMediaType event_media_type,
                                 uint32 rtp_timestamp, uint32 frame_id,
                                 base::TimeDelta delay);

  void InsertSinglePacketEvent(const base::TimeTicks& time_of_event,
                               CastLoggingEvent event,
                               EventMediaType event_media_type,
                               const Packet& packet);

  void InsertPacketListEvent(const base::TimeTicks& time_of_event,
                             CastLoggingEvent event,
                             EventMediaType event_media_type,
                             const PacketList& packets);

  void InsertPacketEvent(const base::TimeTicks& time_of_event,
                         CastLoggingEvent event,
                         EventMediaType event_media_type, uint32 rtp_timestamp,
                         uint32 frame_id, uint16 packet_id,
                         uint16 max_packet_id, size_t size);

  // Delegates to |LoggingRaw::AddRawEventSubscriber()|.
  void AddRawEventSubscriber(RawEventSubscriber* subscriber);

  // Delegates to |LoggingRaw::RemoveRawEventSubscriber()|.
  void RemoveRawEventSubscriber(RawEventSubscriber* subscriber);

 private:
  base::ThreadChecker thread_checker_;
  LoggingRaw raw_;

  DISALLOW_COPY_AND_ASSIGN(LoggingImpl);
};

}  // namespace cast
}  // namespace media

#endif  // MEDIA_CAST_LOGGING_LOGGING_IMPL_H_