scrcpy/app/src/video_buffer.h

#ifndef VIDEO_BUFFER_H
#define VIDEO_BUFFER_H

#include <stdbool.h>
#include <SDL2/SDL_mutex.h>

#include "fps_counter.h"

// forward declarations
typedef struct AVFrame AVFrame;

struct video_buffer {
    AVFrame *decoding_frame;
    AVFrame *rendering_frame;
    SDL_mutex *mutex;
    bool render_expired_frames;
    bool interrupted;
    SDL_cond *rendering_frame_consumed_cond;
    bool rendering_frame_consumed;
    struct fps_counter fps_counter;
};

bool
video_buffer_init(struct video_buffer *vb, bool render_expired_frames);

void
video_buffer_destroy(struct video_buffer *vb);

// set the decoded frame as ready for rendering
// this function locks frames->mutex during its execution
// the output flag is set to report whether the previous frame has been skipped
void
video_buffer_offer_decoded_frame(struct video_buffer *vb,
                                 bool *previous_frame_skipped);

// mark the rendering frame as consumed and return it
// MUST be called with frames->mutex locked!!!
// the caller is expected to render the returned frame to some texture before
// unlocking frames->mutex
const AVFrame *
video_buffer_consume_rendered_frame(struct video_buffer *vb);

// wake up and avoid any blocking call
void
video_buffer_interrupt(struct video_buffer *vb);

#endif
Rename "frames" to "video_buffer" It better describes the purpose of the structure. 2019-03-02 22:16:55 +08:00			`#ifndef VIDEO_BUFFER_H`
			`#define VIDEO_BUFFER_H`
Initial commit Start a new clean history from here. 2017-12-12 22:12:07 +08:00
Replace SDL types by C99 standard types Scrcpy is a C11 project. Use the C99 standard types instead of the SDL-specific types: SDL_bool -> bool SintXX -> intXX_t UintXX -> uintXX_t 2019-03-03 06:52:22 +08:00			`#include <stdbool.h>`
Optimize includes Only include SDL_stdinc.h for SDL_bool, not the whole SDL.h. 2017-12-16 00:34:16 +08:00			`#include <SDL2/SDL_mutex.h>`
Initial commit Start a new clean history from here. 2017-12-12 22:12:07 +08:00
Separate multi-words filenames by '_' Rename foobar.ext to foo_bar.ext. <https://github.com/Genymobile/scrcpy/pull/226#discussion_r209454865> 2018-08-15 23:01:54 +08:00			`#include "fps_counter.h"`
Make SKIP_FRAMES a compilation flag The skip_frames flag was a non-configurable runtime flag. Since it is not exposed to the user, there is no need for a (possible) runtime cost. For testing purpose, we still want it to be configurable, so make it a compilation flag. 2018-02-07 19:25:52 +08:00
Initial commit Start a new clean history from here. 2017-12-12 22:12:07 +08:00			`// forward declarations`
			`typedef struct AVFrame AVFrame;`

Rename "frames" to "video_buffer" It better describes the purpose of the structure. 2019-03-02 22:16:55 +08:00			`struct video_buffer {`
Initial commit Start a new clean history from here. 2017-12-12 22:12:07 +08:00			`AVFrame *decoding_frame;`
			`AVFrame *rendering_frame;`
			`SDL_mutex *mutex;`
Add runtime option to render expired frames Replace the compilation flag SKIP_FRAMES by a runtime flag to force rendering of expired frames. By default, the expired frames are skipped. 2019-06-06 01:02:50 +08:00			`bool render_expired_frames;`
Replace SDL types by C99 standard types Scrcpy is a C11 project. Use the C99 standard types instead of the SDL-specific types: SDL_bool -> bool SintXX -> intXX_t UintXX -> uintXX_t 2019-03-03 06:52:22 +08:00			`bool interrupted;`
Initial commit Start a new clean history from here. 2017-12-12 22:12:07 +08:00			`SDL_cond *rendering_frame_consumed_cond;`
Replace SDL types by C99 standard types Scrcpy is a C11 project. Use the C99 standard types instead of the SDL-specific types: SDL_bool -> bool SintXX -> intXX_t UintXX -> uintXX_t 2019-03-03 06:52:22 +08:00			`bool rendering_frame_consumed;`
Add FPS counter Remove frame counter from scrcpy.c and add a new FPS counter, logging as INFO the measured frame rate every second (on new frame). 2018-02-15 18:10:58 +08:00			`struct fps_counter fps_counter;`
Initial commit Start a new clean history from here. 2017-12-12 22:12:07 +08:00			`};`

