Reference Manual Instruction Manual

Manuals Brands Google Manuals Software Flix Engine Linux

Flix Engine Linux Reference Manual

8.0.17.1

Generated by Doxygen 1.5.2

Tue Jul 20 17:39:03 2010

Summary of content (545 pages)

PAGE 1

Flix Engine Linux Reference Manual 8.0.17.1 Generated by Doxygen 1.5.
PAGE 2
PAGE 3

Contents 1 2 3 4 5 Flix Engine Documentation 1 1.1 Page Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.3 Starting Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.4 New Codecs & Container Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.5 Support Options & FAQ . . . . . . .
PAGE 4

ii CONTENTS 5.14 VP6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 5.15 VP6 with Alpha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 5.16 VP8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 5.17 Encoding Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 5.18 Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 5

CONTENTS iii 5.50 MOV - FFmpeg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 5.51 MP4 - FFmpeg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 5.52 SWF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 5.53 WebM - FFmpeg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 5.54 Base Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 6

iv CONTENTS 6.29 flixengine2/filters/resample.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 301 6.30 flixengine2/filters/rotate.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 302 6.31 flixengine2/filters/scale.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 303 6.32 flixengine2/filters/sharpen.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 304 6.33 flixengine2/flixengine2.h File Reference . . . . . . . . . . . . . . . . .
PAGE 7

Chapter 1 Flix Engine Documentation 1.1 Page Contents • Introduction • Starting Points • New Codecs & Container Formats • Support Options & FAQ 1.2 Introduction Thank you for licensing the On2 Flix Engine SDK. This SDK provides a framework for embedding the acclaimed On2 Flix multimedia engine in your server-based applications.
PAGE 8

2 Flix Engine Documentation • Reading and running the sample code gives a strong overview of what you can achieve with Flix Engine. • Flix Engine API reference • Also note language binding differences from the main API. 1.4 New Codecs & Container Formats Flix Engine 8.0.17.0 supports the html5 ready WebM container using VP8 and Vorbis. Flix Engine 8.0.10.0 now supports MPEG-4 Part 10 standard, commonly known as H.264. Specifically, Flix Engine can now encode video using the H.
PAGE 9

1.5 Support Options & FAQ 3 AND/OR (ii) DECODE AVC VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A PERSONAL AND NONCOMMERCIAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO PROVIDER LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS GRANTED OR SHALL BE IMPLIED FOR ANY OTHER USE. ADDITIONAL INFORMATION MAY BE OBTAINED FROM MPEG LA, L.L.C. SEE HTTP://WWW.MPEGLA.COM.
PAGE 10

4 Flix Engine Documentation Generated on Tue Jul 20 17:39:03 2010 for Flix Engine Linux by Doxygen
PAGE 11

Chapter 2 Flix Engine Linux Module Index 2.1 Flix Engine Linux Modules Here is a list of all modules: Flix Engine API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Audio Encoding Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deprecated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Codecs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 12

6 Flix Engine Linux Module Index Highpass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lowpass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Resample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Main Engine Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 13

Chapter 3 Flix Engine Linux File Index 3.1 Flix Engine Linux File List Here is a list of all files with brief descriptions: flixengine2/audio_options.h (Reference module(s): Audio Encoding Options ) . . . . . . . . . . flixengine2/codec_constants.h (Reference module(s): Codecs ) . . . . . . . . . . . . . . . . . . flixengine2/encoding_status.h (Reference module(s): Encoding Statistics ) . . . . . . . . . . . . flixengine2/filter_constants.h (Reference module(s): Filters ) . . . . . . . . . . . . . . . .
PAGE 14

8 Flix Engine Linux File Index flixengine2/filters/overlay.h (Reference module(s): Overlay (Watermark) ) . . . . . . . . flixengine2/filters/png_export.h (Reference module(s): PNG Image Export (Thumbnail) ) flixengine2/filters/resample.h (Reference module(s): Resample ) . . . . . . . . . . . . . flixengine2/filters/rotate.h (Reference module(s): Rotate ) . . . . . . . . . . . . . . . . . flixengine2/filters/scale.h (Reference module(s): Scale ) . . . . . . . . . . . . . . . . . .
PAGE 15

Chapter 4 Flix Engine Linux Page Index 4.1 Flix Engine Linux Related Pages Here is a list of all related documentation pages: About Flix Engine . . . . . . . . . . . . . . Language Binding API Deviations . . . . . FE2_VP6_CONCURRENCY Performance CHANGELOG . . . . . . . . . . . . . . . flixd man page . . . . . . . . . . . . . . . . Samples . . . . . . . . . . . . . . . . . . . Deprecated List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 16

10 Flix Engine Linux Page Index Generated on Tue Jul 20 17:39:03 2010 for Flix Engine Linux by Doxygen
PAGE 17

Chapter 5 Flix Engine Linux Module Documentation 5.
PAGE 18

12 Flix Engine Linux Module Documentation Valid bitrates for FE2_CODEC_LAME. For use in calls to Flix2_CodecSetParam() and Flix2_CodecGetParam(). 5.1.1 Enumeration Type Documentation 5.1.1.1 enum FE2_AudioBitrates Valid bitrates for FE2_CODEC_LAME. For use in calls to Flix2_CodecSetParam() and Flix2_CodecGetParam().
PAGE 19

5.2 Deprecated 5.2 13 Deprecated Enumerations • enum FE2_FlvAudioFormat { FlvAudioUncompressed, FlvAudioMp3 } Valid output audio formats for use in calls to audio_options_GetFlvAudioFormat() and audio_options_SetFlvAudioFormat(). • enum FE2_AudioSamplingrates { Hertz11025, Hertz22050, Hertz44100 } Sample rates for use with FE2_FILTER_RESAMPLE and the FE2_RESAMPLE_RATE parameter. Functions • on2sc audio_options_Reset (FLIX2HANDLE flix) Reset the audio encoding options to their default values.
PAGE 20

14 Flix Engine Linux Module Documentation Set the number of output audio channels. • on2sc audio_options_GetStereo (const FLIX2HANDLE flix, on2bool ∗pStereo) Retrieve the current number of output audio channels. 5.2.1 Enumeration Type Documentation 5.2.1.1 enum FE2_AudioSamplingrates Sample rates for use with FE2_FILTER_RESAMPLE and the FE2_RESAMPLE_RATE parameter. Deprecated With the addition of new Muxers the allowed sample rates will change.
PAGE 21

5.2 Deprecated 15 Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() → pBitrate Storage location to receive the result Return values: ON2_OK on success ON2_INVALID_PARAMS should one or more of the preconditions fail ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL pBitrate is not NULL Note: Default: Bitrate64kbps Deprecated Use the Codec Interface along with the FE2_CODECPARAM_BITRATE parameter.
PAGE 22

16 Flix Engine Linux Module Documentation 5.2.2.3 on2sc audio_options_GetSamplingrate (const FLIX2HANDLE flix, FE2_AudioSamplingrates ∗ pSamplingrate) Retrieve the current output sample rate.
PAGE 23

5.2 Deprecated 5.2.2.5 17 on2sc audio_options_Reset (FLIX2HANDLE flix) Reset the audio encoding options to their default values.
PAGE 24

18 Flix Engine Linux Module Documentation 5.2.2.7 on2sc audio_options_SetFlvAudioFormat (FLIX2HANDLE flix, const FE2_FlvAudioFormat format) Set the output audio format.
PAGE 25

5.2 Deprecated 19 • source sample rate < 16000Hz, set default to Hertz11025 • source sample rate >= 16000Hz and < 32000Hz, set default to Hertz22050 • source sample rate >= 32000Hz, set default to Hertz44100 Deprecated Use the Filter Interface along with FE2_FILTER_RESAMPLE and the FE2_RESAMPLE_RATE parameter. 5.2.2.9 on2sc audio_options_SetStereo (FLIX2HANDLE flix, const on2bool stereo) Set the number of output audio channels.
PAGE 26

20 Flix Engine Linux Module Documentation Return values: ON2_OK on success ON2_INVALID_PARAMS should the precondition fail ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL Deprecated Use the Codec and Filter interfaces.
PAGE 27

5.3 Codecs 5.3 5.3.1 21 Codecs Detailed Description Codecs are configurable both by the codec interface and individual functions (e.g., (audio|video)_options_SetXXX). The latter, however, are deprecated and will be removed in a future release. Therefore, any new code should use the codec interface.
PAGE 28

22 Flix Engine Linux Module Documentation 5.4 Common Codec Parameters Defines • #define FE2_CODECPARAM_BITRATE Codec parameter for stream bitrate. • #define FE2_VCODECPARAM_RC_MODE Video codec parameter for the rate control mode. • #define FE2_VCODECPARAM_KFINTTYPE Video codec parameter for the keyframe interval type. • #define FE2_VCODECPARAM_KFFREQ Video codec parameter for keyframe frequency.
PAGE 29

5.4 Common Codec Parameters 23 See also: FE2_VideoKeyframeTypes Definition at line 67 of file codec_common.h. 5.4.1.3 #define FE2_VCODECPARAM_KFINTTYPE Video codec parameter for the keyframe interval type. Valid values are defined by FE2_VideoKeyframeTypes. Definition at line 59 of file codec_common.h. 5.4.1.4 #define FE2_VCODECPARAM_RC_MODE Video codec parameter for the rate control mode. Valid values are defined by FE2_VideoBitrateControls. Definition at line 53 of file codec_common.h. 5.4.
PAGE 30

24 Flix Engine Linux Module Documentation 5.
PAGE 31

5.6 Audio Codecs 5.6 Audio Codecs Modules • • • • • AAC AAC+ AMR_NB - FFmpeg MP3 - LAME libvorbis - FFmpeg Defines • #define FE2_CODEC_PCM ’Codec’ name for use with Flix2_AddCodec() 5.6.1 Define Documentation 5.6.1.1 #define FE2_CODEC_PCM ’Codec’ name for use with Flix2_AddCodec() Allows for PCM audio output. Definition at line 65 of file codec_constants.h.
PAGE 32

26 Flix Engine Linux Module Documentation 5.7 AAC 5.7.1 Detailed Description Example Usage: sc = Flix2_AddCodec(&codec, flix, FE2_CODEC_AAC); // Use 128kbps if(sc == ON2_OK) sc = Flix2_CodecSetParam(codec, FE2_AAC_BITRATE, 128); Valid Configurations Channels | Bitrates (kbps) | Sampling Rate (kHz) ====================================================================================== 1ch | 8,10 | 8,11.025,12 1ch | 12 | 8,11.025,12,16 1ch | 16 | 8 to 24 1ch | 20 | 11.025 to 24 1ch | 24,28 | 11.
PAGE 33

5.7 AAC 27 5.7.2 Define Documentation 5.7.2.1 #define FE2_AAC_BITRATE Alias for FE2_CODECPARAM_BITRATE. Codec parameter for stream bitrate. Compressed stream bitrate in kbits/sec. Note: Default: 64 Definition at line 75 of file aac.h. 5.7.2.2 #define FE2_CODEC_AAC AAC. Codec name for use with Flix2_AddCodec(). Definition at line 69 of file aac.h.
PAGE 34

28 Flix Engine Linux Module Documentation 5.8 AAC+ 5.8.1 Detailed Description Example Usage: sc = Flix2_AddCodec(&codec, flix, FE2_CODEC_AACPLUS); // Use 128kbps if(sc == ON2_OK) sc = Flix2_CodecSetParam(codec, FE2_AACPLUS_BITRATE, 128); Valid Configurations Channels | Bitrates (kbps) | Sampling Rate (kHz) =========================================================================== 1ch | 8,10,12,16 | 22.05,24,32,44.1,48 1ch | 20,24,28,32,40,48 | 32,44.1,48 1ch | 56,64 | 32,44.1,48,64,88.
PAGE 35

5.8 AAC+ 5.8.2 Define Documentation 5.8.2.1 #define FE2_AACPLUS_BITRATE 29 Alias for FE2_CODECPARAM_BITRATE. Codec parameter for stream bitrate. Compressed stream bitrate in kbits/sec. Note: Default: 64 Definition at line 126 of file aac.h. 5.8.2.2 #define FE2_AACPLUS_PARAMETRIC_STEREO Parameter for parametric stereo. The Parametric Stereo technology was standardized by ISO 14496-3.
PAGE 36

30 Flix Engine Linux Module Documentation 5.9 AMR_NB - FFmpeg 5.9.1 Detailed Description AMR narrowband encoder. Valid bitrates: AMR narrowband only supports a fixed set of bitrates: codec mode | kbps =================== MR475 | 4.75 MR515 | 5.15 MR59 | 5.90 MR67 | 6.70 MR74 | 7.40 MR795 | 7.95 MR102 | 10.2 MR122 | 12.2 FE2_AMR_BITRATE will be adjusted as follows, if necessary: FE2_AMR_BITRATE = 0.0 5.0 5.9 6.7 7.0 7.95 10.0 12.
PAGE 37

5.9 AMR_NB - FFmpeg AMR Narrowband. Codec name for use with Flix2_AddCodec(). • #define FE2_AMR_BITRATE Alias for FE2_CODECPARAM_BITRATE. 5.9.2 Define Documentation 5.9.2.1 #define FE2_AMR_BITRATE Alias for FE2_CODECPARAM_BITRATE. Codec parameter for stream bitrate. Compressed stream bitrate in kbits/sec. Note: Default: 12.2kbps Definition at line 80 of file amr.h. 5.9.2.2 #define FE2_CODEC_AMR_NB AMR Narrowband. Codec name for use with Flix2_AddCodec(). Definition at line 73 of file amr.h.
PAGE 38

32 Flix Engine Linux Module Documentation 5.10 H263 - FFmpeg 5.10.1 Detailed Description The H263 codec .... Example Usage: sc = Flix2_AddCodec(&codec, flix, FE2_CODEC_H263); // Use 450kbit if(sc == ON2_OK) sc = Flix2_CodecSetParam(codec, FE2_H263_BITRATE, 450.0); Additional References: • FFmpeg project homepage Defines • #define FE2_CODEC_H263 Codec name for use with Flix2_AddCodec(). • #define FE2_CODEC_H263_BASELINE Codec name for use with Flix2_AddCodec().
PAGE 39

5.10 H263 - FFmpeg 5.10.2.2 33 #define FE2_CODEC_H263_BASELINE Codec name for use with Flix2_AddCodec(). Specifically this codec refers to the baseline H.263 profile (profile 0) supported within 3GPP files amongst others. Attention: The baseline profile only supports the following resolutions: • sub-QCIF (128x96) • QCIF (176x144) • CIF (352x288) See also: Scale ITU-T Recommendation H.263 (01/05): "Video coding for low bit rate communication". Definition at line 56 of file h263.h. 5.10.2.
PAGE 40

34 Flix Engine Linux Module Documentation 5.10.2.5 #define FE2_H263_KFINTTYPE Alias for FE2_VCODECPARAM_KFINTTYPE. Video codec parameter for the keyframe interval type. Valid values are defined by FE2_VideoKeyframeTypes. Note: Default: MAX_KEYFRAMES Definition at line 70 of file h263.h. 5.10.2.6 #define FE2_H263_MAX_Q Codec parameter for maximum quantizer. Note: Default: 31 Definition at line 94 of file h263.h. 5.10.2.7 #define FE2_H263_MIN_Q Codec parameter for minimum quantizer.
PAGE 41

5.11 H264 35 5.11 H264 5.11.1 Detailed Description The H264 video codec. Example Usage: sc = Flix2_AddCodec(&codec, flix, FE2_CODEC_H264); // Use 450kbit if(sc == ON2_OK) sc = Flix2_CodecSetParam(codec, FE2_H264_BITRATE, 450.0); Attention: Both width and height MUST be multiples of 4 for codec setup to succeed Additional References: • ISO - International Organization for Standardization • ISO/IEC 14496-10: Advanced Video Coding • ITU - International Telecommunication Union • ITU-T Rec. 5.11.2 H.
PAGE 42

36 Flix Engine Linux Module Documentation • #define FE2_H264_RC_MODE Alias for FE2_VCODECPARAM_RC_MODE. • #define FE2_H264_PROFILE Codec parameter for encoding profile. • #define FE2_H264_B_FRAME_RATE Codec parameter for B frame rate. • #define FE2_H264_SPEED Controls frame analysis, affecting encoder speed and inversely output quality. Typedefs • typedef enum h264profile h264profile_t Valid profiles for use with the FE2_H264_PROFILE parameter.
PAGE 43

5.11 H264 5.11.3.3 37 #define FE2_H264_BITRATE Alias for FE2_CODECPARAM_BITRATE. Codec parameter for stream bitrate. Compressed stream bitrate in kbits/sec. Note: Default: 448 Definition at line 63 of file h264.h. 5.11.3.4 #define FE2_H264_KFFREQ Alias for FE2_VCODECPARAM_KFFREQ. Video codec parameter for keyframe frequency. Value is in video frames. KFINTTYPE The interpretation depends on the setting of FE2_VCODECPARAM_- See also: FE2_VideoKeyframeTypes Note: Default: 12.
PAGE 44

38 Flix Engine Linux Module Documentation Definition at line 89 of file h264.h. 5.11.3.7 #define FE2_H264_RC_MODE Alias for FE2_VCODECPARAM_RC_MODE. Note: Default: VBR_1PASSControl Attention: Only VBR_1PASSControl or CBR_1PASSControl are supported at this time Definition at line 84 of file h264.h. 5.11.3.8 #define FE2_H264_SPEED Controls frame analysis, affecting encoder speed and inversely output quality.
PAGE 45

5.12 MP3 - LAME 5.12 MP3 - LAME 5.12.1 Detailed Description The LAME codec is used to produce MP3 audio streams. Example Usage: sc = Flix2_AddCodec(&codec, flix, FE2_CODEC_LAME); // Use 128kbit if(sc == ON2_OK) sc = Flix2_CodecSetParam(codec, FE2_LAME_BITRATE, Bitrate128kbps); Additional References: LAME project homepage Defines • #define FE2_CODEC_LAME Codec name for use with Flix2_AddCodec(). • #define FE2_LAME_BITRATE Alias for FE2_CODECPARAM_BITRATE.
PAGE 46

40 Flix Engine Linux Module Documentation 5.12.2 Define Documentation 5.12.2.1 #define FE2_CODEC_LAME Codec name for use with Flix2_AddCodec(). Definition at line 41 of file lame.h. 5.12.2.2 #define FE2_LAME_BITRATE Alias for FE2_CODECPARAM_BITRATE. Codec parameter for stream bitrate. Compressed stream bitrate in kbits/sec. Valid bitrates are defined by FE2_AudioBitrates Note: Default: Bitrate64kbps Attention: Some combinations of bitrate and samplerate are invalid based on the MP3 specification.
PAGE 47

5.12 MP3 - LAME 41 quality=0..9. 0=best (very slow). 9=worst. recommended: 2 near-best quality, not too slow 5 good quality, fast 7 ok quality, really fast Note: Valid range: [0,9] Default: 5 Definition at line 72 of file lame.h. 5.12.2.5 #define FE2_LAME_RC_MODE Codec parameter for controlling LAME library’s rate control method. Note: Valid values are defined by lame_rcmode_t Default: LAME_CBR Definition at line 77 of file lame.h. 5.12.3 Typedef Documentation 5.12.3.
PAGE 48

42 Flix Engine Linux Module Documentation 5.13 libvorbis - FFmpeg 5.13.1 Detailed Description Example Usage: sc = Flix2_AddCodec(&codec, flix, FE2_CODEC_VORBIS); // Use 128kbps if(sc == ON2_OK) sc = Flix2_CodecSetParam(codec, FE2_VORBIS_BITRATE, 128); Defines • #define FE2_CODEC_VORBIS Vorbis. Codec name for use with Flix2_AddCodec(). • #define FE2_VORBIS_BITRATE Alias for FE2_CODECPARAM_BITRATE. 5.13.2 Define Documentation 5.13.2.1 #define FE2_CODEC_VORBIS Vorbis.
PAGE 49

5.14 VP6 43 5.14 VP6 5.14.1 Detailed Description The VP6 (Flash 8) video codec. Example Usage: sc = Flix2_AddCodec(&codec, flix, FE2_CODEC_VP6); // Use 450kbit if(sc == ON2_OK) sc = Flix2_CodecSetParam(codec, FE2_VP6_BITRATE, 450.0); 5.14.2 Defaults dependent on bits per pixel Defaults for some encoder parameters are determined based on the bits per pixel, which is determined as follows: FE2_VP6_BITRATE ∗ 1024 bitsperpixel = imagew ∗ imageh ∗ f ps The current defaults are: | <.03 | <.07 | <.12 | <.
PAGE 50

44 Flix Engine Linux Module Documentation General VP6 settings • enum FE2_CompressMode { COMPRESSMODE_GOOD, COMPRESSMODE_BEST } Valid compress modes for VP6, influences encoder speed. • enum vp6profile { VP6_E, VP6_S } Valid profiles for use with the FE2_VP6_PROFILE parameter. • typedef enum vp6profile vp6profile_t Valid profiles for use with the FE2_VP6_PROFILE parameter. • #define FE2_VP6_BITRATE Alias for FE2_CODECPARAM_BITRATE. • #define FE2_VP6_KFINTTYPE Alias for FE2_VCODECPARAM_KFINTTYPE.
PAGE 51

5.14 VP6 45 Advanced VP6 settings • #define FE2_VP6_CONCURRENCY Codec parameter for concurrency level. • #define FE2_VP6_UNDERSHOOT_PCT Codec parameter for undershoot percentage. • #define FE2_VP6_MIN_Q Codec parameter for minimum quantizer. • #define FE2_VP6_MAX_Q Codec parameter for maximum quantizer. • #define FE2_VP6_TEMPORAL_RESAMPLING Codec parameter for temporal resampling. • #define FE2_VP6_TEMPORAL_DOWN_WATERMARK Codec parameter for temporal down watermark percentage.
PAGE 52

46 Flix Engine Linux Module Documentation 5.14.4 Define Documentation 5.14.4.1 #define FE2_CODEC_VP6 Codec name for use with Flix2_AddCodec(). Definition at line 84 of file vp6.h. 5.14.4.2 #define FE2_VP6_2PASS_MAX_SECTION VBR_2PASSControl maximum section datarate This value is given as a percentage. The highest datarate, i.e., FE2_VP6_2PASS_MAX_SECTION% × FE2_VP6_BITRATE, that can be streamed, and also the highest datarate that the encoder will allow, no matter how difficult the section is.
PAGE 53

5.14 VP6 47 Usage Considerations: The current implementation parallelizes the video encode on keyframe boundaries. To achieve this, each instance (1 per core/processor) must buffer both the raw input frames as well as those encoded. As a result, the memory requirement for each session increases dramatically. The number of raw (YV12) input frames required per processor is FE2_VP6_KFFREQ or 60 (the current allowed maximum), whichever is smaller.
PAGE 54

