Debian Codegraph @

media_softlet/agnostic/common/os/mos_user_setting.h

raw
1 /*
2 * Copyright (c) 2021, Intel Corporation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included
12 * in all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
21 */
22 //!
23 //! \file mos_user_setting.h
24 //! \brief This file defines the user settings of mos
25 //! \details Common OS debug across different platform
26 //!
27
28 #ifndef _MOS_USER_SETTING_
29 #define _MOS_USER_SETTING_
30
31 #include "mos_defs.h"
32 #include "media_user_setting.h"
33
34 class MosUserSetting
35 {
36 public:
37 //!
38 //! \brief Init the mos user settings
39 //! \details declare the common user settings
40 //! \return MOS_STATUS
41 //! Returns one of the MOS_STATUS error codes if failed,
42 //! else MOS_STATUS_SUCCESS
43 //!
44 static MOS_STATUS InitMosUserSetting(MediaUserSettingSharedPtr userSettingPtr);
45
46 //!
47 //! \brief Init user settings
48 //! \details declare the ddi user settings
49 //! \return MOS_STATUS
50 //! Returns one of the MOS_STATUS error codes if failed,
51 //! else MOS_STATUS_SUCCESS
52 //!
53 static MOS_STATUS InitMosUserSettingSpecific(MediaUserSettingSharedPtr userSettingPtr);
54
55 private:
56 //!
57 //! \brief Init the mos user settings of mos message
58 //! \details declare the common user settings
59 //! \return MOS_STATUS
60 //! Returns one of the MOS_STATUS error codes if failed,
61 //! else MOS_STATUS_SUCCESS
62 //!
63 static MOS_STATUS InitMosCommonUserSetting(MediaUserSettingSharedPtr userSettingPtr);
64
65 #if MOS_MESSAGES_ENABLED
66 //!
67 //! \brief Init the mos user settings of mos message
68 //! \details declare the common user settings
69 //! \return MOS_STATUS
70 //! Returns one of the MOS_STATUS error codes if failed,
71 //! else MOS_STATUS_SUCCESS
72 //!
73 static MOS_STATUS InitMosMessageUserSetting(MediaUserSettingSharedPtr userSettingPtr);
74 #endif
75
76 #if (_DEBUG || _RELEASE_INTERNAL)
77 //!
78 //! \brief Init the mos user settings of debug
79 //! \details declare the common user settings for debug
80 //! \return MOS_STATUS
81 //! Returns one of the MOS_STATUS error codes if failed,
82 //! else MOS_STATUS_SUCCESS
83 //!
84 static MOS_STATUS InitUserSettingForDebug(MediaUserSettingSharedPtr userSettingPtr);
85 #endif
86
87 MEDIA_CLASS_DEFINE_END(MosUserSetting)
88 };
89 #endif //_MOS_USER_SETTING_