Building a Zoomable PDF Viewer with Jetpack Compose [closed]

Features:

  • Supports PDF annotations
  • Pinch to zoom, tap to zoom in / out
  • Backwards compatible

Problems:
The gesture detector system is not as smooth as in Googles’s PDF app. There must be small touch delay with fingers before the zoom is activated. Sometimes it is mismatched with scroll. Any ideas how to improve it?

I was looking for something like this but backward compatible and lightwait.

https://developer.android.com/jetpack/androidx/releases/pdf

Any other improvements / suggestions are welcomed.

PS: thanks implementation("io.legere:pdfiumandroid:1.0.24")

package com.example

import android.graphics.Bitmap
import android.os.ParcelFileDescriptor
import androidx.compose.foundation.Image
import androidx.compose.foundation.gestures.detectTapGestures
import androidx.compose.foundation.gestures.detectTransformGestures
import androidx.compose.foundation.gestures.scrollBy
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.BoxWithConstraints
import androidx.compose.foundation.layout.Spacer
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.lazy.LazyColumn
import androidx.compose.foundation.lazy.items
import androidx.compose.foundation.lazy.rememberLazyListState
import androidx.compose.runtime.Composable
import androidx.compose.runtime.CompositionLocalProvider
import androidx.compose.runtime.DisposableEffect
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.collectAsState
import androidx.compose.runtime.derivedStateOf
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.geometry.Size
import androidx.compose.ui.graphics.asImageBitmap
import androidx.compose.ui.graphics.graphicsLayer
import androidx.compose.ui.input.pointer.pointerInput
import androidx.compose.ui.platform.LocalContext
import androidx.compose.ui.platform.LocalDensity
import androidx.compose.ui.platform.LocalViewConfiguration
import androidx.compose.ui.platform.ViewConfiguration
import androidx.compose.ui.tooling.preview.Preview
import androidx.compose.ui.unit.dp
import io.legere.pdfiumandroid.suspend.PdfDocumentKt
import io.legere.pdfiumandroid.suspend.PdfiumCoreKt
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.launch
import kotlinx.coroutines.withContext
import java.io.File
import java.io.InputStream

@Composable
fun PDFViewer(
    stream: InputStream,
    modifier: Modifier = Modifier
        .fillMaxSize()
        .padding(4.dp),
    verticalArrangement: Arrangement.Vertical = Arrangement.spacedBy(4.dp),
    loader: @Composable () -> Unit = { },
    pageBox: @Composable (page: @Composable () -> Unit) -> Unit = { page ->
        Box {
            page()
        }
    }
){
    val scope = rememberCoroutineScope()
    var file by remember { mutableStateOf<File?>(null) }
    val context = LocalContext.current

    LaunchedEffect(Unit) {
        scope.launch(Dispatchers.IO) {
            try {
                file = withContext(Dispatchers.IO) {
                    val tempFile = File.createTempFile("pdfTempFile", "pdf", context.cacheDir)
                    tempFile.mkdirs()
                    tempFile.deleteOnExit()

                    tempFile.outputStream().use {
                        it.write(stream.readBytes())
                    }

                    tempFile
                }
            } catch (e: Throwable) {

            }
        }
    }

    PDFViewer(file, modifier, verticalArrangement, loader, pageBox)
}