48 Flix Engine Linux Module Documentation Note: Default: COMPRESSMODE_GOOD Definition at line 149 of file vp6.h. 5.14.4.7 #define FE2_VP6_KFFREQ Alias for FE2_VCODECPARAM_KFFREQ. Video codec parameter for keyframe frequency. Value is in video frames. KFINTTYPE The interpretation depends on the setting of FE2_VCODECPARAM_- See also: FE2_VideoKeyframeTypes Note: Default: 12.0 × outputf ps or 360 frames if the framerate is unknown Definition at line 137 of file vp6.h. 5.14.4.
PAGE 55

5.14 VP6 5.14.4.10 49 #define FE2_VP6_MIN_Q Codec parameter for minimum quantizer. Determines the quality of the output. A lower minimum number produces higher quality output. Note: Valid range: [0,63] Default: Bits per pixel dependent Definition at line 244 of file vp6.h. 5.14.4.11 #define FE2_VP6_NOISE_REDUCTION Codec parameter for noise reduction. Determines the level of noise filtering to apply in the preprocessor. 0 is no preprocessing, 6 is extreme preprocessing.
PAGE 56

50 Flix Engine Linux Module Documentation 5.14.4.14 #define FE2_VP6_SHARPNESS Codec parameter for sharpness. Controls the sharpness of the image in the output. This setting does not impact any other setting and is largely a matter of personal preference. A low sharpness setting will result in fewer visible artifacts but may blur the image somewhat; a high sharpness will result in a sharper image but may result in more visible artifacts.
PAGE 57

5.14 VP6 5.14.4.18 51 #define FE2_VP6_STREAM_PREBUFFER Seconds of preload that are necessary before starting playback. The buffer is used to maintain a consistent datarate and minimize playback interruption. Note: Default: 6 Attention: Valid for CBR only Definition at line 301 of file vp6.h. 5.14.4.19 #define FE2_VP6_TEMPORAL_DOWN_WATERMARK Codec parameter for temporal down watermark percentage.
PAGE 58

52 Flix Engine Linux Module Documentation Note: Default: 90 Definition at line 236 of file vp6.h. 5.14.5 Typedef Documentation 5.14.5.1 typedef enum vp6profile vp6profile_t Valid profiles for use with the FE2_VP6_PROFILE parameter. 5.14.6 Enumeration Type Documentation 5.14.6.1 enum FE2_CompressMode Valid compress modes for VP6, influences encoder speed. For use in calls to Flix2_CodecSetParam() and Flix2_CodecGetParam() for the FE2_VP6_CXMODE and FE2_VP6A_CXMODE. For general transcoding (i.e.
PAGE 59

5.15 VP6 with Alpha 5.15 VP6 with Alpha 5.15.1 Detailed Description 53 The VP6 codec with support for an alpha channel. Example Usage: sc = Flix2_AddCodec(&codec, flix, FE2_CODEC_VP6ALPHA); //Use 380kbit for the video .. if(sc == ON2_OK) sc = Flix2_CodecSetParam(codec, FE2_VP6A_BITRATE, 380.0); //..and 68kbit for the alpha channel if(sc == ON2_OK) sc = Flix2_CodecSetParam(codec, FE2_VP6A_ALPHA_BITRATE, 68.
PAGE 60

54 Flix Engine Linux Module Documentation • #define FE2_VP6A_NOISE_REDUCTION Alias for FE2_VP6_NOISE_REDUCTION. • #define FE2_VP6A_ALPHA_NOISE_REDUCTION Noise reduction for the alpha channel. Advanced VP6 settings • #define FE2_VP6A_UNDERSHOOT_PCT Alias for FE2_VP6_UNDERSHOOT_PCT. • #define FE2_VP6A_MIN_Q Alias for FE2_VP6_MIN_Q. • #define FE2_VP6A_ALPHA_MIN_Q Minimum quantizer for the alpha channel. • #define FE2_VP6A_MAX_Q Alias for FE2_VP6_MAX_Q.
PAGE 61

5.15 VP6 with Alpha 5.15.2 Define Documentation 5.15.2.1 #define FE2_CODEC_VP6ALPHA 55 Codec name for use with Flix2_AddCodec(). Definition at line 56 of file vp6_alpha.h. 5.15.2.2 #define FE2_VP6A_2PASS_MAX_SECTION Alias for FE2_VP6_2PASS_MAX_SECTION. VBR_2PASSControl maximum section datarate This value is given as a percentage. The highest datarate, i.e.
PAGE 62

56 Flix Engine Linux Module Documentation See also: FE2_VP6A_MAX_Q Definition at line 154 of file vp6_alpha.h. 5.15.2.6 #define FE2_VP6A_ALPHA_MIN_Q Minimum quantizer for the alpha channel. See also: FE2_VP6A_MIN_Q Definition at line 143 of file vp6_alpha.h. 5.15.2.7 #define FE2_VP6A_ALPHA_NOISE_REDUCTION Noise reduction for the alpha channel. See also: FE2_VP6A_NOISE_REDUCTION Definition at line 120 of file vp6_alpha.h. 5.15.2.8 #define FE2_VP6A_ALPHA_SHARPNESS Sharpness for the alpha channel.
PAGE 63

5.15 VP6 with Alpha 5.15.2.10 57 #define FE2_VP6A_CXMODE Alias for FE2_VP6_CXMODE. VP6 compress mode. Valid values are defined by FE2_CompressMode Note: Default: COMPRESSMODE_GOOD Definition at line 98 of file vp6_alpha.h. 5.15.2.11 #define FE2_VP6A_KFFREQ Alias for FE2_VP6_KFFREQ. Alias for FE2_VCODECPARAM_KFFREQ. Video codec parameter for keyframe frequency. Value is in video frames.
PAGE 64

58 Flix Engine Linux Module Documentation Note: Valid range: [0,63] Default: Bits per pixel dependent Attention: Setting this value too low will likely cause the encoder to miss (i.e., overshoot) the target datarate specified by FE2_VP6_BITRATE and, should FE2_VP6_TEMPORAL_RESAMPLING be enabled, result in a large amount of dropped frames. The table mentioned above should be used as a guide in choosing a reasonable value based on the bitrate. Definition at line 149 of file vp6_alpha.h. 5.15.2.
PAGE 65

5.15 VP6 with Alpha 5.15.2.17 59 #define FE2_VP6A_SHARPNESS Alias for FE2_VP6_SHARPNESS. Codec parameter for sharpness. Controls the sharpness of the image in the output. This setting does not impact any other setting and is largely a matter of personal preference. A low sharpness setting will result in fewer visible artifacts but may blur the image somewhat; a high sharpness will result in a sharper image but may result in more visible artifacts.
PAGE 66

60 Flix Engine Linux Module Documentation Attention: Valid for CBR only Definition at line 172 of file vp6_alpha.h. 5.15.2.21 #define FE2_VP6A_STREAM_PREBUFFER Alias for FE2_VP6_STREAM_PREBUFFER. Seconds of preload that are necessary before starting playback. The buffer is used to maintain a consistent datarate and minimize playback interruption. Note: Default: 6 Attention: Valid for CBR only Definition at line 178 of file vp6_alpha.h. 5.15.2.
PAGE 67

5.15 VP6 with Alpha 61 Definition at line 160 of file vp6_alpha.h. 5.15.2.24 #define FE2_VP6A_UNDERSHOOT_PCT Alias for FE2_VP6_UNDERSHOOT_PCT. Codec parameter for undershoot percentage. This value is given as a percentage. Creates output that targets a slightly lower datarate so there are bits available in the buffer to improve difficult sections. Note: Default: 90 Definition at line 132 of file vp6_alpha.h.
PAGE 68

62 Flix Engine Linux Module Documentation 5.16 VP8 5.16.1 Detailed Description The VP8 video codec. Example Usage: sc = Flix2_AddCodec(&codec, flix, FE2_CODEC_VP8); // Use 450kbit if(sc == ON2_OK) sc = Flix2_CodecSetParam(codec, FE2_VP8_BITRATE, 450.0); Codec name • #define FE2_CODEC_VP8 Codec name for use with Flix2_AddCodec(). General VP8 settings • #define FE2_VP8_BITRATE Alias for FE2_CODECPARAM_BITRATE. • #define FE2_VP8_KFINTTYPE Alias for FE2_VCODECPARAM_KFINTTYPE.
PAGE 69

5.16 VP8 63 • #define FE2_VP8_MIN_Q Codec parameter for minimum quantizer. • #define FE2_VP8_MAX_Q Codec parameter for maximum quantizer. • #define FE2_VP8_DROP_THRESH Threshold controlling encoder frame dropping. CBR-Specific • #define FE2_VP8_STREAM_INITIAL_BUFFER Seconds of preload that are necessary before starting playback. • #define FE2_VP8_STREAM_OPTIMAL_BUFFER Buffer size that the encoder strives to reach or maintain in case of specific frame overshoots.
PAGE 70

64 Flix Engine Linux Module Documentation • #define FE2_VP8_MB_STATIC_THRESHOLD Threshold for macroblocks treated static. • #define FE2_VP8_TOKEN_PARTITIONS Number of token partitions. • #define FE2_VP8_LAG Allow lagged encoding If set, this value allows the encoder to consume a number of input frames before producing output frames. This allows the encoder to base decisions for the current frame on future frames.
PAGE 71

5.16 VP8 5.16.2.4 65 #define FE2_VP8_ALTREF Enable the use of alternate reference frames. Note: Default: 0 Definition at line 211 of file vp8.h. 5.16.2.5 #define FE2_VP8_AR_MAX_FRAMES Max number of frames blurred creating alternate reference. Note: Valid range: [0,25] Default: 0 Definition at line 216 of file vp8.h. 5.16.2.6 #define FE2_VP8_AR_STRENGTH Filter strength for the alternate reference. Note: Valid range: [0,6] Default: 0 Definition at line 225 of file vp8.h. 5.16.2.
PAGE 72

66 Flix Engine Linux Module Documentation 5.16.2.9 #define FE2_VP8_CXMODE VP8 compress mode. Valid values are defined by FE2_CompressMode Note: Default: COMPRESSMODE_GOOD Definition at line 77 of file vp8.h. 5.16.2.10 #define FE2_VP8_DROP_THRESH Threshold controlling encoder frame dropping. A value of 0 disables frame dropping. Larger values will increase the likelihood frames will be dropped to achieve data rate constraints. Recommended values are 0 for VBR mode and 70 for CBR mode.
PAGE 73

5.16 VP8 5.16.2.13 67 #define FE2_VP8_LAG Allow lagged encoding If set, this value allows the encoder to consume a number of input frames before producing output frames. This allows the encoder to base decisions for the current frame on future frames. Note: Valid range: [0,25] Default: 0 Definition at line 245 of file vp8.h. 5.16.2.14 #define FE2_VP8_MAX_Q Codec parameter for maximum quantizer. Determines the quality of the output. A lower maximum number produces higher quality output.
PAGE 74

68 Flix Engine Linux Module Documentation 5.16.2.17 #define FE2_VP8_NOISE_REDUCTION Controls encoder noise reduction preprocessing. Determines the level of noise filtering to apply in the preprocessor. 0 is no preprocessing, 6 is extreme preprocessing. Note: Valid range: [0,6] Setting this value to anything but 0 will result in slowing down the compression speed. Default: Definition at line 98 of file vp8.h. 5.16.2.18 #define FE2_VP8_OVERSHOOT_PCT Codec parameter for undershoot percentage.
PAGE 75

5.16 VP8 5.16.2.21 69 #define FE2_VP8_SHARPNESS Codec parameter for sharpness. Controls the sharpness of the image in the output. This setting does not impact any other setting and is largely a matter of personal preference. A low sharpness setting will result in fewer visible artifacts but may blur the image somewhat; a high sharpness will result in a sharper image but may result in more visible artifacts. Note: Valid range: [0,7] Default: 0 Definition at line 88 of file vp8.h. 5.16.2.
PAGE 76

70 Flix Engine Linux Module Documentation 5.16.2.25 #define FE2_VP8_THREADS Number of threads to use A reasonable selection would be the number of cores on the system. Note: Default: 1 Definition at line 250 of file vp8.h. 5.16.2.26 #define FE2_VP8_TOKEN_PARTITIONS Number of token partitions. This defines VP8 partitioning mode for compressed data, i.e., the number of sub-streams in the bitstream. Used for parallelized decoding.
PAGE 77

5.17 Encoding Statistics 5.17 71 Encoding Statistics Functions • on2sc encoding_status_GetAverageBitrate (const FLIX2HANDLE flix, int32_t ∗pBitrate) Retrieve the encoder’s average (video) bitrate. • on2sc encoding_status_GetAverageFramesize (const FLIX2HANDLE flix, int32_t ∗pFramesize) Retrieve the encoder’s average (video) frame size.
PAGE 78

72 Flix Engine Linux Module Documentation ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL pBitrate is not NULL 5.17.1.2 on2sc encoding_status_GetAverageFramesize (const FLIX2HANDLE flix, int32_t ∗ pFramesize) Retrieve the encoder’s average (video) frame size. Value is in bytes.
PAGE 79

5.17 Encoding Statistics 5.17.1.4 on2sc encoding_status_GetEndTime (const FLIX2HANDLE flix, int32_t ∗ pEndTime) Retrieve the encode completion time. Value is in milliseconds.
PAGE 80

74 Flix Engine Linux Module Documentation → pMinFramesize Storage location to receive the result Return values: ON2_OK on success ON2_INVALID_PARAMS should one or more of the preconditions fail ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL pMinFramesize is not NULL 5.17.1.7 on2sc encoding_status_GetStartTime (const FLIX2HANDLE flix, int32_t ∗ pStartTime) Retrieve the encode start time. Value is in milliseconds.
PAGE 81

5.17 Encoding Statistics 5.17.1.9 75 on2sc encoding_status_PercentComplete (const FLIX2HANDLE flix, int32_t ∗ percent) Retrieve the percent of the encode complete. Percent is returned as a whole number, e.g. 45.
PAGE 82

76 Flix Engine Linux Module Documentation 5.18 Filters 5.18.1 Detailed Description The Flix API supports a variety of filters. Filters are used to apply user controllable effects to the source material. For example, these include resizing, color adjustment, frame rate conversion, cuts, overlays, etc. All effect filters in Flix will be configured using this API. In a future release, all existing features will be available via this interface as well.
PAGE 83

5.19 Video Filters 5.
PAGE 84

78 Flix Engine Linux Module Documentation 5.
PAGE 85

5.21 Deinterlace 5.21 Deinterlace 5.21.
PAGE 86

80 Flix Engine Linux Module Documentation DEINTERLACE_1_2_1_BLUR, DEINTERLACE_DROP_FIELD, DEINTERLACE_ADAPTIVE } 5.21.2 Define Documentation 5.21.2.1 #define FE2_ADAPTIVE_DEINTERLACE_MODE Specifies deinterlace mode to be applied to source image. The mode may be selected from deintmode_t. Note: Default: DEINTERLACE_NONE Definition at line 65 of file adaptive_deinterlace.h. 5.21.2.2 #define FE2_FILTER_ADAPTIVE_DEINTERLACE Filter name for use with Flix2_AddFilter().
PAGE 87

5.21 Deinterlace 81 Return values: ON2_OK The deinterlace filter enable status was successfully retrieved from the engine. ON2_NET_ERROR The underlying communication layer failed. Note: If a value other than ON2_OK is returned, the output variables should not be considered valid. Deprecated Use the Filter Interface along with FE2_FILTER_ADAPTIVE_DEINTERLACE. This function will be removed in a future release. 5.21.5.
PAGE 88

82 Flix Engine Linux Module Documentation 5.22 Brightness/Contrast/Hue/Saturation 5.22.1 Detailed Description The BCHS video filter is a filter used to modify the brightness, contrast, hue and/or saturation of the source image.
PAGE 89

5.22 Brightness/Contrast/Hue/Saturation 83 • on2sc editor_options_SetHue (FLIX2HANDLE flix, const int32_t hue) Set the hue adjustment factor. • on2sc editor_options_GetUseHue (const FLIX2HANDLE flix, on2bool ∗pUseHue) Determine if the hue filter is enabled. • on2sc editor_options_SetUseHue (FLIX2HANDLE flix, const on2bool bUseHue) Enable/disable the hue filter. • on2sc editor_options_GetSaturation (const FLIX2HANDLE flix, double ∗pSaturation) Get the current saturation adjustment factor.
PAGE 90

84 Flix Engine Linux Module Documentation Note: Valid range: [-255,255] Default: 0 (no change) Definition at line 58 of file bchs.h. 5.22.2.2 #define FE2_BCHS_CONTRAST Parameter for the contrast adjustment factor. Determines the level by which to adjust the contrast. Contrast is adjusted on a scale of -255 to 255, with 0 indicating no change. To increase the relative contrast of the video, use a positive number. To decrease the relative contrast of the video, use a negative number.
PAGE 91

5.22 Brightness/Contrast/Hue/Saturation 5.22.3 Function Documentation 5.22.3.1 on2sc editor_options_GetBrightness (const FLIX2HANDLE flix, int32_t ∗ pBrightness) 85 Get the current brightness adjustment factor. Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() → pBrightness Brightness factor (-255..255) Return values: ON2_OK The brightness value was successfully retrieved from the engine. ON2_NET_ERROR The underlying communication layer failed.
PAGE 92

86 Flix Engine Linux Module Documentation Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() → pHue Hue factor (-180..180) Return values: ON2_OK The hue value was successfully retrieved from the engine. ON2_NET_ERROR The underlying communication layer failed. Note: If a value other than ON2_OK is returned, the output variables should not be considered valid. Deprecated Use the Filter Interface along with FE2_FILTER_BCHS and the FE2_BCHS_HUE parameter.
PAGE 93

5.22 Brightness/Contrast/Hue/Saturation 87 Return values: ON2_OK The brightness filter enable status was successfully retrieved from the engine. ON2_NET_ERROR The underlying communication layer failed. Note: If a value other than ON2_OK is returned, the output variables should not be considered valid. Deprecated Use the Filter Interface along with FE2_FILTER_BCHS and the FE2_BCHS_BRIGHTNESS parameter. This function will be removed in a future release. 5.22.3.
PAGE 94

88 Flix Engine Linux Module Documentation Deprecated Use the Filter Interface along with FE2_FILTER_BCHS and the FE2_BCHS_HUE parameter. This function will be removed in a future release. 5.22.3.8 on2sc editor_options_GetUseSaturation (const FLIX2HANDLE flix, on2bool ∗ pUseSaturation) Determine if the saturation filter is enabled.
PAGE 95

5.22 Brightness/Contrast/Hue/Saturation 5.22.3.10 89 on2sc editor_options_SetContrast (FLIX2HANDLE flix, const double contrast) Set the contrast adjustment factor. Determines the level by which to adjust the contrast. Contrast is adjusted on a scale of -255 to 255, with 0 indicating no change. To increase the relative contrast of the video, use a positive number. To decrease the relative contrast of the video, use a negative number.
PAGE 96

90 Flix Engine Linux Module Documentation 5.22.3.12 on2sc editor_options_SetSaturation (FLIX2HANDLE flix, const double saturation) Set the saturation adjustment factor. Determines the level by which to adjust the saturation. Saturation is adjusted on a scale of -255 to 255, with 0 indicating no change. To increase the relative saturation of the video, use a positive number. To decrease the relative saturation of the video, use a negative number.
PAGE 97

5.22 Brightness/Contrast/Hue/Saturation 5.22.3.14 91 on2sc editor_options_SetUseContrast (FLIX2HANDLE flix, const on2bool bUseContrast) Enable/disable the contrast filter. Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() ← bUseContrast New contrast enable status. on2true to enable, on2false to disable. Return values: ON2_OK The contrast enable status was successfully set in the engine. ON2_NET_ERROR The underlying communication layer failed.
PAGE 98

92 Flix Engine Linux Module Documentation ← bUseSaturation New saturation enable status. on2true to enable, on2false to disable. Return values: ON2_OK The saturation enable status was successfully set in the engine. ON2_NET_ERROR The underlying communication layer failed. Note: By default, the saturation filter is disabled. Deprecated Use the Filter Interface along with FE2_FILTER_BCHS and the FE2_BCHS_SATURATION parameter. This function will be removed in a future release.
PAGE 99

5.23 Blur 93 5.23 Blur 5.23.
PAGE 100

94 Flix Engine Linux Module Documentation 5.23.2 Define Documentation 5.23.2.1 #define FE2_BLUR_FILTER Specifies blur filter to be applied to source. The blur filter may be selected from blurfilter_t. Note: Default: BLUR_LOWPASS Definition at line 88 of file blur.h. 5.23.2.2 #define FE2_BLUR_MASKSIZE Specifies the kernel/mask size to be used. The mask size may be selected from masksiz_t. Note: Default: MASK_3x3 See also: blurfilter_t for kernel details Definition at line 95 of file blur.h. 5.23.2.
PAGE 101

5.23 Blur 95 1/25 1/25 MASK_5x5: 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 1/25 BLUR_GAUSS Filter image using a Gaussian kernel. MASK_3x3: 1/16 2/16 1/16 2/16 4/16 2/16 1/16 2/16 1/16 2/571 7/571 12/571 7/571 2/571 7/571 31/571 52/571 31/571 7/571 MASK_5x5: 12/571 52/571 127/571 52/571 12/571 7/571 31/571 52/571 31/571 7/571 2/571 7/571 12/571 7/571 2/571 Definition at line 52 of file blur.h. 5.23.4.
PAGE 102

96 Flix Engine Linux Module Documentation 5.24 Crop 5.24.1 Detailed Description The crop video filter is a filter used to isolate a subsection of an input image.
PAGE 103

5.24 Crop 97 • #define FE2_CROP_LEFT Filter parameter for setting bounding box’s left coordinate. • #define FE2_CROP_RIGHT Filter parameter for setting bounding box’s right coordinate. 5.24.2 Define Documentation 5.24.2.1 #define FE2_CROP_BOTTOM Filter parameter for setting bounding box’s bottom coordinate. Note: Default: input image height Value must be a multiple of 2. Odd values will be silently adjusted down. Definition at line 61 of file crop.h. 5.24.2.
PAGE 104

98 Flix Engine Linux Module Documentation 5.24.2.5 #define FE2_FILTER_CROP Filter name for use with Flix2_AddFilter(). Definition at line 49 of file crop.h. 5.24.3 Function Documentation 5.24.3.1 on2sc editor_options_GetCrop (const FLIX2HANDLE flix, on2bool ∗ pCrop) Determine if the crop filter is enabled.
PAGE 105

5.24 Crop 99 Deprecated Use the Filter Interface along with FE2_FILTER_CROP and the FE2_CROP_TOP, FE2_CROP_LEFT, FE2_CROP_BOTTOM and FE2_CROP_RIGHT parameters. This function will be removed in a future release. 5.24.3.3 on2sc editor_options_SetCrop (FLIX2HANDLE flix, const on2bool crop) Enable/disable the crop filter. Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() ← crop New crop enable status. on2true to enable, on2false to disable.
PAGE 106

