/**
 * 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
 *
 *     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.media;

import android.media.IResourceManagerClient;
import android.media.MediaResourceParcel;
import android.media.MediaResourcePolicyParcel;
import android.media.ClientInfoParcel;
import android.media.ClientConfigParcel;

/**
 * ResourceManagerService interface that keeps track of media resource
 * owned by clients, and reclaims resources based on configured policies
 * when necessary.
 *
 * {@hide}
 */
interface IResourceManagerService {
    const @utf8InCpp String kPolicySupportsMultipleSecureCodecs
            = "supports-multiple-secure-codecs";
    const @utf8InCpp String kPolicySupportsSecureWithNonSecureCodec
            = "supports-secure-with-non-secure-codec";

    /**
     * Configure the ResourceManagerService to adopted particular policies when
     * managing the resources.
     *
     * @param policies an array of policies to be adopted.
     */
    void config(in MediaResourcePolicyParcel[] policies);

    /**
     * Add a client to a process with a list of resources.
     *
     * @param clientInfo info of the calling client.
     * @param client interface for the ResourceManagerService to call the client.
     * @param resources an array of resources to be added.
     */
    void addResource(
            in ClientInfoParcel clientInfo,
            IResourceManagerClient client,
            in MediaResourceParcel[] resources);

    /**
     * Remove the listed resources from a client.
     *
     * @param clientInfo info of the calling client.
     * @param resources an array of resources to be removed from the client.
     */
    void removeResource(in ClientInfoParcel clientInfo, in MediaResourceParcel[] resources);

    /**
     * Remove all resources from a client.
     *
     * @param clientInfo info of the calling client.
     */
    void removeClient(in ClientInfoParcel clientInfo);

    /**
     * Tries to reclaim resource from processes with lower priority than the
     * calling process according to the requested resources.
     *
     * @param clientInfo info of the calling client.
     * @param resources an array of resources to be reclaimed.
     *
     * @return true if the reclaim was successful and false otherwise.
     */
    boolean reclaimResource(in ClientInfoParcel clientInfo, in MediaResourceParcel[] resources);

    /**
     * Override the pid of original calling process with the pid of the process
     * who actually use the requested resources.
     *
     * @param originalPid pid of the original calling process.
     * @param newPid pid of the actual process who use the resources.
     *        remove existing override on originalPid if newPid is -1.
     */
    void overridePid(int originalPid, int newPid);

    /**
     * Override the process state and OOM score of the calling process with the
     * the specified values. This is used by native service processes to specify
     * these values for ResourceManagerService to use. ResourceManagerService usually
     * gets these values from ActivityManagerService, however, ActivityManagerService
     * doesn't track native service processes.
     *
     * @param client a token for the ResourceManagerService to link to the caller and
     *              receive notification if it goes away. This is needed for clearing
     *              the overrides.
     * @param pid pid of the calling process.
     * @param procState the process state value that ResourceManagerService should
     *                  use for this pid.
     * @param oomScore the oom score value that ResourceManagerService should
     *                  use for this pid.
     */
    void overrideProcessInfo(
            IResourceManagerClient client,
            int pid,
            int procState,
            int oomScore);

    /**
     * Mark a client for pending removal
     *
     * @param clientInfo info of the calling client.
     */
    void markClientForPendingRemoval(in ClientInfoParcel clientInfo);

    /**
     * Reclaim resources from clients pending removal, if any.
     *
     * @param pid pid from which resources will be reclaimed.
     */
    void reclaimResourcesFromClientsPendingRemoval(int pid);

    /**
     * Notify that the client has been created.
     *
     * This call is made to collect the (concurrent) metrics about the
     * resources associated with the Codec (and also DRM sessions).
     *
     * @param clientInfo Information of the client.
     */
    void notifyClientCreated(in ClientInfoParcel clientInfo);

    /**
     * Notify that the client has been started.
     *
     * This call is made to collect the (concurrent) metrics about the
     * resources associated with the Codec (and also DRM sessions).
     *
     * @param clientConfig Configuration information of the client.
     */
    void notifyClientStarted(in ClientConfigParcel clientConfig);

    /**
     * Notify that the client has been stopped.
     *
     * This call is made to collect the (concurrent) metrics about the
     * resources associated with the Codec (and also DRM sessions).
     *
     * @param clientConfig Configuration information of the client.
     */
    void notifyClientStopped(in ClientConfigParcel clientConfig);

    /**
     * Notify that the client's configuration has changed.
     *
     * This call is made to collect the (concurrent) metrics about the
     * resources associated with the Codec (and also DRM sessions).
     * This is called after notifyClientStarted (and before notifyClientStopped)
     * to make changes to some of the configurations associated with the client.
     *
     * @param clientConfig Configuration information of the client.
     */
    void notifyClientConfigChanged(in ClientConfigParcel clientConfig);
}