blob: df097b1f8ab441679c835a538cd70117bd46f039 [file] [log] [blame]
* Copyright (C) 2019 The Android Open Source Project
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#pragma once
#include <android-base/thread_annotations.h>
#include <audio_utils/SimpleLog.h>
#include "AnalyticsActions.h"
#include "AnalyticsState.h"
#include "AudioPowerUsage.h"
#include "TimedAction.h"
#include "Wrap.h"
namespace android::mediametrics {
class AudioAnalytics
// AudioAnalytics action / state helper classes
friend AudioPowerUsage;
* Returns success if AudioAnalytics recognizes item.
* AudioAnalytics requires the item key to start with "audio.".
* A trusted source can create a new key, an untrusted source
* can only modify the key if the uid will match that authorized
* on the existing key.
* \param item the item to be submitted.
* \param isTrusted whether the transaction comes from a trusted source.
* In this case, a trusted source is verified by binder
* UID to be a system service by MediaMetrics service.
* Do not use true if you haven't really checked!
* \return NO_ERROR on success,
* PERMISSION_DENIED if the item cannot be put into the AnalyticsState,
* BAD_VALUE if the item key does not start with "audio.".
status_t submit(const std::shared_ptr<const mediametrics::Item>& item, bool isTrusted);
* Returns a pair consisting of the dump string, and the number of lines in the string.
* The number of lines in the returned pair is used as an optimization
* for subsequent line limiting.
* The TimeMachine and the TransactionLog are dumped separately under
* different locks, so may not be 100% consistent with the last data
* delivered.
* \param lines the maximum number of lines in the string returned.
* \param sinceNs the nanoseconds since Unix epoch to start dump (0 shows all)
* \param prefix the desired key prefix to match (nullptr shows all)
std::pair<std::string, int32_t> dump(
int32_t lines = INT32_MAX, int64_t sinceNs = 0, const char *prefix = nullptr) const;
void clear() {
// underlying state is locked.
// Clear power usage state.
* AudioAnalytics class does not contain a monitor mutex.
* Instead, all of its variables are individually locked for access.
* Since data and items are generally added only (gc removes it), this is a reasonable
* compromise for availability/concurrency versus consistency.
* It is possible for concurrent threads to be reading and writing inside of AudioAnalytics.
* Reads based on a prior time (e.g. one second) in the past from the TimeMachine can be
* used to achieve better consistency if needed.
* Checks for any pending actions for a particular item.
* \param item to check against the current AnalyticsActions.
void checkActions(const std::shared_ptr<const mediametrics::Item>& item);
* Return the audio thread associated with an audio track name.
* e.g. "audio.track.32" -> "audio.thread.10" if the associated
* threadId for the audio track is 10.
std::string getThreadFromTrack(const std::string& track) const;
const bool mDeliverStatistics;
// Actions is individually locked
AnalyticsActions mActions;
// AnalyticsState is individually locked, and we use SharedPtrWrap
// to allow safe access even if the shared pointer changes underneath.
// These wrap pointers always point to a valid state object.
SharedPtrWrap<AnalyticsState> mAnalyticsState;
SharedPtrWrap<AnalyticsState> mPreviousAnalyticsState;
TimedAction mTimedAction; // locked internally
SimpleLog mStatsdLog{16 /* log lines */}; // locked internally
// DeviceUse is a nested class which handles audio device usage accounting.
// We define this class at the end to ensure prior variables all properly constructed.
// TODO: Track / Thread interaction
// TODO: Consider statistics aggregation.
class DeviceUse {
enum ItemType {
TRACK = 2,
explicit DeviceUse(AudioAnalytics &audioAnalytics) : mAudioAnalytics{audioAnalytics} {}
// Called every time an endAudioIntervalGroup message is received.
void endAudioIntervalGroup(
const std::shared_ptr<const android::mediametrics::Item> &item,
ItemType itemType) const;
AudioAnalytics &mAudioAnalytics;
} mDeviceUse{*this};
// DeviceConnected is a nested class which handles audio device connection
// We define this class at the end to ensure prior variables all properly constructed.
// TODO: Track / Thread interaction
// TODO: Consider statistics aggregation.
class DeviceConnection {
explicit DeviceConnection(AudioAnalytics &audioAnalytics)
: mAudioAnalytics{audioAnalytics} {}
// Called every time an endAudioIntervalGroup message is received.
void a2dpConnected(
const std::shared_ptr<const android::mediametrics::Item> &item);
// Called when we have an AudioFlinger createPatch
void createPatch(
const std::shared_ptr<const android::mediametrics::Item> &item);
// Called through AudioManager when the BT service wants to notify connection
void postBluetoothA2dpDeviceConnectionStateSuppressNoisyIntent(
const std::shared_ptr<const android::mediametrics::Item> &item);
// When the timer expires.
void expire();
AudioAnalytics &mAudioAnalytics;
mutable std::mutex mLock;
std::string mA2dpDeviceName;
int64_t mA2dpConnectionRequestNs GUARDED_BY(mLock) = 0; // Time for BT service request.
int64_t mA2dpConnectionServiceNs GUARDED_BY(mLock) = 0; // Time audio service agrees.
int32_t mA2dpConnectionRequests GUARDED_BY(mLock) = 0;
int32_t mA2dpConnectionServices GUARDED_BY(mLock) = 0;
// See the statsd atoms.proto
int32_t mA2dpConnectionSuccesses GUARDED_BY(mLock) = 0;
int32_t mA2dpConnectionJavaServiceCancels GUARDED_BY(mLock) = 0;
int32_t mA2dpConnectionUnknowns GUARDED_BY(mLock) = 0;
} mDeviceConnection{*this};
AudioPowerUsage mAudioPowerUsage{this};
} // namespace android::mediametrics