100 Flix Engine Linux Module Documentation Deprecated Use the Filter Interface along with FE2_FILTER_CROP and the FE2_CROP_TOP, FE2_CROP_LEFT, FE2_CROP_BOTTOM and FE2_CROP_RIGHT parameters. This function will be removed in a future release.
PAGE 107

5.25 Cut 101 5.25 Cut 5.25.1 Detailed Description The cut filter allows for the encoding of a user specified range of time from the input media file.
PAGE 108

102 Flix Engine Linux Module Documentation • #define FE2_CUT_STOP_SEC Filter parameter for setting the cut stop time. • #define FE2_CUT_USE_SEEK Set FE2_CUT_START_SEC application method. 5.25.2 Define Documentation 5.25.2.1 #define FE2_CUT_START_SEC Filter parameter for cut start time. Sets the time (in seconds relative to the beginning of the source) to begin the media cut. A value of 0 indicates that the cut should start at the beginning of the input media.
PAGE 109

5.25 Cut 5.25.2.4 103 #define FE2_FILTER_CUT Filter name for use with Flix2_AddFilter(). Definition at line 52 of file cut.h. 5.25.3 Function Documentation 5.25.3.1 on2sc editor_options_GetCutStartTime (const FLIX2HANDLE flix, double ∗ pStartTime) Get the current cut start time. Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() → pStartTime Clip start time (in seconds) Return values: ON2_OK The cut start time was successfully retrieved from the engine.
PAGE 110

104 Flix Engine Linux Module Documentation ON2_NET_ERROR The underlying communication layer failed. Note: If a value other than ON2_OK is returned, the output variables should not be considered valid. Deprecated Please use: • Flix2_AddFilter() • Flix2_FilterGetParam() • Flix2_FilterSetParam() With the constants: • FE2_FILTER_CUT • FE2_CUT_START_SEC • FE2_CUT_STOP_SEC for access to the flix engine cut filter. 5.25.3.
PAGE 111

5.25 Cut 5.25.3.4 105 on2sc editor_options_SetCutStartTime (FLIX2HANDLE flix, const double start_time) Set the cut start time. Sets the time (in seconds from the beginning of the source) to begin the media cut. 0 indicates start immediately. Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() ← start_time Start time (in seconds, relative to source) Return values: ON2_OK The start time value was successfully set in the engine.
PAGE 112

106 Flix Engine Linux Module Documentation Note: This call will have no effect on the encoded video unless the cut filter is enabled with editor_options_SetUseCut(). The default value is -1.0 (end of source). Deprecated Please use: • Flix2_AddFilter() • Flix2_FilterGetParam() • Flix2_FilterSetParam() With the constants: • FE2_FILTER_CUT • FE2_CUT_START_SEC • FE2_CUT_STOP_SEC for access to the flix engine cut filter. 5.25.3.
PAGE 113

5.26 Denoise 5.26 Denoise 5.26.1 Detailed Description 107 Removes noise from source image Filter Parameters: Name | Type | Opt/Reqd | Range ===================================================================== FE2_DENOISE_NOISE_LEVEL | Numeric | Optional | [0.0,1.0) Example Usage: sc = Flix2_AddFilter(&filter, flix, FE2_FILTER_DENOISE); if(sc == ON2_OK) ; //adaptive noise removal will be applied to the source image Defines • #define FE2_FILTER_DENOISE Filter name for use with Flix2_AddFilter().
PAGE 114

