gecko-dev/dom/media/gmp/gmp-api/gmp-entrypoints.h

76 строки
3.5 KiB
C

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* Copyright (c) 2011, The WebRTC project authors. All rights reserved.
* Copyright (c) 2014, Mozilla
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
** Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
** Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
** Neither the name of Google nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef GMP_ENTRYPOINTS_h_
#define GMP_ENTRYPOINTS_h_
#include "gmp-errors.h"
#include "gmp-platform.h"
/* C functions exposed by Gecko Media Plugin shared library. */
// GMPInit
// - Called once after plugin library is loaded, before GMPGetAPI or GMPShutdown are called.
// - Called on main thread.
// - 'aPlatformAPI' is a structure containing platform-provided APIs. It is valid until
// 'GMPShutdown' is called. Owned and must be deleted by plugin.
typedef GMPErr (*GMPInitFunc)(const GMPPlatformAPI* aPlatformAPI);
// GMPGetAPI
// - Called when host wants to use an API.
// - Called on main thread.
// - 'aAPIName' is a string indicating the API being requested. This should
// match one of the GMP_API_* macros. Subsequent iterations of the GMP_APIs
// may change the value of the GMP_API_* macros when ABI changes occur. So
// make sure you compare aAPIName against the corresponding GMP_API_* macro!
// - 'aHostAPI' is the host API which is specific to the API being requested
// from the plugin. It is valid so long as the API object requested from the
// plugin is valid. It is owned by the host, plugin should not attempt to delete.
// May be null.
// - 'aPluginAPI' is for returning the requested API. Destruction of the requsted
// API object is defined by the API.
typedef GMPErr (*GMPGetAPIFunc)(const char* aAPIName, void* aHostAPI, void** aPluginAPI);
// GMPShutdown
// - Called once before exiting process (unloading library).
// - Called on main thread.
typedef void (*GMPShutdownFunc)(void);
// GMPSetNodeId
// - Optional, not required to be implemented. Only useful for EME plugins.
// - Called after GMPInit to set the device-bound origin-specific node id
// that this GMP instance is running under.
typedef void (*GMPSetNodeIdFunc)(const char* aNodeId, uint32_t aLength);
#endif // GMP_ENTRYPOINTS_h_