@Composable
fun PDFViewer(
    file: File?,
    modifier: Modifier = Modifier
        .fillMaxSize()
        .padding(4.dp),
    verticalArrangement: Arrangement.Vertical = Arrangement.spacedBy(4.dp),
    loader: @Composable () -> Unit = { },
    pageBox: @Composable (page: @Composable () -> Unit) -> Unit = { page ->
        Box {
            page()
        }
    }
) {
    val density = LocalDensity.current

    val listState = rememberLazyListState()

    var scale by remember { mutableFloatStateOf(1F) }
    var offsetX by remember { mutableFloatStateOf(0f) }
    val minZoom = 1F
    val maxZoom = 3F

    val scope = rememberCoroutineScope()

    val viewConfiguration = LocalViewConfiguration.current

    CompositionLocalProvider(LocalViewConfiguration provides object : ViewConfiguration by viewConfiguration {
        override val touchSlop: Float
            get() = viewConfiguration.touchSlop * 5f // Help to detect zoom gesture
    }) {
        BoxWithConstraints(
            contentAlignment = Alignment.Center,
            modifier = modifier
        ) {
            if (file == null) {
                loader()
            } else {
                val pdfRender = remember {
                    PdfRender(
                        screenWidth = constraints.maxWidth,
                        fileDescriptor = ParcelFileDescriptor.open(
                            file,
                            ParcelFileDescriptor.MODE_READ_ONLY
                        )
                    )
                }

                LaunchedEffect(Unit) {
                    pdfRender.loadPDF()
                }

                DisposableEffect(key1 = Unit) {
                    onDispose {
                        pdfRender.close()
                    }
                }

                val pages by pdfRender.pages.collectAsState(listOf())

                LazyColumn(
                    state = listState,
                    verticalArrangement = verticalArrangement,
                    modifier = Modifier
                        .pointerInput(Unit) {
                            detectTransformGestures(true) { _, pan, zoom, _ ->
                                scale = (scale * zoom).coerceIn(minZoom, maxZoom)

                                val maxT = maxOf(constraints.maxWidth * scale - constraints.maxWidth, 0f)

                                offsetX = (offsetX + pan.x).coerceIn(
                                    minimumValue = -maxT / 2,
                                    maximumValue = maxT / 2
                                )

                                scope.launch {
                                    listState.scrollBy(-(pan.y) * (1 / scale))
                                }
                            }
                        }
                        .pointerInput(Unit) {
                            detectTapGestures(
                                onDoubleTap = { tapCenter ->
                                    if (scale > 1.0f) {
                                        scale = minZoom
                                        offsetX = 0f
                                    } else {
                                        scale = maxZoom
                                        val center = Pair(
                                            first = constraints.maxWidth / 2,
                                            second = constraints.maxHeight / 2
                                        )

                                        offsetX = (tapCenter.x - center.first) * scale

                                        val yDiff = ((tapCenter.y - center.second) * scale).coerceIn(
                                            minimumValue = -(center.second * 2f),
                                            maximumValue = (center.second * 2f)
                                        )

                                        scope.launch {
                                            listState.scrollBy(-yDiff)
                                        }
                                    }
                                }
                            )
                        }
                        .graphicsLayer {
                            scaleX = scale
                            scaleY = scale
                            translationX = offsetX
                        },
                ) {
                    item {
                        ZoomSpacer(scale, constraints.maxHeight)
                    }

                    items(pages) { page ->

                        val height = with(density) {
                            page.size.height.toDp()
                        }

                        pageBox {
                            // Help Lazy Lazy Layout render only visible pages
                            Box(modifier = Modifier.height(height)) {
                                var bitmap by remember { mutableStateOf<Bitmap?>(null) }

                                LaunchedEffect(page) {
                                    bitmap = page.load()
                                }

                                DisposableEffect(key1 = Unit) {
                                    //Help with garbage collection, GB runs less often and memory graph is not bumpy.
                                    onDispose {
                                        bitmap?.recycle()
                                        bitmap = null
                                    }
                                }

                                bitmap?.let {
                                    Image(
                                        bitmap = it.asImageBitmap(),
                                        contentDescription = "Pdf page number: ${page.index}",
                                    )
                                }
                            }
                        }
                    }

                    item {
                        ZoomSpacer(scale, constraints.maxHeight)
                    }
                }
            }
        }
    }
}

/**
 * Wee need to overscroll in zoom to zoom last / first page
 */
@Composable
private fun ZoomSpacer(scale: Float, maxHeight: Int) {
    val height by remember(scale, maxHeight) {
        derivedStateOf {
            -(((1 / scale) * maxHeight - maxHeight) / 2.0f)
        }
    }
    val density = LocalDensity.current

    val heightDp = with(density) {
        height.toDp()
    }

    Spacer(Modifier.height(height = heightDp))
}