108 Flix Engine Linux Module Documentation 5.27 Frame Rate 5.27.1 Detailed Description The frame rate filter modifies the source frame rate either by applying a specific frame rate (e.g. 12.0) or a decimation interval (e.g. 2 = 1/2 source frame rate). Filter Parameters: Name | Type | Opt/Reqd | Range ============================================================================ FE2_FRAMERATE_FPS | Numeric | Optional | [0.
PAGE 115

5.27 Frame Rate 109 Defines • #define FE2_FILTER_FRAMERATE Filter name for use with Flix2_AddFilter(). • #define FE2_FRAMERATE_FPS Filter parameter name for frames per second value. • #define FE2_FRAMERATE_DECIMATE Filter parameter for the decimation interval. 5.27.2 Define Documentation 5.27.2.1 #define FE2_FILTER_FRAMERATE Filter name for use with Flix2_AddFilter(). Definition at line 49 of file framerate.h. 5.27.2.2 #define FE2_FRAMERATE_DECIMATE Filter parameter for the decimation interval.
PAGE 116

110 Flix Engine Linux Module Documentation Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() → pValue Decimate value Return values: ON2_OK Success. ON2_INVALID_PARAMS Should one or more of the preconditions fail. ON2_NET_ERROR The underlying communication layer failed. Precondition: flix is not NULL pValue is not NULL Note: If a value other than ON2_OK is returned, the output variables should not be considered valid.
PAGE 117

5.27 Frame Rate 5.27.3.3 111 on2sc video_options_GetVideoFramerate (const FLIX2HANDLE flix, int32_t ∗ lpVideoFramerate) Get the current video framerate. Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() → lpVideoFramerate Frames per second Return values: ON2_OK The framerate was successfully retrieved from the engine. ON2_NET_ERROR The underlying communication layer failed.
PAGE 118

112 Flix Engine Linux Module Documentation Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() ← value Decimate value Return values: ON2_OK The target framerate was successfully set in the engine. ON2_INVALID_PARAMS Should one or more of the preconditions fail. ON2_NET_ERROR The underlying communication layer failed. Precondition: flix is not NULL Note: Default value is 0. A value of <= 1 means to not drop any frames.
PAGE 119

5.27 Frame Rate 5.27.3.7 113 on2sc video_options_SetVideoFramerate (FLIX2HANDLE flix, const int32_t lVideoFramerate) Set the video framerate. Sets the framerate to be used when encoding the video. Frames will be duplicated or dropped as necessary to achieve the desired framerate.
PAGE 120

114 Flix Engine Linux Module Documentation 5.28 Highpass 5.28.1 Detailed Description The highpass audio filter is a filter to attenuate sounds in the audio track that are lower than the cutoff frequency. In other words, high frequencies are passed by the filter, and low frequencies are stopped. Example Usage: sc = Flix2_AddFilter(&filter, flix, FE2_FILTER_HIGHPASS); // Cut off frequencies below 2khz if(sc == ON2_OK) sc = Flix2_FilterSetParam(filter, FE2_HIGHPASS_CUTOFF, 2000.
PAGE 121

5.28 Highpass 5.28.2.3 115 #define FE2_HIGHPASS_Q Filter parameter for shape constant ("Q" coefficient). The Q coefficient controls the "shape" of the filter. In general, higher numbers mean a sharper response curve. The default value is 0.707, and should be appropriate in most cases. If you feel the default value is inadequate, iterative experimentation is the best way to select a new value. Alternatively, a mathematical description of this filter is linked in the references above.
PAGE 122

116 Flix Engine Linux Module Documentation 5.29 Lowpass 5.29.1 Detailed Description The lowpass audio filter is a filter to attenuate sounds in the audio track that are higher than the cutoff frequency. In other words, low frequencies are passed by the filter, and high frequencies are stopped. Example Usage: sc = Flix2_AddFilter(&filter, flix, FE2_FILTER_LOWPASS); // Cut off frequencies above 10khz if(sc == ON2_OK) sc = Flix2_FilterSetParam(filter, FE2_LOWPASS_CUTOFF, 10000.
PAGE 123

5.29 Lowpass 5.29.2.3 117 #define FE2_LOWPASS_Q Filter parameter for shape constant ("Q" coefficient). The Q coefficient controls the "shape" of the filter. In general, higher numbers mean a sharper response curve. The default value is 0.707, and should be appropriate in most cases. If you feel the default value is inadequate, iterative experimentation is the best way to select a new value. Alternatively, a mathematical description of this filter is linked in the references above.
PAGE 124

118 Flix Engine Linux Module Documentation 5.30 Mirror 5.30.1 Detailed Description The mirror filter mirrors (flips) the source along the horizontal axis, vertical axis or both.
PAGE 125

5.30 Mirror Note: Default: 0 (disabled) non-zero: enabled Definition at line 56 of file mirror.h. 5.30.2.3 #define FE2_MIRROR_VERTICAL Specifies vertical disposition. Mirror (flip) the image along the vertical axis Note: Default: 0 (disabled) non-zero: enabled Definition at line 63 of file mirror.h.
PAGE 126

120 Flix Engine Linux Module Documentation 5.31 Overlay (Watermark) 5.31.1 Detailed Description The overlay video filter is a filter used to apply a PNG image to the output video. In addition this filter supports positioning the overlay and treating sections of the image as transparent either by specifying a pixel of the image to use as a reference, specifying a RGB value to use as a reference or using the alpha channel of the image.
PAGE 127

5.31 Overlay (Watermark) 121 • on2sc overlay_options_SetMaskPixelXY (FLIX2HANDLE flix, int32_t maskPixelX, int32_t maskPixelY) Set the X and Y coordinates of the mask pixel. • on2sc overlay_options_GetMaskPixelRGB (FLIX2HANDLE flix, uint8_t ∗pMaskPixelR, uint8_t ∗pMaskPixelG, uint8_t ∗pMaskPixelB) Return the Red, Green, and Blue component values of the mask pixel.
PAGE 128

122 Flix Engine Linux Module Documentation Blue component of the transparency color. • #define FE2_OVERLAY_POS Set the overlay position. Valid modes are defined by FE2_OverlayPositionMode. • #define FE2_OVERLAY_POS_X X coordinate of overlay top left on video. • #define FE2_OVERLAY_POS_Y Y coordinate of overlay top left on video.
PAGE 129

5.31 Overlay (Watermark) 123 Note: Linux Only: flixd, the encoding server, gets its input from, and writes its output to, the host file system. FE2_OVERLAY_FILE must be accessible in this context. An absolute path should be given to help ensure this is the case. See also: Flix2_SetInputFile() Definition at line 96 of file overlay.h. 5.31.2.3 #define FE2_OVERLAY_MASK_B Blue component of the transparency color.
PAGE 130

124 Flix Engine Linux Module Documentation 5.31.2.6 #define FE2_OVERLAY_MASK_RGB Use the RGB value (FE2_OVERLAY_MASK_R, FE2_OVERLAY_MASK_G, FE2_OVERLAY_MASK_B) as the transparency color. Remarks: The color specified will become transparent when the overlay image is drawn on the video image. Setting this parameter will disable FE2_OVERLAY_MASK_XY if it has been set. Using a PNG or bitmap with full alpha channel will produce better results than using a transparency color.
PAGE 131

5.31 Overlay (Watermark) 5.31.2.10 125 #define FE2_OVERLAY_POS Set the overlay position. Valid modes are defined by FE2_OverlayPositionMode. Remarks: If the mode is equal to FE2_OVERLAY_POS_MODE_XY, and either coordinate value is invalid (x > video width or y > video height), the invalid coordinate will be set to 0. If the value of the x and/or y coordinates cause any portion of the overlay to be outside of the video image bounds, the portion of the overlay image that is out of bounds will be cropped.
PAGE 132

126 Flix Engine Linux Module Documentation 5.31.4 Function Documentation 5.31.4.1 on2sc overlay_options_GetMaskPixelRGB (FLIX2HANDLE flix, uint8_t ∗ pMaskPixelR, uint8_t ∗ pMaskPixelG, uint8_t ∗ pMaskPixelB) Return the Red, Green, and Blue component values of the mask pixel.
PAGE 133

5.31 Overlay (Watermark) 127 ON2_INVALID_PARAMS a precondition failed ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL pMaskPixelX is not NULL pMaskPixelY is not NULL Remarks: This method returns the values set in previous call to overlay_options_SetMaskPixelXY(), if no coordinates were previously set, the X and Y coordinate values will be set to 0. The color at the specified coordinate will become transparent when the overlay image is drawn on the video image.
PAGE 134

128 Flix Engine Linux Module Documentation 5.31.4.4 on2sc overlay_options_GetOverlayPosition (FLIX2HANDLE flix, FE2_OverlayPositionMode ∗ pMode, uint32_t ∗ pX, uint32_t ∗ pY) Return the overlay position.
PAGE 135

5.31 Overlay (Watermark) 129 Precondition: flix is not NULL pUseOverlay is not NULL Remarks: Call this function to determine if an overlay is to be drawn on the encoded video output. Deprecated Use the Filter Interface along with FE2_FILTER_OVERLAY. This function will be removed in a future release. 5.31.4.6 on2sc overlay_options_Reset (const FLIX2HANDLE flix) Resets the overlay options.
PAGE 136

130 Flix Engine Linux Module Documentation Return values: ON2_OK the component values were set successfully ON2_INVALID_PARAMS the precondition failed ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL Remarks: The color specified will become transparent when the overlay image is drawn on the video image. Once this function has been called successfully, overlay_options_Reset() must be called to turn transparency off.
PAGE 137

5.31 Overlay (Watermark) 131 Once this function has been called successfully, overlay_options_Reset() must be called to turn transparency off. Calling this method will disable masking based on RGB components. Using a PNG or bitmap with full alpha channel will produce better results than using a transparency color. If using this method to add an overlay to video with an existing alpha channel, the transparent portions of the overlay will be transparent in the output video.
PAGE 138

132 Flix Engine Linux Module Documentation 5.31.4.10 on2sc overlay_options_SetOverlayPosition (FLIX2HANDLE flix, FE2_OverlayPositionMode mode, uint32_t x, uint32_t y) Set the overlay position.
PAGE 139

5.31 Overlay (Watermark) 133 Remarks: Set bUseOverlay to on2true to enable overlay usage. Set bUseOverlay to on2false to disable usage. Only PNG images, 24 bit bitmaps, and 32 bit bitmaps are supported. Use of PNG images is highly recommended. Images with an uneven width or uneven height will be cropped. Overlay images larger than the video image will be cropped. When both the video and overlay images contain an alpha channel, the overlay and video alpha will be averaged.
PAGE 140

134 Flix Engine Linux Module Documentation 5.32 PNG Image Export (Thumbnail) 5.32.1 Detailed Description The PNG image export filter creates PNG images from the source video data of the input file passed to Flix2_SetInputFile().
PAGE 141

5.32 PNG Image Export (Thumbnail) 135 – If any of FE2_PNGEX_AUTO_EXPORT_COUNT, FE2_PNGEX_EXPORT_CUE_POINTS or FE2_PNGEX_EXPORT_TIME_STRING are enabled and a time is duplicated, the duplicate time will be discarded.
PAGE 142

136 Flix Engine Linux Module Documentation • #define FE2_PNGEX_AUTO_EXPORT_END_TIME Filter parameter for setting PNG auto generation end time. • #define FE2_PNGEX_AUTO_EXPORT_RANDOM_PERIOD Filter parameter for randomizing auto generated times. • #define FE2_PNGEX_EXPORT_FIRST_FRAME_PNG Filter parameter for enabling PNG image creation using the first video frame. • #define FE2_PNGEX_COMPRESSION_LEVEL Filter parameter for setting compression level used by libpng.
PAGE 143

5.32 PNG Image Export (Thumbnail) 137 Additional PNG time(s) is/are calculated using the following equation: n: 0 based PNG image index png_time = first_png_time + (time_slice_duration * n) sc = Flix2_AddFilter(&png_exporter_plgn, flix, FE2_FILTER_PNGEX); if (sc == ON2_OK) // auto export 10 PNG images sc = Flix2_FilterSetParam(png_exporter_plgn, FE2_PNGEX_AUTO_EXPORT_COUNT, 10); Definition at line 263 of file png_export.h. 5.32.2.
PAGE 144

138 Flix Engine Linux Module Documentation 5.32.2.5 #define FE2_PNGEX_AUTO_EXPORT_START_TIME Filter parameter for setting PNG auto generation start time. The value specified MUST be in milliseconds.
PAGE 145

5.32 PNG Image Export (Thumbnail) 5.32.2.8 139 #define FE2_PNGEX_EXPORT_CUE_POINTS Filter parameter for enabling export of PNG images at cue points. If enabled, PNG images will be exported at event, navigation, or all cue points. See video_options_AddFLVCuePoint(), for information with regard to adding cue points to your output FLV file. Use FE2_PNGEX_CP_EVENT, FE2_PNGEX_CP_NAV, or FE2_PNGEX_CP_ALL to specify the types of cue points for which the PNG exporter should export PNG images.
PAGE 146

140 Flix Engine Linux Module Documentation sc = Flix2_AddFilter(&png_exporter_plgn, flix, FE2_FILTER_PNGEX); if (sc == ON2_OK) // produce PNG images from the source video // at times of 5 seconds, 10 seconds, and 15 seconds sc = Flix2_FilterSetParamAsStr(png_exporter_plgn, FE2_PNGEX_EXPORT_TIME_STRING, "5000,10000,15000"); Definition at line 209 of file png_export.h. 5.32.2.12 #define FE2_PNGEX_FILENAME_PREFIX Filter parameter for setting PNG image file name prefix.
PAGE 147

5.32 PNG Image Export (Thumbnail) 5.32.2.15 141 #define FE2_PNGEX_OUTPUT_DIRECTORY Filter parameter for setting PNG image output directory. If a directory is not specified, the PNG exporter will write PNG images to the directory specified in the path passed to Flix2_SetOutputFile().
PAGE 148

142 Flix Engine Linux Module Documentation 5.33 Resample 5.33.1 Detailed Description Filter Parameters: Name | Type | Opt/Reqd | Range ============================================================================ FE2_RESAMPLE_RATE | Numeric | Optional | [8000,192000]Hz FE2_RESAMPLE_CHANNELS | Numeric | Optional | [1,2] Usage notes: • FLV/SWF files are limited to sample rates of Hertz11025, Hertz22050 and Hertz44100.
PAGE 149

5.34 Rotate 5.34 Rotate 5.34.1 Detailed Description The rotate filter rotates the source clockwise by the angle specified by FE2_ROTATE_ANGLE. Filter Parameters: Name | Type | Opt/Reqd | Range ============================================================================ FE2_ROTATE_ANGLE | Numeric | Optional | {0,90,180,270} Example Usage: sc = Flix2_AddFilter(&filter, flix, FE2_FILTER_ROTATE); // rotate source 90 degrees clockwise if(sc == ON2_OK) sc = Flix2_FilterSetParam(filter, FE2_ROTATE_ANGLE, 90.
PAGE 150

144 Flix Engine Linux Module Documentation 5.35 Scale 5.35.1 Detailed Description The video scale (resize) filter implements a high quality bicubic scaler to change the dimensions of the video.
PAGE 151

5.35 Scale 145 • on2sc video_options_SetImageHeight (FLIX2HANDLE flix, const int32_t lImageHeight) Set the scaled image height. • on2sc video_options_GetImageWidth (const FLIX2HANDLE flix, int32_t ∗lpImageWidth) Get the current scaled image width. • on2sc video_options_SetImageWidth (FLIX2HANDLE flix, const int32_t lImageWidth) Set the scaled image width.
PAGE 152

146 Flix Engine Linux Module Documentation Attention: This function can NOT be used to obtain information about the unscaled input video, use video_options_GetSourceHeight(). See also: Reserved values Definition at line 103 of file scale.h. 5.35.3.3 #define FE2_SCALE_WIDTH Filter parameter name for scaled width. Use FE2_SCALE_WIDTH with Flix2_FilterSetParam() and Flix2_FilterGetParam() to set and/or get the scaled width of the video.
PAGE 153

5.35 Scale 147 Deprecated Please use: • Flix2_AddFilter() • Flix2_FilterGetParam() • Flix2_FilterSetParam() With the constants: • FE2_FILTER_SCALE • FE2_SCALE_WIDTH • FE2_SCALE_HEIGHT for access to the flix engine video scaling filter. 5.35.4.2 on2sc video_options_GetImageWidth (const FLIX2HANDLE flix, int32_t ∗ lpImageWidth) Get the current scaled image width.
PAGE 154

148 Flix Engine Linux Module Documentation 5.35.4.3 on2sc video_options_GetUseSourceDimensions (const FLIX2HANDLE flix, on2bool ∗ bpUseSourceDimensions) Determine if the source’s dimensions will be used instead of the scaled dimensions. Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() → bpUseSourceDimensions Variable to update with the current dimension status Return values: ON2_OK The dimension status was successfully retrieved from the engine.
PAGE 155

5.35 Scale 5.35.4.5 149 on2sc video_options_SetImageWidth (FLIX2HANDLE flix, const int32_t lImageWidth) Set the scaled image width. Determines the scaled width of the output video. Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() ← lImageWidth Image width (in pixels) Return values: ON2_OK The image width value was successfully set in the engine. ON2_INVALID_PARAMS The value is out of range. ON2_NET_ERROR The underlying communication layer failed.
PAGE 156

150 Flix Engine Linux Module Documentation Deprecated The flix engine encodes video using the video source dimensions by default. If FE2_FILTER_SCALE has not been added to the filter chain, video will be encoded using source dimensions. Attention: Use of this function will cause FE2_FILTER_SCALE settings to be ignored. If FE2_FILTER_SCALE has been added to the filter chain via the Filter Interface this function is unnecessary.
PAGE 157

5.36 Sharpen 5.36 Sharpen 5.36.1 Detailed Description Sharpens the source image using a 3x3 kernel with the values: -1/8 -1/8 -1/8 -1/8 16/8 -1/8 -1/8 -1/8 -1/8 Example Usage: sc = Flix2_AddFilter(&filter, flix, FE2_FILTER_SHARPEN); if(sc == ON2_OK) ; //a sharpening filter will be applied to the source image Defines • #define FE2_FILTER_SHARPEN Filter name for use with Flix2_AddFilter(). 5.36.2 Define Documentation 5.36.2.1 #define FE2_FILTER_SHARPEN Filter name for use with Flix2_AddFilter().
PAGE 158

152 Flix Engine Linux Module Documentation 5.37 Flix Engine API 5.37.1 Detailed Description The Flix Engine for Linux consists of two main parts: the encoding server (flixd) and the client library (libflixengine2.so). The client library is what the user application interfaces with, using the Flix Engine API. Further details can be found in the system overview and install guides included in this release. See also: Support Options & FAQ Version: 8.0.17.
PAGE 159

5.38 Main Engine Interface 5.38 Main Engine Interface Enumerations • enum FE2_ExportedVideoType { ExportSWF3To6Video, ExportSWF7PlusVideo, ExportSWFVectorVideo, ExportFLVVideo } Output file types for use in calls to Flix2_SetExportVideoType() and Flix2_GetExportVideoType(). • enum FE2_EncState { EncStateIdle, EncStateRunning, EncStateQueued } Encoder state returned by Flix2_GetEncoderState().
PAGE 160

154 Flix Engine Linux Module Documentation • on2sc Flix2_SetOutputFile (FLIX2HANDLE flix, const on2tc ∗outputFile) Set the destination file for the encode session. • on2sc Flix2_GetOutputFile (const FLIX2HANDLE flix, on2tc ∗pOutputFile, int32_t ∗len) Get the destination file for the encode session. • on2sc Flix2_SetOverwriteExistingFiles (FLIX2HANDLE flix, const on2bool bOverwriteExistingFiles) Enable/disable overwriting of existing output files.
PAGE 161

5.38 Main Engine Interface • on2sc Flix2_Reset (FLIX2HANDLE flix) Reset the engine to its defaults. • on2sc Flix2_Validate (const FLIX2HANDLE flix) Validate the current encoder settings. • on2sc Flix2_IsEncoderRunning (const FLIX2HANDLE flix, on2bool ∗bpIsEncoderRunning) Check the status of an encode. • on2sc Flix2_GetEncoderState (const FLIX2HANDLE flix, FE2_EncState ∗pEncState) Retrieve the current state of the encoder.
PAGE 162

156 Flix Engine Linux Module Documentation 5.38.1.3 enum FE2_ExportedVideoType Output file types for use in calls to Flix2_SetExportVideoType() and Flix2_GetExportVideoType(). Deprecated Use the Muxer Interface. This enumeration will be removed in a future release. See also: Muxers. Enumerator: ExportSWF3To6Video ExportSWF7PlusVideo ExportSWFVectorVideo ExportFLVVideo Definition at line 93 of file flixengine2.h. 5.38.2 Function Documentation 5.38.2.
PAGE 163

5.38 Main Engine Interface 157 Remarks: Linux Only: Attempts first to connect portmap on localhost. Upon successful query of flixd’s port, initiates a connection to the rpc server, flixd, which registers the encoding session. Failing either of these ON2_NET_ERROR is returned. on2sc Flix2_CreateEx (FLIX2HANDLE ∗ pFlix, const char ∗ rpchost, int32_t timeout) 5.38.2.3 Create a handle to the flix engine. Initializes a FLIX2HANDLE for use in subsequent FLIXENGINE_API calls.
PAGE 164

158 Flix Engine Linux Module Documentation 5.38.2.4 on2sc Flix2_Destroy (FLIX2HANDLE flix) Frees resources associated with a FLIX2HANDLE. Parameters: ← flix FLIXHANDLE to be destroyed Return values: ON2_OK the engine successfully destroyed the handle ON2_INVALID_PARAMS should the precondition fail ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL Remarks: If an encoding session started with Flix2_Encode() is still running when this function is called.
PAGE 165

5.38 Main Engine Interface 5.38.2.6 159 on2sc Flix2_Errno (const FLIX2HANDLE flix, FE2_errno ∗ flixerrno, int32_t ∗ syserrno) Retrieve the current error state of the engine. If an API call has returned an error, this function can be used to retrieve a more specific reason.
PAGE 166

160 Flix Engine Linux Module Documentation 5.38.2.8 on2sc Flix2_GetExportAudio (const FLIX2HANDLE flix, on2bool ∗ bpExportAudio) Retrieve the engine’s current behavior regarding audio output.
PAGE 167

5.38 Main Engine Interface 5.38.2.10 161 on2sc Flix2_GetExportVideoType (const FLIX2HANDLE flix, FE2_ExportedVideoType ∗ pExportVideoType) Retrieve the current output file type.
PAGE 168

162 Flix Engine Linux Module Documentation 5.38.2.12 on2sc Flix2_GetOutputFile (const FLIX2HANDLE flix, on2tc ∗ pOutputFile, int32_t ∗ len) Get the destination file for the encode session. Returns the (possibly modified see Flix2_SetOutputFile()) output file name. If pOutputFile is NULL this function will return the size in bytes required to store the current output file in len, not including the null terminator.
PAGE 169

5.38 Main Engine Interface 5.38.2.14 163 on2sc Flix2_GetSourceDuration (const FLIX2HANDLE flix, int32_t ∗ duration) Get the duration, in milliseconds, of the source file.
PAGE 170

164 Flix Engine Linux Module Documentation Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() Return values: ON2_OK on success ON2_INVALID_PARAMS should the precondition fail ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL 5.38.2.17 on2sc Flix2_SetExportAudio (FLIX2HANDLE flix, const on2bool bExportAudio) Enable/disable audio output in the current encoding session.
PAGE 171

5.38 Main Engine Interface 165 Precondition: flix is not NULL Note: Default: on2true 5.38.2.19 on2sc Flix2_SetExportVideoType (FLIX2HANDLE flix, const FE2_ExportedVideoType exportVideoType) Set the output file type.
PAGE 172

166 Flix Engine Linux Module Documentation Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() ← inputFile Path to the source file. Return values: ON2_OK the engine successfully opened the input file for decoding ON2_INVALID_PARAMS a parameter is invalid. ON2_NET_ERROR the underlying communication layer failed
PAGE 173

5.38 Main Engine Interface 5.38.2.22 on2sc Flix2_SetOverwriteExistingFiles (FLIX2HANDLE flix, const on2bool bOverwriteExistingFiles) Enable/disable overwriting of existing output files.
PAGE 174

168 Flix Engine Linux Module Documentation • input file has been set • at least one of Flix2_GetExportVideo() and Flix2_GetExportAudio() is set to on2true • the export video type is ExportFLVVideo or ExportSWF7PlusVideo • if Flix2_GetExportVideo() is on2true, calls video_options_Validate() • if Flix2_GetExportAudio() is on2true, calls audio_options_Validate() Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() Return values: ON2_OK on success ON2_ERROR on failure
PAGE 175

5.39 Flix Engine Core Library 5.39 Flix Engine Core Library 5.39.1 Detailed Description 169 This library, libflixengine2_core.so, encompasses the Flix Engine API and adds the Frame Server API. The Flix Engine Core Library consists of a single library, libflixengine2_core.so, that exports the entire Flix Engine API. In addition to this it adds the Frame Server API which allows the user to feed the engine raw audio/video frames as opposed to entire files. This is only available through C/C++.
PAGE 176

170 Flix Engine Linux Module Documentation 5.39.2.2 on2sc Flix2_GetLogLevel (const FLIX2HANDLE flix, int32_t ∗ level) Retrieve current library-wide debug log level. Parameters: ← flix Handle to the flix engine returned from Flix2_Create() → level Storage location to receive the result Return values: ON2_OK on success ON2_INVALID_PARAMS should one or more of the preconditions fail Precondition: flix is not NULL level is not NULL 5.39.2.
PAGE 177

5.39 Flix Engine Core Library 5.39.2.5 171 on2sc Flix2_SetLogLevel (FLIX2HANDLE flix, int32_t level) Set the library-wide debug log level.
PAGE 178

172 Flix Engine Linux Module Documentation Remarks: logpath can be the name of a device, e.g.
PAGE 179

5.40 Filter Manipulation 5.40 173 Filter Manipulation Modules • Deprecated Functions • on2sc Flix2_AddFilter (FLIX2PLGNHANDLE ∗pPlgn, const FLIX2HANDLE flix, const char ∗plgn_name) Add a filter to the encoder’s filter chain. • on2sc Flix2_RemoveFilter (FLIX2PLGNHANDLE plgn) Remove a filter to the encoder’s filter chain. • on2sc Flix2_FilterSetParamAsStr (FLIX2PLGNHANDLE plgn, const char ∗name, const on2tc ∗value) Set the value of a parameter in a filter instance using a string representation.
PAGE 180

174 Flix Engine Linux Module Documentation ON2_NET_ERROR the underlying communication layer failed Precondition: pPlgn is not NULL flix is not NULL plgn_name is not NULL See also: Filters 5.40.1.2 on2sc Flix2_FilterGetParam (FLIX2PLGNHANDLE plgn, const char ∗ name, double ∗ outDblVal) Retrieve the value of a parameter in a filter instance represented as a double.
PAGE 181

5.40 Filter Manipulation 175 Return values: ON2_OK on success ON2_INVALID_PARAMS should one or more of the preconditions fail ON2_NOT_SUPP the filter does not support this parameter ON2_NET_ERROR the underlying communication layer failed Precondition: plgn is not NULL value is not NULL len is not NULL Attention: This function is currently unsupported and will return ON2_NOT_SUPP. See also: Filters 5.40.1.
PAGE 182

176 Flix Engine Linux Module Documentation Parameters: ← plgn Handle to the filter returned from Flix2_AddFilter() ← name Name of the parameter to set ← value New value for the parameter Return values: ON2_OK on success ON2_INVALID_PARAMS should the precondition fail ON2_NOT_SUPP the filter does not support this parameter ON2_NET_ERROR the underlying communication layer failed Precondition: plgn is not NULL See also: Filters 5.40.1.
PAGE 183

5.41 Codec Manipulation 5.41 177 Codec Manipulation Functions • on2sc Flix2_AddCodec (FLIX2PLGNHANDLE ∗pPlgn, const FLIX2HANDLE flix, const char ∗plgn_name) Add a codec to the encoder’s codec chain. • on2sc Flix2_RemoveCodec (FLIX2PLGNHANDLE plgn) Remove a codec from the encoder’s codec chain. • on2sc Flix2_CodecSetParamAsStr (FLIX2PLGNHANDLE plgn, const char ∗name, const on2tc ∗value) Set the value of a parameter in a codec instance using a string representation.
PAGE 184

178 Flix Engine Linux Module Documentation Precondition: pPlgn is not NULL flix is not NULL plgn_name is not NULL See also: Codecs 5.41.1.2 on2sc Flix2_CodecGetParam (FLIX2PLGNHANDLE plgn, const char ∗ name, double ∗ outDblVal) Retrieve the value of a parameter in a codec instance represented as a double.
PAGE 185

5.41 Codec Manipulation 179 ON2_INVALID_PARAMS should one or more of the preconditions fail ON2_NOT_SUPP the codec does not support this parameter ON2_NET_ERROR the underlying communication layer failed Precondition: plgn is not NULL value is not NULL len is not NULL Attention: This function is currently unsupported and will return ON2_NOT_SUPP. See also: Codecs 5.41.1.
PAGE 186

180 Flix Engine Linux Module Documentation ← name Name of the parameter to set ← value New value for the parameter Return values: ON2_OK on success ON2_INVALID_PARAMS should the precondition fail ON2_NOT_SUPP the codec does not support this parameter ON2_NET_ERROR the underlying communication layer failed Precondition: plgn is not NULL See also: Codecs 5.41.1.6 on2sc Flix2_RemoveCodec (FLIX2PLGNHANDLE plgn) Remove a codec from the encoder’s codec chain.
PAGE 187

5.42 Muxer Manipulation 5.42 181 Muxer Manipulation Functions • on2sc Flix2_AddMuxer (FLIX2PLGNHANDLE ∗pPlgn, const FLIX2HANDLE flix, const char ∗plgn_name) Set the desired muxer. • on2sc Flix2_RemoveMuxer (FLIX2PLGNHANDLE plgn) Remove the specified muxer. • on2sc Flix2_MuxerSetParamAsStr (FLIX2PLGNHANDLE plgn, const char ∗name, const on2tc ∗value) Set the value of a parameter in a muxer instance using a string representation.
PAGE 188

182 Flix Engine Linux Module Documentation Precondition: pPlgn is not NULL flix is not NULL plgn_name is not NULL See also: Muxers 5.42.1.2 on2sc Flix2_MuxerGetParam (FLIX2PLGNHANDLE plgn, const char ∗ name, double ∗ outDblVal) Retrieve the value of a parameter in a muxer instance represented as a double.
PAGE 189

5.42 Muxer Manipulation 183 ON2_INVALID_PARAMS should one or more of the preconditions fail ON2_NOT_SUPP the muxer does not support this parameter ON2_NET_ERROR the underlying communication layer failed Precondition: plgn is not NULL value is not NULL len is not NULL Attention: This function is currently unsupported and will return ON2_NOT_SUPP. See also: muxer 5.42.1.
PAGE 190

184 Flix Engine Linux Module Documentation ← name Name of the parameter to set ← value New value for the parameter Return values: ON2_OK on success ON2_INVALID_PARAMS should the precondition fail ON2_NOT_SUPP the muxer does not support this parameter ON2_NET_ERROR the underlying communication layer failed Precondition: plgn is not NULL See also: Muxers 5.42.1.6 on2sc Flix2_RemoveMuxer (FLIX2PLGNHANDLE plgn) Remove the specified muxer.
PAGE 191

5.43 Frame Server API 5.43 Frame Server API 5.43.1 Detailed Description 185 Flix Engine Frame Server API. The Frame Server API allows an application to provide the engine with raw audio and video frames rather than entire files. This service is only available via the core Flix Engine library (libflixengine2_core.so). It is not available through the daemon (flixd) / rpc client library (libflixengine2.so) pair or the language extensions that are built to interface with libflixengine2.so. 5.43.
PAGE 192

186 Flix Engine Linux Module Documentation Enumerations • enum FE2_FrameType { FrameTypeAudio, FrameTypeVideo } Frame type being passed to Flix2_EncodeFrame(). • enum FE2_VideoFormat { VideoFormatYV12, VideoFormatBGRA } Format of input video used in calls to Flix2_SetVideoProperties(). Functions • on2sc Flix2_SetFrameServer (FLIX2HANDLE flix, on2bool enable) Enable/disable the frame server for this session.
PAGE 193

5.43 Frame Server API 5.43.3.2 187 enum FE2_VideoFormat Format of input video used in calls to Flix2_SetVideoProperties(). Attention: Available only in the Flix Engine Core Library Enumerator: VideoFormatYV12 VideoFormatBGRA Definition at line 95 of file fs_options.h. 5.43.4 Function Documentation 5.43.4.1 on2sc Flix2_EncodeFrame (FLIX2HANDLE flix, FE2_FrameType type, on2bool eos, uint8_t ∗ frame, uint32_t len, int64_t ts90k) Queue an input frame for encoding.
PAGE 194

188 Flix Engine Linux Module Documentation See also: Example Usage 5.43.4.2 on2sc Flix2_GetFrameServer (FLIX2HANDLE flix, on2bool ∗ enabled) Retrieve the current frame server status.
PAGE 195

5.43 Frame Server API 189 Precondition: flix is not NULL channels is >0 and <= 2 bitspersample is 8 or 16 samplerate is 11025, 22050 or 44100 Attention: Available only in the Flix Engine Core Library Remarks: Taken together with Flix2_SetVideoProperties(), can be viewed as the analogue of Flix2_SetInputFile() Note: MUST be called before Flix2_EncodeFrame() if audio output is desired Calling this function after calling Flix2_EncodeFrame(FrameTypeAudio) is NOT supported 5.43.4.
PAGE 196

190 Flix Engine Linux Module Documentation Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() ← format Raw video format ← width Video width ← height Video height ← pitch Video pitch (stride) in bytes.
PAGE 197

5.44 Deprecated 5.44 191 Deprecated Functions • on2sc editor_options_Reset (FLIX2HANDLE flix) Reset the media editor options to their defaults. • on2sc editor_options_Validate (const FLIX2HANDLE flix) Ensure the current media editor settings are valid. 5.44.1 Function Documentation 5.44.1.1 on2sc editor_options_Reset (FLIX2HANDLE flix) Reset the media editor options to their defaults.
PAGE 198

192 Flix Engine Linux Module Documentation 5.45 Muxers 5.45.1 Detailed Description Muxers are configurable both by the muxer interface and individual functions (e.g. (swf|video)_options_SetXXX). The latter, however, are deprecated and will be removed in a future release. Therefore, any new code should use the muxer interface.
PAGE 199

5.46 FLV 193 5.46 FLV 5.46.1 Detailed Description Muxer Parameters: Name | Type | Opt/Reqd | Range ============================================================================ FE2_FLV_CUEPT_EVENT | String | Optional | [0.0,) FE2_FLV_CUEPT_NAV | String | Optional | [0.
PAGE 200

194 Flix Engine Linux Module Documentation • #define FE2_FLV_CUEPT_EVENT Set an event cue point. • #define FE2_FLV_CUEPT_NAV Set a navigation cue point. • #define FE2_FLV_CUEPT_PARAM Add a name/value pair to an existing cue point. • #define FE2_FLV_METADATA_ENABLE Enable output of meta data element. • #define FE2_FLV_METADATA_DISABLE Disable output of meta data element. Typedefs • typedef enum flv_metadata flvmetadata_t Supported FLV onMetaData elements.
PAGE 201

5.46 FLV 195 5.46.4 Define Documentation 5.46.4.1 #define FE2_FLV_CUEPT_EVENT Set an event cue point. Parameter format: Format = cueptNAME ’=’ cueptTIME_SECONDS e.g., "evtpt0=343.0". Precondition: time must be >= 0.0 Note: Multiple cue points may be added. See also: http://livedocs.macromedia.com/flash/8/main/wwhelp/wwhimpl/common/html/wwhelp.htm? Parts&file=00001574.html Definition at line 133 of file flv.h. 5.46.4.2 #define FE2_FLV_CUEPT_NAV Set a navigation cue point.
PAGE 202

196 Flix Engine Linux Module Documentation 5.46.4.3 #define FE2_FLV_CUEPT_PARAM Add a name/value pair to an existing cue point. Parameter format: Format = cueptNAME ∗[ ’&’ Pair ] Pair = Name ’=’ Value e.g., "cuept0&name0=value0&name1=value1" Precondition: The cue point has already been added Definition at line 154 of file flv.h. 5.46.4.4 #define FE2_FLV_METADATA_DISABLE Disable output of meta data element. Note: Valid elements are defined by flvmetadata_t Definition at line 164 of file flv.h. 5.46.4.
PAGE 203

5.46 FLV 197 5.46.6 Enumeration Type Documentation 5.46.6.1 enum flv_metadata Supported FLV onMetaData elements. Descriptions indicate the default in bold, followed by the element name in italics, its type and a description of the units if applicable. Note: Audio/Video specific entries are disabled should there be no stream of the type Enumerator: MD_DURATION Enabled. duration seconds MD_DATASIZE Enabled. datasize bytes MD_AUDIO_SIZE Enabled.
PAGE 204

198 Flix Engine Linux Module Documentation 5.47 FXM 5.47.1 Detailed Description The FXM muxer produces output compatible with the Sun Java VM. Muxer Parameters: Name | Type | Opt/Reqd | Range ============================================================================ FE2_FXM_CUEPT_EVENT | String | Optional | [0.0,) FE2_FXM_CUEPT_NAV | String | Optional | [0.
PAGE 205

5.47 FXM 199 Add a name/value pair to an existing cue point. • #define FE2_FXM_METADATA_ENABLE Enable output of meta data element. • #define FE2_FXM_METADATA_DISABLE Disable output of meta data element. Typedefs • typedef enum flv_metadata fxmmetadata_t 5.47.4 Define Documentation 5.47.4.1 #define FE2_FXM_CUEPT_EVENT Set an event cue point. Parameter format: Format = cueptNAME ’=’ cueptTIME_SECONDS e.g., "evtpt0=343.0". Precondition: time must be >= 0.0 Note: Multiple cue points may be added.
PAGE 206

200 Flix Engine Linux Module Documentation 5.47.4.3 #define FE2_FXM_CUEPT_PARAM Add a name/value pair to an existing cue point. Parameter format: Format = cueptNAME ∗[ ’&’ Pair ] Pair = Name ’=’ Value e.g., "cuept0&name0=value0&name1=value1" Precondition: The cue point has already been added Definition at line 90 of file fxm.h. 5.47.4.4 #define FE2_FXM_METADATA_DISABLE Disable output of meta data element. Note: Valid elements are defined by fxmmetadata_t Definition at line 100 of file fxm.h. 5.47.4.
PAGE 207

5.48 3GPP - FFmpeg 5.48 3GPP - FFmpeg 5.48.1 Detailed Description Example Usage: sc = Flix2_AddMuxer(&muxer, flix, FE2_MUXER_3GP); if(sc == ON2_OK) ; //Now using the 3GPP muxer for output 5.48.2 Supported Codecs • Video: – FE2_CODEC_H263_BASELINE – FE2_CODEC_H264 • Audio: – FE2_CODEC_AAC – FE2_CODEC_AACPLUS – FE2_CODEC_AMR_NB Additional References: • 3GPP homepage Defines • #define FE2_MUXER_3GP 3GPP muxer. For use with Flix2_AddMuxer() • #define FE2_3GP_FASTSTART FE2_ISOMEDIA_FASTSTART alias 5.
PAGE 208

202 Flix Engine Linux Module Documentation Attention: The current implementation is a post-process. A temporary file is created within the output directory as the necessary boxes are rewritten, with the result then replacing the original output file. Definition at line 67 of file isomedia.h. 5.48.3.2 #define FE2_MUXER_3GP 3GPP muxer. For use with Flix2_AddMuxer() Definition at line 62 of file isomedia.h.
PAGE 209

5.49 3GPP2 - FFmpeg 5.49 3GPP2 - FFmpeg 5.49.1 Detailed Description Example Usage: sc = Flix2_AddMuxer(&muxer, flix, FE2_MUXER_3G2); if(sc == ON2_OK) ; //Now using the 3GPP2 muxer for output 5.49.2 Supported Codecs • Video: – FE2_CODEC_H263_BASELINE – FE2_CODEC_H264 • Audio: – FE2_CODEC_AAC – FE2_CODEC_AACPLUS – FE2_CODEC_AMR_NB Additional References: • 3GPP2 homepage Defines • #define FE2_MUXER_3G2 3GPP2 muxer.
PAGE 210

204 Flix Engine Linux Module Documentation Attention: The current implementation is a post-process. A temporary file is created within the output directory as the necessary boxes are rewritten, with the result then replacing the original output file. Definition at line 102 of file isomedia.h. 5.49.3.2 #define FE2_MUXER_3G2 3GPP2 muxer. For use with Flix2_AddMuxer() Definition at line 97 of file isomedia.h.
PAGE 211

5.50 MOV - FFmpeg 5.50 MOV - FFmpeg 5.50.1 Detailed Description 205 Example Usage: sc = Flix2_AddMuxer(&muxer, flix, FE2_MUXER_MOV); if(sc == ON2_OK) ; //Now using the MOV muxer for output 5.50.
PAGE 212

206 Flix Engine Linux Module Documentation 5.50.3 Define Documentation 5.50.3.1 #define FE2_MOV_FASTSTART FE2_ISOMEDIA_FASTSTART alias Influence ’moov’ box placement. When enabled places the ’moov’ box near the beginning of the file allowing for progressive download. Note: Default: 0 (disabled) Attention: The current implementation is a post-process. A temporary file is created within the output directory as the necessary boxes are rewritten, with the result then replacing the original output file.
PAGE 213

5.51 MP4 - FFmpeg 5.51 MP4 - FFmpeg 5.51.1 Detailed Description 207 Example Usage: sc = Flix2_AddMuxer(&muxer, flix, FE2_MUXER_MP4); if(sc == ON2_OK) ; //Now using the MP4 muxer for output 5.51.2 Supported Codecs • Video: – FE2_CODEC_H264 • Audio: – FE2_CODEC_AAC – FE2_CODEC_AACPLUS Additional References: • ISO - International Organization for Standardization • ISO/IEC 14496-12:ISO base media file format Attention: The current implementation does not write a ’ctts’ table (cf.
PAGE 214

208 Flix Engine Linux Module Documentation Note: Default: 0 (disabled) Attention: The current implementation is a post-process. A temporary file is created within the output directory as the necessary boxes are rewritten, with the result then replacing the original output file. Definition at line 188 of file isomedia.h. 5.51.3.2 #define FE2_MUXER_MP4 MP4 muxer. For use with Flix2_AddMuxer(). Definition at line 183 of file isomedia.h.
PAGE 215

5.52 SWF 209 5.52 SWF 5.52.1 Detailed Description Muxer Parameters: Name | Type | Opt/Reqd | Range ================================================================================== FE2_SWF_ADAPTIVE_PRELOAD_BUFFER_FACTOR | Number | Optional | [0.0,2.0] step:0.
PAGE 216

210 Flix Engine Linux Module Documentation • on2sc swf_options_GetEmbeddedUrlTarget (FLIX2HANDLE flix, char ∗embeddedUrlTarget, int32_t ∗len) Gets the target of embedded URL. • on2sc swf_options_SetEmbeddedUrl (FLIX2HANDLE flix, const char ∗embeddedUrl) Sets the embedded URL of the SWF or HTML that will be loaded when the user clicks on the video. • on2sc swf_options_SetEmbeddedUrlTarget ∗embeddedUrlTarget) (FLIX2HANDLE flix, const char Sets the target of the embedded URL.
PAGE 217

5.52 SWF 211 Sets the percent of the SWF movie to preload before playback begins. • on2sc swf_options_GetPreloaderType ∗pPreloaderType) (FLIX2HANDLE flix, FE2_SwfPreloaderOptions Gets the type of preloader. • on2sc swf_options_SetPreloaderType (FLIX2HANDLE flix, const FE2_SwfPreloaderOptions preloaderType) Sets the type of preloader. • on2sc swf_options_GetAdaptivePreloaderBufferFactor ∗pPreloaderBufferFactor) (FLIX2HANDLE flix, double Gets the adaptive preload buffer factor.
PAGE 218

212 Flix Engine Linux Module Documentation • on2sc swf_options_SetWaitTimeToStart (FLIX2HANDLE flix, const int32_t waitTimeToStart) Sets the number of seconds to wait before playback begins. • on2sc swf_options_AddVariable (FLIX2HANDLE flix, const char ∗name, const char ∗value) Adds a custom SWF variable as a name/value pair. • on2sc swf_options_DeleteVariable (FLIX2HANDLE flix, const int32_t index) Deletes a custom SWF variable.
PAGE 219

5.52 SWF Sets the adaptive preload buffer factor. • #define FE2_SWF_ON_END_OPTION Sets the options for the end of the SWF. • #define FE2_SWF_ON_END_URL Sets the URL a SWF movie will load after the current movie ends. • #define FE2_SWF_ON_START_OPTION Sets the options for the start of the SWF. • #define FE2_SWF_START_BLANK_FRAME Control the insertion of a blank first frame in the SWF. • #define FE2_SWF_START_WAIT_SEC Sets the number of seconds to wait before playback begins.
PAGE 220

214 Flix Engine Linux Module Documentation • enum FE2_SwfPreloaderOptions { SwfPreloaderNone, SwfFixedPreloader, SwfAdaptivePreloader } Determines the type of preloader added to the SWF file. 5.52.3 Define Documentation 5.52.3.1 #define FE2_MUXER_SWF SWF muxer. For use with Flix2_AddMuxer(). Definition at line 105 of file swf.h. 5.52.3.2 #define FE2_SWF_ADAPTIVE_PRELOAD_BUFFER_FACTOR Sets the adaptive preload buffer factor.
PAGE 221

5.52 SWF 215 Parameter format: Format = Variable ∗[ ’&’ Variable ] Variable = varName ’=’ varValue e.g. "n0=v0&n1=v1" Definition at line 262 of file swf.h. 5.52.3.4 #define FE2_SWF_DELETE_VARIABLE Delete an existing variable in the SWF. Multiple variables may be specified. Parameter format: Format = varName ∗[ ’&’ varName ] e.g. "var0&var1" Definition at line 270 of file swf.h. 5.52.3.5 #define FE2_SWF_EMBEDDED_URL Set the SWF’s target URL.
PAGE 222

216 Flix Engine Linux Module Documentation 5.52.3.7 #define FE2_SWF_EMBEDDED_URL_TYPE Set how FE2_SWF_EMBEDDED_URL is interpreted. Valid values are defined by FE2_EmbeddedUrlType Note: Default: EmbeddedUrlIsLoadMovie Definition at line 158 of file swf.h. 5.52.3.8 #define FE2_SWF_FIXED_PRELOAD_PCT Sets the percent of the SWF movie to preload before playback begins.
PAGE 223

5.52 SWF 5.52.3.11 217 #define FE2_SWF_LOOP_COUNT Sets the number of times the SWF should loop. Note: Default: 0 Setting this to a value >0 will see the SWF ignore the loop command of the Flash player. This will implicitly set FE2_SWF_ON_END_OPTION to SwfOnMovieEndLoop Definition at line 168 of file swf.h. 5.52.3.12 #define FE2_SWF_ON_END_OPTION Sets the options for the end of the SWF. Valid values are defined by FE2_SwfOnEndOptions Note: Default: SwfOnMovieEndNothing Definition at line 228 of file swf.
PAGE 224

218 Flix Engine Linux Module Documentation 5.52.3.16 #define FE2_SWF_START_BLANK_FRAME Control the insertion of a blank first frame in the SWF. Note: Default: 0 Definition at line 247 of file swf.h. 5.52.3.17 #define FE2_SWF_START_WAIT_SEC Sets the number of seconds to wait before playback begins. Note: Default: 0 Definition at line 252 of file swf.h. 5.52.3.18 #define FE2_SWF_WIDTH Set the SWF width. Note: Default: video width Definition at line 115 of file swf.h. 5.52.
PAGE 225

5.52 SWF 219 SwfOnMovieEndSTOP SwfOnMovieEndLoop SwfOnMovieEndUnload SwfOnMovieEndLoadMovie Definition at line 76 of file swf.h. 5.52.4.3 enum FE2_SwfOnStartOptions Actions that can be added to the start frame of the SWF file. For use with FE2_SWF_ON_START_OPTION Enumerator: SwfOnMovieStartAutomatically SwfOnMovieStartOnClick SwfOnMovieStartWait SwfOnMovieStartEmbedSTOP Definition at line 87 of file swf.h. 5.52.4.4 enum FE2_SwfPreloaderOptions Determines the type of preloader added to the SWF file.
PAGE 226

220 Flix Engine Linux Module Documentation ON2_INVALID_PARAMS should one or more of the preconditions fail ON2_NO_MEM an error occurred allocating memory for name or value ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL name is not NULL value is not NULL See also: swf_options_DeleteVariable(), swf_options_GetVariableCount(), swf_options_UpdateVariable() Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_ADD_VARIABLE parameter.
PAGE 227

5.52 SWF 5.52.5.3 221 on2sc swf_options_GetAdaptivePreloaderBufferFactor (FLIX2HANDLE flix, double ∗ pPreloaderBufferFactor) Gets the adaptive preload buffer factor. Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() → pPreloaderBufferFactor The adaptive preloader buffer factor.
PAGE 228

222 Flix Engine Linux Module Documentation Note: If embeddedUrl is NULL this function will return the size in bytes required to store the current embedded URL in len, not including the null terminator. See also: swf_options_SetEmbeddedUrl(), SetEmbeddedUrlType() swf_options_GetEmbeddedUrlType(), swf_options_- Attention: Currently only supported in C/C++ Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL parameter. This function will be removed in a future release.
PAGE 229

5.52 SWF 223 Attention: Currently only supported in C/C++ Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL_TARGET parameter. This function will be removed in a future release. 5.52.5.6 on2sc swf_options_GetEmbeddedUrlType (FLIX2HANDLE flix, FE2_EmbeddedUrlType ∗ embeddedUrlType) Gets the type of embedded URL. Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() → embeddedUrlType The type of embedded URL.
PAGE 230

224 Flix Engine Linux Module Documentation ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL pEnablePreloader is not NULL See also: swf_options_SetEnablePreloader() 5.52.5.8 on2sc swf_options_GetInsertBlankFrameOnStart (FLIX2HANDLE flix, on2bool ∗ pInsertBlankFrameOnStart) Gets if the engine is to insert a blank frame as the first frame of the SWF or not.
PAGE 231

5.52 SWF 225 ON2_NO_MEM pLoadMovieOnEndUrl does not have enough allocated space to return the URL. The size in bytes needed (minus null terminator) will be returned in len. ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL len is not NULL Note: If pLoadMovieOnEndUrl is NULL this function will return the size in bytes required to store the current URL in len, not including the null terminator.
PAGE 232

226 Flix Engine Linux Module Documentation 5.52.5.11 on2sc swf_options_GetMovieOnEndOptions (FLIX2HANDLE flix, FE2_SwfOnEndOptions ∗ pOnEndOptions) Gets the options for the end of the SWF. Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() → pOnEndOptions The options for the end of the SWF.
PAGE 233

5.52 SWF 227 Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_ON_START_OPTION parameter. This function will be removed in a future release. 5.52.5.13 on2sc swf_options_GetPercentToPreload (FLIX2HANDLE flix, int32_t ∗ pPercentToPreload) Gets the percent of the SWF movie to preload before playback begins. Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() → pPercentToPreload Percent of the SWF movie to preload before playback begins.
PAGE 234

228 Flix Engine Linux Module Documentation Precondition: flix is not NULL pPreloaderType is not NULL See also: swf_options_SetPreloaderType() Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_PRELOAD_TYPE parameter. This function will be removed in a future release. 5.52.5.15 on2sc swf_options_GetSwfFramerate (FLIX2HANDLE flix, int32_t ∗ pSwfFramerate) Gets the SWF framerate.
PAGE 235

5.52 SWF 229 Return values: ON2_OK The engine successfully returned SWF framerate. ON2_INVALID_PARAMS should one or more of the preconditions fail ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL pSwfFramerate is not NULL See also: swf_options_SetSwfFramerateAsDouble() Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_FRAMERATE parameter. This function will be removed in a future release. 5.52.5.
PAGE 236

230 Flix Engine Linux Module Documentation Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() → pWaitTimeToStart Number of seconds to wait.
PAGE 237

5.52 SWF 5.52.5.20 231 on2sc swf_options_SetAdaptivePreloaderBufferFactor (FLIX2HANDLE flix, const double preloaderBufferFactor) Sets the adaptive preload buffer factor. Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() ← preloaderBufferFactor The adaptive preloader buffer factor.
PAGE 238

232 Flix Engine Linux Module Documentation 5.52.5.21 on2sc swf_options_SetEmbeddedUrl (FLIX2HANDLE flix, const char ∗ embeddedUrl) Sets the embedded URL of the SWF or HTML that will be loaded when the user clicks on the video. Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() ← embeddedUrl The embedded URL.
PAGE 239

5.52 SWF 233 Precondition: flix is not NULL If embeddedUrlTarget is not NULL then it must be one of the valid values. Note: The embeddedUrlTarget will be ignored if the embedded URL is not set. Valid values for embeddedUrlTarget are: • "_self" • "_blank" • "_parent" • "_top" • see http://www.w3.org/TR/REC-WebCGM/REC-03-CGM-IC.html#webcgm_3_1_2_2 for more information. The default value is "_self". If embeddedUrlTarget is NULL then the engine will delete the target of the embedded URL.
PAGE 240

234 Flix Engine Linux Module Documentation Remarks: The default value is EmbeddedUrlIsLoadMovie. See also: swf_options_SetEmbeddedUrl(), swf_options_GetEmbeddedUrlType() Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_EMBEDDED_URL_TYPE parameter. This function will be removed in a future release. 5.52.5.24 on2sc swf_options_SetEnablePreloader (FLIX2HANDLE flix, const on2bool enablePreloader) Enables or disables the video preloader.
PAGE 241

5.52 SWF 235 ON2_INVALID_PARAMS should one or more of the preconditions fail ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL Note: on2true will insert a blank frame. on2false will not. See also: swf_options_GetInsertBlankFrameOnStart() Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_START_BLANK_FRAME parameter. This function will be removed in a future release. 5.52.5.
PAGE 242

236 Flix Engine Linux Module Documentation 5.52.5.27 on2sc swf_options_SetLoopCount (FLIX2HANDLE flix, const int32_t loopCount) Sets the number of times the SWF should loop. Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() ← loopCount The number of times the SWF should loop.
PAGE 243

5.52 SWF 237 Note: The default value is SwfOnMovieEndNothing. See also: swf_options_GetMovieOnEndOptions() Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_ON_END_OPTION parameter. This function will be removed in a future release. 5.52.5.29 on2sc swf_options_SetMovieOnStartOptions (FLIX2HANDLE flix, const FE2_SwfOnStartOptions onStartOptions) Sets the options for the start of the SWF.
PAGE 244

238 Flix Engine Linux Module Documentation ← percentToPreload Percent of the SWF movie to preload before playback begins. Return values: ON2_OK Success ON2_INVALID_PARAMS should one or more of the preconditions fail ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL Note: The preloader has to be enabled. The default value is 20%. The range is 1-100. The preloader type must be SwfFixedPreloader. Works with any Flash player version 4 and higher.
PAGE 245

5.52 SWF 239 See also: swf_options_GetPreloaderType() Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_PRELOAD_TYPE parameter. This function will be removed in a future release. 5.52.5.32 on2sc swf_options_SetSwfFramerate (FLIX2HANDLE flix, const int32_t swfFramerate) Sets the SWF framerate. Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() ← swfFramerate The SWF framerate.
PAGE 246

240 Flix Engine Linux Module Documentation Precondition: flix is not NULL Note: The default value will be the video framerate. The SWF framerate may be changed when the encoding process starts because of two conditions. Changing the SWF framerate will NOT change the duration or the audio/video synchronization. The first condition is the SWF framerate should always be equal to or a multiple of the video framerate to prevent problems with encoding such as loss of audio sync and audio distortion.
PAGE 247

5.52 SWF 5.52.5.35 241 on2sc swf_options_UpdateVariable (FLIX2HANDLE flix, const int32_t index, const char ∗ name, const char ∗ value) Updates an already existing SWF variable. Parameters: ← flix Handle to the flix engine returned from Flix2_Create() or Flix2_CreateEx() ← index The zero based index of the variable to update. ← name The name of the variable. ← value The value of the variable.
PAGE 248

242 Flix Engine Linux Module Documentation 5.53 WebM - FFmpeg 5.53.1 Detailed Description Example Usage: sc = Flix2_AddMuxer(&muxer, flix, FE2_MUXER_WEBM); if(sc == ON2_OK) ; //Now using the WebM muxer for output 5.53.2 Supported Codecs • Video: – FE2_CODEC_VP8 • Audio: – FE2_CODEC_VORBIS Additional References: • WebM Project Defines • #define FE2_MUXER_WEBM WebM muxer. For use with Flix2_AddMuxer(). 5.53.3 Define Documentation 5.53.3.1 #define FE2_MUXER_WEBM WebM muxer.
PAGE 249

5.54 Base Types 5.
PAGE 250

244 Flix Engine Linux Module Documentation ON2_WOULDBLOCK, ON2_NET_ERROR, ON2_INVALID_VERSION, ON2_INPROGRESS, ON2_NOT_SUPP, ON2_NO_MEM, ON2_INVALID_PARAMS, ON2_ERROR, ON2_OK, ON2_DONE } Common return type. 5.54.1 Define Documentation 5.54.1.1 #define ON264 printf format string suitable for printing an on2s64 Definition at line 96 of file on2types.h. 5.54.1.2 #define ON2TC printf format string suitable for printing an on2tc Definition at line 81 of file on2types.h. 5.54.1.
PAGE 251

5.54 Base Types 5.54.2.3 typedef on2s64 int64_t Definition at line 130 of file on2types.h. 5.54.2.4 typedef char int8_t Definition at line 42 of file on2types.h. 5.54.2.5 typedef int32_t on2bool Definition at line 57 of file on2types.h. 5.54.2.6 typedef int16_t on2s16 Definition at line 53 of file on2types.h. 5.54.2.7 typedef int32_t on2s32 Definition at line 55 of file on2types.h. 5.54.2.8 typedef long long on2s64 Definition at line 97 of file on2types.h. 5.54.2.
PAGE 252

246 Flix Engine Linux Module Documentation 5.54.2.14 typedef uint8_t on2u8 Definition at line 52 of file on2types.h. 5.54.2.15 typedef unsigned short uint16_t Definition at line 47 of file on2types.h. 5.54.2.16 typedef unsigned int uint32_t Definition at line 48 of file on2types.h. 5.54.2.17 typedef on2u64 uint64_t Definition at line 131 of file on2types.h. 5.54.2.18 typedef unsigned char uint8_t Definition at line 46 of file on2types.h. 5.54.3 Enumeration Type Documentation 5.54.3.
PAGE 253

5.54 Base Types ON2_NO_MEM ON2_INVALID_PARAMS ON2_ERROR ON2_OK ON2_DONE Definition at line 137 of file on2types.h.
PAGE 254

248 Flix Engine Linux Module Documentation 5.55 Video Encoding Options Modules • Deprecated Functions • on2sc video_options_Reset (FLIX2HANDLE flix) Reset the video options to their defaults. • on2sc video_options_Validate (const FLIX2HANDLE flix) Ensure the current video settings are valid. • on2sc video_options_GetSwfHeight (const FLIX2HANDLE flix, int32_t ∗lpSwfHeight) Gets the SWF height. • on2sc video_options_SetSwfHeight (FLIX2HANDLE flix, const int32_t lSwfHeight) Sets the SWF height.
PAGE 255

5.55 Video Encoding Options 249 → height Source video height, in pixels Return values: ON2_OK The source video size was successfully retrieved from the engine. ON2_NET_ERROR The underlying communication layer failed. 5.55.1.2 on2sc video_options_GetSourceWidth (const FLIX2HANDLE flix, int32_t ∗ width) Get the width of the source video.
PAGE 256

250 Flix Engine Linux Module Documentation → lpSwfWidth SWF width. Return values: ON2_OK Success. ON2_NET_ERROR The underlying communication layer failed. Note: If a value other than ON2_OK is returned, the output variables should not be considered valid. Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_WIDTH parameter. This function will be removed in a future release. 5.55.1.
PAGE 257

5.55 Video Encoding Options 5.55.1.7 251 on2sc video_options_SetSwfHeight (FLIX2HANDLE flix, const int32_t lSwfHeight) Sets the SWF height. Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() ← lSwfHeight SWF height. Return values: ON2_OK Success. ON2_NET_ERROR The underlying communication layer failed. Note: By default, the SWF height will be the video height. Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_HEIGHT parameter.
PAGE 258

252 Flix Engine Linux Module Documentation ← bUseCustomSwfDimensions on2true to enable, on2false to disable. Return values: ON2_OK Success. ON2_NET_ERROR The underlying communication layer failed. Note: By default, this is disabled. This will automatically be set to enabled if video_options_SetSwfWidth() or video_options_SetSwfHeight() is called. Deprecated Use the Muxer Interface along with FE2_MUXER_SWF and the FE2_SWF_WIDTH/FE2_SWF_HEIGHT parameters. This function will be removed in a future release.
PAGE 259

5.56 Deprecated 5.56 253 Deprecated Enumerations • enum FE2_VideoCodec { CODEC_NULL, CODEC_H263, CODEC_SCREENVIDEO, CODEC_VP6, CODEC_VP6ALPHA } Output video codec types, influences quality/compatibility. • enum FE2_CuePointType { CUE_EVENT, CUE_NAVIGATION } Cue point type for use with video_options_AddFLVCuePoint(). Functions • on2sc video_options_GetImageQuality (const FLIX2HANDLE flix, int32_t ∗lpImageQuality) Get the current image quality factor.
PAGE 260

254 Flix Engine Linux Module Documentation • on2sc video_options_GetRateControlType (const FLIX2HANDLE flix, FE2_VideoBitrateControls ∗pRateControlType) Get the current rate control type. • on2sc video_options_SetRateControlType (FLIX2HANDLE flix, const FE2_VideoBitrateControls rateControlType) Set the rate control type. • on2sc video_options_GetUseMaximumBitrate ∗bpUseMaximumBitrate) (const FLIX2HANDLE flix, on2bool Determine if the maximum bitrate target will be used.
PAGE 261

5.56 Deprecated 5.56.1 Enumeration Type Documentation 5.56.1.1 enum FE2_CuePointType 255 Cue point type for use with video_options_AddFLVCuePoint(). Deprecated Use the Muxer Interface along with FE2_MUXER_FLV and the FE2_FLV_CUEPT_EVENT/FE2_FLV_CUEPT_NAV parameter. This enumeration will be removed in a future release. Enumerator: CUE_EVENT Trigger an event at a specified point CUE_NAVIGATION Allows the user to seek to a specified point Definition at line 52 of file video_options.h. 5.56.1.
PAGE 262

256 Flix Engine Linux Module Documentation ← type Cue point type. Return values: ON2_OK on success ON2_INVALID_PARAMS should one or more of the preconditions fail ON2_NO_MEM an error occurred allocating memory for the new cue point. ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL pName is not NULL time >= 0.0 type is a valid member of FE2_CuePointType Note: Cue points can only be added to FLV files. May add multiple cue points.
PAGE 263

5.56 Deprecated 257 Note: Cue points can only be added to FLV files. May add multiple parameters to a cue point. Deprecated Use the Muxer Interface along with FE2_MUXER_FLV and the FE2_FLV_CUEPT_PARAM parameter. This function will be removed in a future release. 5.56.2.3 on2sc video_options_GetAlphaPercentage (const FLIX2HANDLE flix, int32_t ∗ percentage) Gets the percentage of the video bitrate to be used to encode the alpha channel.
PAGE 264

258 Flix Engine Linux Module Documentation Deprecated Use the Codec Interface along with FE2_CODEC_VP6 or FE2_CODEC_VP6ALPHA and the FE2_VP6_CXMODE or FE2_VP6A_CXMODE parameter. This function will be removed in a future release. See also: Video Codecs. 5.56.2.5 on2sc video_options_GetImageQuality (const FLIX2HANDLE flix, int32_t ∗ lpImageQuality) Get the current image quality factor.
PAGE 265

5.56 Deprecated 5.56.2.7 259 on2sc video_options_GetKeyframeIntervalType (const FLIX2HANDLE flix, FE2_VideoKeyframeTypes ∗ pKeyframeIntervalType) Get the current keyframe interval type. Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() → pKeyframeIntervalType Keyframe interval type (one of FE2_VideoKeyframeTypes) Return values: ON2_OK The keyframe interval type was successfully retrieved from the engine. ON2_NET_ERROR The underlying communication layer failed.
PAGE 266

260 Flix Engine Linux Module Documentation Parameters: ← flix Handle to the Flix Engine returned from Flix2_Create() or Flix2_CreateEx() → pRateControlType Rate control type (one of FE2_VideoBitrateControls) Return values: ON2_OK The rate control type was successfully retrieved from the engine. ON2_NET_ERROR The underlying communication layer failed. Note: If a value other than ON2_OK is returned, the output variables should not be considered valid.
PAGE 267

5.56 Deprecated 261 Return values: ON2_OK The bitrate enable status was successfully retrieved from the engine. ON2_NET_ERROR The underlying communication layer failed. Note: If a value other than ON2_OK is returned, the output variables should not be considered valid. Deprecated Use the Codec Interface along with the FE2_CODECPARAM_BITRATE parameter. This function will be removed in a future release. See also: Video Codecs. 5.56.2.
PAGE 268

262 Flix Engine Linux Module Documentation Note: By default, the percentage is 15%. The range is 0-100%. The codec type must be CODEC_VP6ALPHA. For example if the maximum video bitrate was set to 500 through video_options_SetMaximumBitrate(), and the alpha percentage was set to 15% then the bitrate for the VP6 video would be 425 and the alpha bitrate would be 75. Deprecated Use the Codec Interface along with FE2_CODEC_VP6ALPHA and the FE2_VP6A_ALPHA_BITRATE parameter.
PAGE 269

5.56 Deprecated 263 ← lImageQuality Quality Factor (0 to 100) Return values: ON2_OK The quality value was successfully set in the engine. ON2_INVALID_PARAMS The value is out of range. ON2_NET_ERROR The underlying communication layer failed. Note: The default value is 75. Deprecated The image quality functions have been deprecated in favor of the maximum bitrate functions. Use video_options_GetMaximumBitrate() instead. 5.56.2.
PAGE 270

264 Flix Engine Linux Module Documentation 5.56.2.17 on2sc video_options_SetKeyframeIntervalType (FLIX2HANDLE flix, const FE2_VideoKeyframeTypes keyframeIntervalType) Set the keyframe interval type. Two keyframe modes are supported, MAX_KEYFRAMES (the default) and FIXED_KEYFRAMES. These specify that the keyframe interval set using video_options_SetKeyframeInterval() is either the maximum interval between keyframes or a fixed interval, respectively.
PAGE 271

5.56 Deprecated 265 The H.263 codec is usable down to 0.05 bpp. For lower bitrates, VP6 must be used. The default value is 448 Kbps. Setting this value will have no effect unless enabled via video_options_SetUseMaximumBitrate() Deprecated Use the Codec Interface along with the FE2_CODECPARAM_BITRATE parameter. This function will be removed in a future release. See also: Video Codecs. See also: Video Codecs 5.56.2.
PAGE 272

266 Flix Engine Linux Module Documentation ON2_NET_ERROR the underlying communication layer failed Precondition: flix is not NULL Deprecated Please use swf_options_SetSwfFramerateAsDouble() to allow for non integer framerates. 5.56.2.21 on2sc video_options_SetUseMaximumBitrate (FLIX2HANDLE flix, const on2bool bUseMaximumBitrate) Enable/disable the maximum bitrate target value.
PAGE 273

Chapter 6 Flix Engine Linux File Documentation 6.1 about.
PAGE 274

268 6.2 Flix Engine Linux File Documentation binding_deviations.
PAGE 275

6.3 flixengine2/audio_options.h File Reference 6.3 6.3.1 269 flixengine2/audio_options.h File Reference Detailed Description Reference module(s): Audio Encoding Options. Definition in file audio_options.h.
PAGE 276

270 Flix Engine Linux File Documentation Functions • on2sc audio_options_Reset (FLIX2HANDLE flix) Reset the audio encoding options to their default values. • on2sc audio_options_Validate (FLIX2HANDLE flix) Validate the current audio encoding options. • on2sc audio_options_SetBitrate (FLIX2HANDLE flix, const FE2_AudioBitrates bitrate) Set the bitrate to use in mp3 encoding. • on2sc audio_options_GetBitrate (const FLIX2HANDLE flix, FE2_AudioBitrates ∗pBitrate) Retrieve the current mp3 bitrate.
PAGE 277

6.4 flixengine2/codec_constants.h File Reference 6.4 6.4.1 flixengine2/codec_constants.h File Reference Detailed Description Reference module(s): Codecs. Definition in file codec_constants.h. #include "codecs/codec_common.h" #include "codecs/h263.h" #include "codecs/h264.h" #include "codecs/vp6.h" #include "codecs/vp6_alpha.h" #include "codecs/vp8.h" #include "codecs/aac.h" #include "codecs/amr.h" #include "codecs/lame.h" #include "codecs/vorbis.
PAGE 278

272 Flix Engine Linux File Documentation 6.5 6.5.1 flixengine2/codecs/aac.h File Reference Detailed Description Reference module(s): AAC, AAC+. Definition in file aac.h. Defines • #define FE2_CODEC_AAC AAC. Codec name for use with Flix2_AddCodec(). • #define FE2_AAC_BITRATE Alias for FE2_CODECPARAM_BITRATE. • #define FE2_CODEC_AACPLUS AAC+ (HE-AAC). Codec name for use with Flix2_AddCodec(). • #define FE2_AACPLUS_BITRATE Alias for FE2_CODECPARAM_BITRATE.
PAGE 279

6.6 flixengine2/codecs/amr.h File Reference 6.6 6.6.1 flixengine2/codecs/amr.h File Reference Detailed Description Reference module(s): AMR_NB - FFmpeg. Definition in file amr.h. Defines • #define FE2_CODEC_AMR_NB AMR Narrowband. Codec name for use with Flix2_AddCodec(). • #define FE2_AMR_BITRATE Alias for FE2_CODECPARAM_BITRATE.
PAGE 280

274 Flix Engine Linux File Documentation 6.7 flixengine2/codecs/codec_common.h File Reference Defines • #define FE2_CODECPARAM_BITRATE Codec parameter for stream bitrate. • #define FE2_VCODECPARAM_RC_MODE Video codec parameter for the rate control mode. • #define FE2_VCODECPARAM_KFINTTYPE Video codec parameter for the keyframe interval type. • #define FE2_VCODECPARAM_KFFREQ Video codec parameter for keyframe frequency.
PAGE 281

6.8 flixengine2/codecs/h263.h File Reference 6.8 6.8.1 flixengine2/codecs/h263.h File Reference Detailed Description Reference module(s): H263 - FFmpeg. Definition in file h263.h. Defines • #define FE2_CODEC_H263 Codec name for use with Flix2_AddCodec(). • #define FE2_CODEC_H263_BASELINE Codec name for use with Flix2_AddCodec(). • #define FE2_H263_BITRATE Alias for FE2_CODECPARAM_BITRATE. • #define FE2_H263_KFINTTYPE Alias for FE2_VCODECPARAM_KFINTTYPE.
PAGE 282

276 Flix Engine Linux File Documentation 6.9 6.9.1 flixengine2/codecs/h264.h File Reference Detailed Description Reference module(s): H264. Definition in file h264.h. Defines • #define FE2_CODEC_H264 Codec name for use with Flix2_AddCodec(). • #define FE2_H264_BITRATE Alias for FE2_CODECPARAM_BITRATE. • #define FE2_H264_KFINTTYPE Alias for FE2_VCODECPARAM_KFINTTYPE. • #define FE2_H264_KFFREQ Alias for FE2_VCODECPARAM_KFFREQ. • #define FE2_H264_RC_MODE Alias for FE2_VCODECPARAM_RC_MODE.
PAGE 283

6.10 flixengine2/codecs/lame.h File Reference 6.10 flixengine2/codecs/lame.h File Reference 6.10.1 Detailed Description Reference module(s): MP3 - LAME. Definition in file lame.h. Defines • #define FE2_CODEC_LAME Codec name for use with Flix2_AddCodec(). • #define FE2_LAME_BITRATE Alias for FE2_CODECPARAM_BITRATE. • #define FE2_LAME_QUALITY Codec parameter for controlling LAME library’s algorithm selection.
PAGE 284

278 Flix Engine Linux File Documentation 6.11 flixengine2/codecs/vorbis.h File Reference 6.11.1 Detailed Description Reference module(s): libvorbis - FFmpeg. Definition in file vorbis.h. Defines • #define FE2_CODEC_VORBIS Vorbis. Codec name for use with Flix2_AddCodec(). • #define FE2_VORBIS_BITRATE Alias for FE2_CODECPARAM_BITRATE.
PAGE 285

6.12 flixengine2/codecs/vp6.h File Reference 6.12 flixengine2/codecs/vp6.h File Reference 6.12.1 Detailed Description Reference module(s): VP6. Definition in file vp6.h. General VP6 settings • #define FE2_VP6_BITRATE Alias for FE2_CODECPARAM_BITRATE. • #define FE2_VP6_KFINTTYPE Alias for FE2_VCODECPARAM_KFINTTYPE. • #define FE2_VP6_KFFREQ Alias for FE2_VCODECPARAM_KFFREQ. • #define FE2_VP6_RC_MODE Alias for FE2_VCODECPARAM_RC_MODE. • #define FE2_VP6_CXMODE VP6 compress mode.
PAGE 286

280 Flix Engine Linux File Documentation Defines Codec name • #define FE2_CODEC_VP6 Codec name for use with Flix2_AddCodec(). Advanced VP6 settings • #define FE2_VP6_CONCURRENCY Codec parameter for concurrency level. • #define FE2_VP6_UNDERSHOOT_PCT Codec parameter for undershoot percentage. • #define FE2_VP6_MIN_Q Codec parameter for minimum quantizer. • #define FE2_VP6_MAX_Q Codec parameter for maximum quantizer. • #define FE2_VP6_TEMPORAL_RESAMPLING Codec parameter for temporal resampling.
PAGE 287

6.13 flixengine2/codecs/vp6_alpha.h File Reference 6.13 flixengine2/codecs/vp6_alpha.h File Reference 6.13.1 Detailed Description Reference module(s): VP6 with Alpha. Definition in file vp6_alpha.h. Defines Codec name • #define FE2_CODEC_VP6ALPHA Codec name for use with Flix2_AddCodec(). General VP6 settings • #define FE2_VP6A_BITRATE Alias for FE2_CODECPARAM_BITRATE. • #define FE2_VP6A_ALPHA_BITRATE Compressed bitrate of the alpha channel in kbit/s.
PAGE 288

282 Flix Engine Linux File Documentation • #define FE2_VP6A_MIN_Q Alias for FE2_VP6_MIN_Q. • #define FE2_VP6A_ALPHA_MIN_Q Minimum quantizer for the alpha channel. • #define FE2_VP6A_MAX_Q Alias for FE2_VP6_MAX_Q. • #define FE2_VP6A_ALPHA_MAX_Q Maximum quantizer for the alpha channel. • #define FE2_VP6A_TEMPORAL_RESAMPLING Alias for FE2_VP6_TEMPORAL_RESAMPLING. • #define FE2_VP6A_TEMPORAL_DOWN_WATERMARK Alias for FE2_VP6_TEMPORAL_DOWN_WATERMARK.
PAGE 289

6.14 flixengine2/codecs/vp8.h File Reference 6.14 flixengine2/codecs/vp8.h File Reference 6.14.1 Detailed Description 283 Reference module(s): VP8. Definition in file vp8.h. Defines • #define FE2_VP8_PROFILE Bitstream profile. • #define FE2_VP8_ALTREF Enable the use of alternate reference frames. • #define FE2_VP8_AR_MAX_FRAMES Max number of frames blurred creating alternate reference. • #define FE2_VP8_AR_TYPE Filter type to use w/alternate reference.
PAGE 290

284 Flix Engine Linux File Documentation Alias for FE2_VCODECPARAM_KFINTTYPE. • #define FE2_VP8_KFFREQ Alias for FE2_VCODECPARAM_KFFREQ. • #define FE2_VP8_RC_MODE Alias for FE2_VCODECPARAM_RC_MODE. • #define FE2_VP8_CXMODE VP8 compress mode. • #define FE2_VP8_SHARPNESS Codec parameter for sharpness. • #define FE2_VP8_NOISE_REDUCTION Controls encoder noise reduction preprocessing. Advanced VP8 settings • #define FE2_VP8_UNDERSHOOT_PCT Codec parameter for undershoot percentage.
PAGE 291

6.15 flixengine2/encoding_status.h File Reference 285 6.15 flixengine2/encoding_status.h File Reference 6.15.1 Detailed Description Reference module(s): Encoding Statistics. Definition in file encoding_status.h. Functions • on2sc encoding_status_GetAverageBitrate (const FLIX2HANDLE flix, int32_t ∗pBitrate) Retrieve the encoder’s average (video) bitrate. • on2sc encoding_status_GetAverageFramesize (const FLIX2HANDLE flix, int32_t ∗pFramesize) Retrieve the encoder’s average (video) frame size.
PAGE 292

286 Flix Engine Linux File Documentation 6.16 flixengine2/filter_constants.h File Reference 6.16.1 Detailed Description Reference module(s): Filters. Definition in file filter_constants.h. #include "filters/cut.h" #include "filters/adaptive_deinterlace.h" #include "filters/bchs.h" #include "filters/blur.h" #include "filters/crop.h" #include "filters/denoise.h" #include "filters/framerate.h" #include "filters/mirror.h" #include "filters/overlay.h" #include "filters/png_export.
PAGE 293

6.17 flixengine2/filters/adaptive_deinterlace.h File Reference 6.17 flixengine2/filters/adaptive_deinterlace.h File Reference 6.17.1 Detailed Description Reference module(s): Deinterlace. Definition in file adaptive_deinterlace.h. Defines • #define FE2_FILTER_ADAPTIVE_DEINTERLACE Filter name for use with Flix2_AddFilter(). • #define FE2_ADAPTIVE_DEINTERLACE_MODE Specifies deinterlace mode to be applied to source image.
PAGE 294

288 Flix Engine Linux File Documentation 6.18 flixengine2/filters/bchs.h File Reference 6.18.1 Detailed Description Reference module(s): Brightness/Contrast/Hue/Saturation. Definition in file bchs.h. Defines • #define FE2_FILTER_BCHS Filter name for use with Flix2_AddFilter(). • #define FE2_BCHS_BRIGHTNESS Parameter for the brightness adjustment factor. • #define FE2_BCHS_CONTRAST Parameter for the contrast adjustment factor. • #define FE2_BCHS_HUE Parameter for the hue adjustment factor.
PAGE 295

6.19 flixengine2/filters/blur.h File Reference 6.19 flixengine2/filters/blur.h File Reference 6.19.1 Detailed Description Reference module(s): Blur. Definition in file blur.h. Defines • #define FE2_FILTER_BLUR Filter name for use with Flix2_AddFilter(). • #define FE2_BLUR_FILTER Specifies blur filter to be applied to source. • #define FE2_BLUR_MASKSIZE Specifies the kernel/mask size to be used. Typedefs • typedef enum masksiz masksiz_t Filter mask/kernel size.
PAGE 296

290 Flix Engine Linux File Documentation 6.20 flixengine2/filters/crop.h File Reference 6.20.1 Detailed Description Reference module(s): Crop. Definition in file crop.h. Defines • #define FE2_FILTER_CROP Filter name for use with Flix2_AddFilter(). • #define FE2_CROP_TOP Filter parameter for setting bounding box’s top coordinate. • #define FE2_CROP_BOTTOM Filter parameter for setting bounding box’s bottom coordinate.
PAGE 297

6.21 flixengine2/filters/cut.h File Reference 6.21 flixengine2/filters/cut.h File Reference 6.21.1 Detailed Description Reference module(s): Cut. Definition in file cut.h. Defines • #define FE2_FILTER_CUT Filter name for use with Flix2_AddFilter(). • #define FE2_CUT_START_SEC Filter parameter for cut start time. • #define FE2_CUT_STOP_SEC Filter parameter for setting the cut stop time. • #define FE2_CUT_USE_SEEK Set FE2_CUT_START_SEC application method.
PAGE 298

292 Flix Engine Linux File Documentation 6.22 flixengine2/filters/denoise.h File Reference 6.22.1 Detailed Description Reference module(s): Denoise. Definition in file denoise.h. Defines • #define FE2_FILTER_DENOISE Filter name for use with Flix2_AddFilter(). • #define FE2_DENOISE_NOISE_LEVEL Specifies noise level of the source.
PAGE 299

6.23 flixengine2/filters/framerate.h File Reference 6.23 flixengine2/filters/framerate.h File Reference 6.23.1 Detailed Description Reference module(s): Frame Rate. Definition in file framerate.h. Defines • #define FE2_FILTER_FRAMERATE Filter name for use with Flix2_AddFilter(). • #define FE2_FRAMERATE_FPS Filter parameter name for frames per second value. • #define FE2_FRAMERATE_DECIMATE Filter parameter for the decimation interval.
PAGE 300

294 Flix Engine Linux File Documentation 6.24 flixengine2/filters/highpass.h File Reference 6.24.1 Detailed Description Reference module(s): Highpass. Definition in file highpass.h. Defines • #define FE2_FILTER_HIGHPASS Filter name for use with Flix2_AddFilter(). • #define FE2_HIGHPASS_Q Filter parameter for shape constant ("Q" coefficient). • #define FE2_HIGHPASS_CUTOFF Filter parameter for cutoff frequency.
PAGE 301

6.25 flixengine2/filters/lowpass.h File Reference 6.25 flixengine2/filters/lowpass.h File Reference 6.25.1 Detailed Description Reference module(s): Lowpass. Definition in file lowpass.h. Defines • #define FE2_FILTER_LOWPASS Filter name for use with Flix2_AddFilter(). • #define FE2_LOWPASS_Q Filter parameter for shape constant ("Q" coefficient). • #define FE2_LOWPASS_CUTOFF Filter parameter for cutoff frequency.
PAGE 302

296 Flix Engine Linux File Documentation 6.26 flixengine2/filters/mirror.h File Reference 6.26.1 Detailed Description Reference module(s): Mirror. Definition in file mirror.h. Defines • #define FE2_FILTER_MIRROR Filter name for use with Flix2_AddFilter(). • #define FE2_MIRROR_HORIZONTAL Specifies horizontal disposition. • #define FE2_MIRROR_VERTICAL Specifies vertical disposition.
PAGE 303

6.27 flixengine2/filters/overlay.h File Reference 6.27 flixengine2/filters/overlay.h File Reference 6.27.1 Detailed Description 297 Reference module(s): Overlay (Watermark). Definition in file overlay.h. Defines • #define FE2_FILTER_OVERLAY Filter name for use with Flix2_AddFilter(). • #define FE2_OVERLAY_FILE Set the path to the overlay image file. • #define FE2_OVERLAY_MASK_XY Use the pixel at coordinates (FE2_OVERLAY_MASK_X,FE2_OVERLAY_MASK_Y) to determine the transparent color.
PAGE 304

298 Flix Engine Linux File Documentation Enumerations • enum FE2_OverlayPositionMode { FE2_OVERLAY_POS_MODE_TOPLEFT, FE2_OVERLAY_POS_MODE_BOTLEFT, FE2_OVERLAY_POS_MODE_CENTER, FE2_OVERLAY_POS_MODE_TOPRIGHT, FE2_OVERLAY_POS_MODE_BOTRIGHT, FE2_OVERLAY_POS_MODE_XY } Position modes for use with FE2_OVERLAY_POS.
PAGE 305

6.28 flixengine2/filters/png_export.h File Reference 6.28 flixengine2/filters/png_export.h File Reference 6.28.1 Detailed Description Reference module(s): PNG Image Export (Thumbnail). Definition in file png_export.h. Defines • #define FE2_FILTER_PNGEX Filter name for use with Flix2_AddFilter(). • #define FE2_PNGEX_OUTPUT_DIRECTORY Filter parameter for setting PNG image output directory. • #define FE2_PNGEX_FILENAME_PREFIX Filter parameter for setting PNG image file name prefix.
PAGE 306

300 Flix Engine Linux File Documentation Filter parameter for setting compression level used by libpng. • #define FE2_PNGEX_WIDTH Filter parameter for setting PNG image width. • #define FE2_PNGEX_HEIGHT Filter parameter for setting PNG image height. Enumerations • enum FE2_PNGExCuePtMode { FE2_PNGEX_CP_EVENT, FE2_PNGEX_CP_NAV, FE2_PNGEX_CP_ALL } Constants for use with FE2_PNGEX_EXPORT_CUE_POINTS.
PAGE 307

6.29 flixengine2/filters/resample.h File Reference 6.29 flixengine2/filters/resample.h File Reference 6.29.1 Detailed Description Reference module(s): Resample. Definition in file resample.h. Defines • #define FE2_FILTER_RESAMPLE Filter name for use with Flix2_AddFilter(). • #define FE2_RESAMPLE_RATE Desired sample rate in Hertz (Hz). • #define FE2_RESAMPLE_CHANNELS Filter parameter for channels.
PAGE 308

302 Flix Engine Linux File Documentation 6.30 flixengine2/filters/rotate.h File Reference 6.30.1 Detailed Description Reference module(s): Rotate. Definition in file rotate.h. Defines • #define FE2_FILTER_ROTATE Filter name for use with Flix2_AddFilter(). • #define FE2_ROTATE_ANGLE Specifies the image rotation angle in degrees.
PAGE 309

6.31 flixengine2/filters/scale.h File Reference 6.31 flixengine2/filters/scale.h File Reference 6.31.1 Detailed Description Reference module(s): Scale. Definition in file scale.h. Defines • #define FE2_FILTER_SCALE Filter name for use with Flix2_AddFilter(). • #define FE2_SCALE_WIDTH Filter parameter name for scaled width. • #define FE2_SCALE_HEIGHT Filter parameter name for scaled height.
PAGE 310

304 Flix Engine Linux File Documentation 6.32 flixengine2/filters/sharpen.h File Reference 6.32.1 Detailed Description Reference module(s): Sharpen. Definition in file sharpen.h. Defines • #define FE2_FILTER_SHARPEN Filter name for use with Flix2_AddFilter().
PAGE 311

6.33 flixengine2/flixengine2.h File Reference 6.33 flixengine2/flixengine2.h File Reference 6.33.1 Detailed Description 305 Reference module(s): Main Engine Interface, Flix Engine Core Library, Filter Manipulation, Codec Manipulation, Muxer Manipulation. Definition in file flixengine2.h. #include "on2types.h" #include "filter_constants.h" #include "codec_constants.h" #include "muxer_constants.h" #include "video_options.h" #include "audio_options.h" #include "swf_options.h" #include "encoding_status.
PAGE 312

306 Flix Engine Linux File Documentation • enum FE2_EncState { EncStateIdle, EncStateRunning, EncStateQueued } Encoder state returned by Flix2_GetEncoderState(). • enum FE2_errno { ErrNone, ErrSys, ErrFileIO, ErrFileOpen, ErrFileDecode, ErrFileDecodeA, ErrFileDecodeV, ErrEncodeA, ErrEncodeV } Flix engine error state returned by Flix2_Errno(). Functions • on2sc Flix2_Init () Perform library initialization. • on2sc Flix2_Deinit () Cleanup resources allocated by Flix2_Init().
PAGE 313

6.33 flixengine2/flixengine2.h File Reference 307 • on2sc Flix2_SetOverwriteExistingFiles (FLIX2HANDLE flix, const on2bool bOverwriteExistingFiles) Enable/disable overwriting of existing output files. • on2sc Flix2_GetOverwriteExistingFiles ∗bpOverwriteExistingFiles) (const FLIX2HANDLE flix, on2bool Retrieve the engine’s current behavior regarding existing output files.
PAGE 314

308 Flix Engine Linux File Documentation • on2sc Flix2_IsEncoderRunning (const FLIX2HANDLE flix, on2bool ∗bpIsEncoderRunning) Check the status of an encode. • on2sc Flix2_GetEncoderState (const FLIX2HANDLE flix, FE2_EncState ∗pEncState) Retrieve the current state of the encoder. • on2sc Flix2_SetLogLevel (FLIX2HANDLE flix, int32_t level) Set the library-wide debug log level. • on2sc Flix2_GetLogLevel (const FLIX2HANDLE flix, int32_t ∗level) Retrieve current library-wide debug log level.
PAGE 315

6.33 flixengine2/flixengine2.h File Reference 309 • on2sc Flix2_CodecGetParamAsStr (FLIX2PLGNHANDLE plgn, const char ∗name, on2tc ∗value, int32_t ∗len) Retrieve the value of a parameter in a codec instance represented as a string. • on2sc Flix2_CodecSetParam (FLIX2PLGNHANDLE plgn, const char ∗name, double inDblVal) Set the value of a parameter in a codec instance using a double representation.
PAGE 316

310 6.33.2.4 Flix Engine Linux File Documentation #define FLIXENGINE_VERSION_MAJOR Definition at line 34 of file flixengine2.h. 6.33.2.5 #define FLIXENGINE_VERSION_MINOR Definition at line 35 of file flixengine2.h. 6.33.2.6 #define FLIXENGINE_VERSION_PATCH Definition at line 36 of file flixengine2.h. 6.33.2.7 #define FLIXENGINE_VERSION_STR Definition at line 43 of file flixengine2.h. 6.33.3 Typedef Documentation 6.33.3.
PAGE 317

6.34 flixengine2/fs_options.h File Reference 6.34 flixengine2/fs_options.h File Reference 6.34.1 Detailed Description 311 Reference module(s): Frame Server API. Definition in file fs_options.h. Enumerations • enum FE2_FrameType { FrameTypeAudio, FrameTypeVideo } Frame type being passed to Flix2_EncodeFrame(). • enum FE2_VideoFormat { VideoFormatYV12, VideoFormatBGRA } Format of input video used in calls to Flix2_SetVideoProperties().
PAGE 318

312 Flix Engine Linux File Documentation 6.35 flixengine2/media_editor_options.h File Reference 6.35.1 Detailed Description Reference module(s): Filter Manipulation, Video Filters. Definition in file media_editor_options.h. Functions • on2sc editor_options_Reset (FLIX2HANDLE flix) Reset the media editor options to their defaults. • on2sc editor_options_Validate (const FLIX2HANDLE flix) Ensure the current media editor settings are valid.
PAGE 319

6.35 flixengine2/media_editor_options.h File Reference 313 Set the contrast adjustment factor. • on2sc editor_options_GetUseContrast (const FLIX2HANDLE flix, on2bool ∗pUseContrast) Determine if the contrast filter is enabled. • on2sc editor_options_SetUseContrast (FLIX2HANDLE flix, const on2bool bUseContrast) Enable/disable the contrast filter. • on2sc editor_options_GetHue (const FLIX2HANDLE flix, int32_t ∗pHue) Get the current hue adjustment factor.
PAGE 320

314 Flix Engine Linux File Documentation 6.36 flixengine2/muxer_constants.h File Reference 6.36.1 Detailed Description Reference module(s): Muxers. Definition in file muxer_constants.h. #include "muxers/flv.h" #include "muxers/fxm.h" #include "muxers/isomedia.h" #include "muxers/swf.h" #include "muxers/webm.
PAGE 321

6.37 flixengine2/muxers/flv.h File Reference 6.37 flixengine2/muxers/flv.h File Reference 6.37.1 Detailed Description Reference module(s): FLV Muxer. Definition in file flv.h. Defines • #define FE2_MUXER_FLV FLV muxer. For use with Flix2_AddMuxer(). • #define FE2_FLV_CUEPT_EVENT Set an event cue point. • #define FE2_FLV_CUEPT_NAV Set a navigation cue point. • #define FE2_FLV_CUEPT_PARAM Add a name/value pair to an existing cue point.
PAGE 322

316 Flix Engine Linux File Documentation MD_HEIGHT, MD_FRAMERATE, MD_CANSEEKTOEND, MD_LASTTIMESTAMP, MD_LASTKEYFRAMETIMESTAMP, MD_LASTKEYFRAMELOCATION, MD_KEYFRAMES } Supported FLV onMetaData elements.
PAGE 323

6.38 flixengine2/muxers/fxm.h File Reference 6.38 flixengine2/muxers/fxm.h File Reference 6.38.1 Detailed Description Reference module(s): FXM Muxer. Definition in file fxm.h. Defines • #define FE2_MUXER_FXM FXM muxer. For use with Flix2_AddMuxer(). • #define FE2_FXM_CUEPT_EVENT Set an event cue point. • #define FE2_FXM_CUEPT_NAV Set a navigation cue point. • #define FE2_FXM_CUEPT_PARAM Add a name/value pair to an existing cue point.
PAGE 324

318 Flix Engine Linux File Documentation 6.39 flixengine2/muxers/isomedia.h File Reference 6.39.1 Detailed Description Reference module(s): 3GPP Muxer, 3GPP2 Muxer, MOV Muxer, MP4 Muxer. Definition in file isomedia.h. Defines • #define FE2_ISOMEDIA_FASTSTART Influence ’moov’ box placement. • #define FE2_MUXER_3GP 3GPP muxer. For use with Flix2_AddMuxer() • #define FE2_3GP_FASTSTART FE2_ISOMEDIA_FASTSTART alias • #define FE2_MUXER_3G2 3GPP2 muxer.
PAGE 325

6.39 flixengine2/muxers/isomedia.h File Reference 319 Attention: The current implementation is a post-process. A temporary file is created within the output directory as the necessary boxes are rewritten, with the result then replacing the original output file. Definition at line 34 of file isomedia.h.
PAGE 326

320 Flix Engine Linux File Documentation 6.40 flixengine2/muxers/swf.h File Reference 6.40.1 Detailed Description Reference module(s): SWF Muxer. Definition in file swf.h. Defines • #define FE2_MUXER_SWF SWF muxer. For use with Flix2_AddMuxer(). • #define FE2_SWF_HEIGHT Set the SWF height. • #define FE2_SWF_WIDTH Set the SWF width. • #define FE2_SWF_FRAMERATE Set the SWF framerate. • #define FE2_SWF_EMBEDDED_URL Set the SWF’s target URL.
PAGE 327

6.40 flixengine2/muxers/swf.h File Reference Sets the options for the start of the SWF. • #define FE2_SWF_START_BLANK_FRAME Control the insertion of a blank first frame in the SWF. • #define FE2_SWF_START_WAIT_SEC Sets the number of seconds to wait before playback begins. • #define FE2_SWF_ADD_VARIABLE Add or update a variable in the SWF. • #define FE2_SWF_DELETE_VARIABLE Delete an existing variable in the SWF.
PAGE 328

322 Flix Engine Linux File Documentation 6.41 flixengine2/muxers/webm.h File Reference 6.41.1 Detailed Description Reference module(s): WebM Muxer. Definition in file webm.h. Defines • #define FE2_MUXER_WEBM WebM muxer. For use with Flix2_AddMuxer().
PAGE 329

6.42 flixengine2/on2types.h File Reference 6.42 flixengine2/on2types.h File Reference 6.42.1 Detailed Description Reference module(s): Base Types. Definition in file on2types.h. #include Defines • #define OTC(str) a macro suitable for declaring a constant on2tc • #define ON2TC printf format string suitable for printing an on2tc • #define PRId64 • #define ON264 printf format string suitable for printing an on2s64 • #define ON2API library calling convention/storage class attributes.
PAGE 330

324 Flix Engine Linux File Documentation Enumerations • enum _on2bool { on2false, on2true } • enum on2sc { ON2_NOT_FOUND, ON2_BUFFER_EMPTY, ON2_BUFFER_FULL, ON2_CONNREFUSED, ON2_TIMEDOUT, ON2_WOULDBLOCK, ON2_NET_ERROR, ON2_INVALID_VERSION, ON2_INPROGRESS, ON2_NOT_SUPP, ON2_NO_MEM, ON2_INVALID_PARAMS, ON2_ERROR, ON2_OK, ON2_DONE } Common return type. 6.42.2 Define Documentation 6.42.2.1 #define ON2API library calling convention/storage class attributes.
PAGE 331

6.43 flixengine2/overlay_options.h File Reference 6.43 flixengine2/overlay_options.h File Reference 6.43.1 Detailed Description 325 Reference module(s): Overlay (Watermark). Definition in file overlay_options.h. Functions Deprecated functions • on2sc overlay_options_Reset (const FLIX2HANDLE flix) Resets the overlay options. • on2sc overlay_options_GetUseOverlay (const FLIX2HANDLE flix, on2bool ∗pUseOverlay) Determines if an overlay is to be used.
PAGE 332

326 Flix Engine Linux File Documentation 6.44 flixengine2/swf_options.h File Reference 6.44.1 Detailed Description Reference module(s): SWF. Definition in file swf_options.h. Functions Deprecated functions • on2sc swf_options_Reset (FLIX2HANDLE flix) Resets the swf options. • on2sc swf_options_GetEmbeddedUrl (FLIX2HANDLE flix, char ∗embeddedUrl, int32_t ∗len) Gets the embedded URL.
PAGE 333

6.44 flixengine2/swf_options.h File Reference 327 • on2sc swf_options_SetSwfFramerateAsDouble (FLIX2HANDLE flix, const double swfFramerate) Sets the SWF framerate as a double. • on2sc swf_options_GetEnablePreloader (FLIX2HANDLE flix, on2bool ∗pEnablePreloader) Gets if a video preloader is enabled or disabled. • on2sc swf_options_SetEnablePreloader (FLIX2HANDLE flix, const on2bool enablePreloader) Enables or disables the video preloader.
PAGE 334

328 Flix Engine Linux File Documentation • on2sc swf_options_GetMovieOnStartOptions (FLIX2HANDLE flix, FE2_SwfOnStartOptions ∗pOnStartOptions) Gets the options for the start of the SWF. • on2sc swf_options_SetMovieOnStartOptions SwfOnStartOptions onStartOptions) (FLIX2HANDLE flix, const FE2_- Sets the options for the start of the SWF. • on2sc swf_options_GetWaitTimeToStart (FLIX2HANDLE flix, int32_t ∗pWaitTimeToStart) Gets the number of seconds to wait before playback begins.
PAGE 335

6.45 flixengine2/video_options.h File Reference 329 6.45 flixengine2/video_options.h File Reference 6.45.1 Detailed Description Reference module(s): Video Encoding Options, Frame Rate, Scale. Definition in file video_options.h. Enumerations • enum FE2_VideoCodec { CODEC_NULL, CODEC_H263, CODEC_SCREENVIDEO, CODEC_VP6, CODEC_VP6ALPHA } Output video codec types, influences quality/compatibility.
PAGE 336

330 Flix Engine Linux File Documentation Get the current keyframe interval type. • on2sc video_options_SetKeyframeIntervalType VideoKeyframeTypes keyframeIntervalType) (FLIX2HANDLE flix, const FE2_- Set the keyframe interval type. • on2sc video_options_GetMaximumBitrate t ∗lpMaximumBitrate) (const FLIX2HANDLE flix, int32_- Get the current maximum bitrate target. • on2sc video_options_SetMaximumBitrate (FLIX2HANDLE flix, const int32_t lMaximumBitrate) Set the maximum bitrate target.
PAGE 337

6.45 flixengine2/video_options.h File Reference 331 Gets the SWF framerate. • on2sc video_options_SetSwfFramerate (FLIX2HANDLE flix, const int32_t swfFramerate) Sets the SWF framerate. • on2sc video_options_GetVideoCodec ∗pVideoCodec) (const FLIX2HANDLE flix, FE2_VideoCodec Determine which video codec will be used. • on2sc video_options_SetVideoCodec (FLIX2HANDLE flix, const FE2_VideoCodec videoCodec) Select the video codec to be used.
PAGE 338

332 Flix Engine Linux File Documentation • on2sc video_options_SetImageWidth (FLIX2HANDLE flix, const int32_t lImageWidth) Set the scaled image width. • on2sc video_options_GetUseSourceDimensions ∗bpUseSourceDimensions) (const FLIX2HANDLE flix, on2bool Determine if the source’s dimensions will be used instead of the scaled dimensions. • on2sc video_options_SetUseSourceDimensions (FLIX2HANDLE flix, const on2bool bUseSourceDimensions) Switch between source and scaled dimensions.
PAGE 339

6.46 mainpage.dox File Reference 6.46 mainpage.
PAGE 340

334 6.47 Flix Engine Linux File Documentation samples.
PAGE 341

Chapter 7 Flix Engine Linux Page Documentation 7.1 About Flix Engine 7.1.1 Version Information Version: 8.0.17.1 7.1.2 Third Parties • This Flix product includes H.264 files licensed by Intel Corporation. Intel is a trademark or registered trademark of Intel Corporation or its subsidiaries in the United States and other countries. • This Flix product includes aacPlus developed by Coding Technologies. http://www.codingtechnologies.
PAGE 342

336 Flix Engine Linux Page Documentation Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2.
PAGE 343

7.1 About Flix Engine 337 If this package is used in a product, Eric Young should be given attribution as the author of the parts of the library used. This can be in the form of a textual message at program startup or in documentation (online or textual) provided with the package. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1.
PAGE 344

338 Flix Engine Linux Page Documentation THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ‘‘AS IS’’ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
PAGE 345

7.2 Language Binding API Deviations 7.2 339 Language Binding API Deviations The Flix Engine language bindings endeavor to remain as true as possible to the Flix Engine API. In certain cases, however, the C implementation does not transfer directly. This guide will provide an overview of the changes, both necessary and those done for the sake of convenience. Currently Flix Engine has support for Java, Perl, PHP and Python.
PAGE 346

340 Flix Engine Linux Page Documentation $flix= flix2handlep_value($flixptr); $flix is now the handle to use in the remaining API calls, for example: Flix2_SetInputFile($flix,"/path/to/input.video"); When you’re finished with the handle you can clean up any resources allocated to it by calling: delete_flix2handlep($flixptr); 7.2.2 Codec Handle Creation The Codec Manipulation functions use the same interface to create a handle as the Filters. See below for a detailed example. 7.2.
PAGE 347

7.
PAGE 348

342 Flix Engine Linux Page Documentation • PHP ##sc is $res[0], value is $res[1] #boolean $res= Flix2_IsEncoderRunning($flix); #integer $res= video_options_GetSourceWidth($flix); #double $res= video_options_GetVideoFramerateAsDouble($flix); • Python ##sc is res[0], value is res[1] #boolean res= flixengine2.Flix2_IsEncoderRunning(flix) #integer res= flixengine2.video_options_GetSourceWidth(flix) #double res= flixengine2.
PAGE 349

7.3 FE2_VP6_CONCURRENCY Performance 7.3 343 FE2_VP6_CONCURRENCY Performance What follows are graphs of the mean encode time over 5 successive encodes for 4 relatively short videos using v8.0.9.0. In addition the same encodes were run against v8.0.8.2, less the FE2_VP6_CONCURRENCY parameter, as some modest gains were made outside the scope of this parameter.
PAGE 350

344 Flix Engine Linux Page Documentation 7.3.1.1 320x240 (QVGA) video: live action, 320x240@23.976fps length: 1m13s Codec Settings Flix Engine v8.0.8.2, Pentium 4 540 (3.2GHz HT) FE2_VP6_KFFREQ(360) 26.95 FE2_VP6_KFFREQ(180) 26.90 FE2_VP6_KFFREQ(60) 26.70 FE2_VP6_KFFREQ(30) 26.59 FE2_CODEC_H263 13.13 Time in seconds (shorter is better) video: live action, 320x240@23.976fps length: 1m13s Flix Engine v8.0.9.0, Pentium 4 540 (3.2GHz HT) FE2_VP6_KFFREQ(180) 24.94 FE2_VP6_KFFREQ(360) 24.
PAGE 351

7.3 FE2_VP6_CONCURRENCY Performance 7.3.1.2 345 640x480 (VGA) video: animation, 640x480@30fps length: 1m01s Codec Settings Flix Engine v8.0.8.2, Pentium 4 540 (3.2GHz HT) FE2_VP6_KFFREQ(360) 81.57 FE2_VP6_KFFREQ(180) 80.90 FE2_VP6_KFFREQ(60) 78.64 FE2_VP6_KFFREQ(30) 77.02 FE2_CODEC_H263 28.06 Time in seconds (shorter is better) video: animation, 640x480@30fps length: 1m01s Flix Engine v8.0.9.0, Pentium 4 540 (3.2GHz HT) FE2_VP6_KFFREQ(360) 68.44 FE2_VP6_KFFREQ(180) 68.
PAGE 352

346 Flix Engine Linux Page Documentation 7.3.1.3 1024x464 video: CG, 1024x464@24.4fps length: 2m50s Codec Settings Flix Engine v8.0.8.2, Pentium 4 540 (3.2GHz HT) FE2_VP6_KFFREQ(360) 356.78 FE2_VP6_KFFREQ(180) 356.57 FE2_VP6_KFFREQ(60) 355.36 FE2_VP6_KFFREQ(30) 353.56 FE2_CODEC_H263 122.55 Time in seconds (shorter is better) video: CG, 1024x464@24.4fps length: 2m50s Flix Engine v8.0.9.0, Pentium 4 540 (3.2GHz HT) Codec Settings FE2_VP6_{CONCURRENCY(1), KFFREQ(360)} 326.
PAGE 353

7.3 FE2_VP6_CONCURRENCY Performance 7.3.1.4 347 1280x720 (720p) video: CG, 1280x720@23.976fps length: 1m29s Codec Settings Flix Engine v8.0.8.2, Pentium 4 540 (3.2GHz HT) FE2_VP6_KFFREQ(30) 342.03 FE2_VP6_KFFREQ(60) 340.76 FE2_VP6_KFFREQ(180) 339.32 FE2_VP6_KFFREQ(360) 339.30 FE2_CODEC_H263 107.87 Time in seconds (shorter is better) video: CG, 1280x720@23.976fps length: 1m29s Flix Engine v8.0.9.0, Pentium 4 540 (3.2GHz HT) Codec Settings FE2_VP6_{CONCURRENCY(1), KFFREQ(360)} 305.
PAGE 354

348 Flix Engine Linux Page Documentation 7.3.2.1 320x240 (QVGA) video: live action, 320x240@23.976fps length: 1m13s Codec Settings Flix Engine v8.0.8.2, Intel Xeon X5355 (Quad−Core 2@2.66GHz) FE2_VP6_KFFREQ(180) 19.15 FE2_VP6_KFFREQ(60) 19.03 FE2_VP6_KFFREQ(360) 18.98 FE2_VP6_KFFREQ(30) 18.91 FE2_CODEC_H263 8.66 Time in seconds (shorter is better) video: live action, 320x240@23.976fps length: 1m13s Codec Settings Flix Engine v8.0.9.0, Intel Xeon X5355 (Quad−Core 2@2.
PAGE 355

7.3 FE2_VP6_CONCURRENCY Performance 7.3.2.2 349 640x480 (VGA) video: animation, 640x480@30fps length: 1m01s Codec Settings Flix Engine v8.0.8.2, Intel Xeon X5355 (Quad−Core 2@2.66GHz) FE2_VP6_KFFREQ(360) 58.73 FE2_VP6_KFFREQ(180) 58.59 FE2_VP6_KFFREQ(60) 57.43 FE2_VP6_KFFREQ(30) 56.34 FE2_CODEC_H263 20.06 Time in seconds (shorter is better) video: animation, 640x480@30fps length: 1m01s Codec Settings Flix Engine v8.0.9.0, Intel Xeon X5355 (Quad−Core 2@2.66GHz) FE2_VP6_KFFREQ(360) 48.
PAGE 356

350 Flix Engine Linux Page Documentation 7.3.2.3 1024x464 video: CG, 1024x464@24.4fps length: 2m50s Codec Settings Flix Engine v8.0.8.2, Intel Xeon X5355 (Quad−Core 2@2.66GHz) FE2_VP6_KFFREQ(360) 255.16 FE2_VP6_KFFREQ(180) 253.63 FE2_VP6_KFFREQ(60) 251.56 FE2_VP6_KFFREQ(30) 250.62 FE2_CODEC_H263 87.60 Time in seconds (shorter is better) video: CG, 1024x464@24.4fps length: 2m50s Codec Settings Flix Engine v8.0.9.0, Intel Xeon X5355 (Quad−Core 2@2.66GHz) FE2_VP6_KFFREQ(360) 203.
PAGE 357

7.3 FE2_VP6_CONCURRENCY Performance 7.3.2.4 351 1280x720 (720p) video: CG, 1280x720@23.976fps length: 1m29s Codec Settings Flix Engine v8.0.8.2, Intel Xeon X5355 (Quad−Core 2@2.66GHz) FE2_VP6_KFFREQ(60) 246.05 FE2_VP6_KFFREQ(30) 245.83 FE2_VP6_KFFREQ(180) 244.19 FE2_VP6_KFFREQ(360) 244.15 FE2_CODEC_H263 85.39 Time in seconds (shorter is better) video: CG, 1280x720@23.976fps length: 1m29s Codec Settings Flix Engine v8.0.9.0, Intel Xeon X5355 (Quad−Core 2@2.66GHz) FE2_VP6_KFFREQ(30) 198.
PAGE 358

352 7.4 Flix Engine Linux Page Documentation CHANGELOG 2010-07-20 v8.0.17.1 Linux 2010-07-20 v8.0.17.1_DEMO Linux 2010-07-20 v8.0.17.1 Windows COM v0.0.9.0 2010-07-20 v8.0.17.1_DEMO Windows COM v0.0.9.0 Bug Fixes: - FE2_CODEC_H264, fix bug causing grey dots/grid appearing on scene change to a mostly white frame when using BASE_H264PROFILE +--------------------------+ 2010-05-17 v8.0.17.0 Linux 2010-05-17 v8.0.17.0_DEMO Linux 2010-05-17 v8.0.17.0 Windows COM v0.0.9.0 2010-05-17 v8.0.17.
PAGE 359

7.4 CHANGELOG inspected, providing behavior similar to r27474 snapshot. - updated patches: o libavformat_mov-avoid_reporting_empty_av_streams.diff, mov_06_tkhd_matrix_scale.diff - fix bug causing rotation of 180 to go unreported - (Linux) flixd, return glibc requirement to 2.3.2. glibc-2.3.4 dependencies were unintentionally added in v8.0.15.3. - (Windows) FE2_FILTER_RESAMPLE, after v8.0.15.3, fix over reading of 8 bits/sample input creating potential for a crash - (Windows) flvsplit.dll v2.7.0.
PAGE 360

354 Flix Engine Linux Page Documentation o mpegvideo-revert_r18381.diff - temporary, changes at this revision crash select internal test clips o stream_file-clear_eof_on_seek.diff - addresses a regression in the removal of mov_06_invalid_audio_size.diff. Files w/truncated audio data, but complete indexes, would result in video truncation. o vd_qtvideo-validate_ImageDesc_size.diff - avoid crash should this decoder be paired w/the lavf demuxer - updated patches: o demux_lavf-add_dv_mts_preferred.
PAGE 361

7.4 CHANGELOG 355 - FE2_MUXER_3GP/FE2_MUXER_3G2/FE2_MUXER_MOV/FE2_MUXER_MP4, write edit list containing empty edit for streams w/non-zero start time correcting sync - FE2_CODEC_AAC/FE2_CODEC_AACPLUS/FE2_CODEC_LAME, correct timestamp calculation. Fixes drift on long form content, esp. visible w/FE2_CODEC_AAC.
PAGE 362

356 Flix Engine Linux Page Documentation New header file: filters/{mirror,rotate}.h - (Linux) mencoder, update snapshot to r27474 Additional differences may be obtained from the MPlayer changelog/subversion logs (svn://svn.mplayerhq.hu/mplayer/trunk), aside from overall stability and decoder/demuxer updates, notably addresses/adds: o Nellymoser, Musepack SV8 audio decode - new patches: o ad_faad-restrict_aac_probe_adts.
PAGE 363

7.4 CHANGELOG - new patches: o asfhdr_correct_movielength.diff: correct duration calculation by using double precision as well as correct units for pre-roll (ms). - updated files/patches: o muxer_ogg.c,oggpcm.c: re-base timestamps guaranteeing one stream starting at 0. avoids unnecessary startup delays and at times A/V sync issues esp. w/ASF/WMV. - (Linux) upgraded to SWIG-1.3.35 for language binding generation. Fixes issue seen w/PHP language bindings, from swig-1.3.
PAGE 364

358 Flix Engine Linux Page Documentation adjustment. value is in ms, 0=no timeout. - FE2_CODEC_VP6ALPHA, add pixel normalize to help avoid loss of transparency seen when re-encoding alpha content. - FE2_CODEC_VP6, fix codec bug causing HD clips at high bitrates (>~5000KiB) under VBR_2PASSControl to greatly overshoot the data rate. - correct appl. of forced FE2_FILTER_RESAMPLE due to sample rate/channel restrictions in output.
PAGE 365

7.4 CHANGELOG +--------------------------+ 2007-12-14 v8.0.10.1 Linux 2007-12-14 v8.0.10.1_DEMO Linux 2007-12-14 v8.0.10.1 Windows COM v0.0.4.0 2007-12-14 v8.0.10.1_DEMO Windows COM v0.0.4.0 Bug Fixes: - FE2_MUXER_FLV, pad clips w/truncated audio stream allowing playback to fully complete, avoiding potential hang in many third party players. - FE2_CODEC_H264, add preliminary iPhone support. see group__codec__h264.html#h264_appledevices in the API documentation for further details.
PAGE 366

360 Flix Engine Linux Page Documentation o ffmpeg_correct_dimensions.diff - addresses cropped output in MPG/MP4/MOV files o mov_01_edl_kf_search.diff - updated to avoid video frame duplication (entire video track sans audio appearing after clip completion) o demux_mpg_short_video_fix.
PAGE 367

7.4 CHANGELOG http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2007-2445 - FE2_FILTER_PNGEX, should end-of-stream be encountered and not all requested PNGs have been written (due to misreported duration) output 1 final PNG. - FE2_FILTER_PNGEX, when using FE2_PNGEX_AUTO_EXPORT_COUNT and clip duration cannot be determined output the first FE2_PNGEX_AUTO_EXPORT_COUNT frame(s), as opposed to none at all.
PAGE 368

362 Flix Engine Linux Page Documentation - (linux,mencoder) allow mean framerate patch to only increase output framerate. avoids artifacts when decoding certain h264 clips (mov, etc). - (windows) update flvsplit.dll to v1.5.3.0, ignores flv header information indicating presence of audio, manually inspecting the data, allowing for audio extraction from malformed files. - (windows) update qtsource.dll to v1.0.2.0, addresses incorrect framerate calculation causing file to be transcoded at low framerate.
PAGE 369

7.4 CHANGELOG 363 duplicated. depending on the content this may have produced an audible distortion in the output. in addition, break final mp3 block into individual frames to avoid storing one (potentially large) block at the end of the file. - fix bug, most evident in the demo version, that could cause a crash should the crop filter be used to adjust the width of the input. - remove video height restriction from overlay filter. prior versions required the height to be divisible by 2.
PAGE 370

364 Flix Engine Linux Page Documentation previous versions would correctly decimate the input, but report the source frame rate, adversely affecting video quality. - (windows) correct PNG export filter to accept ’\’ as the path name separator. fixes a potential crash when either FE2_PNGEX_DIRECTORY or FE2_PNGEX_FILENAME_PREFIX were left unset. - add FE2_CUT_USE_SEEK parameter.
PAGE 371

7.5 flixd man page 7.5 365 flixd man page FLIXD(8) FLIXD(8) NAME flixd - Flix encoding daemon SYNOPSIS flixd [ -d ] [ -p port ] [ -i interface ] [ -r ] [ --max-sessions snct ] [ --authdir path ] [ --pidfile file ] [ --logfile file ] [ --loglevel level ] flixd [ -h ] [ -v ] DESCRIPTION flixd is an rpc-based flix encoding server. As such, portmap MUST be running for it to operate. The port and interface to listen on can be specified using the --port and --interface options.
PAGE 372

366 Flix Engine Linux Page Documentation --authdir path path to search home directory) for flixd authorization files (default: user’s --pidfile file write pid to file; e.g., /var/run/flixd.pid --logfile file file to log messages to (default: mode: use syslog(3)) debug mode: stderr, daemon --loglevel level logging verbosity (0-4, 0: none, 1: errors, 2: status, 3: debug, 4: heavy), the levels are cumulative.
PAGE 373

7.5 flixd man page o See the Flix ing/description 367 Engine API documentation for complete list- BUGS Email bug reports to flixsupport@on2.com. Make sure to include the word(s) ’flixd’ or ’flix engine linux’ in the subject field. If possible attach a copy of the install log, ’flix-engine-installerlinux-.bin.log’, or include the Flix Engine version and any pertinent system information in the message body.
PAGE 374

368 Flix Engine Linux Page Documentation 7.6 Samples Sample usage of the Flix Engine API. The easiest way to test your installation is to run the C command line sample or the command line sample of your language of choice. By default samples are installed in /usr/local/share/on2/flixsamples. NOTE: To run the other samples you will have to have installed the appropriate language bindings.
PAGE 375

7.7 Overview 7.7 Overview =============================================================================== Copyright (c) On2 Technologies Inc. All Rights Reserved.
PAGE 376

370 Flix Engine Linux Page Documentation these examples cli_encode.php - php command line example similar to the java and perl examples described above. flix2_sample.php process_sample.php - php cgi example similar to the perl example. python/ NOTE: You must build and install the python extension before running these examples cli_encode.py - python command line example similar to the java and perl examples described above flix2_sample.py process_sample.py - python cgi example similar to the perl example.
PAGE 377

7.8 Command Line 7.8 Command Line /* //========================================================================== // // Copyright (c) On2 Technologies Inc. All Rights Reserved. // //-------------------------------------------------------------------------// // File: $Workfile$ // $Revision$ // // Last Update: $DateUTC$ // //-------------------------------------------------------------------------*/ #include //printf, etc #include //exit #include
PAGE 378

372 Flix Engine Linux Page Documentation /* Options may be set and codecs/filters/muxers may be added prior to Flix2_Encode() */ /*Add the scale filter { FLIX2PLGNHANDLE filter; CHECKSC( Flix2_AddFilter(&filter,flix,FE2_FILTER_SCALE) ); CHECKSC( Flix2_FilterSetParam(filter,FE2_SCALE_WIDTH,240) ); CHECKSC( Flix2_FilterSetParam(filter,FE2_SCALE_HEIGHT,160) ); }*/ /*Add the vp6 codec.
PAGE 379

7.9 Command Line 7.9 Command Line /* //========================================================================== // // Copyright (c) On2 Technologies Inc. All Rights Reserved. // //-------------------------------------------------------------------------// // File: $Workfile$ // $Revision$ // // Last Update: $DateUTC$ // //-------------------------------------------------------------------------*/ import com.on2.flix.*; import java.io.
PAGE 380

374 Flix Engine Linux Page Documentation Options may be set and codecs/filters/muxers may be added prior to Encode() */ /*Add the scale filter Filter filter = new Filter(flix,flix.FE2_FILTER_SCALE); filter.add(); filter.setParam(flix.FE2_SCALE_WIDTH,240.0); filter.setParam(flix.FE2_SCALE_HEIGHT,160.0); */ /*Add the vp6 codec. Though it is the default, you must add it in order to modify its settings Codec codec = new Codec(flix,flix.FE2_CODEC_VP6); codec.add(); codec.setParam(flix.
PAGE 381

7.10 Command Line 7.10 Command Line #!/usr/bin/perl -w ##========================================================================== ## ## Copyright (c) On2 Technologies Inc. All Rights Reserved.
PAGE 382

376 ## ## ## ## my Flix Engine Linux Page Documentation A port may be specified by giving rpchost in the form ’server:port’ to avoid making a connection to portmap before contacting flixd. This is only useful if flixd is being run with the --port option.
PAGE 383

7.
PAGE 384

378 Flix Engine Linux Page Documentation 7.11 CGI This example consists of 2 parts: flix2_sample.cgi and process_sample.cgi. flix2_sample.cgi searches for uploaded files to encode and allows the user to select one while giving the option to set values for most of the engine’s functions. The engine options are separated into sections that map to the engine’s include files. To use this example navigate to flix2_sample.
PAGE 385

7.11 CGI 379 i++; } } function toggle_expand(_this) { _this.parentNode.className= (_this.parentNode.className==’expanded’) ? ’collapsed’ : ’expanded’; document.getElementById(’showall’).checked=false; } function set_table_visible(ctable,visible) { var table= document.getElementById(ctable); if(table) { if(visible && table.className == ’hidden’) { table.className= ’’; } else if(!visible && table.className == ’’) { table.
PAGE 386

380 Flix Engine Linux Page Documentation var i=0; while(list[i]) { if(list[i].type==’checkbox’) { list[i++].checked=false; } else { list[i++].value=’’; } } } function toggle_ftable(ftable,enabled) { var table= document.getElementById(ftable); if(table) { table.className = enabled ? ’’ : ’disabled’; if(!enabled) { clear_value(table.getElementsByTagName(’input’)); clear_value(table.getElementsByTagName(’select’)); } } } function reset_tables() { var table_list= document.
PAGE 387

7.11 CGI content: ""; color: inherit; background-color: rgb(250,250,250); border-top: 1px solid rgb(144,144,144); height: 20px; width: 100%; display: block; } fieldset table, fieldset {display: none;} fieldset.expanded, fieldset.collapsed {display: block;} /*first is fallback for IE*/ fieldset.expanded table {display: block;} fieldset.
PAGE 388

382 Flix Engine Linux Page Documentation table { font-size: 100%; border-spacing: 0; /*border-collapse: collapse;*/ width: 100%; } th:before { display: none; } th, td { width: 50%; vertical-align: top; padding: 2px 3px; border-width: 1px 0; border-style: solid; border-color: rgb(188,188,188) rgb(252,252,252) rgb(252,252,252); } tr:first-child>* {border-top-color: rgb(252,252,252);} th { font-weight: normal; text-align: left; padding: 2px 2px 2px 5px; } input[type] { font-family: monospace; font-size: 100%;

PAGE 389

7.11 CGI 383

This page requires javascript be enabled.

Flix CGI Sample

flix2_sample.cgi version 1.9

Instructions

In this sample you must choose a source file and an output file.
If you leave all the other options blank then the sample will not call the corresponding Flix Engine function and the default will be used.
When done please press the "Start Encode" button at the bottom of the page.
PAGE 390

384 Flix Engine Linux Page Documentation PAGE 391
7.
PAGE 392

386 Flix Engine Linux Page Documentation FE2_VP6_PROFILE <
PAGE 393

7.
PAGE 394

388 Flix Engine Linux Page Documentation FE2_VP6A_CXMODE Advanced Settings: FE2_VP6A_UNDERSHOOT_PCT
PAGE 395

7.

PAGE 402

396 Flix Engine Linux Page Documentation

PAGE 403

PAGE 404

398 Flix Engine Linux Page Documentation FE2_FILTER_DENOISE

PAGE 405 7.11 CGI 399

PAGE 406

400 Flix Engine Linux Page Documentation

FE2_OVERLAY_MASK_Y

FE2_OVERLAY_MASK_RGB

FE2_OVERLAY_MASK_R

PAGE 408

402 Flix Engine Linux Page Documentation

FE2_PNGEX_COMPRESSION_LEVEL

Automatic PNG Export Options:

FE2_PNGEX_AUTO_EXPORT_COUNT

PAGE 414

408 Flix Engine Linux Page Documentation

PAGE 415

7.11 CGI 409

FE2_FXM_CUEPT_EVENT
FE2_FXM_CUEPT_NAV
PAGE 416 410 Flix Engine Linux Page Documentation
PAGE 417 7. PAGE 418 412 Flix Engine Linux Page Documentation	FE2_ISOMEDIA_FASTSTART

FE2_ISOMEDIA_FASTSTART

FE2_SWF_EMBEDDED_URL_TYPE

PAGE 420

414 Flix Engine Linux Page Documentation

FE2_SWF_ON_END_OPTION

PAGE 435

PAGE 436

430 Flix Engine Linux Page Documentation

FE2_VP6_CXMODE

FE2_VP6_PROFILE

FE2_VP6A_CXMODE

FE2_H263_MAX_Q

PAGE 442

436 Flix Engine Linux Page Documentation

FE2_VP8_UNDERSHOOT_PCT

FE2_VP8_OVERSHOOT_PCT

FE2_VP8_MIN_Q

PAGE 443

PAGE 444

438 Flix Engine Linux Page Documentation

PAGE 445

PAGE 446

440 Flix Engine Linux Page Documentation

Video Filters

PAGE 447

7.13 CGI PAGE 448

442 Flix Engine Linux Page Documentation

FE2_FILTER_DENOISE

PAGE 449 7.13 CGI 443
FE2_MIRROR_VERTICAL

PAGE 450

444 Flix Engine Linux Page Documentation

FE2_OVERLAY_MASK_X

FE2_OVERLAY_MASK_Y

FE2_OVERLAY_MASK_RGB

FE2_PNGEX_COMPRESSION_LEVEL

PAGE 454

448 Flix Engine Linux Page Documentation FE2_FILTER_LOWPASS

PAGE 455 7. PAGE 456 450 Flix Engine Linux Page Documentation

PAGE 457 7. PAGE 458 452 Flix Engine Linux Page Documentation
FE2_FLV_CUEPT_EVENT

PAGE 459 7.13 CGI 453

FE2_FXM_CUEPT_EVENT

PAGE 460

454 Flix Engine Linux Page Documentation

PAGE 462

456 Flix Engine Linux Page Documentation

FE2_ISOMEDIA_FASTSTART

"; $sc = call_user_func($funcname,$codec,constant("$name"), (preg_match(’/AsStr/’,$funcname)||!preg_match(’/[[:alpha:]_]/’,$value))?$value:constant("$value")) process_sc($funcname,$sc); } function init_filter($name) { global $flix, $filter, $filterptr; ##if name is a ##we’ll assume ##hit the next if($filterptr) filter name, e.g.

PAGE 467

7.13 CGI 461 flush(); if(ini_get("output_buffering")) ob_flush(); } echo "\r\n\r\nFlix CGI Process Sample - PHP\n"; # output the function calls echo "

process_sample.php version 1.8
\n"; # Load the FlixEngine module # add extension_dir/.. to ’include_path’ as this is often missing from php.ini set_include_path(get_include_path().PATH_SEPARATOR.ini_get("extension_dir")."/.."); $flixphp = ’flixengine2.php’; echo ’Loading flix: ’ . $flixphp .

PAGE 468

462 Flix Engine Linux Page Documentation $temp = explode(":",$func); muxer_interface($temp[0],$temp[1],$param); } else { SimpleSet($func,$param); } } } echo "

