1 /* 2 * This file is part of FFmpeg. 3 * 4 * FFmpeg is free software; you can redistribute it and/or 5 * modify it under the terms of the GNU Lesser General Public 6 * License as published by the Free Software Foundation; either 7 * version 2.1 of the License, or (at your option) any later version. 8 * 9 * FFmpeg is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 * Lesser General Public License for more details. 13 * 14 * You should have received a copy of the GNU Lesser General Public 15 * License along with FFmpeg; if not, write to the Free Software 16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 17 */ 18 19 #ifndef AVUTIL_FILE_H 20 #define AVUTIL_FILE_H 21 22 #include <stdint.h> 23 24 #include "avutil.h" 25 26 /** 27 * @file 28 * Misc file utilities. 29 */ 30 31 /** 32 * Read the file with name filename, and put its content in a newly 33 * allocated buffer or map it with mmap() when available. 34 * In case of success set *bufptr to the read or mmapped buffer, and 35 * *size to the size in bytes of the buffer in *bufptr. 36 * Unlike mmap this function succeeds with zero sized files, in this 37 * case *bufptr will be set to NULL and *size will be set to 0. 38 * The returned buffer must be released with av_file_unmap(). 39 * 40 * @param log_offset loglevel offset used for logging 41 * @param log_ctx context used for logging 42 * @return a non negative number in case of success, a negative value 43 * corresponding to an AVERROR error code in case of failure 44 */ 45 av_warn_unused_result 46 int av_file_map(const char *filename, uint8_t **bufptr, size_t *size, 47 int log_offset, void *log_ctx); 48 49 /** 50 * Unmap or free the buffer bufptr created by av_file_map(). 51 * 52 * @param size size in bytes of bufptr, must be the same as returned 53 * by av_file_map() 54 */ 55 void av_file_unmap(uint8_t *bufptr, size_t size); 56 57 /** 58 * Wrapper to work around the lack of mkstemp() on mingw. 59 * Also, tries to create file in /tmp first, if possible. 60 * *prefix can be a character constant; *filename will be allocated internally. 61 * @return file descriptor of opened file (or negative value corresponding to an 62 * AVERROR code on error) 63 * and opened file name in **filename. 64 * @note On very old libcs it is necessary to set a secure umask before 65 * calling this, av_tempfile() can't call umask itself as it is used in 66 * libraries and could interfere with the calling application. 67 * @deprecated as fd numbers cannot be passed saftely between libs on some platforms 68 */ 69 int av_tempfile(const char *prefix, char **filename, int log_offset, void *log_ctx); 70 71 #endif /* AVUTIL_FILE_H */ 72