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 * @addtogroup Media 19 * @{ 20 */ 21 22 /** 23 * @file NdkMediaFormat.h 24 */ 25 26 /* 27 * This file defines an NDK API. 28 * Do not remove methods. 29 * Do not change method signatures. 30 * Do not change the value of constants. 31 * Do not change the size of any of the classes defined in here. 32 * Do not reference types that are not part of the NDK. 33 * Do not #include files that aren't part of the NDK. 34 */ 35 36 #ifndef _NDK_MEDIA_FORMAT_H 37 #define _NDK_MEDIA_FORMAT_H 38 39 #include <sys/cdefs.h> 40 #include <sys/types.h> 41 42 #include "NdkMediaError.h" 43 44 __BEGIN_DECLS 45 46 struct AMediaFormat; 47 typedef struct AMediaFormat AMediaFormat; 48 49 #if __ANDROID_API__ >= 21 50 51 AMediaFormat *AMediaFormat_new() __INTRODUCED_IN(21); 52 media_status_t AMediaFormat_delete(AMediaFormat*) __INTRODUCED_IN(21); 53 54 /** 55 * Human readable representation of the format. The returned string is owned by the format, 56 * and remains valid until the next call to toString, or until the format is deleted. 57 */ 58 const char* AMediaFormat_toString(AMediaFormat*) __INTRODUCED_IN(21); 59 60 bool AMediaFormat_getInt32(AMediaFormat*, const char *name, int32_t *out) __INTRODUCED_IN(21); 61 bool AMediaFormat_getInt64(AMediaFormat*, const char *name, int64_t *out) __INTRODUCED_IN(21); 62 bool AMediaFormat_getFloat(AMediaFormat*, const char *name, float *out) __INTRODUCED_IN(21); 63 bool AMediaFormat_getSize(AMediaFormat*, const char *name, size_t *out) __INTRODUCED_IN(21); 64 /** 65 * The returned data is owned by the format and remains valid as long as the named entry 66 * is part of the format. 67 */ 68 bool AMediaFormat_getBuffer(AMediaFormat*, const char *name, void** data, size_t *size) __INTRODUCED_IN(21); 69 /** 70 * The returned string is owned by the format, and remains valid until the next call to getString, 71 * or until the format is deleted. 72 */ 73 bool AMediaFormat_getString(AMediaFormat*, const char *name, const char **out) __INTRODUCED_IN(21); 74 75 76 void AMediaFormat_setInt32(AMediaFormat*, const char* name, int32_t value) __INTRODUCED_IN(21); 77 void AMediaFormat_setInt64(AMediaFormat*, const char* name, int64_t value) __INTRODUCED_IN(21); 78 void AMediaFormat_setFloat(AMediaFormat*, const char* name, float value) __INTRODUCED_IN(21); 79 /** 80 * The provided string is copied into the format. 81 */ 82 void AMediaFormat_setString(AMediaFormat*, const char* name, const char* value) __INTRODUCED_IN(21); 83 /** 84 * The provided data is copied into the format. 85 */ 86 void AMediaFormat_setBuffer(AMediaFormat*, const char* name, const void* data, size_t size) __INTRODUCED_IN(21); 87 88 89 extern const char* AMEDIAFORMAT_KEY_AAC_DRC_ATTENUATION_FACTOR __INTRODUCED_IN(28); 90 extern const char* AMEDIAFORMAT_KEY_AAC_DRC_BOOST_FACTOR __INTRODUCED_IN(28); 91 extern const char* AMEDIAFORMAT_KEY_AAC_DRC_HEAVY_COMPRESSION __INTRODUCED_IN(28); 92 extern const char* AMEDIAFORMAT_KEY_AAC_DRC_TARGET_REFERENCE_LEVEL __INTRODUCED_IN(28); 93 extern const char* AMEDIAFORMAT_KEY_AAC_ENCODED_TARGET_LEVEL __INTRODUCED_IN(28); 94 extern const char* AMEDIAFORMAT_KEY_AAC_MAX_OUTPUT_CHANNEL_COUNT __INTRODUCED_IN(28); 95 extern const char* AMEDIAFORMAT_KEY_AAC_PROFILE __INTRODUCED_IN(21); 96 extern const char* AMEDIAFORMAT_KEY_AAC_SBR_MODE __INTRODUCED_IN(28); 97 extern const char* AMEDIAFORMAT_KEY_AUDIO_SESSION_ID __INTRODUCED_IN(28); 98 extern const char* AMEDIAFORMAT_KEY_BITRATE_MODE __INTRODUCED_IN(28); 99 extern const char* AMEDIAFORMAT_KEY_BIT_RATE __INTRODUCED_IN(21); 100 extern const char* AMEDIAFORMAT_KEY_CAPTURE_RATE __INTRODUCED_IN(28); 101 extern const char* AMEDIAFORMAT_KEY_CHANNEL_COUNT __INTRODUCED_IN(21); 102 extern const char* AMEDIAFORMAT_KEY_CHANNEL_MASK __INTRODUCED_IN(21); 103 extern const char* AMEDIAFORMAT_KEY_COLOR_FORMAT __INTRODUCED_IN(21); 104 extern const char* AMEDIAFORMAT_KEY_COLOR_RANGE __INTRODUCED_IN(28); 105 extern const char* AMEDIAFORMAT_KEY_COLOR_STANDARD __INTRODUCED_IN(28); 106 extern const char* AMEDIAFORMAT_KEY_COLOR_TRANSFER __INTRODUCED_IN(28); 107 extern const char* AMEDIAFORMAT_KEY_COMPLEXITY __INTRODUCED_IN(28); 108 extern const char* AMEDIAFORMAT_KEY_CSD __INTRODUCED_IN(28); 109 extern const char* AMEDIAFORMAT_KEY_CSD_0 __INTRODUCED_IN(28); 110 extern const char* AMEDIAFORMAT_KEY_CSD_1 __INTRODUCED_IN(28); 111 extern const char* AMEDIAFORMAT_KEY_CSD_2 __INTRODUCED_IN(28); 112 extern const char* AMEDIAFORMAT_KEY_DISPLAY_CROP __INTRODUCED_IN(28); 113 extern const char* AMEDIAFORMAT_KEY_DISPLAY_HEIGHT __INTRODUCED_IN(28); 114 extern const char* AMEDIAFORMAT_KEY_DISPLAY_WIDTH __INTRODUCED_IN(28); 115 extern const char* AMEDIAFORMAT_KEY_DURATION __INTRODUCED_IN(21); 116 extern const char* AMEDIAFORMAT_KEY_FLAC_COMPRESSION_LEVEL __INTRODUCED_IN(21); 117 extern const char* AMEDIAFORMAT_KEY_FRAME_RATE __INTRODUCED_IN(21); 118 extern const char* AMEDIAFORMAT_KEY_GRID_COLUMNS __INTRODUCED_IN(28); 119 extern const char* AMEDIAFORMAT_KEY_GRID_ROWS __INTRODUCED_IN(28); 120 extern const char* AMEDIAFORMAT_KEY_HDR_STATIC_INFO __INTRODUCED_IN(28); 121 extern const char* AMEDIAFORMAT_KEY_HEIGHT __INTRODUCED_IN(21); 122 extern const char* AMEDIAFORMAT_KEY_INTRA_REFRESH_PERIOD __INTRODUCED_IN(28); 123 extern const char* AMEDIAFORMAT_KEY_IS_ADTS __INTRODUCED_IN(21); 124 extern const char* AMEDIAFORMAT_KEY_IS_AUTOSELECT __INTRODUCED_IN(21); 125 extern const char* AMEDIAFORMAT_KEY_IS_DEFAULT __INTRODUCED_IN(21); 126 extern const char* AMEDIAFORMAT_KEY_IS_FORCED_SUBTITLE __INTRODUCED_IN(21); 127 extern const char* AMEDIAFORMAT_KEY_I_FRAME_INTERVAL __INTRODUCED_IN(21); 128 extern const char* AMEDIAFORMAT_KEY_LANGUAGE __INTRODUCED_IN(21); 129 extern const char* AMEDIAFORMAT_KEY_LATENCY __INTRODUCED_IN(28); 130 extern const char* AMEDIAFORMAT_KEY_LEVEL __INTRODUCED_IN(28); 131 extern const char* AMEDIAFORMAT_KEY_MAX_HEIGHT __INTRODUCED_IN(21); 132 extern const char* AMEDIAFORMAT_KEY_MAX_INPUT_SIZE __INTRODUCED_IN(21); 133 extern const char* AMEDIAFORMAT_KEY_MAX_WIDTH __INTRODUCED_IN(21); 134 extern const char* AMEDIAFORMAT_KEY_MIME __INTRODUCED_IN(21); 135 extern const char* AMEDIAFORMAT_KEY_MPEG_USER_DATA __INTRODUCED_IN(28); 136 extern const char* AMEDIAFORMAT_KEY_OPERATING_RATE __INTRODUCED_IN(28); 137 extern const char* AMEDIAFORMAT_KEY_PCM_ENCODING __INTRODUCED_IN(28); 138 extern const char* AMEDIAFORMAT_KEY_PRIORITY __INTRODUCED_IN(28); 139 extern const char* AMEDIAFORMAT_KEY_PROFILE __INTRODUCED_IN(28); 140 extern const char* AMEDIAFORMAT_KEY_PUSH_BLANK_BUFFERS_ON_STOP __INTRODUCED_IN(21); 141 extern const char* AMEDIAFORMAT_KEY_REPEAT_PREVIOUS_FRAME_AFTER __INTRODUCED_IN(21); 142 extern const char* AMEDIAFORMAT_KEY_ROTATION __INTRODUCED_IN(28); 143 extern const char* AMEDIAFORMAT_KEY_SAMPLE_RATE __INTRODUCED_IN(21); 144 extern const char* AMEDIAFORMAT_KEY_SEI __INTRODUCED_IN(28); 145 extern const char* AMEDIAFORMAT_KEY_SLICE_HEIGHT __INTRODUCED_IN(28); 146 extern const char* AMEDIAFORMAT_KEY_STRIDE __INTRODUCED_IN(21); 147 extern const char* AMEDIAFORMAT_KEY_TEMPORAL_LAYER_ID __INTRODUCED_IN(28); 148 extern const char* AMEDIAFORMAT_KEY_TEMPORAL_LAYERING __INTRODUCED_IN(28); 149 extern const char* AMEDIAFORMAT_KEY_TILE_HEIGHT __INTRODUCED_IN(28); 150 extern const char* AMEDIAFORMAT_KEY_TILE_WIDTH __INTRODUCED_IN(28); 151 extern const char* AMEDIAFORMAT_KEY_TIME_US __INTRODUCED_IN(28); 152 extern const char* AMEDIAFORMAT_KEY_TRACK_ID __INTRODUCED_IN(28); 153 extern const char* AMEDIAFORMAT_KEY_TRACK_INDEX __INTRODUCED_IN(28); 154 extern const char* AMEDIAFORMAT_KEY_WIDTH __INTRODUCED_IN(21); 155 #endif /* __ANDROID_API__ >= 21 */ 156 157 #if __ANDROID_API__ >= 28 158 bool AMediaFormat_getDouble(AMediaFormat*, const char *name, double *out) __INTRODUCED_IN(28); 159 bool AMediaFormat_getRect(AMediaFormat*, const char *name, 160 int32_t *left, int32_t *top, int32_t *right, int32_t *bottom) __INTRODUCED_IN(28); 161 162 void AMediaFormat_setDouble(AMediaFormat*, const char* name, double value) __INTRODUCED_IN(28); 163 void AMediaFormat_setSize(AMediaFormat*, const char* name, size_t value) __INTRODUCED_IN(28); 164 void AMediaFormat_setRect(AMediaFormat*, const char* name, 165 int32_t left, int32_t top, int32_t right, int32_t bottom) __INTRODUCED_IN(28); 166 #endif /* __ANDROID_API__ >= 28 */ 167 168 #if __ANDROID_API__ >= 29 169 /** 170 * remove all key/value pairs from the given AMediaFormat 171 */ 172 void AMediaFormat_clear(AMediaFormat*) __INTRODUCED_IN(29); 173 174 /** 175 * copy one AMediaFormat to another 176 */ 177 media_status_t AMediaFormat_copy(AMediaFormat *to, AMediaFormat *from) __INTRODUCED_IN(29); 178 179 extern const char* AMEDIAFORMAT_KEY_ALBUM __INTRODUCED_IN(29); 180 extern const char* AMEDIAFORMAT_KEY_ALBUMART __INTRODUCED_IN(29); 181 extern const char* AMEDIAFORMAT_KEY_ALBUMARTIST __INTRODUCED_IN(29); 182 extern const char* AMEDIAFORMAT_KEY_ARTIST __INTRODUCED_IN(29); 183 extern const char* AMEDIAFORMAT_KEY_AUDIO_PRESENTATION_INFO __INTRODUCED_IN(29); 184 extern const char* AMEDIAFORMAT_KEY_AUDIO_PRESENTATION_PRESENTATION_ID __INTRODUCED_IN(29); 185 extern const char* AMEDIAFORMAT_KEY_AUDIO_PRESENTATION_PROGRAM_ID __INTRODUCED_IN(29); 186 extern const char* AMEDIAFORMAT_KEY_AUTHOR __INTRODUCED_IN(29); 187 extern const char* AMEDIAFORMAT_KEY_BITS_PER_SAMPLE __INTRODUCED_IN(29); 188 extern const char* AMEDIAFORMAT_KEY_CDTRACKNUMBER __INTRODUCED_IN(29); 189 extern const char* AMEDIAFORMAT_KEY_COMPILATION __INTRODUCED_IN(29); 190 extern const char* AMEDIAFORMAT_KEY_COMPOSER __INTRODUCED_IN(29); 191 extern const char* AMEDIAFORMAT_KEY_CREATE_INPUT_SURFACE_SUSPENDED __INTRODUCED_IN(29); 192 extern const char* AMEDIAFORMAT_KEY_CRYPTO_DEFAULT_IV_SIZE __INTRODUCED_IN(29); 193 extern const char* AMEDIAFORMAT_KEY_CRYPTO_ENCRYPTED_BYTE_BLOCK __INTRODUCED_IN(29); 194 extern const char* AMEDIAFORMAT_KEY_CRYPTO_ENCRYPTED_SIZES __INTRODUCED_IN(29); 195 extern const char* AMEDIAFORMAT_KEY_CRYPTO_IV __INTRODUCED_IN(29); 196 extern const char* AMEDIAFORMAT_KEY_CRYPTO_KEY __INTRODUCED_IN(29); 197 extern const char* AMEDIAFORMAT_KEY_CRYPTO_MODE __INTRODUCED_IN(29); 198 extern const char* AMEDIAFORMAT_KEY_CRYPTO_PLAIN_SIZES __INTRODUCED_IN(29); 199 extern const char* AMEDIAFORMAT_KEY_CRYPTO_SKIP_BYTE_BLOCK __INTRODUCED_IN(29); 200 extern const char* AMEDIAFORMAT_KEY_CSD_AVC __INTRODUCED_IN(29); 201 extern const char* AMEDIAFORMAT_KEY_CSD_HEVC __INTRODUCED_IN(29); 202 extern const char* AMEDIAFORMAT_KEY_D263 __INTRODUCED_IN(29); 203 extern const char* AMEDIAFORMAT_KEY_DATE __INTRODUCED_IN(29); 204 extern const char* AMEDIAFORMAT_KEY_DISCNUMBER __INTRODUCED_IN(29); 205 extern const char* AMEDIAFORMAT_KEY_ENCODER_DELAY __INTRODUCED_IN(29); 206 extern const char* AMEDIAFORMAT_KEY_ENCODER_PADDING __INTRODUCED_IN(29); 207 extern const char* AMEDIAFORMAT_KEY_ESDS __INTRODUCED_IN(29); 208 extern const char* AMEDIAFORMAT_KEY_EXIF_OFFSET __INTRODUCED_IN(29); 209 extern const char* AMEDIAFORMAT_KEY_EXIF_SIZE __INTRODUCED_IN(29); 210 extern const char* AMEDIAFORMAT_KEY_FRAME_COUNT __INTRODUCED_IN(29); 211 extern const char* AMEDIAFORMAT_KEY_GENRE __INTRODUCED_IN(29); 212 extern const char* AMEDIAFORMAT_KEY_HAPTIC_CHANNEL_COUNT __INTRODUCED_IN(29); 213 extern const char* AMEDIAFORMAT_KEY_ICC_PROFILE __INTRODUCED_IN(29); 214 extern const char* AMEDIAFORMAT_KEY_IS_SYNC_FRAME __INTRODUCED_IN(29); 215 extern const char* AMEDIAFORMAT_KEY_LOCATION __INTRODUCED_IN(29); 216 extern const char* AMEDIAFORMAT_KEY_LOOP __INTRODUCED_IN(29); 217 extern const char* AMEDIAFORMAT_KEY_LYRICIST __INTRODUCED_IN(29); 218 extern const char* AMEDIAFORMAT_KEY_MANUFACTURER __INTRODUCED_IN(29); 219 extern const char* AMEDIAFORMAT_KEY_MAX_BIT_RATE __INTRODUCED_IN(29); 220 extern const char* AMEDIAFORMAT_KEY_MAX_FPS_TO_ENCODER __INTRODUCED_IN(29); 221 extern const char* AMEDIAFORMAT_KEY_MAX_PTS_GAP_TO_ENCODER __INTRODUCED_IN(29); 222 extern const char* AMEDIAFORMAT_KEY_MPEG2_STREAM_HEADER __INTRODUCED_IN(29); 223 extern const char* AMEDIAFORMAT_KEY_PCM_BIG_ENDIAN __INTRODUCED_IN(29); 224 extern const char* AMEDIAFORMAT_KEY_PSSH __INTRODUCED_IN(29); 225 extern const char* AMEDIAFORMAT_KEY_SAR_HEIGHT __INTRODUCED_IN(29); 226 extern const char* AMEDIAFORMAT_KEY_SAR_WIDTH __INTRODUCED_IN(29); 227 extern const char* AMEDIAFORMAT_KEY_TARGET_TIME __INTRODUCED_IN(29); 228 extern const char* AMEDIAFORMAT_KEY_TEMPORAL_LAYER_COUNT __INTRODUCED_IN(29); 229 extern const char* AMEDIAFORMAT_KEY_TEXT_FORMAT_DATA __INTRODUCED_IN(29); 230 extern const char* AMEDIAFORMAT_KEY_THUMBNAIL_CSD_HEVC __INTRODUCED_IN(29); 231 extern const char* AMEDIAFORMAT_KEY_THUMBNAIL_HEIGHT __INTRODUCED_IN(29); 232 extern const char* AMEDIAFORMAT_KEY_THUMBNAIL_TIME __INTRODUCED_IN(29); 233 extern const char* AMEDIAFORMAT_KEY_THUMBNAIL_WIDTH __INTRODUCED_IN(29); 234 extern const char* AMEDIAFORMAT_KEY_TITLE __INTRODUCED_IN(29); 235 extern const char* AMEDIAFORMAT_KEY_VALID_SAMPLES __INTRODUCED_IN(29); 236 extern const char* AMEDIAFORMAT_KEY_YEAR __INTRODUCED_IN(29); 237 238 #endif /* __ANDROID_API__ >= 29 */ 239 240 __END_DECLS 241 242 #endif // _NDK_MEDIA_FORMAT_H 243 244 /** @} */ 245