Skip to content
This repository has been archived by the owner on Jun 11, 2020. It is now read-only.

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
mpenkov committed Dec 28, 2012
1 parent 71214cf commit b349ef3
Showing 1 changed file with 21 additions and 20 deletions.
41 changes: 21 additions & 20 deletions README.md
Expand Up @@ -3,7 +3,7 @@ ffmpeg-tutorial

This repository contains files from an FFmpeg tutorial originally written by
Stephen Dranger (dranger@gmail.com). The files have been updated to work with
the most recent version of FFmpeg (N-42806-gf4451d2 at the time of writing).
the most recent version of FFmpeg (N-48241-g9e04e11 at the time of writing).
The updates were performed with an effort to modify as little code as possible,
so that the original code and tutorial descriptions could be easily consulted.

Expand All @@ -16,10 +16,10 @@ Main changes:
* Renamed includes, e.g. ffmpeg/avcodec.h --> libavcodec/avcodec.h
* Work around deprecated functions and symbols (see below)
* Initializing pointers to NULL on declaration. Some FFmpeg functions
(e.g. avformat_open_input) now segfault when given uninitialized pointers as
(e.g. avformat\_open\_input) now segfault when given uninitialized pointers as
input.
* Removed tutorial08.c, which introduced software scaling (as
opposed to using the img_convert method). img_convert has been deprecated
opposed to using the img\_convert method). img\_convert has been deprecated
and is no longer available, so these new tutorials use software scaling
from the very beginning, and a separate tutorial is not necessary.

Expand All @@ -28,24 +28,24 @@ Deprecated Functions and Symbols

This section describes the changes made to work around deprecated functions
and symbols, in the format: before --> after. In some cases, a simple rename
sufficed (e.g. dump_format), but in others, more significant changes to the
code were required (e.g. avcodec_decode_audio2). Consult the diffs for each
sufficed (e.g. dump\_format), but in others, more significant changes to the
code were required (e.g. avcodec\_decode\_audio2). Consult the diffs for each
respective tutorial to see exactly what has changed since the original
version of the tutorial.

* av_open_input_file --> avformat_open_input
* av_find_stream_info --> avformat_find_stream_info
* dump_format --> av_dump_format
* CODEC_TYPE_VIDEO --> AVMEDIA_TYPE_VIDEO
* avcodec_open --> avcodec_open2
* avcodec_decode_video --> avcodec_decode_video2
* img_convert --> sws_scale
* av_close_input_file --> avformat_close_input
* avcodec_decode_audio2 --> avcodec_decode_audio4
* CODEC_TYPE_AUDIO --> AVMEDIA_TYPE_AUDIO
* url_set_interrupt_cb --> avio_open2
* url_ferror --> check attribute is->pFormatCtx->pb->error
* pstrcpy --> av_strlcpy
* av\_open\_input\_file --> avformat\_open\_input
* av\_find\_stream\_info --> avformat\_find\_stream\_info
* dump\_format --> av\_dump\_format
* CODEC\_TYPE\_VIDEO --> AVMEDIA\_TYPE\_VIDEO
* avcodec\_open --> avcodec\_open2
* avcodec\_decode\_video --> avcodec\_decode\_video2
* img\_convert --> sws\_scale
* av\_close\_input\_file --> avformat\_close\_input
* avcodec\_decode\_audio2 --> avcodec\_decode\_audio4
* CODEC\_TYPE\_AUDIO --> AVMEDIA\_TYPE\_AUDIO
* url\_set\_interrupt\_cb --> avio\_open2
* url\_ferror --> check attribute is->pFormatCtx->pb->error
* pstrcpy --> av\_strlcpy

Building and Running
--------------------
Expand All @@ -59,6 +59,7 @@ To build the tutorials:
cd ffmpeg-tutorial
make

To run a tutorial:
To run a tutorial, first make sure that your ffmpeg installation is on your
$LD\_LIBRARY\_PATH and then:

bin/tutorial01.out
bin/tutorial01.out

4 comments on commit b349ef3

@caohong
Copy link

@caohong caohong commented on b349ef3 Jan 2, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, I'm trying to update the "ffmpeg tutorial" documentation based on your modified code and Dranger's documentation. Can I merge my modification link to your branch? Please give me advise.

@mpenkov
Copy link
Owner Author

@mpenkov mpenkov commented on b349ef3 Jan 2, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better that you write the new documentation first.

@caohong
Copy link

@caohong caohong commented on b349ef3 Jan 2, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's ok, current documentation is only the copy, but it is started now.
But I wonder if someone else is doing this work, so I ask your advise.

@mpenkov
Copy link
Owner Author

@mpenkov mpenkov commented on b349ef3 Jan 2, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know of anybody else that is doing similar work.

Please sign in to comment.