private class PdfRender(
    private val fileDescriptor: ParcelFileDescriptor,
    val screenWidth: Int
) {
    private val pdfiumCore = PdfiumCoreKt(Dispatchers.Default)

    lateinit var document: PdfDocumentKt

    val pages = MutableStateFlow<List<Page>>(listOf())

    suspend fun loadPDF() {
        document = pdfiumCore.newDocument(fileDescriptor)

        pages.value = List(document.getPageCount()) {
            Page(
                index = it,
                pdfRenderer = document,
                size = document.openPage(it).use { page ->
                    Size(
                        width = screenWidth.toFloat(),
                        height = ((screenWidth.toFloat() / page.getPageWidthPoint()) * page.getPageHeightPoint())
                    )
                }
            )
        }
    }

    fun close() {
        document.close()
        fileDescriptor.close()
    }

    class Page(
        val index: Int,
        val pdfRenderer: PdfDocumentKt,
        val size: Size
    ) {
        suspend fun load(): Bitmap {
            pdfRenderer.openPage(index).use { currentPage ->
                val newBitmap = Bitmap.createBitmap(
                    size.width.toInt(),
                    size.height.toInt(),
                    Bitmap.Config.ARGB_8888
                )

                currentPage.renderPageBitmap(
                    newBitmap,
                    0,
                    0,
                    size.width.toInt(),
                    size.height.toInt(),
                    renderAnnot = true
                )

                return newBitmap
            }
        }
    }
}

@Composable
@Preview
private fun CebPdfViewPreview() {
    val stream = LocalContext.current.assets.open("apollo.pdf")

    PDFViewer(stream = stream)
}

1

FIXED:
I had to implement my own: detectTransformGesturesPreferZoom The trick is to check event.changes.size == 1 && !isZoomed() – Number of fingers, so the one finger scroll is propagated to the LazyLayout.

package com.example

import android.graphics.Bitmap
import android.os.ParcelFileDescriptor
import androidx.compose.foundation.Image
import androidx.compose.foundation.gestures.awaitEachGesture
import androidx.compose.foundation.gestures.awaitFirstDown
import androidx.compose.foundation.gestures.calculateCentroid
import androidx.compose.foundation.gestures.calculateCentroidSize
import androidx.compose.foundation.gestures.calculatePan
import androidx.compose.foundation.gestures.calculateZoom
import androidx.compose.foundation.gestures.detectTapGestures
import androidx.compose.foundation.gestures.scrollBy
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.BoxWithConstraints
import androidx.compose.foundation.layout.Spacer
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.lazy.LazyColumn
import androidx.compose.foundation.lazy.items
import androidx.compose.foundation.lazy.rememberLazyListState
import androidx.compose.runtime.Composable
import androidx.compose.runtime.DisposableEffect
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.collectAsState
import androidx.compose.runtime.derivedStateOf
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableFloatStateOf
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.geometry.Offset
import androidx.compose.ui.geometry.Size
import androidx.compose.ui.graphics.asImageBitmap
import androidx.compose.ui.graphics.graphicsLayer
import androidx.compose.ui.input.pointer.PointerInputScope
import androidx.compose.ui.input.pointer.pointerInput
import androidx.compose.ui.input.pointer.positionChanged
import androidx.compose.ui.platform.LocalContext
import androidx.compose.ui.platform.LocalDensity
import androidx.compose.ui.tooling.preview.Preview
import androidx.compose.ui.unit.dp
import androidx.compose.ui.util.fastAny
import androidx.compose.ui.util.fastForEach
import io.legere.pdfiumandroid.suspend.PdfDocumentKt
import io.legere.pdfiumandroid.suspend.PdfiumCoreKt
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.launch
import java.io.File
import kotlin.math.abs

@Composable
@Preview
private fun CebPdfViewPreview() {
    val context = LocalContext.current

    val file = File.createTempFile("tmp", "pdf", context.cacheDir).apply {
        mkdirs()
        deleteOnExit()
        writeBytes(context.assets.open("apollo.pdf").readBytes())
    }

    PDFViewer(file)
}

