[FFmpeg-devel] [PATCH 1/2] [WIP/RFC] Add a release note for 2.3

[Clément Bœsch]

On Fri, Jul 11, 2014 at 09:08:40PM -0700, Timothy Gu wrote:
> Based on a patch by Clément Bœsch <u at pkh.me>.
> 
> Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> ---
> 
> So, I rebased Clément's original patch and added (a lot) more stuff to make it
> a real official modern-looking release note. Some stuff I am not sure about:
> 
>  - Should we use Clément's format with all kinds of Unicode characters or
>    stick to Markdown?

We don't really render Markdown anywhere; here we can just link to the
raw on the repository and have a decent layout. We don't need complex
markup, unless we want to link to commit hashes or stuff?

>  - Does the new image auto-detection really work as advertised in "Behaviour
>    changes" section?
>  - Is there any stuff I missed in the "Behaviour changes" section? (I'm sure
>    there are.)
> 
> ---
>  RELEASE_NOTE | 144 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 144 insertions(+)
>  create mode 100644 RELEASE_NOTE
> 
> diff --git a/RELEASE_NOTE b/RELEASE_NOTE
> new file mode 100644
> index 0000000..0cbd63f
> --- /dev/null
> +++ b/RELEASE_NOTE
> @@ -0,0 +1,144 @@
> + ┌─────────────────────────────────┐
> + │ Release notes for FFmpeg 2.3    │
> + └─────────────────────────────────┘
> +
> +   The FFmpeg Project proudly presents FFmpeg 2.3, a new release completely
> +   source-compatible to the FFmpeg 2.2 series. There are however some API
> +   deprecations that you need to take care of. Use `git diff n2.2 n2.3
> +   doc/APIchanges` to show the list of added and deprecated APIs.
> +
> +   In this release, there are lots of internal overhauls that make FFmpeg a
> +   more accessible project for new developers. Many important new features
> +   like native Opus decoder and QTKit and AVFoundation input devices are also
> +   committed.
> +

Maybe mention that there are a lot of ASM x86 improvements? I don't
which, but IIRC huffyuv & hevc at least got some.

> +   Since this release, the traditional Changelog file is upgraded to this
> +   modern-looking release note. Old change logs are moved to
> +   doc/Changelog.old.
> +
> +   Enjoy!
> +
> +   ┌────────────────────────────┐
> +   │ Native Opus decoder        │
> +   └────────────────────────────┘
> +
> +     Opus is an open audio format jointly developed by Xiph.Org, Mozilla,
> +     Skype/Microsoft, and Broadcom. It combines the features of the Skype Cilk
> +     speech codec and the Xiph.Org CELT music codec into one low-latency
> +     codec. Decoding Opus is already possible since FFmpeg 1.0 using the
> +     libopus library, but the new Opus native decoder brings a higher level of
> +     stability and speed.
> +
> +   ┌────────────────────────────┐
> +   │ QTKit and AVFoundation     │
> +   └────────────────────────────┘
> +
> +     For OS X users, the new QTKit and AVFoundation devices allow you to use
> +     the integrated camera on Macs. AVFoundation is a newer API only available
> +     on OS X 10.7 "Lion" or newer. For users with older OS X systems, the
> +     QTKit device using the older OS X API is for you.
> +
> +   ┌────────────────────────────┐
> +   │ API Additions              │
> +   └────────────────────────────┘
> +
> +     In this release, stream side data are introduced as AVStream.side_data as
> +     a way to store miscellaneous stream-wide information. The format is
> +     similar to the previously anonymous structure AVPacket.side_data (now
> +     named as AVPacketSideData). With this change, audio ReplayGain
> +     information and video rotation matrix are now exported through this API,
> +     if available in the demuxer.
> +
> +     We also have improved libswresample's Doxygen API documentation, so new
> +     developers wishing to use FFmpeg's excellent can get started more easily

FFmpeg's excellent what?

> +     and faster.
> +
> +   ┌────────────────────────────┐
> +   │ Last But Not Least         │
> +   └────────────────────────────┘
> +
> +     Other interesting new features including hqx, a pixel art scaling filter;

hqx video filter

> +     a fixed-point AC-3 decoder contributed by Imagination Technologies; a VP7
> +     video decoder; an HTML5 WebVTT subtitle decoder; and an 1-bit Direct

WebVTT subtitles encoder: the decoder was already present, you can produce
them from any other text subtitles now.

> +     Stream Digital audio decoder.
> +
> + ┌────────────────────────────┐
> + │ *  List of New Features    │
> + └────────────────────────────┘
> +

★ is prettier than * ;)

> +   ┌────────────────────────────┐
> +   │ •  Command line tools      │
> +   └────────────────────────────┘

Not sure you should you should put the • inside.

> +    • Support for decoding through DXVA2 in ffmpeg
> +
[...]
> + ┌────────────────────────────┐
> + │ ⚠  Behaviour changes       │
> + └────────────────────────────┘
> +
> +  • libx264 reference frames count is now limited depending on level chosen
> +  • Because of the new image format auto-detection feature, you don't need to
> +    specify image format when decoding an image with no extension.
> +

> + ┌────────────────────────────┐
> + │ *  API Information         │
> + └────────────────────────────┘
> +
> +   FFmpeg 2.3 includes the following library versions:
> +
> +     • libavutil      xx.yy.1zz
> +     • libavcodec     xx.yy.1zz
> +     • libavformat    xx.yy.1zz
> +     • libavdevice    xx.yy.1zz
> +     • libavfilter    xx.yy.1zz
> +     • libswscale     xx.yy.1zz
> +     • libswresample  xx.yy.1zz
> +     • libpostproc    xx.yy.1zz
> +
> +   Please refer to the doc/APIChanges file for more information.

I'd move this chunk to the top

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 473 bytes
Desc: not available
URL: <https://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20140712/8b74651a/attachment.asc>