xref: /aosp_15_r20/hardware/interfaces/media/c2/1.0/IInputSurface.hal (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)

/*
 * Copyright (C) 2018 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 [email protected];

import [email protected]::IGraphicBufferProducer;

import IConfigurable;
import IInputSink;
import IInputSurfaceConnection;

/**
 * Input surface for a Codec2 component.
 *
 * An <em>input surface</em> is an instance of `IInputSurface`, which may be
 * created by calling IComponentStore::createInputSurface(). Once created, the
 * client may
 *   1. write data to it via the `IGraphicBufferProducer` interface; and
 *   2. use it as input to a Codec2 encoder.
 *
 * @sa IInputSurfaceConnection, IComponentStore::createInputSurface(),
 *     IComponent::connectToInputSurface().
 */
interface IInputSurface {
    /**
     * Returns the producer interface into the internal buffer queue.
     *
     * @return producer `IGraphicBufferProducer` instance. This must not be
     * null.
     */
    getGraphicBufferProducer() generates (IGraphicBufferProducer producer);

    /**
     * Returns the @ref IConfigurable instance associated to this input surface.
     *
     * @return configurable `IConfigurable` instance. This must not be null.
     */
    getConfigurable() generates (IConfigurable configurable);

    /**
     * Connects the input surface to an input sink.
     *
     * This function is generally called from inside the implementation of
     * IComponent::connectToInputSurface(), where @p sink is a thin wrapper of
     * the component that consumes buffers from this surface.
     *
     * @param sink Input sink. See `IInputSink` for more information.
     * @return status Status of the call, which may be
     *   - `OK`        - Configuration successful.
     *   - `BAD_VALUE` - @p sink is invalid.
     *   - `CORRUPTED` - Some unknown error occurred.
     * @return connection `IInputSurfaceConnection` object. This must not be
     *     null if @p status is `OK`.
     */
    connect(
            IInputSink sink
        ) generates (
            Status status,
            IInputSurfaceConnection connection
        );
};