"; $sc = Flix2_Encode($flix); echo "\n"; echo "

PAGE 463 7.13 CGI 457
FE2_SWF_EMBEDDED_URL_TYPE
PAGE 464 458 Flix Engine Linux Page Documentation
End Settings:
FE2_SWF_ON_END_OPTION
$funcname( $name, $value )
Flix2_Encode()	$sc

\n"; if($sc != ON2_OK) {die (’Flix2_Encode: sc=’ . $sc ."\n");} echo "
Encoding...(video frames encoded, percent complete). ". "Total frames will reset when doing 2pass.

PAGE 469

PAGE 470

464 Flix Engine Linux Page Documentation if(os.path.isabs(sys.argv[1])!=True): print "WARNING: path to input file is not absolute" sc = flixengine2.Flix2_SetInputFile(flix, sys.argv[1]);\ checksc(’flixengine2.Flix2_SetInputFile’,sc) ##input file information srcw = flixengine2.video_options_GetSourceWidth(flix);\ checksc(’flixengine2.video_options_GetSourceWidth’,srcw[0]) srch = flixengine2.video_options_GetSourceHeight(flix);\ checksc(’flixengine2.

PAGE 471

7.14 Command Line ##retrieve the value of the handle for use in the remaining muxer functions #muxer= flixengine2.flix2plgnhandlep_value(muxerptr) # ##cleanup #flixengine2.delete_flix2plgnhandlep(muxerptr); muxerptr= None sc = flixengine2.Flix2_Encode(flix); checksc(’flixengine2.Flix2_Encode’,sc) ier = [0,1] print while(ier[1] != 0): ier = flixengine2.Flix2_IsEncoderRunning(flix);\ checksc(’flixengine2.Flix2_IsEncoderRunning’,ier[0]) pcnt = flixengine2.

