DebugTraceUtil

@UnstableApi
class DebugTraceUtil

A debugging tracing utility. Debug logging is disabled at compile time by default.

Summary

Nested types
@Retention(value = RetentionPolicy.SOURCE)
@StringDef(value = )
@Documented
@Target(value = TYPE_USE)
annotation DebugTraceUtil.DebugTraceEvent

Events logged by logEvent.

Constants
const String!
EVENT_BITMAP_TEXTURE_MANAGER_SIGNAL_EOS = "BitmapTextureManager-SignalEOS"
const String!
EVENT_COMPOSITOR_OUTPUT_TEXTURE_RENDERED = "COMP-OutputTextureRendered"
const String!
EVENT_DECODER_DECODED_FRAME = "Decoder-DecodedFrame"
const String!
EVENT_DECODER_RECEIVE_EOS = "Decoder-ReceiveEOS"
const String!
EVENT_DECODER_SIGNAL_EOS = "Decoder-SignalEOS"
const String!
EVENT_ENCODER_ENCODED_FRAME = "Encoder-EncodedFrame"
const String!
EVENT_ENCODER_RECEIVE_EOS = "Encoder-ReceiveEOS"
const String!
EVENT_EXTERNAL_TEXTURE_MANAGER_SIGNAL_EOS = "ExternalTextureManager-SignalEOS"
const String!
EVENT_MUXER_CAN_WRITE_SAMPLE_AUDIO = "Muxer-CanWriteSample_Audio"
const String!
EVENT_MUXER_CAN_WRITE_SAMPLE_VIDEO = "Muxer-CanWriteSample_Video"
const String!
EVENT_MUXER_TRACK_ENDED_AUDIO = "Muxer-TrackEnded_Audio"
const String!
EVENT_MUXER_TRACK_ENDED_VIDEO = "Muxer-TrackEnded_Video"
const String!
EVENT_MUXER_WRITE_SAMPLE_AUDIO = "Muxer-WriteSample_Audio"
const String!
EVENT_MUXER_WRITE_SAMPLE_VIDEO = "Muxer-WriteSample_Video"
const String!
EVENT_TEX_ID_TEXTURE_MANAGER_SIGNAL_EOS = "TexIdTextureManager-SignalEOS"
const String!
EVENT_VFP_FINISH_PROCESSING_INPUT_STREAM = "VFP-FinishOneInputStream"
const String!
EVENT_VFP_OUTPUT_TEXTURE_RENDERED = "VFP-OutputTextureRendered"
const String!
EVENT_VFP_QUEUE_BITMAP = "VFP-QueueBitmap"
const String!
EVENT_VFP_QUEUE_FRAME = "VFP-QueueFrame"
const String!
EVENT_VFP_QUEUE_TEXTURE = "VFP-QueueTexture"
const String!
EVENT_VFP_RECEIVE_END_OF_INPUT = "VFP-ReceiveEndOfAllInput"
const String!
EVENT_VFP_REGISTER_NEW_INPUT_STREAM = "VFP-RegisterNewInputStream"
const String!
EVENT_VFP_RENDERED_TO_OUTPUT_SURFACE = "VFP-RenderedToOutputSurface"
const String!
EVENT_VFP_SIGNAL_ENDED = "VFP-SignalEnded"
const String!
EVENT_VFP_SURFACE_TEXTURE_INPUT = "VFP-SurfaceTextureInput"
const String!
EVENT_VIDEO_INPUT_FORMAT = "VideoInputFormat"

Public constructors

Public functions
synchronized java-static Unit
dumpTsv(writer: Writer!)

Dumps all the logged events to a tsv file.
synchronized java-static String!

Generate a summary of the logged events, containing the total number of times an event happened and the detailed log of a window of the oldest and newest events.
synchronized java-static Unit
logEvent(
    @DebugTraceUtil.DebugTraceEvent eventName: @DebugTraceUtil.DebugTraceEvent String!,
    presentationTimeUs: Long
)

Logs a new event, if debug logging is enabled.
synchronized java-static Unit
logEvent(
    @DebugTraceUtil.DebugTraceEvent eventName: @DebugTraceUtil.DebugTraceEvent String!,
    presentationTimeUs: Long,
    extraFormat: String?,
    extraArgs: Array<Any!>!
)

Logs a new event, if debug logging is enabled.
synchronized java-static Unit

Public properties
java-static Boolean

Whether to store tracing events for debug logging.

Constants

EVENT_BITMAP_TEXTURE_MANAGER_SIGNAL_EOS

const val EVENT_BITMAP_TEXTURE_MANAGER_SIGNAL_EOS = "BitmapTextureManager-SignalEOS": String!

EVENT_COMPOSITOR_OUTPUT_TEXTURE_RENDERED

const val EVENT_COMPOSITOR_OUTPUT_TEXTURE_RENDERED = "COMP-OutputTextureRendered": String!

EVENT_DECODER_DECODED_FRAME

const val EVENT_DECODER_DECODED_FRAME = "Decoder-DecodedFrame": String!

EVENT_DECODER_RECEIVE_EOS

const val EVENT_DECODER_RECEIVE_EOS = "Decoder-ReceiveEOS": String!

EVENT_DECODER_SIGNAL_EOS

const val EVENT_DECODER_SIGNAL_EOS = "Decoder-SignalEOS": String!

EVENT_ENCODER_ENCODED_FRAME

const val EVENT_ENCODER_ENCODED_FRAME = "Encoder-EncodedFrame": String!

EVENT_ENCODER_RECEIVE_EOS

const val EVENT_ENCODER_RECEIVE_EOS = "Encoder-ReceiveEOS": String!