Replace SDL types by C99 standard types Scrcpy is a C11 project. Use the C99 standard types instead of the SDL-specific types: SDL_bool -> bool SintXX -> intXX_t UintXX -> uintXX_t 2019-03-03 06:52:22 +08:00			`bool`
Add runtime option to render expired frames Replace the compilation flag SKIP_FRAMES by a runtime flag to force rendering of expired frames. By default, the expired frames are skipped. 2019-06-06 01:02:50 +08:00			`video_buffer_init(struct video_buffer *vb, bool render_expired_frames);`
Update code style Limit source code to 80 chars, and declare functions return type and modifiers on a separate line. This allows to avoid very long lines, and all function names are aligned. (We do this on VLC, and I like it.) 2019-03-03 03:09:56 +08:00
			`void`
			`video_buffer_destroy(struct video_buffer *vb);`
Initial commit Start a new clean history from here. 2017-12-12 22:12:07 +08:00
Rename "frames" to "video_buffer" It better describes the purpose of the structure. 2019-03-02 22:16:55 +08:00			`// set the decoded frame as ready for rendering`
Move frame swapping logic to frame.c Expose frames_offer_decoded_frame() and frames_consume_rendered_frame() so that callers are not exposed to frame swapping (between the decoding and rendering frames) details. 2018-02-09 02:23:24 +08:00			`// this function locks frames->mutex during its execution`
Use explicit output parameter for skipped frame The function video_buffer_offer_decoded_frame() returned a bool to indicate whether the previous frame had been consumed. This was confusing, because we could expect the returned bool report whether the action succeeded. Make the semantic explicit by using an output parameter. Also revert the flag (report if the frame has been skipped instead of consumed) to avoid confusion for the first frame (the previous is neither skipped nor consumed because there is no previous frame). 2019-03-03 07:26:48 +08:00			`// the output flag is set to report whether the previous frame has been skipped`
			`void`
			`video_buffer_offer_decoded_frame(struct video_buffer *vb,`
			`bool *previous_frame_skipped);`
Move frame swapping logic to frame.c Expose frames_offer_decoded_frame() and frames_consume_rendered_frame() so that callers are not exposed to frame swapping (between the decoding and rendering frames) details. 2018-02-09 02:23:24 +08:00
			`// mark the rendering frame as consumed and return it`
			`// MUST be called with frames->mutex locked!!!`
			`// the caller is expected to render the returned frame to some texture before`
			`// unlocking frames->mutex`
Update code style Limit source code to 80 chars, and declare functions return type and modifiers on a separate line. This allows to avoid very long lines, and all function names are aligned. (We do this on VLC, and I like it.) 2019-03-03 03:09:56 +08:00			`const AVFrame *`
			`video_buffer_consume_rendered_frame(struct video_buffer *vb);`
Initial commit Start a new clean history from here. 2017-12-12 22:12:07 +08:00
Fix deadlock on exit if SKIP_FRAMES disabled On exit, the renderer will not consume frames anymore, so signal the condition variable to wake up the decoder. 2018-02-09 15:42:39 +08:00			`// wake up and avoid any blocking call`
Update code style Limit source code to 80 chars, and declare functions return type and modifiers on a separate line. This allows to avoid very long lines, and all function names are aligned. (We do this on VLC, and I like it.) 2019-03-03 03:09:56 +08:00			`void`
			`video_buffer_interrupt(struct video_buffer *vb);`
Fix deadlock on exit if SKIP_FRAMES disabled On exit, the renderer will not consume frames anymore, so signal the condition variable to wake up the decoder. 2018-02-09 15:42:39 +08:00
Initial commit Start a new clean history from here. 2017-12-12 22:12:07 +08:00			`#endif`