PAGE 472

466 Flix Engine Linux Page Documentation 7.15 CGI This example consists of 2 parts: flix2_sample.py and process_sample.py. flix2_sample.py searches for uploaded files to encode and allows the user to select one while giving the option to set values for most of the engine’s functions. The engine options are separated into sections that map to the engine’s include files. To use this example navigate to flix2_sample.

PAGE 473

7.15 CGI 467 document.getElementById(’showall’).checked=false; } function set_table_visible(ctable,visible) { var table= document.getElementById(ctable); if(table) { if(visible && table.className == ’hidden’) { table.className= ’’; } else if(!visible && table.className == ’’) { table.className= ’hidden’; } } } function hide_tablelist(vistablename,tablelist) { var table= document.getElementById(vistablename); if(table&&table.className==’hidden’) { table.

PAGE 474

468 Flix Engine Linux Page Documentation { var table= document.getElementById(ftable); if(table) { table.className = enabled ? ’’ : ’disabled’; if(!enabled) { clear_value(table.getElementsByTagName(’input’)); clear_value(table.getElementsByTagName(’select’)); } } } function reset_tables() { var table_list= document.getElementsByTagName(’table’); var i=0; while(table_list[i]) { if (table_list[i].id.length > 7 && table_list[i].id.substring(0,7) == ’filter_’) { table_list[i].

PAGE 475

7.15 CGI fieldset table, fieldset {display: none;} fieldset.expanded, fieldset.collapsed {display: block;} /*first is fallback for IE*/ fieldset.expanded table {display: block;} fieldset.

PAGE 476

470 Flix Engine Linux Page Documentation th, td { width: 50%; vertical-align: top; padding: 2px 3px; border-width: 1px 0; border-style: solid; border-color: rgb(188,188,188) rgb(252,252,252) rgb(252,252,252); } tr:first-child>* {border-top-color: rgb(252,252,252);} th { font-weight: normal; text-align: left; padding: 2px 2px 2px 5px; } input[type] { font-family: monospace; font-size: 100%; color: rgb(56,56,56); background-color: inherit; } [type="text"], [type="number"] { margin-right: 13px; width: 222px;

PAGE 477

7.15 CGI 471

flix2_sample.cgi version 1.9

Instructions

In this sample you must choose a source file and an output file.
If you leave all the other options blank then the sample will not call the corresponding Flix Engine function and the default will be used.
When done please press the "Start Encode" button at the bottom of the page.
Mouse over a function name to see its default, if applicable.
PAGE 478

472 Flix Engine Linux Page Documentation

Main Options

Advanced Settings:
Flix2_SetOverwriteExistingFiles
FE2_VP6_PROFILE
FE2_VP6_CONCURRENCY
PAGE 481 7. PAGE 482 476 Flix Engine Linux Page Documentation
Advanced Settings:
FE2_VP6A_UNDERSHOOT_PCT
FE2_VP6A_MIN_Q	PAGE 483 7. PAGE 484 478 Flix Engine Linux Page Documentation
FE2_H263_MIN_Q

FE2_H264_BITRATE

PAGE 485

PAGE 486

480 Flix Engine Linux Page Documentation

FE2_VP8_MIN_Q

FE2_VP8_MAX_Q

FE2_VP8_SHARPNESS

FE2_VP8_NOISE_REDUCTION

PAGE 487

PAGE 488

482 Flix Engine Linux Page Documentation

FE2_AAC_BITRATE

FE2_AACPLUS_BITRATE

PAGE 489

PAGE 490

484 Flix Engine Linux Page Documentation

FE2_ADAPTIVE_DEINTERLACE_MODE

FE2_DENOISE_NOISE_LEVEL

PAGE 493

7.15 CGI

FE2_FILTER_OVERLAY

FE2_PNGEX_AUTO_E PAGE 497 7.15 CGI
FE2_OVERLAY_FILE	""" if os.path. PAGE 494 488 Flix Engine Linux Page Documentation
FE2_OVERLAY_MASK_R
FE2_OVERLAY_MASK_G	PAGE 495 7. PAGE 496 490 Flix Engine Linux Page Documentation
Automatic PNG Export Options:
FE2_PNGEX_AUTO_EXPORT_COUNT
FE2_PNGEX_AUTO_EXPORT_START_TIME