EVENT_EXTERNAL_TEXTURE_MANAGER_SIGNAL_EOS

const val EVENT_EXTERNAL_TEXTURE_MANAGER_SIGNAL_EOS = "ExternalTextureManager-SignalEOS": String!

EVENT_MUXER_CAN_WRITE_SAMPLE_AUDIO

const val EVENT_MUXER_CAN_WRITE_SAMPLE_AUDIO = "Muxer-CanWriteSample_Audio": String!

EVENT_MUXER_CAN_WRITE_SAMPLE_VIDEO

const val EVENT_MUXER_CAN_WRITE_SAMPLE_VIDEO = "Muxer-CanWriteSample_Video": String!

EVENT_MUXER_TRACK_ENDED_AUDIO

const val EVENT_MUXER_TRACK_ENDED_AUDIO = "Muxer-TrackEnded_Audio": String!

EVENT_MUXER_TRACK_ENDED_VIDEO

const val EVENT_MUXER_TRACK_ENDED_VIDEO = "Muxer-TrackEnded_Video": String!

EVENT_MUXER_WRITE_SAMPLE_AUDIO

const val EVENT_MUXER_WRITE_SAMPLE_AUDIO = "Muxer-WriteSample_Audio": String!

EVENT_MUXER_WRITE_SAMPLE_VIDEO

const val EVENT_MUXER_WRITE_SAMPLE_VIDEO = "Muxer-WriteSample_Video": String!

EVENT_TEX_ID_TEXTURE_MANAGER_SIGNAL_EOS

const val EVENT_TEX_ID_TEXTURE_MANAGER_SIGNAL_EOS = "TexIdTextureManager-SignalEOS": String!

EVENT_VFP_FINISH_PROCESSING_INPUT_STREAM

const val EVENT_VFP_FINISH_PROCESSING_INPUT_STREAM = "VFP-FinishOneInputStream": String!

EVENT_VFP_OUTPUT_TEXTURE_RENDERED

const val EVENT_VFP_OUTPUT_TEXTURE_RENDERED = "VFP-OutputTextureRendered": String!

EVENT_VFP_QUEUE_BITMAP

const val EVENT_VFP_QUEUE_BITMAP = "VFP-QueueBitmap": String!

EVENT_VFP_QUEUE_FRAME

const val EVENT_VFP_QUEUE_FRAME = "VFP-QueueFrame": String!

EVENT_VFP_QUEUE_TEXTURE

const val EVENT_VFP_QUEUE_TEXTURE = "VFP-QueueTexture": String!

EVENT_VFP_RECEIVE_END_OF_INPUT

const val EVENT_VFP_RECEIVE_END_OF_INPUT = "VFP-ReceiveEndOfAllInput": String!

EVENT_VFP_REGISTER_NEW_INPUT_STREAM

const val EVENT_VFP_REGISTER_NEW_INPUT_STREAM = "VFP-RegisterNewInputStream": String!

EVENT_VFP_RENDERED_TO_OUTPUT_SURFACE

const val EVENT_VFP_RENDERED_TO_OUTPUT_SURFACE = "VFP-RenderedToOutputSurface": String!

EVENT_VFP_SIGNAL_ENDED

const val EVENT_VFP_SIGNAL_ENDED = "VFP-SignalEnded": String!

EVENT_VFP_SURFACE_TEXTURE_INPUT

const val EVENT_VFP_SURFACE_TEXTURE_INPUT = "VFP-SurfaceTextureInput": String!

EVENT_VIDEO_INPUT_FORMAT

const val EVENT_VIDEO_INPUT_FORMAT = "VideoInputFormat": String!

Public constructors

DebugTraceUtil

DebugTraceUtil()

Public functions

dumpTsv

synchronized java-static fun dumpTsv(writer: Writer!): Unit

Dumps all the logged events to a tsv file.

Throws
java.io.IOException

generateTraceSummary

synchronized java-static fun generateTraceSummary(): String!

Generate a summary of the logged events, containing the total number of times an event happened and the detailed log of a window of the oldest and newest events.

logEvent

synchronized java-static fun logEvent(
    @DebugTraceUtil.DebugTraceEvent eventName: @DebugTraceUtil.DebugTraceEvent String!,
    presentationTimeUs: Long
): Unit

Logs a new event, if debug logging is enabled.

Parameters
@DebugTraceUtil.DebugTraceEvent eventName: @DebugTraceUtil.DebugTraceEvent String!

The event name to log.
presentationTimeUs: Long

The current presentation time of the media. Use TIME_UNSET if unknown, TIME_END_OF_SOURCE if EOS.

logEvent

synchronized java-static fun logEvent(
    @DebugTraceUtil.DebugTraceEvent eventName: @DebugTraceUtil.DebugTraceEvent String!,
    presentationTimeUs: Long,
    extraFormat: String?,
    extraArgs: Array<Any!>!
): Unit

Logs a new event, if debug logging is enabled.

Parameters
@DebugTraceUtil.DebugTraceEvent eventName: @DebugTraceUtil.DebugTraceEvent String!

The event name to log.
presentationTimeUs: Long

The current presentation time of the media. Use TIME_UNSET if unknown, TIME_END_OF_SOURCE if EOS.
extraFormat: String?

Format string for optional extra information. See formatInvariant.
extraArgs: Array<Any!>!

Arguments for optional extra information.

reset

synchronized java-static fun reset(): Unit

Public properties

enableTracing

java-static val enableTracing: Boolean

Whether to store tracing events for debug logging. Should be set to true for testing and debugging purposes only, before running transformer.