xref: /aosp_15_r20/external/intel-media-driver/media_softlet/agnostic/common/os/mos_mediacopy_base.h (revision ba62d9d3abf0e404f2022b4cd7a85e107f48596f)
1 /*
2 * Copyright (c) 2020-2022, 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 //!
24 //! \file        mos_mediacopy_base.h
25 //! \brief       This module defines MOS decompression on linux platform
26 //!
27 #ifndef __MOS_MEDIACOPY_BASE_H__
28 #define __MOS_MEDIACOPY_BASE_H__
29 
30 #include "mos_os.h"
31 #include "media_copy.h"
32 
33 class MosMediaCopyBase
34 {
35 public:
36     //!
37     //! \brief    constructor
38     //!
39     MosMediaCopyBase(PMOS_CONTEXT mosCtx);
40 
41     //!
42     //! \brief    destructor
43     //!
44     virtual ~MosMediaCopyBase();
45 
46     virtual MediaCopyBaseState **GetMediaCopyState();
47 
48     //!
49     //! \brief    Media copy
50     //! \details  Entry point to copy media memory, input can support both compressed/uncompressed
51     //! \param    [in] inputResource
52     //!            The surface resource will be decompressed
53     //! \param    [out] outputResource
54     //!            The target uncompressed surface resource will be copied to
55     //! \param    [in] preferMethod
56     //!            The preferred copy mode
57     //!
58     //! \return   MOS_STATUS_SUCCESS if succeeded, else error code.
59     //!
60     MOS_STATUS MediaCopy(
61         PMOS_RESOURCE inputResource,
62         PMOS_RESOURCE outputResource,
63         MCPY_METHOD   preferMethod);
64 
65     //!
66     //! \brief    Is AIL force opition.
67     //! \details  Is AIL force opition.
68     //! \return   bool
69     //!           Return true if support, otherwise return false.
70     bool IsAILForceOption();
71 
72     // Get mos interfae
73     virtual PMOS_INTERFACE GetMediaCopyMosInterface();
74 
75 protected:
76     MediaCopyBaseState *m_mediaCopyState = nullptr;
77     PMOS_CONTEXT        m_mosContext     = nullptr;
78 MEDIA_CLASS_DEFINE_END(MosMediaCopyBase)
79 };
80 
81 #endif // __MOS_MEDIACOPY_BASE_H__
82