@Composable
fun PDFViewer(
    file: File?,
    modifier: Modifier = Modifier
        .fillMaxSize()
        .padding(4.dp),
    verticalArrangement: Arrangement.Vertical = Arrangement.spacedBy(4.dp),
    pageBox: @Composable (page: @Composable () -> Unit) -> Unit = { page -> page() }
) {
    val density = LocalDensity.current

    val listState = rememberLazyListState()

    var scale by remember { mutableFloatStateOf(1F) }
    var offsetX by remember { mutableFloatStateOf(0f) }
    val minZoom = 1F
    val maxZoom = 3F

    val scope = rememberCoroutineScope()

    BoxWithConstraints(
        contentAlignment = Alignment.Center,
        modifier = modifier
    ) {
        val pdfRender = remember {
            PdfRender(
                screenWidth = constraints.maxWidth,
                fileDescriptor = ParcelFileDescriptor.open(
                    file,
                    ParcelFileDescriptor.MODE_READ_ONLY
                )
            )
        }

        LaunchedEffect(Unit) {
            pdfRender.loadPDF()
        }

        DisposableEffect(key1 = Unit) {
            onDispose {
                pdfRender.close()
            }
        }

        val pages by pdfRender.pages.collectAsState(listOf())

        LazyColumn(
            state = listState,
            verticalArrangement = verticalArrangement,
            modifier = Modifier
                .pointerInput(Unit) {
                    detectTransformGesturesPreferZoom(
                        isZoomed = { scale > 1.0f }
                    ) { _, pan, zoom ->
                        scale = (scale * zoom).coerceIn(minZoom, maxZoom)

                        val maxT =
                            maxOf(constraints.maxWidth * scale - constraints.maxWidth, 0f)

                        offsetX = (offsetX + pan.x).coerceIn(
                            minimumValue = -maxT / 2,
                            maximumValue = maxT / 2
                        )

                        scope.launch {
                            listState.scrollBy(-(pan.y) * (1 / scale))
                        }
                    }
                }
                .pointerInput(Unit) {
                    detectTapGestures(
                        onDoubleTap = { tapCenter ->
                            if (scale > 1.0f) {
                                scale = minZoom
                                offsetX = 0f
                            } else {
                                scale = maxZoom
                                val center = Pair(
                                    first = constraints.maxWidth / 2,
                                    second = constraints.maxHeight / 2
                                )

                                offsetX = (tapCenter.x - center.first) * scale

                                val yDiff = ((tapCenter.y - center.second) * scale).coerceIn(
                                    minimumValue = -(center.second * 2f),
                                    maximumValue = (center.second * 2f)
                                )

                                scope.launch {
                                    listState.scrollBy(-yDiff)
                                }
                            }
                        }
                    )
                }
                .graphicsLayer {
                    scaleX = scale
                    scaleY = scale
                    translationX = offsetX
                },
        ) {
            item {
                ZoomSpacer(scale, constraints.maxHeight)
            }

            items(pages) { page ->

                val height = with(density) {
                    page.size.height.toDp()
                }

                pageBox {
                    // Help Lazy Lazy Layout render only visible pages
                    Box(modifier = Modifier.height(height)) {
                        var bitmap by remember { mutableStateOf<Bitmap?>(null) }

                        LaunchedEffect(page) {
                            bitmap = page.load()
                        }

                        DisposableEffect(key1 = Unit) {
                            //Help with garbage collection, GB runs less often and memory graph is not bumpy.
                            onDispose {
                                bitmap?.recycle()
                                bitmap = null
                            }
                        }

                        bitmap?.let {
                            Image(
                                bitmap = it.asImageBitmap(),
                                contentDescription = "Pdf page number: ${page.index}",
                            )
                        }
                    }
                }
            }

            item {
                ZoomSpacer(scale, constraints.maxHeight)
            }
        }
    }
}


/**
 * Wee need to overscroll in zoom to zoom last / first page
 */
@Composable
private fun ZoomSpacer(scale: Float, maxHeight: Int) {
    val height by remember(scale, maxHeight) {
        derivedStateOf {
            -(((1 / scale) * maxHeight - maxHeight) / 2.0f)
        }
    }
    val density = LocalDensity.current

    val heightDp = with(density) {
        height.toDp()
    }

    Spacer(Modifier.height(height = heightDp))
}

private class PdfRender(
    private val fileDescriptor: ParcelFileDescriptor,
    val screenWidth: Int
) {
    private val pdfiumCore = PdfiumCoreKt(Dispatchers.Default)

    lateinit var document: PdfDocumentKt

    val pages = MutableStateFlow<List<Page>>(listOf())

    suspend fun loadPDF() {
        document = pdfiumCore.newDocument(fileDescriptor)

        pages.value = List(document.getPageCount()) {
            Page(
                index = it,
                pdfRenderer = document,
                size = document.openPage(it).use { page ->
                    Size(
                        width = screenWidth.toFloat(),
                        height = ((screenWidth.toFloat() / page.getPageWidthPoint()) * page.getPageHeightPoint())
                    )
                }
            )
        }
    }

    fun close() {
        document.close()
        fileDescriptor.close()
    }

    class Page(
        val index: Int,
        val pdfRenderer: PdfDocumentKt,
        val size: Size
    ) {
        suspend fun load(): Bitmap {
            pdfRenderer.openPage(index).use { currentPage ->
                val newBitmap = Bitmap.createBitmap(
                    size.width.toInt(),
                    size.height.toInt(),
                    Bitmap.Config.ARGB_8888
                )

                currentPage.renderPageBitmap(
                    newBitmap,
                    0,
                    0,
                    size.width.toInt(),
                    size.height.toInt(),
                    renderAnnot = true
                )

                return newBitmap
            }
        }
    }
}

