xref: /aosp_15_r20/hardware/interfaces/cas/1.0/IMediaCasService.hal (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)

/*
 * Copyright (C) 2017 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]::ICas;
import [email protected]::ICasListener;
import [email protected]::IDescramblerBase;

/**
 * IMediaCasService is the main entry point for interacting with a vendor's
 * cas HAL to create cas and descrambler plugin instances. A cas plugin instance
 * opens cas sessions which are used to obtain keys for a descrambler session,
 * which can in turn be used to descramble protected video content.
 */
interface IMediaCasService {
    /**
     * List all available CA systems on the device.
     *
     * @return descriptors an array of descriptors for the available CA systems.
     */
    enumeratePlugins() generates (vec<HidlCasPluginDescriptor> descriptors);

    /**
     * Query if a certain CA system is supported on this device.
     *
     * @param CA_system_id the id of the CA system.
     * @return result whether the specified CA system is supported on this device.
     */
    isSystemIdSupported(int32_t CA_system_id) generates (bool result);

    /**
     * Construct a new instance of a CasPlugin given a CA_system_id.
     *
     * @param CA_system_id the id of the CA system.
     * @param listener the event listener to receive events coming from the CasPlugin.
     * @return cas the newly created CasPlugin interface.
     */
    createPlugin(int32_t CA_system_id, ICasListener listener) generates (ICas cas);

    /**
     * Query if the descrambling scheme for a CA system is supported on this device.
     *
     * @param CA_system_id the id of the CA system.
     * @return result whether the specified descrambling scheme is supported on this device.
     */
    isDescramblerSupported(int32_t CA_system_id) generates (bool result);

    /**
     * Construct a new instance of a DescramblerPlugin given a CA_system_id.
     *
     * @param CA_system_id the id of the CA system.
     * @return descrambler the newly created plugin interface.
     */
    createDescrambler(int32_t CA_system_id) generates (IDescramblerBase descrambler);
};