Andy Hung
5 years ago
committed by
Android (Google) Code Review
commit
ba86770445
@ -0,0 +1,135 @@
|
||||
/*
|
||||
* Copyright (C) 2020 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
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
#ifndef ANDROID_MEDIA_MEDIAMETRICSCONSTANTS_H
|
||||
#define ANDROID_MEDIA_MEDIAMETRICSCONSTANTS_H
|
||||
|
||||
/*
|
||||
* MediaMetrics Keys and Properties.
|
||||
*
|
||||
* C/C++ friendly constants that ensure
|
||||
* 1) Compilation error on misspelling
|
||||
* 2) Consistent behavior and documentation.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Taxonomy of audio keys
|
||||
*
|
||||
* To build longer keys, we use compiler string concatenation of
|
||||
* adjacent string literals. This is done in the translation phase
|
||||
* of compilation to make a single string token.
|
||||
*/
|
||||
|
||||
// Key Prefixes are used for MediaMetrics Item Keys and ends with a ".".
|
||||
// They must be appended with another value to make a key.
|
||||
#define AMEDIAMETRICS_KEY_PREFIX_AUDIO "audio."
|
||||
|
||||
// The AudioRecord key appends the "trackId" to the prefix.
|
||||
#define AMEDIAMETRICS_KEY_PREFIX_AUDIO_RECORD AMEDIAMETRICS_KEY_PREFIX_AUDIO "record."
|
||||
|
||||
// The AudioThread key appends the "threadId" to the prefix.
|
||||
#define AMEDIAMETRICS_KEY_PREFIX_AUDIO_THREAD AMEDIAMETRICS_KEY_PREFIX_AUDIO "thread."
|
||||
|
||||
// The AudioTrack key appends the "trackId" to the prefix.
|
||||
#define AMEDIAMETRICS_KEY_PREFIX_AUDIO_TRACK AMEDIAMETRICS_KEY_PREFIX_AUDIO "track."
|
||||
|
||||
// Keys are strings used for MediaMetrics Item Keys
|
||||
#define AMEDIAMETRICS_KEY_AUDIO_FLINGER AMEDIAMETRICS_KEY_PREFIX_AUDIO "flinger"
|
||||
#define AMEDIAMETRICS_KEY_AUDIO_POLICY AMEDIAMETRICS_KEY_PREFIX_AUDIO "policy"
|
||||
|
||||
/*
|
||||
* MediaMetrics Properties are unified space for consistency and readability.
|
||||
*/
|
||||
|
||||
// Property prefixes may be applied before a property name to indicate a specific
|
||||
// category to which it is associated.
|
||||
#define AMEDIAMETRICS_PROP_PREFIX_EFFECTIVE "effective."
|
||||
#define AMEDIAMETRICS_PROP_PREFIX_HAL "hal."
|
||||
#define AMEDIAMETRICS_PROP_PREFIX_HAPTIC "haptic."
|
||||
#define AMEDIAMETRICS_PROP_PREFIX_SERVER "server."
|
||||
|
||||
// Properties within mediametrics are string constants denoted by
|
||||
// a macro name beginning with AMEDIAMETRICS_PROP_*
|
||||
//
|
||||
// For a property name like "auxEffectId" we write this as a single upper case word
|
||||
// at the end of the macro name, such as AMEDIAMETRICS_PROP_AUXEFFECTID.
|
||||
//
|
||||
// Underscores after the AMEDIAMETRICS_PROP_* prefix indicate
|
||||
// a "dot" in the property name. For example AMEDIAMETRICS_PROP_VOLUME_LEFT
|
||||
// corresponds to "volume.left".
|
||||
|
||||
#define AMEDIAMETRICS_PROP_AUXEFFECTID "auxEffectId" // int32 (AudioTrack)
|
||||
#define AMEDIAMETRICS_PROP_CHANNELCOUNT "channelCount" // int32
|
||||
#define AMEDIAMETRICS_PROP_CHANNELMASK "channelMask" // int32
|
||||
#define AMEDIAMETRICS_PROP_CONTENTTYPE "contentType" // string attributes (AudioTrack)
|
||||
#define AMEDIAMETRICS_PROP_DURATIONNS "durationNs" // int64 duration time span
|
||||
#define AMEDIAMETRICS_PROP_ENCODING "encoding" // string value of format
|
||||
#define AMEDIAMETRICS_PROP_EVENT "event" // string value (often func name)
|
||||
|
||||
// TODO: fix inconsistency in flags: AudioRecord / AudioTrack int32, AudioThread string
|
||||
#define AMEDIAMETRICS_PROP_FLAGS "flags"
|
||||
|
||||
#define AMEDIAMETRICS_PROP_FRAMECOUNT "frameCount" // int32
|
||||
#define AMEDIAMETRICS_PROP_INPUTDEVICES "inputDevices" // string value
|
||||
#define AMEDIAMETRICS_PROP_LATENCYMS "latencyMs" // double value
|
||||
#define AMEDIAMETRICS_PROP_ORIGINALFLAGS "originalFlags" // int32
|
||||
#define AMEDIAMETRICS_PROP_OUTPUTDEVICES "outputDevices" // string value
|
||||
#define AMEDIAMETRICS_PROP_PLAYBACK_PITCH "playback.pitch" // double value (AudioTrack)
|
||||
#define AMEDIAMETRICS_PROP_PLAYBACK_SPEED "playback.speed" // double value (AudioTrack)
|
||||
#define AMEDIAMETRICS_PROP_ROUTEDDEVICEID "routedDeviceId" // int32
|
||||
#define AMEDIAMETRICS_PROP_SAMPLERATE "sampleRate" // int32
|
||||
#define AMEDIAMETRICS_PROP_SELECTEDDEVICEID "selectedDeviceId" // int32
|
||||
#define AMEDIAMETRICS_PROP_SELECTEDMICDIRECTION "selectedMicDirection" // int32
|
||||
#define AMEDIAMETRICS_PROP_SELECTEDMICFIELDDIRECTION "selectedMicFieldDimension" // double
|
||||
#define AMEDIAMETRICS_PROP_SESSIONID "sessionId" // int32
|
||||
#define AMEDIAMETRICS_PROP_SOURCE "source" // string (AudioAttributes)
|
||||
#define AMEDIAMETRICS_PROP_STARTUPMS "startupMs" // double value
|
||||
// State is "ACTIVE" or "STOPPED" for AudioRecord
|
||||
#define AMEDIAMETRICS_PROP_STATE "state" // string
|
||||
#define AMEDIAMETRICS_PROP_STATUS "status" // int32 status_t
|
||||
#define AMEDIAMETRICS_PROP_STREAMTYPE "streamType" // string (AudioTrack)
|
||||
#define AMEDIAMETRICS_PROP_THREADID "threadId" // int32 value io handle
|
||||
#define AMEDIAMETRICS_PROP_THROTTLEMS "throttleMs" // double
|
||||
#define AMEDIAMETRICS_PROP_TRACKID "trackId" // int32 port id of track/record
|
||||
#define AMEDIAMETRICS_PROP_TYPE "type" // string (thread type)
|
||||
#define AMEDIAMETRICS_PROP_UNDERRUN "underrun" // int32
|
||||
#define AMEDIAMETRICS_PROP_USAGE "usage" // string attributes (ATrack)
|
||||
#define AMEDIAMETRICS_PROP_VOLUME_LEFT "volume.left" // double (AudioTrack)
|
||||
#define AMEDIAMETRICS_PROP_VOLUME_RIGHT "volume.right" // double (AudioTrack)
|
||||
#define AMEDIAMETRICS_PROP_WHERE "where" // string value
|
||||
|
||||
// Timing values: millisecond values are suffixed with MS and the type is double
|
||||
// nanosecond values are suffixed with NS and the type is int64.
|
||||
|
||||
// Values are strings accepted for a given property.
|
||||
|
||||
// An event is a general description, which often is a function name.
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_CREATE "create"
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_CREATEAUDIOPATCH "createAudioPatch"
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_CTOR "ctor"
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_DTOR "dtor"
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_FLUSH "flush" // AudioTrack
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_INVALIDATE "invalidate" // server track, record
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_PAUSE "pause" // AudioTrack
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_READPARAMETERS "readParameters" // Thread
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_RESTORE "restore"
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_SETPLAYBACKPARAM "setPlaybackParam" // AudioTrack
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_SETVOLUME "setVolume" // AudioTrack
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_START "start" // AudioTrack, AudioRecord
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_STOP "stop" // AudioTrack, AudioRecord
|
||||
#define AMEDIAMETRICS_PROP_EVENT_VALUE_UNDERRUN "underrun" // from Thread
|
||||
|
||||
#endif // ANDROID_MEDIA_MEDIAMETRICSCONSTANTS_H
|
||||
Loading…
Reference in new issue