FFmpeg
file.h
Go to the documentation of this file.
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 <stddef.h>
23 #include <stdint.h>
24 
25 #include "version.h"
26 #include "attributes.h"
27 
28 /**
29  * @file
30  * Misc file utilities.
31  */
32 
33 /**
34  * Read the file with name filename, and put its content in a newly
35  * allocated buffer or map it with mmap() when available.
36  * In case of success set *bufptr to the read or mmapped buffer, and
37  * *size to the size in bytes of the buffer in *bufptr.
38  * Unlike mmap this function succeeds with zero sized files, in this
39  * case *bufptr will be set to NULL and *size will be set to 0.
40  * The returned buffer must be released with av_file_unmap().
41  *
42  * @param filename path to the file
43  * @param[out] bufptr pointee is set to the mapped or allocated buffer
44  * @param[out] size pointee is set to the size in bytes of the buffer
45  * @param log_offset loglevel offset used for logging
46  * @param log_ctx context used for logging
47  * @return a non negative number in case of success, a negative value
48  * corresponding to an AVERROR error code in case of failure
49  */
51 int av_file_map(const char *filename, uint8_t **bufptr, size_t *size,
52  int log_offset, void *log_ctx);
53 
54 /**
55  * Unmap or free the buffer bufptr created by av_file_map().
56  *
57  * @param bufptr the buffer previously created with av_file_map()
58  * @param size size in bytes of bufptr, must be the same as returned
59  * by av_file_map()
60  */
61 void av_file_unmap(uint8_t *bufptr, size_t size);
62 
63 #if FF_API_AV_FOPEN_UTF8
64 /**
65  * Wrapper to work around the lack of mkstemp() on mingw.
66  * Also, tries to create file in /tmp first, if possible.
67  * *prefix can be a character constant; *filename will be allocated internally.
68  * @return file descriptor of opened file (or negative value corresponding to an
69  * AVERROR code on error)
70  * and opened file name in **filename.
71  * @note On very old libcs it is necessary to set a secure umask before
72  * calling this, av_tempfile() can't call umask itself as it is used in
73  * libraries and could interfere with the calling application.
74  * @deprecated as fd numbers cannot be passed saftely between libs on some platforms
75  */
77 int av_tempfile(const char *prefix, char **filename, int log_offset, void *log_ctx);
78 #endif
79 
80 #endif /* AVUTIL_FILE_H */
av_tempfile
attribute_deprecated int av_tempfile(const char *prefix, char **filename, int log_offset, void *log_ctx)
Wrapper to work around the lack of mkstemp() on mingw.
Definition: file.c:160
av_file_map
av_warn_unused_result int av_file_map(const char *filename, uint8_t **bufptr, size_t *size, int log_offset, void *log_ctx)
Read the file with name filename, and put its content in a newly allocated buffer or map it with mmap...
Definition: file.c:55
av_file_unmap
void av_file_unmap(uint8_t *bufptr, size_t size)
Unmap or free the buffer bufptr created by av_file_map().
Definition: file.c:146
size
int size
Definition: twinvq_data.h:10344
attribute_deprecated
#define attribute_deprecated
Definition: attributes.h:104
attributes.h
av_warn_unused_result
#define av_warn_unused_result
Definition: attributes.h:64
version.h