• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2014 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /*
18  * This file defines an NDK API.
19  * Do not remove methods.
20  * Do not change method signatures.
21  * Do not change the value of constants.
22  * Do not change the size of any of the classes defined in here.
23  * Do not reference types that are not part of the NDK.
24  * Do not #include files that aren't part of the NDK.
25  */
26 
27 #ifndef _NDK_MEDIA_FORMAT_H
28 #define _NDK_MEDIA_FORMAT_H
29 
30 #include <sys/cdefs.h>
31 #include <sys/types.h>
32 
33 #include "NdkMediaError.h"
34 
35 __BEGIN_DECLS
36 
37 struct AMediaFormat;
38 typedef struct AMediaFormat AMediaFormat;
39 
40 #if __ANDROID_API__ >= 21
41 
42 AMediaFormat *AMediaFormat_new();
43 media_status_t AMediaFormat_delete(AMediaFormat*);
44 
45 /**
46  * Human readable representation of the format. The returned string is owned by the format,
47  * and remains valid until the next call to toString, or until the format is deleted.
48  */
49 const char* AMediaFormat_toString(AMediaFormat*);
50 
51 bool AMediaFormat_getInt32(AMediaFormat*, const char *name, int32_t *out);
52 bool AMediaFormat_getInt64(AMediaFormat*, const char *name, int64_t *out);
53 bool AMediaFormat_getFloat(AMediaFormat*, const char *name, float *out);
54 bool AMediaFormat_getSize(AMediaFormat*, const char *name, size_t *out);
55 /**
56  * The returned data is owned by the format and remains valid as long as the named entry
57  * is part of the format.
58  */
59 bool AMediaFormat_getBuffer(AMediaFormat*, const char *name, void** data, size_t *size);
60 /**
61  * The returned string is owned by the format, and remains valid until the next call to getString,
62  * or until the format is deleted.
63  */
64 bool AMediaFormat_getString(AMediaFormat*, const char *name, const char **out);
65 
66 
67 void AMediaFormat_setInt32(AMediaFormat*, const char* name, int32_t value);
68 void AMediaFormat_setInt64(AMediaFormat*, const char* name, int64_t value);
69 void AMediaFormat_setFloat(AMediaFormat*, const char* name, float value);
70 /**
71  * The provided string is copied into the format.
72  */
73 void AMediaFormat_setString(AMediaFormat*, const char* name, const char* value);
74 /**
75  * The provided data is copied into the format.
76  */
77 void AMediaFormat_setBuffer(AMediaFormat*, const char* name, void* data, size_t size);
78 
79 
80 
81 /**
82  * XXX should these be ints/enums that we look up in a table as needed?
83  */
84 extern const char* AMEDIAFORMAT_KEY_AAC_DRC_ATTENUATION_FACTOR;
85 extern const char* AMEDIAFORMAT_KEY_AAC_DRC_BOOST_FACTOR;
86 extern const char* AMEDIAFORMAT_KEY_AAC_DRC_HEAVY_COMPRESSION;
87 extern const char* AMEDIAFORMAT_KEY_AAC_DRC_TARGET_REFERENCE_LEVEL;
88 extern const char* AMEDIAFORMAT_KEY_AAC_ENCODED_TARGET_LEVEL;
89 extern const char* AMEDIAFORMAT_KEY_AAC_MAX_OUTPUT_CHANNEL_COUNT;
90 extern const char* AMEDIAFORMAT_KEY_AAC_PROFILE;
91 extern const char* AMEDIAFORMAT_KEY_AAC_SBR_MODE;
92 extern const char* AMEDIAFORMAT_KEY_AUDIO_SESSION_ID;
93 extern const char* AMEDIAFORMAT_KEY_BITRATE_MODE;
94 extern const char* AMEDIAFORMAT_KEY_BIT_RATE;
95 extern const char* AMEDIAFORMAT_KEY_CAPTURE_RATE;
96 extern const char* AMEDIAFORMAT_KEY_CHANNEL_COUNT;
97 extern const char* AMEDIAFORMAT_KEY_CHANNEL_MASK;
98 extern const char* AMEDIAFORMAT_KEY_COLOR_FORMAT;
99 extern const char* AMEDIAFORMAT_KEY_COLOR_RANGE;
100 extern const char* AMEDIAFORMAT_KEY_COLOR_STANDARD;
101 extern const char* AMEDIAFORMAT_KEY_COLOR_TRANSFER;
102 extern const char* AMEDIAFORMAT_KEY_COMPLEXITY;
103 extern const char* AMEDIAFORMAT_KEY_CSD;
104 extern const char* AMEDIAFORMAT_KEY_CSD_0;
105 extern const char* AMEDIAFORMAT_KEY_CSD_1;
106 extern const char* AMEDIAFORMAT_KEY_CSD_2;
107 extern const char* AMEDIAFORMAT_KEY_DISPLAY_CROP;
108 extern const char* AMEDIAFORMAT_KEY_DISPLAY_HEIGHT;
109 extern const char* AMEDIAFORMAT_KEY_DISPLAY_WIDTH;
110 extern const char* AMEDIAFORMAT_KEY_DURATION;
111 extern const char* AMEDIAFORMAT_KEY_FLAC_COMPRESSION_LEVEL;
112 extern const char* AMEDIAFORMAT_KEY_FRAME_RATE;
113 extern const char* AMEDIAFORMAT_KEY_GRID_COLUMNS;
114 extern const char* AMEDIAFORMAT_KEY_GRID_ROWS;
115 extern const char* AMEDIAFORMAT_KEY_HDR_STATIC_INFO;
116 extern const char* AMEDIAFORMAT_KEY_HEIGHT;
117 extern const char* AMEDIAFORMAT_KEY_INTRA_REFRESH_PERIOD;
118 extern const char* AMEDIAFORMAT_KEY_IS_ADTS;
119 extern const char* AMEDIAFORMAT_KEY_IS_AUTOSELECT;
120 extern const char* AMEDIAFORMAT_KEY_IS_DEFAULT;
121 extern const char* AMEDIAFORMAT_KEY_IS_FORCED_SUBTITLE;
122 extern const char* AMEDIAFORMAT_KEY_I_FRAME_INTERVAL;
123 extern const char* AMEDIAFORMAT_KEY_LANGUAGE;
124 extern const char* AMEDIAFORMAT_KEY_LATENCY;
125 extern const char* AMEDIAFORMAT_KEY_LEVEL;
126 extern const char* AMEDIAFORMAT_KEY_MAX_HEIGHT;
127 extern const char* AMEDIAFORMAT_KEY_MAX_INPUT_SIZE;
128 extern const char* AMEDIAFORMAT_KEY_MAX_WIDTH;
129 extern const char* AMEDIAFORMAT_KEY_MIME;
130 extern const char* AMEDIAFORMAT_KEY_MPEG_USER_DATA;
131 extern const char* AMEDIAFORMAT_KEY_OPERATING_RATE;
132 extern const char* AMEDIAFORMAT_KEY_PCM_ENCODING;
133 extern const char* AMEDIAFORMAT_KEY_PRIORITY;
134 extern const char* AMEDIAFORMAT_KEY_PROFILE;
135 extern const char* AMEDIAFORMAT_KEY_PUSH_BLANK_BUFFERS_ON_STOP;
136 extern const char* AMEDIAFORMAT_KEY_REPEAT_PREVIOUS_FRAME_AFTER;
137 extern const char* AMEDIAFORMAT_KEY_ROTATION;
138 extern const char* AMEDIAFORMAT_KEY_SAMPLE_RATE;
139 extern const char* AMEDIAFORMAT_KEY_SEI;
140 extern const char* AMEDIAFORMAT_KEY_SLICE_HEIGHT;
141 extern const char* AMEDIAFORMAT_KEY_STRIDE;
142 extern const char* AMEDIAFORMAT_KEY_TEMPORAL_LAYER_ID;
143 extern const char* AMEDIAFORMAT_KEY_TEMPORAL_LAYERING;
144 extern const char* AMEDIAFORMAT_KEY_TILE_HEIGHT;
145 extern const char* AMEDIAFORMAT_KEY_TILE_WIDTH;
146 extern const char* AMEDIAFORMAT_KEY_TIME_US;
147 extern const char* AMEDIAFORMAT_KEY_TRACK_ID;
148 extern const char* AMEDIAFORMAT_KEY_TRACK_INDEX;
149 extern const char* AMEDIAFORMAT_KEY_WIDTH;
150 
151 #endif /* __ANDROID_API__ >= 21 */
152 
153 #if __ANDROID_API__ >= 28
154 bool AMediaFormat_getDouble(AMediaFormat*, const char *name, double *out);
155 bool AMediaFormat_getRect(AMediaFormat*, const char *name,
156                           int32_t *left, int32_t *top, int32_t *right, int32_t *bottom);
157 
158 void AMediaFormat_setDouble(AMediaFormat*, const char* name, double value);
159 void AMediaFormat_setSize(AMediaFormat*, const char* name, size_t value);
160 void AMediaFormat_setRect(AMediaFormat*, const char* name,
161                           int32_t left, int32_t top, int32_t right, int32_t bottom);
162 #endif /* __ANDROID_API__ >= 28 */
163 
164 __END_DECLS
165 
166 #endif // _NDK_MEDIA_FORMAT_H
167