You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

932 lines
33KB

  1. /*
  2. * copyright (c) 2001 Fabrice Bellard
  3. *
  4. * This file is part of FFmpeg.
  5. *
  6. * FFmpeg is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Lesser General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 2.1 of the License, or (at your option) any later version.
  10. *
  11. * FFmpeg is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Lesser General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Lesser General Public
  17. * License along with FFmpeg; if not, write to the Free Software
  18. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19. */
  20. #ifndef FFMPEG_AVFORMAT_H
  21. #define FFMPEG_AVFORMAT_H
  22. #define LIBAVFORMAT_VERSION_INT ((51<<16)+(18<<8)+0)
  23. #define LIBAVFORMAT_VERSION 51.18.0
  24. #define LIBAVFORMAT_BUILD LIBAVFORMAT_VERSION_INT
  25. #define LIBAVFORMAT_IDENT "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION)
  26. #include <time.h>
  27. #include <stdio.h> /* FILE */
  28. #include "avcodec.h"
  29. #include "avio.h"
  30. /* packet functions */
  31. typedef struct AVPacket {
  32. int64_t pts; ///< presentation time stamp in time_base units
  33. int64_t dts; ///< decompression time stamp in time_base units
  34. uint8_t *data;
  35. int size;
  36. int stream_index;
  37. int flags;
  38. int duration; ///< presentation duration in time_base units (0 if not available)
  39. void (*destruct)(struct AVPacket *);
  40. void *priv;
  41. int64_t pos; ///< byte position in stream, -1 if unknown
  42. } AVPacket;
  43. #define PKT_FLAG_KEY 0x0001
  44. void av_destruct_packet_nofree(AVPacket *pkt);
  45. /**
  46. * Default packet destructor.
  47. */
  48. void av_destruct_packet(AVPacket *pkt);
  49. /**
  50. * Initialize optional fields of a packet to default values.
  51. *
  52. * @param pkt packet
  53. */
  54. void av_init_packet(AVPacket *pkt);
  55. /**
  56. * Allocate the payload of a packet and initialize its fields to default values.
  57. *
  58. * @param pkt packet
  59. * @param size wanted payload size
  60. * @return 0 if OK. AVERROR_xxx otherwise.
  61. */
  62. int av_new_packet(AVPacket *pkt, int size);
  63. /**
  64. * Allocate and read the payload of a packet and initialize its fields to default values.
  65. *
  66. * @param pkt packet
  67. * @param size wanted payload size
  68. * @return >0 (read size) if OK. AVERROR_xxx otherwise.
  69. */
  70. int av_get_packet(ByteIOContext *s, AVPacket *pkt, int size);
  71. /**
  72. * @warning This is a hack - the packet memory allocation stuff is broken. The
  73. * packet is allocated if it was not really allocated
  74. */
  75. int av_dup_packet(AVPacket *pkt);
  76. /**
  77. * Free a packet
  78. *
  79. * @param pkt packet to free
  80. */
  81. static inline void av_free_packet(AVPacket *pkt)
  82. {
  83. if (pkt && pkt->destruct) {
  84. pkt->destruct(pkt);
  85. }
  86. }
  87. /*************************************************/
  88. /* fractional numbers for exact pts handling */
  89. /**
  90. * the exact value of the fractional number is: 'val + num / den'.
  91. * num is assumed to be such as 0 <= num < den
  92. * @deprecated Use AVRational instead
  93. */
  94. typedef struct AVFrac {
  95. int64_t val, num, den;
  96. } AVFrac attribute_deprecated;
  97. /*************************************************/
  98. /* input/output formats */
  99. struct AVCodecTag;
  100. struct AVFormatContext;
  101. /** this structure contains the data a format has to probe a file */
  102. typedef struct AVProbeData {
  103. const char *filename;
  104. unsigned char *buf;
  105. int buf_size;
  106. } AVProbeData;
  107. #define AVPROBE_SCORE_MAX 100 ///< max score, half of that is used for file extension based detection
  108. #define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer
  109. typedef struct AVFormatParameters {
  110. AVRational time_base;
  111. int sample_rate;
  112. int channels;
  113. int width;
  114. int height;
  115. enum PixelFormat pix_fmt;
  116. int channel; /**< used to select dv channel */
  117. #if LIBAVFORMAT_VERSION_INT < (52<<16)
  118. const char *device; /**< video, audio or DV device */
  119. #endif
  120. const char *standard; /**< tv standard, NTSC, PAL, SECAM */
  121. int mpeg2ts_raw:1; /**< force raw MPEG2 transport stream output, if possible */
  122. int mpeg2ts_compute_pcr:1; /**< compute exact PCR for each transport
  123. stream packet (only meaningful if
  124. mpeg2ts_raw is TRUE) */
  125. int initial_pause:1; /**< do not begin to play the stream
  126. immediately (RTSP only) */
  127. int prealloced_context:1;
  128. enum CodecID video_codec_id;
  129. enum CodecID audio_codec_id;
  130. } AVFormatParameters;
  131. //! demuxer will use url_fopen, no opened file should be provided by the caller
  132. #define AVFMT_NOFILE 0x0001
  133. #define AVFMT_NEEDNUMBER 0x0002 /**< needs '%d' in filename */
  134. #define AVFMT_SHOW_IDS 0x0008 /**< show format stream IDs numbers */
  135. #define AVFMT_RAWPICTURE 0x0020 /**< format wants AVPicture structure for
  136. raw picture data */
  137. #define AVFMT_GLOBALHEADER 0x0040 /**< format wants global header */
  138. #define AVFMT_NOTIMESTAMPS 0x0080 /**< format does not need / have any timestamps */
  139. #define AVFMT_GENERIC_INDEX 0x0100 /**< use generic index building code */
  140. typedef struct AVOutputFormat {
  141. const char *name;
  142. const char *long_name;
  143. const char *mime_type;
  144. const char *extensions; /**< comma separated filename extensions */
  145. /** size of private data so that it can be allocated in the wrapper */
  146. int priv_data_size;
  147. /* output support */
  148. enum CodecID audio_codec; /**< default audio codec */
  149. enum CodecID video_codec; /**< default video codec */
  150. int (*write_header)(struct AVFormatContext *);
  151. int (*write_packet)(struct AVFormatContext *, AVPacket *pkt);
  152. int (*write_trailer)(struct AVFormatContext *);
  153. /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_GLOBALHEADER */
  154. int flags;
  155. /** currently only used to set pixel format if not YUV420P */
  156. int (*set_parameters)(struct AVFormatContext *, AVFormatParameters *);
  157. int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, AVPacket *in, int flush);
  158. /**
  159. * list of supported codec_id-codec_tag pairs, ordered by "better choice first"
  160. * the arrays are all CODEC_ID_NONE terminated
  161. */
  162. const struct AVCodecTag **codec_tag;
  163. enum CodecID subtitle_codec; /**< default subtitle codec */
  164. /* private fields */
  165. struct AVOutputFormat *next;
  166. } AVOutputFormat;
  167. typedef struct AVInputFormat {
  168. const char *name;
  169. const char *long_name;
  170. /** size of private data so that it can be allocated in the wrapper */
  171. int priv_data_size;
  172. /**
  173. * tell if a given file has a chance of being parsed by this format.
  174. * The buffer provided is guranteed to be AVPROBE_PADDING_SIZE bytes big
  175. * so you dont have to check for that unless you need more.
  176. */
  177. int (*read_probe)(AVProbeData *);
  178. /** read the format header and initialize the AVFormatContext
  179. structure. Return 0 if OK. 'ap' if non NULL contains
  180. additional paramters. Only used in raw format right
  181. now. 'av_new_stream' should be called to create new streams. */
  182. int (*read_header)(struct AVFormatContext *,
  183. AVFormatParameters *ap);
  184. /** read one packet and put it in 'pkt'. pts and flags are also
  185. set. 'av_new_stream' can be called only if the flag
  186. AVFMTCTX_NOHEADER is used. */
  187. int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
  188. /** close the stream. The AVFormatContext and AVStreams are not
  189. freed by this function */
  190. int (*read_close)(struct AVFormatContext *);
  191. /**
  192. * seek to a given timestamp relative to the frames in
  193. * stream component stream_index
  194. * @param stream_index must not be -1
  195. * @param flags selects which direction should be preferred if no exact
  196. * match is available
  197. * @return >= 0 on success (but not necessarily the new offset)
  198. */
  199. int (*read_seek)(struct AVFormatContext *,
  200. int stream_index, int64_t timestamp, int flags);
  201. /**
  202. * gets the next timestamp in AV_TIME_BASE units.
  203. */
  204. int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
  205. int64_t *pos, int64_t pos_limit);
  206. /** can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER */
  207. int flags;
  208. /** if extensions are defined, then no probe is done. You should
  209. usually not use extension format guessing because it is not
  210. reliable enough */
  211. const char *extensions;
  212. /** general purpose read only value that the format can use */
  213. int value;
  214. /** start/resume playing - only meaningful if using a network based format
  215. (RTSP) */
  216. int (*read_play)(struct AVFormatContext *);
  217. /** pause playing - only meaningful if using a network based format
  218. (RTSP) */
  219. int (*read_pause)(struct AVFormatContext *);
  220. const struct AVCodecTag **codec_tag;
  221. /* private fields */
  222. struct AVInputFormat *next;
  223. } AVInputFormat;
  224. enum AVStreamParseType {
  225. AVSTREAM_PARSE_NONE,
  226. AVSTREAM_PARSE_FULL, /**< full parsing and repack */
  227. AVSTREAM_PARSE_HEADERS, /**< only parse headers, don't repack */
  228. AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on packet boundary */
  229. };
  230. typedef struct AVIndexEntry {
  231. int64_t pos;
  232. int64_t timestamp;
  233. #define AVINDEX_KEYFRAME 0x0001
  234. int flags:2;
  235. int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs 32 byte due to possible 8byte align).
  236. int min_distance; /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
  237. } AVIndexEntry;
  238. typedef struct AVStream {
  239. int index; /**< stream index in AVFormatContext */
  240. int id; /**< format specific stream id */
  241. AVCodecContext *codec; /**< codec context */
  242. /**
  243. * real base frame rate of the stream.
  244. * this is the lowest framerate with which all timestamps can be
  245. * represented accurately (it is the least common multiple of all
  246. * framerates in the stream), Note, this value is just a guess!
  247. * for example if the timebase is 1/90000 and all frames have either
  248. * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
  249. */
  250. AVRational r_frame_rate;
  251. void *priv_data;
  252. /* internal data used in av_find_stream_info() */
  253. int64_t first_dts;
  254. #if LIBAVFORMAT_VERSION_INT < (52<<16)
  255. int codec_info_nb_frames;
  256. #endif
  257. /** encoding: PTS generation when outputing stream */
  258. struct AVFrac pts;
  259. /**
  260. * this is the fundamental unit of time (in seconds) in terms
  261. * of which frame timestamps are represented. for fixed-fps content,
  262. * timebase should be 1/framerate and timestamp increments should be
  263. * identically 1.
  264. */
  265. AVRational time_base;
  266. int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */
  267. /* ffmpeg.c private use */
  268. int stream_copy; /**< if set, just copy stream */
  269. enum AVDiscard discard; ///< selects which packets can be discarded at will and do not need to be demuxed
  270. //FIXME move stuff to a flags field?
  271. /** quality, as it has been removed from AVCodecContext and put in AVVideoFrame
  272. * MN: dunno if that is the right place for it */
  273. float quality;
  274. /**
  275. * decoding: pts of the first frame of the stream, in stream time base.
  276. * only set this if you are absolutely 100% sure that the value you set
  277. * it to really is the pts of the first frame
  278. * This may be undefined (AV_NOPTS_VALUE).
  279. * @note the ASF header does NOT contain a correct start_time the ASF
  280. * demuxer must NOT set this
  281. */
  282. int64_t start_time;
  283. /**
  284. * decoding: duration of the stream, in stream time base.
  285. * If a source file does not specify a duration, but does specify
  286. * a bitrate, this value will be estimates from bit rate and file size.
  287. */
  288. int64_t duration;
  289. char language[4]; /** ISO 639 3-letter language code (empty string if undefined) */
  290. /* av_read_frame() support */
  291. enum AVStreamParseType need_parsing;
  292. struct AVCodecParserContext *parser;
  293. int64_t cur_dts;
  294. int last_IP_duration;
  295. int64_t last_IP_pts;
  296. /* av_seek_frame() support */
  297. AVIndexEntry *index_entries; /**< only used if the format does not
  298. support seeking natively */
  299. int nb_index_entries;
  300. unsigned int index_entries_allocated_size;
  301. int64_t nb_frames; ///< number of frames in this stream if known or 0
  302. #define MAX_REORDER_DELAY 4
  303. int64_t pts_buffer[MAX_REORDER_DELAY+1];
  304. } AVStream;
  305. #define AV_PROGRAM_RUNNING 1
  306. typedef struct AVProgram {
  307. int id;
  308. char *provider_name; ///< Network name for DVB streams
  309. char *name; ///< Service name for DVB streams
  310. int flags;
  311. enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller
  312. unsigned int *stream_index;
  313. unsigned int nb_stream_indexes;
  314. } AVProgram;
  315. #define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present
  316. (streams are added dynamically) */
  317. #define MAX_STREAMS 20
  318. /* format I/O context */
  319. typedef struct AVFormatContext {
  320. const AVClass *av_class; /**< set by av_alloc_format_context */
  321. /* can only be iformat or oformat, not both at the same time */
  322. struct AVInputFormat *iformat;
  323. struct AVOutputFormat *oformat;
  324. void *priv_data;
  325. ByteIOContext pb;
  326. unsigned int nb_streams;
  327. AVStream *streams[MAX_STREAMS];
  328. char filename[1024]; /**< input or output filename */
  329. /* stream info */
  330. int64_t timestamp;
  331. char title[512];
  332. char author[512];
  333. char copyright[512];
  334. char comment[512];
  335. char album[512];
  336. int year; /**< ID3 year, 0 if none */
  337. int track; /**< track number, 0 if none */
  338. char genre[32]; /**< ID3 genre */
  339. int ctx_flags; /**< format specific flags, see AVFMTCTX_xx */
  340. /* private data for pts handling (do not modify directly) */
  341. /** This buffer is only needed when packets were already buffered but
  342. not decoded, for example to get the codec parameters in mpeg
  343. streams */
  344. struct AVPacketList *packet_buffer;
  345. /** decoding: position of the first frame of the component, in
  346. AV_TIME_BASE fractional seconds. NEVER set this value directly:
  347. it is deduced from the AVStream values. */
  348. int64_t start_time;
  349. /** decoding: duration of the stream, in AV_TIME_BASE fractional
  350. seconds. NEVER set this value directly: it is deduced from the
  351. AVStream values. */
  352. int64_t duration;
  353. /** decoding: total file size. 0 if unknown */
  354. int64_t file_size;
  355. /** decoding: total stream bitrate in bit/s, 0 if not
  356. available. Never set it directly if the file_size and the
  357. duration are known as ffmpeg can compute it automatically. */
  358. int bit_rate;
  359. /* av_read_frame() support */
  360. AVStream *cur_st;
  361. const uint8_t *cur_ptr;
  362. int cur_len;
  363. AVPacket cur_pkt;
  364. /* av_seek_frame() support */
  365. int64_t data_offset; /** offset of the first packet */
  366. int index_built;
  367. int mux_rate;
  368. int packet_size;
  369. int preload;
  370. int max_delay;
  371. #define AVFMT_NOOUTPUTLOOP -1
  372. #define AVFMT_INFINITEOUTPUTLOOP 0
  373. /** number of times to loop output in formats that support it */
  374. int loop_output;
  375. int flags;
  376. #define AVFMT_FLAG_GENPTS 0x0001 ///< generate pts if missing even if it requires parsing future frames
  377. #define AVFMT_FLAG_IGNIDX 0x0002 ///< ignore index
  378. #define AVFMT_FLAG_NONBLOCK 0x0004 ///< do not block when reading packets from input
  379. int loop_input;
  380. /** decoding: size of data to probe; encoding unused */
  381. unsigned int probesize;
  382. /**
  383. * maximum duration in AV_TIME_BASE units over which the input should be analyzed in av_find_stream_info()
  384. */
  385. int max_analyze_duration;
  386. const uint8_t *key;
  387. int keylen;
  388. unsigned int nb_programs;
  389. AVProgram **programs;
  390. } AVFormatContext;
  391. typedef struct AVPacketList {
  392. AVPacket pkt;
  393. struct AVPacketList *next;
  394. } AVPacketList;
  395. extern AVInputFormat *first_iformat;
  396. extern AVOutputFormat *first_oformat;
  397. enum CodecID av_guess_image2_codec(const char *filename);
  398. /* XXX: use automatic init with either ELF sections or C file parser */
  399. /* modules */
  400. /* utils.c */
  401. void av_register_input_format(AVInputFormat *format);
  402. void av_register_output_format(AVOutputFormat *format);
  403. AVOutputFormat *guess_stream_format(const char *short_name,
  404. const char *filename, const char *mime_type);
  405. AVOutputFormat *guess_format(const char *short_name,
  406. const char *filename, const char *mime_type);
  407. /**
  408. * Guesses the codec id based upon muxer and filename.
  409. */
  410. enum CodecID av_guess_codec(AVOutputFormat *fmt, const char *short_name,
  411. const char *filename, const char *mime_type, enum CodecType type);
  412. /**
  413. * Send a nice hexadecimal dump of a buffer to the specified file stream.
  414. *
  415. * @param f The file stream pointer where the dump should be sent to.
  416. * @param buf buffer
  417. * @param size buffer size
  418. *
  419. * @see av_hex_dump_log, av_pkt_dump, av_pkt_dump_log
  420. */
  421. void av_hex_dump(FILE *f, uint8_t *buf, int size);
  422. /**
  423. * Send a nice hexadecimal dump of a buffer to the log.
  424. *
  425. * @param avcl A pointer to an arbitrary struct of which the first field is a
  426. * pointer to an AVClass struct.
  427. * @param level The importance level of the message, lower values signifying
  428. * higher importance.
  429. * @param buf buffer
  430. * @param size buffer size
  431. *
  432. * @see av_hex_dump, av_pkt_dump, av_pkt_dump_log
  433. */
  434. void av_hex_dump_log(void *avcl, int level, uint8_t *buf, int size);
  435. /**
  436. * Send a nice dump of a packet to the specified file stream.
  437. *
  438. * @param f The file stream pointer where the dump should be sent to.
  439. * @param pkt packet to dump
  440. * @param dump_payload true if the payload must be displayed too
  441. */
  442. void av_pkt_dump(FILE *f, AVPacket *pkt, int dump_payload);
  443. /**
  444. * Send a nice dump of a packet to the log.
  445. *
  446. * @param avcl A pointer to an arbitrary struct of which the first field is a
  447. * pointer to an AVClass struct.
  448. * @param level The importance level of the message, lower values signifying
  449. * higher importance.
  450. * @param pkt packet to dump
  451. * @param dump_payload true if the payload must be displayed too
  452. */
  453. void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
  454. void av_register_all(void);
  455. /** codec tag <-> codec id */
  456. enum CodecID av_codec_get_id(const struct AVCodecTag **tags, unsigned int tag);
  457. unsigned int av_codec_get_tag(const struct AVCodecTag **tags, enum CodecID id);
  458. /* media file input */
  459. /**
  460. * finds AVInputFormat based on input format's short name.
  461. */
  462. AVInputFormat *av_find_input_format(const char *short_name);
  463. /**
  464. * Guess file format.
  465. *
  466. * @param is_opened whether the file is already opened, determines whether
  467. * demuxers with or without AVFMT_NOFILE are probed
  468. */
  469. AVInputFormat *av_probe_input_format(AVProbeData *pd, int is_opened);
  470. /**
  471. * Allocates all the structures needed to read an input stream.
  472. * This does not open the needed codecs for decoding the stream[s].
  473. */
  474. int av_open_input_stream(AVFormatContext **ic_ptr,
  475. ByteIOContext *pb, const char *filename,
  476. AVInputFormat *fmt, AVFormatParameters *ap);
  477. /**
  478. * Open a media file as input. The codecs are not opened. Only the file
  479. * header (if present) is read.
  480. *
  481. * @param ic_ptr the opened media file handle is put here
  482. * @param filename filename to open.
  483. * @param fmt if non NULL, force the file format to use
  484. * @param buf_size optional buffer size (zero if default is OK)
  485. * @param ap additional parameters needed when opening the file (NULL if default)
  486. * @return 0 if OK. AVERROR_xxx otherwise.
  487. */
  488. int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
  489. AVInputFormat *fmt,
  490. int buf_size,
  491. AVFormatParameters *ap);
  492. /** no av_open for output, so applications will need this: */
  493. AVFormatContext *av_alloc_format_context(void);
  494. /**
  495. * Read packets of a media file to get stream information. This
  496. * is useful for file formats with no headers such as MPEG. This
  497. * function also computes the real frame rate in case of mpeg2 repeat
  498. * frame mode.
  499. * The logical file position is not changed by this function;
  500. * examined packets may be buffered for later processing.
  501. *
  502. * @param ic media file handle
  503. * @return >=0 if OK. AVERROR_xxx if error.
  504. * @todo Let user decide somehow what information is needed so we do not waste time geting stuff the user does not need.
  505. */
  506. int av_find_stream_info(AVFormatContext *ic);
  507. /**
  508. * Read a transport packet from a media file.
  509. *
  510. * This function is obsolete and should never be used.
  511. * Use av_read_frame() instead.
  512. *
  513. * @param s media file handle
  514. * @param pkt is filled
  515. * @return 0 if OK. AVERROR_xxx if error.
  516. */
  517. int av_read_packet(AVFormatContext *s, AVPacket *pkt);
  518. /**
  519. * Return the next frame of a stream.
  520. *
  521. * The returned packet is valid
  522. * until the next av_read_frame() or until av_close_input_file() and
  523. * must be freed with av_free_packet. For video, the packet contains
  524. * exactly one frame. For audio, it contains an integer number of
  525. * frames if each frame has a known fixed size (e.g. PCM or ADPCM
  526. * data). If the audio frames have a variable size (e.g. MPEG audio),
  527. * then it contains one frame.
  528. *
  529. * pkt->pts, pkt->dts and pkt->duration are always set to correct
  530. * values in AVStream.timebase units (and guessed if the format cannot
  531. * provided them). pkt->pts can be AV_NOPTS_VALUE if the video format
  532. * has B frames, so it is better to rely on pkt->dts if you do not
  533. * decompress the payload.
  534. *
  535. * @return 0 if OK, < 0 if error or end of file.
  536. */
  537. int av_read_frame(AVFormatContext *s, AVPacket *pkt);
  538. /**
  539. * Seek to the key frame at timestamp.
  540. * 'timestamp' in 'stream_index'.
  541. * @param stream_index If stream_index is (-1), a default
  542. * stream is selected, and timestamp is automatically converted
  543. * from AV_TIME_BASE units to the stream specific time_base.
  544. * @param timestamp timestamp in AVStream.time_base units
  545. * or if there is no stream specified then in AV_TIME_BASE units
  546. * @param flags flags which select direction and seeking mode
  547. * @return >= 0 on success
  548. */
  549. int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, int flags);
  550. /**
  551. * start playing a network based stream (e.g. RTSP stream) at the
  552. * current position
  553. */
  554. int av_read_play(AVFormatContext *s);
  555. /**
  556. * Pause a network based stream (e.g. RTSP stream).
  557. *
  558. * Use av_read_play() to resume it.
  559. */
  560. int av_read_pause(AVFormatContext *s);
  561. /**
  562. * Close a media file (but not its codecs).
  563. *
  564. * @param s media file handle
  565. */
  566. void av_close_input_file(AVFormatContext *s);
  567. /**
  568. * Add a new stream to a media file.
  569. *
  570. * Can only be called in the read_header() function. If the flag
  571. * AVFMTCTX_NOHEADER is in the format context, then new streams
  572. * can be added in read_packet too.
  573. *
  574. * @param s media file handle
  575. * @param id file format dependent stream id
  576. */
  577. AVStream *av_new_stream(AVFormatContext *s, int id);
  578. AVProgram *av_new_program(AVFormatContext *s, int id);
  579. /**
  580. * Set the pts for a given stream.
  581. *
  582. * @param s stream
  583. * @param pts_wrap_bits number of bits effectively used by the pts
  584. * (used for wrap control, 33 is the value for MPEG)
  585. * @param pts_num numerator to convert to seconds (MPEG: 1)
  586. * @param pts_den denominator to convert to seconds (MPEG: 90000)
  587. */
  588. void av_set_pts_info(AVStream *s, int pts_wrap_bits,
  589. int pts_num, int pts_den);
  590. #define AVSEEK_FLAG_BACKWARD 1 ///< seek backward
  591. #define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes
  592. #define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non keyframes
  593. int av_find_default_stream_index(AVFormatContext *s);
  594. /**
  595. * Gets the index for a specific timestamp.
  596. * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond to
  597. * the timestamp which is <= the requested one, if backward is 0
  598. * then it will be >=
  599. * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise
  600. * @return < 0 if no such timestamp could be found
  601. */
  602. int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags);
  603. /**
  604. * Add a index entry into a sorted list updateing if it is already there.
  605. *
  606. * @param timestamp timestamp in the timebase of the given stream
  607. */
  608. int av_add_index_entry(AVStream *st,
  609. int64_t pos, int64_t timestamp, int size, int distance, int flags);
  610. /**
  611. * Does a binary search using av_index_search_timestamp() and AVCodec.read_timestamp().
  612. * This is not supposed to be called directly by a user application, but by demuxers.
  613. * @param target_ts target timestamp in the time base of the given stream
  614. * @param stream_index stream number
  615. */
  616. int av_seek_frame_binary(AVFormatContext *s, int stream_index, int64_t target_ts, int flags);
  617. /**
  618. * Updates cur_dts of all streams based on given timestamp and AVStream.
  619. *
  620. * Stream ref_st unchanged, others set cur_dts in their native timebase
  621. * only needed for timestamp wrapping or if (dts not set and pts!=dts).
  622. * @param timestamp new dts expressed in time_base of param ref_st
  623. * @param ref_st reference stream giving time_base of param timestamp
  624. */
  625. void av_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
  626. /**
  627. * Does a binary search using read_timestamp().
  628. * This is not supposed to be called directly by a user application, but by demuxers.
  629. * @param target_ts target timestamp in the time base of the given stream
  630. * @param stream_index stream number
  631. */
  632. int64_t av_gen_search(AVFormatContext *s, int stream_index, int64_t target_ts, int64_t pos_min, int64_t pos_max, int64_t pos_limit, int64_t ts_min, int64_t ts_max, int flags, int64_t *ts_ret, int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
  633. /** media file output */
  634. int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);
  635. /**
  636. * Allocate the stream private data and write the stream header to an
  637. * output media file.
  638. *
  639. * @param s media file handle
  640. * @return 0 if OK. AVERROR_xxx if error.
  641. */
  642. int av_write_header(AVFormatContext *s);
  643. /**
  644. * Write a packet to an output media file.
  645. *
  646. * The packet shall contain one audio or video frame.
  647. * The packet must be correctly interleaved according to the container specification,
  648. * if not then av_interleaved_write_frame must be used
  649. *
  650. * @param s media file handle
  651. * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
  652. * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
  653. */
  654. int av_write_frame(AVFormatContext *s, AVPacket *pkt);
  655. /**
  656. * Writes a packet to an output media file ensuring correct interleaving.
  657. *
  658. * The packet must contain one audio or video frame.
  659. * If the packets are already correctly interleaved the application should
  660. * call av_write_frame() instead as it is slightly faster. It is also important
  661. * to keep in mind that completely non-interleaved input will need huge amounts
  662. * of memory to interleave with this, so it is preferable to interleave at the
  663. * demuxer level.
  664. *
  665. * @param s media file handle
  666. * @param pkt the packet, which contains the stream_index, buf/buf_size, dts/pts, ...
  667. * @return < 0 if error, = 0 if OK, 1 if end of stream wanted.
  668. */
  669. int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt);
  670. /**
  671. * Interleave a packet per DTS in an output media file.
  672. *
  673. * Packets with pkt->destruct == av_destruct_packet will be freed inside this function,
  674. * so they cannot be used after it, note calling av_free_packet() on them is still safe.
  675. *
  676. * @param s media file handle
  677. * @param out the interleaved packet will be output here
  678. * @param in the input packet
  679. * @param flush 1 if no further packets are available as input and all
  680. * remaining packets should be output
  681. * @return 1 if a packet was output, 0 if no packet could be output,
  682. * < 0 if an error occured
  683. */
  684. int av_interleave_packet_per_dts(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush);
  685. /**
  686. * @brief Write the stream trailer to an output media file and
  687. * free the file private data.
  688. *
  689. * @param s media file handle
  690. * @return 0 if OK. AVERROR_xxx if error.
  691. */
  692. int av_write_trailer(AVFormatContext *s);
  693. void dump_format(AVFormatContext *ic,
  694. int index,
  695. const char *url,
  696. int is_output);
  697. /**
  698. * parses width and height out of string str.
  699. * @deprecated Use av_parse_video_frame_size instead.
  700. */
  701. attribute_deprecated int parse_image_size(int *width_ptr, int *height_ptr, const char *str);
  702. /**
  703. * Converts frame rate from string to a fraction.
  704. * @deprecated Use av_parse_video_frame_rate instead.
  705. */
  706. attribute_deprecated int parse_frame_rate(int *frame_rate, int *frame_rate_base, const char *arg);
  707. /**
  708. * Parses \p datestr and returns a corresponding number of microseconds.
  709. * @param datestr String representing a date or a duration.
  710. * - If a date the syntax is:
  711. * @code
  712. * [{YYYY-MM-DD|YYYYMMDD}]{T| }{HH[:MM[:SS[.m...]]][Z]|HH[MM[SS[.m...]]][Z]}
  713. * @endcode
  714. * Time is localtime unless Z is appended, in which case it is
  715. * interpreted as UTC.
  716. * If the year-month-day part isn't specified it takes the current
  717. * year-month-day.
  718. * Returns the number of microseconds since 1st of January, 1970 up to
  719. * the time of the parsed date or INT64_MIN if \p datestr cannot be
  720. * successfully parsed.
  721. * - If a duration the syntax is:
  722. * @code
  723. * [-]HH[:MM[:SS[.m...]]]
  724. * [-]S+[.m...]
  725. * @endcode
  726. * Returns the number of microseconds contained in a time interval
  727. * with the specified duration or INT64_MIN if \p datestr cannot be
  728. * succesfully parsed.
  729. * @param duration Flag which tells how to interpret \p datestr, if
  730. * not zero \p datestr is interpreted as a duration, otherwise as a
  731. * date.
  732. */
  733. int64_t parse_date(const char *datestr, int duration);
  734. int64_t av_gettime(void);
  735. /* ffm specific for ffserver */
  736. #define FFM_PACKET_SIZE 4096
  737. offset_t ffm_read_write_index(int fd);
  738. void ffm_write_write_index(int fd, offset_t pos);
  739. void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size);
  740. /**
  741. * Attempts to find a specific tag in a URL.
  742. *
  743. * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done.
  744. * Return 1 if found.
  745. */
  746. int find_info_tag(char *arg, int arg_size, const char *tag1, const char *info);
  747. /**
  748. * Returns in 'buf' the path with '%d' replaced by number.
  749. * Also handles the '%0nd' format where 'n' is the total number
  750. * of digits and '%%'.
  751. *
  752. * @param buf destination buffer
  753. * @param buf_size destination buffer size
  754. * @param path numbered sequence string
  755. * @number frame number
  756. * @return 0 if OK, -1 if format error.
  757. */
  758. int av_get_frame_filename(char *buf, int buf_size,
  759. const char *path, int number);
  760. /**
  761. * Check whether filename actually is a numbered sequence generator.
  762. *
  763. * @param filename possible numbered sequence string
  764. * @return 1 if a valid numbered sequence string, 0 otherwise.
  765. */
  766. int av_filename_number_test(const char *filename);
  767. /**
  768. * Generate an SDP for an RTP session.
  769. *
  770. * @param ac array of AVFormatContexts describing the RTP streams. If the
  771. * array is composed by only one context, such context can contain
  772. * multiple AVStreams (one AVStream per RTP stream). Otherwise,
  773. * all the contexts in the array (an AVCodecContext per RTP stream)
  774. * must contain only one AVStream
  775. * @param n_files number of AVCodecContexts contained in ac
  776. * @param buff buffer where the SDP will be stored (must be allocated by
  777. * the caller
  778. * @param size the size of the buffer
  779. * @return 0 if OK. AVERROR_xxx if error.
  780. */
  781. int avf_sdp_create(AVFormatContext *ac[], int n_files, char *buff, int size);
  782. #ifdef HAVE_AV_CONFIG_H
  783. #include "os_support.h"
  784. void __dynarray_add(unsigned long **tab_ptr, int *nb_ptr, unsigned long elem);
  785. #ifdef __GNUC__
  786. #define dynarray_add(tab, nb_ptr, elem)\
  787. do {\
  788. typeof(tab) _tab = (tab);\
  789. typeof(elem) _elem = (elem);\
  790. (void)sizeof(**_tab == _elem); /* check that types are compatible */\
  791. __dynarray_add((unsigned long **)_tab, nb_ptr, (unsigned long)_elem);\
  792. } while(0)
  793. #else
  794. #define dynarray_add(tab, nb_ptr, elem)\
  795. do {\
  796. __dynarray_add((unsigned long **)(tab), nb_ptr, (unsigned long)(elem));\
  797. } while(0)
  798. #endif
  799. time_t mktimegm(struct tm *tm);
  800. struct tm *brktimegm(time_t secs, struct tm *tm);
  801. const char *small_strptime(const char *p, const char *fmt,
  802. struct tm *dt);
  803. struct in_addr;
  804. int resolve_host(struct in_addr *sin_addr, const char *hostname);
  805. void url_split(char *proto, int proto_size,
  806. char *authorization, int authorization_size,
  807. char *hostname, int hostname_size,
  808. int *port_ptr,
  809. char *path, int path_size,
  810. const char *url);
  811. int match_ext(const char *filename, const char *extensions);
  812. #endif /* HAVE_AV_CONFIG_H */
  813. #endif /* FFMPEG_AVFORMAT_H */