libraries/flicker/utils/src/android/tools/device/traces/monitors/surfaceflinger/TransactionsTraceMonitor.kt

/*
 * Copyright (C) 2023 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.
 */

package android.tools.device.traces.monitors.surfaceflinger

import android.tools.common.io.TraceType
import android.tools.common.io.WINSCOPE_EXT
import android.tools.common.traces.surfaceflinger.TransactionsTrace
import android.tools.device.traces.monitors.TraceMonitor
import android.view.WindowManagerGlobal
import java.io.File

/** Captures [TransactionsTrace] from SurfaceFlinger. */
open class TransactionsTraceMonitor : TraceMonitor() {
    private val windowManager =
        WindowManagerGlobal.getWindowManagerService() ?: error("Unable to acquire WindowManager")
    override val isEnabled = true
    override val traceType = TraceType.TRANSACTION

    override fun doStart() {
        windowManager.setActiveTransactionTracing(true)
    }

    override fun validateStart() {
        // No validation required
    }

    override fun doStop(): File {
        windowManager.setActiveTransactionTracing(false)
        return TRACE_DIR.resolve("transactions_trace$WINSCOPE_EXT")
    }
}