third_party/libva/va/drm/va_drm_utils.h

   1 /*
   2  * va_drm_utils.h - VA/DRM Utilities
   3  *
   4  * Copyright (c) 2012 Intel Corporation. All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL INTEL AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  */
  26
  27 #ifndef VA_DRM_UTILS_H
  28 #define VA_DRM_UTILS_H
  29
  30 #include <va/va_backend.h>
  31
  32 /**
  33  * \file va_drm_utils.h
  34  * \brief VA/DRM Utilities
  35  *
  36  * This file contains VA/DRM utility functions. The API herein defined is
  37  * internal to libva. Users include the VA/DRM API itself or VA/Android,
  38  * should it be based on DRM.
  39  */
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /**
  46  * \brief Returns the VA driver name for the active display.
  47  *
  48  * This functions returns a newly allocated buffer in @driver_name_ptr that
  49  * contains the VA driver name for the active display. Active display means
  50  * the display obtained with any of the vaGetDisplay*() functions.
  51  *
  52  * The VADriverContext.drm_state structure must be valid, i.e. allocated
  53  * and containing an open DRM connection descriptor. The DRM connection
  54  * does *not* need to be authenticated as it only performs a call to
  55  * drmGetVersion().
  56  *
  57  * @param[in]   ctx     the pointer to a VADriverContext
  58  * @param[out]  driver_name_ptr the newly allocated buffer containing
  59  *     the VA driver name
  60  * @return VA_STATUS_SUCCESS if operation is successful, or another
  61  *     #VAStatus value otherwise.
  62  */
  63 DLL_HIDDEN
  64 VAStatus
  65 VA_DRM_GetDriverName(VADriverContextP ctx, char **driver_name_ptr);
  66
  67 /**@}*/
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif
  72
  73 #endif /* VA_DRM_UTILS_H */