libavutil/file.h
0328b9ea
 /*
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #ifndef AVUTIL_FILE_H
 #define AVUTIL_FILE_H
 
1d9c2dc8
 #include <stdint.h>
 
0328b9ea
 #include "avutil.h"
 
 /**
134557f3
  * @file
  * Misc file utilities.
0328b9ea
  */
 
 /**
  * Read the file with name filename, and put its content in a newly
  * allocated buffer or map it with mmap() when available.
  * In case of success set *bufptr to the read or mmapped buffer, and
  * *size to the size in bytes of the buffer in *bufptr.
4737387d
  * Unlike mmap this function succeeds with zero sized files, in this
  * case *bufptr will be set to NULL and *size will be set to 0.
0328b9ea
  * The returned buffer must be released with av_file_unmap().
  *
  * @param log_offset loglevel offset used for logging
  * @param log_ctx context used for logging
  * @return a non negative number in case of success, a negative value
  * corresponding to an AVERROR error code in case of failure
  */
a0b079ac
 av_warn_unused_result
0328b9ea
 int av_file_map(const char *filename, uint8_t **bufptr, size_t *size,
                 int log_offset, void *log_ctx);
 
 /**
  * Unmap or free the buffer bufptr created by av_file_map().
  *
  * @param size size in bytes of bufptr, must be the same as returned
  * by av_file_map()
  */
 void av_file_unmap(uint8_t *bufptr, size_t size);
 
885158c8
 /**
  * Wrapper to work around the lack of mkstemp() on mingw.
  * Also, tries to create file in /tmp first, if possible.
  * *prefix can be a character constant; *filename will be allocated internally.
b4d8724a
  * @return file descriptor of opened file (or negative value corresponding to an
  * AVERROR code on error)
885158c8
  * and opened file name in **filename.
3a34ac65
  * @note On very old libcs it is necessary to set a secure umask before
a9bbf59b
  *       calling this, av_tempfile() can't call umask itself as it is used in
31bf820a
  *       libraries and could interfere with the calling application.
b4f59bee
  * @deprecated as fd numbers cannot be passed saftely between libs on some platforms
885158c8
  */
74dbb538
 int av_tempfile(const char *prefix, char **filename, int log_offset, void *log_ctx);
885158c8
 
0328b9ea
 #endif /* AVUTIL_FILE_H */