File: mfx_task.h

package info (click to toggle)
intel-mediasdk 22.5.4-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 86,508 kB
  • sloc: cpp: 1,055,709; ansic: 25,847; asm: 17,754; python: 8,951; cs: 965; sh: 543; makefile: 528; lisp: 52
file content (137 lines) | stat: -rw-r--r-- 4,538 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
// Copyright (c) 2017 Intel Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

#ifndef __MFX_TASK_H
#define __MFX_TASK_H

#include <mfxplugin.h>
#include <mfx_thread_task.h>
#include <mfx_task_threading_policy.h>

enum
{
    // Declare the maximum number of source or destination dependencies
    MFX_TASK_NUM_DEPENDENCIES   = 4
};

enum
{
    // Declare overall number of priorities
    MFX_PRIORITY_NUMBER = MFX_PRIORITY_HIGH + 1

};

// Declare implementation types
enum
{
    MFX_TYPE_HARDWARE = 0,
    MFX_TYPE_SOFTWARE = 1,
    MFX_TYPE_NUMBER
};

#define MFX_TASK_NEED_CONTINUE MFX_TASK_WORKING

enum
{
    MFX_TRACE_ID_DECODE  = 0x10000000,
    MFX_TRACE_ID_VPP     = 0x20000000,
    MFX_TRACE_ID_VPP2    = 0x30000000,
    MFX_TRACE_ID_ENCODE  = 0x40000000,
    MFX_TRACE_ID_ENCODE2 = 0x50000000,
    MFX_TRACE_ID_USER    = 0x60000000,
};

inline
bool isFailed(mfxStatus mfxRes)
{
    return (MFX_ERR_NONE > mfxRes);

} // bool isFailed(mfxStatus mfxRes)

/* declare type for MFX task callbacks.
Usually, most thread API involve a single parameter.
MFX callback function require 3 parameters to make developers' life.
pState - is a pointer to the performing object or something like this.
pParam - is an addition parameter to destingush one task from the another inside
    the entry point. It is possible to start different threads with the same
    object (pState), but different task (pParam). Usually, it is a handle or some
    internal pointer.
threadNumber - number of the current additional thread. It can be any number
    not exceeding the maximum required threads for given task. */
typedef mfxStatus (*mfxTaskRoutine) (void *pState, void *pParam, mfxU32 threadNumber, mfxU32 callNumber);
typedef mfxStatus (*mfxTaskCompleteProc) (void *pState, void *pParam, mfxStatus taskRes);
typedef mfxStatus (*mfxGetSubTaskProc) (void *pState, void *pParam, void **ppSubTask);
typedef mfxStatus (*mfxCompleteSubTaskProc) (void *pState, void *pParam, void *pSubTask, mfxStatus taskRes);

typedef
struct MFX_ENTRY_POINT
{
    // pointer to the task processing object
    void *pState;
    // pointer to the task's parameter
    void *pParam;

    // pointer to the task processing routine
    mfxTaskRoutine pRoutine;
    // pointer to the task completing procedure
    mfxTaskCompleteProc pCompleteProc;

    // pointer to get a sub-task from the component (NON-OBLIGATORY)
    mfxGetSubTaskProc pGetSubTaskProc;
    // sub-task is complete. Update the status of it (NON-OBLIGATORY)
    mfxCompleteSubTaskProc pCompleteSubTaskProc;

    // number of simultaneously allowed threads for the task
    mfxU32 requiredNumThreads;

    // name of routine - for debug and tracing purpose
    const char *pRoutineName;
} MFX_ENTRY_POINT;

struct MFX_TASK
{
    // Pointer to task owning object
    void *pOwner;

    // Task parameters provided by the component
    MFX_ENTRY_POINT entryPoint;

    // legacy parameters should be eliminated
    bool bObsoleteTask;
    MFX_THREAD_TASK_PARAMETERS obsolete_params;

    // these are not a source/destination parameters,
    // these are only in/out dependencies.

    // Array of source dependencies
    const void *pSrc[MFX_TASK_NUM_DEPENDENCIES];
    // Array of destination dependencies
    void *pDst[MFX_TASK_NUM_DEPENDENCIES];

    // Task's priority
    mfxPriority priority;
    // how the object processes the tasks
    mfxTaskThreadingPolicy threadingPolicy;

    unsigned int nTaskId;
    unsigned int nParentId;
};

#endif // __MFX_TASK_H