1 /*****************************************************************************
2 * androidsurface.c: android video output using Surface Flinger
3 *****************************************************************************
4 * Copyright © 2011 VideoLAN
6 * Authors: Ming Hu <tewilove@gmail.com>
7 * Ludovic Fauvet <etix@l0cal.com>
8 * Sébastien Toque <xilasz@gmail.com>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
29 #include <vlc_common.h>
30 #include <vlc_plugin.h>
31 #include <vlc_vout_display.h>
32 #include <vlc_picture_pool.h>
39 #ifndef ANDROID_SYM_S_LOCK
40 # define ANDROID_SYM_S_LOCK "_ZN7android7Surface4lockEPNS0_11SurfaceInfoEb"
42 #ifndef ANDROID_SYM_S_LOCK2
43 # define ANDROID_SYM_S_LOCK2 "_ZN7android7Surface4lockEPNS0_11SurfaceInfoEPNS_6RegionE"
45 #ifndef ANDROID_SYM_S_UNLOCK
46 # define ANDROID_SYM_S_UNLOCK "_ZN7android7Surface13unlockAndPostEv"
49 /*****************************************************************************
51 *****************************************************************************/
52 #define CHROMA_TEXT N_("Chroma used")
53 #define CHROMA_LONGTEXT N_(\
54 "Force use of a specific chroma for output. Default is RGB32.")
56 #define CFG_PREFIX "androidsurface-"
58 static int Open (vlc_object_t *);
59 static void Close(vlc_object_t *);
62 set_category(CAT_VIDEO)
63 set_subcategory(SUBCAT_VIDEO_VOUT)
64 set_shortname("AndroidSurface")
65 set_description(N_("Android Surface video output"))
66 set_capability("vout display", 155)
67 add_shortcut("androidsurface", "android")
68 add_string(CFG_PREFIX "chroma", NULL, CHROMA_TEXT, CHROMA_LONGTEXT, true)
69 set_callbacks(Open, Close)
72 /*****************************************************************************
74 *****************************************************************************/
77 extern void *jni_LockAndGetAndroidSurface();
78 extern jobject jni_LockAndGetAndroidJavaSurface();
79 extern void jni_UnlockAndroidSurface();
80 extern void jni_SetAndroidSurfaceSize(int width, int height, int visible_width, int visible_height, int sar_num, int sar_den);
82 // _ZN7android7Surface4lockEPNS0_11SurfaceInfoEb
83 typedef void (*Surface_lock)(void *, void *, int);
84 // _ZN7android7Surface4lockEPNS0_11SurfaceInfoEPNS_6RegionE
85 typedef void (*Surface_lock2)(void *, void *, void *);
86 // _ZN7android7Surface13unlockAndPostEv
87 typedef void (*Surface_unlockAndPost)(void *);
89 /*****************************************************************************
91 *****************************************************************************/
93 static picture_pool_t *Pool (vout_display_t *, unsigned);
94 static void Display(vout_display_t *, picture_t *, subpicture_t *);
95 static int Control(vout_display_t *, int, va_list);
98 typedef struct _SurfaceInfo {
105 uint32_t reserved[2];
109 struct vout_display_sys_t {
110 picture_pool_t *pool;
113 Surface_lock2 s_lock2;
114 Surface_unlockAndPost s_unlockAndPost;
115 native_window_api_t native_window;
118 ANativeWindow *window;
128 struct picture_sys_t {
131 vout_display_sys_t *sys;
134 static int AndroidLockSurface(picture_t *);
135 static void AndroidUnlockSurface(picture_t *);
137 static vlc_mutex_t single_instance = VLC_STATIC_MUTEX;
139 static inline void *LoadSurface(const char *psz_lib, vout_display_sys_t *sys)
141 void *p_library = dlopen(psz_lib, RTLD_NOW);
145 sys->s_lock = (Surface_lock)(dlsym(p_library, ANDROID_SYM_S_LOCK));
146 sys->s_lock2 = (Surface_lock2)(dlsym(p_library, ANDROID_SYM_S_LOCK2));
147 sys->s_unlockAndPost =
148 (Surface_unlockAndPost)(dlsym(p_library, ANDROID_SYM_S_UNLOCK));
150 if ((sys->s_lock || sys->s_lock2) && sys->s_unlockAndPost)
157 static void *InitLibrary(vout_display_sys_t *sys)
159 static const char *libs[] = {
160 "libsurfaceflinger_client.so",
165 for (size_t i = 0; i < sizeof(libs) / sizeof(*libs); i++) {
166 void *lib = LoadSurface(libs[i], sys);
173 static int Open(vlc_object_t *p_this)
175 vout_display_t *vd = (vout_display_t *)p_this;
178 if (vlc_mutex_trylock(&single_instance) != 0) {
179 msg_Err(vd, "Can't start more than one instance at a time");
183 /* Allocate structure */
184 vout_display_sys_t *sys = (struct vout_display_sys_t*) calloc(1, sizeof(*sys));
186 vlc_mutex_unlock(&single_instance);
191 sys->p_library = LoadNativeWindowAPI(&sys->native_window);
192 sys->s_unlockAndPost = (Surface_unlockAndPost)sys->native_window.unlockAndPost;
194 sys->p_library = InitLibrary(sys);
195 if (!sys->p_library) {
197 msg_Err(vd, "Could not initialize libandroid.so/libui.so/libgui.so/libsurfaceflinger_client.so!");
198 vlc_mutex_unlock(&single_instance);
203 video_format_t fmt = vd->fmt;
205 if (fmt.i_chroma == VLC_CODEC_ANDROID_OPAQUE)
208 char *psz_fcc = var_InheritString(vd, CFG_PREFIX "chroma");
210 fmt.i_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, psz_fcc);
213 fmt.i_chroma = VLC_CODEC_RGB32;
215 switch(fmt.i_chroma) {
217 /* avoid swscale usage by asking for I420 instead since the
218 * vout already has code to swap the buffers */
219 fmt.i_chroma = VLC_CODEC_I420;
223 case VLC_CODEC_RGB16:
224 fmt.i_bmask = 0x0000001f;
225 fmt.i_gmask = 0x000007e0;
226 fmt.i_rmask = 0x0000f800;
229 case VLC_CODEC_RGB32:
230 fmt.i_rmask = 0x000000ff;
231 fmt.i_gmask = 0x0000ff00;
232 fmt.i_bmask = 0x00ff0000;
238 video_format_FixRgb(&fmt);
240 msg_Dbg(vd, "Pixel format %4.4s", (char*)&fmt.i_chroma);
243 /* Create the associated picture */
244 picture_sys_t *picsys = malloc(sizeof(*picsys));
245 if (unlikely(picsys == NULL))
249 picture_resource_t resource = { .p_sys = picsys };
250 picture_t *picture = picture_NewFromResource(&fmt, &resource);
256 /* Wrap it into a picture pool */
257 picture_pool_configuration_t pool_cfg;
258 memset(&pool_cfg, 0, sizeof(pool_cfg));
259 pool_cfg.picture_count = 1;
260 pool_cfg.picture = &picture;
261 pool_cfg.lock = AndroidLockSurface;
262 pool_cfg.unlock = AndroidUnlockSurface;
264 sys->pool = picture_pool_NewExtended(&pool_cfg);
266 picture_Release(picture);
270 /* Setup vout_display */
274 vd->display = Display;
275 vd->control = Control;
279 /* Fix initial state */
280 vout_display_SendEventFullscreen(vd, false);
282 sys->i_sar_num = vd->source.i_sar_num;
283 sys->i_sar_den = vd->source.i_sar_den;
288 dlclose(sys->p_library);
290 vlc_mutex_unlock(&single_instance);
294 static void Close(vlc_object_t *p_this)
296 vout_display_t *vd = (vout_display_t *)p_this;
297 vout_display_sys_t *sys = vd->sys;
299 picture_pool_Delete(sys->pool);
301 sys->native_window.winRelease(sys->window);
302 dlclose(sys->p_library);
304 vlc_mutex_unlock(&single_instance);
307 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
311 return vd->sys->pool;
314 #define ALIGN_16_PIXELS( x ) ( ( ( x ) + 15 ) / 16 * 16 )
315 static void SetupPictureYV12( SurfaceInfo* p_surfaceInfo, picture_t *p_picture )
317 /* according to document of android.graphics.ImageFormat.YV12 */
318 int i_stride = ALIGN_16_PIXELS( p_surfaceInfo->s );
319 int i_c_stride = ALIGN_16_PIXELS( i_stride / 2 );
321 p_picture->p->i_pitch = i_stride;
323 /* Fill chroma planes for planar YUV */
324 for( int n = 1; n < p_picture->i_planes; n++ )
326 const plane_t *o = &p_picture->p[n-1];
327 plane_t *p = &p_picture->p[n];
329 p->p_pixels = o->p_pixels + o->i_lines * o->i_pitch;
330 p->i_pitch = i_c_stride;
331 p->i_lines = p_picture->format.i_height / 2;
334 if( vlc_fourcc_AreUVPlanesSwapped( p_picture->format.i_chroma,
336 uint8_t *p_tmp = p_picture->p[1].p_pixels;
337 p_picture->p[1].p_pixels = p_picture->p[2].p_pixels;
338 p_picture->p[2].p_pixels = p_tmp;
342 static int AndroidLockSurface(picture_t *picture)
344 picture_sys_t *picsys = picture->p_sys;
345 vout_display_sys_t *sys = picsys->sys;
350 sw = sys->fmt.i_width;
351 sh = sys->fmt.i_height;
353 if (sys->native_window.winFromSurface) {
354 jobject jsurf = jni_LockAndGetAndroidJavaSurface();
355 if (unlikely(!jsurf)) {
356 jni_UnlockAndroidSurface();
359 if (sys->window && jsurf != sys->jsurf) {
360 sys->native_window.winRelease(sys->window);
366 (*myVm)->AttachCurrentThread(myVm, &p_env, NULL);
367 sys->window = sys->native_window.winFromSurface(p_env, jsurf);
368 (*myVm)->DetachCurrentThread(myVm);
370 // Using sys->window instead of the native surface object
371 // as parameter to the unlock function
372 picsys->surf = surf = sys->window;
374 picsys->surf = surf = jni_LockAndGetAndroidSurface();
375 if (unlikely(!surf)) {
376 jni_UnlockAndroidSurface();
380 info = &picsys->info;
382 if (sys->native_window.winLock) {
383 ANativeWindow_Buffer buf = { 0 };
384 sys->native_window.winLock(sys->window, &buf, NULL);
386 info->h = buf.height;
387 info->bits = buf.bits;
388 info->s = buf.stride;
389 info->format = buf.format;
390 } else if (sys->s_lock)
391 sys->s_lock(surf, info, 1);
393 sys->s_lock2(surf, info, NULL);
395 // For RGB (32 or 16) we need to align on 8 or 4 pixels, 16 pixels for YUV
396 int align_pixels = (16 / picture->p[0].i_pixel_pitch) - 1;
397 uint32_t aligned_width = (sw + align_pixels) & ~align_pixels;
399 if (info->w != aligned_width || info->h != sh || sys->b_changed_crop) {
400 // input size doesn't match the surface size -> request a resize
401 jni_SetAndroidSurfaceSize(aligned_width, sh, sys->fmt.i_visible_width, sys->fmt.i_visible_height, sys->i_sar_num, sys->i_sar_den);
402 // When using ANativeWindow, one should use ANativeWindow_setBuffersGeometry
403 // to set the size and format. In our case, these are set via the SurfaceHolder
404 // in Java, so we seem to manage without calling this ANativeWindow function.
405 sys->s_unlockAndPost(surf);
406 jni_UnlockAndroidSurface();
407 sys->b_changed_crop = false;
411 picture->p[0].p_pixels = (uint8_t*)info->bits;
412 picture->p[0].i_lines = info->h;
413 picture->p[0].i_pitch = picture->p[0].i_pixel_pitch * info->s;
415 if (info->format == 0x32315659 /*ANDROID_IMAGE_FORMAT_YV12*/)
416 SetupPictureYV12(info, picture);
421 static void AndroidUnlockSurface(picture_t *picture)
423 picture_sys_t *picsys = picture->p_sys;
424 vout_display_sys_t *sys = picsys->sys;
426 if (likely(picsys->surf))
427 sys->s_unlockAndPost(picsys->surf);
428 jni_UnlockAndroidSurface();
431 static void Display(vout_display_t *vd, picture_t *picture, subpicture_t *subpicture)
434 VLC_UNUSED(subpicture);
436 /* refcount lowers to 0, and pool_cfg.unlock is called */
438 picture_Release(picture);
441 static int Control(vout_display_t *vd, int query, va_list args)
446 case VOUT_DISPLAY_HIDE_MOUSE:
449 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
453 vout_display_sys_t *sys = vd->sys;
455 const video_format_t *source = (const video_format_t *)va_arg(args, const video_format_t *);
457 sys->b_changed_crop = true;
462 msg_Err(vd, "Unknown request in android vout display");
464 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
465 case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
466 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
467 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
468 case VOUT_DISPLAY_CHANGE_ZOOM:
469 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
470 case VOUT_DISPLAY_GET_OPENGL: