libltcsmpte - framerate conversion More...

This graph shows which files directly or indirectly include this file:

Data Structures
struct	FrameRate
	Frame rate data structure. More...

Enumerations
enum	FRFlags { FRF_NONE = 0, FRF_DROP_FRAMES = 1, FRF_UNUSED = 2, FRF_SAMPLERATE = 4, FRF_OFFA = 8, FRF_OFFV = 16, FRF_LAST = 32 }
	Frame-Rate-Flags and options: multiple flags/options can be added (binary OR). More...

enum	FRSMPTE { SMPTE_FRAME = 0, SMPTE_SEC, SMPTE_MIN, SMPTE_HOUR, SMPTE_OVERFLOW, SMPTE_LAST }

Functions
int	FR_toint (FrameRate *fr)
	round framerate to the nearest integer

double	FR_todbl (FrameRate *fr)
	return (double) floating point representation of framerate

FrameRate *	FR_create (int num, int den, int flags)
	allocate memory for FrameRate struct and initialize with given values.

void	FR_free (FrameRate *f)
	free memory allocated for FrameRate data structure

void	FR_setsamplerate (FrameRate *f, int samplerate)
	set audio sample rate (sps) for av,vf conversion

long long int	FR_vf2af (FrameRate *f, long int vf)
	convert integer video-frames to audio frame.

long int	FR_af2vfi (FrameRate *f, long long int af)
	convert audio-frame to integer video-frames round down to the prev.

double	FR_af2vf (FrameRate *f, long long int af)
	convert audio-frame to fractional video-frames

long int	FR_insert_drop_frames (long int frames)
	private function - no need to call it when using the FR-API for smpte/bcd conversion

long int	FR_drop_frames (FrameRate *fr, int f, int s, int m, int h)
	private function - no need to call it when using the FR-API for smpte/bcd conversion

long long int	FR_smpte2af (FrameRate *fr, int f, int s, int m, int h, int overflow)
	convert timecode to audio-frame number

void	FR_frame_to_bcd (FrameRate f, long int bcd, long int frame)
	converts video-frame number into binary coded decimal timecode sets: bcd[SMPTE_FRAME] .

void	FR_vf2smpte (FrameRate fr, char smptestring, long int frame)
	converts video-frame into 13char SMPTE string.

long int	FR_smpte2vf (FrameRate *fr, int f, int s, int m, int h, int overflow)
	convert smpte into video-frame number expects smpte in decimal representation as separate arguments:

long int	FR_bcd2vf (FrameRate *fr, int bcd[SMPTE_LAST])
	wrapper around FR_smpte2vf reads SMPTE as bcd array argument and returns video frame number, starting at zero

void	FR_setflags (FrameRate *fr, int flags)
	directly change framerate flags

void	FR_setratio (FrameRate *fr, int num, int den)
	set the framerate

void	FR_setdbl (FrameRate *fr, double fps, int mode)
	convert double value into ratio and set framerate.

Detailed Description

libltcsmpte - framerate conversion

Author: Robin Gareus robin.nosp@m.@gar.nosp@m.eus.o.nosp@m.rg

This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Definition in file framerate.h.

Enumeration Type Documentation

enum FRFlags

Frame-Rate-Flags and options: multiple flags/options can be added (binary OR).

Enumerator:

FRF_NONE
FRF_DROP_FRAMES	use drop frame timecode
FRF_UNUSED
FRF_SAMPLERATE	has sample-rate info
FRF_OFFA	has audio frame offset
FRF_OFFV	has video frame offset
FRF_LAST

Definition at line 31 of file framerate.h.

enum FRSMPTE

Enumerator:

SMPTE_FRAME
SMPTE_SEC
SMPTE_MIN
SMPTE_HOUR
SMPTE_OVERFLOW
SMPTE_LAST

Definition at line 42 of file framerate.h.

Function Documentation

double FR_af2vf	(	FrameRate *	f,
		long long int	af
	)

convert audio-frame to fractional video-frames

long int FR_af2vfi	(	FrameRate *	f,
		long long int	af
	)

convert audio-frame to integer video-frames round down to the prev.

video frame.

long int FR_bcd2vf	(	FrameRate *	fr,
		int	bcd[SMPTE_LAST]
	)

wrapper around FR_smpte2vf reads SMPTE as bcd array argument and returns video frame number, starting at zero

FrameRate* FR_create	(	int	num,
		int	den,
		int	flags
	)

allocate memory for FrameRate struct and initialize with given values.

Examples:: tests/decoder.c, and tests/encoder.c.

long int FR_drop_frames	(	FrameRate *	fr,
		int	f,
		int	s,
		int	m,
		int	h
	)

private function - no need to call it when using the FR-API for smpte/bcd conversion

Drop frame numbers (not frames) 00:00 and 00:01 at the start of every minute except the tenth. returns video frame number staring at zero for 29.97fps

dropframes are not required or permitted when operating at 24, 25, or 30 frames per second.

void FR_frame_to_bcd	(	FrameRate *	f,
		long int *	bcd,
		long int	frame
	)

converts video-frame number into binary coded decimal timecode sets: bcd[SMPTE_FRAME] .

. bcd[SMPTE_LAST] accoding to video-frame. Note: this supports only integer framerates! use FR_vf2smpte instead.

void FR_free ( FrameRate * f )

free memory allocated for FrameRate data structure

Examples:: tests/decoder.c, and tests/encoder.c.

long int FR_insert_drop_frames ( long int frames )

private function - no need to call it when using the FR-API for smpte/bcd conversion

Insert two frame numbers at the start of every minute except the tenth. unit: video-frames!

void FR_setdbl	(	FrameRate *	fr,
		double	fps,
		int	mode
	)

convert double value into ratio and set framerate.

if mode == 1: autodetect drop-frame timecode (set flag|=FRF_DROP_FRAMES if fps==29.97 )

Examples:: tests/decoder.c, and tests/encoder.c.

void FR_setflags	(	FrameRate *	fr,
		int	flags
	)

directly change framerate flags

void FR_setratio	(	FrameRate *	fr,
		int	num,
		int	den
	)

set the framerate

void FR_setsamplerate	(	FrameRate *	f,
		int	samplerate
	)

set audio sample rate (sps) for av,vf conversion

long long int FR_smpte2af	(	FrameRate *	fr,
		int	f,
		int	s,
		int	m,
		int	h,
		int	overflow
	)

convert timecode to audio-frame number

long int FR_smpte2vf	(	FrameRate *	fr,
		int	f,
		int	s,
		int	m,
		int	h,
		int	overflow
	)

convert smpte into video-frame number expects smpte in decimal representation as separate arguments:

f: frame, s: second, m: minute, h: hour overflow should be set to zero (days); returns: video frame number, starting at zero

double FR_todbl ( FrameRate * fr )

return (double) floating point representation of framerate

int FR_toint ( FrameRate * fr )

round framerate to the nearest integer

long long int FR_vf2af	(	FrameRate *	f,
		long int	vf
	)

convert integer video-frames to audio frame.

void FR_vf2smpte	(	FrameRate *	fr,
		char *	smptestring,
		long int	frame
	)

converts video-frame into 13char SMPTE string.

smptestring needs to point to a allocated (char*) memory!

it does handle drop-frame formats correctly.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation