NdkMediaExtractor.h revision 050eb3280d7305b84f723d515be2dc9606dc39d1
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/* 19 * This file defines an NDK API. 20 * Do not remove methods. 21 * Do not change method signatures. 22 * Do not change the value of constants. 23 * Do not change the size of any of the classes defined in here. 24 * Do not reference types that are not part of the NDK. 25 * Do not #include files that aren't part of the NDK. 26 */ 27 28#ifndef _NDK_MEDIA_EXTRACTOR_H 29#define _NDK_MEDIA_EXTRACTOR_H 30 31#include <sys/types.h> 32 33#include "NdkMediaCodec.h" 34#include "NdkMediaFormat.h" 35#include "NdkMediaCrypto.h" 36 37#ifdef __cplusplus 38extern "C" { 39#endif 40 41struct AMediaExtractor; 42typedef struct AMediaExtractor AMediaExtractor; 43 44 45/** 46 * Create new media extractor 47 */ 48AMediaExtractor* AMediaExtractor_new(); 49 50/** 51 * Delete a previously created media extractor 52 */ 53int AMediaExtractor_delete(AMediaExtractor*); 54 55/** 56 * Set the file descriptor from which the extractor will read. 57 */ 58int AMediaExtractor_setDataSourceFd(AMediaExtractor*, int fd, off64_t offset, off64_t length); 59 60/** 61 * Set the URI from which the extractor will read. 62 */ 63int AMediaExtractor_setDataSource(AMediaExtractor*, const char *location); // TODO support headers 64 65/** 66 * Return the number of tracks in the previously specified media file 67 */ 68int AMediaExtractor_getTrackCount(AMediaExtractor*); 69 70/** 71 * Return the format of the specified track. The caller must free the returned format 72 */ 73AMediaFormat* AMediaExtractor_getTrackFormat(AMediaExtractor*, size_t idx); 74 75/** 76 * Select the specified track. Subsequent calls to readSampleData, getSampleTrackIndex and 77 * getSampleTime only retrieve information for the subset of tracks selected. 78 * Selecting the same track multiple times has no effect, the track is 79 * only selected once. 80 */ 81int AMediaExtractor_selectTrack(AMediaExtractor*, size_t idx); 82 83/** 84 * Unselect the specified track. Subsequent calls to readSampleData, getSampleTrackIndex and 85 * getSampleTime only retrieve information for the subset of tracks selected.. 86 */ 87int AMediaExtractor_unselectTrack(AMediaExtractor*, size_t idx); 88 89/** 90 * Read the current sample. 91 */ 92int AMediaExtractor_readSampleData(AMediaExtractor*, uint8_t *buffer, size_t capacity); 93 94/** 95 * Read the current sample's flags. 96 */ 97int AMediaExtractor_getSampleFlags(AMediaExtractor*); // see definitions below 98 99/** 100 * Returns the track index the current sample originates from (or -1 101 * if no more samples are available) 102 */ 103int AMediaExtractor_getSampleTrackIndex(AMediaExtractor*); 104 105/** 106 * Returns the current sample's presentation time in microseconds. 107 * or -1 if no more samples are available. 108 */ 109int64_t AMediaExtractor_getSampletime(AMediaExtractor*); 110 111/** 112 * Advance to the next sample. Returns false if no more sample data 113 * is available (end of stream). 114 */ 115bool AMediaExtractor_advance(AMediaExtractor*); 116 117 118/** 119 * mapping of crypto scheme uuid to the scheme specific data for that scheme 120 */ 121typedef struct PsshEntry { 122 AMediaUUID uuid; 123 size_t datalen; 124 void *data; 125} PsshEntry; 126 127/** 128 * list of crypto schemes and their data 129 */ 130typedef struct PsshInfo { 131 size_t numentries; 132 PsshEntry entries[0]; 133} PsshInfo; 134 135/** 136 * Get the PSSH info if present. 137 */ 138PsshInfo* AMediaExtractor_getPsshInfo(AMediaExtractor*); 139 140 141AMediaCodecCryptoInfo *AMediaExtractor_getSampleCryptoInfo(AMediaExtractor *); 142 143 144enum { 145 AMEDIAEXTRACTOR_SAMPLE_FLAG_SYNC = 1, 146 AMEDIAEXTRACTOR_SAMPLE_FLAG_ENCRYPTED = 2, 147}; 148 149 150#ifdef __cplusplus 151} // extern "C" 152#endif 153 154#endif // _NDK_MEDIA_EXTRACTOR_H 155