suspend fun PointerInputScope.detectTransformGesturesPreferZoom(
    isZoomed: () -> Boolean,
    onGesture: (centroid: Offset, pan: Offset, zoom: Float) -> Unit
) {
    awaitEachGesture {
        var zoom = 1f
        var pan = Offset.Zero
        var pastTouchSlop = false
        val touchSlop = viewConfiguration.touchSlop

        awaitFirstDown(requireUnconsumed = false)
        do {
            val event = awaitPointerEvent()
            val canceled =
                event.changes.fastAny { it.isConsumed } || (event.changes.size == 1 && !isZoomed())

            if (!canceled) {
                val zoomChange = event.calculateZoom()
                val panChange = event.calculatePan()

                if (!pastTouchSlop) {
                    zoom *= zoomChange
                    pan += panChange

                    val centroidSize = event.calculateCentroidSize(useCurrent = false)
                    val zoomMotion = abs(1 - zoom) * centroidSize
                    val panMotion = pan.getDistance()

                    if (zoomMotion > touchSlop || panMotion > touchSlop) {
                        pastTouchSlop = true
                    }
                }

                val centroid = event.calculateCentroid(useCurrent = false)

                if (zoomChange != 1f || panChange != Offset.Zero) {
                    onGesture(centroid, panChange, zoomChange)
                }
                event.changes.fastForEach {
                    if (it.positionChanged()) {
                        it.consume()
                    }
                }

            }
        } while (!canceled && event.changes.fastAny { it.pressed })
    }
}

Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa Dịch vụ tổ chức sự kiện 5 sao Thông tin về chúng tôi Dịch vụ sinh nhật bé trai Dịch vụ sinh nhật bé gái Sự kiện trọn gói Các tiết mục giải trí Dịch vụ bổ trợ Tiệc cưới sang trọng Dịch vụ khai trương Tư vấn tổ chức sự kiện Hình ảnh sự kiện Cập nhật tin tức Liên hệ ngay Thuê chú hề chuyên nghiệp Tiệc tất niên cho công ty Trang trí tiệc cuối năm Tiệc tất niên độc đáo Sinh nhật bé Hải Đăng Sinh nhật đáng yêu bé Khánh Vân Sinh nhật sang trọng Bích Ngân Tiệc sinh nhật bé Thanh Trang Dịch vụ ông già Noel Xiếc thú vui nhộn Biểu diễn xiếc quay đĩa Dịch vụ tổ chức tiệc uy tín Khám phá dịch vụ của chúng tôi Tiệc sinh nhật cho bé trai Trang trí tiệc cho bé gái Gói sự kiện chuyên nghiệp Chương trình giải trí hấp dẫn Dịch vụ hỗ trợ sự kiện Trang trí tiệc cưới đẹp Khởi đầu thành công với khai trương Chuyên gia tư vấn sự kiện Xem ảnh các sự kiện đẹp Tin mới về sự kiện Kết nối với đội ngũ chuyên gia Chú hề vui nhộn cho tiệc sinh nhật Ý tưởng tiệc cuối năm Tất niên độc đáo Trang trí tiệc hiện đại Tổ chức sinh nhật cho Hải Đăng Sinh nhật độc quyền Khánh Vân Phong cách tiệc Bích Ngân Trang trí tiệc bé Thanh Trang Thuê dịch vụ ông già Noel chuyên nghiệp Xem xiếc khỉ đặc sắc Xiếc quay đĩa thú vị
Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa
Thiết kế website Thiết kế website Thiết kế website Cách kháng tài khoản quảng cáo Mua bán Fanpage Facebook Dịch vụ SEO Tổ chức sinh nhật