Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
showbox-public / ffmpeg-doc deb
Repository URL to install this package:
|
Version:
7:2.7.1-1ubuntu2 ▾
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FFmpeg: libavutil/file.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FFmpeg
 <span id="projectnumber">2.7.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">libavutil/file.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Misc file utilities.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <stdint.h></code><br/>
<code>#include "<a class="el" href="avutil_8h_source.html">avutil.h</a>"</code><br/>
</div>
<p><a href="file_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="file_8h.html#a20ab80637ab92af5fbbe4c00be406ad3">av_file_map</a> (const char *filename, uint8_t **bufptr, size_t *size, int log_offset, void *log_ctx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the file with name filename, and put its content in a newly allocated buffer or map it with mmap() when available. <a href="#a20ab80637ab92af5fbbe4c00be406ad3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="file_8h.html#a12e643af4a329ae6d1d567d8a782af1e">av_file_unmap</a> (uint8_t *bufptr, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unmap or free the buffer bufptr created by <a class="el" href="file_8h.html#a20ab80637ab92af5fbbe4c00be406ad3" title="Read the file with name filename, and put its content in a newly allocated buffer or map it with mmap...">av_file_map()</a>. <a href="#a12e643af4a329ae6d1d567d8a782af1e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="file_8h.html#a8c2cb7d30f32e871d353c2f2b2dd6ba2">av_tempfile</a> (const char *prefix, char **filename, int log_offset, void *log_ctx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper to work around the lack of mkstemp() on mingw. <a href="#a8c2cb7d30f32e871d353c2f2b2dd6ba2"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Misc file utilities. </p>
<p>Definition in file <a class="el" href="file_8h_source.html">file.h</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a20ab80637ab92af5fbbe4c00be406ad3"></a><!-- doxytag: member="file.h::av_file_map" ref="a20ab80637ab92af5fbbe4c00be406ad3" args="(const char *filename, uint8_t **bufptr, size_t *size, int log_offset, void *log_ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="file_8h.html#a20ab80637ab92af5fbbe4c00be406ad3">av_file_map</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t ** </td>
<td class="paramname"><em>bufptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>log_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>log_ctx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read the file with name filename, and put its content in a newly allocated buffer or map it with mmap() when available. </p>
<p>In case of success set *bufptr to the read or mmapped buffer, and *size to the size in bytes of the buffer in *bufptr. The returned buffer must be released with <a class="el" href="file_8h.html#a12e643af4a329ae6d1d567d8a782af1e" title="Unmap or free the buffer bufptr created by av_file_map().">av_file_unmap()</a>.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">log_offset</td><td>loglevel offset used for logging </td></tr>
<tr><td class="paramname">log_ctx</td><td>context used for logging </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a non negative number in case of success, a negative value corresponding to an AVERROR error code in case of failure </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="avio_reading_8c-example.html#a10">avio_reading.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="avio__reading_8c_source.html#l00057">main()</a>.</p>
</div>
</div>
<a class="anchor" id="a12e643af4a329ae6d1d567d8a782af1e"></a><!-- doxytag: member="file.h::av_file_unmap" ref="a12e643af4a329ae6d1d567d8a782af1e" args="(uint8_t *bufptr, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="file_8h.html#a12e643af4a329ae6d1d567d8a782af1e">av_file_unmap</a> </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>bufptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unmap or free the buffer bufptr created by <a class="el" href="file_8h.html#a20ab80637ab92af5fbbe4c00be406ad3" title="Read the file with name filename, and put its content in a newly allocated buffer or map it with mmap...">av_file_map()</a>. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>size in bytes of bufptr, must be the same as returned by <a class="el" href="file_8h.html#a20ab80637ab92af5fbbe4c00be406ad3" title="Read the file with name filename, and put its content in a newly allocated buffer or map it with mmap...">av_file_map()</a> </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="avio_reading_8c-example.html#a22">avio_reading.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="avio__reading_8c_source.html#l00057">main()</a>.</p>
</div>
</div>
<a class="anchor" id="a8c2cb7d30f32e871d353c2f2b2dd6ba2"></a><!-- doxytag: member="file.h::av_tempfile" ref="a8c2cb7d30f32e871d353c2f2b2dd6ba2" args="(const char *prefix, char **filename, int log_offset, void *log_ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="file_8h.html#a8c2cb7d30f32e871d353c2f2b2dd6ba2">av_tempfile</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>prefix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>log_offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>log_ctx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wrapper to work around the lack of mkstemp() on mingw. </p>
<p>Also, tries to create file in /tmp first, if possible. *prefix can be a character constant; *filename will be allocated internally. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>file descriptor of opened file (or negative value corresponding to an AVERROR code on error) and opened file name in **filename. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>On very old libcs it is necessary to set a secure umask before calling this, <a class="el" href="file_8h.html#a8c2cb7d30f32e871d353c2f2b2dd6ba2" title="Wrapper to work around the lack of mkstemp() on mingw.">av_tempfile()</a> can't call umask itself as it is used in libraries and could interfere with the calling application. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>